diff --git a/keccak.h b/keccak.h index 4d75b5e5..41302c79 100644 --- a/keccak.h +++ b/keccak.h @@ -7,8 +7,6 @@ //! desire FIPS 202 behavior, then use SHA3 classes. //! \details Keccak will likely change in the future to accomodate extensibility of the //! round function and the XOF functions. -//! \details Perform the following to specify a different digest size. It will use F1600 and 0x80. -//!
Keccack_192 : public Keccack //! \sa Keccak #ifndef CRYPTOPP_KECCAK_H @@ -24,6 +22,9 @@ NAMESPACE_BEGIN(CryptoPP) //! \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 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. //! \details Keccak will likely change in the future to accomodate extensibility of the //! round function and the XOF functions. //! \details Perform the following to specify a different digest size. The class will use F1600, 0x80, @@ -36,13 +37,14 @@ NAMESPACE_BEGIN(CryptoPP) //! }; //!//! +//! \sa SHA3, Keccak_224, Keccak_256, Keccak_384 and Keccak_512. class Keccak : public HashTransformation { public: //! \brief Construct a Keccak //! \param digestSize the digest size, in bytes //! \details Keccak is the base class for Keccak_224, Keccak_256, Keccak_384 and Keccak_512. - //! Library users should construct a derived class instead, and only use Keccak + //! Library users should instantiate a derived class, and only use Keccak //! as a base class reference or pointer. Keccak(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} unsigned int DigestSize() const {return m_digestSize;} diff --git a/sha3.h b/sha3.h index ed3a03b8..0337fbac 100644 --- a/sha3.h +++ b/sha3.h @@ -3,7 +3,7 @@ //! \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 Keccak classes. +//! Previous behavior is available in SHA3 classes. //! \sa SHA-3, //! SHA-3 STANDARD (FIPS 202). @@ -17,13 +17,17 @@ 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. class SHA3 : public HashTransformation { public: //! \brief Construct a SHA3 //! \param digestSize the digest size, in bytes //! \details SHA3 is the base class for SHA3_224, SHA3_256, SHA3_384 and SHA3_512. - //! Library users should construct a derived class instead, and only use SHA3 + //! Library users should instantiate a derived class, and only use SHA3 //! as a base class reference or pointer. SHA3(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} unsigned int DigestSize() const {return m_digestSize;}