Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Types | Public Member Functions | List of all members
CFB_CipherTemplate< BASE > Class Template Referenceabstract

Base class for feedback based stream ciphers with SymmetricCipher interface. More...

+ Inheritance diagram for CFB_CipherTemplate< BASE >:

Public Types

typedef BASE::PolicyInterface PolicyInterface
 

Public Member Functions

void ProcessData (byte *outString, const byte *inString, size_t length)
 Apply keystream to data. More...
 
void Resynchronize (const byte *iv, int length=-1)
 Resynchronize the cipher. More...
 
unsigned int OptimalBlockSize () const
 Provides number of ideal bytes to process. More...
 
unsigned int GetOptimalNextBlockSize () const
 Provides number of ideal bytes to process. More...
 
unsigned int OptimalDataAlignment () const
 Provides number of ideal data alignment. More...
 
bool IsRandomAccess () const
 Flag indicating random access. More...
 
bool IsSelfInverting () const
 Determines if the cipher is self inverting. More...
 

Detailed Description

template<class BASE>
class CFB_CipherTemplate< BASE >

Base class for feedback based stream ciphers with SymmetricCipher interface.

Template Parameters
BASEAbstractPolicyHolder base class

Definition at line 487 of file strciphr.h.

Member Function Documentation

template<class BASE >
void CFB_CipherTemplate< BASE >::ProcessData ( byte *  outString,
const byte *  inString,
size_t  length 
)

Apply keystream to data.

Parameters
outStringa buffer to write the transformed data
inStringa buffer to read the data
lengththe size fo the buffers, in bytes

This is the primary method to operate a stream cipher. For example:

    size_t size = 30;
    byte plain[size] = "Do or do not; there is no try";
    byte cipher[size];
    ...
    ChaCha20 chacha(key, keySize);
    chacha.ProcessData(cipher, plain, size);

Definition at line 177 of file strciphr.cpp.

template<class BASE >
void CFB_CipherTemplate< BASE >::Resynchronize ( const byte *  iv,
int  length = -1 
)

Resynchronize the cipher.

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

Definition at line 169 of file strciphr.cpp.

template<class BASE >
unsigned int CFB_CipherTemplate< BASE >::OptimalBlockSize ( ) const
inline

Provides number of ideal bytes to process.

Returns
the ideal number of bytes to process

Internally, the default implementation returns GetBytesPerIteration()

See also
GetBytesPerIteration() and GetOptimalNextBlockSize()

Definition at line 514 of file strciphr.h.

template<class BASE >
unsigned int CFB_CipherTemplate< BASE >::GetOptimalNextBlockSize ( ) const
inline

Provides number of ideal bytes to process.

Returns
the ideal number of bytes to process

Internally, the default implementation returns remaining unprocessed bytes

See also
GetBytesPerIteration() and OptimalBlockSize()

Definition at line 520 of file strciphr.h.

template<class BASE >
unsigned int CFB_CipherTemplate< BASE >::OptimalDataAlignment ( ) const
inline

Provides number of ideal data alignment.

Returns
the ideal data alignment, in bytes
See also
GetAlignment() and OptimalBlockSize()

Definition at line 525 of file strciphr.h.

template<class BASE >
bool CFB_CipherTemplate< BASE >::IsRandomAccess ( ) const
inline

Flag indicating random access.

Returns
true if the cipher is seekable, false otherwise
See also
Seek()

Definition at line 530 of file strciphr.h.

template<class BASE >
bool CFB_CipherTemplate< BASE >::IsSelfInverting ( ) const
inline

Determines if the cipher is self inverting.

Returns
true if the stream cipher is self inverting, false otherwise

Definition at line 534 of file strciphr.h.


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