ssh: Initial ssh_tprt_test_lib.erl and ssh_protocol_SUITE

This test lib is intended for deeper testing of the SSH application. It
makes it possible to do exact steps in the message exchange to test "corner
cases"

1 files changed, 314 insertions, 0 deletions

diff --git a/lib/ssh/test/ssh_protocol_SUITE.erl b/lib/ssh/test/ssh_protocol_SUITE.erl
new file mode 100644
index 0000000000..3fb2840a19
--- /dev/null
+++ b/lib/ssh/test/ssh_protocol_SUITE.erl
@@ -0,0 +1,314 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2008-2015. All Rights Reserved.
+%%
+%% The contents of this file are subject to the Erlang Public License,
+%% Version 1.1, (the "License"); you may not use this file except in
+%% compliance with the License. You should have received a copy of the
+%% Erlang Public License along with this software. If not, it can be
+%% retrieved online at http://www.erlang.org/.
+%%
+%% Software distributed under the License is distributed on an "AS IS"
+%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+%% the License for the specific language governing rights and limitations
+%% under the License.
+%%
+%% %CopyrightEnd%
+%%
+
+%%
+
+-module(ssh_protocol_SUITE).
+
+-include_lib("common_test/include/ct.hrl").
+-include_lib("kernel/include/inet.hrl").
+-include_lib("ssh/src/ssh.hrl").		% ?UINT32, ?BYTE, #ssh{} ...
+-include_lib("ssh/src/ssh_transport.hrl").
+-include_lib("ssh/src/ssh_auth.hrl").
+
+%% Note: This directive should only be used in test suites.
+-compile(export_all).
+
+-define(NEWLINE, <<"\r\n">>).
+-define(REKEY_DATA_TMO, 65000).
+
+-define(v(Key, Config), proplists:get_value(Key, Config)).
+-define(v(Key, Config, Default), proplists:get_value(Key, Config, Default)).
+
+
+%%--------------------------------------------------------------------
+%% Common Test interface functions -----------------------------------
+%%--------------------------------------------------------------------
+
+suite() ->
+    [{ct_hooks,[ts_install_cth]}].
+
+all() -> 
+    [{group,tool_tests}
+    ].
+
+groups() ->
+    [{tool_tests, [], [lib_works_as_client,
+		       lib_works_as_server,
+		       lib_match,
+		       lib_no_match
+		      ]}
+    ].
+
+
+init_per_suite(Config) ->
+    start_std_daemon( setup_dirs( start_apps(Config))).
+    
+end_per_suite(Config) ->
+    stop_apps(Config).
+
+
+init_per_testcase(_TestCase, Config) ->
+    check_std_daemon_works(Config, ?LINE).
+
+end_per_testcase(_TestCase, Config) ->
+    check_std_daemon_works(Config, ?LINE).
+
+
+%%%--------------------------------------------------------------------
+%%% Test Cases --------------------------------------------------------
+%%%--------------------------------------------------------------------
+
+%%%--------------------------------------------------------------------
+%%% Connect to an erlang server and check that the testlib acts as a client.
+lib_works_as_client(Config) ->
+    %% Connect and negotiate keys
+    {ok,InitialState} =
+	ssh_trpt_test_lib:exec(
+	  [{set_options, [print_ops, print_seqnums, print_messages]},
+	   {connect,
+	    server_host(Config),server_port(Config),
+	    [{silently_accept_hosts, true},
+	     {user_dir, user_dir(Config)},
+	     {user_interaction, false}]},
+	   receive_hello,
+	   {send, hello},
+	   {send, ssh_msg_kexinit},
+	   {match, #ssh_msg_kexinit{_='_'}, receive_msg},
+	   {send, ssh_msg_kexdh_init},
+	   {match,# ssh_msg_kexdh_reply{_='_'}, receive_msg},
+	   {send, #ssh_msg_newkeys{}},
+	   {match, #ssh_msg_newkeys{_='_'}, receive_msg}
+	  ]
+	 ),
+
+    %% Do the authentcation
+    {User,Pwd} = server_user_password(Config),
+    {ok,EndState} =
+	ssh_trpt_test_lib:exec(
+	  [{send, #ssh_msg_service_request{name = "ssh-userauth"}},
+	   {match, #ssh_msg_service_accept{name = "ssh-userauth"}, receive_msg},
+	   {send, #ssh_msg_userauth_request{user = User,
+					    service = "ssh-connection",
+					    method = "password",
+					    data = <<?BOOLEAN(?FALSE),
+						     ?STRING(unicode:characters_to_binary(Pwd))>>
+					   }},
+	   {match, #ssh_msg_userauth_success{_='_'}, receive_msg}
+	  ], InitialState),
+
+    %% Disconnect
+    {ok,_} =
+	ssh_trpt_test_lib:exec(
+	  [{send, #ssh_msg_disconnect{code = ?SSH_DISCONNECT_BY_APPLICATION,
+				      description = "End of the fun",
+				      language = ""
+				     }},
+	   close_socket
+	  ], EndState).
+
+
+%%--------------------------------------------------------------------
+%%% Connect an erlang client and check that the testlib can act as a server.
+lib_works_as_server(Config) ->
+    {User,_Pwd} = server_user_password(Config),
+
+    %% Create a listening socket as server socket:
+    {ok,InitialState} = ssh_trpt_test_lib:exec(listen),
+    HostPort = ssh_trpt_test_lib:server_host_port(InitialState),
+
+    %% Start a process handling one connection on the server side:
+    spawn_link(
+      fun() ->
+	      {ok,_} =
+		  ssh_trpt_test_lib:exec(
+		    [{set_options, [print_ops, print_messages]},
+		     {accept, [{system_dir, system_dir(Config)},
+			       {user_dir, user_dir(Config)}]},
+		     receive_hello,
+		     {send, hello},
+
+		     {send, ssh_msg_kexinit},
+		     {match, #ssh_msg_kexinit{_='_'}, receive_msg},
+
+		     {match, #ssh_msg_kexdh_init{_='_'}, receive_msg},
+		     {send, ssh_msg_kexdh_reply},
+
+		     {send, #ssh_msg_newkeys{}},
+		     {match,  #ssh_msg_newkeys{_='_'}, receive_msg},
+
+		     {match, #ssh_msg_service_request{name="ssh-userauth"}, receive_msg},
+		     {send, #ssh_msg_service_accept{name="ssh-userauth"}},
+
+		     {match, #ssh_msg_userauth_request{service="ssh-connection",
+						       method="none",
+						       user=User,
+						       _='_'}, receive_msg},
+
+		     {send, #ssh_msg_userauth_failure{authentications = "password",
+						      partial_success = false}},
+
+		     {match, #ssh_msg_userauth_request{service="ssh-connection",
+						       method="password",
+						       user=User,
+						       _='_'}, receive_msg},
+		     {send, #ssh_msg_userauth_success{}},
+		     close_socket,
+		     print_state
+		    ],
+		    InitialState)
+      end),
+
+    %% and finally connect to it with a regular Erlang SSH client:
+    {ok,_} = std_connect(HostPort, Config).
+
+%%--------------------------------------------------------------------
+%%% Matching
+lib_match(_Config) ->
+    {ok,_} =
+	ssh_trpt_test_lib:exec([{set_options, [print_ops]},
+				{match, abc, abc},
+				{match, '$a', {cde,fgh}},
+				{match, {cde,fgh}, '$a'},
+				{match, '_', {cde,fgh}},
+				{match, [a,'$a',b], [a,{cde,fgh},b]},
+				{match, [a,'$a'|'$b'], [a,{cde,fgh},b,c]},
+				{match, '$b', [b,c]}
+			       ]).
+
+%%--------------------------------------------------------------------
+%%% Not matching
+lib_no_match(_Config) ->
+    case ssh_trpt_test_lib:exec([{set_options, [print_ops]},
+				 {match, '$x', b},
+				 {match, a, '$x'}])
+    of
+	{ok,_} -> {fail,"Unexpected match"};
+	{error, {_Op,{expected,a,b},_State}} -> ok
+    end.
+
+%%%================================================================
+%%%==== Internal functions ========================================
+%%%================================================================
+
+%%%---- init_suite and end_suite ---------------------------------------	
+start_apps(Config) ->
+    catch crypto:stop(),
+    case catch crypto:start() of
+	ok ->
+	    catch ssh:stop(),
+	    ok = ssh:start(),
+	    [{stop_apps, 
+	      fun() ->
+		      ssh:stop(),
+		      crypto:stop()
+	      end} | Config];
+	_Else ->
+	    {skip, "Crypto could not be started!"}
+    end.
+    
+
+stop_apps(Config) ->
+    (?v(stop_apps, Config, fun()-> ok end))(),
+    ssh:stop().
+
+
+setup_dirs(Config) ->
+    DataDir = ?config(data_dir, Config),
+    PrivDir = ?config(priv_dir, Config),
+    ssh_test_lib:setup_rsa(DataDir, PrivDir),
+    Config.
+
+system_dir(Config) -> filename:join(?config(priv_dir, Config), system).
+
+user_dir(Config) -> ?config(priv_dir, Config).
+
+%%%----------------------------------------------------------------
+start_std_daemon(Config) ->	
+    start_std_daemon(Config, []).
+
+start_std_daemon(Config, ExtraOpts) ->
+    PrivDir = ?config(priv_dir, Config), 
+    UserDir = filename:join(PrivDir, nopubkey), % to make sure we don't use public-key-auth
+    file:make_dir(UserDir),
+    UserPasswords = [{"user1","pwd1"}],
+    Options = [{system_dir, system_dir(Config)},
+	       {user_dir, user_dir(Config)},
+	       {user_passwords, UserPasswords},
+	       {failfun, fun ssh_test_lib:failfun/2}
+	       | ExtraOpts],
+    Ref = {Server, Host, Port} = ssh_test_lib:daemon(Options),
+    ct:log("Std server ~p started at ~p:~p~nOptions=~p",[Server, Host, Port, Options]),
+    [{server,Ref}, {user_passwords, UserPasswords} | Config].
+
+
+stop_std_daemon(Config) ->
+    ssh:stop_daemon(server_pid(Config)),
+    ct:log("Std server ~p at ~p:~p stopped", [server_pid(Config), server_host(Config), server_port(Config)]),
+    lists:keydelete(server, 1, Config).
+
+check_std_daemon_works(Config, Line) ->
+    case std_connect(Config) of
+	{ok,C} ->
+	    ct:log("Server ~p:~p ~p is ok at line ~p",
+		   [server_host(Config), server_port(Config), 
+		    server_pid(Config), Line]),
+	    ok = ssh:close(C),
+	    Config;
+	Error = {error,_} ->
+	    {fail,
+	     lists:flatten(
+	       io_lib:format("Standard server ~p:~p ~p is ill at line ~p: ~p",
+			     [server_host(Config), server_port(Config), 
+			      server_pid(Config), Line, Error])
+	      )
+	    }
+    end.
+
+server_pid(Config)  -> element(1,?v(server,Config)).
+server_host(Config) -> element(2,?v(server,Config)).
+server_port(Config) -> element(3,?v(server,Config)).
+
+server_user_password(Config) -> server_user_password(1, Config).
+
+server_user_password(N, Config) -> lists:nth(N, ?v(user_passwords,Config)).
+    
+
+std_connect(Config) -> 
+    {User,Pwd} = server_user_password(Config),
+    std_connect(server_host(Config), server_port(Config),
+		Config,
+		[{user,User},{password,Pwd}]).
+    
+std_connect({Host,Port}, Config) ->
+    {User,Pwd} = server_user_password(Config),
+    std_connect(Host, Port, Config, [{user,User},{password,Pwd}]).
+
+std_connect({Host,Port}, Config, Opts) ->
+    std_connect(Host, Port, Config, Opts).
+
+std_connect(Host, Port, Config, Opts) ->
+    ssh:connect(Host, Port, 
+		[{silently_accept_hosts, true},
+		 {user_dir, user_dir(Config)},
+		 {user_interaction, false} | Opts],
+		30000).
+    
+
+%%%----------------------------------------------------------------