MAC construction using a hermetic hash function. More...

#include <panama.h>

Inheritance diagram for HermeticHashFunctionMAC< T_Hash, T_Info >:

Collaboration diagram for HermeticHashFunctionMAC< T_Hash, T_Info >:

Public Member Functions
void	UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)
	Sets the key for this object without performing parameter validation. More...

void	Restart ()
	Restart the hash. More...

void	Update (const byte *input, size_t length)
	Updates a hash with additional input. More...

void	TruncatedFinal (byte *digest, size_t digestSize)
	Computes the hash of the current message. More...

unsigned int	DigestSize () const
	Provides the digest size of the hash. More...

unsigned int	BlockSize () const
	Provides the block size of the compression function. More...

unsigned int	OptimalBlockSize () const
	Provides the input block size most efficient for this hash. More...

unsigned int	OptimalDataAlignment () const
	Provides input and output data alignment for optimal performance. More...

Public Member Functions inherited from AlgorithmImpl< SimpleKeyingInterfaceImpl< TwoBases< MessageAuthenticationCode, VariableKeyLength< 32, 0, INT_MAX > > >, T_Info >
std::string	AlgorithmName () const

Public Member Functions inherited from SimpleKeyingInterfaceImpl< TwoBases< MessageAuthenticationCode, VariableKeyLength< 32, 0, INT_MAX > > >
size_t	MinKeyLength () const
	The minimum key length used by the algorithm. More...

size_t	MaxKeyLength () const
	The maximum key length used by the algorithm. More...

size_t	DefaultKeyLength () const
	The default key length used by the algorithm. More...

size_t	GetValidKeyLength (size_t keylength) const
	Provides a valid key length for the algorithm. More...

SimpleKeyingInterface::IV_Requirement	IVRequirement () const
	The default IV requirements for the algorithm. More...

unsigned int	IVSize () const
	The default initialization vector length for the algorithm. More...

Public Member Functions inherited from SimpleKeyingInterface
virtual	~SimpleKeyingInterface ()

virtual bool	IsValidKeyLength (size_t keylength) const
	Returns whether keylength is a valid key length. More...

virtual void	SetKey (const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)
	Sets or reset the key of this object. More...

void	SetKeyWithRounds (const byte *key, size_t length, int rounds)
	Sets or reset the key of this object. More...

void	SetKeyWithIV (const byte key, size_t length, const byte iv, size_t ivLength)
	Sets or reset the key of this object. More...

void	SetKeyWithIV (const byte key, size_t length, const byte iv)
	Sets or reset the key of this object. More...

bool	IsResynchronizable () const
	Determines if the object can be resynchronized. More...

bool	CanUseRandomIVs () const
	Determines if the object can use random IVs. More...

bool	CanUsePredictableIVs () const
	Determines if the object can use random but possibly predictable IVs. More...

bool	CanUseStructuredIVs () const
	Determines if the object can use structured IVs. More...

unsigned int	DefaultIVLength () const
	Provides the default size of an IV. More...

virtual unsigned int	MinIVLength () const
	Provides the minimum size of an IV. More...

virtual unsigned int	MaxIVLength () const
	Provides the maximum size of an IV. More...

virtual void	Resynchronize (const byte *iv, int ivLength=-1)
	Resynchronize with an IV. More...

virtual void	GetNextIV (RandomNumberGenerator &rng, byte *iv)
	Retrieves a secure IV for the next message. More...

Public Member Functions inherited from HashTransformation
virtual	~HashTransformation ()

HashTransformation &	Ref ()
	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 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...

Public Member Functions inherited from Algorithm
virtual	~Algorithm ()

	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()

virtual Clonable *	Clone () const
	Copies this object. More...

Public Member Functions inherited from VariableKeyLength< 32, 0, INT_MAX >
CRYPTOPP_STATIC_CONSTEXPR size_t CRYPTOPP_API	StaticGetValidKeyLength (size_t keylength)
	The minimum key length used by the algorithm provided as a constant. More...

Protected Member Functions
void	KeyHash ()

Protected Member Functions inherited from MessageAuthenticationCode
const Algorithm &	GetAlgorithm () const
	Returns the base class Algorithm. More...

Protected Member Functions inherited from SimpleKeyingInterface
void	ThrowIfInvalidKeyLength (size_t length)
	Validates the key length. More...

void	ThrowIfResynchronizable ()
	Validates the object. More...

void	ThrowIfInvalidIV (const byte *iv)
	Validates the IV. More...

size_t	ThrowIfInvalidIVLength (int length)
	Validates the IV length. More...

const byte *	GetIVAndThrowIfInvalid (const NameValuePairs &params, size_t &size)
	Retrieves and validates the IV. More...

void	AssertValidKeyLength (size_t length) const
	Validates the key length. More...

Protected Member Functions inherited from HashTransformation
void	ThrowIfInvalidTruncatedSize (size_t size) const
	Validates a truncated digest size. More...

Protected Attributes
T_Hash	m_hash

bool	m_keyed

SecByteBlock	m_key

Additional Inherited Members
Public Types inherited from SimpleKeyingInterface
enum	IV_Requirement { UNIQUE_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV, NOT_RESYNCHRONIZABLE }
	Secure IVs requirements as enumerated values. More...

Static Public Member Functions inherited from AlgorithmImpl< SimpleKeyingInterfaceImpl< TwoBases< MessageAuthenticationCode, VariableKeyLength< 32, 0, INT_MAX > > >, T_Info >
static std::string CRYPTOPP_API	StaticAlgorithmName ()

Detailed Description

template<class T_Hash, class T_Info = T_Hash>
class HermeticHashFunctionMAC< T_Hash, T_Info >

MAC construction using a hermetic hash function.

Definition at line 60 of file panama.h.

Member Function Documentation

template<class T_Hash, class T_Info = T_Hash>

unsigned int HermeticHashFunctionMAC< T_Hash, T_Info >::BlockSize ( ) const

inlinevirtual

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 from HashTransformation.

Definition at line 94 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

unsigned int HermeticHashFunctionMAC< T_Hash, T_Info >::DigestSize ( ) const

inlinevirtual

Provides the digest size of the hash.

Returns: the digest size of the hash.

Implements HashTransformation.

Definition at line 92 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

void HermeticHashFunctionMAC< T_Hash, T_Info >::KeyHash ( )

inlineprotected

Definition at line 102 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

unsigned int HermeticHashFunctionMAC< T_Hash, T_Info >::OptimalBlockSize ( ) const

inlinevirtual

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 implementation returns MandatoryBlockSize().

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

Reimplemented from HashTransformation.

Definition at line 96 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

unsigned int HermeticHashFunctionMAC< T_Hash, T_Info >::OptimalDataAlignment ( ) const

inlinevirtual

Provides input and output data alignment for optimal performance.

Returns: the input data alignment that provides optimal performance

Reimplemented from HashTransformation.

Definition at line 98 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

void HermeticHashFunctionMAC< T_Hash, T_Info >::Restart ( )

inlinevirtual

Restart the hash.

Discards the current state, and restart for a new message

Reimplemented from HashTransformation.

Definition at line 71 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

void HermeticHashFunctionMAC< T_Hash, T_Info >::TruncatedFinal	(	byte *	digest,
		size_t	digestSize
	)

inlinevirtual

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() call Final() and then copies digestSize bytes to digest. The hash is restarted the hash for the next message.

Implements HashTransformation.

Definition at line 84 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

void HermeticHashFunctionMAC< T_Hash, T_Info >::UncheckedSetKey	(	const byte *	key,
		unsigned int	length,
		const NameValuePairs &	params
	)

inlinevirtual

Sets the key for this object without performing parameter validation.

Parameters

key	a byte buffer used to key the cipher
length	the length of the byte buffer
params	additional parameters passed as NameValuePairs

key must be at least DEFAULT_KEYLENGTH in length.

Implements SimpleKeyingInterface.

Definition at line 63 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

void HermeticHashFunctionMAC< T_Hash, T_Info >::Update	(	const byte *	input,
		size_t	length
	)

inlinevirtual

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 77 of file panama.h.

Member Data Documentation

template<class T_Hash, class T_Info = T_Hash>

T_Hash HermeticHashFunctionMAC< T_Hash, T_Info >::m_hash

protected

Definition at line 108 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

SecByteBlock HermeticHashFunctionMAC< T_Hash, T_Info >::m_key

protected

Definition at line 110 of file panama.h.

template<class T_Hash, class T_Info = T_Hash>

bool HermeticHashFunctionMAC< T_Hash, T_Info >::m_keyed

protected

Definition at line 109 of file panama.h.

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

src/cryptopp/panama.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class T_Hash, class T_Info = T_Hash> class HermeticHashFunctionMAC< T_Hash, T_Info >

Member Function Documentation

Member Data Documentation

template<class T_Hash, class T_Info = T_Hash>
class HermeticHashFunctionMAC< T_Hash, T_Info >