Block cipher mode of operation default implementation. More...

#include <modes.h>

Inheritance diagram for BlockOrientedCipherModeBase:

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

unsigned int	MandatoryBlockSize () const
	Provides the mandatory block size of the cipher.

bool	IsRandomAccess () const
	Determines whether the cipher supports random access.

bool	IsSelfInverting () const
	Determines whether the cipher is self-inverting.

bool	IsForwardTransformation () const
	Determines if the cipher is being operated in its forward direction.

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

Public Member Functions inherited from CipherModeBase
std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm.

size_t	MinKeyLength () const
	Returns smallest valid key length.

size_t	MaxKeyLength () const
	Returns largest valid key length.

size_t	DefaultKeyLength () const
	Returns default key length.

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

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

unsigned int	OptimalDataAlignment () const
	Provides input and output data alignment for optimal performance.

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

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

void	SetCipher (BlockCipher &cipher)
	Set external block cipher.

void	SetCipherWithIV (BlockCipher &cipher, const byte *iv, int feedbackSize=0)
	Set external block cipher and IV.

Public Member Functions inherited from SimpleKeyingInterface
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.

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.

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	GetNextIV (RandomNumberGenerator &rng, byte *iv)
	Retrieves a secure IV for the next message.

Public Member Functions inherited from StreamTransformation
StreamTransformation &	Ref ()
	Provides a reference to this object.

virtual unsigned int	OptimalBlockSize () const
	Provides the input block size most efficient for this cipher.

virtual unsigned int	GetOptimalBlockSizeUsed () const
	Provides the number of bytes used in the current block when processing at optimal block size.

virtual void	ProcessData (byte outString, const byte inString, size_t length)=0
	Encrypt or decrypt an array of bytes.

virtual size_t	ProcessLastBlock (byte outString, size_t outLength, const byte inString, size_t inLength)
	Encrypt or decrypt the last block of data.

virtual unsigned int	MinLastBlockSize () const
	Provides the size of the last block.

virtual bool	IsLastBlockSpecial () const
	Determines if the last block receives special processing.

void	ProcessString (byte *inoutString, size_t length)
	Encrypt or decrypt a string of bytes.

void	ProcessString (byte outString, const byte inString, size_t length)
	Encrypt or decrypt a string of bytes.

byte	ProcessByte (byte input)
	Encrypt or decrypt a byte.

virtual void	Seek (lword pos)
	Seek to an absolute position.

Public Member Functions inherited from Algorithm
	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms.

virtual std::string	AlgorithmName () const
	Provides the name of this algorithm.

Public Member Functions inherited from Clonable
virtual Clonable *	Clone () const
	Copies this object.

Additional Inherited Members
Public Types inherited from SimpleKeyingInterface
enum	IV_Requirement { UNIQUE_IV = 0 , RANDOM_IV , UNPREDICTABLE_RANDOM_IV , INTERNALLY_GENERATED_IV , NOT_RESYNCHRONIZABLE }
	Secure IVs requirements as enumerated values. More...

Detailed Description

Block cipher mode of operation default implementation.

Definition at line 250 of file modes.h.

Constructor & Destructor Documentation

◆ ~BlockOrientedCipherModeBase()

virtual BlockOrientedCipherModeBase::~BlockOrientedCipherModeBase ( )

inlinevirtual

Definition at line 253 of file modes.h.

Member Function Documentation

◆ UncheckedSetKey()

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

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.

Implements SimpleKeyingInterface.

◆ MandatoryBlockSize()

unsigned int BlockOrientedCipherModeBase::MandatoryBlockSize ( ) const

inlinevirtual

Provides the mandatory block size of the cipher.

Returns: The block size of the cipher if input must be processed in blocks, 1 otherwise

Stream ciphers and some block ciphers modes of operation return 1. Modes that return 1 must be able to process a single byte at a time, like counter mode. If a mode of operation or block cipher cannot stream then it must not return 1.

When filters operate the mode or cipher, ProcessData will be called with a string of bytes that is determined by MandatoryBlockSize and OptimalBlockSize. When a policy is set, like 16-byte strings for a 16-byte block cipher, the filter will buffer bytes until the specified number of bytes is available to the object.

See also: ProcessData, ProcessLastBlock, MandatoryBlockSize, MinLastBlockSize, BlockPaddingSchemeDef, IsLastBlockSpecial

Reimplemented from StreamTransformation.

Definition at line 255 of file modes.h.

◆ IsRandomAccess()

bool BlockOrientedCipherModeBase::IsRandomAccess ( ) const

inlinevirtual

Determines whether the cipher supports random access.

Returns: true if the cipher supports random access, false otherwise

Implements StreamTransformation.

Definition at line 256 of file modes.h.

◆ IsSelfInverting()

bool BlockOrientedCipherModeBase::IsSelfInverting ( ) const

inlinevirtual

Determines whether the cipher is self-inverting.

Returns: true if the cipher is self-inverting, false otherwise

IsSelfInverting determines whether this transformation is self-inverting (e.g. xor with a keystream).

Implements StreamTransformation.

Definition at line 257 of file modes.h.

◆ IsForwardTransformation()

bool BlockOrientedCipherModeBase::IsForwardTransformation ( ) const

inlinevirtual

Determines if the cipher is being operated in its forward direction.

Returns: true if DIR is ENCRYPTION, false otherwise

See also: IsForwardTransformation(), IsPermutation(), GetCipherDirection()

Implements StreamTransformation.

Definition at line 258 of file modes.h.

◆ Resynchronize()

void BlockOrientedCipherModeBase::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 from SimpleKeyingInterface.

Reimplemented in XTS_ModeBase.

Definition at line 260 of file modes.h.

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

modes.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~BlockOrientedCipherModeBase()

Member Function Documentation

◆ UncheckedSetKey()

◆ MandatoryBlockSize()

◆ IsRandomAccess()

◆ IsSelfInverting()

◆ IsForwardTransformation()

◆ Resynchronize()