The BLAKE2s cryptographic hash function. More...

#include <blake2.h>

Inheritance diagram for BLAKE2s:

Collaboration diagram for BLAKE2s:

Public Types
typedef BLAKE2_Base< word32, false >	ThisBase

typedef BLAKE2_ParameterBlock< false >	ParameterBlock

Public Types inherited from BLAKE2_Base< word32, false >
typedef BLAKE2_State< word32, T_64bit >	State

typedef BLAKE2_ParameterBlock< T_64bit >	ParameterBlock

typedef SecBlock< State, AllocatorWithCleanup< State, true > >	AlignedState

typedef SecBlock< ParameterBlock, AllocatorWithCleanup< ParameterBlock, true > >	AlignedParameterBlock

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

Public Member Functions
	CRYPTOPP_COMPILE_ASSERT (sizeof(ParameterBlock)==32)

	BLAKE2s (bool treeMode=false, unsigned int digestSize=DIGESTSIZE)
	Construct a BLAKE2s hash. More...

	BLAKE2s (const byte key, size_t keyLength, const byte salt=NULL, size_t saltLength=0, const byte *personalization=NULL, size_t personalizationLength=0, bool treeMode=false, unsigned int digestSize=DIGESTSIZE)
	Construct a BLAKE2s hash. More...

Public Member Functions inherited from BLAKE2_Base< word32, false >
virtual	~BLAKE2_Base ()

CRYPTOPP_STATIC_CONSTEXPR const char *	StaticAlgorithmName ()
	Retrieve the static algorithm name. More...

std::string	AlgorithmName () const
	Retrieve the object's name. More...

unsigned int	DigestSize () const
	Provides the digest size of the hash. 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...

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

void	Restart (const BLAKE2_ParameterBlock< T_64bit > &block, const word32counter[2])
	Restart a hash with parameter block and counter. More...

void	SetTreeMode (bool mode)
	Set tree mode. More...

bool	GetTreeMode () const
	Get tree mode. More...

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

Public Member Functions inherited from SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2_Info< T_64bit > >
size_t	MinKeyLength () const
	The minimum key length used by the algorithm. More...

size_t	MaxKeyLength () const
	The maximum key length used by the algorithm. More...

size_t	DefaultKeyLength () const
	The default key length used by the algorithm. More...

size_t	GetValidKeyLength (size_t keylength) const
	Provides a valid key length for the algorithm. More...

SimpleKeyingInterface::IV_Requirement	IVRequirement () const
	The default IV requirements for the algorithm. More...

unsigned int	IVSize () const
	The default initialization vector length for the algorithm. More...

Public Member Functions inherited from SimpleKeyingInterface
virtual	~SimpleKeyingInterface ()

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

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

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

Public Member Functions inherited from Clonable
virtual	~Clonable ()

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

Additional Inherited Members
Protected Member Functions inherited from BLAKE2_Base< word32, false >
	BLAKE2_Base ()

	BLAKE2_Base (bool treeMode, unsigned int digestSize)

	BLAKE2_Base (const byte key, size_t keyLength, const byte salt, size_t saltLength, const byte *personalization, size_t personalizationLength, bool treeMode, unsigned int digestSize)

void	Compress (const byte *input)

void	IncrementCounter (size_t count=BLOCKSIZE)

void	UncheckedSetKey (const byte *key, unsigned int length, const CryptoPP::NameValuePairs &params)

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

Protected Member Functions inherited from SimpleKeyingInterface
virtual void	UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)=0
	Sets the key for this object without performing parameter validation. More...

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

Detailed Description

The BLAKE2s cryptographic hash function.

BLAKE2s can function as both a hash and keyed hash. If you want only the hash, then use the BLAKE2s constructor that accepts no parameters or digest size. If you want a keyed hash, then use the constructor that accpts the key as a parameter. Once a key and digest size are selected, its effectively immutable. The Restart() method that accepts a ParameterBlock does not allow you to change it.

See also: Aumasson, Neves, Wilcox-O'Hearn and Winnerlein's BLAKE2: simpler, smaller, fast as MD5 (2013.01.29).

Since: Crypto++ 5.6.4

Definition at line 285 of file blake2.h.

Member Typedef Documentation

typedef BLAKE2_ParameterBlock<false> BLAKE2s::ParameterBlock

Definition at line 289 of file blake2.h.

typedef BLAKE2_Base<word32, false> BLAKE2s::ThisBase

Definition at line 288 of file blake2.h.

Constructor & Destructor Documentation

BLAKE2s::BLAKE2s	(	bool	treeMode = `false`,
		unsigned int	digestSize = `DIGESTSIZE`
	)

inline

Construct a BLAKE2s hash.

Parameters

digestSize	the digest size, in bytes
treeMode	flag indicating tree mode

Definition at line 295 of file blake2.h.

BLAKE2s::BLAKE2s	(	const byte *	key,
		size_t	keyLength,
		const byte *	salt = `NULL`,
		size_t	saltLength = `0`,
		const byte *	personalization = `NULL`,
		size_t	personalizationLength = `0`,
		bool	treeMode = `false`,
		unsigned int	digestSize = `DIGESTSIZE`
	)

inline

Construct a BLAKE2s hash.

Parameters

key	a byte array used to key the cipher
keyLength	the size of the byte array
salt	a byte array used as salt
saltLength	the size of the byte array
personalization	a byte array used as prsonalization string
personalizationLength	the size of the byte array
treeMode	flag indicating tree mode
digestSize	the digest size, in bytes

Definition at line 306 of file blake2.h.

Member Function Documentation

BLAKE2s::CRYPTOPP_COMPILE_ASSERT ( sizeof(ParameterBlock) = =32 )

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

src/cryptopp/blake2.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation