crypto: Documentation

1 files changed, 23 insertions, 40 deletions

diff --git a/lib/crypto/doc/src/algorithm_details.xml b/lib/crypto/doc/src/algorithm_details.xml
index 854bfbb4b1..85ae766c35 100644
--- a/lib/crypto/doc/src/algorithm_details.xml
+++ b/lib/crypto/doc/src/algorithm_details.xml
@@ -48,8 +48,7 @@
       <p>Available in all OpenSSL compatible with Erlang CRYPTO if not disabled by configuration.
       </p>
       <p>To dynamically check availability, check that the name in the <i>Cipher and Mode</i> column is present in the
-      list with the <c>cipher</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(ciphers)</seealso>.
       </p>
       <table>
 	<row><cell><strong>Cipher and Mode</strong></cell><cell><strong>Key length</strong><br/><strong>[bytes]</strong></cell><cell><strong>IV length</strong><br/><strong>[bytes]</strong></cell><cell><strong>Block size</strong><br/><strong>[bytes]</strong></cell></row>
@@ -85,8 +84,7 @@
       <seealso marker="crypto#block_decrypt-4">block_decrypt/4</seealso>.
       </p>
       <p>To dynamically check availability, check that the name in the <i>Cipher and Mode</i> column is present in the
-      list with the <c>cipher</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(ciphers)</seealso>.
       </p>
       <table>
 	<row><cell><strong>Cipher and Mode</strong></cell><cell><strong>Key length</strong><br/><strong>[bytes]</strong></cell><cell><strong>IV length</strong><br/><strong>[bytes]</strong></cell><cell><strong>AAD length</strong><br/><strong>[bytes]</strong></cell><cell><strong>Tag length</strong><br/><strong>[bytes]</strong></cell><cell><strong>Block size</strong><br/><strong>[bytes]</strong></cell><cell><strong>Supported with</strong><br/><strong>OpenSSL versions</strong></cell></row>
@@ -103,8 +101,7 @@
       <seealso marker="crypto#stream_init/3">stream_init/3</seealso>.
       </p>
       <p>To dynamically check availability, check that the name in the <i>Cipher and Mode</i> column is present in the
-      list with the <c>cipher</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(ciphers)</seealso>.
       </p>
       <table>
 	<row><cell><strong>Cipher and Mode</strong></cell><cell><strong>Key length</strong><br/><strong>[bytes]</strong></cell><cell><strong>IV length</strong><br/><strong>[bytes]</strong></cell><cell><strong>Supported with</strong><br/><strong>OpenSSL versions</strong></cell></row>
@@ -117,20 +114,19 @@
 
   <section>
     <title>Message Authentication Codes (MACs)</title>
+    <p>To be used in <seealso marker="crypto#mac-4">mac/4</seealso> and
+    <seealso marker="crypto:new_api#macs--message-authentication-codes-">related functions</seealso>.
+    </p>
 
     <section>
       <title>CMAC</title>
-      <p>To be used in <seealso marker="crypto#cmac-3">cmac/3</seealso> and
-      <seealso marker="crypto#cmac-3">cmac/4</seealso>.
-      </p>
       <p>CMAC with the following ciphers are available with OpenSSL 1.0.1 or later if not disabled by configuration.
       </p>
 
       <p>To dynamically check availability, check that the name <c>cmac</c> is present in the
-      list with the <c>macs</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(macs)</seealso>.
       Also check that the name in the <i>Cipher and Mode</i> column is present in the
-      list with the <c>cipher</c> tag in the return value.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(ciphers)</seealso>.
       </p>
       <table>
 	<row><cell><strong>Cipher and Mode</strong></cell><cell><strong>Key length</strong><br/><strong>[bytes]</strong></cell><cell><strong>Max Mac Length</strong><br/><strong>[bytes]</strong></cell></row>
@@ -162,8 +158,7 @@
       <p>Available in all OpenSSL compatible with Erlang CRYPTO if not disabled by configuration.
       </p>
       <p>To dynamically check availability, check that the name <c>hmac</c> is present in the
-      list with the <c>macs</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(macs)</seealso>.
       </p>
     </section>
 
@@ -172,8 +167,7 @@
       <p>POLY1305 is available with OpenSSL 1.1.1 or later if not disabled by configuration.
       </p>
       <p>To dynamically check availability, check that the name <c>poly1305</c> is present in the
-      list with the <c>macs</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(macs)</seealso>.
       </p>
     </section>
 
@@ -183,11 +177,9 @@
     <title>Hash</title>
 
     <p>To dynamically check availability, check that the wanted name in the <i>Names</i> column is present in the
-    list with the <c>hashs</c> tag in the return value of
-    <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+    list returned by <seealso marker="crypto#supports-1">crypto:supports(hashs)</seealso>.
     </p>
 
-
     <table>
       <row><cell><strong>Type</strong></cell>
            <cell><strong>Names</strong></cell>
@@ -210,8 +202,7 @@
       <title>RSA</title>
       <p>RSA is available with all OpenSSL versions compatible with Erlang CRYPTO if not disabled by configuration.
       To dynamically check availability, check that the atom <c>rsa</c> is present in the
-      list with the <c>public_keys</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>.
       </p>
       <warning>
 	<!-- In RefMan rsa_opt(), rsa_sign_verify_opt() and User's man RSA -->
@@ -283,8 +274,7 @@
       <title>DSS</title>
       <p>DSS is available with OpenSSL versions compatible with Erlang CRYPTO if not disabled by configuration.
       To dynamically check availability, check that the atom <c>dss</c> is present in the
-      list with the <c>public_keys</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>.
       </p>
     </section>
 
@@ -292,13 +282,11 @@
       <title>ECDSA</title>
       <p>ECDSA is available with OpenSSL 0.9.8o or later if not disabled by configuration.
       To dynamically check availability, check that the atom <c>ecdsa</c> is present in the
-      list with the <c>public_keys</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
-      If the atom <c>ec_gf2m</c> characteristic two field curves are available.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>.
+      If the atom <c>ec_gf2m</c> also is present, the characteristic two field curves are available.
       </p>
-      <p>The actual supported named curves could be checked by examining the list with the
-      <c>curves</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      <p>The actual supported named curves could be checked by examining the
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(curves)</seealso>.
       </p>
     </section>
 
@@ -306,13 +294,11 @@
       <title>EdDSA</title>
       <p>EdDSA is available with OpenSSL 1.1.1 or later if not disabled by configuration.
       To dynamically check availability, check that the atom <c>eddsa</c> is present in the
-      list with the <c>public_keys</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>.
       </p>
       <p>Support for the curves ed25519 and ed448 is implemented.
       The actual supported named curves could be checked by examining the list with the
-      <c>curves</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(curves)</seealso>.
       </p>
     </section>
 
@@ -321,8 +307,7 @@
       <p>Diffie-Hellman computations are available with OpenSSL versions compatible with Erlang CRYPTO
       if not disabled by configuration.
       To dynamically check availability, check that the atom <c>dh</c> is present in the
-      list with the <c>public_keys</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>.
       </p>
     </section>
 
@@ -330,17 +315,15 @@
       <title>Elliptic Curve Diffie-Hellman</title>
       <p>Elliptic Curve Diffie-Hellman is available with OpenSSL 0.9.8o or later if not disabled by configuration.
       To dynamically check availability, check that the atom <c>ecdh</c> is present in the
-      list with the <c>public_keys</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>.
       </p>
 
       <p>The Edward curves <c>x25519</c> and <c>x448</c> are supported with OpenSSL 1.1.1 or later
       if not disabled by configuration.
       </p>
 
-      <p>The actual supported named curves could be checked by examining the list with the
-      <c>curves</c> tag in the return value of
-      <seealso marker="crypto#supports-0">crypto:supports()</seealso>.
+      <p>The actual supported named curves could be checked by examining the
+      list returned by <seealso marker="crypto#supports-1">crypto:supports(curves)</seealso>.
       </p>
     </section>