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

Collaboration 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_HashWordType, T_Base >
typedef T_HashWordType	HashWordType

Public Member Functions
	CRYPTOPP_COMPILE_ASSERT ((T_BlockSize &(T_BlockSize-1))==0)
virtual	~IteratedHash ()
unsigned int	BlockSize () const
	Provides the block size of the hash. More...
ByteOrder	GetByteOrder () const
	Provides the byte order of the hash. More...
void	CorrectEndianess (HashWordType *out, const HashWordType *in, size_t byteCount)
	Adjusts the byte ordering of the hash. More...
Public Member Functions inherited from IteratedHashBase< T_HashWordType, T_Base >
	IteratedHashBase ()
	Construct an IteratedHashBase. More...
unsigned int	OptimalBlockSize () const
	Provides the input block size most efficient for this cipher. More...
unsigned int	OptimalDataAlignment () const
	Provides input and output data alignment for optimal performance. More...
void	Update (const byte *input, size_t length)
	Updates a hash with additional input. More...
byte *	CreateUpdateSpace (size_t &size)
	Requests space which can be written into by the caller. More...
void	Restart ()
	Restart the hash. More...
void	TruncatedFinal (byte *digest, size_t digestSize)
	Computes the hash of the current message. More...

Protected Member Functions
T_HashWordType *	DataBuf ()
Protected Member Functions inherited from IteratedHashBase< T_HashWordType, T_Base >
T_HashWordType	GetBitCountHi () const
T_HashWordType	GetBitCountLo () const
void	PadLastBlock (unsigned int lastBlockSize, byte padFirst=0x80)
virtual void	Init ()=0
virtual void	HashEndianCorrectedBlock (const HashWordType *data)=0
virtual size_t	HashMultipleBlocks (const T_HashWordType *input, size_t length)
void	HashBlock (const HashWordType *input)
virtual T_HashWordType *	StateBuf ()=0

Protected Attributes
FixedSizeSecBlock< T_HashWordType, T_BlockSize/sizeof(T_HashWordType)>	m_data

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 101 of file iterhash.h.

Member Typedef Documentation

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 104 of file iterhash.h.

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 105 of file iterhash.h.

Constructor & Destructor Documentation

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 111 of file iterhash.h.

Member Function Documentation

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 116 of file iterhash.h.

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 129 of file iterhash.h.

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

IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::CRYPTOPP_COMPILE_ASSERT

(

(T_BlockSize &(T_BlockSize-1))

= =0

)

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

T_HashWordType* IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::DataBuf ( )

inlineprotectedvirtual

Implements IteratedHashBase< T_HashWordType, T_Base >.

Definition at line 135 of file iterhash.h.

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_HashWordType, T_Base >.

Definition at line 122 of file iterhash.h.

Member Data Documentation

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

FixedSizeSecBlock<T_HashWordType, T_BlockSize/sizeof(T_HashWordType)> IteratedHash< T_HashWordType, T_Endianness, T_BlockSize, T_Base >::m_data

protected

Definition at line 136 of file iterhash.h.

---

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

• src/cryptopp/iterhash.h