Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

XMACC< T > Class Template Reference

#include <xormac.h>

Inheritance diagram for XMACC< T >:

ClonableImpl< XMACC< T >, MessageAuthenticationCodeImpl< XMACC_Base< T > > > MessageAuthenticationCodeImpl< XMACC_Base< T > > AlgorithmImpl< SimpleKeyingInterfaceImpl< XMACC_Base< T >, XMACC_Base< T > >, XMACC_Base< T > > SimpleKeyingInterfaceImpl< XMACC_Base< T >, XMACC_Base< T > > FixedKeyLength< DigestSizeSubtract4Workaround< T >::RESULT, SimpleKeyingInterface::INTERNALLY_GENERATED_IV > IteratedHash< T::HashWordType, T::ByteOrderClass, T::BLOCKSIZE, MessageAuthenticationCode > IteratedHashBase< T::HashWordType, MessageAuthenticationCode > MessageAuthenticationCode HashTransformation SimpleKeyingInterface Algorithm Clonable List of all members.

Detailed Description

template<class T>
class XMACC< T >

XMAC

If you need to generate MACs with XMACC (instead of just verifying them), you must save the counter before destroying an XMACC object and reinitialize it the next time you create an XMACC with the same key. Start counter at 0 when using a key for the first time.

Definition at line 65 of file xormac.h.

Public Types

enum  
typedef T::ByteOrderClass ByteOrderClass
typedef T::HashWordType HashWordType
enum  IV_Requirement {
  STRUCTURED_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV,
  NOT_RESYNCHRONIZABLE
}

Public Member Functions

 XMACC (const byte *key, word32 counter=0xffffffff)
ClonableClone () const
 this is not implemented by most classes yet
void SetKey (const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)
 set or reset the key of this object
std::string AlgorithmName () const
 returns name of this algorithm, not universally implemented yet
size_t MinKeyLength () const
 returns smallest valid key length in bytes */
size_t MaxKeyLength () const
 returns largest valid key length in bytes */
size_t DefaultKeyLength () const
 returns default (recommended) key length in bytes */
size_t GetValidKeyLength (size_t n) const
 returns the smallest valid key length in bytes that is >= min(n, GetMaxKeyLength())
XMACC_Base< T >::IV_Requirement IVRequirement () const
 returns the minimal requirement for secure IVs
ByteOrder GetByteOrder () const
unsigned int BlockSize () const
 block size of underlying compression function, or 0 if not block based
unsigned int OptimalBlockSize () const
 input to Update() should have length a multiple of this for optimal speed
unsigned int OptimalDataAlignment () const
 returns how input should be aligned for optimal performance
void Update (const byte *input, size_t length)
 process more input
byte * CreateUpdateSpace (size_t &size)
 request space to write input into
void Restart ()
 discard the current state, and restart with a new message
void TruncatedFinal (byte *digest, size_t size)
 truncated version of Final()
virtual void Final (byte *digest)
 compute hash for current message, then restart for a new message
virtual unsigned int DigestSize () const =0
 size of the hash returned by Final()
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 bool IsValidKeyLength (size_t n) const
 returns whether n is a valid key length
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)
 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)
virtual unsigned int IVSize () const
 returns size of IVs used by this object
virtual void Resynchronize (const byte *IV)
 resynchronize with an IV
virtual void GetNextIV (byte *IV)
 get a secure IV for the next message

Static Public Member Functions

std::string __cdecl StaticAlgorithmName ()
size_t __cdecl StaticGetValidKeyLength (size_t)
void CorrectEndianess (HashWordType *out, const HashWordType *in, size_t byteCount)

Static Public Attributes

CompileAssert<((BLOCKSIZE
&(BLOCKSIZE-1))==0) 
cryptopp_assert___LINE__ )

Protected Member Functions

void AssertValidKeyLength (size_t length)
void AssertValidKeyLength (size_t length) const
void SetBlockSize (unsigned int blockSize)
void SetStateSize (unsigned int stateSize)
T::HashWordType GetBitCountHi () const
T::HashWordType GetBitCountLo () const
void PadLastBlock (unsigned int lastBlockSize, byte padFirst=0x80)
virtual void Init ()=0
virtual void HashEndianCorrectedBlock (const HashWordType *data)=0
virtual size_t HashMultipleBlocks (const T::HashWordType *input, size_t length)
void HashBlock (const HashWordType *input)
void ThrowIfInvalidTruncatedSize (size_t size) const
void ThrowIfInvalidKeyLength (const Algorithm &algorithm, size_t length)
void ThrowIfResynchronizable ()
void ThrowIfInvalidIV (const byte *iv)
const byte * GetIVAndThrowIfInvalid (const NameValuePairs &params)

Protected Attributes

SecBlock< T::HashWordType > m_data
SecBlock< T::HashWordType > m_digest


Member Function Documentation

void MessageAuthenticationCodeImpl< XMACC_Base< T > , XMACC_Base< T > >::SetKey const byte *  key,
size_t  length,
const NameValuePairs params = g_nullNameValuePairs
[inline, virtual, inherited]
 

Implements SimpleKeyingInterface.

Definition at line 188 of file seckey.h.

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 534 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 560 of file cryptlib.h.

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 384 of file cryptlib.h.

References SimpleKeyingInterface::IVRequirement().

virtual void SimpleKeyingInterface::GetNextIV byte *  IV  )  [inline, 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 400 of file cryptlib.h.


The documentation for this class was generated from the following file:
Generated on Tue Aug 16 08:38:55 2005 for Crypto++ by  doxygen 1.3.9.1