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

Update documentation

pull/809/head
Jeffrey Walton 2019-02-15 08:57:54 -05:00
parent e8bb20d84f
commit f44d4cb5b8
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 29 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
shake.h
View File

@ -72,6 +72,11 @@ public:
{ return "SHAKE-" + IntToString(T_Strength); } { return "SHAKE-" + IntToString(T_Strength); }
/// \brief Construct a SHAKE-X message digest /// \brief Construct a SHAKE-X message digest
/// \details SHAKE128 and SHAKE256 don't need the output size in advance
/// because the output size does not affect the digest. TruncatedFinal
/// produces the correct digest for any output size. However, cSHAKE
/// requires the output size in advance because the algoirthm uses
/// output size as a parameter to the hash function.
SHAKE_Final(unsigned int outputSize=DIGESTSIZE) : SHAKE(outputSize) {} SHAKE_Final(unsigned int outputSize=DIGESTSIZE) : SHAKE(outputSize) {}
/// \brief Provides the block size of the compression function /// \brief Provides the block size of the compression function
@ -104,13 +109,21 @@ private:
class SHAKE128 : public SHAKE_Final<128> class SHAKE128 : public SHAKE_Final<128>
{ {
public: public:
/// \details Construct a SHAKE128 message digest /// \brief Construct a SHAKE128 message digest
/// \details SHAKE128() uses the default output digest size /// \details SHAKE128 and SHAKE256 don't need the output size in advance
/// because the output size does not affect the digest. TruncatedFinal
/// produces the correct digest for any output size. However, cSHAKE
/// requires the output size in advance because the algoirthm uses
/// output size as a parameter to the hash function.
/// \since Crypto++ 8.1 /// \since Crypto++ 8.1
SHAKE128() {} SHAKE128() {}
/// \details Construct a SHAKE128 message digest /// \brief Construct a SHAKE128 message digest
/// \details SHAKE128() uses <tt>outputSize</tt> digest size /// \details SHAKE128 and SHAKE256 don't need the output size in advance
/// because the output size does not affect the digest. TruncatedFinal
/// produces the correct digest for any output size. However, cSHAKE
/// requires the output size in advance because the algoirthm uses
/// output size as a parameter to the hash function.
/// \since Crypto++ 8.1 /// \since Crypto++ 8.1
SHAKE128(unsigned int outputSize) : SHAKE_Final(outputSize) {} SHAKE128(unsigned int outputSize) : SHAKE_Final(outputSize) {}
}; };
@ -126,13 +139,21 @@ public:
class SHAKE256 : public SHAKE_Final<256> class SHAKE256 : public SHAKE_Final<256>
{ {
public: public:
/// \details Construct a SHAKE256 message digest /// \brief Construct a SHAKE256 message digest
/// \details SHAKE256() uses the default output digest size /// \details SHAKE128 and SHAKE256 don't need the output size in advance
/// because the output size does not affect the digest. TruncatedFinal
/// produces the correct digest for any output size. However, cSHAKE
/// requires the output size in advance because the algoirthm uses
/// output size as a parameter to the hash function.
/// \since Crypto++ 8.1 /// \since Crypto++ 8.1
SHAKE256() {} SHAKE256() {}
/// \details Construct a SHAKE256 message digest /// \brief Construct a SHAKE256 message digest
/// \details SHAKE256() uses <tt>outputSize</tt> digest size /// \details SHAKE128 and SHAKE256 don't need the output size in advance
/// because the output size does not affect the digest. TruncatedFinal
/// produces the correct digest for any output size. However, cSHAKE
/// requires the output size in advance because the algoirthm uses
/// output size as a parameter to the hash function.
/// \since Crypto++ 8.1 /// \since Crypto++ 8.1
SHAKE256(unsigned int outputSize) : SHAKE_Final(outputSize) {} SHAKE256(unsigned int outputSize) : SHAKE_Final(outputSize) {}
}; };