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

Update documentation

pull/795/head
Jeffrey Walton 2019-01-27 12:13:09 -05:00
parent 3f37cfc3a3
commit 6ef865fbcd
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
poly1305.h
View File

@ -95,8 +95,8 @@ protected:
/// \details The key is 32 bytes and a concatenation <tt>key = {k,s}</tt>, where /// \details The key is 32 bytes and a concatenation <tt>key = {k,s}</tt>, where
/// <tt>k</tt> is the AES key and <tt>r</tt> is additional key that gets clamped. /// <tt>k</tt> is the AES key and <tt>r</tt> is additional key that gets clamped.
/// The key is clamped internally so there is no need to perform the operation /// The key is clamped internally so there is no need to perform the operation
/// defore setting the key. /// before setting the key.
/// \details Each message must use a unique security context, which means either the key or nonce /// \details Each message must have a unique security context, which means either the key or nonce
/// must be changed after each message. It can be accomplished in one of two ways. First, you /// must be changed after each message. It can be accomplished in one of two ways. First, you
/// can create a new Poly1305 object each time its needed. /// can create a new Poly1305 object each time its needed.
/// <pre> SecByteBlock key(32), nonce(16); /// <pre> SecByteBlock key(32), nonce(16);
@ -125,8 +125,9 @@ protected:
/// poly1305.Update(...); /// poly1305.Update(...);
/// poly1305.Final(...); /// poly1305.Final(...);
/// ...</pre> /// ...</pre>
/// \warning The Poly1305 class does not enforce a fresh nonce for each message. The source code /// \warning Each message must have a unique security context. The Poly1305 class does not
/// will assert in debug builds to alert of nonce reuse. No action is taken in release builds. /// enforce a fresh key or nonce for each message. The source code 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>
@ -148,7 +149,7 @@ public:
/// \details The key is 32 bytes and a concatenation <tt>key = {k,s}</tt>, where /// \details The key is 32 bytes and a concatenation <tt>key = {k,s}</tt>, where
/// <tt>k</tt> is the AES key and <tt>r</tt> is additional key that gets clamped. /// <tt>k</tt> is the AES key and <tt>r</tt> is additional key that gets clamped.
/// The key is clamped internally so there is no need to perform the operation /// The key is clamped internally so there is no need to perform the operation
/// defore setting the key. /// before setting the key.
/// \details Each message requires a unique security context. You can use GetNextIV() /// \details Each message requires a unique security context. You can use GetNextIV()
/// and Resynchronize() to set a new nonce under a key for a message. /// and Resynchronize() to set a new nonce under a key for a message.
Poly1305(const byte *key, size_t keyLength=DEFAULT_KEYLENGTH, const byte *nonce=NULLPTR, size_t nonceLength=0) Poly1305(const byte *key, size_t keyLength=DEFAULT_KEYLENGTH, const byte *nonce=NULLPTR, size_t nonceLength=0)
@ -200,8 +201,8 @@ protected:
/// \details The key is 32 bytes and a concatenation <tt>key = {r,s}</tt>, where /// \details The key is 32 bytes and a concatenation <tt>key = {r,s}</tt>, where
/// <tt>r</tt> is additional key that gets clamped and <tt>s</tt> is the nonce. /// <tt>r</tt> is additional key that gets clamped and <tt>s</tt> is the nonce.
/// The key is clamped internally so there is no need to perform the operation /// The key is clamped internally so there is no need to perform the operation
/// defore setting the key. /// before setting the key.
/// \details Each message must use a unique security context, which means the key /// \details Each message must have a unique security context, which means the key
/// must be changed after each message. It can be accomplished in one of two ways. /// must be changed after each message. It can be accomplished in one of two ways.
/// First, you can create a new Poly1305 object with a new key each time its needed. /// First, you can create a new Poly1305 object with a new key each time its needed.
/// <pre> SecByteBlock key(32); /// <pre> SecByteBlock key(32);
@ -228,6 +229,8 @@ protected:
/// poly1305.Update(...); /// poly1305.Update(...);
/// poly1305.Final(...); /// poly1305.Final(...);
/// ...</pre> /// ...</pre>
/// \warning Each message must have a unique security context. The Poly1305-TLS class
/// does not enforce a fresh key or nonce for each message.
/// \since Crypto++ 8.1 /// \since Crypto++ 8.1
/// \sa MessageAuthenticationCode(), <a href="http://tools.ietf.org/html/rfc8439">RFC /// \sa MessageAuthenticationCode(), <a href="http://tools.ietf.org/html/rfc8439">RFC
/// 8439, ChaCha20 and Poly1305 for IETF Protocols</a> /// 8439, ChaCha20 and Poly1305 for IETF Protocols</a>