Poly1305 message authentication code base class. More...

#include <poly1305.h>

Inheritance diagram for Poly1305_Base< T >:

Public Member Functions
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...

std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm. More...

Public Member Functions inherited from 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...

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

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

Public Member Functions inherited from HashTransformation
HashTransformation &	Ref ()
	Provides a reference to this object. More...

virtual void	Update (const byte *input, size_t length)=0
	Updates a hash with additional input. 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 void	Restart ()
	Restart the hash. 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	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	TruncatedFinal (byte *digest, size_t digestSize)=0
	Computes 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
	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...

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

virtual std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm. More...

Public Member Functions inherited from Clonable
virtual Clonable *	Clone () const
	Copies this object. More...

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

Static Public Member Functions inherited from FixedKeyLength< 32, SimpleKeyingInterface::UNIQUE_IV, 16 >
static size_t	StaticGetValidKeyLength (size_t keylength)
	The default key length for the algorithm provided by a static function. More...

Static Public Attributes
static const int	DIGESTSIZE =T::BLOCKSIZE

static const int	BLOCKSIZE =T::BLOCKSIZE

Static Public Attributes inherited from FixedKeyLength< 32, SimpleKeyingInterface::UNIQUE_IV, 16 >
static const int	KEYLENGTH
	The default key length used by the algorithm provided as a constant. More...

static const int	MIN_KEYLENGTH
	The minimum key length used by the algorithm provided as a constant. More...

static const int	MAX_KEYLENGTH
	The maximum key length used by the algorithm provided as a constant. More...

static const int	DEFAULT_KEYLENGTH
	The default key length used by the algorithm provided as a constant. More...

static const int	IV_REQUIREMENT
	The default IV requirements for the algorithm provided as a constant. More...

static const int	IV_LENGTH
	The default IV length used by the algorithm provided as a constant. More...

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	BlockCipherDocumentation derived class with 16-byte key and 16-byte blocksize

Poly1305_Base is the base class of Bernstein's Poly1305 algorithm.

Since: Crypto++ 6.0

Definition at line 43 of file poly1305.h.

Constructor & Destructor Documentation

◆ ~Poly1305_Base()

template<class T >

virtual Poly1305_Base< T >::~Poly1305_Base ( )

inlinevirtual

Definition at line 54 of file poly1305.h.

◆ Poly1305_Base()

template<class T >

Poly1305_Base< T >::Poly1305_Base ( )

inline

Definition at line 55 of file poly1305.h.

Member Function Documentation

◆ StaticAlgorithmName()

template<class T >

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

inlinestatic

Definition at line 49 of file poly1305.h.

◆ Resynchronize()

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

◆ GetNextIV()

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

◆ UncheckedSetKey()

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

◆ Update()

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

◆ TruncatedFinal()

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() calls Final() and then copies digestSize bytes to digest. The hash is restarted the hash for the next message.

Precondition: COUNTOF(digest) <= DigestSize() or COUNTOF(digest) <= HASH::DIGESTSIZE ensures the output byte buffer is a valid size.

Implements HashTransformation.

Definition at line 259 of file poly1305.cpp.

◆ Restart()

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

◆ BlockSize()

template<class T >

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

inlinevirtual

Provides the block size of the compression function.

Returns: block size of the compression function, in bytes

BlockSize() will return 0 if the hash is not block based or does not have an equivalent block size. For example, Keccak and SHA-3 do not have a block size, but they do have an equivalent block size called rate expressed as r.

Reimplemented from HashTransformation.

Definition at line 65 of file poly1305.h.

◆ DigestSize()

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 66 of file poly1305.h.

◆ AlgorithmProvider()

template<class T >

std::string Poly1305_Base< T >::AlgorithmProvider

virtual

Retrieve the provider of this algorithm.

Returns: the algorithm provider

The algorithm provider can be a name like "C++", "SSE", "NEON", "AESNI", "ARMv8" and "Power8". C++ is standard C++ code. Other labels, like SSE, usually indicate a specialized implementation using instructions from a higher instruction set architecture (ISA). Future labels may include external hardware like a hardware security module (HSM).

Generally speaking Wei Dai's original IA-32 ASM code falls under "SSE2". Labels like "SSSE3" and "SSE4.1" follow after Wei's code and use intrinsics instead of ASM.

Algorithms which combine different instructions or ISAs provide the dominant one. For example on x86 AES/GCM returns "AESNI" rather than "CLMUL" or "AES+SSE4.1" or "AES+CLMUL" or "AES+SSE4.1+CLMUL".

Note: Provider is not universally implemented yet.

Since: Crypto++ 8.0

Reimplemented from Algorithm.

Definition at line 184 of file poly1305.cpp.

Member Data Documentation

◆ DIGESTSIZE

template<class T >

const int Poly1305_Base< T >::DIGESTSIZE =T::BLOCKSIZE

static

Definition at line 51 of file poly1305.h.

◆ BLOCKSIZE

template<class T >

const int Poly1305_Base< T >::BLOCKSIZE =T::BLOCKSIZE

static

Definition at line 52 of file poly1305.h.

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Poly1305_Base()

◆ Poly1305_Base()

Member Function Documentation

◆ StaticAlgorithmName()

◆ Resynchronize()

◆ GetNextIV()

◆ UncheckedSetKey()

◆ Update()

◆ TruncatedFinal()

◆ Restart()

◆ BlockSize()

◆ DigestSize()

◆ AlgorithmProvider()

Member Data Documentation

◆ DIGESTSIZE

◆ BLOCKSIZE