Crypto++
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Weak::PanamaMAC< B > Class Template Reference

Panama MAC. More...

#include <panama.h>

Inheritance diagram for Weak::PanamaMAC< B >:
HermeticHashFunctionMAC< PanamaHash< B > > AlgorithmImpl< SimpleKeyingInterfaceImpl< TwoBases< MessageAuthenticationCode, VariableKeyLength< 32, 0, INT_MAX > > >, T_Info > SimpleKeyingInterfaceImpl< TwoBases< MessageAuthenticationCode, VariableKeyLength< 32, 0, INT_MAX > > > TwoBases< MessageAuthenticationCode, VariableKeyLength< 32, 0, INT_MAX > > MessageAuthenticationCode VariableKeyLength< 32, 0, INT_MAX > SimpleKeyingInterface HashTransformation Algorithm Clonable

Public Types

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

Public Member Functions

 PanamaMAC (const byte *key, unsigned int length)
 
void UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)
 
void Restart ()
 discard the current state, and restart with a new message
 
void Update (const byte *input, size_t length)
 process more input
 
void TruncatedFinal (byte *digest, size_t digestSize)
 truncated version of Final()
 
unsigned int DigestSize () const
 size of the hash/digest/MAC returned by Final()
 
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
 
std::string AlgorithmName () const
 
size_t MinKeyLength () const
 
size_t MaxKeyLength () const
 
size_t DefaultKeyLength () const
 
size_t GetValidKeyLength (size_t n) const
 
SimpleKeyingInterface::IV_Requirement IVRequirement () const
 
unsigned int IVSize () const
 
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 More...
 
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) More...
 
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 More...
 
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 More...
 
unsigned int TagSize () const
 same as DigestSize()
 
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 More...
 
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 size_t StaticGetValidKeyLength (size_t n)
 

Static Public Attributes

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

Protected Member Functions

void KeyHash ()
 
const AlgorithmGetAlgorithm () const
 
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
 

Protected Attributes

PanamaHash< B > m_hash
 
bool m_keyed
 
SecByteBlock m_key
 

Detailed Description

template<class B = LittleEndian>
class Weak::PanamaMAC< B >

Panama MAC.

Definition at line 100 of file panama.h.

Member Function Documentation

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

set or reset the key of this object

Parameters
paramsis used to specify Rounds, BlockSize, etc.

Reimplemented in ECB_OneWay, and AuthenticatedSymmetricCipherBase.

bool SimpleKeyingInterface::IsResynchronizable ( ) const
inlineinherited

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

virtual void SimpleKeyingInterface::GetNextIV ( RandomNumberGenerator rng,
byte *  IV 
)
virtualinherited

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

virtual void HashTransformation::Final ( byte *  digest)
inlinevirtualinherited

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

Precondition
size of digest == DigestSize().

Definition at line 544 of file cryptlib.h.

Referenced by PKCS5_PBKDF2_HMAC< T >::DeriveKey().

virtual bool HashTransformation::Verify ( const byte *  digest)
inlinevirtualinherited

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


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