Merge remote-tracking branch 'upstream/maint'

1 files changed, 17 insertions, 49 deletions

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 4c0a63566d..679ef9bc19 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -53,8 +53,7 @@
     returned by ssh:daemon/[1,2,3]</c></p>
     <p><c>ssh_connection_ref() - opaque to the user
     returned by ssh:connect/3</c></p>
-    <p><c>ip_address() - {N1,N2,N3,N4} % IPv4 |
-    {K1,K2,K3,K4,K5,K6,K7,K8} % IPv6</c></p>
+    <p><c>ip_address() - inet::ip_address()</c></p>
     <p><c>subsystem_spec() = {subsystem_name(),
     {channel_callback(), channel_init_args()}} </c></p>
     <p><c>subsystem_name() = string() </c></p>
@@ -181,10 +180,6 @@
 	  <item>
 	    <p>Allow an existing file descriptor to be used
 	  (simply passed on to the transport protocol).</p></item>
-	  <tag><c><![CDATA[{ipv6_disabled, boolean()}]]></c></tag>
-	  <item>
-	    <p>Determines if SSH shall use IPv6 or not.</p>
-	  </item>
 	  <tag><c><![CDATA[{rekey_limit, integer()}]]></c></tag>
 	  <item>
 	    <p>Provide, in bytes, when rekeying should be initiated, 
@@ -202,8 +197,11 @@
       Value}] </name>
       <fsummary> Retrieves information about a connection. </fsummary>
       <type>
-        <v>Option = client_version | server_version | peer</v>
-	<v>Value = term() </v>
+        <v>Option = client_version | server_version | user | peer | sockname </v>
+	<v>Value = [option_value()] </v>
+	<v>option_value() = {{Major::integer(), Minor::integer()}, VersionString::string()} | User::string() |
+	Peer::{inet:hostname(), {inet::ip_adress(), inet::port_number()}} |
+	Sockname::{inet::ip_adress(), inet::port_number()} () </v>
       </type>
       <desc>
         <p> Retrieves information about a connection. 
@@ -249,13 +247,14 @@
 	    <c><![CDATA[{shell, start, []}]]></c>
 	  </item>
 	  <tag><c><![CDATA[{ssh_cli, {channel_callback(),
-	  channel_init_args()}}]]></c></tag>
+	  channel_init_args()} | no_cli}]]></c></tag>
 	  <item>
-	    Provides your own cli implementation, i.e. a channel callback
+	    Provides your own CLI implementation, i.e. a channel callback
 	    module that implements a shell and command execution. Note
 	    that you may customize the shell read-eval-print loop using the
 	    option <c>shell</c> which is much less work than implementing
-	    your own cli channel.
+	    your own CLI channel. If set to  <c>no_cli</c> you will disable
+	    CLI channels and only subsystem channels will be allowed.
 	  </item>
 	  <tag><c><![CDATA[{user_dir, String}]]></c></tag>
 	  <item>
@@ -296,7 +295,7 @@
               user. From a security perspective this option makes
 	      the server very vulnerable.</p>
 	  </item>
-	  <tag><c><![CDATA[{pwdfun, fun(User::string(), password::string() -> boolean()}]]></c></tag>
+	  <tag><c><![CDATA[{pwdfun, fun(User::string(), password::string()) -> boolean()}]]></c></tag>
 	  <item>
 	    <p>Provide a function for password validation. This is called
 	      with user and password as strings, and should return
@@ -313,39 +312,22 @@
 	  <item>
 	    <p>Allow an existing file-descriptor to be used
 	  (simply passed on to the transport protocol).</p></item>
-	  <tag><c><![CDATA[{ip_v6_disabled, boolean()}]]></c></tag>
-	  <item>
-	    <p>Determines if SSH shall use IPv6 or not (only used when 
-               HostAddress is set to any).</p></item>
-	  <tag><c><![CDATA[{failfun, fun()}]]></c></tag>
+	  <tag><c><![CDATA[{failfun, fun(User::string(), PeerAddress::ip_address(), Reason::term()) -> _}]]></c></tag>
 	  <item>
-	    <p>Provide a fun() to implement your own logging when a user fails to authenticate.</p>
+	    <p>Provide a fun to implement your own logging when a user fails to authenticate.</p>
 	  </item>
-	  <tag><c><![CDATA[{connectfun, fun()}]]></c></tag>
+	  <tag><c><![CDATA[{connectfun, fun(User::string(), PeerAddress::ip_address(), Method::string()) ->_}]]></c></tag>
 	  <item>
-	    <p>Provide a fun() to implement your own logging when a user authenticates to the server.</p>
+	    <p>Provide a fun to implement your own logging when a user authenticates to the server.</p>
 	  </item>
-	  <tag><c><![CDATA[{disconnectfun, fun()}]]></c></tag>
+	  <tag><c><![CDATA[{disconnectfun, fun(Reason:term()) -> _}]]></c></tag>
 	  <item>
-	    <p>Provide a fun() to implement your own logging when a user disconnects from the server.</p>
+	    <p>Provide a fun to implement your own logging when a user disconnects from the server.</p>
 	  </item>
         </taglist>
       </desc>
     </func>
 
-    <func>
-      <name>peername(ConnectionRef) -> {ok, {Address,Port}} | {error,Error} </name>
-      <fsummary> </fsummary>
-      <type>
-	<v> ConnectionRef = ssh_connection_ref()</v>
-        <v> Address = ip_address()</v>
-	<v> Port = integer()</v>
-      </type>
-      <desc>
-        <p>Returns the address and port for the other end of a connection.
-	</p>
-      </desc>
-    </func>
 
     <func>
       <name>shell(Host) -> </name>
@@ -367,20 +349,6 @@
     </func>
 
     <func>
-      <name>sockname(ConnectionRef) -> {ok, {Address,Port}} | {error,Error} </name>
-      <fsummary> </fsummary>
-      <type>
-	<v> ConnectionRef = ssh_connection_ref()</v>
-        <v> Address = ip_address()</v>
-	<v> Port = integer()</v>
-      </type>
-      <desc>
-        <p>Returns the local address and port number for a connection.
-	</p>
-      </desc>
-    </func>
-
-    <func>
       <name>start() -> </name>
       <name>start(Type) -> ok | {error, Reason}</name>
       <fsummary>Starts the SSH application. </fsummary>