ssh: Add option sftp_vsn

4 files changed, 63 insertions, 17 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_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) ->