Crypto++
8.6
Free C++ class library of cryptographic schemes
|
The BLAKE2b cryptographic hash function. More...
Public Types | |
typedef BLAKE2b_State | State |
typedef BLAKE2b_ParameterBlock | ParameterBlock |
![]() | |
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 | |
BLAKE2b (bool treeMode=false, unsigned int digestSize=DIGESTSIZE) | |
Construct a BLAKE2b hash. More... | |
BLAKE2b (unsigned int digestSize) | |
Construct a BLAKE2s hash. More... | |
BLAKE2b (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 BLAKE2b hash. More... | |
std::string | AlgorithmName () const |
Retrieve the object's name. 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... | |
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 BLAKE2b_ParameterBlock &block, const word64 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... | |
std::string | AlgorithmProvider () const |
Retrieve the provider of this algorithm. More... | |
![]() | |
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 initialization vector length for the algorithm. More... | |
![]() | |
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 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 ¶ms=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... | |
![]() | |
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 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... | |
![]() | |
Algorithm (bool checkSelfTestStatus=true) | |
Interface for all crypto algorithms. More... | |
![]() | |
virtual Clonable * | Clone () const |
Copies this object. More... | |
Static Public Member Functions | |
static const char * | StaticAlgorithmName () |
The BLAKE2b cryptographic hash function.
BLAKE2b can function as both a hash and keyed hash. If you want only the hash, then use the BLAKE2b 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.
BLAKE2b::BLAKE2b | ( | bool | treeMode = false , |
unsigned int | digestSize = DIGESTSIZE |
||
) |
Construct a BLAKE2b hash.
digestSize | the digest size, in bytes |
treeMode | flag indicating tree mode |
Definition at line 336 of file blake2.cpp.
BLAKE2b::BLAKE2b | ( | unsigned int | digestSize | ) |
Construct a BLAKE2s hash.
digestSize | the digest size, in bytes treeMode flag is set to false |
Definition at line 356 of file blake2.cpp.
BLAKE2b::BLAKE2b | ( | 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 BLAKE2b hash.
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 personalization string |
personalizationLength | the size of the byte array |
treeMode | flag indicating tree mode |
digestSize | the digest size, in bytes |
Definition at line 382 of file blake2.cpp.
|
inlinevirtual |
Retrieve the object's name.
Reimplemented from Algorithm.
|
inlinevirtual |
Provides the block size of the compression function.
r
. Reimplemented from HashTransformation.
|
inlinevirtual |
Provides the digest size of the hash.
Implements HashTransformation.
|
virtual |
Provides input and output data alignment for optimal performance.
Reimplemented from HashTransformation.
Definition at line 192 of file blake2.cpp.
|
virtual |
Updates a hash with additional input.
input | the additional input as a buffer |
length | the size of the buffer, in bytes |
Implements HashTransformation.
Definition at line 573 of file blake2.cpp.
|
virtual |
Restart the hash.
Discards the current state, and restart for a new message
Reimplemented from HashTransformation.
Definition at line 468 of file blake2.cpp.
void BLAKE2b::Restart | ( | const BLAKE2b_ParameterBlock & | block, |
const word64 | counter[2] | ||
) |
Restart a hash with parameter block and counter.
block | parameter block |
counter | counter array Parameter block is persisted across calls to Restart(). |
Definition at line 505 of file blake2.cpp.
|
inline |
Set tree mode.
mode | the 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(). |
|
inline |
|
virtual |
Computes the hash of the current message.
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. |
COUNTOF(digest) <= DigestSize()
or COUNTOF(digest) <= HASH::DIGESTSIZE
ensures the output byte buffer is a valid size. Implements HashTransformation.
Definition at line 636 of file blake2.cpp.
|
virtual |
Retrieve the provider of this algorithm.
AES/GCM
returns "AESNI" rather than "CLMUL" or "AES+SSE4.1" or "AES+CLMUL" or "AES+SSE4.1+CLMUL". Reimplemented from Algorithm.
Definition at line 212 of file blake2.cpp.