Security Scol plugin
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CFB_ModePolicy Class Reference

CFB block cipher mode of operation. More...

#include <modes.h>

Inheritance diagram for CFB_ModePolicy:
ModePolicyCommonTemplate< CFB_CipherAbstractPolicy > CipherModeBase CFB_CipherAbstractPolicy SymmetricCipher SimpleKeyingInterface StreamTransformation Algorithm Clonable

Public Member Functions

CRYPTOPP_STATIC_CONSTEXPR const char *CRYPTOPP_API StaticAlgorithmName ()
 
IV_Requirement IVRequirement () const
 Minimal requirement for secure IVs.
 
- 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.
 
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 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.
 
- Public Member Functions inherited from StreamTransformation
StreamTransformationRef ()
 Provides a reference to this object.
 
virtual unsigned int MandatoryBlockSize () const
 Provides the mandatory block size of the cipher.
 
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 bool IsRandomAccess () const =0
 Determines whether the cipher supports random access.
 
virtual void Seek (lword pos)
 Seek to an absolute position.
 
virtual bool IsSelfInverting () const =0
 Determines whether the cipher is self-inverting.
 
virtual bool IsForwardTransformation () const =0
 Determines if the cipher is being operated in its forward direction.
 
- 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 ClonableClone () const
 Copies this object.
 
- Public Member Functions inherited from CFB_CipherAbstractPolicy
virtual std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm.
 

Protected Member Functions

unsigned int GetBytesPerIteration () const
 Provides number of bytes operated upon during an iteration.
 
bool CanIterate () const
 Flag indicating iteration support.
 
void Iterate (byte *output, const byte *input, CipherDir dir, size_t iterationCount)
 Iterate the cipher.
 
void TransformRegister ()
 TODO.
 
void CipherResynchronize (const byte *iv, size_t length)
 Resynchronize the cipher.
 
void SetFeedbackSize (unsigned int feedbackSize)
 
void ResizeBuffers ()
 
byteGetRegisterBegin ()
 Access the feedback register.
 
- Protected Member Functions inherited from CipherModeBase
unsigned int BlockSize () const
 
- Protected Member Functions inherited from SymmetricCipher
const AlgorithmGetAlgorithm () const
 Returns the base class Algorithm.
 
- 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.
 
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 byteGetIVAndThrowIfInvalid (const NameValuePairs &params, size_t &size)
 Retrieves and validates the IV.
 
void AssertValidKeyLength (size_t length) const
 Validates the key length.
 

Protected Attributes

SecByteBlock m_temp
 
unsigned int m_feedbackSize
 
- Protected Attributes inherited from CipherModeBase
BlockCipherm_cipher
 
SecByteBlock 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

CFB block cipher mode of operation.

Definition at line 165 of file modes.h.

Constructor & Destructor Documentation

◆ ~CFB_ModePolicy()

virtual CFB_ModePolicy::~CFB_ModePolicy ( )
inlinevirtual

Definition at line 170 of file modes.h.

◆ CFB_ModePolicy()

CFB_ModePolicy::CFB_ModePolicy ( )
inline

Definition at line 171 of file modes.h.

Member Function Documentation

◆ CanIterate()

bool CFB_ModePolicy::CanIterate ( ) const
inlineprotectedvirtual

Flag indicating iteration support.

Returns
true if the cipher supports iteration, false otherwise

Reimplemented from CFB_CipherAbstractPolicy.

Definition at line 176 of file modes.h.

◆ CipherResynchronize()

void CFB_ModePolicy::CipherResynchronize ( const byte iv,
size_t  length 
)
protectedvirtual

Resynchronize the cipher.

Parameters
iva byte array used to resynchronize the cipher
lengththe size of the IV array

Reimplemented from CFB_CipherAbstractPolicy.

Definition at line 72 of file modes.cpp.

◆ GetBytesPerIteration()

unsigned int CFB_ModePolicy::GetBytesPerIteration ( ) const
inlineprotectedvirtual

Provides number of bytes operated upon during an iteration.

Returns
bytes operated upon during an iteration, in bytes
See also
GetOptimalBlockSize()

Implements CFB_CipherAbstractPolicy.

Definition at line 175 of file modes.h.

◆ GetRegisterBegin()

byte * CFB_ModePolicy::GetRegisterBegin ( )
protectedvirtual

Access the feedback register.

Returns
pointer to the first byte of the feedback register

Implements CFB_CipherAbstractPolicy.

Definition at line 94 of file modes.cpp.

◆ Iterate()

void CFB_ModePolicy::Iterate ( byte output,
const byte input,
CipherDir  dir,
size_t  iterationCount 
)
protectedvirtual

Iterate the cipher.

Parameters
outputthe output buffer
inputthe input buffer
dirthe direction of the cipher
iterationCountthe number of iterations to perform on the input
See also
IsSelfInverting() and IsForwardTransformation()

Reimplemented from CFB_CipherAbstractPolicy.

Definition at line 33 of file modes.cpp.

◆ IVRequirement()

IV_Requirement CFB_ModePolicy::IVRequirement ( ) const
inlinevirtual

Minimal requirement for secure IVs.

Returns
the secure IV requirement of the algorithm

Implements CipherModeBase.

Definition at line 172 of file modes.h.

◆ ResizeBuffers()

void CFB_ModePolicy::ResizeBuffers ( )
protectedvirtual

Reimplemented from CipherModeBase.

Definition at line 88 of file modes.cpp.

◆ SetFeedbackSize()

void CFB_ModePolicy::SetFeedbackSize ( unsigned int  feedbackSize)
protectedvirtual

Reimplemented from CipherModeBase.

Definition at line 81 of file modes.cpp.

◆ StaticAlgorithmName()

CRYPTOPP_STATIC_CONSTEXPR const char *CRYPTOPP_API CFB_ModePolicy::StaticAlgorithmName ( )
inline

Definition at line 168 of file modes.h.

◆ TransformRegister()

void CFB_ModePolicy::TransformRegister ( )
protectedvirtual

TODO.

Implements CFB_CipherAbstractPolicy.

Definition at line 60 of file modes.cpp.

Member Data Documentation

◆ m_feedbackSize

unsigned int CFB_ModePolicy::m_feedbackSize
protected

Definition at line 185 of file modes.h.

◆ m_temp

SecByteBlock CFB_ModePolicy::m_temp
protected

Definition at line 184 of file modes.h.


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