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 > > XMACC_Base< T > FixedKeyLength< DigestSizeSubtract4Workaround< T >::RESULT, SimpleKeyingInterface::INTERNALLY_GENERATED_IV > IteratedHash< T::HashWordType, T::ByteOrderClass, T::BLOCKSIZE, MessageAuthenticationCode > IteratedHashBase2< T::HashWordType, T::ByteOrderClass, 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

typedef T::HashWordType HashWordType
enum  { DIGESTSIZE = 4+T::DIGESTSIZE }
typedef CompileAssert<((BLOCKSIZE
&(BLOCKSIZE-1))==0) 
cryptopp_assert___LINE__ )
typedef T::ByteOrderClass ByteOrderClass
enum  IV_Requirement {
  STRUCTURED_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV,
  NOT_RESYNCHRONIZABLE
}

Public Member Functions

 XMACC ()
 XMACC (const byte *key, word32 counter=0xffffffff)
ClonableClone () const
 this is not implemented by most classes yet
void SetKey (const byte *key, unsigned int 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
unsigned int MinKeyLength () const
 returns smallest valid key length in bytes */
unsigned int MaxKeyLength () const
 returns largest valid key length in bytes */
unsigned int DefaultKeyLength () const
 returns default (recommended) key length in bytes */
unsigned int GetValidKeyLength (unsigned int 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
void CheckedSetKey (void *, Empty empty, const byte *key, unsigned int length, const NameValuePairs &params)
void Resynchronize (const byte *IV)
 resynchronize with an IV
unsigned int IVSize () const
 returns size of IVs used by this object
void GetNextIV (byte *IV)
 get a secure IV for the next message
word32 CurrentCounter () const
void TruncatedFinal (byte *mac, unsigned int size)
 truncated version of Final()
bool TruncatedVerify (const byte *mac, unsigned int length)
 truncated version of Verify()
unsigned int DigestSize () const
 size of the hash returned by Final()
 IteratedHashBase ()
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, unsigned int length)
 process more input
byte * CreateUpdateSpace (unsigned int &size)
 request space to write input into
void Restart ()
 discard the current state, and restart with a new message
virtual void Final (byte *digest)
 compute hash for current message, then restart for a new message
virtual void CalculateDigest (byte *digest, const byte *input, unsigned int 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, unsigned int 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, unsigned int digestSize, const byte *input, unsigned int length)
 truncated version of CalculateDigest()
virtual bool VerifyTruncatedDigest (const byte *digest, unsigned int digestLength, const byte *input, unsigned int length)
 truncated version of VerifyDigest()
virtual bool IsValidKeyLength (unsigned int n) const
 returns whether n is a valid key length
void SetKeyWithRounds (const byte *key, unsigned int length, int rounds)
 calls SetKey() with an NameValuePairs object that just specifies "Rounds"
void SetKeyWithIV (const byte *key, unsigned int 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)

Static Public Member Functions

static std::string StaticAlgorithmName ()
static unsigned int StaticGetValidKeyLength (unsigned int)
static void CorrectEndianess (HashWordType *out, const HashWordType *in, unsigned int byteCount)

Protected Member Functions

void AssertValidKeyLength (unsigned int length)
void AssertValidKeyLength (unsigned int length) const
virtual void HashEndianCorrectedBlock (const HashWordType *data)=0
 IteratedHash ()
void HashBlock (const HashWordType *input)
virtual void HashBlock (const T::HashWordType *input)=0
void SetBlockSize (unsigned int blockSize)
void SetStateSize (unsigned int stateSize)
T::HashWordType GetBitCountHi () const
T::HashWordType GetBitCountLo () const
virtual unsigned int HashMultipleBlocks (const T::HashWordType *input, unsigned int length)
void PadLastBlock (unsigned int lastBlockSize, byte padFirst=0x80)
void ThrowIfInvalidTruncatedSize (unsigned int size) const
void ThrowIfInvalidKeyLength (const Algorithm &algorithm, unsigned int 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,
unsigned int  length,
const NameValuePairs params = g_nullNameValuePairs
[inline, virtual, inherited]
 

Implements SimpleKeyingInterface.

Definition at line 188 of file seckey.h.

Referenced by XMACC< T >::XMACC().

template<class T>
void XMACC_Base< T >::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.

Reimplemented from SimpleKeyingInterface.

Definition at line 34 of file xormac.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 532 of file cryptlib.h.

Referenced by PSSR_MEM_Base::ComputeMessageRepresentative(), PKCS1v15_SignatureMessageEncodingMethod::ComputeMessageRepresentative(), EMSA5Pad< T >::ComputeMessageRepresentative(), PKCS5_PBKDF2_HMAC< T >::DeriveKey(), DefaultEncryptor::FirstPut(), HashFilter::Put2(), PSSR_MEM_Base::RecoverMessageFromRepresentative(), HMAC_Base::TruncatedFinal(), ZlibCompressor::WritePoststreamTail(), and Gzip::WritePoststreamTail().

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

Referenced by HashVerificationFilter::LastPut(), Gunzip::ProcessPoststreamTail(), and PSSR_MEM_Base::RecoverMessageFromRepresentative().

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.

Referenced by SimpleKeyingInterface::ThrowIfInvalidIV(), SimpleKeyingInterface::ThrowIfResynchronizable(), and BlockOrientedCipherModeBase::UncheckedSetKey().


The documentation for this class was generated from the following file:
Generated on Fri Sep 9 19:01:39 2005 for Crypto++ by  doxygen 1.4.4