Interface for algorithms that take byte strings as keys. More...

#include <cryptlib.h>

Inheritance diagram for SimpleKeyingInterface:

Public Types
enum	IV_Requirement { UNIQUE_IV = 0 , RANDOM_IV , UNPREDICTABLE_RANDOM_IV , INTERNALLY_GENERATED_IV , NOT_RESYNCHRONIZABLE }
	Secure IVs requirements as enumerated values. More...

Public Member Functions
virtual size_t	MinKeyLength () const =0
	Returns smallest valid key length.

virtual size_t	MaxKeyLength () const =0
	Returns largest valid key length.

virtual size_t	DefaultKeyLength () const =0
	Returns default key length.

virtual size_t	GetValidKeyLength (size_t keylength) const =0
	Returns a valid key length for the algorithm.

virtual bool	IsValidKeyLength (size_t keylength) const
	Returns whether keylength is a valid key length.

virtual void	SetKey (const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)
	Sets or reset the key of this object.

void	SetKeyWithRounds (const byte *key, size_t length, int rounds)
	Sets or reset the key of this object.

void	SetKeyWithIV (const byte key, size_t length, const byte iv, size_t ivLength)
	Sets or reset the key of this object.

void	SetKeyWithIV (const byte key, size_t length, const byte iv)
	Sets or reset the key of this object.

virtual IV_Requirement	IVRequirement () const =0
	Minimal requirement for secure IVs.

bool	IsResynchronizable () const
	Determines if the object can be resynchronized.

bool	CanUseRandomIVs () const
	Determines if the object can use random IVs.

bool	CanUsePredictableIVs () const
	Determines if the object can use random but possibly predictable IVs.

bool	CanUseStructuredIVs () const
	Determines if the object can use structured IVs.

virtual unsigned int	IVSize () const
	Returns length of the IV accepted by this object.

unsigned int	DefaultIVLength () const
	Provides the default size of an IV.

virtual unsigned int	MinIVLength () const
	Provides the minimum size of an IV.

virtual unsigned int	MaxIVLength () const
	Provides the maximum size of an IV.

virtual void	Resynchronize (const byte *iv, int ivLength=-1)
	Resynchronize with an IV.

virtual void	GetNextIV (RandomNumberGenerator &rng, byte *iv)
	Retrieves a secure IV for the next message.

Protected Member Functions
virtual const Algorithm &	GetAlgorithm () const =0
	Returns the base class Algorithm.

virtual void	UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)=0
	Sets the key for this object without performing parameter validation.

void	ThrowIfInvalidKeyLength (size_t length)
	Validates the key length.

void	ThrowIfResynchronizable ()
	Validates the object.

void	ThrowIfInvalidIV (const byte *iv)
	Validates the IV.

size_t	ThrowIfInvalidIVLength (int length)
	Validates the IV length.

const byte *	GetIVAndThrowIfInvalid (const NameValuePairs &params, size_t &size)
	Retrieves and validates the IV.

void	AssertValidKeyLength (size_t length) const
	Validates the key length.

Detailed Description

Interface for algorithms that take byte strings as keys.

See also: FixedKeyLength(), VariableKeyLength(), SameKeyLengthAs(), SimpleKeyingInterfaceImpl()

Definition at line 641 of file cryptlib.h.

Member Enumeration Documentation

◆ IV_Requirement

enum SimpleKeyingInterface::IV_Requirement

Secure IVs requirements as enumerated values.

Provides secure IV requirements as a monotonically increasing enumerated values. Requirements can be compared using less than (<) and greater than (>). For example, UNIQUE_IV < RANDOM_IV and UNPREDICTABLE_RANDOM_IV > RANDOM_IV.

Objects that use SimpleKeyingInterface do not support an optional IV. That is, an IV must be present or it must be absent. If you wish to support an optional IV then provide two classes - one with an IV and one without an IV.

See also: IsResynchronizable(), CanUseRandomIVs(), CanUsePredictableIVs(), CanUseStructuredIVs()

Enumerator
UNIQUE_IV	The IV must be unique.
RANDOM_IV	The IV must be random and possibly predictable.
UNPREDICTABLE_RANDOM_IV	The IV must be random and unpredictable.
INTERNALLY_GENERATED_IV	The IV is set by the object.
NOT_RESYNCHRONIZABLE	The object does not use an IV.

Definition at line 719 of file cryptlib.h.

Constructor & Destructor Documentation

◆ ~SimpleKeyingInterface()

virtual SimpleKeyingInterface::~SimpleKeyingInterface ( )

inlinevirtual

Definition at line 644 of file cryptlib.h.

Member Function Documentation

◆ AssertValidKeyLength()

void SimpleKeyingInterface::AssertValidKeyLength ( size_t length ) const

inlineprotected

Validates the key length.

Parameters

length the size of the keying material, in bytes

Definition at line 846 of file cryptlib.h.

◆ CanUsePredictableIVs()

bool SimpleKeyingInterface::CanUsePredictableIVs ( ) const

inline

Determines if the object can use random but possibly predictable IVs.

Returns: true if the object can use random but possibly predictable IVs (in addition to ones returned by GetNextIV), false otherwise

Definition at line 749 of file cryptlib.h.

◆ CanUseRandomIVs()

bool SimpleKeyingInterface::CanUseRandomIVs ( ) const

inline

Determines if the object can use random IVs.

Returns: true if the object can use random IVs (in addition to ones returned by GetNextIV), false otherwise

Definition at line 744 of file cryptlib.h.

◆ CanUseStructuredIVs()

bool SimpleKeyingInterface::CanUseStructuredIVs ( ) const

inline

Determines if the object can use structured IVs.

Returns: true if the object can use structured IVs, false otherwise

CanUseStructuredIVs() indicates whether the object can use structured IVs; for example a counter (in addition to ones returned by GetNextIV).

Definition at line 755 of file cryptlib.h.

◆ DefaultIVLength()

unsigned int SimpleKeyingInterface::DefaultIVLength ( ) const

inline

Provides the default size of an IV.

Returns: default length of IVs accepted by this object, in bytes

Definition at line 766 of file cryptlib.h.

◆ DefaultKeyLength()

virtual size_t SimpleKeyingInterface::DefaultKeyLength ( ) const

pure virtual

Returns default key length.

Returns: the default key length, in bytes

◆ GetAlgorithm()

virtual const Algorithm & SimpleKeyingInterface::GetAlgorithm ( ) const

protectedpure virtual

Returns the base class Algorithm.

Returns: the base class Algorithm

Implemented in BlockCipher, SymmetricCipher, MessageAuthenticationCode, and AuthenticatedSymmetricCipher.

◆ GetIVAndThrowIfInvalid()

const byte * SimpleKeyingInterface::GetIVAndThrowIfInvalid	(	const NameValuePairs &	params,
		size_t &	size
	)

protected

Retrieves and validates the IV.

Parameters

params	NameValuePairs with the IV supplied as a ConstByteArrayParameter
size	the length of the IV, in bytes

Returns: a pointer to the first byte of the IV

Exceptions

InvalidArgument if the number of rounds are invalid

Definition at line 107 of file cryptlib.cpp.

◆ GetNextIV()

void SimpleKeyingInterface::GetNextIV	(	RandomNumberGenerator &	rng,
		byte *	iv
	)

virtual

Retrieves a secure IV for the next message.

Parameters

rng	a RandomNumberGenerator to produce keying material
iv	a block of bytes to receive the IV

The IV must be at least IVSize() in length.

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.

Internally, the base class implementation calls RandomNumberGenerator's GenerateBlock()

Note: This method is not implemented on decryption objects.

Reimplemented in Poly1305_Base< T >, and VMAC_Base.

Definition at line 136 of file cryptlib.cpp.

◆ GetValidKeyLength()

virtual size_t SimpleKeyingInterface::GetValidKeyLength ( size_t keylength ) const

pure virtual

Returns a valid key length for the algorithm.

Parameters

keylength the size of the key, in bytes

Returns: the valid key length, in bytes

keylength is provided in bytes, not bits. If keylength is less than MIN_KEYLENGTH, then the function returns MIN_KEYLENGTH. If keylength is greater than MAX_KEYLENGTH, then the function returns MAX_KEYLENGTH. if If keylength is a multiple of KEYLENGTH_MULTIPLE, then keylength is returned. Otherwise, the function returns a lower multiple of KEYLENGTH_MULTIPLE.

◆ IsResynchronizable()

bool SimpleKeyingInterface::IsResynchronizable ( ) const

inline

Determines if the object can be resynchronized.

Returns: true if the object can be resynchronized (i.e. supports initialization vectors), false otherwise

Note: 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 740 of file cryptlib.h.

◆ IsValidKeyLength()

virtual bool SimpleKeyingInterface::IsValidKeyLength ( size_t keylength ) const

inlinevirtual

Returns whether keylength is a valid key length.

Parameters

keylength the requested keylength

Returns: true if keylength is valid, false otherwise

Internally the function calls GetValidKeyLength()

Reimplemented in CCM_Base, CipherModeBase, XTS_ModeBase, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, and GCM_Base.

Definition at line 672 of file cryptlib.h.

◆ IVRequirement()

virtual IV_Requirement SimpleKeyingInterface::IVRequirement ( ) const

pure virtual

Minimal requirement for secure IVs.

Returns: the secure IV requirement of the algorithm

◆ IVSize()

virtual unsigned int SimpleKeyingInterface::IVSize ( ) const

inlinevirtual

Returns length of the IV accepted by this object.

Returns: the size of an IV, in bytes

Exceptions

NotImplemented() if the object does not support resynchronization

The default implementation throws NotImplemented

Definition at line 761 of file cryptlib.h.

◆ MaxIVLength()

virtual unsigned int SimpleKeyingInterface::MaxIVLength ( ) const

inlinevirtual

Provides the maximum size of an IV.

Returns: maximal length of IVs accepted by this object, in bytes

Exceptions

NotImplemented() if the object does not support resynchronization

Reimplemented in CCM_Base, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, and GCM_Base.

Definition at line 776 of file cryptlib.h.

◆ MaxKeyLength()

virtual size_t SimpleKeyingInterface::MaxKeyLength ( ) const

pure virtual

Returns largest valid key length.

Returns: the maximum key length, in bytes

◆ MinIVLength()

virtual unsigned int SimpleKeyingInterface::MinIVLength ( ) const

inlinevirtual

Provides the minimum size of an IV.

Returns: minimal length of IVs accepted by this object, in bytes

Exceptions

NotImplemented() if the object does not support resynchronization

Reimplemented in CCM_Base, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, GCM_Base, and VMAC_Base.

Definition at line 771 of file cryptlib.h.

◆ MinKeyLength()

virtual size_t SimpleKeyingInterface::MinKeyLength ( ) const

pure virtual

Returns smallest valid key length.

Returns: the minimum key length, in bytes

◆ Resynchronize()

virtual void SimpleKeyingInterface::Resynchronize	(	const byte *	iv,
		int	ivLength = `-1`
	)

inlinevirtual

Resynchronize with an IV.

Parameters

iv	the initialization vector
ivLength	the size of the initialization vector, in bytes

Resynchronize() resynchronizes with an IV provided by the caller. ivLength=-1 means use IVSize().

Exceptions

NotImplemented() if the object does not support resynchronization

Reimplemented in Poly1305_Base< T >, XTS_ModeBase, AuthenticatedSymmetricCipherBase, BlockOrientedCipherModeBase, AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > >, CFB_CipherTemplate< AbstractPolicyHolder< CFB_CipherAbstractPolicy, SymmetricCipher > >, and VMAC_Base.

Definition at line 783 of file cryptlib.h.

◆ SetKey()

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

virtual

Sets or reset the key of this object.

Parameters

key	the key to use when keying the object
length	the size of the key, in bytes
params	additional initialization parameters to configure this object

Reimplemented in ECB_OneWay, XTS_ModeBase, and AuthenticatedSymmetricCipherBase.

Definition at line 58 of file cryptlib.cpp.

◆ SetKeyWithIV() [1/2]

void SimpleKeyingInterface::SetKeyWithIV	(	const byte *	key,
		size_t	length,
		const byte *	iv
	)

inline

Sets or reset the key of this object.

Parameters

key	the key to use when keying the object
length	the size of the key, in bytes
iv	the initialization vector to use when keying the object

SetKeyWithIV() calls SetKey() with a NameValuePairs() object that only specifies iv. iv is a byte buffer, and it must have a size IVSize().

Definition at line 708 of file cryptlib.h.

◆ SetKeyWithIV() [2/2]

void SimpleKeyingInterface::SetKeyWithIV	(	const byte *	key,
		size_t	length,
		const byte *	iv,
		size_t	ivLength
	)

Sets or reset the key of this object.

Parameters

key	the key to use when keying the object
length	the size of the key, in bytes
iv	the initialization vector to use when keying the object
ivLength	the size of the iv, in bytes

SetKeyWithIV() calls SetKey() with a NameValuePairs that only specifies IV. The IV is a byte buffer with size ivLength. ivLength is an integer parameter, and -1 means use IVSize().

Definition at line 69 of file cryptlib.cpp.

◆ SetKeyWithRounds()

void SimpleKeyingInterface::SetKeyWithRounds	(	const byte *	key,
		size_t	length,
		int	rounds
	)

Sets or reset the key of this object.

Parameters

key	the key to use when keying the object
length	the size of the key, in bytes
rounds	the number of rounds to apply the transformation function, if applicable

SetKeyWithRounds() calls SetKey() with a NameValuePairs object that only specifies rounds. rounds is an integer parameter, and -1 means use the default number of rounds.

Definition at line 64 of file cryptlib.cpp.

◆ ThrowIfInvalidIV()

void SimpleKeyingInterface::ThrowIfInvalidIV ( const byte * iv )

protected

Validates the IV.

Parameters

iv	the IV with a length of IVSize, in bytes

Exceptions

InvalidArgument on failure

Internally, the default implementation checks the iv. If iv is not NULL or nullptr, then the function succeeds. If iv is NULL, then IVRequirement is checked against UNPREDICTABLE_RANDOM_IV. If IVRequirement is UNPREDICTABLE_RANDOM_IV, then then the function succeeds. Otherwise, an exception is thrown.

Definition at line 86 of file cryptlib.cpp.

◆ ThrowIfInvalidIVLength()

size_t SimpleKeyingInterface::ThrowIfInvalidIVLength ( int length )

protected

Validates the IV length.

Parameters

length the size of an IV, in bytes

Exceptions

InvalidArgument if the IV length is invalid

Definition at line 92 of file cryptlib.cpp.

◆ ThrowIfInvalidKeyLength()

void SimpleKeyingInterface::ThrowIfInvalidKeyLength ( size_t length )

protected

Validates the key length.

Parameters

length the size of the keying material, in bytes

Exceptions

InvalidKeyLength if the key length is invalid

Definition at line 74 of file cryptlib.cpp.

◆ ThrowIfResynchronizable()

void SimpleKeyingInterface::ThrowIfResynchronizable ( )

protected

Validates the object.

Exceptions

InvalidArgument if the IV is present

Internally, the default implementation calls IsResynchronizable() and throws InvalidArgument if the function returns true.

Note: called when no IV is passed

Definition at line 80 of file cryptlib.cpp.

◆ UncheckedSetKey()

virtual void SimpleKeyingInterface::UncheckedSetKey	(	const byte *	key,
		unsigned int	length,
		const NameValuePairs &	params
	)

protectedpure virtual

Sets the key for this object without performing parameter validation.

Parameters

key	a byte buffer used to key the cipher
length	the length of the byte buffer
params	additional parameters passed as NameValuePairs

key must be at least DEFAULT_KEYLENGTH in length.

Implemented in Weak1::ARC4_Base, CBC_MAC_Base, CMAC_Base, DMAC_Base< T >, BlockOrientedCipherModeBase, CBC_CTS_Encryption, Poly1305_Base< T >, Poly1305TLS_Base, SipHash_Base< C, D, T_128bit >, SipHash_Base< 2, 4, false >, HMAC_Base, VMAC_Base, and SAFER::Base.

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

G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/cryptlib.h
G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/cryptlib.cpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ IV_Requirement

Constructor & Destructor Documentation

◆ ~SimpleKeyingInterface()

Member Function Documentation

◆ AssertValidKeyLength()

◆ CanUsePredictableIVs()

◆ CanUseRandomIVs()

◆ CanUseStructuredIVs()

◆ DefaultIVLength()

◆ DefaultKeyLength()

◆ GetAlgorithm()

◆ GetIVAndThrowIfInvalid()

◆ GetNextIV()

◆ GetValidKeyLength()

◆ IsResynchronizable()

◆ IsValidKeyLength()

◆ IVRequirement()

◆ IVSize()

◆ MaxIVLength()

◆ MaxKeyLength()

◆ MinIVLength()

◆ MinKeyLength()

◆ Resynchronize()

◆ SetKey()

◆ SetKeyWithIV() [1/2]

◆ SetKeyWithIV() [2/2]

◆ SetKeyWithRounds()

◆ ThrowIfInvalidIV()

◆ ThrowIfInvalidIVLength()

◆ ThrowIfInvalidKeyLength()

◆ ThrowIfResynchronizable()

◆ UncheckedSetKey()