Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
BlockOrientedCipherModeBase Class Reference
+ 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. More...
 
unsigned int MandatoryBlockSize () const
 Provides the mandatory block size of the cipher. More...
 
bool IsRandomAccess () const
 Determines whether the cipher supports random access. More...
 
bool IsSelfInverting () const
 Determines whether the cipher is self-inverting. More...
 
bool IsForwardTransformation () const
 Determines if the cipher is being operated in its forward direction. More...
 
void Resynchronize (const byte *iv, int length=-1)
 Resynchronize with an IV. More...
 
- Public Member Functions inherited from CipherModeBase
size_t MinKeyLength () const
 Returns smallest valid key length in bytes.
 
size_t MaxKeyLength () const
 Returns largest valid key length in bytes.
 
size_t DefaultKeyLength () const
 Returns default (recommended) key length in bytes.
 
size_t GetValidKeyLength (size_t n) const
 
bool IsValidKeyLength (size_t n) const
 Returns whether keylength is a valid key length. More...
 
unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance. More...
 
unsigned int IVSize () const
 Returns length of the IV accepted by this object. More...
 
virtual IV_Requirement IVRequirement () const =0
 Minimal requirement for secure IVs. More...
 
void SetCipher (BlockCipher &cipher)
 
void SetCipherWithIV (BlockCipher &cipher, const byte *iv, int feedbackSize=0)
 
- 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. 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...
 
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 returns whether the object can use structured IVs, for example a counter (in addition to ones returned by GetNextIV), false otherwise.
 
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 GetNextIV (RandomNumberGenerator &rng, byte *iv)
 Retrieves a secure IV for the next message. More...
 
- Public Member Functions inherited from StreamTransformation
StreamTransformationRef ()
 Provides a reference to this object. More...
 
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this cipher. More...
 
virtual unsigned int GetOptimalBlockSizeUsed () const
 Provides the number of bytes used in the current block when processing at optimal block size. More...
 
virtual void ProcessData (byte *outString, const byte *inString, size_t length)=0
 Encrypt or decrypt an array of bytes. More...
 
virtual void ProcessLastBlock (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt the last block of data. More...
 
virtual unsigned int MinLastBlockSize () const
 returns the minimum size of the last block, 0 indicating the last block is not special
 
void ProcessString (byte *inoutString, size_t length)
 Encrypt or decrypt a string of bytes. More...
 
void ProcessString (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt a string of bytes. More...
 
byte ProcessByte (byte input)
 Encrypt or decrypt a byte. More...
 
virtual void Seek (lword pos)
 Seek to an absolute position. More...
 
- Public Member Functions inherited from 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 ClonableClone () const
 Copies this object. 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...
 

Detailed Description

Definition at line 169 of file modes.h.

Member Function Documentation

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

Sets the key for this object without performing parameter validation.

Parameters
keya byte buffer used to key the cipher
lengththe length of the byte buffer
paramsadditional parameters passed as NameValuePairs

key must be at least DEFAULT_KEYLENGTH in length.

Implements SimpleKeyingInterface.

Definition at line 154 of file modes.cpp.

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

Reimplemented from StreamTransformation.

Definition at line 173 of file modes.h.

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 174 of file modes.h.

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 175 of file modes.h.

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 176 of file modes.h.

void BlockOrientedCipherModeBase::Resynchronize ( const byte *  iv,
int  ivLength = -1 
)
inlinevirtual

Resynchronize with an IV.

Parameters
ivthe initialization vector
ivLengththe 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.

Definition at line 177 of file modes.h.


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