arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation

pull/347/head
Jeffrey Walton 2016-11-28 10:37:28 -05:00
parent 4ee9fe3acc
commit 8af3937728
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
poly1305.h
View File

@ -102,6 +102,7 @@ protected:
}; };
//! \class Poly1305 //! \class Poly1305
//! \brief Poly1305 message authentication code
//! \details Poly1305-AES is a state-of-the-art message-authentication code suitable for a wide //! \details Poly1305-AES is a state-of-the-art message-authentication code suitable for a wide
//! variety of applications. Poly1305-AES computes a 16-byte authenticator of a variable-length //! variety of applications. Poly1305-AES computes a 16-byte authenticator of a variable-length
//! message, using a 16-byte AES key, a 16-byte additional key, and a 16-byte nonce. //! message, using a 16-byte AES key, a 16-byte additional key, and a 16-byte nonce.
@ -135,8 +136,8 @@ protected:
//! poly1305.Update(...); //! poly1305.Update(...);
//! poly1305.Final(...); //! poly1305.Final(...);
//! ...</pre> //! ...</pre>
//! \warn The Poly1305 class does not enforce a fresh nonce for each message. The source code //! \warning The Poly1305 class does not enforce a fresh nonce for each message. The source code
//! will assert in debug builds to alert of nonce reuse. No action is taken in releas builds. //! will assert in debug builds to alert of nonce reuse. No action is taken in release builds.
//! \sa Daniel J. Bernstein <A HREF="http://cr.yp.to/mac/poly1305-20050329.pdf">The Poly1305-AES //! \sa Daniel J. Bernstein <A HREF="http://cr.yp.to/mac/poly1305-20050329.pdf">The Poly1305-AES
//! Message-Authentication Code (20050329)</A> and Andy Polyakov <A //! Message-Authentication Code (20050329)</A> and Andy Polyakov <A
//! HREF="http://www.openssl.org/blog/blog/2016/02/15/poly1305-revised/">Poly1305 Revised</A> //! HREF="http://www.openssl.org/blog/blog/2016/02/15/poly1305-revised/">Poly1305 Revised</A>