SHA3_Final< T_DigestSize > Class Template Reference

SHA3 message digest template. More...

#include <sha3.h>

Inheritance diagram for SHA3_Final< T_DigestSize >:

Public Member Functions
	SHA3_Final ()
	Construct a SHA3-X message digest. More...
unsigned int	BlockSize () const
	Provides the block size of the compression function. More...
std::string	AlgorithmName () const
	Provides the name of this algorithm. More...
Public Member Functions inherited from SHA3
unsigned int	DigestSize () const
	Provides the digest size of the hash. 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...
Public Member Functions inherited from HashTransformation
HashTransformation &	Ref ()
	Provides a reference to this object. More...
virtual void	Update (const byte *input, size_t length)=0
	Updates a hash with additional input. 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...
virtual void	Restart ()
	Restart the hash. More...
virtual unsigned int	DigestSize () const =0
	Provides the digest size of the hash. 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 unsigned int	OptimalDataAlignment () const
	Provides input and output data alignment for optimal performance. 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	TruncatedFinal (byte *digest, size_t digestSize)=0
	Computes 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...
Public Member Functions inherited from Algorithm
	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...
virtual std::string	AlgorithmName () const
	Provides the name of this algorithm. More...
virtual std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm. More...
Public Member Functions inherited from Clonable
virtual Clonable *	Clone () const
	Copies this object. More...

Static Public Member Functions
static std::string	StaticAlgorithmName ()

Static Public Attributes
static const int	DIGESTSIZE = T_DigestSize
static const int	BLOCKSIZE = 200 - 2 * DIGESTSIZE

Detailed Description

template<unsigned int T_DigestSize>
class SHA3_Final< T_DigestSize >

SHA3 message digest template.

Template Parameters

T_DigestSize

the size of the digest, in bytes

Since

Crypto++ 5.6.2

Definition at line 60 of file sha3.h.

Constructor & Destructor Documentation

SHA3_Final()

template<unsigned int T_DigestSize>

SHA3_Final< T_DigestSize >::SHA3_Final ( )

inline

Construct a SHA3-X message digest.

Definition at line 69 of file sha3.h.

Member Function Documentation

StaticAlgorithmName()

template<unsigned int T_DigestSize>

static std::string SHA3_Final< T_DigestSize >::StaticAlgorithmName ( )

inlinestatic

Definition at line 65 of file sha3.h.

BlockSize()

template<unsigned int T_DigestSize>

unsigned int SHA3_Final< T_DigestSize >::BlockSize ( ) const

inlinevirtual

Provides the block size of the compression function.

Returns

block size of the compression function, in bytes

BlockSize() will return 0 if the hash is not block based or does not have an equivalent block size. For example, Keccak and SHA-3 do not have a block size, but they do have an equivalent block size called rate expressed as r.

Reimplemented from HashTransformation.

Definition at line 77 of file sha3.h.

AlgorithmName()

template<unsigned int T_DigestSize>

std::string SHA3_Final< T_DigestSize >::AlgorithmName ( ) const

inlinevirtual

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 79 of file sha3.h.

Member Data Documentation

DIGESTSIZE

template<unsigned int T_DigestSize>

const int SHA3_Final< T_DigestSize >::DIGESTSIZE = T_DigestSize

static

Definition at line 63 of file sha3.h.

BLOCKSIZE

template<unsigned int T_DigestSize>

const int SHA3_Final< T_DigestSize >::BLOCKSIZE = 200 - 2 * DIGESTSIZE

static

Definition at line 64 of file sha3.h.

---

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

• sha3.h