CMAC base implementation. More...

#include <cmac.h>

Inheritance diagram for CMAC_Base:

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

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

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

unsigned int	DigestSize () const

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

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

std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm.

Public Member Functions inherited from SimpleKeyingInterface
virtual size_t	MinKeyLength () const =0
	Returns smallest valid key length.

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

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

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

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

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

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

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

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

virtual IV_Requirement	IVRequirement () const =0
	Minimal requirement for secure IVs.

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

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

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

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

virtual unsigned int	IVSize () const
	Returns length of the IV accepted by this object.

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

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

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

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

virtual void	GetNextIV (RandomNumberGenerator &rng, byte *iv)
	Retrieves a secure IV for the next 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.

virtual void	Restart ()
	Restart the hash.

unsigned int	TagSize () const

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

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.

Public Member Functions inherited from Clonable
virtual Clonable *	Clone () const
	Copies this object.

Protected Member Functions
const BlockCipher &	GetCipher () const

virtual BlockCipher &	AccessCipher ()=0

void	ProcessBuf ()

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

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

void	ThrowIfResynchronizable ()
	Validates the object.

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

size_t	ThrowIfInvalidIVLength (int length)
	Validates the IV length.

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

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

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

Protected Attributes
SecByteBlock	m_reg

unsigned int	m_counter

Friends
class	EAX_Base

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

Detailed Description

CMAC base implementation.

Since: Crypto++ 5.6.0

Definition at line 24 of file cmac.h.

Constructor & Destructor Documentation

◆ ~CMAC_Base()

virtual CMAC_Base::~CMAC_Base ( )

inlinevirtual

Definition at line 28 of file cmac.h.

◆ CMAC_Base()

CMAC_Base::CMAC_Base ( )

inline

Definition at line 29 of file cmac.h.

Member Function Documentation

◆ AlgorithmProvider()

std::string CMAC_Base::AlgorithmProvider ( ) const

inlinevirtual

Retrieve the provider of this algorithm.

Returns: the algorithm provider

The algorithm provider can be a name like "C++", "SSE", "NEON", "AESNI", "ARMv8" and "Power8". C++ is standard C++ code. Other labels, like SSE, usually indicate a specialized implementation using instructions from a higher instruction set architecture (ISA). Future labels may include external hardware like a hardware security module (HSM).

Generally speaking Wei Dai's original IA-32 ASM code falls under "SSE2". Labels like "SSSE3" and "SSE4.1" follow after Wei's code and use intrinsics instead of ASM.

Algorithms which combine different instructions or ISAs provide the dominant one. For example on x86 AES/GCM returns "AESNI" rather than "CLMUL" or "AES+SSE4.1" or "AES+CLMUL" or "AES+SSE4.1+CLMUL".

Note: Provider is not universally implemented yet.

Since: Crypto++ 8.0

Reimplemented from Algorithm.

Definition at line 37 of file cmac.h.

◆ DigestSize()

unsigned int CMAC_Base::DigestSize ( ) const

inlinevirtual

Provides the digest size of the hash

Returns: the digest size of the hash.

Implements HashTransformation.

Definition at line 34 of file cmac.h.

◆ GetCipher()

const BlockCipher & CMAC_Base::GetCipher ( ) const

inlineprotected

Definition at line 42 of file cmac.h.

◆ OptimalBlockSize()

unsigned int CMAC_Base::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 35 of file cmac.h.

◆ OptimalDataAlignment()

unsigned int CMAC_Base::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 36 of file cmac.h.

◆ TruncatedFinal()

void CMAC_Base::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 139 of file cmac.cpp.

◆ UncheckedSetKey()

ANONYMOUS_NAMESPACE_END void CMAC_Base::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 79 of file cmac.cpp.

◆ Update()

void CMAC_Base::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 94 of file cmac.cpp.

Friends And Related Symbol Documentation

◆ EAX_Base

friend class EAX_Base

friend

Definition at line 40 of file cmac.h.

Member Data Documentation

◆ m_counter

unsigned int CMAC_Base::m_counter

protected

Definition at line 47 of file cmac.h.

◆ m_reg

SecByteBlock CMAC_Base::m_reg

protected

Definition at line 46 of file cmac.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~CMAC_Base()

◆ CMAC_Base()

Member Function Documentation

◆ AlgorithmProvider()

◆ DigestSize()

◆ GetCipher()

◆ OptimalBlockSize()

◆ OptimalDataAlignment()

◆ TruncatedFinal()

◆ UncheckedSetKey()

◆ Update()

Friends And Related Symbol Documentation

◆ EAX_Base

Member Data Documentation

◆ m_counter

◆ m_reg