IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base > Class Template Reference

Iterated hash base class. More...

#include <iterhash.h>

Inheritance diagram for IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >:

Public Types
typedef T_Endianness	ByteOrderClass
typedef T_HashWordType	HashWordType
Public Types inherited from IteratedHashBase< T, BASE >
typedef T	HashWordType

Public Member Functions
unsigned int	BlockSize () const
	Provides the block size of the hash.
ByteOrder	GetByteOrder () const
	Provides the byte order of the hash.
void	CorrectEndianess (HashWordType *out, const HashWordType *in, size_t byteCount)
	Adjusts the byte ordering of the hash.
Public Member Functions inherited from IteratedHashBase< T, BASE >
	IteratedHashBase ()
	Construct an IteratedHashBase.
unsigned int	OptimalBlockSize () const
	Provides the input block size most efficient for this cipher.
unsigned int	OptimalDataAlignment () const
	Provides input and output data alignment for optimal performance.
void	Update (const byte *input, size_t length)
	Updates a hash with additional input.
byte *	CreateUpdateSpace (size_t &size)
	Requests space which can be written into by the caller.
void	Restart ()
	Restart the hash.
void	TruncatedFinal (byte *digest, size_t digestSize)
	Computes the hash of the current message.
virtual std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm.

Static Public Attributes
static const int	BLOCKSIZE = T_BlockSize

Detailed Description

template<class T_HashWordType, class T_Endianness, unsigned int T_BlockSize, class T_Base = HashTransformation>
class IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >

Iterated hash base class.

Template Parameters

T_HashWordType	Hash word type
T_Endianness	Endianness type of hash
T_BlockSize	Block size of the hash
T_Base	HashTransformation derived class

IteratedHash provides a default implementation for block-based iterated hashes

See also

HashTransformation, MessageAuthenticationCode

Definition at line 126 of file iterhash.h.

Member Typedef Documentation

ByteOrderClass

template<class T_HashWordType , class T_Endianness , unsigned int T_BlockSize, class T_Base = HashTransformation>

typedef T_Endianness IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::ByteOrderClass

Definition at line 129 of file iterhash.h.

HashWordType

template<class T_HashWordType , class T_Endianness , unsigned int T_BlockSize, class T_Base = HashTransformation>

typedef T_HashWordType IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::HashWordType

Definition at line 130 of file iterhash.h.

Constructor & Destructor Documentation

~IteratedHash()

template<class T_HashWordType , class T_Endianness , unsigned int T_BlockSize, class T_Base = HashTransformation>

virtual IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::~IteratedHash ( )

inlinevirtual

Definition at line 136 of file iterhash.h.

Member Function Documentation

BlockSize()

template<class T_HashWordType , class T_Endianness , unsigned int T_BlockSize, class T_Base = HashTransformation>

unsigned int IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::BlockSize ( ) const

inline

Provides the block size of the hash.

Returns

the block size of the hash, in bytes

BlockSize() returns T_BlockSize.

Definition at line 141 of file iterhash.h.

GetByteOrder()

template<class T_HashWordType , class T_Endianness , unsigned int T_BlockSize, class T_Base = HashTransformation>

ByteOrder IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::GetByteOrder ( ) const

inlinevirtual

Provides the byte order of the hash.

Returns

the byte order of the hash as an enumeration

GetByteOrder() returns T_Endianness::ToEnum().

See also

ByteOrder()

Implements IteratedHashBase< T, BASE >.

Definition at line 147 of file iterhash.h.

CorrectEndianess()

template<class T_HashWordType , class T_Endianness , unsigned int T_BlockSize, class T_Base = HashTransformation>

void IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::CorrectEndianess ( HashWordType *  out, const HashWordType *  in, size_t  byteCount  )

inline

Adjusts the byte ordering of the hash.

Parameters

out	the output buffer
in	the input buffer
byteCount	the size of the buffers, in bytes

CorrectEndianess() calls ConditionalByteReverse() using T_Endianness.

Definition at line 154 of file iterhash.h.

Member Data Documentation

BLOCKSIZE

template<class T_HashWordType , class T_Endianness , unsigned int T_BlockSize, class T_Base = HashTransformation>

const int IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::BLOCKSIZE = T_BlockSize

static

Definition at line 132 of file iterhash.h.

---

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

• iterhash.h