ssh: Option unexpectedfun for ssh:daemon and ssh:connect

This option has a fun as value.  The fun will be called when an
unexpected message arrives.  The fun returns either 'skip' or 'report'
to guide the connection_handler what to do.

One usage is to filter out messages that are not wanted in the error
logger as info reports. An example of such a message is the 'etimedout'
tcp error message that will be received if a connection has keep_alive
and the peer is restarted.

1 files changed, 84 insertions, 0 deletions

diff --git a/lib/ssh/test/ssh_basic_SUITE.erl b/lib/ssh/test/ssh_basic_SUITE.erl
index f737c436c8..b3a837f40f 100644
--- a/lib/ssh/test/ssh_basic_SUITE.erl
+++ b/lib/ssh/test/ssh_basic_SUITE.erl
@@ -60,6 +60,8 @@ all() ->
      ssh_msg_debug_fun_option_server,
      disconnectfun_option_server,
      disconnectfun_option_client,
+     unexpectedfun_option_server,
+     unexpectedfun_option_client,
      preferred_algorithms,
      id_string_no_opt_client,
      id_string_own_string_client,
@@ -879,6 +881,88 @@ disconnectfun_option_client(Config) ->
     end.
 
 %%--------------------------------------------------------------------
+unexpectedfun_option_server(Config) ->
+    PrivDir = ?config(priv_dir, Config),
+    UserDir = filename:join(PrivDir, nopubkey), % to make sure we don't use public-key-auth
+    file:make_dir(UserDir),
+    SysDir = ?config(data_dir, Config),
+
+    Parent = self(),
+    ConnFun = fun(_,_,_) -> Parent ! {connection_pid,self()} end,
+    UnexpFun = fun(Msg,Peer) ->
+		       Parent ! {unexpected,Msg,Peer,self()},
+		       skip
+	       end,
+
+    {Pid, Host, Port} = ssh_test_lib:daemon([{system_dir, SysDir},
+					     {user_dir, UserDir},
+					     {password, "morot"},
+					     {failfun, fun ssh_test_lib:failfun/2},
+					     {connectfun, ConnFun},
+					     {unexpectedfun, UnexpFun}]),
+    _ConnectionRef =
+	ssh_test_lib:connect(Host, Port, [{silently_accept_hosts, true},
+					  {user, "foo"},
+					  {password, "morot"},
+					  {user_dir, UserDir},
+					  {user_interaction, false}]),
+    receive
+	{connection_pid,Server} ->
+	    %% Beware, implementation knowledge:
+	    Server ! unexpected_message,
+	    receive
+		{unexpected, unexpected_message, {{_,_,_,_},_}, _} -> ok;
+		{unexpected, unexpected_message, Peer, _} -> ct:fail("Bad peer ~p",[Peer]);
+		M = {unexpected, _, _, _} -> ct:fail("Bad msg ~p",[M])
+	    after 3000 ->
+		    ssh:stop_daemon(Pid),
+		    {fail,timeout2}
+	    end
+    after 3000 ->
+	    ssh:stop_daemon(Pid),
+	    {fail,timeout1}
+    end.
+
+%%--------------------------------------------------------------------
+unexpectedfun_option_client(Config) ->
+    PrivDir = ?config(priv_dir, Config),
+    UserDir = filename:join(PrivDir, nopubkey), % to make sure we don't use public-key-auth
+    file:make_dir(UserDir),
+    SysDir = ?config(data_dir, Config),
+
+    Parent = self(),
+    UnexpFun = fun(Msg,Peer) -> 
+		       Parent ! {unexpected,Msg,Peer,self()},
+		       skip
+	       end,
+
+    {Pid, Host, Port} = ssh_test_lib:daemon([{system_dir, SysDir},
+					     {user_dir, UserDir},
+					     {password, "morot"},
+					     {failfun, fun ssh_test_lib:failfun/2}]),
+    ConnectionRef =
+	ssh_test_lib:connect(Host, Port, [{silently_accept_hosts, true},
+					  {user, "foo"},
+					  {password, "morot"},
+					  {user_dir, UserDir},
+					  {user_interaction, false},
+					  {unexpectedfun, UnexpFun}]),
+    %% Beware, implementation knowledge:
+    ConnectionRef ! unexpected_message,
+
+    receive
+	{unexpected, unexpected_message, {{_,_,_,_},_}, ConnectionRef} ->
+	    ok;
+	{unexpected, unexpected_message, Peer, ConnectionRef} ->
+	    ct:fail("Bad peer ~p",[Peer]);
+	M = {unexpected, _, _, _} ->
+	    ct:fail("Bad msg ~p",[M])
+    after 3000 ->
+	    ssh:stop_daemon(Pid),
+	    {fail,timeout}
+    end.
+
+%%--------------------------------------------------------------------
 known_hosts() ->
     [{doc, "check that known_hosts is updated correctly"}].
 known_hosts(Config) when is_list(Config) ->