Merge branch 'ia/patch-17/ssh/user-interaction/OTP-11329/sftp-version/OTP-12227' into maint-17

* ia/patch-17/ssh/user-interaction/OTP-11329/sftp-version/OTP-12227:
  ssh: Prepare for release
  ssh: Add option sftp_vsn
  ssh: Fix option user_interaction to work as expected

9 files changed, 128 insertions, 69 deletions

diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index e55d092fe2..f1091e9eca 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>2005</year><year>2013</year>
+      <year>2005</year><year>2014</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -81,6 +81,17 @@
 	    <p>The timeout is passed to the ssh_channel start function,
 	    and defaults to infinity.</p>
 	  </item>
+	  <tag>
+	    <p><c><![CDATA[{sftp_vsn, integer()}]]></c></p>
+	  </tag>
+	  <item>
+	    <p>
+	      Desired SFTP protocol version.
+	      The actual version will be the minimum of
+	      the desired version and the maximum supported
+	      versions by the SFTP server.
+	    </p>
+	  </item>
 	</taglist>
 	<p>All other options are  directly passed to
 	<seealso marker="ssh">ssh:connect/3</seealso> or ignored if a
diff --git a/lib/ssh/src/ssh.appup.src b/lib/ssh/src/ssh.appup.src
index 1917c95f5a..3cafe2d6be 100644
--- a/lib/ssh/src/ssh.appup.src
+++ b/lib/ssh/src/ssh.appup.src
@@ -19,9 +19,19 @@
 
 {"%VSN%",	
  [
+  {"3.0.6", [{load_module, ssh_auth, soft_purge, soft_purge, [ssh_connection_handler]},
+	     {load_module, ssh_message, soft_purge, soft_purge, [ssh_connection_handler]},
+	     {load_module, ssh_io, soft_purge, soft_purge, [ssh_connection_handler]},
+	     {load_module, ssh_sftp, soft_purge, soft_purge, [ssh_connection_handler]}]},
+	     {load_module, ssh_xfer, soft_purge, soft_purge, [ssh_connection_handler]},
   {<<".*">>, [{restart_application, ssh}]}
  ],
  [
+  {"3.0.6", [{load_module, ssh_auth, soft_purge, soft_purge, [ssh_connection_handler]},
+	     {load_module, ssh_message, soft_purge, soft_purge, [ssh_connection_handler]},
+	     {load_module, ssh_io, soft_purge, soft_purge, [ssh_connection_handler]},
+	     {load_module, ssh_sftp, soft_purge, soft_purge, [ssh_connection_handler]},
+	     {load_module, ssh_xfer, soft_purge, soft_purge, [ssh_connection_handler]}]},
   {<<".*">>, [{restart_application, ssh}]}
  ]
 }.
diff --git a/lib/ssh/src/ssh_auth.erl b/lib/ssh/src/ssh_auth.erl
index 45fd907383..b4d406ba8d 100644
--- a/lib/ssh/src/ssh_auth.erl
+++ b/lib/ssh/src/ssh_auth.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2008-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2008-2014. 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
@@ -119,8 +119,7 @@ init_userauth_request_msg(#ssh{opts = Opts} = Ssh) ->
 		false ->
 		    FirstAlg = proplists:get_value(public_key_alg, Opts, ?PREFERRED_PK_ALG),
 		    SecondAlg = other_alg(FirstAlg),
-		    AllowUserInt =  proplists:get_value(user_interaction, Opts, true),
-		    Prefs = method_preference(FirstAlg, SecondAlg, AllowUserInt),
+		    Prefs = method_preference(FirstAlg, SecondAlg),
 		    ssh_transport:ssh_packet(Msg, Ssh#ssh{user = User,
 							  userauth_preference = Prefs,
 							  userauth_methods = none,
@@ -130,15 +129,13 @@ init_userauth_request_msg(#ssh{opts = Opts} = Ssh) ->
 		    case length(Algs) =:= 2 of
 			true ->
 			    SecondAlg = other_alg(FirstAlg),
-			    AllowUserInt =  proplists:get_value(user_interaction, Opts, true),
-			    Prefs = method_preference(FirstAlg, SecondAlg, AllowUserInt),
+			    Prefs = method_preference(FirstAlg, SecondAlg),
 			    ssh_transport:ssh_packet(Msg, Ssh#ssh{user = User,
 								  userauth_preference = Prefs,
 								  userauth_methods = none,
 								  service = "ssh-connection"});
 			_ ->
-			    AllowUserInt = proplists:get_value(user_interaction, Opts, true),
-			    Prefs = method_preference(FirstAlg, AllowUserInt),
+			    Prefs = method_preference(FirstAlg),
 			    ssh_transport:ssh_packet(Msg, Ssh#ssh{user = User,
 								  userauth_preference = Prefs,
 								  userauth_methods = none,
@@ -256,15 +253,12 @@ handle_userauth_info_request(
 				 data  = Data}, IoCb, 
   #ssh{opts = Opts} = Ssh) ->
     PromptInfos = decode_keyboard_interactive_prompts(NumPrompts,Data),
-    Resps = keyboard_interact_get_responses(IoCb, Opts,
+    Responses = keyboard_interact_get_responses(IoCb, Opts,
 					    Name, Instr, PromptInfos),
-    RespBin = list_to_binary(
-		lists:map(fun(S) -> <<?STRING(list_to_binary(S))>> end,
-			  Resps)),
     {ok, 
      ssh_transport:ssh_packet(
        #ssh_msg_userauth_info_response{num_responses = NumPrompts,
-				       data = RespBin}, Ssh)}.
+				       data = Responses}, Ssh)}.
 
 handle_userauth_info_response(#ssh_msg_userauth_info_response{},
 			      _Auth) ->
@@ -276,25 +270,16 @@ handle_userauth_info_response(#ssh_msg_userauth_info_response{},
 %%--------------------------------------------------------------------
 %%% Internal functions
 %%--------------------------------------------------------------------
-method_preference(Alg1, Alg2, true) ->
+method_preference(Alg1, Alg2) ->
     [{"publickey", ?MODULE, publickey_msg, [Alg1]},
      {"publickey", ?MODULE, publickey_msg,[Alg2]},
      {"password", ?MODULE, password_msg, []},
      {"keyboard-interactive", ?MODULE, keyboard_interactive_msg, []}
-    ];
-method_preference(Alg1, Alg2, false) ->
-    [{"publickey", ?MODULE, publickey_msg, [Alg1]},
-     {"publickey", ?MODULE, publickey_msg,[Alg2]},
-     {"password", ?MODULE, password_msg, []}
     ].
-method_preference(Alg1, true) ->
+method_preference(Alg1) ->
     [{"publickey", ?MODULE, publickey_msg, [Alg1]},
      {"password", ?MODULE, password_msg, []},
      {"keyboard-interactive", ?MODULE, keyboard_interactive_msg, []}
-    ];
-method_preference(Alg1, false) ->
-    [{"publickey", ?MODULE, publickey_msg, [Alg1]},
-     {"password", ?MODULE, password_msg, []}
     ].
 
 user_name(Opts) ->
@@ -362,35 +347,29 @@ build_sig_data(SessionId, User, Service, KeyBlob, Alg) ->
 algorithm_string('ssh-rsa') ->
     "ssh-rsa";
 algorithm_string('ssh-dss') ->
-     "ssh-dss".
+    "ssh-dss".
 
 decode_keyboard_interactive_prompts(_NumPrompts, Data) ->
     ssh_message:decode_keyboard_interactive_prompts(Data, []).
 
 keyboard_interact_get_responses(IoCb, Opts, Name, Instr, PromptInfos) ->
     NumPrompts = length(PromptInfos),
-    case proplists:get_value(keyboard_interact_fun, Opts) of
-	undefined when NumPrompts == 1 ->
-	    %% Special case/fallback for just one prompt
-	    %% (assumed to be the password prompt)
-	    case proplists:get_value(password, Opts) of
-		undefined -> keyboard_interact(IoCb, Name, Instr, PromptInfos, Opts);
-		PW        -> [PW]
-	    end;
-	undefined ->
-	    keyboard_interact(IoCb, Name, Instr, PromptInfos, Opts);
-	KbdInteractFun ->
-	    Prompts = lists:map(fun({Prompt, _Echo}) -> Prompt end,
-				PromptInfos),
-	    case KbdInteractFun(Name, Instr, Prompts) of
-		Rs when length(Rs) == NumPrompts ->
-		    Rs;
-		Rs ->
-		    erlang:error({mismatching_number_of_responses,
-				  {got,Rs},
-				  {expected,NumPrompts}})
-	    end
-    end.
+    keyboard_interact_get_responses(proplists:get_value(user_interaction, Opts, true),
+				    proplists:get_value(keyboard_interact_fun, Opts),
+				    proplists:get_value(password, Opts, undefined), IoCb, Name,
+				    Instr, PromptInfos, Opts, NumPrompts).
+
+keyboard_interact_get_responses(_, undefined, Password, _, _, _, _, _,
+				1) when Password =/= undefined ->
+    [Password]; %% Password auth implemented with keyboard-interaction and passwd is known
+keyboard_interact_get_responses(_, _, _, _, _, _, _, _, 0)  ->
+    [""];
+keyboard_interact_get_responses(false, undefined, undefined, _, _, _, [Prompt|_], Opts, _) ->
+    ssh_no_io:read_line(Prompt, Opts); %% Throws error as keyboard interaction is not allowed
+keyboard_interact_get_responses(true, undefined, _,IoCb, Name, Instr, PromptInfos, Opts, _) ->
+    keyboard_interact(IoCb, Name, Instr, PromptInfos, Opts);
+keyboard_interact_get_responses(true, Fun, _, Name, Instr, PromptInfos, _, _, NumPrompts) ->
+    keyboard_interact_fun(Fun, Name, Instr, PromptInfos, NumPrompts).
 
 keyboard_interact(IoCb, Name, Instr, Prompts, Opts) ->
     if Name /= "" -> IoCb:format("~s", [Name]);
@@ -404,6 +383,21 @@ keyboard_interact(IoCb, Name, Instr, Prompts, Opts) ->
 	      end,
 	      Prompts).
 
+keyboard_interact_fun(KbdInteractFun, Name, Instr,  PromptInfos, NumPrompts) ->
+    Prompts = lists:map(fun({Prompt, _Echo}) -> Prompt end,
+			PromptInfos),
+    case KbdInteractFun(Name, Instr, Prompts) of
+	Rs when length(Rs) == NumPrompts ->
+	    Rs;
+	Rs ->
+	    throw({mismatching_number_of_responses,
+		   {got,Rs},
+		   {expected, NumPrompts},
+		   #ssh_msg_disconnect{code = ?SSH_DISCONNECT_SERVICE_NOT_AVAILABLE,
+				       description = "User interaction failed",
+				       language = "en"}})
+    end.
+
 other_alg('ssh-rsa') ->
     'ssh-dss';
 other_alg('ssh-dss') ->
diff --git a/lib/ssh/src/ssh_io.erl b/lib/ssh/src/ssh_io.erl
index 35336bce8b..97e2dee27a 100644
--- a/lib/ssh/src/ssh_io.erl
+++ b/lib/ssh/src/ssh_io.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2005-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2005-2014. 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
@@ -73,7 +73,9 @@ read_password(Prompt, Ssh) ->
 listify(A) when is_atom(A) ->
     atom_to_list(A);
 listify(L) when is_list(L) ->
-    L.
+    L;
+listify(B) when is_binary(B)  ->
+    binary_to_list(B).
 
 format(Fmt, Args) ->
     io:format(Fmt, Args).
diff --git a/lib/ssh/src/ssh_message.erl b/lib/ssh/src/ssh_message.erl
index 76b57cb995..891ccec24c 100644
--- a/lib/ssh/src/ssh_message.erl
+++ b/lib/ssh/src/ssh_message.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2013-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2013-2014. 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
@@ -162,8 +162,15 @@ encode(#ssh_msg_userauth_info_request{
 encode(#ssh_msg_userauth_info_response{
 	  num_responses = Num,
 	  data = Data}) ->
-    ssh_bits:encode([?SSH_MSG_USERAUTH_INFO_RESPONSE, Num, Data],
-		    [byte, uint32, '...']);
+    Responses = lists:map(fun("") ->
+				  <<>>;
+			     (Response) ->
+				  ssh_bits:encode([Response], [string])
+			  end, Data),
+    Start = ssh_bits:encode([?SSH_MSG_USERAUTH_INFO_RESPONSE, Num],
+			    [byte, uint32]),
+    iolist_to_binary([Start, Responses]);
+
 encode(#ssh_msg_disconnect{
 	  code = Code,
 	  description = Desc,
diff --git a/lib/ssh/src/ssh_sftp.erl b/lib/ssh/src/ssh_sftp.erl
index 0ea2366ac7..721146c509 100644
--- a/lib/ssh/src/ssh_sftp.erl
+++ b/lib/ssh/src/ssh_sftp.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2005-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2005-2014. 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
@@ -57,7 +57,8 @@
 	  rep_buf = <<>>,
 	  req_id,
 	  req_list = [],  %% {ReqId, Fun}
-	  inf   %% list of fileinf
+	  inf,   %% list of fileinf,
+	  opts
 	 }).
 
 -record(fileinf,
@@ -85,10 +86,11 @@ start_channel(Host) when is_list(Host) ->
     start_channel(Host, []).					 
 start_channel(Cm, Opts) when is_pid(Cm) ->
     Timeout = proplists:get_value(timeout, Opts, infinity),
+    {_, SftpOpts} = handle_options(Opts, [], []),
     case ssh_xfer:attach(Cm, []) of
 	{ok, ChannelId, Cm} -> 
 	    case ssh_channel:start(Cm, ChannelId, 
-				   ?MODULE, [Cm, ChannelId, Timeout]) of
+				   ?MODULE, [Cm, ChannelId, SftpOpts]) of
 		{ok, Pid} ->
 		    case wait_for_version_negotiation(Pid, Timeout) of
 			ok ->
@@ -108,11 +110,12 @@ start_channel(Cm, Opts) when is_pid(Cm) ->
 start_channel(Host, Opts) ->
     start_channel(Host, 22, Opts).
 start_channel(Host, Port, Opts) ->
-    Timeout = proplists:get_value(timeout, Opts, infinity),
-    case ssh_xfer:connect(Host, Port, proplists:delete(timeout, Opts)) of
+    {SshOpts, SftpOpts} = handle_options(Opts, [], []),
+    Timeout = proplists:get_value(timeout, SftpOpts, infinity),
+    case ssh_xfer:connect(Host, Port, SshOpts) of
 	{ok, ChannelId, Cm} ->
 	    case ssh_channel:start(Cm, ChannelId, ?MODULE, [Cm, 
-							    ChannelId, Timeout]) of
+							    ChannelId, SftpOpts]) of
 		{ok, Pid} ->
 		    case wait_for_version_negotiation(Pid, Timeout) of
 			ok ->
@@ -392,7 +395,8 @@ write_file_loop(Pid, Handle, Pos, Bin, Remain, PacketSz, FileOpTimeout) ->
 %%                        
 %% Description: 
 %%--------------------------------------------------------------------
-init([Cm, ChannelId, Timeout]) ->
+init([Cm, ChannelId, Options]) ->
+    Timeout = proplists:get_value(timeout, Options, infinity),
     erlang:monitor(process, Cm),
     case ssh_connection:subsystem(Cm, ChannelId, "sftp", Timeout) of
 	success ->
@@ -401,7 +405,8 @@ init([Cm, ChannelId, Timeout]) ->
 	    {ok, #state{xf = Xf,
 			req_id = 0, 
 			rep_buf = <<>>,
-			inf = new_inf()}};
+			inf = new_inf(),
+			opts = Options}};
 	failure ->
 	    {stop, "server failed to start sftp subsystem"};
 	Error ->
@@ -707,8 +712,9 @@ handle_ssh_msg({ssh_cm, _, {exit_status, ChannelId, Status}}, State0) ->
 %%                        
 %% Description: Handles channel messages
 %%--------------------------------------------------------------------
-handle_msg({ssh_channel_up, _, _}, #state{xf = Xf} = State) ->
-    ssh_xfer:protocol_version_request(Xf),
+handle_msg({ssh_channel_up, _, _}, #state{opts = Options, xf = Xf} = State) ->
+    Version = proplists:get_value(sftp_vsn, Options, ?SSH_SFTP_PROTOCOL_VERSION),
+    ssh_xfer:protocol_version_request(Xf, Version),
     {ok, State};
 
 %% Version negotiation timed out
@@ -754,6 +760,15 @@ terminate(_Reason, State) ->
 %%====================================================================
 %% Internal functions
 %%====================================================================
+handle_options([], Sftp, Ssh) ->
+    {Ssh, Sftp};
+handle_options([{timeout, _} = Opt | Rest], Sftp, Ssh) ->
+    handle_options(Rest, [Opt | Sftp], Ssh);
+handle_options([{sftp_vsn, _} = Opt| Rest], Sftp, Ssh) ->
+    handle_options(Rest, [Opt | Sftp], Ssh);
+handle_options([Opt | Rest], Sftp, Ssh) ->
+    handle_options(Rest, Sftp, [Opt | Ssh]).
+
 call(Pid, Msg, TimeOut) ->
     ssh_channel:call(Pid, {{timeout, TimeOut}, Msg}, infinity).
 
diff --git a/lib/ssh/src/ssh_xfer.erl b/lib/ssh/src/ssh_xfer.erl
index 63d01fd9de..1881392db8 100644
--- a/lib/ssh/src/ssh_xfer.erl
+++ b/lib/ssh/src/ssh_xfer.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2005-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2005-2014. 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
@@ -28,7 +28,7 @@
 	 rename/5, remove/3, mkdir/4, rmdir/3, realpath/3, extended/4,
 	 stat/4, fstat/4, lstat/4, setstat/4,
 	 readlink/3, fsetstat/4, symlink/4,
-	 protocol_version_request/1,
+	 protocol_version_request/2,
 	 xf_reply/2,
 	 xf_send_reply/3, xf_send_names/3, xf_send_name/4,
 	 xf_send_status/3, xf_send_status/4, xf_send_status/5,
@@ -67,8 +67,8 @@ open_xfer(CM, Opts) ->
 	    Error
     end.
 
-protocol_version_request(XF) ->
-    xf_request(XF, ?SSH_FXP_INIT, <<?UINT32(?SSH_SFTP_PROTOCOL_VERSION)>>).
+protocol_version_request(XF, Version) ->
+    xf_request(XF, ?SSH_FXP_INIT, <<?UINT32(Version)>>).
 
 open(XF, ReqID, FileName, Access, Flags, Attrs) -> 
     Vsn = XF#ssh_xfer.vsn,
diff --git a/lib/ssh/test/ssh_sftp_SUITE.erl b/lib/ssh/test/ssh_sftp_SUITE.erl
index 56b1363b7a..4c46a1b1a8 100644
--- a/lib/ssh/test/ssh_sftp_SUITE.erl
+++ b/lib/ssh/test/ssh_sftp_SUITE.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2005-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2005-2014. 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
@@ -65,7 +65,7 @@ groups() ->
     [{erlang_server, [], [open_close_file, open_close_dir, read_file, read_dir,
 			  write_file, rename_file, mk_rm_dir, remove_file, links,
 			  retrieve_attributes, set_attributes, async_read,
-			  async_write, position, pos_read, pos_write]},
+			  async_write, position, pos_read, pos_write, version_option]},
      {openssh_server, [], [open_close_file, open_close_dir, read_file, read_dir,
 			   write_file, rename_file, mk_rm_dir, remove_file, links,
 			   retrieve_attributes, set_attributes, async_read,
@@ -111,6 +111,21 @@ init_per_testcase(sftp_nonexistent_subsystem, Config) ->
 				]),
     [{sftpd, Sftpd} | Config];
 
+init_per_testcase(version_option, Config) ->
+    prep(Config),
+    TmpConfig0 = lists:keydelete(watchdog, 1, Config),
+    TmpConfig = lists:keydelete(sftp, 1, TmpConfig0),
+    Dog = ct:timetrap(?default_timeout),
+    {_,Host, Port} =  ?config(sftpd, Config),
+    {ok, ChannelPid, Connection}  = 
+	ssh_sftp:start_channel(Host, Port,
+			       [{sftp_vsn, 3},
+				{user, ?USER},
+				{password, ?PASSWD},
+				{user_interaction, false},
+				{silently_accept_hosts, true}]),
+    Sftp = {ChannelPid, Connection},
+    [{sftp, Sftp}, {watchdog, Dog} | TmpConfig];
 init_per_testcase(Case, Config) ->
     prep(Config),
     TmpConfig0 = lists:keydelete(watchdog, 1, Config),
@@ -447,6 +462,11 @@ sftp_nonexistent_subsystem(Config) when is_list(Config) ->
 				{silently_accept_hosts, true}]).
 
 %%--------------------------------------------------------------------
+version_option()  ->
+    [{doc, "Test API option sftp_vsn"}].
+version_option(Config) when is_list(Config) ->
+    open_close_dir(Config).
+%%--------------------------------------------------------------------
 %% Internal functions ------------------------------------------------
 %%--------------------------------------------------------------------
 prep(Config) ->
diff --git a/lib/ssh/vsn.mk b/lib/ssh/vsn.mk
index 11f30e8d04..866b192101 100644
--- a/lib/ssh/vsn.mk
+++ b/lib/ssh/vsn.mk
@@ -1,5 +1,5 @@
 #-*-makefile-*-   ; force emacs to enter makefile-mode
 
-SSH_VSN = 3.0.6
+SSH_VSN = 3.0.7
 APP_VSN    = "ssh-$(SSH_VSN)"