Security Scol plugin
Static Public Member Functions | List of all members
VMAC< T_BlockCipher, T_DigestBitSize > Class Template Reference

VMAC message authentication code. More...

#include <vmac.h>

Inheritance diagram for VMAC< T_BlockCipher, T_DigestBitSize >:
SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > > VMAC_Base IteratedHashBase< word64, MessageAuthenticationCode > MessageAuthenticationCode SimpleKeyingInterface HashTransformation Algorithm Clonable

Static Public Member Functions

static std::string StaticAlgorithmName ()
 

Additional Inherited Members

- Public Types inherited from IteratedHashBase< word64, MessageAuthenticationCode >
typedef word64 HashWordType
 
- 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...
 
- Public Member Functions inherited from SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > >
size_t MinKeyLength () const
 The minimum key length used by the algorithm.
 
size_t MaxKeyLength () const
 The maximum key length used by the algorithm.
 
size_t DefaultKeyLength () const
 The default key length used by the algorithm.
 
size_t GetValidKeyLength (size_t keylength) const
 Provides a valid key length for the algorithm.
 
SimpleKeyingInterface::IV_Requirement IVRequirement () const
 The default IV requirements for the algorithm.
 
unsigned int IVSize () const
 The initialization vector length for the algorithm.
 
- Public Member Functions inherited from VMAC_Base
std::string AlgorithmName () const
 Provides the name of this algorithm.
 
std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm.
 
unsigned int IVSize () const
 Returns length of the IV accepted by this object.
 
unsigned int MinIVLength () const
 Provides the minimum size of an IV.
 
void Resynchronize (const byte *nonce, int length=-1)
 Resynchronize with an IV.
 
void GetNextIV (RandomNumberGenerator &rng, byte *IV)
 Retrieves a secure IV for the next message.
 
unsigned int DigestSize () const
 
void UncheckedSetKey (const byte *userKey, unsigned int keylength, const NameValuePairs &params)
 Sets the key for this object without performing parameter validation.
 
void TruncatedFinal (byte *mac, size_t size)
 Computes the hash of the current message.
 
unsigned int BlockSize () const
 Provides the block size of the compression function.
 
ByteOrder GetByteOrder () const
 
unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance.
 
- Public Member Functions inherited from IteratedHashBase< word64, MessageAuthenticationCode >
 IteratedHashBase ()
 Construct an IteratedHashBase.
 
unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this cipher.
 
void Update (const byte *input, size_t length)
 Updates a hash with additional input.
 
byteCreateUpdateSpace (size_t &size)
 Requests space which can be written into by the caller.
 
void Restart ()
 Restart the hash.
 
- Public Member Functions inherited from SimpleKeyingInterface
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.
 
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.
 
unsigned int DefaultIVLength () const
 Provides the default size of an IV.
 
virtual unsigned int MaxIVLength () const
 Provides the maximum size of an IV.
 
- Public Member Functions inherited from HashTransformation
HashTransformationRef ()
 Provides a reference to this object.
 
virtual void Final (byte *digest)
 Computes the hash of the current message.
 
unsigned int TagSize () const
 
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.
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object.
 
- Protected Member Functions inherited from VMAC_Base
const BlockCipherGetCipher () const
 
void HashEndianCorrectedBlock (const word64 *data)
 
size_t HashMultipleBlocks (const word64 *input, size_t length)
 
void Init ()
 
word64 * StateBuf ()
 
word64 * DataBuf ()
 
void VHASH_Update_SSE2 (const word64 *data, size_t blocksRemainingInWord64, int tagPart)
 
template<bool T_128BitTag>
void VHASH_Update_Template (const word64 *data, size_t blockRemainingInWord128)
 
void VHASH_Update (const word64 *data, size_t blocksRemainingInWord128)
 
- Protected Member Functions inherited from IteratedHashBase< word64, MessageAuthenticationCode >
word64 GetBitCountHi () const
 
word64 GetBitCountLo () const
 
void PadLastBlock (unsigned int lastBlockSize, byte padFirst=0x80)
 
virtual size_t HashMultipleBlocks (const word64 *input, size_t length)
 
void HashBlock (const HashWordType *input)
 
- Protected Member Functions inherited from MessageAuthenticationCode
const AlgorithmGetAlgorithm () 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 byteGetIVAndThrowIfInvalid (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 inherited from VMAC_Base
bool m_is128
 
bool m_padCached
 
bool m_isFirstBlock
 
unsigned int m_L1KeyLength
 

Detailed Description

template<class T_BlockCipher, int T_DigestBitSize = 128>
class VMAC< T_BlockCipher, T_DigestBitSize >

VMAC message authentication code.

Template Parameters
T_BlockCipherblock cipher
T_DigestBitSizedigest size, in bits

VMAC is a block cipher-based message authentication code algorithm using a universal hash proposed by Ted Krovetz and Wei Dai in April 2007. The algorithm was designed for high performance backed by a formal analysis.

The implementation is based on Ted Krovetz's public domain vmac.c and draft-krovetz-vmac-01.txt.

See also
VMAC.
Since
Crypto++ 5.5

Definition at line 78 of file vmac.h.

Member Function Documentation

◆ StaticAlgorithmName()

template<class T_BlockCipher , int T_DigestBitSize = 128>
static std::string VMAC< T_BlockCipher, T_DigestBitSize >::StaticAlgorithmName ( )
inlinestatic

Definition at line 81 of file vmac.h.


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