Poly1305 message authentication code base class. More...

#include <poly1305.h>

Inheritance diagram for Poly1305_Base< T >:

Collaboration diagram for Poly1305_Base< T >:

Public Member Functions
	Poly1305_Base ()

void	Resynchronize (const byte *iv, int ivLength=-1)
	Resynchronize with an IV. More...

void	GetNextIV (RandomNumberGenerator &rng, byte *iv)
	Retrieves a secure IV for the next message. More...

void	UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)
	Sets the key for this object without performing parameter validation. More...

void	Update (const byte *input, size_t length)
	Updates a hash with additional input. More...

void	TruncatedFinal (byte *mac, size_t size)
	Computes the hash of the current message. More...

void	Restart ()
	Restart the hash. More...

unsigned int	BlockSize () const
	Provides the block size of the compression function. More...

unsigned int	DigestSize () const
	Provides the digest size of the hash. More...

Public Member Functions inherited from FixedKeyLength< 32, SimpleKeyingInterface::UNIQUE_IV, 16 >
CRYPTOPP_STATIC_CONSTEXPR size_t CRYPTOPP_API	StaticGetValidKeyLength (size_t keylength)
	The default key length used by the algorithm provided as a constant. More...

Public Member Functions inherited from SimpleKeyingInterface
virtual	~SimpleKeyingInterface ()

virtual size_t	MinKeyLength () const =0
	Returns smallest valid key length. More...

virtual size_t	MaxKeyLength () const =0
	Returns largest valid key length. More...

virtual size_t	DefaultKeyLength () const =0
	Returns default key length. More...

virtual size_t	GetValidKeyLength (size_t keylength) const =0
	Returns a valid key length for the algorithm. More...

virtual bool	IsValidKeyLength (size_t keylength) const
	Returns whether keylength is a valid key length. More...

virtual void	SetKey (const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)
	Sets or reset the key of this object. 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
	Minimal requirement for secure IVs. More...

bool	IsResynchronizable () const
	Determines if the object can be resynchronized. More...

bool	CanUseRandomIVs () const
	Determines if the object can use random IVs. More...

bool	CanUsePredictableIVs () const
	Determines if the object can use random but possibly predictable IVs. More...

bool	CanUseStructuredIVs () const
	Determines if the object can use structured IVs. More...

virtual unsigned int	IVSize () const
	Returns length of the IV accepted by this object. More...

unsigned int	DefaultIVLength () const
	Provides the default size of an IV. More...

virtual unsigned int	MinIVLength () const
	Provides the minimum size of an IV. More...

virtual unsigned int	MaxIVLength () const
	Provides the maximum size of an IV. More...

Public Member Functions inherited from HashTransformation
virtual	~HashTransformation ()

HashTransformation &	Ref ()
	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...

unsigned int	TagSize () const
	Provides the tag size of the hash. More...

virtual unsigned int	OptimalBlockSize () const
	Provides the input block size most efficient for this hash. 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...

Public Member Functions inherited from Algorithm
virtual	~Algorithm ()

	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...

virtual std::string	AlgorithmName () const
	Provides the name of this algorithm. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()

virtual Clonable *	Clone () const
	Copies this object. More...

Static Public Member Functions
static std::string	StaticAlgorithmName ()

Protected Member Functions
void	HashBlocks (const byte *input, size_t length, word32 padbit)

void	HashFinal (byte *mac, size_t length)

Protected Member Functions inherited from MessageAuthenticationCode
const Algorithm &	GetAlgorithm () const
	Returns the base class Algorithm. More...

Protected Member Functions inherited from SimpleKeyingInterface
void	ThrowIfInvalidKeyLength (size_t length)
	Validates the key length. More...

void	ThrowIfResynchronizable ()
	Validates the object. More...

void	ThrowIfInvalidIV (const byte *iv)
	Validates the IV. More...

size_t	ThrowIfInvalidIVLength (int length)
	Validates the IV length. More...

const byte *	GetIVAndThrowIfInvalid (const NameValuePairs &params, size_t &size)
	Retrieves and validates the IV. More...

void	AssertValidKeyLength (size_t length) const
	Validates the key length. More...

Protected Member Functions inherited from HashTransformation
void	ThrowIfInvalidTruncatedSize (size_t size) const
	Validates a truncated digest size. More...

Protected Attributes
T::Encryption	m_cipher

FixedSizeAlignedSecBlock< word32, 5 >	m_h

FixedSizeAlignedSecBlock< word32, 4 >	m_r

FixedSizeAlignedSecBlock< word32, 4 >	m_n

FixedSizeAlignedSecBlock< byte, BLOCKSIZE >	m_acc

size_t	m_idx

bool	m_used

Private Member Functions
	CRYPTOPP_COMPILE_ASSERT (T::DEFAULT_KEYLENGTH==16)

	CRYPTOPP_COMPILE_ASSERT (T::BLOCKSIZE==16)

Additional Inherited Members
Public Types inherited from SimpleKeyingInterface
enum	IV_Requirement { UNIQUE_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV, NOT_RESYNCHRONIZABLE }
	Secure IVs requirements as enumerated values. More...

Detailed Description

template<class T>
class Poly1305_Base< T >

Poly1305 message authentication code base class.

Template Parameters

T	class derived from BlockCipherDocumentation with 16-byte key and 16-byte blocksize

Since: Crypto++ 5.7

Definition at line 61 of file poly1305.h.

Constructor & Destructor Documentation

template<class T >

Poly1305_Base< T >::Poly1305_Base ( )

inline

Definition at line 72 of file poly1305.h.

Member Function Documentation

template<class T >

unsigned int Poly1305_Base< T >::BlockSize ( ) const

inlinevirtual

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

Definition at line 82 of file poly1305.h.

template<class T >

Poly1305_Base< T >::CRYPTOPP_COMPILE_ASSERT ( T::DEFAULT_KEYLENGTH = =16 )

private

template<class T >

Poly1305_Base< T >::CRYPTOPP_COMPILE_ASSERT ( T::BLOCKSIZE = =16 )

private

template<class T >

unsigned int Poly1305_Base< T >::DigestSize ( ) const

inlinevirtual

Provides the digest size of the hash.

Returns: the digest size of the hash.

Implements HashTransformation.

Definition at line 83 of file poly1305.h.

template<class T >

void Poly1305_Base< T >::GetNextIV	(	RandomNumberGenerator &	rng,
		byte *	iv
	)

virtual

Retrieves a secure IV for the next message.

Parameters

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

The IV must be at least IVSize() in length.

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.

Internally, the base class implementation calls RandomNumberGenerator's GenerateBlock()

Note: This method is not implemented on decryption objects.

Reimplemented from SimpleKeyingInterface.

Definition at line 251 of file poly1305.cpp.

Here is the call graph for this function:

template<class T >

void Poly1305_Base< T >::HashBlocks	(	const byte *	input,
		size_t	length,
		word32	padbit
	)

protected

Definition at line 93 of file poly1305.cpp.

Here is the call graph for this function:

template<class T >

void Poly1305_Base< T >::HashFinal	(	byte *	mac,
		size_t	length
	)

protected

Definition at line 190 of file poly1305.cpp.

Here is the call graph for this function:

template<class T >

void Poly1305_Base< T >::Restart ( )

virtual

Restart the hash.

Discards the current state, and restart for a new message

Reimplemented from HashTransformation.

Definition at line 257 of file poly1305.cpp.

template<class T >

void Poly1305_Base< T >::Resynchronize	(	const byte *	iv,
		int	ivLength = `-1`
	)

virtual

Resynchronize with an IV.

Parameters

iv	the initialization vector
ivLength	the size of the initialization vector, in bytes

Resynchronize() resynchronizes with an IV provided by the caller. ivLength=-1 means use IVSize().

Exceptions

NotImplemented() if the object does not support resynchronization

Reimplemented from SimpleKeyingInterface.

Definition at line 243 of file poly1305.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

static std::string Poly1305_Base< T >::StaticAlgorithmName ( )

inlinestatic

Definition at line 67 of file poly1305.h.

template<class T >

void Poly1305_Base< T >::TruncatedFinal	(	byte *	digest,
		size_t	digestSize
	)

virtual

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. The hash is restarted the hash for the next message.

Implements HashTransformation.

Definition at line 166 of file poly1305.cpp.

template<class T >

void Poly1305_Base< T >::UncheckedSetKey	(	const byte *	key,
		unsigned int	length,
		const NameValuePairs &	params
	)

virtual

Sets the key for this object without performing parameter validation.

Parameters

key	a byte buffer used to key the cipher
length	the length of the byte buffer
params	additional parameters passed as NameValuePairs

key must be at least DEFAULT_KEYLENGTH in length.

Implements SimpleKeyingInterface.

Definition at line 16 of file poly1305.cpp.

Here is the call graph for this function:

template<class T >

void Poly1305_Base< T >::Update	(	const byte *	input,
		size_t	length
	)

virtual

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 52 of file poly1305.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

template<class T >

FixedSizeAlignedSecBlock<byte, BLOCKSIZE> Poly1305_Base< T >::m_acc

protected

Definition at line 97 of file poly1305.h.

template<class T >

T::Encryption Poly1305_Base< T >::m_cipher

protected

Definition at line 89 of file poly1305.h.

template<class T >

FixedSizeAlignedSecBlock<word32, 5> Poly1305_Base< T >::m_h

protected

Definition at line 92 of file poly1305.h.

template<class T >

size_t Poly1305_Base< T >::m_idx

protected

Definition at line 98 of file poly1305.h.

template<class T >

FixedSizeAlignedSecBlock<word32, 4> Poly1305_Base< T >::m_n

protected

Definition at line 94 of file poly1305.h.

template<class T >

FixedSizeAlignedSecBlock<word32, 4> Poly1305_Base< T >::m_r

protected

Definition at line 93 of file poly1305.h.

template<class T >

bool Poly1305_Base< T >::m_used

protected

Definition at line 101 of file poly1305.h.

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

src/cryptopp/poly1305.h
src/cryptopp/poly1305.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

template<class T> class Poly1305_Base< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class Poly1305_Base< T >