Security Scol plugin
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VMAC_Base Class Referenceabstract

VMAC message authentication code base class. More...

#include <vmac.h>

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

Public Member Functions

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

virtual BlockCipherAccessCipher ()=0
 
virtual int DefaultDigestSize () const =0
 
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

bool m_is128
 
bool m_padCached
 
bool m_isFirstBlock
 
unsigned int m_L1KeyLength
 

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

Detailed Description

VMAC message authentication code base class.

Since
Crypto++ 5.5

Definition at line 24 of file vmac.h.

Member Function Documentation

◆ AlgorithmName()

std::string VMAC_Base::AlgorithmName ( ) const
inlinevirtual

Provides the name of this algorithm.

Returns
the standard algorithm name

The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.

Note
AlgorithmName is not universally implemented yet.

Reimplemented from Algorithm.

Definition at line 27 of file vmac.h.

◆ AlgorithmProvider()

std::string VMAC_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).

Note
Provider is not universally implemented yet.

Reimplemented from IteratedHashBase< word64, MessageAuthenticationCode >.

Definition at line 28 of file vmac.h.

◆ BlockSize()

unsigned int VMAC_Base::BlockSize ( ) const
inlinevirtual

Provides the block size of the compression function.

Returns
block size of the compression function, in bytes

BlockSize() will return 0 if the hash is not block based or does not have an equivalent block size. For example, Keccak and SHA-3 do not have a block size, but they do have an equivalent block size called rate expressed as r.

Reimplemented from HashTransformation.

Definition at line 36 of file vmac.h.

◆ DataBuf()

word64 * VMAC_Base::DataBuf ( )
inlineprotectedvirtual

Implements IteratedHashBase< word64, MessageAuthenticationCode >.

Definition at line 48 of file vmac.h.

◆ DigestSize()

unsigned int VMAC_Base::DigestSize ( ) const
inlinevirtual

Provides the digest size of the hash

Returns
the digest size of the hash.

Implements HashTransformation.

Definition at line 33 of file vmac.h.

◆ GetByteOrder()

ByteOrder VMAC_Base::GetByteOrder ( ) const
inlinevirtual

Implements IteratedHashBase< word64, MessageAuthenticationCode >.

Definition at line 37 of file vmac.h.

◆ GetCipher()

const BlockCipher & VMAC_Base::GetCipher ( ) const
inlineprotected

Definition at line 43 of file vmac.h.

◆ GetNextIV()

void VMAC_Base::GetNextIV ( RandomNumberGenerator rng,
byte iv 
)
virtual

Retrieves a secure IV for the next message.

Parameters
rnga RandomNumberGenerator to produce keying material
iva block of bytes to receive the IV

The IV must be at least IVSize() in length.

This method should be called after you finish encrypting one message and are ready to start the next one. After calling it, you must call SetKey() or Resynchronize(). before using this object again.

Internally, the base class implementation calls RandomNumberGenerator's GenerateBlock()

Note
This method is not implemented on decryption objects.

Reimplemented from SimpleKeyingInterface.

Definition at line 122 of file vmac.cpp.

◆ HashEndianCorrectedBlock()

void VMAC_Base::HashEndianCorrectedBlock ( const word64 *  data)
protectedvirtual

Implements IteratedHashBase< word64, MessageAuthenticationCode >.

Definition at line 162 of file vmac.cpp.

◆ HashMultipleBlocks()

size_t VMAC_Base::HashMultipleBlocks ( const word64 *  input,
size_t  length 
)
protected

Definition at line 791 of file vmac.cpp.

◆ Init()

void VMAC_Base::Init ( )
inlineprotectedvirtual

Implements IteratedHashBase< word64, MessageAuthenticationCode >.

Definition at line 46 of file vmac.h.

◆ IVSize()

unsigned int VMAC_Base::IVSize ( ) const
inlinevirtual

Returns length of the IV accepted by this object.

Returns
the size of an IV, in bytes
Exceptions
NotImplemented()if the object does not support resynchronization

The default implementation throws NotImplemented

Reimplemented from SimpleKeyingInterface.

Definition at line 29 of file vmac.h.

◆ MinIVLength()

unsigned int VMAC_Base::MinIVLength ( ) const
inlinevirtual

Provides the minimum size of an IV.

Returns
minimal length of IVs accepted by this object, in bytes
Exceptions
NotImplemented()if the object does not support resynchronization

Reimplemented from SimpleKeyingInterface.

Definition at line 30 of file vmac.h.

◆ OptimalDataAlignment()

unsigned int VMAC_Base::OptimalDataAlignment ( ) const
virtual

Provides input and output data alignment for optimal performance.

Returns
the input data alignment that provides optimal performance

OptimalDataAlignment returns the natural alignment of the hash word.

Reimplemented from IteratedHashBase< word64, MessageAuthenticationCode >.

Definition at line 169 of file vmac.cpp.

◆ Resynchronize()

void VMAC_Base::Resynchronize ( const byte iv,
int  ivLength = -1 
)
virtual

Resynchronize with an IV.

Parameters
ivthe initialization vector
ivLengththe size of the initialization vector, in bytes

Resynchronize() resynchronizes with an IV provided by the caller. ivLength=-1 means use IVSize().

Exceptions
NotImplemented()if the object does not support resynchronization

Reimplemented from SimpleKeyingInterface.

Definition at line 128 of file vmac.cpp.

◆ StateBuf()

word64 * VMAC_Base::StateBuf ( )
inlineprotectedvirtual

Implements IteratedHashBase< word64, MessageAuthenticationCode >.

Definition at line 47 of file vmac.h.

◆ TruncatedFinal()

void VMAC_Base::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.

Reimplemented from IteratedHashBase< word64, MessageAuthenticationCode >.

Definition at line 839 of file vmac.cpp.

◆ UncheckedSetKey()

ANONYMOUS_NAMESPACE_END void VMAC_Base::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 63 of file vmac.cpp.

◆ VHASH_Update()

void VMAC_Base::VHASH_Update ( const word64 *  data,
size_t  blocksRemainingInWord128 
)
inlineprotected

Definition at line 771 of file vmac.cpp.

◆ VHASH_Update_Template()

template<bool T_128BitTag>
void VMAC_Base::VHASH_Update_Template ( const word64 *  data,
size_t  blockRemainingInWord128 
)
protected

Definition at line 514 of file vmac.cpp.

Member Data Documentation

◆ m_is128

bool VMAC_Base::m_is128
protected

Definition at line 63 of file vmac.h.

◆ m_isFirstBlock

bool VMAC_Base::m_isFirstBlock
protected

Definition at line 63 of file vmac.h.

◆ m_L1KeyLength

unsigned int VMAC_Base::m_L1KeyLength
protected

Definition at line 64 of file vmac.h.

◆ m_padCached

bool VMAC_Base::m_padCached
protected

Definition at line 63 of file vmac.h.


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