SHA3 Class Reference

SHA3 message digest base class. More...

#include <sha3.h>

Inheritance diagram for SHA3:

Public Member Functions
unsigned int	DigestSize () const
unsigned int	OptimalDataAlignment () const
	Provides input and output data alignment for optimal performance.
void	Update (const byte *input, size_t length)
	Updates a hash with additional input.
void	Restart ()
	Restart the hash.
void	TruncatedFinal (byte *hash, size_t size)
	Computes the hash of the current message.
Public Member Functions inherited from HashTransformation
HashTransformation &	Ref ()
	Provides a reference to this object.
virtual byte *	CreateUpdateSpace (size_t &size)
	Request space which can be written into by the caller.
virtual void	Final (byte *digest)
	Computes the hash of the current message.
unsigned int	TagSize () const
virtual unsigned int	BlockSize () const
	Provides the block size of the compression function.
virtual unsigned int	OptimalBlockSize () const
	Provides the input block size most efficient for this hash.
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.
virtual bool	Verify (const byte *digest)
	Verifies the hash of the current message.
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.
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.
virtual bool	TruncatedVerify (const byte *digest, size_t digestLength)
	Verifies the hash of the current message.
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.
Public Member Functions inherited from Algorithm
	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms.
virtual std::string	AlgorithmName () const
	Provides the name of this algorithm.
virtual std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm.
Public Member Functions inherited from Clonable
virtual Clonable *	Clone () const
	Copies this object.

Protected Member Functions
	SHA3 (unsigned int digestSize)
	Construct a SHA3.
unsigned int	r () const
Protected Member Functions inherited from HashTransformation
void	ThrowIfInvalidTruncatedSize (size_t size) const
	Validates a truncated digest size.

Protected Attributes
FixedSizeSecBlock< word64, 25 >	m_state
unsigned int	m_digestSize
unsigned int	m_counter

Detailed Description

SHA3 message digest base class.

The Crypto++ implementation conforms to FIPS 202 version of SHA3 using F1600 with XOF d=0x06. Previous behavior (XOF d=0x01) is available in Keccak classes.

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.

See also

Keccak, SHA3_224, SHA3_256, SHA3_384 and SHA3_512.

Since

Crypto++ 5.6.2

Definition at line 28 of file sha3.h.

Constructor & Destructor Documentation

SHA3()

SHA3::SHA3 ( unsigned int  digestSize )

inlineprotected

Construct a SHA3.

Parameters

digestSize

the digest size, in bytes

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.

This constructor was moved to protected at Crypto++ 8.1 because users were attempting to create Keccak objects with it.

Since

Crypto++ 5.6.2

Definition at line 39 of file sha3.h.

Member Function Documentation

DigestSize()

unsigned int SHA3::DigestSize ( ) const

inlinevirtual

Provides the digest size of the hash

Returns

the digest size of the hash.

Implements HashTransformation.

Definition at line 42 of file sha3.h.

OptimalDataAlignment()

unsigned int SHA3::OptimalDataAlignment ( ) const

inlinevirtual

Provides input and output data alignment for optimal performance.

Returns

the input data alignment that provides optimal performance

See also

GetAlignment() and OptimalBlockSize()

Reimplemented from HashTransformation.

Definition at line 43 of file sha3.h.

r()

unsigned int SHA3::r ( ) const

inlineprotected

Definition at line 50 of file sha3.h.

Restart()

void SHA3::Restart ( )

virtual

Restart the hash.

Discards the current state, and restart for a new message

Reimplemented from HashTransformation.

Definition at line 53 of file sha3.cpp.

TruncatedFinal()

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

virtual

Computes the hash of the current message.

Parameters

digest	a pointer to the buffer to receive the hash
digestSize	the size of the truncated digest, in bytes

TruncatedFinal() calls Final() and then copies digestSize bytes to digest. The hash is restarted the hash for the next message.

Precondition

COUNTOF(digest) <= DigestSize() or COUNTOF(digest) <= HASH::DIGESTSIZE ensures the output byte buffer is a valid size.

Implements HashTransformation.

Definition at line 59 of file sha3.cpp.

Update()

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

virtual

Updates a hash with additional input.

Parameters

input	the additional input as a buffer
length	the size of the buffer, in bytes

Implements HashTransformation.

Definition at line 32 of file sha3.cpp.

Member Data Documentation

m_counter

unsigned int SHA3::m_counter

protected

Definition at line 53 of file sha3.h.

m_digestSize

unsigned int SHA3::m_digestSize

protected

Definition at line 53 of file sha3.h.

m_state

FixedSizeSecBlock<word64, 25> SHA3::m_state

protected

Definition at line 52 of file sha3.h.

---

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

• G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/sha3.h
• G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/sha3.cpp