Fabcoin Core  0.16.2
P2P Digital Currency
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
BLAKE2_Base< W, T_64bit > Class Template Reference

BLAKE2 hash implementation. More...

#include <blake2.h>

Inheritance diagram for BLAKE2_Base< W, T_64bit >:
[legend]
Collaboration diagram for BLAKE2_Base< W, T_64bit >:
[legend]

Public Types

typedef BLAKE2_State< W, 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

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 W counter[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 ()
 
HashTransformationRef ()
 Provides a reference to this object. More...
 
virtual byteCreateUpdateSpace (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 ClonableClone () const
 Copies this object. More...
 

Protected Member Functions

 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 AlgorithmGetAlgorithm () 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 byteGetIVAndThrowIfInvalid (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...
 

Private Attributes

AlignedState m_state
 
AlignedParameterBlock m_block
 
AlignedSecByteBlock m_key
 
word32 m_digestSize
 
bool m_treeMode
 

Detailed Description

template<class W, bool T_64bit>
class BLAKE2_Base< W, T_64bit >

BLAKE2 hash implementation.

Template Parameters
Wword type
T_64bitflag indicating 64-bit

BLAKE2b uses BLAKE2_Base<word64, true>, while BLAKE2s uses BLAKE2_Base<word32, false>.

Since
Crypto++ 5.6.4

Definition at line 162 of file blake2.h.

Member Typedef Documentation

template<class W, bool T_64bit>
typedef SecBlock<ParameterBlock, AllocatorWithCleanup<ParameterBlock, true> > BLAKE2_Base< W, T_64bit >::AlignedParameterBlock

Definition at line 177 of file blake2.h.

template<class W, bool T_64bit>
typedef SecBlock<State, AllocatorWithCleanup<State, true> > BLAKE2_Base< W, T_64bit >::AlignedState

Definition at line 176 of file blake2.h.

template<class W, bool T_64bit>
typedef BLAKE2_ParameterBlock<T_64bit> BLAKE2_Base< W, T_64bit >::ParameterBlock

Definition at line 175 of file blake2.h.

template<class W, bool T_64bit>
typedef BLAKE2_State<W, T_64bit> BLAKE2_Base< W, T_64bit >::State

Definition at line 174 of file blake2.h.

Constructor & Destructor Documentation

template<class W, bool T_64bit>
virtual BLAKE2_Base< W, T_64bit >::~BLAKE2_Base ( )
inlinevirtual

Definition at line 179 of file blake2.h.

template<class W , bool T_64bit>
BLAKE2_Base< W, T_64bit >::BLAKE2_Base ( )
protected

Definition at line 341 of file blake2.cpp.

Here is the call graph for this function:

template<class W , bool T_64bit>
BLAKE2_Base< W, T_64bit >::BLAKE2_Base ( bool  treeMode,
unsigned int  digestSize 
)
protected

Definition at line 348 of file blake2.cpp.

Here is the call graph for this function:

template<class W , bool T_64bit>
BLAKE2_Base< W, T_64bit >::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 
)
protected

Definition at line 357 of file blake2.cpp.

Here is the call graph for this function:

Member Function Documentation

template<class W, bool T_64bit>
std::string BLAKE2_Base< W, T_64bit >::AlgorithmName ( ) const
inlinevirtual

Retrieve the object's name.

Returns
the object's algorithm name following RFC 7693

Object algorithm name follows the naming described in RFC 7693, The BLAKE2 Cryptographic Hash and Message Authentication Code (MAC). For example, "BLAKE2b-512" and "BLAKE2s-256".

Reimplemented from Algorithm.

Definition at line 190 of file blake2.h.

template<class W, bool T_64bit>
void BLAKE2_Base< W, T_64bit >::Compress ( const byte input)
protected

Here is the caller graph for this function:

template<class W, bool T_64bit>
unsigned int BLAKE2_Base< W, T_64bit >::DigestSize ( ) const
inlinevirtual

Provides the digest size of the hash.

Returns
the digest size of the hash.

Implements HashTransformation.

Definition at line 192 of file blake2.h.

template<class W, bool T_64bit>
bool BLAKE2_Base< W, T_64bit >::GetTreeMode ( ) const
inline

Get tree mode.

Returns
the current tree mode

Tree mode is persisted across calls to Restart().

Definition at line 215 of file blake2.h.

template<class W , bool T_64bit>
void BLAKE2_Base< W, T_64bit >::IncrementCounter ( size_t  count = BLOCKSIZE)
inlineprotected

Definition at line 469 of file blake2.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

template<class W, bool T_64bit>
unsigned int BLAKE2_Base< W, T_64bit >::OptimalDataAlignment ( ) const
inlinevirtual

Provides input and output data alignment for optimal performance.

Returns
the input data alignment that provides optimal performance

Reimplemented from HashTransformation.

Definition at line 193 of file blake2.h.

template<class W , bool T_64bit>
void BLAKE2_Base< W, T_64bit >::Restart ( )
virtual

Restart the hash.

Discards the current state, and restart for a new message

Reimplemented from HashTransformation.

Definition at line 372 of file blake2.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

template<class W, bool T_64bit>
void BLAKE2_Base< W, T_64bit >::Restart ( const BLAKE2_ParameterBlock< T_64bit > &  block,
const W  counter[2] 
)

Restart a hash with parameter block and counter.

Parameters
blockparameter block
countercounter array

Parameter block is persisted across calls to Restart().

Definition at line 379 of file blake2.cpp.

Here is the call graph for this function:

template<class W, bool T_64bit>
void BLAKE2_Base< W, T_64bit >::SetTreeMode ( bool  mode)
inline

Set tree mode.

Parameters
modethe new tree mode

BLAKE2 has two finalization flags, called State::f[0] and State::f[1]. If treeMode=false (default), then State::f[1] is never set. If treeMode=true, then State::f[1] is set when State::f[0] is set. Tree mode is persisted across calls to Restart().

Definition at line 210 of file blake2.h.

template<class W, bool T_64bit>
CRYPTOPP_STATIC_CONSTEXPR const char* BLAKE2_Base< W, T_64bit >::StaticAlgorithmName ( )
inline

Retrieve the static algorithm name.

Returns
the algorithm name (BLAKE2s or BLAKE2b)

Definition at line 183 of file blake2.h.

template<class W , bool T_64bit>
void BLAKE2_Base< W, T_64bit >::TruncatedFinal ( byte digest,
size_t  digestSize 
)
virtual

Computes the hash of the current message.

Parameters
digesta pointer to the buffer to receive the hash
digestSizethe 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 444 of file blake2.cpp.

Here is the call graph for this function:

template<class W , bool T_64bit>
void BLAKE2_Base< W, T_64bit >::UncheckedSetKey ( const byte key,
unsigned int  length,
const CryptoPP::NameValuePairs &  params 
)
protected

Definition at line 280 of file blake2.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

template<class W , bool T_64bit>
void BLAKE2_Base< W, T_64bit >::Update ( const byte input,
size_t  length 
)
virtual

Updates a hash with additional input.

Parameters
inputthe additional input as a buffer
lengththe size of the buffer, in bytes

Implements HashTransformation.

Definition at line 410 of file blake2.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

template<class W, bool T_64bit>
AlignedParameterBlock BLAKE2_Base< W, T_64bit >::m_block
private

Definition at line 234 of file blake2.h.

template<class W, bool T_64bit>
word32 BLAKE2_Base< W, T_64bit >::m_digestSize
private

Definition at line 236 of file blake2.h.

template<class W, bool T_64bit>
AlignedSecByteBlock BLAKE2_Base< W, T_64bit >::m_key
private

Definition at line 235 of file blake2.h.

template<class W, bool T_64bit>
AlignedState BLAKE2_Base< W, T_64bit >::m_state
private

Definition at line 233 of file blake2.h.

template<class W, bool T_64bit>
bool BLAKE2_Base< W, T_64bit >::m_treeMode
private

Definition at line 237 of file blake2.h.


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