From c57c9dc983424e15c9f499ff958d7e6ff5827e7b Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Wed, 8 Nov 2017 12:20:33 +0100
Subject: ssh: Update ssh_{server|client}_key doc to what it should have been

---
 lib/ssh/doc/src/ssh_client_key_api.xml | 33 ++++++++++++++++++++-------------
 lib/ssh/doc/src/ssh_server_key_api.xml | 23 +++++++++++++++--------
 2 files changed, 35 insertions(+), 21 deletions(-)

diff --git a/lib/ssh/doc/src/ssh_client_key_api.xml b/lib/ssh/doc/src/ssh_client_key_api.xml
index a1cd9d4b02..98a1676ca4 100644
--- a/lib/ssh/doc/src/ssh_client_key_api.xml
+++ b/lib/ssh/doc/src/ssh_client_key_api.xml
@@ -56,11 +56,17 @@
       <tag><c>string() =</c></tag>
       <item><p><c>[byte()]</c></p></item>
       <tag><c>public_key() =</c></tag>
-      <item><p><c>#'RSAPublicKey'{}| {integer(),  #'Dss-Parms'{}}| term()</c></p></item>
+      <item><p><c>#'RSAPublicKey'{} 
+      | {integer(),#'Dss-Parms'{}} 
+      | {#'ECPoint'{},{namedCurve,Curve::string()}}</c></p></item>
       <tag><c>private_key() =</c></tag>
-      <item><p><c>#'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()</c></p></item>
+      <item><p><c>#'RSAPrivateKey'{} 
+      | #'DSAPrivateKey'{} 
+      | #'ECPrivateKey'{}</c></p></item>      
       <tag><c>public_key_algorithm() =</c></tag>
-      <item><p><c>'ssh-rsa'| 'ssh-dss' | atom()</c></p></item>
+      <item><p><c>'ssh-rsa' | 'ssh-dss' 
+      | 'rsa-sha2-256' | 'rsa-sha2-384' | 'rsa-sha2-512' 
+      | 'ecdsa-sha2-nistp256' | 'ecdsa-sha2-nistp384' | 'ecdsa-sha2-nistp521' </c></p></item>
     </taglist>
   </section>
 
@@ -73,10 +79,11 @@
       <d>Description of the host that owns the <c>PublicKey</c>.</d>
 
       <v>Key = public_key()</v>
-      <d>Normally an RSA or DSA public key, but handling of other public keys can be added.</d>
+      <d>Normally an RSA, DSA or ECDSA public key, but handling of other public keys can be added.</d>
 
       <v>ConnectOptions = proplists:proplist()</v>
-      <d>Options provided to <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso></d>
+      <d>Options provided to <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso>. The option list given in
+	the <c>key_cb</c> option is available with the key <c>key_cb_private</c>.</d>
       <v>Reason = term().</v>
       </type>
       <desc>
@@ -89,17 +96,17 @@
       <fsummary>Checks if a host key is trusted.</fsummary>
       <type>
 	<v>Key = public_key() </v>
-	<d>Normally an RSA or DSA public key, but handling of other public keys can be added.</d>
+	<d>Normally an RSA, DSA or ECDSA public key, but handling of other public keys can be added.</d>
 
 	<v>Host = string()</v>
 	<d>Description of the host.</d>
 
 	<v>Algorithm = public_key_algorithm()</v>
-	<d>Host key algorithm. Is to support <c>'ssh-rsa'| 'ssh-dss'</c>, but more algorithms
-	can be handled.</d>
+	<d>Host key algorithm.</d>
 
 	<v>ConnectOptions = proplists:proplist() </v>
-	<d>Options provided to <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso>.</d>
+	<d>Options provided to <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso>. The option list given in
+	the <c>key_cb</c> option is available with the key <c>key_cb_private</c>.</d>
 
 	<v>Result = boolean()</v>
       </type>
@@ -110,15 +117,15 @@
 
     <func>
       <name>Module:user_key(Algorithm, ConnectOptions) ->
-      {ok,  PrivateKey}  | {error, Reason}</name>
+      {ok, PrivateKey}  | {error, Reason}</name>
       <fsummary>Fetches the users <em>public key</em> matching the <c>Algorithm</c>.</fsummary>
       <type>
 	<v>Algorithm = public_key_algorithm()</v>
-	<d>Host key algorithm. Is to support <c>'ssh-rsa'| 'ssh-dss'</c> but more algorithms
-	can be handled.</d>
+	<d>Host key algorithm.</d>
 
 	<v>ConnectOptions = proplists:proplist()</v>
-	<d>Options provided to <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso></d>
+	<d>Options provided to <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso>. The option list given in
+	the <c>key_cb</c> option is available with the key <c>key_cb_private</c>.</d>
 
 	<v>PrivateKey = private_key()</v>
 	<d>Private key of the user matching the <c>Algorithm</c>.</d>
diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml
index a0694ca8d9..0d7b079e19 100644
--- a/lib/ssh/doc/src/ssh_server_key_api.xml
+++ b/lib/ssh/doc/src/ssh_server_key_api.xml
@@ -57,11 +57,17 @@
       <tag><c>string() =</c></tag>
       <item><p><c>[byte()]</c></p></item>
       <tag><c>public_key() =</c></tag>
-      <item><p><c>#'RSAPublicKey'{}| {integer(),  #'Dss-Parms'{}}| term()</c></p></item>
+      <item><p><c>#'RSAPublicKey'{} 
+      | {integer(),#'Dss-Parms'{}} 
+      | {#'ECPoint'{},{namedCurve,Curve::string()}}</c></p></item>
       <tag><c>private_key() =</c></tag>
-      <item><p><c>#'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()</c></p></item>
+      <item><p><c>#'RSAPrivateKey'{} 
+      | #'DSAPrivateKey'{} 
+      | #'ECPrivateKey'{}</c></p></item>      
       <tag><c>public_key_algorithm() =</c></tag>
-      <item><p><c>'ssh-rsa'| 'ssh-dss' | atom()</c></p></item>
+      <item><p><c>'ssh-rsa' | 'ssh-dss' 
+      | 'rsa-sha2-256' | 'rsa-sha2-384' | 'rsa-sha2-512'
+      | 'ecdsa-sha2-nistp256' | 'ecdsa-sha2-nistp384' | 'ecdsa-sha2-nistp521' </c></p></item>
     </taglist>
   </section>
   
@@ -72,10 +78,10 @@
       <fsummary>Fetches the host’s private key.</fsummary>
       <type>
 	<v>Algorithm = public_key_algorithm()</v>
-	<d>Host key algorithm. Is to support <c>'ssh-rsa' | 'ssh-dss'</c>, but more algorithms
-	can be handled.</d>
+	<d>Host key algorithm.</d>
 	<v>DaemonOptions = proplists:proplist()</v>
-	<d>Options provided to <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso>.</d>
+	<d>Options provided to <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso>. The option list given in
+	the <c>key_cb</c> option is available with the key <c>key_cb_private</c>.</d>
 	<v>Key = private_key()</v>
 	<d>Private key of the host matching the <c>Algorithm</c>.</d>
 	<v>Reason = term()</v>
@@ -90,11 +96,12 @@
       <fsummary>Checks if the user key is authorized.</fsummary>
       <type>
 	<v>Key = public_key()</v>
-	<d>Normally an RSA or DSA public key, but handling of other public keys can be added</d>
+	<d>Normally an RSA, DSA or ECDSA public key, but handling of other public keys can be added</d>
 	<v>User = string()</v>
 	<d>User owning the public key.</d>
 	<v>DaemonOptions = proplists:proplist()</v>
-	<d>Options provided to  <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso>.</d>
+	<d>Options provided to <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso>. The option list given in
+	the <c>key_cb</c> option is available with the key <c>key_cb_private</c>.</d>
 	<v>Result = boolean()</v>
       </type>
       <desc>
-- 
cgit v1.2.3