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

Updated documentation

pull/263/head
Jeffrey Walton 2016-09-10 18:22:00 -04:00
parent 5155b91178
commit a8a6e41beb
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
keccak.h
View File

@ -2,9 +2,8 @@
//! \file keccak.h
//! \brief Classes for Keccak message digests
//! \details The Keccak classes use F1600 and XOF byte 0x80, which is effectively
//! the behavior specified by NIST at round three of the selection process. If you
//! desire FIPS 202 behavior, then use SHA3 classes.
//! \details The Crypto++ Keccak implementation uses F1600 with XOF d=0x01.
//! FIPS 202 conformance (XOF d=0x06) is available in SHA3 classes.
//! \details Keccak will likely change in the future to accomodate extensibility of the
//! round function and the XOF functions.
//! \sa <a href="http://en.wikipedia.org/wiki/Keccak">Keccak</a>
@ -20,9 +19,8 @@ NAMESPACE_BEGIN(CryptoPP)
//! \class Keccak
//! \brief Keccak message digest base class
//! \details The Keccak classes use F1600 and XOF byte 0x80, which is effectively
//! the behavior specified by NIST at round three of the selection process. If you
//! desire FIPS 202 behavior, then use SHA3 classes.
//! \details The Crypto++ Keccak implementation uses F1600 with XOF d=0x06.
//! FIPS 202 conformance (XOF d=0x01) is available in SHA3 classes.
//! \details Keccak is the base class for Keccak_224, Keccak_256, Keccak_384 and Keccak_512.
//! Library users should instantiate a derived class, and only use Keccak
//! as a base class reference or pointer.

18
sha3.h
View File

@ -1,9 +1,9 @@
// sha3.h - written and placed in the public domain by Wei Dai
//! \file sha3.h
//! \brief Classes for SHA-3 message digests
//! \details The Crypto++ SHA-3 conforms to FIPS 202 version of SHA-3.
//! Previous behavior is available in SHA3 classes.
//! \brief Classes for SHA3 message digests
//! \details The Crypto++ implementation conforms to the FIPS 202 version of SHA3 using F1600 with XOF d=0x06.
//! Previous behavior (XOF d=0x01) is available in Keccak classes.
//! \sa <a href="http://en.wikipedia.org/wiki/SHA-3">SHA-3</a>,
//! <A HREF="http://csrc.nist.gov/groups/ST/hash/sha-3/fips202_standard_2015.html">SHA-3 STANDARD (FIPS 202)</A>.
//! \since Crypto++ 5.6.2
@ -18,11 +18,13 @@ NAMESPACE_BEGIN(CryptoPP)
//! \class SHA3
//! \brief SHA3 message digest base class
//! \details SHA3 is the base class for SHA3_224, SHA3_256, SHA3_384 and SHA3_512.
//! Library users should instantiate a derived class, and only use SHA3
//! as a base class reference or pointer.
//! \sa Keccak, SHA3_224, SHA3_256, SHA3_384 and SHA3_512.
//! \since Crypto++ 5.6.2
//! \details The Crypto++ implementation conforms to FIPS 202 version of SHA3 usinf F1600 with XOF d=0x06.
//! Previous behavior (XOF d=0x01) is available in Keccak classes.
//! \details SHA3 is the base class for SHA3_224, SHA3_256, SHA3_384 and SHA3_512.
//! Library users should instantiate a derived class, and only use SHA3
//! as a base class reference or pointer.
//! \sa Keccak, SHA3_224, SHA3_256, SHA3_384 and SHA3_512.
//! \since Crypto++ 5.6.2
class SHA3 : public HashTransformation
{
public: