From ff8fc212301b3322f6ce1c45aed9f2de19e570ca Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 6 Jul 2017 15:04:13 +0200
Subject: public_key: doc for new sign/4 and verify/5

---
 lib/public_key/doc/src/public_key.xml | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

(limited to 'lib')

diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
index 04966ffb9c..35f9e86cad 100644
--- a/lib/public_key/doc/src/public_key.xml
+++ b/lib/public_key/doc/src/public_key.xml
@@ -129,18 +129,31 @@
 	<p><c>| 'rsa_no_padding'</c></p>
       </item>
 
+      <tag><c>public_sign_options() =</c></tag>
+      <item><p><c>[{rsa_pad, rsa_sign_padding()} | {rsa_pss_saltlen, integer()}]</c></p></item>
+
+      <tag><c>rsa_sign_padding() =</c></tag>
+      <item>
+	<p><c>'rsa_pkcs1_padding'</c></p>
+	<p><c>| 'rsa_pkcs1_pss_padding'</c></p>
+      </item>
+
       <tag><c>digest_type() = </c></tag>
       <item><p>Union of <c>rsa_digest_type()</c>, <c>dss_digest_type()</c>, 
       and <c>ecdsa_digest_type()</c>.</p></item>
 
       <tag><c>rsa_digest_type() = </c></tag>
-      <item><p><c>'md5' | 'sha' | 'sha224' | 'sha256' | 'sha384' | 'sha512'</c></p></item>
+      <item><p><c>'md5' | 'ripemd160' | 'sha' | 'sha224' | 'sha256' | 'sha384' | 'sha512'</c></p></item>
 
       <tag><c>dss_digest_type() = </c></tag>
-      <item><p><c>'sha'</c></p></item>
+      <item><p><c>'sha' | 'sha224' | 'sha256' | 'sha384' | 'sha512'</c></p>
+      <p>Note that the actual supported dss_digest_type depends on the underlying crypto library.
+      In OpenSSL version >= 1.0.1 the listed digest are supported, while in 1.0.0 only
+      sha, sha224 and sha256 are supported. In version 0.9.8 only sha is supported.</p>
+      </item>
 
       <tag><c>ecdsa_digest_type() = </c></tag>
-      <item><p><c>'sha'| 'sha224' | 'sha256' | 'sha384' | 'sha512'</c></p></item>
+      <item><p><c>'sha' | 'sha224' | 'sha256' | 'sha384' | 'sha512'</c></p></item>
       
       <tag><c>crl_reason() = </c></tag>
       <item>
@@ -795,6 +808,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
 
   <func>
     <name>sign(Msg, DigestType, Key) -> binary()</name>
+    <name>sign(Msg, DigestType, Key, Options) -> binary()</name>
     <fsummary>Creates a digital signature.</fsummary>
     <type>
        <v>Msg = binary() | {digest,binary()}</v>
@@ -803,6 +817,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
        digest.</d>
        <v>DigestType = rsa_digest_type() | dss_digest_type() | ecdsa_digest_type()</v>
        <v>Key = rsa_private_key() | dsa_private_key() | ec_private_key()</v>
+       <v>Options = public_sign_options()</v>
   </type>
   <desc>
     <p>Creates a digital signature.</p> 
@@ -895,6 +910,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
 
   <func>
     <name>verify(Msg, DigestType, Signature, Key) -> boolean()</name>
+    <name>verify(Msg, DigestType, Signature, Key, Options) -> boolean()</name>
     <fsummary>Verifies a digital signature.</fsummary>
     <type>
       <v>Msg = binary() | {digest,binary()}</v>
@@ -903,6 +919,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
       <v>DigestType = rsa_digest_type() | dss_digest_type() | ecdsa_digest_type()</v>
       <v>Signature = binary()</v>
       <v>Key = rsa_public_key() | dsa_public_key() | ec_public_key()</v>
+      <v>Options = public_sign_options()</v>
   </type>
   <desc>
     <p>Verifies a digital signature.</p>
-- 
cgit v1.2.3