Crypto++ 8.9
Free C++ class library of cryptographic schemes
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
DMAC_Base< T > Class Template Reference

DMAC message authentication code base class. More...

#include <dmac.h>

+ Inheritance diagram for DMAC_Base< T >:

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
 Provides the digest size of the hash.
 
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
HashTransformationRef ()
 Provides a reference to this object.
 
virtual byteCreateUpdateSpace (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
 Provides the tag size of the hash.
 
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 unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance.
 
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 ClonableClone () const
 Copies this object.
 

Static Public Member Functions

static std::string StaticAlgorithmName ()
 
- Static Public Member Functions inherited from SameKeyLengthAs< T, IV_REQ, IV_L >
static size_t StaticGetValidKeyLength (size_t keylength)
 Provides a valid key length for the algorithm provided by a static function.
 

Static Public Attributes

static const int DIGESTSIZE =T::BLOCKSIZE
 
- Static Public Attributes inherited from SameKeyLengthAs< T, IV_REQ, IV_L >
static const int MIN_KEYLENGTH =T::MIN_KEYLENGTH
 The minimum key length used by the algorithm provided as a constant.
 
static const int MAX_KEYLENGTH =T::MAX_KEYLENGTH
 The maximum key length used by the algorithm provided as a constant.
 
static const int DEFAULT_KEYLENGTH =T::DEFAULT_KEYLENGTH
 The default key length used by the algorithm provided as a constant.
 
static const int IV_REQUIREMENT =IV_REQ
 The default IV requirements for the algorithm provided as a constant.
 
static const int IV_LENGTH =IV_L
 The default initialization vector length for the algorithm provided as a constant.
 

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

template<class T>
class DMAC_Base< T >

DMAC message authentication code base class.

Template Parameters
Tclass derived from BlockCipherDocumentation
Since
Crypto++ 3.1

Definition at line 17 of file dmac.h.

Constructor & Destructor Documentation

◆ ~DMAC_Base()

template<class T >
virtual DMAC_Base< T >::~DMAC_Base ( )
inline

Definition at line 23 of file dmac.h.

◆ DMAC_Base()

template<class T >
DMAC_Base< T >::DMAC_Base ( )
inline

Definition at line 24 of file dmac.h.

Member Function Documentation

◆ StaticAlgorithmName()

template<class T >
static std::string DMAC_Base< T >::StaticAlgorithmName ( )
inlinestatic

Definition at line 21 of file dmac.h.

◆ UncheckedSetKey()

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
keya byte buffer used to key the cipher
lengththe length of the byte buffer
paramsadditional parameters passed as NameValuePairs

key must be at least DEFAULT_KEYLENGTH in length.

Implements SimpleKeyingInterface.

Definition at line 69 of file dmac.h.

◆ Update()

template<class T >
void DMAC_Base< T >::Update ( const byte * input,
size_t length )
virtual

Updates a hash with additional input.

Parameters
inputthe additional input as a buffer
lengththe size of the buffer, in bytes

Implements HashTransformation.

Definition at line 80 of file dmac.h.

◆ TruncatedFinal()

template<class T >
void DMAC_Base< T >::TruncatedFinal ( byte * digest,
size_t digestSize )
virtual

Computes the hash of the current message.

Parameters
digesta pointer to the buffer to receive the hash
digestSizethe 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 87 of file dmac.h.

◆ DigestSize()

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

◆ AlgorithmProvider()

template<class T >
std::string DMAC_Base< T >::AlgorithmProvider ( ) const
virtual

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

Member Data Documentation

◆ DIGESTSIZE

template<class T >
const int DMAC_Base< T >::DIGESTSIZE =T::BLOCKSIZE
static

Definition at line 20 of file dmac.h.


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