DMAC message authentication code base class. More...

#include <dmac.h>

Inheritance diagram for DMAC_Base< T >:

Collaboration diagram for DMAC_Base< T >:

Public Member Functions
	DMAC_Base ()

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

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

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

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

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

Public Member Functions inherited from SimpleKeyingInterface
virtual	~SimpleKeyingInterface ()

virtual size_t	MinKeyLength () const =0
	Returns smallest valid key length. More...

virtual size_t	MaxKeyLength () const =0
	Returns largest valid key length. More...

virtual size_t	DefaultKeyLength () const =0
	Returns default key length. More...

virtual size_t	GetValidKeyLength (size_t keylength) const =0
	Returns a valid key length for the algorithm. More...

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

virtual IV_Requirement	IVRequirement () const =0
	Minimal requirement for secure IVs. 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...

virtual unsigned int	IVSize () const
	Returns length of the IV accepted by this object. 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...

virtual void	Restart ()
	Restart 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	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...

virtual std::string	AlgorithmName () const
	Provides the name of this algorithm. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()

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

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

Private Member Functions
byte *	GenerateSubKeys (const byte *key, size_t keylength)

Private Attributes
size_t	m_subkeylength

SecByteBlock	m_subkeys

CBC_MAC< T >	m_mac1

T::Encryption	m_f2

unsigned int	m_counter

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

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

Detailed Description

template<class T>
class DMAC_Base< T >

DMAC message authentication code base class.

Template Parameters

T	class derived from BlockCipherDocumentation

Definition at line 18 of file dmac.h.

Constructor & Destructor Documentation

template<class T >

DMAC_Base< T >::DMAC_Base ( )

inline

Definition at line 25 of file dmac.h.

Member Function Documentation

template<class T >

unsigned int DMAC_Base< T >::DigestSize ( ) const

inlinevirtual

Provides the digest size of the hash.

Returns: the digest size of the hash.

Implements HashTransformation.

Definition at line 30 of file dmac.h.

template<class T >

byte * DMAC_Base< T >::GenerateSubKeys	(	const byte *	key,
		size_t	keylength
	)

private

Definition at line 95 of file dmac.h.

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

static std::string DMAC_Base< T >::StaticAlgorithmName ( )

inlinestatic

Definition at line 21 of file dmac.h.

template<class T >

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

Implements HashTransformation.

Definition at line 80 of file dmac.h.

Here is the call graph for this function:

template<class T >

void DMAC_Base< T >::UncheckedSetKey	(	const byte *	key,
		unsigned int	length,
		const NameValuePairs &	params
	)

virtual

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 62 of file dmac.h.

Here is the call graph for this function:

template<class T >

void DMAC_Base< T >::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 73 of file dmac.h.

Here is the call graph for this function:

Member Data Documentation

template<class T >

unsigned int DMAC_Base< T >::m_counter

private

Definition at line 39 of file dmac.h.

template<class T >

T::Encryption DMAC_Base< T >::m_f2

private

Definition at line 38 of file dmac.h.

template<class T >

CBC_MAC<T> DMAC_Base< T >::m_mac1

private

Definition at line 37 of file dmac.h.

template<class T >

size_t DMAC_Base< T >::m_subkeylength

private

Definition at line 35 of file dmac.h.

template<class T >

SecByteBlock DMAC_Base< T >::m_subkeys

private

Definition at line 36 of file dmac.h.

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

src/cryptopp/dmac.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class DMAC_Base< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class DMAC_Base< T >