Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
StreamTransformation Class Referenceabstract

Interface for the data processing portion of stream ciphers. More...

+ Inheritance diagram for StreamTransformation:

Public Member Functions

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 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 void ProcessLastBlock (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt the last block of data. More...
 
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. 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...
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
virtual ClonableClone () const
 Copies this object. More...
 

Detailed Description

Interface for the data processing portion of stream ciphers.

See also
StreamTransformationFilter()

Definition at line 752 of file cryptlib.h.

Member Function Documentation

StreamTransformation& StreamTransformation::Ref ( )
inline

Provides a reference to this object.

Returns
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
inlinevirtual

Provides the mandatory block size of the cipher.

Returns
The block size of the cipher if input must be processed in blocks, 1 otherwise

Reimplemented in BlockOrientedCipherModeBase.

Definition at line 762 of file cryptlib.h.

Referenced by ArrayXorSink::Put2().

virtual unsigned int StreamTransformation::OptimalBlockSize ( ) const
inlinevirtual

Provides the input block size most efficient for this cipher.

Returns
The input block size that is most efficient for the cipher

The base class implemnetation returns MandatoryBlockSize().

Note
Optimal input length is 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
inlinevirtual

Provides the number of bytes used in the current block when processing at optimal block size.

Returns
the number of bytes used in the current block when processing at the 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.

Returns
the input data alignment that provides optimal performance

Reimplemented in CipherModeBase, GCM_Base, EAX_Base, and CCM_Base.

Definition at line 237 of file cryptlib.cpp.

Referenced by GCM_Base::IsValidKeyLength().

virtual void StreamTransformation::ProcessData ( byte *  outString,
const byte *  inString,
size_t  length 
)
pure virtual

Encrypt or decrypt an array of bytes.

Parameters
outStringthe output byte buffer
inStringthe input byte buffer
lengththe size of the input and output byte buffers, in bytes

Either inString == outString, or they must not overlap.

Implemented in CBC_Decryption, CBC_Encryption, ECB_OneWay, Weak::ARC4_Base, AuthenticatedSymmetricCipherBase, and PublicBlumBlumShub.

Referenced by AuthenticatedSymmetricCipherBase::ProcessData().

void StreamTransformation::ProcessLastBlock ( byte *  outString,
const byte *  inString,
size_t  length 
)
virtual

Encrypt or decrypt the last block of data.

Parameters
outStringthe output byte buffer
inStringthe input byte buffer
lengththe 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_Decryption, and CBC_CTS_Encryption.

Definition at line 247 of file cryptlib.cpp.

void StreamTransformation::ProcessString ( byte *  inoutString,
size_t  length 
)
inline

Encrypt or decrypt a string of bytes.

Parameters
inoutStringthe string to process
lengththe size of the inoutString, in bytes

Internally, the base class implementation calls ProcessData().

Definition at line 801 of file cryptlib.h.

Referenced by TestDataNameValuePairs::GetVoidValue().

void StreamTransformation::ProcessString ( byte *  outString,
const byte *  inString,
size_t  length 
)
inline

Encrypt or decrypt a string of bytes.

Parameters
outStringthe output string to process
inStringthe input string to process
lengththe 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.

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

Returns
true if the cipher supports random access, false otherwise

Implemented in BlockOrientedCipherModeBase, BlumBlumShub, Weak::ARC4_Base, and AuthenticatedSymmetricCipherBase.

virtual void StreamTransformation::Seek ( lword  pos)
inlinevirtual

Seek to an absolute position.

Parameters
posposition to seek
Exceptions
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.

Referenced by TestDataNameValuePairs::GetVoidValue().

virtual bool StreamTransformation::IsSelfInverting ( ) const
pure virtual

Determines whether the cipher is self-inverting.

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

IsSelfInverting determines whether this transformation is self-inverting (e.g. xor with a keystream).

Implemented in BlockOrientedCipherModeBase, Weak::ARC4_Base, PublicBlumBlumShub, and AuthenticatedSymmetricCipherBase.

Referenced by AuthenticatedDecryptionFilter::AuthenticatedDecryptionFilter().

virtual bool StreamTransformation::IsForwardTransformation ( ) const
pure virtual
virtual std::string Algorithm::AlgorithmName ( ) const
inlinevirtualinherited

Provides the name of this algorithm.

Returns
the standard algorithm name

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.

Note
AlgorithmName is not universally implemented yet

Reimplemented in AuthenticatedSymmetricCipher, SignatureVerificationFilter, SignerFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, HashFilter, StreamTransformationFilter, ClassNullRNG, BitBucket, RDSEED, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, HMAC< T >, RDRAND, CRC32, GCM_Base, Adler32, EAX_Base, CCM_Base, SHA3, and VMAC_Base.

Definition at line 488 of file cryptlib.h.

Referenced by VariableRounds< 6, 2 >::StaticGetDefaultRounds().

virtual Clonable* Clonable::Clone ( ) const
inlinevirtualinherited

Copies this object.

Returns
a copy of this object
Exceptions
NotImplemented
Note
this is not implemented by most classes
See also
NotCopyable

Definition at line 464 of file cryptlib.h.


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