Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions

CBC_MAC< T > Class Template Reference

CBC-MAC More...

#include <cbcmac.h>

Inheritance diagram for CBC_MAC< T >:
MessageAuthenticationCodeImpl< CBC_MAC_Base, CBC_MAC< T > > SameKeyLengthAs< T > AlgorithmImpl< SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > >, CBC_MAC< T > > SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > > CBC_MAC_Base MessageAuthenticationCode SimpleKeyingInterface HashTransformation Algorithm Clonable

List of all members.

Public Types

enum  IV_Requirement {
  UNIQUE_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV,
  NOT_RESYNCHRONIZABLE
}

Public Member Functions

 CBC_MAC (const byte *key, size_t length=SameKeyLengthAs< T >::DEFAULT_KEYLENGTH)
std::string AlgorithmName () const
 returns name of this algorithm, not universally implemented yet
size_t MinKeyLength () const
virtual size_t MinKeyLength () const =0
 returns smallest valid key length in bytes */
size_t MaxKeyLength () const
virtual size_t MaxKeyLength () const =0
 returns largest valid key length in bytes */
size_t DefaultKeyLength () const
virtual size_t DefaultKeyLength () const =0
 returns default (recommended) key length in bytes */
size_t GetValidKeyLength (size_t n) const
virtual size_t GetValidKeyLength (size_t n) const =0
 returns the smallest valid key length in bytes that is >= min(n, GetMaxKeyLength())
SimpleKeyingInterface::IV_Requirement IVRequirement () const
virtual IV_Requirement IVRequirement () const =0
 returns the minimal requirement for secure IVs
unsigned int IVSize () const
virtual unsigned int IVSize () const
void UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)
void Update (const byte *input, size_t length)
 process more input
void TruncatedFinal (byte *mac, size_t size)
 truncated version of Final()
unsigned int DigestSize () const
 size of the hash/digest/MAC returned by Final()
virtual bool IsValidKeyLength (size_t n) const
 returns whether n is a valid key length
virtual void SetKey (const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)
 set or reset the key of this object
void SetKeyWithRounds (const byte *key, size_t length, int rounds)
 calls SetKey() with an NameValuePairs object that just specifies "Rounds"
void SetKeyWithIV (const byte *key, size_t length, const byte *iv, size_t ivLength)
 calls SetKey() with an NameValuePairs object that just specifies "IV"
void SetKeyWithIV (const byte *key, size_t length, const byte *iv)
 calls SetKey() with an NameValuePairs object that just specifies "IV"
bool IsResynchronizable () const
 returns whether this object can be resynchronized (i.e. supports initialization vectors)
bool CanUseRandomIVs () const
 returns whether this object can use random IVs (in addition to ones returned by GetNextIV)
bool CanUsePredictableIVs () const
 returns whether this object can use random but possibly predictable IVs (in addition to ones returned by GetNextIV)
bool CanUseStructuredIVs () const
 returns whether this object can use structured IVs, for example a counter (in addition to ones returned by GetNextIV)
unsigned int DefaultIVLength () const
 returns default length of IVs accepted by this object
virtual unsigned int MinIVLength () const
 returns minimal length of IVs accepted by this object
virtual unsigned int MaxIVLength () const
 returns maximal length of IVs accepted by this object
virtual void Resynchronize (const byte *iv, int ivLength=-1)
 resynchronize with an IV. ivLength=-1 means use IVSize()
virtual void GetNextIV (RandomNumberGenerator &rng, byte *IV)
 get a secure IV for the next message
HashTransformationRef ()
 return a reference to this object, useful for passing a temporary object to a function that takes a non-const reference
virtual byte * CreateUpdateSpace (size_t &size)
 request space to write input into
virtual void Final (byte *digest)
 compute hash for current message, then restart for a new message
virtual void Restart ()
 discard the current state, and restart with a new message
unsigned int TagSize () const
 same as DigestSize()
virtual unsigned int BlockSize () const
 block size of underlying compression function, or 0 if not block based
virtual unsigned int OptimalBlockSize () const
 input to Update() should have length a multiple of this for optimal speed
virtual unsigned int OptimalDataAlignment () const
 returns how input should be aligned for optimal performance
virtual void CalculateDigest (byte *digest, const byte *input, size_t length)
 use this if your input is in one piece and you don't want to call Update() and Final() separately
virtual bool Verify (const byte *digest)
 verify that digest is a valid digest for the current message, then reinitialize the object
virtual bool VerifyDigest (const byte *digest, const byte *input, size_t length)
 use this if your input is in one piece and you don't want to call Update() and Verify() separately
virtual void CalculateTruncatedDigest (byte *digest, size_t digestSize, const byte *input, size_t length)
 truncated version of CalculateDigest()
virtual bool TruncatedVerify (const byte *digest, size_t digestLength)
 truncated version of Verify()
virtual bool VerifyTruncatedDigest (const byte *digest, size_t digestLength, const byte *input, size_t length)
 truncated version of VerifyDigest()
virtual ClonableClone () const
 this is not implemented by most classes yet

Static Public Member Functions

static std::string StaticAlgorithmName ()
static std::string StaticAlgorithmName ()
static size_t StaticGetValidKeyLength (size_t keylength)

Static Public Attributes

static const int MIN_KEYLENGTH
static const int MAX_KEYLENGTH
static const int DEFAULT_KEYLENGTH
static const int IV_REQUIREMENT
static const int IV_LENGTH

Protected Member Functions

virtual void UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)=0
virtual BlockCipherAccessCipher ()=0
const AlgorithmGetAlgorithm () const
virtual const AlgorithmGetAlgorithm () const =0
void ThrowIfInvalidKeyLength (size_t length)
void ThrowIfResynchronizable ()
void ThrowIfInvalidIV (const byte *iv)
size_t ThrowIfInvalidIVLength (int size)
const byte * GetIVAndThrowIfInvalid (const NameValuePairs &params, size_t &size)
void AssertValidKeyLength (size_t length) const
void ThrowIfInvalidTruncatedSize (size_t size) const

Detailed Description

template<class T>
class CBC_MAC< T >

CBC-MAC

Compatible with FIPS 113. T should be a class derived from BlockCipherDocumentation. Secure only for fixed length messages. For variable length messages use CMAC or DMAC.

Definition at line 34 of file cbcmac.h.


Member Function Documentation

void SimpleKeyingInterface::SetKey ( const byte *  key,
size_t  length,
const NameValuePairs params = g_nullNameValuePairs 
) [virtual, inherited]

set or reset the key of this object

Parameters:
params is used to specify Rounds, BlockSize, etc.

Definition at line 60 of file cryptlib.cpp.

Referenced by SimpleKeyingInterface::SetKeyWithIV(), and SimpleKeyingInterface::SetKeyWithRounds().

bool SimpleKeyingInterface::IsResynchronizable (  )  const [inline, inherited]

returns whether this object can be resynchronized (i.e. supports initialization vectors)

If this function returns true, and no IV is passed to SetKey() and CanUseStructuredIVs()==true, an IV of all 0's will be assumed.

Definition at line 386 of file cryptlib.h.

void SimpleKeyingInterface::GetNextIV ( RandomNumberGenerator rng,
byte *  IV 
) [virtual, inherited]

get a secure IV for the next message

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. This method is not implemented on decryption objects.

Definition at line 136 of file cryptlib.cpp.

References RandomNumberGenerator::GenerateBlock().

virtual void HashTransformation::Final ( byte *  digest  )  [inline, virtual, inherited]

compute hash for current message, then restart for a new message

Precondition:
size of digest == DigestSize().

Definition at line 545 of file cryptlib.h.

Referenced by PKCS5_PBKDF2_HMAC< T >::DeriveKey(), and HMAC_Base::TruncatedFinal().

virtual bool HashTransformation::Verify ( const byte *  digest  )  [inline, virtual, inherited]

verify that digest is a valid digest for the current message, then reinitialize the object

Default implementation is to call Final() and do a bitwise comparison between its output and digest.

Definition at line 575 of file cryptlib.h.


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