Botan::BLAKE2b Class Reference

#include <blake2b.h>

Inheritance diagram for Botan::BLAKE2b:

Public Member Functions
	BLAKE2b (size_t output_bits=512)
void	clear () override
HashFunction *	clone () const override
std::unique_ptr< HashFunction >	copy_state () const override
void	final (uint8_t out[])
secure_vector< uint8_t >	final ()
template<typename Alloc >
void	final (std::vector< uint8_t, Alloc > &out)
std::vector< uint8_t >	final_stdvec ()
size_t	hash_block_size () const override
std::string	name () const override
size_t	output_length () const override
secure_vector< uint8_t >	process (const uint8_t in[], size_t length)
secure_vector< uint8_t >	process (const secure_vector< uint8_t > &in)
secure_vector< uint8_t >	process (const std::vector< uint8_t > &in)
secure_vector< uint8_t >	process (const std::string &in)
virtual std::string	provider () const
void	update (const uint8_t in[], size_t length)
void	update (const secure_vector< uint8_t > &in)
void	update (const std::vector< uint8_t > &in)
void	update (const std::string &str)
void	update (uint8_t in)
void	update_be (uint16_t val)
void	update_be (uint32_t val)
void	update_be (uint64_t val)
void	update_le (uint16_t val)
void	update_le (uint32_t val)
void	update_le (uint64_t val)

Static Public Member Functions
static std::unique_ptr< HashFunction >	create (const std::string &algo_spec, const std::string &provider="")
static std::unique_ptr< HashFunction >	create_or_throw (const std::string &algo_spec, const std::string &provider="")
static std::vector< std::string >	providers (const std::string &algo_spec)

Detailed Description

BLAKE2B

Definition at line 22 of file blake2b.h.

Constructor & Destructor Documentation

BLAKE2b()

Botan::BLAKE2b::BLAKE2b ( size_t  output_bits = 512 )

explicit

Parameters

output_bits

the output size of BLAKE2b in bits

Definition at line 34 of file blake2b.cpp.

Referenced by clone(), and copy_state().

                                   :
   m_output_bits(output_bits),
   m_buffer(BLAKE2B_BLOCKBYTES),
   m_bufpos(0),
   m_H(BLAKE2B_IVU64COUNT)
   {
   if(output_bits == 0 || output_bits > 512 || output_bits % 8 != 0)
      {
      throw Invalid_Argument("Bad output bits size for BLAKE2b");
      }

   state_init();
   }

Member Function Documentation

clear()

void Botan::BLAKE2b::clear ( )

overridevirtual

Reset the state.

Implements Botan::HashFunction.

Definition at line 199 of file blake2b.cpp.

References Botan::zeroise().

   {
   zeroise(m_H);
   zeroise(m_buffer);
   m_bufpos = 0;
   state_init();
   }

clone()

HashFunction * Botan::BLAKE2b::clone ( ) const

overridevirtual

Returns

new object representing the same algorithm as *this

Implements Botan::HashFunction.

Definition at line 189 of file blake2b.cpp.

References BLAKE2b().

   {
   return new BLAKE2b(m_output_bits);
   }

copy_state()

std::unique_ptr< HashFunction > Botan::BLAKE2b::copy_state ( ) const

overridevirtual

Return a new hash object with the same state as *this. This allows computing the hash of several messages with a common prefix more efficiently than would otherwise be possible.

This function should be called clone but that was already used for the case of returning an uninitialized object.

Returns

new hash object

Implements Botan::HashFunction.

Definition at line 194 of file blake2b.cpp.

References BLAKE2b().

   {
   return std::unique_ptr<HashFunction>(new BLAKE2b(*this));
   }

create()

std::unique_ptr< HashFunction > Botan::HashFunction::create ( const std::string &  algo_spec, const std::string &  provider = ""  )

staticinherited

Create an instance based on a name, or return null if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 106 of file hash.cpp.

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), hash, Botan::make_commoncrypto_hash(), Botan::make_openssl_hash(), and Botan::HashFunction::provider().

Referenced by botan_hash_init(), botan_pubkey_fingerprint(), Botan::KDF::create(), Botan::MessageAuthenticationCode::create(), Botan::BlockCipher::create(), Botan::PBKDF::create(), Botan::PasswordHashFamily::create(), Botan::HashFunction::create_or_throw(), Botan::Certificate_Store_In_Memory::find_cert_by_pubkey_sha1(), Botan::Certificate_Store_In_Memory::find_cert_by_raw_subject_dn_sha256(), Botan::get_eme(), Botan::get_emsa(), Botan::X942_PRF::kdf(), and Botan::X509_Certificate::raw_subject_dn_sha256().

   {

#if defined(BOTAN_HAS_COMMONCRYPTO)
   if(provider.empty() || provider == "commoncrypto")
      {
      if(auto hash = make_commoncrypto_hash(algo_spec))
         return hash;

      if(!provider.empty())
         return nullptr;
      }
#endif

#if defined(BOTAN_HAS_OPENSSL)
   if(provider.empty() || provider == "openssl")
      {
      if(auto hash = make_openssl_hash(algo_spec))
         return hash;

      if(!provider.empty())
         return nullptr;
      }
#endif

   if(provider.empty() == false && provider != "base")
      return nullptr; // unknown provider

#if defined(BOTAN_HAS_SHA1)
   if(algo_spec == "SHA-160" ||
      algo_spec == "SHA-1" ||
      algo_spec == "SHA1")
      {
      return std::unique_ptr<HashFunction>(new SHA_160);
      }
#endif

#if defined(BOTAN_HAS_SHA2_32)
   if(algo_spec == "SHA-224")
      {
      return std::unique_ptr<HashFunction>(new SHA_224);
      }

   if(algo_spec == "SHA-256")
      {
      return std::unique_ptr<HashFunction>(new SHA_256);
      }
#endif

#if defined(BOTAN_HAS_SHA2_64)
   if(algo_spec == "SHA-384")
      {
      return std::unique_ptr<HashFunction>(new SHA_384);
      }

   if(algo_spec == "SHA-512")
      {
      return std::unique_ptr<HashFunction>(new SHA_512);
      }

   if(algo_spec == "SHA-512-256")
      {
      return std::unique_ptr<HashFunction>(new SHA_512_256);
      }
#endif

#if defined(BOTAN_HAS_RIPEMD_160)
   if(algo_spec == "RIPEMD-160")
      {
      return std::unique_ptr<HashFunction>(new RIPEMD_160);
      }
#endif

#if defined(BOTAN_HAS_WHIRLPOOL)
   if(algo_spec == "Whirlpool")
      {
      return std::unique_ptr<HashFunction>(new Whirlpool);
      }
#endif

#if defined(BOTAN_HAS_MD5)
   if(algo_spec == "MD5")
      {
      return std::unique_ptr<HashFunction>(new MD5);
      }
#endif

#if defined(BOTAN_HAS_MD4)
   if(algo_spec == "MD4")
      {
      return std::unique_ptr<HashFunction>(new MD4);
      }
#endif

#if defined(BOTAN_HAS_GOST_34_11)
   if(algo_spec == "GOST-R-34.11-94" || algo_spec == "GOST-34.11")
      {
      return std::unique_ptr<HashFunction>(new GOST_34_11);
      }
#endif

#if defined(BOTAN_HAS_ADLER32)
   if(algo_spec == "Adler32")
      {
      return std::unique_ptr<HashFunction>(new Adler32);
      }
#endif

#if defined(BOTAN_HAS_CRC24)
   if(algo_spec == "CRC24")
      {
      return std::unique_ptr<HashFunction>(new CRC24);
      }
#endif

#if defined(BOTAN_HAS_CRC32)
   if(algo_spec == "CRC32")
      {
      return std::unique_ptr<HashFunction>(new CRC32);
      }
#endif

   const SCAN_Name req(algo_spec);

#if defined(BOTAN_HAS_TIGER)
   if(req.algo_name() == "Tiger")
      {
      return std::unique_ptr<HashFunction>(
         new Tiger(req.arg_as_integer(0, 24),
                   req.arg_as_integer(1, 3)));
      }
#endif

#if defined(BOTAN_HAS_SKEIN_512)
   if(req.algo_name() == "Skein-512")
      {
      return std::unique_ptr<HashFunction>(
         new Skein_512(req.arg_as_integer(0, 512), req.arg(1, "")));
      }
#endif

#if defined(BOTAN_HAS_BLAKE2B)
   if(req.algo_name() == "Blake2b" || req.algo_name() == "BLAKE2b")
      {
      return std::unique_ptr<HashFunction>(
         new Blake2b(req.arg_as_integer(0, 512)));
   }
#endif

#if defined(BOTAN_HAS_KECCAK)
   if(req.algo_name() == "Keccak-1600")
      {
      return std::unique_ptr<HashFunction>(
         new Keccak_1600(req.arg_as_integer(0, 512)));
      }
#endif

#if defined(BOTAN_HAS_SHA3)
   if(req.algo_name() == "SHA-3")
      {
      return std::unique_ptr<HashFunction>(
         new SHA_3(req.arg_as_integer(0, 512)));
      }
#endif

#if defined(BOTAN_HAS_SHAKE)
   if(req.algo_name() == "SHAKE-128")
      {
      return std::unique_ptr<HashFunction>(new SHAKE_128(req.arg_as_integer(0, 128)));
      }
   if(req.algo_name() == "SHAKE-256")
      {
      return std::unique_ptr<HashFunction>(new SHAKE_256(req.arg_as_integer(0, 256)));
      }
#endif

#if defined(BOTAN_HAS_STREEBOG)
   if(algo_spec == "Streebog-256")
      {
      return std::unique_ptr<HashFunction>(new Streebog_256);
      }
   if(algo_spec == "Streebog-512")
      {
      return std::unique_ptr<HashFunction>(new Streebog_512);
      }
#endif

#if defined(BOTAN_HAS_SM3)
   if(algo_spec == "SM3")
      {
      return std::unique_ptr<HashFunction>(new SM3);
      }
#endif

#if defined(BOTAN_HAS_WHIRLPOOL)
   if(req.algo_name() == "Whirlpool")
      {
      return std::unique_ptr<HashFunction>(new Whirlpool);
      }
#endif

#if defined(BOTAN_HAS_PARALLEL_HASH)
   if(req.algo_name() == "Parallel")
      {
      std::vector<std::unique_ptr<HashFunction>> hashes;

      for(size_t i = 0; i != req.arg_count(); ++i)
         {
         auto h = HashFunction::create(req.arg(i));
         if(!h)
            {
            return nullptr;
            }
         hashes.push_back(std::move(h));
         }

      return std::unique_ptr<HashFunction>(new Parallel(hashes));
      }
#endif

#if defined(BOTAN_HAS_COMB4P)
   if(req.algo_name() == "Comb4P" && req.arg_count() == 2)
      {
      std::unique_ptr<HashFunction> h1(HashFunction::create(req.arg(0)));
      std::unique_ptr<HashFunction> h2(HashFunction::create(req.arg(1)));

      if(h1 && h2)
         return std::unique_ptr<HashFunction>(new Comb4P(h1.release(), h2.release()));
      }
#endif


   return nullptr;
   }

create_or_throw()

std::unique_ptr< HashFunction > Botan::HashFunction::create_or_throw ( const std::string &  algo_spec, const std::string &  provider = ""  )

staticinherited

Create an instance based on a name If provider is empty then best available is chosen.

Parameters

algo_spec	algorithm name
provider	provider implementation to use Throws Lookup_Error if not found.

Definition at line 344 of file hash.cpp.

References Botan::HashFunction::create(), hash, and Botan::HashFunction::provider().

Referenced by Botan::argon2(), Botan::bcrypt_pbkdf(), botan_pubkey_sm2_compute_za(), Botan::OCSP::CertID::CertID(), Botan::create_hex_fingerprint(), Botan::Sodium::crypto_hash_sha256(), Botan::Sodium::crypto_hash_sha512(), Botan::EMSA_PKCS1v15_Raw::EMSA_PKCS1v15_Raw(), Botan::TLS::Handshake_Hash::final(), Botan::generate_dsa_primes(), Botan::OCSP::CertID::is_id_for(), Botan::TLS::make_hello_random(), Botan::newhope_shareda(), Botan::newhope_sharedb(), Botan::Roughtime::nonce_from_blind(), Botan::X509_Certificate::raw_issuer_dn_sha256(), Botan::RTSS_Share::split(), and Botan::Cert_Extension::Subject_Key_ID::Subject_Key_ID().

   {
   if(auto hash = HashFunction::create(algo, provider))
      {
      return hash;
      }
   throw Lookup_Error("Hash", algo, provider);
   }

final() [1/3]

void Botan::Buffered_Computation::final ( uint8_t  out[] )

inlineinherited

Complete the computation and retrieve the final result.

Parameters

out	The byte array to be filled with the result. Must be of length output_length()

Definition at line 83 of file buf_comp.h.

Referenced by botan_mac_final(), Botan::ed25519_gen_keypair(), Botan::ed25519_sign(), Botan::ed25519_verify(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption::finish(), and Botan::pbkdf2().

{ final_result(out); }

final() [2/3]

secure_vector<uint8_t> Botan::Buffered_Computation::final ( )

inlineinherited

Complete the computation and retrieve the final result.

Returns

secure_vector holding the result

Definition at line 90 of file buf_comp.h.

         {
         secure_vector<uint8_t> output(output_length());
         final_result(output.data());
         return output;
         }

final() [3/3]

template<typename Alloc >

void Botan::Buffered_Computation::final ( std::vector< uint8_t, Alloc > &  out )

inlineinherited

Definition at line 105 of file buf_comp.h.

         {
         out.resize(output_length());
         final_result(out.data());
         }

final_stdvec()

std::vector<uint8_t> Botan::Buffered_Computation::final_stdvec ( )

inlineinherited

Definition at line 97 of file buf_comp.h.

         {
         std::vector<uint8_t> output(output_length());
         final_result(output.data());
         return output;
         }

hash_block_size()

size_t Botan::BLAKE2b::hash_block_size ( ) const

inlineoverridevirtual

Returns

hash block size as defined for this algorithm

Reimplemented from Botan::HashFunction.

Definition at line 30 of file blake2b.h.

{ return 128; }

name()

std::string Botan::BLAKE2b::name ( ) const

overridevirtual

Returns

the hash function name

Implements Botan::HashFunction.

Definition at line 184 of file blake2b.cpp.

References Botan::ASN1::to_string().

   {
   return "BLAKE2b(" + std::to_string(m_output_bits) + ")";
   }

output_length()

size_t Botan::BLAKE2b::output_length ( ) const

inlineoverridevirtual

Returns

length of the output of this function in bytes

Implements Botan::Buffered_Computation.

Definition at line 31 of file blake2b.h.

{ return m_output_bits / 8; }

process() [1/4]

secure_vector<uint8_t> Botan::Buffered_Computation::process ( const uint8_t  in[], size_t  length  )

inlineinherited

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process as a byte array
length	the length of the byte array

Returns

the result of the call to final()

Definition at line 118 of file buf_comp.h.

         {
         add_data(in, length);
         return final();
         }

process() [2/4]

secure_vector<uint8_t> Botan::Buffered_Computation::process ( const secure_vector< uint8_t > &  in )

inlineinherited

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process

Returns

the result of the call to final()

Definition at line 130 of file buf_comp.h.

         {
         add_data(in.data(), in.size());
         return final();
         }

process() [3/4]

secure_vector<uint8_t> Botan::Buffered_Computation::process ( const std::vector< uint8_t > &  in )

inlineinherited

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process

Returns

the result of the call to final()

Definition at line 142 of file buf_comp.h.

         {
         add_data(in.data(), in.size());
         return final();
         }

process() [4/4]

secure_vector<uint8_t> Botan::Buffered_Computation::process ( const std::string &  in )

inlineinherited

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process as a string

Returns

the result of the call to final()

Definition at line 154 of file buf_comp.h.

References update.

         {
         update(in);
         return final();
         }

provider()

virtual std::string Botan::HashFunction::provider ( ) const

inlinevirtualinherited

Returns

provider information about this implementation. Default is "base", might also return "sse2", "avx2", "openssl", or some other arbitrary string.

Reimplemented in Botan::SHA_512_256, Botan::SHA_256, Botan::SHA_512, Botan::SHA_3, Botan::SHA_224, and Botan::SHA_384.

Definition at line 58 of file hash.h.

Referenced by Botan::HashFunction::create(), and Botan::HashFunction::create_or_throw().

{ return "base"; }

providers()

std::vector< std::string > Botan::HashFunction::providers ( const std::string &  algo_spec )

staticinherited

Returns

list of available providers for this algorithm, empty if not available

Parameters

algo_spec

algorithm name

Definition at line 354 of file hash.cpp.

   {
   return probe_providers_of<HashFunction>(algo_spec, {"base", "openssl", "commoncrypto"});
   }

update() [1/5]

void Botan::Buffered_Computation::update ( const uint8_t  in[], size_t  length  )

inlineinherited

Add new input to process.

Parameters

in	the input to process as a byte array
length	of param in in bytes

Definition at line 33 of file buf_comp.h.

Referenced by botan_mac_update(), Botan::ed25519_gen_keypair(), Botan::ed25519_sign(), Botan::ed25519_verify(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption::finish(), and Botan::pbkdf2().

{ add_data(in, length); }

update() [2/5]

void Botan::Buffered_Computation::update ( const secure_vector< uint8_t > &  in )

inlineinherited

Add new input to process.

Parameters

in	the input to process as a secure_vector

Definition at line 39 of file buf_comp.h.

         {
         add_data(in.data(), in.size());
         }

update() [3/5]

void Botan::Buffered_Computation::update ( const std::vector< uint8_t > &  in )

inlineinherited

Add new input to process.

Parameters

in	the input to process as a std::vector

Definition at line 48 of file buf_comp.h.

         {
         add_data(in.data(), in.size());
         }

update() [4/5]

void Botan::Buffered_Computation::update ( const std::string &  str )

inlineinherited

Add new input to process.

Parameters

str	the input to process as a std::string. Will be interpreted as a byte array based on the strings encoding.

Definition at line 66 of file buf_comp.h.

References Botan::cast_char_ptr_to_uint8().

         {
         add_data(cast_char_ptr_to_uint8(str.data()), str.size());
         }

update() [5/5]

void Botan::Buffered_Computation::update ( uint8_t  in )

inlineinherited

Process a single byte.

Parameters

in	the byte to process

Definition at line 75 of file buf_comp.h.

{ add_data(&in, 1); }

update_be() [1/3]

void Botan::Buffered_Computation::update_be ( uint16_t  val )

inherited

Definition at line 12 of file buf_comp.cpp.

References Botan::store_be().

Referenced by Botan::pbkdf2().

   {
   uint8_t inb[sizeof(val)];
   store_be(val, inb);
   add_data(inb, sizeof(inb));
   }

update_be() [2/3]

void Botan::Buffered_Computation::update_be ( uint32_t  val )

inherited

Definition at line 19 of file buf_comp.cpp.

References Botan::store_be().

   {
   uint8_t inb[sizeof(val)];
   store_be(val, inb);
   add_data(inb, sizeof(inb));
   }

update_be() [3/3]

void Botan::Buffered_Computation::update_be ( uint64_t  val )

inherited

Definition at line 26 of file buf_comp.cpp.

References Botan::store_be().

   {
   uint8_t inb[sizeof(val)];
   store_be(val, inb);
   add_data(inb, sizeof(inb));
   }

update_le() [1/3]

void Botan::Buffered_Computation::update_le ( uint16_t  val )

inherited

Definition at line 33 of file buf_comp.cpp.

References Botan::store_le().

   {
   uint8_t inb[sizeof(val)];
   store_le(val, inb);
   add_data(inb, sizeof(inb));
   }

update_le() [2/3]

void Botan::Buffered_Computation::update_le ( uint32_t  val )

inherited

Definition at line 40 of file buf_comp.cpp.

References Botan::store_le().

   {
   uint8_t inb[sizeof(val)];
   store_le(val, inb);
   add_data(inb, sizeof(inb));
   }

update_le() [3/3]

void Botan::Buffered_Computation::update_le ( uint64_t  val )

inherited

Definition at line 47 of file buf_comp.cpp.

References Botan::store_le().

   {
   uint8_t inb[sizeof(val)];
   store_le(val, inb);
   add_data(inb, sizeof(inb));
   }

---

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

• src/lib/hash/blake2/blake2b.h
• src/lib/hash/blake2/blake2b.cpp