Crypto++
8.4
Free C++ class library of cryptographic schemes
|
Interface for the data processing portion of stream ciphers. More...
Public Member Functions | |
StreamTransformation & | Ref () |
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 unsigned int | OptimalDataAlignment () const |
Provides input and output data alignment for optimal performance. More... | |
virtual void | ProcessData (byte *outString, const byte *inString, size_t length)=0 |
Encrypt or decrypt an array of bytes. More... | |
virtual size_t | ProcessLastBlock (byte *outString, size_t outLength, const byte *inString, size_t inLength) |
Encrypt or decrypt the last block of data. More... | |
virtual unsigned int | MinLastBlockSize () const |
Provides the size of the last block. More... | |
virtual bool | IsLastBlockSpecial () const |
Determines if the last block receives special processing. 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... | |
![]() | |
Algorithm (bool checkSelfTestStatus=true) | |
Interface for all crypto algorithms. More... | |
virtual std::string | AlgorithmName () const |
Provides the name of this algorithm. More... | |
virtual std::string | AlgorithmProvider () const |
Retrieve the provider of this algorithm. More... | |
![]() | |
virtual Clonable * | Clone () const |
Copies this object. More... | |
Interface for the data processing portion of stream ciphers.
Definition at line 945 of file cryptlib.h.
|
inline |
Provides a reference to this object.
Definition at line 953 of file cryptlib.h.
|
inlinevirtual |
Provides the mandatory block size of the cipher.
Reimplemented in BlockOrientedCipherModeBase.
Definition at line 965 of file cryptlib.h.
|
inlinevirtual |
Provides the input block size most efficient for this cipher.
n * OptimalBlockSize() - GetOptimalBlockSizeUsed()
for any n > 0
. Reimplemented in AdditiveCipherTemplate< BASE >, and ECB_OneWay.
Definition at line 972 of file cryptlib.h.
|
inlinevirtual |
Provides the number of bytes used in the current block when processing at optimal block size.
Definition at line 976 of file cryptlib.h.
|
virtual |
Provides input and output data alignment for optimal performance.
Reimplemented in XTS_ModeBase, AdditiveCipherTemplate< BASE >, CipherModeBase, GCM_Base, EAX_Base, XChaCha20Poly1305_Base, ChaCha20Poly1305_Base, and CCM_Base.
|
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 ProcessData is called with a string of bytes whose size depends on MandatoryBlockSize. Either inString == outString , or they must not overlap. |
Implemented in XTS_ModeBase, CFB_CipherTemplate< AbstractPolicyHolder< CFB_CipherAbstractPolicy, SymmetricCipher > >, AdditiveCipherTemplate< BASE >, AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > >, CBC_Decryption, CBC_Encryption, ECB_OneWay, PublicBlumBlumShub, AuthenticatedSymmetricCipherBase, and Weak::ARC4_Base.
|
virtual |
Encrypt or decrypt the last block of data.
outString | the output byte buffer |
outLength | the size of the output byte buffer, in bytes |
inString | the input byte buffer |
inLength | the size of the input byte buffer, in bytes |
inLength+2*MandatoryBlockSize()
. The return value allows the cipher to expand cipher text during encryption or shrink plain text during decryption. This member function is used by CBC-CTS and OCB modes. Reimplemented in XTS_ModeBase, CBC_CTS_Decryption, and CBC_CTS_Encryption.
|
inlinevirtual |
Provides the size of the last block.
Reimplemented in XTS_ModeBase, CBC_CTS_Decryption, CBC_CTS_Encryption, and CBC_ModeBase.
Definition at line 1021 of file cryptlib.h.
|
inlinevirtual |
Determines if the last block receives special processing.
2*MandatoryBlockSize()
. That is, there's a reserve available when processing the last block. Fourth, the cipher is responsible for finalization like custom padding. The cipher will tell the library how many bytes were processed or used by returning the appropriate value from ProcessLastBlock(). The return value of ProcessLastBlock() indicates how many bytes were written to outString
. A filter pipelining data will send outString
and up to outLength
to an AttachedTransformation()
for additional processing. Below is an example of the code used in StreamTransformationFilter::LastPut
. if (m_cipher.IsLastBlockSpecial()) { size_t reserve = 2*m_cipher.MandatoryBlockSize(); space = HelpCreatePutSpace(*AttachedTransformation(), DEFAULT_CHANNEL, length+reserve); length = m_cipher.ProcessLastBlock(space, length+reserve, inString, length); AttachedTransformation()->Put(space, length); return; }
Definition at line 1054 of file cryptlib.h.
|
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 1060 of file cryptlib.h.
|
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 1068 of file cryptlib.h.
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 1074 of file cryptlib.h.
|
pure virtual |
Determines whether the cipher supports random access.
Implemented in AdditiveCipherTemplate< BASE >, BlockOrientedCipherModeBase, BlumBlumShub, AuthenticatedSymmetricCipherBase, and Weak::ARC4_Base.
|
inlinevirtual |
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 AdditiveCipherTemplate< BASE >, AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > >, and BlumBlumShub.
Definition at line 1086 of file cryptlib.h.
|
pure virtual |
Determines whether the cipher is self-inverting.
Implemented in AdditiveCipherTemplate< BASE >, BlockOrientedCipherModeBase, PublicBlumBlumShub, AuthenticatedSymmetricCipherBase, and Weak::ARC4_Base.
|
pure virtual |
Determines if the cipher is being operated in its forward direction.
Implemented in AdditiveCipherTemplate< BASE >, BlockOrientedCipherModeBase, GCM_Final< T_BlockCipher, T_TablesOption, T_IsEncryption >, EAX_Final< T_BlockCipher, T_IsEncryption >, CCM_Final< T_BlockCipher, T_DefaultDigestSize, T_IsEncryption >, PublicBlumBlumShub, and Weak::ARC4_Base.