aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2018-05-04 13:31:12 +0200
committerHans Nilsson <[email protected]>2018-05-04 13:31:12 +0200
commit5a4112b53facc42fec58ca31b96b2791bd70d328 (patch)
treedb37dab735633c1c7c2b2ee5154e5e89eaa7b0d3 /lib/ssh/doc
parenta8ede33f9a51c1566ccb38df0056c3e1f092b970 (diff)
parent79e3c477f8d0d8ea397820847c576e0a0aaa5323 (diff)
downloadotp-5a4112b53facc42fec58ca31b96b2791bd70d328.tar.gz
otp-5a4112b53facc42fec58ca31b96b2791bd70d328.tar.bz2
otp-5a4112b53facc42fec58ca31b96b2791bd70d328.zip
Merge branch 'hans/ssh/rekey_limit/OTP-15069'
* hans/ssh/rekey_limit/OTP-15069: ssh: Extend rekey_limit to also take an optional time
Diffstat (limited to 'lib/ssh/doc')
-rw-r--r--lib/ssh/doc/src/ssh.xml12
1 files changed, 10 insertions, 2 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 0223831cb1..6aed525e8b 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -763,8 +763,16 @@
<datatype>
<name name="rekey_limit_common_option"/>
<desc>
- <p>Sets a limit, in bytes, when rekeying is to be initiated.
- Defaults to once per each GB and once per hour.</p>
+ <p>Sets the limit when rekeying is to be initiated. Both the max time and max amount of data
+ could be configured:
+ </p>
+ <list>
+ <item><c>{Minutes, Bytes}</c> initiate rekeying when any of the limits are reached.</item>
+ <item><c>Bytes</c> initiate rekeying when <c>Bytes</c> number of bytes are transferred,
+ or at latest after one hour.</item>
+ </list>
+ <p>When a rekeying is done, both the timer and the byte counter are restarted.
+ Defaults to one hour and one GByte.</p>
</desc>
</datatype>