Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Types | Public Member Functions | List of all members
AuthenticatedSymmetricCipherBase Class Referenceabstract
+ Inheritance diagram for AuthenticatedSymmetricCipherBase:

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

bool IsRandomAccess () const
 Determines whether the cipher supports random access. More...
 
bool IsSelfInverting () const
 Determines whether the cipher is self-inverting. More...
 
void UncheckedSetKey (const byte *, unsigned int, const ::NameValuePairs &)
 
void SetKey (const byte *userKey, size_t keylength, const NameValuePairs &params)
 Sets or reset the key of this object. More...
 
void Restart ()
 Restart the hash. More...
 
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. More...
 
void ProcessData (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt an array of bytes. More...
 
void TruncatedFinal (byte *mac, size_t macSize)
 Computes the hash of the current message. More...
 
virtual lword MaxHeaderLength () const =0
 the maximum length of AAD that can be input before the encrypted data
 
virtual lword MaxMessageLength () const =0
 the maximum length of encrypted data
 
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 More...
 
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()
 
virtual std::string AlgorithmName () const =0
 Provides the name of this algorithm. More...
 
virtual size_t MinKeyLength () const =0
 Returns smallest valid key length in bytes.
 
virtual size_t MaxKeyLength () const =0
 Returns largest valid key length in bytes.
 
virtual size_t DefaultKeyLength () const =0
 Returns default (recommended) key length in bytes.
 
virtual size_t GetValidKeyLength (size_t n) const =0
 
virtual bool IsValidKeyLength (size_t keylength) const
 Returns whether keylength is a valid key length. More...
 
void SetKeyWithRounds (const byte *key, size_t length, int rounds)
 Sets or reset the key of this object. More...
 
void SetKeyWithIV (const byte *key, size_t length, const byte *iv, size_t ivLength)
 Sets or reset the key of this object. More...
 
void SetKeyWithIV (const byte *key, size_t length, const byte *iv)
 Sets or reset the key of this object. More...
 
virtual IV_Requirement IVRequirement () const =0
 returns the minimal requirement for secure IVs
 
bool IsResynchronizable () const
 returns whether the object can be resynchronized (i.e. supports initialization vectors) More...
 
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)
 
virtual unsigned int IVSize () const
 Returns length of the IV accepted by this object. More...
 
unsigned int DefaultIVLength () const
 returns default length of IVs accepted by this object
 
virtual unsigned int MinIVLength () const
 returns minimal length of IVs accepted by this object
 
virtual unsigned int MaxIVLength () const
 returns maximal length of IVs accepted by this object
 
virtual void GetNextIV (RandomNumberGenerator &rng, byte *iv)
 Gets a secure IV for the next message. More...
 
HashTransformationRef ()
 Provides a reference to this object. More...
 
StreamTransformationRef ()
 Provides a reference to this object. More...
 
virtual byte * CreateUpdateSpace (size_t &size)
 Request space which can be written into by the caller. More...
 
virtual void Final (byte *digest)
 Computes the hash of the current message. More...
 
virtual unsigned int DigestSize () const =0
 Provides the digest size of the hash. More...
 
unsigned int TagSize () const
 Provides the tag size of the hash. More...
 
virtual unsigned int BlockSize () const
 Provides the block size of the compression function. More...
 
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this hash. More...
 
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this cipher. More...
 
virtual unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance. More...
 
virtual unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance. More...
 
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. More...
 
virtual bool Verify (const byte *digest)
 Verifies the hash of the current message. More...
 
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. More...
 
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. More...
 
virtual bool TruncatedVerify (const byte *digest, size_t digestLength)
 Verifies the hash of the current message. More...
 
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. More...
 
virtual ClonableClone () const
 Copies this object. More...
 
virtual unsigned int MandatoryBlockSize () const
 Provides the mandatory block size of the 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 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 void Seek (lword pos)
 Seek to an absolute position. More...
 
virtual bool IsForwardTransformation () const =0
 Determines if the cipher is being operated in its forward direction. More...
 

Detailed Description

Definition at line 17 of file authenc.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

bool AuthenticatedSymmetricCipherBase::IsRandomAccess ( ) const
inlinevirtual

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
inlinevirtual

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

Sets or reset the key of this object.

Parameters
keythe key to use when keying the object
lengththe size of the key, in bytes
paramsadditional initialization parameters that cannot be passed directly through the constructor

Reimplemented from SimpleKeyingInterface.

Definition at line 48 of file authenc.cpp.

References Resynchronize().

void AuthenticatedSymmetricCipherBase::Restart ( )
inlinevirtual

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

Updates a hash with additional input.

Parameters
inputthe additional input as a buffer
lengththe 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

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.

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

Computes the hash of the current message.

Parameters
digesta pointer to the buffer to receive the hash
digestSizethe 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
inlinevirtualinherited

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.

Referenced by TestDataNameValuePairs::GetVoidValue().

virtual std::string AuthenticatedSymmetricCipher::AlgorithmName ( ) const
pure virtualinherited

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 from Algorithm.

Implemented in GCM_Base, EAX_Base, and CCM_Base.

Referenced by ProcessData(), Resynchronize(), TruncatedFinal(), and Update().

virtual size_t SimpleKeyingInterface::GetValidKeyLength ( size_t  n) const
pure virtualinherited
virtual bool SimpleKeyingInterface::IsValidKeyLength ( size_t  keylength) const
inlinevirtualinherited

Returns whether keylength is a valid key length.

Internally the function calls GetValidKeyLength()

Reimplemented in CipherModeBase, GCM_Base, EAX_Base, and CCM_Base.

Definition at line 515 of file cryptlib.h.

References g_nullNameValuePairs.

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

Sets or reset the key of this object.

Parameters
keythe key to use when keying the object
lengththe size of the key, in bytes
roundsthe 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(), and Name::Rounds().

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
keythe key to use when keying the object
lengththe size of the key, in bytes
ivthe intiialization vector to use when keying the object
ivLengththe 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 NameValuePairs::GetValue(), IntToString(), Name::IV(), and MakeParameters().

void SimpleKeyingInterface::SetKeyWithIV ( const byte *  key,
size_t  length,
const byte *  iv 
)
inlineinherited

Sets or reset the key of this object.

Parameters
keythe key to use when keying the object
lengththe size of the key, in bytes
ivthe 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.

bool SimpleKeyingInterface::IsResynchronizable ( ) const
inlineinherited

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 CipherModeBase::IVSize(), and BlockOrientedCipherModeBase::UncheckedSetKey().

virtual unsigned int SimpleKeyingInterface::IVSize ( ) const
inlinevirtualinherited
void SimpleKeyingInterface::GetNextIV ( RandomNumberGenerator rng,
byte *  iv 
)
virtualinherited

Gets a secure IV for the next message.

Parameters
rnga RandomNumberGenerator to produce keying material
iva 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().

Referenced by VMAC_Base::GetNextIV(), and FilterTester::Put2().

HashTransformation& HashTransformation::Ref ( )
inlineinherited

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 ( )
inlineinherited

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

Request space which can be written into by the caller.

Parameters
sizethe 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)
inlinevirtualinherited

Computes the hash of the current message.

Parameters
digesta 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 Name::DigestSize().

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

virtual unsigned int HashTransformation::DigestSize ( ) const
pure virtualinherited

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

Implemented in PK_MessageAccumulator, IteratedHashWithStaticTransform< T_HashWordType, T_Endianness, T_BlockSize, T_StateSize, T_Transform, T_DigestSize, T_StateAligned >, IteratedHashWithStaticTransform< word32, LittleEndian, 64, 32, RIPEMD256 >, IteratedHashWithStaticTransform< word32, LittleEndian, 64, 16, MD5 >, IteratedHashWithStaticTransform< word32, LittleEndian, 64, 16, MD4 >, IteratedHashWithStaticTransform< word32, LittleEndian, 64, 40, RIPEMD320 >, IteratedHashWithStaticTransform< word32, BigEndian, 64, 20, SHA1 >, IteratedHashWithStaticTransform< word32, LittleEndian, 64, 16, RIPEMD128 >, IteratedHashWithStaticTransform< word32, BigEndian, 64, 32, SHA224, 28, true >, IteratedHashWithStaticTransform< word32, BigEndian, 64, 32, SHA256, 32, true >, IteratedHashWithStaticTransform< word32, LittleEndian, 64, 20, RIPEMD160 >, IteratedHashWithStaticTransform< word64, LittleEndian, 64, 24, Tiger >, IteratedHashWithStaticTransform< word64, BigEndian, 128, 64, SHA384, 48,(0|0)>, IteratedHashWithStaticTransform< word64, BigEndian, 64, 64, Whirlpool >, IteratedHashWithStaticTransform< word64, BigEndian, 128, 64, SHA512, 64,(0|0)>, GCM_Base, EAX_Base, CCM_Base, Weak::PanamaHash< B >, TruncatedHashTemplate< T >, CRC32, DMAC_Base< T >, HMAC_Base, CBC_MAC_Base, CMAC_Base, VMAC_Base, Adler32, SHA3, TTMAC_Base, Weak::MD2, and NullHash.

Referenced by TestDataNameValuePairs::GetVoidValue(), TF_VerifierBase::InputSignature(), IntegrityCheckModule(), OAEP_Base::MaxUnpaddedLength(), PKCS_EncryptionPaddingScheme::MaxUnpaddedLength(), TF_VerifierBase::RecoverAndRestart(), TF_SignerBase::SignAndRestart(), HMAC_Base::TruncatedFinal(), HMAC_Base::UncheckedSetKey(), DL_GroupParameters_DSA::ValidateGroup(), and TF_VerifierBase::VerifyAndRestart().

unsigned int HashTransformation::TagSize ( ) const
inlineinherited

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 Name::DigestSize().

virtual unsigned int HashTransformation::BlockSize ( ) const
inlinevirtualinherited

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 VMAC_Base, and Weak::MD2.

Definition at line 907 of file cryptlib.h.

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

virtual unsigned int HashTransformation::OptimalBlockSize ( ) const
inlinevirtualinherited

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
inlinevirtualinherited

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.

unsigned int HashTransformation::OptimalDataAlignment ( ) const
virtualinherited

Provides input and output data alignment for optimal performance.

Returns
the input data alignment that provides optimal performance

Reimplemented in GCM_Base, EAX_Base, CCM_Base, VMAC_Base, CMAC_Base, and SHA3.

Definition at line 242 of file cryptlib.cpp.

unsigned int StreamTransformation::OptimalDataAlignment ( ) const
virtualinherited

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 HashTransformation::CalculateDigest ( byte *  digest,
const byte *  input,
size_t  length 
)
inlinevirtualinherited

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

Parameters
digesta pointer to the buffer to receive the hash
inputthe additional input as a buffer
lengththe 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 HKDF< T >::DeriveKey(), PKCS5_PBKDF2_HMAC< T >::DeriveKey(), and OAEP_Base::MaxUnpaddedLength().

virtual bool HashTransformation::Verify ( const byte *  digest)
inlinevirtualinherited

Verifies the hash of the current message.

Parameters
digesta 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 Name::DigestSize().

Referenced by Gunzip::Gunzip(), and ZlibDecompressor::ZlibDecompressor().

virtual bool HashTransformation::VerifyDigest ( const byte *  digest,
const byte *  input,
size_t  length 
)
inlinevirtualinherited

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

Parameters
digesta pointer to the buffer of an existing hash
inputthe additional input as a buffer
lengththe 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.

Referenced by OAEP_Base::MaxUnpaddedLength().

virtual void HashTransformation::CalculateTruncatedDigest ( byte *  digest,
size_t  digestSize,
const byte *  input,
size_t  length 
)
inlinevirtualinherited

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

Parameters
digesta pointer to the buffer to receive the hash
digestSizethe length of the truncated hash, in bytes
inputthe additional input as a buffer
lengththe 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 
)
virtualinherited

Verifies the hash of the current message.

Parameters
digesta pointer to the buffer of an existing hash
digestLengththe 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 TruncatedHashTemplate< T >, and NullHash.

Definition at line 411 of file cryptlib.cpp.

References Name::DigestSize(), IntToString(), and VerifyBufsEqual().

virtual bool HashTransformation::VerifyTruncatedDigest ( const byte *  digest,
size_t  digestLength,
const byte *  input,
size_t  length 
)
inlinevirtualinherited

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

Parameters
digesta pointer to the buffer of an existing hash
digestLengththe size of the truncated hash, in bytes
inputthe additional input as a buffer
lengththe 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
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.

virtual unsigned int StreamTransformation::MandatoryBlockSize ( ) const
inlinevirtualinherited

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::GetOptimalBlockSizeUsed ( ) const
inlinevirtualinherited

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

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

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

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

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 void StreamTransformation::Seek ( lword  pos)
inlinevirtualinherited

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::IsForwardTransformation ( ) const
pure virtualinherited

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