Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
Weak::PanamaHash< B > Class Template Reference

Panama Hash More...

+ Inheritance diagram for Weak::PanamaHash< B >:

Public Types

typedef NativeByteOrder ByteOrderClass
 
typedef word32 HashWordType
 

Public Member Functions

unsigned int DigestSize () const
 Provides the digest size of the hash. More...
 
void TruncatedFinal (byte *hash, size_t size)
 Computes the hash of the current message. More...
 
std::string AlgorithmName () const
 
unsigned int BlockSize () const
 
ByteOrder GetByteOrder () const
 
unsigned int OptimalBlockSize () const
 
unsigned int OptimalDataAlignment () const
 
void Update (const byte *input, size_t length)
 
byte * CreateUpdateSpace (size_t &size)
 
void Restart ()
 
HashTransformationRef ()
 Provides a reference to this object. More...
 
virtual void Final (byte *digest)
 Computes the hash of the current message. More...
 
unsigned int TagSize () const
 Provides the tag size of the hash. 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...
 

Static Public Member Functions

static const char * StaticAlgorithmName ()
 
static void CorrectEndianess (HashWordType *out, const HashWordType *in, size_t byteCount)
 

Static Public Attributes

static const int DIGESTSIZE = 32
 
static const int BLOCKSIZE
 

Private Member Functions

void Reset ()
 
void Iterate (size_t count, const word32 *p=NULL, byte *output=NULL, const byte *input=NULL, KeystreamOperation operation=WRITE_KEYSTREAM)
 

Detailed Description

template<class B = LittleEndian>
class Weak::PanamaHash< B >

Panama Hash

Definition at line 37 of file panama.h.

Member Function Documentation

template<class B = LittleEndian>
unsigned int Weak::PanamaHash< B >::DigestSize ( ) const
inlinevirtual

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 42 of file panama.h.

References Weak::PanamaHash< B >::TruncatedFinal().

template<class B >
void Weak::PanamaHash< B >::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 431 of file panama.cpp.

References SecBlock< T, A >::BytePtr().

Referenced by Weak::PanamaHash< B >::DigestSize().

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.

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

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


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