Merge branch 'hans/ssh/rekey_limit/OTP-15069'

* hans/ssh/rekey_limit/OTP-15069:
  ssh: Test the infinity rekey_limit option
  ssh: Add infinity as values to rekey_limit

4 files changed, 54 insertions, 28 deletions

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 6aed525e8b..407956cc6f 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -762,6 +762,8 @@
 
     <datatype>
       <name name="rekey_limit_common_option"/>
+      <name name="limit_bytes"/>
+      <name name="limit_time"/>
       <desc>
 	<p>Sets the limit when rekeying is to be initiated. Both the max time and max amount of data
 	could be configured:
@@ -773,6 +775,10 @@
 	</list>
 	<p>When a rekeying is done, both the timer and the byte counter are restarted.
 	Defaults to one hour and one GByte.</p>
+	<p>If <c>Minutes</c> is set to <c>infinity</c>, no rekeying will ever occur due to that max time has passed.
+	Setting <c>Bytes</c> to <c>infinity</c> will inhibit rekeying after a certain amount of data has been transferred.
+	If the option value is set to <c>{infinity, infinity}</c>, no rekeying will be initiated. Note that rekeying initiated
+	by the peer will still be performed.</p>
       </desc>
     </datatype>
 
diff --git a/lib/ssh/src/ssh.hrl b/lib/ssh/src/ssh.hrl
index fc0a3786ac..2efd239aae 100644
--- a/lib/ssh/src/ssh.hrl
+++ b/lib/ssh/src/ssh.hrl
@@ -191,10 +191,13 @@
 -type user_dir_common_option()      :: {user_dir,  false | string()}.
 -type profile_common_option()       :: {profile,   atom() }.
 -type max_idle_time_common_option() :: {idle_time, timeout()}.
--type rekey_limit_common_option()   :: {rekey_limit, Bytes::non_neg_integer() |
-                                                     {Minutes::non_neg_integer(), Bytes::non_neg_integer()}
+-type rekey_limit_common_option()   :: {rekey_limit, Bytes::limit_bytes() |
+                                                     {Minutes::limit_time(), Bytes::limit_bytes()}
                                        }.
 
+-type limit_bytes() :: non_neg_integer() | infinity .  % non_neg_integer due to compatibility
+-type limit_time()  :: pos_integer() | infinity .
+
 -type key_cb_common_option()            :: {key_cb,  Module::atom() | {Module::atom(),Opts::[term()]} } .
 -type disconnectfun_common_option()     ::
         {disconnectfun, fun((Reason::term()) -> void | any()) }.
diff --git a/lib/ssh/src/ssh_options.erl b/lib/ssh/src/ssh_options.erl
index 73287e464a..fe95d2ac54 100644
--- a/lib/ssh/src/ssh_options.erl
+++ b/lib/ssh/src/ssh_options.erl
@@ -601,14 +601,19 @@ default(common) ->
 
       {rekey_limit, def} =>
           #{default => {3600000, 1024000000}, % {1 hour, 1 GB}
-            chk => fun({TimeMins, SizBytes}) when is_integer(TimeMins) andalso TimeMins>=0,
-                                                  is_integer(SizBytes) andalso SizBytes>=0 ->
-                           %% New (>= 21) format
-                           {true, {TimeMins * 60*1000, % To ms
-                                   SizBytes}};
-                      (SizBytes) when is_integer(SizBytes) andalso SizBytes>=0 ->
-                           %% Old (< 21) format
-                           {true, {3600000, SizBytes}};
+            chk => fun({infinity, infinity}) ->
+                           true;
+                      ({Mins, infinity}) when is_integer(Mins), Mins>0 ->
+                           {true, {Mins*60*1000, infinity}};
+                      ({infinity, Bytes}) when is_integer(Bytes), Bytes>=0 ->
+                           true;
+                      ({Mins, Bytes}) when is_integer(Mins), Mins>0,
+                                           is_integer(Bytes), Bytes>=0 ->
+                           {true, {Mins*60*1000, Bytes}};
+                      (infinity) ->
+                           {true, {3600000, infinity}};
+                      (Bytes) when is_integer(Bytes), Bytes>=0 ->
+                           {true, {3600000, Bytes}};
                       (_) ->
                            false
                    end,
diff --git a/lib/ssh/test/ssh_basic_SUITE.erl b/lib/ssh/test/ssh_basic_SUITE.erl
index 603ac71d4b..715dcaf3c0 100644
--- a/lib/ssh/test/ssh_basic_SUITE.erl
+++ b/lib/ssh/test/ssh_basic_SUITE.erl
@@ -76,7 +76,11 @@ groups() ->
                             shell_exit_status
                            ]},
 
-     {ssh_renegotiate_SUITE, [parallel], [rekey,
+     {ssh_renegotiate_SUITE, [parallel], [rekey0,
+                                          rekey1,
+                                          rekey2,
+                                          rekey3,
+                                          rekey4,
                                           rekey_limit_client,
                                           rekey_limit_daemon,
                                           rekey_time_limit_client,
@@ -1330,28 +1334,36 @@ shell_exit_status(Config) when is_list(Config) ->
     ssh:stop_daemon(Pid).
 
 
+%%----------------------------------------------------------------------------
 %%% Idle timeout test
-rekey() -> [{timetrap,{seconds,90}}].
+rekey0() -> [{timetrap,{seconds,90}}].
+rekey1() -> [{timetrap,{seconds,90}}].
+rekey2() -> [{timetrap,{seconds,90}}].
+rekey3() -> [{timetrap,{seconds,90}}].
+rekey4() -> [{timetrap,{seconds,90}}].
     
-rekey(Config) ->
-    {Pid, Host, Port} = 
-	ssh_test_lib:std_daemon(Config,
-				[{rekey_limit, 0}]),
-    ConnectionRef =
-	ssh_test_lib:std_connect(Config, Host, Port, 
-				 [{rekey_limit, 0}]),
+rekey0(Config) -> rekey_chk(Config, 0,                   0).
+rekey1(Config) -> rekey_chk(Config, infinity,            0).
+rekey2(Config) -> rekey_chk(Config, {infinity,infinity}, 0).
+rekey3(Config) -> rekey_chk(Config, 0,                   infinity).
+rekey4(Config) -> rekey_chk(Config, 0,                   {infinity,infinity}).
+
+rekey_chk(Config, RLdaemon, RLclient) ->
+    {Pid, Host, Port} = ssh_test_lib:std_daemon(Config,	[{rekey_limit, RLdaemon}]),
+    ConnectionRef = ssh_test_lib:std_connect(Config, Host, Port, [{rekey_limit, RLclient}]),
     Kex1 = ssh_test_lib:get_kex_init(ConnectionRef),
-    receive
-    after ?REKEY_DATA_TMO ->
-	    %%By this time rekeying would have been done
-	    Kex2 = ssh_test_lib:get_kex_init(ConnectionRef),
-	    false = (Kex2 == Kex1),
-	    ssh:close(ConnectionRef),
-	    ssh:stop_daemon(Pid)
-    end.
 
-%%--------------------------------------------------------------------
+    %% Make both sides send something:
+    {ok, SftpPid} = ssh_sftp:start_channel(ConnectionRef),
+
+    %% Check rekeying
+    timer:sleep(?REKEY_DATA_TMO),
+    ?wait_match(false, Kex1==ssh_test_lib:get_kex_init(ConnectionRef), [], 2000, 10),
 
+    ssh:close(ConnectionRef),
+    ssh:stop_daemon(Pid).
+
+%%--------------------------------------------------------------------
 %%% Test rekeying by data volume
 
 rekey_limit_client() -> [{timetrap,{seconds,400}}].