SimpleKeyedTransformation< T > Class Template Reference

Inheritance diagram for SimpleKeyedTransformation< T >:

List of all members.

---

Detailed Description

template<class T>
class SimpleKeyedTransformation< T >

Definition at line 597 of file cryptlib.h.

Public Types
enum	IV_Requirement {   UNIQUE_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV,   NOT_RESYNCHRONIZABLE }
Public Member Functions
virtual size_t	MinKeyLength () const=0
	returns smallest valid key length in bytes */
virtual size_t	MaxKeyLength () const=0
	returns largest valid key length in bytes */
virtual size_t	DefaultKeyLength () const=0
	returns default (recommended) key length in bytes */
virtual size_t	GetValidKeyLength (size_t n) const=0
	returns the smallest valid key length in bytes that is >= min(n, GetMaxKeyLength())
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)
	calls SetKey() with an NameValuePairs object that just specifies "IV"
virtual IV_Requirement	IVRequirement () const=0
	returns the minimal requirement for secure IVs
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 (RandomNumberGenerator &rng, byte *IV)
	get a secure IV for the next message
Protected Member Functions
const Algorithm &	GetAlgorithm () const
virtual void	UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)=0
void	ThrowIfInvalidKeyLength (size_t length)
void	ThrowIfResynchronizable ()
void	ThrowIfInvalidIV (const byte *iv)
const byte *	GetIVAndThrowIfInvalid (const NameValuePairs &params)
void	AssertValidKeyLength (size_t length) const

---

Member Enumeration Documentation

enum SimpleKeyingInterface::IV_Requirement [inherited]

Enumerator:

UNIQUE_IV
RANDOM_IV
UNPREDICTABLE_RANDOM_IV
INTERNALLY_GENERATED_IV
NOT_RESYNCHRONIZABLE

Definition at line 382 of file cryptlib.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

Reimplemented in ECB_OneWay.

Definition at line 52 of file cryptlib.cpp.

References SimpleKeyingInterface::ThrowIfInvalidKeyLength().

Referenced by CBC_MAC< T >::CBC_MAC(), CipherModeFinalTemplate_CipherHolder< CIPHER, BASE >::CipherModeFinalTemplate_CipherHolder(), DMAC< T >::DMAC(), HMAC< T >::HMAC(), Weak::PanamaMAC< B >::PanamaMAC(), ECB_OneWay::SetKey(), SimpleKeyingInterface::SetKeyWithIV(), SimpleKeyingInterface::SetKeyWithRounds(), VMAC_Base::UncheckedSetKey(), and BlockOrientedCipherModeBase::UncheckedSetKey().

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

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

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.

Reimplemented in VMAC_Base.

Definition at line 96 of file cryptlib.cpp.

References RandomNumberGenerator::GenerateBlock(), and SimpleKeyingInterface::IVSize().

Referenced by VMAC_Base::GetNextIV().

---

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

• cryptlib.h

---