Fabcoin Core  0.16.2
P2P Digital Currency
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CipherModeBase Class Referenceabstract

Block cipher mode of operation information. More...

#include <modes.h>

Inheritance diagram for CipherModeBase:
[legend]
Collaboration diagram for CipherModeBase:
[legend]

Public Member Functions

virtual ~CipherModeBase ()
 
size_t MinKeyLength () const
 Returns smallest valid key length. More...
 
size_t MaxKeyLength () const
 Returns largest valid key length. More...
 
size_t DefaultKeyLength () const
 Returns default key length. More...
 
size_t GetValidKeyLength (size_t n) const
 Returns a valid key length for the algorithm. More...
 
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 ~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. 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 StreamTransformation
virtual ~StreamTransformation ()
 
StreamTransformationRef ()
 Provides a reference to this object. More...
 
virtual unsigned int MandatoryBlockSize () const
 Provides the mandatory block size of the cipher. 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
 Provides the size of the last block. More...
 
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 bool IsRandomAccess () const =0
 Determines whether the cipher supports random access. More...
 
virtual void Seek (lword pos)
 Seek to an absolute position. More...
 
virtual bool IsSelfInverting () const =0
 Determines whether the cipher is self-inverting. More...
 
virtual bool IsForwardTransformation () const =0
 Determines if the cipher is being operated in its forward direction. 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 ClonableClone () const
 Copies this object. More...
 

Protected Member Functions

 CipherModeBase ()
 
unsigned int BlockSize () const
 
virtual void SetFeedbackSize (unsigned int feedbackSize)
 
virtual void ResizeBuffers ()
 
- Protected Member Functions inherited from SymmetricCipher
const AlgorithmGetAlgorithm () 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 byteGetIVAndThrowIfInvalid (const NameValuePairs &params, size_t &size)
 Retrieves and validates the IV. More...
 
void AssertValidKeyLength (size_t length) const
 Validates the key length. More...
 

Protected Attributes

BlockCipherm_cipher
 
AlignedSecByteBlock m_register
 

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

Definition at line 43 of file modes.h.

Constructor & Destructor Documentation

virtual CipherModeBase::~CipherModeBase ( )
inlinevirtual

Definition at line 46 of file modes.h.

CipherModeBase::CipherModeBase ( )
inlineprotected

Definition at line 76 of file modes.h.

Member Function Documentation

unsigned int CipherModeBase::BlockSize ( ) const
inlineprotected

Definition at line 77 of file modes.h.

Here is the caller graph for this function:

size_t CipherModeBase::DefaultKeyLength ( ) const
inlinevirtual

Returns default key length.

Returns
the default (recommended) key length, in bytes

Implements SimpleKeyingInterface.

Definition at line 49 of file modes.h.

size_t CipherModeBase::GetValidKeyLength ( size_t  keylength) const
inlinevirtual

Returns a valid key length for the algorithm.

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

Implements SimpleKeyingInterface.

Definition at line 50 of file modes.h.

bool CipherModeBase::IsValidKeyLength ( size_t  keylength) const
inlinevirtual

Returns whether keylength is a valid key length.

Parameters
keylengththe requested keylength
Returns
true if keylength is valid, false otherwise

Internally the function calls GetValidKeyLength()

Reimplemented from SimpleKeyingInterface.

Definition at line 51 of file modes.h.

virtual IV_Requirement CipherModeBase::IVRequirement ( ) const
pure virtual

Minimal requirement for secure IVs.

Returns
the secure IV requirement of the algorithm

Implements SimpleKeyingInterface.

Implemented in CBC_ModeBase, ECB_OneWay, CTR_ModePolicy, OFB_ModePolicy, and CFB_ModePolicy.

unsigned int CipherModeBase::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

Reimplemented from SimpleKeyingInterface.

Definition at line 55 of file modes.h.

Here is the call graph for this function:

size_t CipherModeBase::MaxKeyLength ( ) const
inlinevirtual

Returns largest valid key length.

Returns
the maximum key length, in bytes

Implements SimpleKeyingInterface.

Definition at line 48 of file modes.h.

size_t CipherModeBase::MinKeyLength ( ) const
inlinevirtual

Returns smallest valid key length.

Returns
the minimum key length, in bytes

Implements SimpleKeyingInterface.

Definition at line 47 of file modes.h.

unsigned int CipherModeBase::OptimalDataAlignment ( ) const
inlinevirtual

Provides input and output data alignment for optimal performance.

Returns
the input data alignment that provides optimal performance

Reimplemented from StreamTransformation.

Reimplemented in AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > >.

Definition at line 53 of file modes.h.

void CipherModeBase::ResizeBuffers ( )
protectedvirtual

Reimplemented in CBC_Decryption, BlockOrientedCipherModeBase, and CFB_ModePolicy.

Definition at line 28 of file modes.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void CipherModeBase::SetCipher ( BlockCipher cipher)
inline

Definition at line 58 of file modes.h.

Here is the call graph for this function:

void CipherModeBase::SetCipherWithIV ( BlockCipher cipher,
const byte iv,
int  feedbackSize = 0 
)
inline

Definition at line 65 of file modes.h.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void CipherModeBase::SetFeedbackSize ( unsigned int  feedbackSize)
inlineprotectedvirtual

Reimplemented in CFB_ModePolicy.

Definition at line 78 of file modes.h.

Member Data Documentation

BlockCipher* CipherModeBase::m_cipher
protected

Definition at line 86 of file modes.h.

AlignedSecByteBlock CipherModeBase::m_register
protected

Definition at line 87 of file modes.h.


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