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

Updated documentation

pull/263/head
Jeffrey Walton 2016-09-09 05:04:36 -04:00
parent 1df4463c33
commit e4e01a6af3
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
keccak.h
View File

@ -7,8 +7,6 @@
//! desire FIPS 202 behavior, then use SHA3 classes. //! desire FIPS 202 behavior, then use SHA3 classes.
//! \details Keccak will likely change in the future to accomodate extensibility of the //! \details Keccak will likely change in the future to accomodate extensibility of the
//! round function and the XOF functions. //! round function and the XOF functions.
//! \details Perform the following to specify a different digest size. It will use F1600 and 0x80.
//! <pre>Keccack_192 : public Keccack
//! \sa <a href="http://en.wikipedia.org/wiki/Keccak">Keccak</a> //! \sa <a href="http://en.wikipedia.org/wiki/Keccak">Keccak</a>
#ifndef CRYPTOPP_KECCAK_H #ifndef CRYPTOPP_KECCAK_H
@ -24,6 +22,9 @@ NAMESPACE_BEGIN(CryptoPP)
//! \details The Keccak classes use F1600 and XOF byte 0x80, which is effectively //! \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 //! the behavior specified by NIST at round three of the selection process. If you
//! desire FIPS 202 behavior, then use SHA3 classes. //! 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 //! \details Keccak will likely change in the future to accomodate extensibility of the
//! round function and the XOF functions. //! round function and the XOF functions.
//! \details Perform the following to specify a different digest size. The class will use F1600, 0x80, //! \details Perform the following to specify a different digest size. The class will use F1600, 0x80,
@ -36,13 +37,14 @@ NAMESPACE_BEGIN(CryptoPP)
//! }; //! };
//! </pre> //! </pre>
//! //!
//! \sa SHA3, Keccak_224, Keccak_256, Keccak_384 and Keccak_512.
class Keccak : public HashTransformation class Keccak : public HashTransformation
{ {
public: public:
//! \brief Construct a Keccak //! \brief Construct a Keccak
//! \param digestSize the digest size, in bytes //! \param digestSize the digest size, in bytes
//! \details Keccak is the base class for Keccak_224, Keccak_256, Keccak_384 and Keccak_512. //! \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. //! as a base class reference or pointer.
Keccak(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} Keccak(unsigned int digestSize) : m_digestSize(digestSize) {Restart();}
unsigned int DigestSize() const {return m_digestSize;} unsigned int DigestSize() const {return m_digestSize;}

8
sha3.h
View File

@ -3,7 +3,7 @@
//! \file sha3.h //! \file sha3.h
//! \brief Classes for SHA-3 message digests //! \brief Classes for SHA-3 message digests
//! \details The Crypto++ SHA-3 conforms to FIPS 202 version of SHA-3. //! \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 <a href="http://en.wikipedia.org/wiki/SHA-3">SHA-3</a>, //! \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>. //! <A HREF="http://csrc.nist.gov/groups/ST/hash/sha-3/fips202_standard_2015.html">SHA-3 STANDARD (FIPS 202)</A>.
@ -17,13 +17,17 @@ NAMESPACE_BEGIN(CryptoPP)
//! \class SHA3 //! \class SHA3
//! \brief SHA3 message digest base class //! \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 class SHA3 : public HashTransformation
{ {
public: public:
//! \brief Construct a SHA3 //! \brief Construct a SHA3
//! \param digestSize the digest size, in bytes //! \param digestSize the digest size, in bytes
//! \details SHA3 is the base class for SHA3_224, SHA3_256, SHA3_384 and SHA3_512. //! \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. //! as a base class reference or pointer.
SHA3(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} SHA3(unsigned int digestSize) : m_digestSize(digestSize) {Restart();}
unsigned int DigestSize() const {return m_digestSize;} unsigned int DigestSize() const {return m_digestSize;}