From c8d09a8237f1d610ab0806fae3e929652811549b Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Wed, 15 Aug 2018 11:36:49 +0200
Subject: crypto: doc poly1305

---
 lib/crypto/doc/src/crypto.xml | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'lib/crypto/doc/src/crypto.xml')

diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index c104e29a1e..889e5616dd 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -195,7 +195,7 @@
      <code> cipher_algorithms() = aes_cbc | aes_cfb8 | aes_cfb128 | aes_ctr | aes_gcm |
      aes_ige256 | blowfish_cbc | blowfish_cfb64 | chacha20 | chacha20_poly1305 | des_cbc |
      des_cfb | des3_cbc | des3_cfb | des_ede3 | rc2_cbc | rc4 </code>
-     <code> mac_algorithms() = hmac | cmac</code>
+     <code> mac_algorithms() = hmac | cmac | poly1305</code>
      <code> public_key_algorithms() = rsa |dss | ecdsa | dh | ecdh | ec_gf2m</code>
      <p>Note that ec_gf2m is not strictly a public key algorithm, but a restriction on what curves are supported
      with ecdsa and ecdh.
@@ -597,6 +597,20 @@
    </desc>
     </func>
 
+    <func>
+      <name>poly1305(Key, Data) -> Mac</name>
+      <fsummary></fsummary>
+      <type>
+        <v>Key = iodata()</v>
+	<v>Data = iodata()</v>
+	<v>Mac = binary()</v>
+      </type>
+      <desc>
+        <p>Computes a POLY1305 message authentication code (<c>Mac</c>) from <c>Data</c> using
+        <c>Key</c> as the authentication key.</p>
+      </desc>
+    </func>
+
     <func>
       <name>private_decrypt(Type, CipherText, PrivateKey, Padding) -> PlainText</name>
       <fsummary>Decrypts CipherText using the private Key.</fsummary>
-- 
cgit v1.2.3