Interface for the data processing portion of stream ciphers. More...
Public Member Functions | |
StreamTransformation & | Ref () |
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 unsigned int | OptimalDataAlignment () const |
Provides input and output data alignment for optimal performance. | |
virtual void | ProcessData (byte *outString, const byte *inString, size_t length)=0 |
Encrypt or decrypt an array of bytes. | |
virtual void | ProcessLastBlock (byte *outString, const byte *inString, size_t length) |
Encrypt or decrypt the last block of data. | |
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. | |
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. | |
virtual std::string | AlgorithmName () const |
Provides the name of this algorithm. | |
virtual Clonable * | Clone () const |
Copies this object. |
Interface for the data processing portion of stream ciphers.
Definition at line 752 of file cryptlib.h.
StreamTransformation& StreamTransformation::Ref | ( | ) | [inline] |
Provides a reference to this object.
Useful for passing a temporary object to a function that takes a non-const reference
Definition at line 758 of file cryptlib.h.
virtual unsigned int StreamTransformation::MandatoryBlockSize | ( | ) | const [inline, virtual] |
Provides the mandatory block size of the cipher.
Reimplemented in BlockOrientedCipherModeBase.
Definition at line 762 of file cryptlib.h.
Referenced by ProcessLastBlock().
virtual unsigned int StreamTransformation::OptimalBlockSize | ( | ) | const [inline, virtual] |
Provides the input block size most efficient for this cipher.
The base class implemnetation returns MandatoryBlockSize().
n * OptimalBlockSize() - GetOptimalBlockSizeUsed()
for any n > 0
. Reimplemented in ECB_OneWay.
Definition at line 769 of file cryptlib.h.
virtual unsigned int StreamTransformation::GetOptimalBlockSizeUsed | ( | ) | const [inline, virtual] |
Provides the number of bytes used in the current block when processing at optimal block size.
Definition at line 773 of file cryptlib.h.
unsigned int StreamTransformation::OptimalDataAlignment | ( | ) | const [virtual] |
Provides input and output data alignment for optimal performance.
Reimplemented in CCM_Base, EAX_Base, GCM_Base, and CipherModeBase.
Definition at line 237 of file cryptlib.cpp.
virtual void StreamTransformation::ProcessData | ( | byte * | outString, | |
const byte * | inString, | |||
size_t | length | |||
) | [pure virtual] |
Encrypt or decrypt an array of bytes.
outString | the output byte buffer | |
inString | the input byte buffer | |
length | the size of the input and output byte buffers, in bytes |
Either inString == outString
, or they must not overlap.
Implemented in Weak1::ARC4_Base, AuthenticatedSymmetricCipherBase, PublicBlumBlumShub, ECB_OneWay, CBC_Encryption, and CBC_Decryption.
Referenced by AuthenticatedSymmetricCipherBase::ProcessData(), and ProcessLastBlock().
void StreamTransformation::ProcessLastBlock | ( | byte * | outString, | |
const byte * | inString, | |||
size_t | length | |||
) | [virtual] |
Encrypt or decrypt the last block of data.
outString | the output byte buffer | |
inString | the input byte buffer | |
length | the size of the input and output byte buffers, in bytes ProcessLastBlock is used when the last block of data is special. Currently the only use of this function is CBC-CTS mode. |
Reimplemented in CBC_CTS_Encryption, and CBC_CTS_Decryption.
Definition at line 247 of file cryptlib.cpp.
References Algorithm::AlgorithmName(), MandatoryBlockSize(), MinLastBlockSize(), and ProcessData().
void StreamTransformation::ProcessString | ( | byte * | inoutString, | |
size_t | length | |||
) | [inline] |
Encrypt or decrypt a string of bytes.
inoutString | the string to process | |
length | the size of the inoutString, in bytes |
Internally, the base class implementation calls ProcessData().
Definition at line 801 of file cryptlib.h.
Referenced by AuthenticatedSymmetricCipher::DecryptAndVerify(), and AuthenticatedSymmetricCipher::EncryptAndAuthenticate().
void StreamTransformation::ProcessString | ( | byte * | outString, | |
const byte * | inString, | |||
size_t | length | |||
) | [inline] |
Encrypt or decrypt a string of bytes.
outString | the output string to process | |
inString | the input string to process | |
length | the size of the input and output strings, in bytes |
Internally, the base class implementation calls ProcessData().
Definition at line 809 of file cryptlib.h.
byte StreamTransformation::ProcessByte | ( | byte | input | ) | [inline] |
Encrypt or decrypt a byte.
input | the input byte to process |
Internally, the base class implementation calls ProcessData() with a size of 1.
Definition at line 815 of file cryptlib.h.
virtual bool StreamTransformation::IsRandomAccess | ( | ) | const [pure virtual] |
Determines whether the cipher supports random access.
Implemented in Weak1::ARC4_Base, AuthenticatedSymmetricCipherBase, BlumBlumShub, and BlockOrientedCipherModeBase.
virtual void StreamTransformation::Seek | ( | lword | pos | ) | [inline, virtual] |
Seek to an absolute position.
pos | position to seek |
NotImplemented |
The base class implementation throws NotImplemented. The function asserts IsRandomAccess() in debug builds.
Reimplemented in BlumBlumShub.
Definition at line 827 of file cryptlib.h.
virtual bool StreamTransformation::IsSelfInverting | ( | ) | const [pure virtual] |
Determines whether the cipher is self-inverting.
IsSelfInverting determines whether this transformation is self-inverting (e.g. xor with a keystream).
Implemented in Weak1::ARC4_Base, AuthenticatedSymmetricCipherBase, PublicBlumBlumShub, and BlockOrientedCipherModeBase.
Referenced by AuthenticatedDecryptionFilter::AuthenticatedDecryptionFilter().
virtual bool StreamTransformation::IsForwardTransformation | ( | ) | const [pure virtual] |
Determines if the cipher is being operated in its forward direction.
Implemented in Weak1::ARC4_Base, PublicBlumBlumShub, CCM_Final< T_BlockCipher, T_DefaultDigestSize, T_IsEncryption >, EAX_Final< T_BlockCipher, T_IsEncryption >, GCM_Final< T_BlockCipher, T_TablesOption, T_IsEncryption >, and BlockOrientedCipherModeBase.
Referenced by AuthenticatedDecryptionFilter::AuthenticatedDecryptionFilter(), AuthenticatedEncryptionFilter::AuthenticatedEncryptionFilter(), and AuthenticatedSymmetricCipherBase::ProcessData().
virtual std::string Algorithm::AlgorithmName | ( | ) | const [inline, virtual, inherited] |
Provides the name of this algorithm.
The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.
Reimplemented in Adler32, CCM_Base, CRC32, ClassNullRNG, AuthenticatedSymmetricCipher, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, EAX_Base, StreamTransformationFilter, HashFilter, HashVerificationFilter, AuthenticatedDecryptionFilter, SignerFilter, SignatureVerificationFilter, GCM_Base, HMAC< T >, RDRAND, RDSEED, SHA3, BitBucket, and VMAC_Base.
Definition at line 488 of file cryptlib.h.
Referenced by BufferedTransformation::ChannelCreatePutSpace(), BufferedTransformation::ChannelFlush(), BufferedTransformation::ChannelMessageSeriesEnd(), BufferedTransformation::ChannelPut2(), TF_DecryptorBase::Decrypt(), TF_EncryptorBase::Encrypt(), ProcessLastBlock(), and PK_DefaultDecryptionFilter::Put2().
virtual Clonable* Clonable::Clone | ( | ) | const [inline, virtual, inherited] |
Copies this object.
NotImplemented |
Definition at line 464 of file cryptlib.h.