Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
SHA3_256 Class Reference
+ Inheritance diagram for SHA3_256:

Public Member Functions

unsigned int DigestSize () const
 Provides the digest size of the hash. More...
 
std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance. More...
 
void Update (const byte *input, size_t length)
 Updates a hash with additional input. More...
 
void Restart ()
 Restart the hash. More...
 
void TruncatedFinal (byte *hash, size_t size)
 Computes the hash of the current message. More...
 
HashTransformationRef ()
 Provides a reference to this object. More...
 
virtual byte * CreateUpdateSpace (size_t &size)
 Request space which can be written into by the caller. More...
 
virtual void Final (byte *digest)
 Computes the hash of the current message. More...
 
unsigned int TagSize () const
 Provides the tag size of the hash. More...
 
virtual unsigned int BlockSize () const
 Provides the block size of the compression function. More...
 
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this hash. More...
 
virtual void CalculateDigest (byte *digest, const byte *input, size_t length)
 Updates the hash with additional input and computes the hash of the current message. More...
 
virtual bool Verify (const byte *digest)
 Verifies the hash of the current message. More...
 
virtual bool VerifyDigest (const byte *digest, const byte *input, size_t length)
 Updates the hash with additional input and verifies the hash of the current message. More...
 
virtual void CalculateTruncatedDigest (byte *digest, size_t digestSize, const byte *input, size_t length)
 Updates the hash with additional input and computes the hash of the current message. More...
 
virtual bool TruncatedVerify (const byte *digest, size_t digestLength)
 Verifies the hash of the current message. More...
 
virtual bool VerifyTruncatedDigest (const byte *digest, size_t digestLength, const byte *input, size_t length)
 Updates the hash with additional input and verifies the hash of the current message. More...
 
virtual ClonableClone () const
 Copies this object. More...
 

Static Public Member Functions

static const char * StaticAlgorithmName ()
 

Static Public Attributes

static const int DIGESTSIZE = 32
 

Detailed Description

Definition at line 43 of file sha3.h.

Member Function Documentation

unsigned int SHA3::DigestSize ( ) const
inlinevirtualinherited

Provides the digest size of the hash.

Returns
the digest size of the hash.

Calls to Final() require a buffer that is equal to (or greater than) DigestSize().

Implements HashTransformation.

Definition at line 20 of file sha3.h.

std::string SHA3::AlgorithmName ( ) const
inlinevirtualinherited

Provides the name of this algorithm.

Returns
the standard algorithm name

The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.

Note
AlgorithmName is not universally implemented yet

Reimplemented from Algorithm.

Definition at line 21 of file sha3.h.

References IntToString().

unsigned int SHA3::OptimalDataAlignment ( ) const
inlinevirtualinherited

Provides input and output data alignment for optimal performance.

Returns
the input data alignment that provides optimal performance

Reimplemented from HashTransformation.

Definition at line 22 of file sha3.h.

void SHA3::Update ( const byte *  input,
size_t  length 
)
virtualinherited

Updates a hash with additional input.

Parameters
inputthe additional input as a buffer
lengththe size of the buffer, in bytes

Implements HashTransformation.

Definition at line 252 of file sha3.cpp.

References SecBlock< T, A >::BytePtr(), and xorbuf().

void SHA3::Restart ( )
virtualinherited

Restart the hash.

Discards the current state, and restart for a new message

Reimplemented from HashTransformation.

Definition at line 274 of file sha3.cpp.

References SecBlock< T, A >::SizeInBytes().

Referenced by SHA3::TruncatedFinal().

void SHA3::TruncatedFinal ( byte *  digest,
size_t  digestSize 
)
virtualinherited

Computes the hash of the current message.

Parameters
digesta pointer to the buffer to receive the hash
digestSizethe size of the truncated digest, in bytes

TruncatedFinal() call Final() and then copies digestSize bytes to digest

TruncatedFinal() restarts the hash for the next nmessage.

Implements HashTransformation.

Definition at line 280 of file sha3.cpp.

References SecBlock< T, A >::BytePtr(), and SHA3::Restart().

HashTransformation& HashTransformation::Ref ( )
inlineinherited

Provides a reference to this object.

Returns
A reference to this object

Useful for passing a temporary object to a function that takes a non-const reference

Definition at line 864 of file cryptlib.h.

virtual byte* HashTransformation::CreateUpdateSpace ( size_t &  size)
inlinevirtualinherited

Request space which can be written into by the caller.

Parameters
sizethe requested size of the buffer

The purpose of this method is to help avoid extra memory allocations.

size is an IN and OUT parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.

The base class implementation sets size to 0 and returns NULL.

Note
Some objects, like ArraySink, cannot create a space because its fixed. In the case of

Definition at line 879 of file cryptlib.h.

virtual void HashTransformation::Final ( byte *  digest)
inlinevirtualinherited

Computes the hash of the current message.

Parameters
digesta pointer to the buffer to receive the hash

digest must be equal to (or greater than) DigestSize(). Final() restarts the hash for a new message.

Definition at line 885 of file cryptlib.h.

References Name::DigestSize().

Referenced by DefaultDecryptor::DefaultDecryptor(), DefaultEncryptor::DefaultEncryptor(), PKCS5_PBKDF2_HMAC< T >::DeriveKey(), RandomPool::IncorporateEntropy(), PKCS_EncryptionPaddingScheme::MaxUnpaddedLength(), and HMAC_Base::TruncatedFinal().

unsigned int HashTransformation::TagSize ( ) const
inlineinherited

Provides the tag size of the hash.

Returns
the tag size of the hash.

Same as DigestSize().

Definition at line 901 of file cryptlib.h.

References Name::DigestSize().

virtual unsigned int HashTransformation::BlockSize ( ) const
inlinevirtualinherited

Provides the block size of the compression function.

Returns
the block size of the compression function, in bytes

BlockSize() will return 0 if the hash is not block based. For example, SHA3 is a recursive hash (not an iterative hash), and it does not have a block size.

Reimplemented in VMAC_Base, and Weak::MD2.

Definition at line 907 of file cryptlib.h.

Referenced by CBC_MAC_Base::DigestSize(), HMAC_Base::DigestSize(), HMAC_Base::TruncatedFinal(), CBC_MAC_Base::TruncatedFinal(), and HMAC_Base::UncheckedSetKey().

virtual unsigned int HashTransformation::OptimalBlockSize ( ) const
inlinevirtualinherited

Provides the input block size most efficient for this hash.

Returns
The input block size that is most efficient for the cipher

The base class implemnetation returns MandatoryBlockSize().

Note
Optimal input length is n * OptimalBlockSize() - GetOptimalBlockSizeUsed() for any n > 0.

Reimplemented in CMAC_Base, and HMAC_Base.

Definition at line 914 of file cryptlib.h.

virtual void HashTransformation::CalculateDigest ( byte *  digest,
const byte *  input,
size_t  length 
)
inlinevirtualinherited

Updates the hash with additional input and computes the hash of the current message.

Parameters
digesta pointer to the buffer to receive the hash
inputthe additional input as a buffer
lengththe size of the buffer, in bytes

Use this if your input is in one piece and you don't want to call Update() and Final() separately

CalculateDigest() restarts the hash for the next nmessage.

Definition at line 927 of file cryptlib.h.

Referenced by HKDF< T >::DeriveKey(), PKCS5_PBKDF2_HMAC< T >::DeriveKey(), and OAEP_Base::MaxUnpaddedLength().

virtual bool HashTransformation::Verify ( const byte *  digest)
inlinevirtualinherited

Verifies the hash of the current message.

Parameters
digesta pointer to the buffer of an existing hash
Returns
true if the existing hash matches the computed hash, false otherwise
Exceptions
ThrowIfInvalidTruncatedSize()if the existing hash's size exceeds DigestSize()

Calls to Verify() require a buffer that is equal to (or greater than) DigestSize().

Verify() performs a bitwise compare on the buffers using VerifyBufsEqual(), which is a constant time comparison function. digestLength cannot exceed DigestSize().

Verify() restarts the hash for the next nmessage.

Definition at line 938 of file cryptlib.h.

References Name::DigestSize().

Referenced by Gunzip::Gunzip(), and ZlibDecompressor::ZlibDecompressor().

virtual bool HashTransformation::VerifyDigest ( const byte *  digest,
const byte *  input,
size_t  length 
)
inlinevirtualinherited

Updates the hash with additional input and verifies the hash of the current message.

Parameters
digesta pointer to the buffer of an existing hash
inputthe additional input as a buffer
lengththe size of the buffer, in bytes
Returns
true if the existing hash matches the computed hash, false otherwise
Exceptions
ThrowIfInvalidTruncatedSize()if the existing hash's size exceeds DigestSize()

Use this if your input is in one piece and you don't want to call Update() and Verify() separately

VerifyDigest() performs a bitwise compare on the buffers using VerifyBufsEqual(), which is a constant time comparison function. digestLength cannot exceed DigestSize().

VerifyDigest() restarts the hash for the next nmessage.

Definition at line 952 of file cryptlib.h.

Referenced by OAEP_Base::MaxUnpaddedLength().

virtual void HashTransformation::CalculateTruncatedDigest ( byte *  digest,
size_t  digestSize,
const byte *  input,
size_t  length 
)
inlinevirtualinherited

Updates the hash with additional input and computes the hash of the current message.

Parameters
digesta pointer to the buffer to receive the hash
digestSizethe length of the truncated hash, in bytes
inputthe additional input as a buffer
lengththe size of the buffer, in bytes

Use this if your input is in one piece and you don't want to call Update() and CalculateDigest() separately.

CalculateTruncatedDigest() restarts the hash for the next nmessage.

Definition at line 970 of file cryptlib.h.

bool HashTransformation::TruncatedVerify ( const byte *  digest,
size_t  digestLength 
)
virtualinherited

Verifies the hash of the current message.

Parameters
digesta pointer to the buffer of an existing hash
digestLengththe size of the truncated hash, in bytes
Returns
true if the existing hash matches the computed hash, false otherwise
Exceptions
ThrowIfInvalidTruncatedSize()if digestLength exceeds DigestSize()

TruncatedVerify() is a truncated version of Verify(). It can operate on a buffer smaller than DigestSize(). However, digestLength cannot exceed DigestSize().

Verify() performs a bitwise compare on the buffers using VerifyBufsEqual(), which is a constant time comparison function. digestLength cannot exceed DigestSize().

TruncatedVerify() restarts the hash for the next nmessage.

Reimplemented in TruncatedHashTemplate< T >, and NullHash.

Definition at line 411 of file cryptlib.cpp.

References Name::DigestSize(), IntToString(), and VerifyBufsEqual().

virtual bool HashTransformation::VerifyTruncatedDigest ( const byte *  digest,
size_t  digestLength,
const byte *  input,
size_t  length 
)
inlinevirtualinherited

Updates the hash with additional input and verifies the hash of the current message.

Parameters
digesta pointer to the buffer of an existing hash
digestLengththe size of the truncated hash, in bytes
inputthe additional input as a buffer
lengththe size of the buffer, in bytes
Returns
true if the existing hash matches the computed hash, false otherwise
Exceptions
ThrowIfInvalidTruncatedSize()if digestLength exceeds DigestSize()

Use this if your input is in one piece and you don't want to call Update() and TruncatedVerify() separately.

VerifyTruncatedDigest() is a truncated version of VerifyDigest(). It can operate on a buffer smaller than DigestSize(). However, digestLength cannot exceed DigestSize().

VerifyTruncatedDigest() restarts the hash for the next nmessage.

Definition at line 997 of file cryptlib.h.

virtual Clonable* Clonable::Clone ( ) const
inlinevirtualinherited

Copies this object.

Returns
a copy of this object
Exceptions
NotImplemented
Note
this is not implemented by most classes
See also
NotCopyable

Definition at line 464 of file cryptlib.h.


The documentation for this class was generated from the following file: