Interface for one direction (encryption or decryption) of a block cipher. More...

#include <cryptlib.h>

Inheritance diagram for BlockCipher:

Collaboration diagram for BlockCipher:

Protected Member Functions
const Algorithm &	GetAlgorithm () const
	Returns the base class Algorithm. More...

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

void	ThrowIfInvalidKeyLength (size_t length)
	Validates the key length. More...

void	ThrowIfResynchronizable ()
	Validates the object. More...

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

size_t	ThrowIfInvalidIVLength (int length)
	Validates the IV length. More...

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

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

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

Public Types inherited from BlockTransformation
enum	FlagsForAdvancedProcessBlocks { BT_InBlockIsCounter =1, BT_DontIncrementInOutPointers =2, BT_XorInput =4, BT_ReverseDirection =8, BT_AllowParallel =16 }
	Bit flags that control AdvancedProcessBlocks() behavior. More...

Public Member Functions inherited from SimpleKeyingInterface
virtual	~SimpleKeyingInterface ()

virtual size_t	MinKeyLength () const =0
	Returns smallest valid key length. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from BlockTransformation
virtual	~BlockTransformation ()

virtual void	ProcessAndXorBlock (const byte inBlock, const byte xorBlock, byte *outBlock) const =0
	Encrypt or decrypt a block. More...

void	ProcessBlock (const byte inBlock, byte outBlock) const
	Encrypt or decrypt a block. More...

void	ProcessBlock (byte *inoutBlock) const
	Encrypt or decrypt a block in place. More...

virtual unsigned int	BlockSize () const =0
	Provides the block size of the cipher. More...

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

virtual bool	IsPermutation () const
	returns true if this is a permutation (i.e. there is an inverse transformation) More...

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

virtual unsigned int	OptimalNumberOfParallelBlocks () const
	Determines the number of blocks that can be processed in parallel. More...

virtual size_t	AdvancedProcessBlocks (const byte inBlocks, const byte xorBlocks, byte *outBlocks, size_t length, word32 flags) const
	Encrypt and xor multiple blocks using additional flags. More...

CipherDir	GetCipherDirection () const
	Provides the direction of the cipher. More...

Public Member Functions inherited from Algorithm
virtual	~Algorithm ()

	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...

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

Public Member Functions inherited from Clonable
virtual	~Clonable ()

virtual Clonable *	Clone () const
	Copies this object. More...

Detailed Description

Interface for one direction (encryption or decryption) of a block cipher.

These objects usually should not be used directly. See BlockTransformation for more details.

Definition at line 1095 of file cryptlib.h.

Member Function Documentation

const Algorithm& BlockCipher::GetAlgorithm ( ) const

inlineprotectedvirtual

Returns the base class Algorithm.

Returns: the base class Algorithm

Implements SimpleKeyingInterface.

Definition at line 1098 of file cryptlib.h.

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

src/cryptopp/cryptlib.h

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation