EAX_Base Class Reference

EAX block cipher mode of operation. More...

Inheritance diagram for EAX_Base:
AuthenticatedSymmetricCipherBase AuthenticatedSymmetricCipher MessageAuthenticationCode StreamTransformation SimpleKeyingInterface HashTransformation Algorithm Algorithm Clonable Clonable EAX_Final< T_BlockCipher, T_IsEncryption >

List of all members.

Public Types

enum  IV_Requirement {
  UNIQUE_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV,
  NOT_RESYNCHRONIZABLE
}
 

Provides IV requirements as an enumerated value.

More...

Public Member Functions

std::string AlgorithmName () const
 Provides the name of this algorithm.
size_t MinKeyLength () const
 Returns smallest valid key length in bytes.
size_t MaxKeyLength () const
 Returns largest valid key length in bytes.
size_t DefaultKeyLength () const
 Returns default (recommended) key length in bytes.
size_t GetValidKeyLength (size_t n) const
bool IsValidKeyLength (size_t n) const
 Returns whether keylength is a valid key length.
unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance.
IV_Requirement IVRequirement () const
 returns the minimal requirement for secure IVs
unsigned int IVSize () const
 Returns length of the IV accepted by this object.
unsigned int MinIVLength () const
 returns minimal length of IVs accepted by this object
unsigned int MaxIVLength () const
 returns maximal length of IVs accepted by this object
unsigned int DigestSize () const
 Provides the digest size of the hash.
lword MaxHeaderLength () const
 the maximum length of AAD that can be input before the encrypted data
lword MaxMessageLength () const
 the maximum length of encrypted data
bool IsRandomAccess () const
 Determines whether the cipher supports random access.
bool IsSelfInverting () const
 Determines whether the cipher is self-inverting.
void UncheckedSetKey (const byte *, unsigned int, const CryptoPP::NameValuePairs &)
void SetKey (const byte *userKey, size_t keylength, const NameValuePairs &params)
 Sets or reset the key of this object.
void Restart ()
 Restart the hash.
void Resynchronize (const byte *iv, int length=-1)
 resynchronize with an IV. ivLength=-1 means use IVSize()
void Update (const byte *input, size_t length)
 Updates a hash with additional input.
void ProcessData (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt an array of bytes.
void TruncatedFinal (byte *mac, size_t macSize)
 Computes the hash of the current message.
virtual lword MaxFooterLength () const
 the maximum length of AAD that can be input after the encrypted data
virtual bool NeedsPrespecifiedDataLengths () const
 if this function returns true, SpecifyDataLengths() must be called before attempting to input data
void SpecifyDataLengths (lword headerLength, lword messageLength, lword footerLength=0)
 this function only needs to be called if NeedsPrespecifiedDataLengths() returns true
virtual void EncryptAndAuthenticate (byte *ciphertext, byte *mac, size_t macSize, const byte *iv, int ivLength, const byte *header, size_t headerLength, const byte *message, size_t messageLength)
 encrypt and generate MAC in one call. will truncate MAC if macSize < TagSize()
virtual bool DecryptAndVerify (byte *message, const byte *mac, size_t macLength, const byte *iv, int ivLength, const byte *header, size_t headerLength, const byte *ciphertext, size_t ciphertextLength)
 decrypt and verify MAC in one call, returning true iff MAC is valid. will assume MAC is truncated if macLength < TagSize()
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
 returns whether the object can be resynchronized (i.e. supports initialization vectors)
bool CanUseRandomIVs () const
 returns whether the object can use random IVs (in addition to ones returned by GetNextIV)
bool CanUsePredictableIVs () const
 returns whether the object can use random but possibly predictable IVs (in addition to ones returned by GetNextIV)
bool CanUseStructuredIVs () const
 returns whether the object can use structured IVs, for example a counter (in addition to ones returned by GetNextIV)
unsigned int DefaultIVLength () const
 returns default length of IVs accepted by this object
virtual void GetNextIV (RandomNumberGenerator &rng, byte *iv)
 Gets a secure IV for the next message.
HashTransformationRef ()
 Provides a reference to this object.
StreamTransformationRef ()
 Provides a reference to this object.
virtual byte * CreateUpdateSpace (size_t &size)
 Request space which can be written into by the caller.
virtual void Final (byte *digest)
 Computes the hash of the current message.
unsigned int TagSize () const
 Provides the tag size of the hash.
virtual unsigned int BlockSize () const
 Provides the block size of the compression function.
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this hash.
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this cipher.
virtual void CalculateDigest (byte *digest, const byte *input, size_t length)
 Updates the hash with additional input and computes the hash of the current message.
virtual bool Verify (const byte *digest)
 Verifies the hash of the current message.
virtual bool VerifyDigest (const byte *digest, const byte *input, size_t length)
 Updates the hash with additional input and verifies the hash of the current message.
virtual void CalculateTruncatedDigest (byte *digest, size_t digestSize, const byte *input, size_t length)
 Updates the hash with additional input and computes the hash of the current message.
virtual bool TruncatedVerify (const byte *digest, size_t digestLength)
 Verifies the hash of the current message.
virtual bool VerifyTruncatedDigest (const byte *digest, size_t digestLength, const byte *input, size_t length)
 Updates the hash with additional input and verifies the hash of the current message.
virtual ClonableClone () const
 Copies this object.
virtual unsigned int MandatoryBlockSize () const
 Provides the mandatory block size of the cipher.
virtual unsigned int GetOptimalBlockSizeUsed () const
 Provides the number of bytes used in the current block when processing at optimal block size.
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 void Seek (lword pos)
 Seek to an absolute position.
virtual bool IsForwardTransformation () const =0
 Determines if the cipher is being operated in its forward direction.

Protected Types

enum  State {
  State_Start, State_KeySet, State_IVSet, State_AuthUntransformed,
  State_AuthTransformed, State_AuthFooter
}

Protected Member Functions

void AuthenticateData (const byte *data, size_t len)
const SymmetricCipherGetSymmetricCipher () const
virtual void AuthenticateLastConfidentialBlock ()

Protected Attributes

State m_state
unsigned int m_bufferedDataLength
lword m_totalHeaderLength
lword m_totalMessageLength
lword m_totalFooterLength
AlignedSecByteBlock m_buffer

Detailed Description

EAX block cipher mode of operation.

Implementations and overrides in EAX_Base apply to both ENCRYPTION and DECRYPTION directions

Definition at line 19 of file eax.h.


Member Enumeration Documentation

Provides IV requirements as an enumerated value.

Enumerator:
UNIQUE_IV 

The IV must be unique.

RANDOM_IV 

The IV must be random.

UNPREDICTABLE_RANDOM_IV 

The IV must be unpredictable.

INTERNALLY_GENERATED_IV 

The IV is set by the object.

NOT_RESYNCHRONIZABLE 

The object does not use an IV.

Definition at line 555 of file cryptlib.h.


Member Function Documentation

std::string EAX_Base::AlgorithmName (  )  const [inline, virtual]

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

Implements AuthenticatedSymmetricCipher.

Definition at line 23 of file eax.h.

size_t EAX_Base::GetValidKeyLength ( size_t  n  )  const [inline, virtual]
Returns:
the smallest valid key length in bytes that is greater than or equal to min(n, GetMaxKeyLength())

Implements SimpleKeyingInterface.

Definition at line 31 of file eax.h.

bool EAX_Base::IsValidKeyLength ( size_t  keylength  )  const [inline, virtual]

Returns whether keylength is a valid key length.

Internally the function calls GetValidKeyLength()

Reimplemented from SimpleKeyingInterface.

Definition at line 33 of file eax.h.

unsigned int EAX_Base::OptimalDataAlignment (  )  const [inline, virtual]

Provides input and output data alignment for optimal performance.

Returns:
the input data alignment that provides optimal performance

Reimplemented from StreamTransformation.

Definition at line 35 of file eax.h.

unsigned int EAX_Base::IVSize (  )  const [inline, virtual]

Returns length of the IV accepted by this object.

The default implementation throws NotImplemented

Reimplemented from SimpleKeyingInterface.

Definition at line 39 of file eax.h.

unsigned int EAX_Base::DigestSize (  )  const [inline, virtual]

Provides the digest size of the hash.

Returns:
the digest size of the hash.

Calls to Final() require a buffer that is equal to (or greater than) DigestSize().

Implements HashTransformation.

Definition at line 45 of file eax.h.

bool AuthenticatedSymmetricCipherBase::IsRandomAccess (  )  const [inline, virtual, inherited]

Determines whether the cipher supports random access.

Returns:
true if the cipher supports random access, false otherwise

Implements StreamTransformation.

Definition at line 23 of file authenc.h.

bool AuthenticatedSymmetricCipherBase::IsSelfInverting (  )  const [inline, virtual, inherited]

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).

Implements StreamTransformation.

Definition at line 24 of file authenc.h.

void AuthenticatedSymmetricCipherBase::SetKey ( const byte *  key,
size_t  length,
const NameValuePairs params 
) [virtual, inherited]

Sets or reset the key of this object.

Parameters:
key the key to use when keying the object
length the size of the key, in bytes
params additional initialization parameters that cannot be passed directly through the constructor

Reimplemented from SimpleKeyingInterface.

Definition at line 48 of file authenc.cpp.

References AuthenticatedSymmetricCipherBase::Resynchronize().

void AuthenticatedSymmetricCipherBase::Restart (  )  [inline, virtual, inherited]

Restart the hash.

Discards the current state, and restart for a new message

Reimplemented from HashTransformation.

Definition at line 28 of file authenc.h.

void AuthenticatedSymmetricCipherBase::Update ( const byte *  input,
size_t  length 
) [virtual, inherited]

Updates a hash with additional input.

Parameters:
input the additional input as a buffer
length the size of the buffer, in bytes

Implements HashTransformation.

Definition at line 75 of file authenc.cpp.

References AuthenticatedSymmetricCipher::AlgorithmName().

void AuthenticatedSymmetricCipherBase::ProcessData ( byte *  outString,
const byte *  inString,
size_t  length 
) [virtual, inherited]

Encrypt or decrypt an array of bytes.

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

Implements StreamTransformation.

Definition at line 104 of file authenc.cpp.

References AuthenticatedSymmetricCipher::AlgorithmName(), StreamTransformation::IsForwardTransformation(), AuthenticatedSymmetricCipher::MaxMessageLength(), and StreamTransformation::ProcessData().

void AuthenticatedSymmetricCipherBase::TruncatedFinal ( byte *  digest,
size_t  digestSize 
) [virtual, inherited]

Computes the hash of the current message.

Parameters:
digest a pointer to the buffer to receive the hash
digestSize the size of the truncated digest, in bytes

TruncatedFinal() call Final() and then copies digestSize bytes to digest

TruncatedFinal() restarts the hash for the next nmessage.

Implements HashTransformation.

Definition at line 136 of file authenc.cpp.

References AuthenticatedSymmetricCipher::AlgorithmName(), IntToString(), AuthenticatedSymmetricCipher::MaxFooterLength(), and AuthenticatedSymmetricCipher::MaxHeaderLength().

virtual bool AuthenticatedSymmetricCipher::NeedsPrespecifiedDataLengths (  )  const [inline, virtual, inherited]

if this function returns true, SpecifyDataLengths() must be called before attempting to input data

This is the case for some schemes, such as CCM.

Reimplemented in CCM_Base.

Definition at line 1055 of file cryptlib.h.

void SimpleKeyingInterface::SetKeyWithRounds ( const byte *  key,
size_t  length,
int  rounds 
) [inherited]

Sets or reset the key of this object.

Parameters:
key the key to use when keying the object
length the size of the key, in bytes
rounds the number of rounds to apply the transformation function, if applicable

SetKeyWithRounds calls SetKey with an NameValuePairs object that just specifies rounds. rounds is an integer parameter, and -1 means use the default number of rounds.

Definition at line 106 of file cryptlib.cpp.

References MakeParameters(), Rounds(), and SimpleKeyingInterface::SetKey().

void SimpleKeyingInterface::SetKeyWithIV ( const byte *  key,
size_t  length,
const byte *  iv,
size_t  ivLength 
) [inherited]

Sets or reset the key of this object.

Parameters:
key the key to use when keying the object
length the size of the key, in bytes
iv the intiialization vector to use when keying the object
ivLength the size of the iv, in bytes

SetKeyWithIV calls SetKey with an NameValuePairs object that just specifies iv. iv is a byte buffer with size ivLength.

Definition at line 111 of file cryptlib.cpp.

References IV(), MakeParameters(), and SimpleKeyingInterface::SetKey().

void SimpleKeyingInterface::SetKeyWithIV ( const byte *  key,
size_t  length,
const byte *  iv 
) [inline, inherited]

Sets or reset the key of this object.

Parameters:
key the key to use when keying the object
length the size of the key, in bytes
iv the intiialization vector to use when keying the object

SetKeyWithIV calls SetKey with an NameValuePairs object that just specifies iv. iv is a byte buffer, and it must have a size IVSize.

Definition at line 551 of file cryptlib.h.

References SimpleKeyingInterface::SetKeyWithIV().

Referenced by SimpleKeyingInterface::SetKeyWithIV().

bool SimpleKeyingInterface::IsResynchronizable (  )  const [inline, inherited]

returns whether the object can be resynchronized (i.e. supports initialization vectors)

If this function returns true, and no IV is passed to SetKey() and CanUseStructuredIVs()==true, an IV of all 0's will be assumed.

Definition at line 573 of file cryptlib.h.

Referenced by BlockOrientedCipherModeBase::UncheckedSetKey().

void SimpleKeyingInterface::GetNextIV ( RandomNumberGenerator rng,
byte *  iv 
) [virtual, inherited]

Gets a secure IV for the next message.

Parameters:
rng a RandomNumberGenerator to produce keying material
iv a block of bytes to receive the IV

This method should be called after you finish encrypting one message and are ready to start the next one. After calling it, you must call SetKey() or Resynchronize() before using this object again.

key must be at least IVSize() in length.

Note:
This method is not implemented on decryption objects.

Reimplemented in VMAC_Base.

Definition at line 176 of file cryptlib.cpp.

References RandomNumberGenerator::GenerateBlock(), and SimpleKeyingInterface::IVSize().

HashTransformation& HashTransformation::Ref (  )  [inline, inherited]

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 864 of file cryptlib.h.

StreamTransformation& StreamTransformation::Ref (  )  [inline, inherited]

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 byte* HashTransformation::CreateUpdateSpace ( size_t &  size  )  [inline, virtual, inherited]

Request space which can be written into by the caller.

Parameters:
size the requested size of the buffer

The purpose of this method is to help avoid extra memory allocations.

size is an IN and OUT parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.

The base class implementation sets size to 0 and returns NULL.

Note:
Some objects, like ArraySink, cannot create a space because its fixed. In the case of

Definition at line 879 of file cryptlib.h.

virtual void HashTransformation::Final ( byte *  digest  )  [inline, virtual, inherited]

Computes the hash of the current message.

Parameters:
digest a pointer to the buffer to receive the hash

digest must be equal to (or greater than) DigestSize(). Final() restarts the hash for a new message.

Definition at line 885 of file cryptlib.h.

References DigestSize().

Referenced by PKCS5_PBKDF2_HMAC< T >::DeriveKey(), RandomPool::IncorporateEntropy(), and HMAC_Base::TruncatedFinal().

unsigned int HashTransformation::TagSize (  )  const [inline, inherited]

Provides the tag size of the hash.

Returns:
the tag size of the hash.

Same as DigestSize().

Definition at line 901 of file cryptlib.h.

References DigestSize().

virtual unsigned int HashTransformation::BlockSize (  )  const [inline, virtual, inherited]

Provides the block size of the compression function.

Returns:
the block size of the compression function, in bytes

BlockSize() will return 0 if the hash is not block based. For example, SHA3 is a recursive hash (not an iterative hash), and it does not have a block size.

Reimplemented in Weak::MD2, and VMAC_Base.

Definition at line 907 of file cryptlib.h.

Referenced by HMAC_Base::TruncatedFinal(), CBC_MAC_Base::TruncatedFinal(), and HMAC_Base::UncheckedSetKey().

virtual unsigned int HashTransformation::OptimalBlockSize (  )  const [inline, virtual, inherited]

Provides the input block size most efficient for this hash.

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 CMAC_Base, and HMAC_Base.

Definition at line 914 of file cryptlib.h.

virtual unsigned int StreamTransformation::OptimalBlockSize (  )  const [inline, virtual, inherited]

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 void HashTransformation::CalculateDigest ( byte *  digest,
const byte *  input,
size_t  length 
) [inline, virtual, inherited]

Updates the hash with additional input and computes the hash of the current message.

Parameters:
digest a pointer to the buffer to receive the hash
input the additional input as a buffer
length the size of the buffer, in bytes

Use this if your input is in one piece and you don't want to call Update() and Final() separately

CalculateDigest() restarts the hash for the next nmessage.

Definition at line 927 of file cryptlib.h.

Referenced by PKCS5_PBKDF2_HMAC< T >::DeriveKey(), and HKDF< T >::DeriveKey().

virtual bool HashTransformation::Verify ( const byte *  digest  )  [inline, virtual, inherited]

Verifies the hash of the current message.

Parameters:
digest a pointer to the buffer of an existing hash
Returns:
true if the existing hash matches the computed hash, false otherwise
Exceptions:
ThrowIfInvalidTruncatedSize() if the existing hash's size exceeds DigestSize()

Calls to Verify() require a buffer that is equal to (or greater than) DigestSize().

Verify() performs a bitwise compare on the buffers using VerifyBufsEqual(), which is a constant time comparison function. digestLength cannot exceed DigestSize().

Verify() restarts the hash for the next nmessage.

Definition at line 938 of file cryptlib.h.

References DigestSize().

virtual bool HashTransformation::VerifyDigest ( const byte *  digest,
const byte *  input,
size_t  length 
) [inline, virtual, inherited]

Updates the hash with additional input and verifies the hash of the current message.

Parameters:
digest a pointer to the buffer of an existing hash
input the additional input as a buffer
length the size of the buffer, in bytes
Returns:
true if the existing hash matches the computed hash, false otherwise
Exceptions:
ThrowIfInvalidTruncatedSize() if the existing hash's size exceeds DigestSize()

Use this if your input is in one piece and you don't want to call Update() and Verify() separately

VerifyDigest() performs a bitwise compare on the buffers using VerifyBufsEqual(), which is a constant time comparison function. digestLength cannot exceed DigestSize().

VerifyDigest() restarts the hash for the next nmessage.

Definition at line 952 of file cryptlib.h.

virtual void HashTransformation::CalculateTruncatedDigest ( byte *  digest,
size_t  digestSize,
const byte *  input,
size_t  length 
) [inline, virtual, inherited]

Updates the hash with additional input and computes the hash of the current message.

Parameters:
digest a pointer to the buffer to receive the hash
digestSize the length of the truncated hash, in bytes
input the additional input as a buffer
length the size of the buffer, in bytes

Use this if your input is in one piece and you don't want to call Update() and CalculateDigest() separately.

CalculateTruncatedDigest() restarts the hash for the next nmessage.

Definition at line 970 of file cryptlib.h.

bool HashTransformation::TruncatedVerify ( const byte *  digest,
size_t  digestLength 
) [virtual, inherited]

Verifies the hash of the current message.

Parameters:
digest a pointer to the buffer of an existing hash
digestLength the size of the truncated hash, in bytes
Returns:
true if the existing hash matches the computed hash, false otherwise
Exceptions:
ThrowIfInvalidTruncatedSize() if digestLength exceeds DigestSize()

TruncatedVerify() is a truncated version of Verify(). It can operate on a buffer smaller than DigestSize(). However, digestLength cannot exceed DigestSize().

Verify() performs a bitwise compare on the buffers using VerifyBufsEqual(), which is a constant time comparison function. digestLength cannot exceed DigestSize().

TruncatedVerify() restarts the hash for the next nmessage.

Reimplemented in NullHash, and TruncatedHashTemplate< T >.

Definition at line 411 of file cryptlib.cpp.

References HashTransformation::TruncatedFinal().

Referenced by AuthenticatedSymmetricCipher::DecryptAndVerify().

virtual bool HashTransformation::VerifyTruncatedDigest ( const byte *  digest,
size_t  digestLength,
const byte *  input,
size_t  length 
) [inline, virtual, inherited]

Updates the hash with additional input and verifies the hash of the current message.

Parameters:
digest a pointer to the buffer of an existing hash
digestLength the size of the truncated hash, in bytes
input the additional input as a buffer
length the size of the buffer, in bytes
Returns:
true if the existing hash matches the computed hash, false otherwise
Exceptions:
ThrowIfInvalidTruncatedSize() if digestLength exceeds DigestSize()

Use this if your input is in one piece and you don't want to call Update() and TruncatedVerify() separately.

VerifyTruncatedDigest() is a truncated version of VerifyDigest(). It can operate on a buffer smaller than DigestSize(). However, digestLength cannot exceed DigestSize().

VerifyTruncatedDigest() restarts the hash for the next nmessage.

Definition at line 997 of file cryptlib.h.

virtual Clonable* Clonable::Clone (  )  const [inline, virtual, inherited]

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.

virtual unsigned int StreamTransformation::MandatoryBlockSize (  )  const [inline, virtual, inherited]

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 StreamTransformation::ProcessLastBlock().

virtual unsigned int StreamTransformation::GetOptimalBlockSizeUsed (  )  const [inline, virtual, inherited]

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.

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

Encrypt or decrypt the last block of data.

Parameters:
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(), StreamTransformation::MandatoryBlockSize(), StreamTransformation::MinLastBlockSize(), and StreamTransformation::ProcessData().

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

Encrypt or decrypt a string of bytes.

Parameters:
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, inherited]

Encrypt or decrypt a string of bytes.

Parameters:
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, inherited]

Encrypt or decrypt a byte.

Parameters:
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 void StreamTransformation::Seek ( lword  pos  )  [inline, virtual, inherited]

Seek to an absolute position.

Parameters:
pos position 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.

virtual bool StreamTransformation::IsForwardTransformation (  )  const [pure virtual, inherited]

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

Generated on 24 Mar 2016 for Crypto++ by  doxygen 1.6.1