Botan  2.8.0
Crypto and TLS for C++11
Public Member Functions | Static Public Member Functions | List of all members
Botan::Blake2b Class Referencefinal

#include <blake2b.h>

Inheritance diagram for Botan::Blake2b:
Botan::HashFunction Botan::Buffered_Computation

Public Member Functions

 Blake2b (size_t output_bits=512)
 
void clear () override
 
HashFunctionclone () const override
 
std::unique_ptr< HashFunctioncopy_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)
 
template<typename T >
void update_be (const T in)
 

Static Public Member Functions

static std::unique_ptr< HashFunctioncreate (const std::string &algo_spec, const std::string &provider="")
 
static std::unique_ptr< HashFunctioncreate_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 20 of file blake2b.h.

Constructor & Destructor Documentation

◆ Blake2b()

Botan::Blake2b::Blake2b ( size_t  output_bits = 512)
explicit
Parameters
output_bitsthe output size of Blake2b in bits

Definition at line 34 of file blake2b.cpp.

Referenced by clone(), and copy_state().

34  :
35  m_output_bits(output_bits),
36  m_buffer(BLAKE2B_BLOCKBYTES),
37  m_bufpos(0),
38  m_H(BLAKE2B_IVU64COUNT)
39  {
40  if(output_bits == 0 || output_bits > 512 || output_bits % 8 != 0)
41  {
42  throw Invalid_Argument("Bad output bits size for Blake2b");
43  }
44 
45  state_init();
46  }

Member Function Documentation

◆ clear()

void Botan::Blake2b::clear ( )
overridevirtual

Reset the state.

Implements Botan::HashFunction.

Definition at line 198 of file blake2b.cpp.

References Botan::zeroise().

199  {
200  zeroise(m_H);
201  zeroise(m_buffer);
202  m_bufpos = 0;
203  state_init();
204  }
void zeroise(std::vector< T, Alloc > &vec)
Definition: secmem.h:183

◆ clone()

HashFunction * Botan::Blake2b::clone ( ) const
overridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::HashFunction.

Definition at line 188 of file blake2b.cpp.

References Blake2b().

189  {
190  return new Blake2b(m_output_bits);
191  }
Blake2b(size_t output_bits=512)
Definition: blake2b.cpp:34

◆ 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 193 of file blake2b.cpp.

References Blake2b().

194  {
195  return std::unique_ptr<HashFunction>(new Blake2b(*this));
196  }
Blake2b(size_t output_bits=512)
Definition: blake2b.cpp:34

◆ 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 110 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_bearssl_hash(), Botan::make_commoncrypto_hash(), Botan::make_openssl_hash(), and Botan::HashFunction::provider().

Referenced by botan_hash_init(), botan_pubkey_fingerprint(), Botan::BlockCipher::create(), Botan::KDF::create(), Botan::MessageAuthenticationCode::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::OCSP::CertID::is_id_for(), Botan::X942_PRF::kdf(), and Botan::X509_Certificate::raw_subject_dn_sha256().

112  {
113 
114 #if defined(BOTAN_HAS_COMMONCRYPTO)
115  if(provider.empty() || provider == "commoncrypto")
116  {
117  if(auto hash = make_commoncrypto_hash(algo_spec))
118  return hash;
119 
120  if(!provider.empty())
121  return nullptr;
122  }
123 #endif
124 
125 #if defined(BOTAN_HAS_OPENSSL)
126  if(provider.empty() || provider == "openssl")
127  {
128  if(auto hash = make_openssl_hash(algo_spec))
129  return hash;
130 
131  if(!provider.empty())
132  return nullptr;
133  }
134 #endif
135 
136 #if defined(BOTAN_HAS_BEARSSL)
137  if(provider.empty() || provider == "bearssl")
138  {
139  if(auto hash = make_bearssl_hash(algo_spec))
140  return hash;
141 
142  if(!provider.empty())
143  return nullptr;
144  }
145 #endif
146 
147  if(provider.empty() == false && provider != "base")
148  return nullptr; // unknown provider
149 
150 #if defined(BOTAN_HAS_SHA1)
151  if(algo_spec == "SHA-160" ||
152  algo_spec == "SHA-1" ||
153  algo_spec == "SHA1")
154  {
155  return std::unique_ptr<HashFunction>(new SHA_160);
156  }
157 #endif
158 
159 #if defined(BOTAN_HAS_SHA2_32)
160  if(algo_spec == "SHA-224")
161  {
162  return std::unique_ptr<HashFunction>(new SHA_224);
163  }
164 
165  if(algo_spec == "SHA-256")
166  {
167  return std::unique_ptr<HashFunction>(new SHA_256);
168  }
169 #endif
170 
171 #if defined(BOTAN_HAS_SHA2_64)
172  if(algo_spec == "SHA-384")
173  {
174  return std::unique_ptr<HashFunction>(new SHA_384);
175  }
176 
177  if(algo_spec == "SHA-512")
178  {
179  return std::unique_ptr<HashFunction>(new SHA_512);
180  }
181 
182  if(algo_spec == "SHA-512-256")
183  {
184  return std::unique_ptr<HashFunction>(new SHA_512_256);
185  }
186 #endif
187 
188 #if defined(BOTAN_HAS_RIPEMD_160)
189  if(algo_spec == "RIPEMD-160")
190  {
191  return std::unique_ptr<HashFunction>(new RIPEMD_160);
192  }
193 #endif
194 
195 #if defined(BOTAN_HAS_WHIRLPOOL)
196  if(algo_spec == "Whirlpool")
197  {
198  return std::unique_ptr<HashFunction>(new Whirlpool);
199  }
200 #endif
201 
202 #if defined(BOTAN_HAS_MD5)
203  if(algo_spec == "MD5")
204  {
205  return std::unique_ptr<HashFunction>(new MD5);
206  }
207 #endif
208 
209 #if defined(BOTAN_HAS_MD4)
210  if(algo_spec == "MD4")
211  {
212  return std::unique_ptr<HashFunction>(new MD4);
213  }
214 #endif
215 
216 #if defined(BOTAN_HAS_GOST_34_11)
217  if(algo_spec == "GOST-R-34.11-94" || algo_spec == "GOST-34.11")
218  {
219  return std::unique_ptr<HashFunction>(new GOST_34_11);
220  }
221 #endif
222 
223 #if defined(BOTAN_HAS_ADLER32)
224  if(algo_spec == "Adler32")
225  {
226  return std::unique_ptr<HashFunction>(new Adler32);
227  }
228 #endif
229 
230 #if defined(BOTAN_HAS_CRC24)
231  if(algo_spec == "CRC24")
232  {
233  return std::unique_ptr<HashFunction>(new CRC24);
234  }
235 #endif
236 
237 #if defined(BOTAN_HAS_CRC32)
238  if(algo_spec == "CRC32")
239  {
240  return std::unique_ptr<HashFunction>(new CRC32);
241  }
242 #endif
243 
244  const SCAN_Name req(algo_spec);
245 
246 #if defined(BOTAN_HAS_TIGER)
247  if(req.algo_name() == "Tiger")
248  {
249  return std::unique_ptr<HashFunction>(
250  new Tiger(req.arg_as_integer(0, 24),
251  req.arg_as_integer(1, 3)));
252  }
253 #endif
254 
255 #if defined(BOTAN_HAS_SKEIN_512)
256  if(req.algo_name() == "Skein-512")
257  {
258  return std::unique_ptr<HashFunction>(
259  new Skein_512(req.arg_as_integer(0, 512), req.arg(1, "")));
260  }
261 #endif
262 
263 #if defined(BOTAN_HAS_BLAKE2B)
264  if(req.algo_name() == "Blake2b")
265  {
266  return std::unique_ptr<HashFunction>(
267  new Blake2b(req.arg_as_integer(0, 512)));
268  }
269 #endif
270 
271 #if defined(BOTAN_HAS_KECCAK)
272  if(req.algo_name() == "Keccak-1600")
273  {
274  return std::unique_ptr<HashFunction>(
275  new Keccak_1600(req.arg_as_integer(0, 512)));
276  }
277 #endif
278 
279 #if defined(BOTAN_HAS_SHA3)
280  if(req.algo_name() == "SHA-3")
281  {
282  return std::unique_ptr<HashFunction>(
283  new SHA_3(req.arg_as_integer(0, 512)));
284  }
285 #endif
286 
287 #if defined(BOTAN_HAS_SHAKE)
288  if(req.algo_name() == "SHAKE-128")
289  {
290  return std::unique_ptr<HashFunction>(new SHAKE_128(req.arg_as_integer(0, 128)));
291  }
292  if(req.algo_name() == "SHAKE-256")
293  {
294  return std::unique_ptr<HashFunction>(new SHAKE_256(req.arg_as_integer(0, 256)));
295  }
296 #endif
297 
298 #if defined(BOTAN_HAS_STREEBOG)
299  if(algo_spec == "Streebog-256")
300  {
301  return std::unique_ptr<HashFunction>(new Streebog_256);
302  }
303  if(algo_spec == "Streebog-512")
304  {
305  return std::unique_ptr<HashFunction>(new Streebog_512);
306  }
307 #endif
308 
309 #if defined(BOTAN_HAS_SM3)
310  if(algo_spec == "SM3")
311  {
312  return std::unique_ptr<HashFunction>(new SM3);
313  }
314 #endif
315 
316 #if defined(BOTAN_HAS_WHIRLPOOL)
317  if(req.algo_name() == "Whirlpool")
318  {
319  return std::unique_ptr<HashFunction>(new Whirlpool);
320  }
321 #endif
322 
323 #if defined(BOTAN_HAS_PARALLEL_HASH)
324  if(req.algo_name() == "Parallel")
325  {
326  std::vector<std::unique_ptr<HashFunction>> hashes;
327 
328  for(size_t i = 0; i != req.arg_count(); ++i)
329  {
330  auto h = HashFunction::create(req.arg(i));
331  if(!h)
332  {
333  return nullptr;
334  }
335  hashes.push_back(std::move(h));
336  }
337 
338  return std::unique_ptr<HashFunction>(new Parallel(hashes));
339  }
340 #endif
341 
342 #if defined(BOTAN_HAS_COMB4P)
343  if(req.algo_name() == "Comb4P" && req.arg_count() == 2)
344  {
345  std::unique_ptr<HashFunction> h1(HashFunction::create(req.arg(0)));
346  std::unique_ptr<HashFunction> h2(HashFunction::create(req.arg(1)));
347 
348  if(h1 && h2)
349  return std::unique_ptr<HashFunction>(new Comb4P(h1.release(), h2.release()));
350  }
351 #endif
352 
353 
354  return nullptr;
355  }
std::unique_ptr< HashFunction > make_bearssl_hash(const std::string &name)
virtual std::string provider() const
Definition: hash.h:58
std::unique_ptr< HashFunction > make_openssl_hash(const std::string &name)
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
Definition: hash.cpp:110
std::unique_ptr< HashFunction > make_commoncrypto_hash(const std::string &name)
MechanismType hash

◆ 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_specalgorithm name
providerprovider implementation to use Throws Lookup_Error if not found.

Definition at line 359 of file hash.cpp.

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

Referenced by botan_pubkey_sm2_compute_za(), Botan::OCSP::CertID::CertID(), Botan::create_hex_fingerprint(), Botan::EMSA_PKCS1v15_Raw::EMSA_PKCS1v15_Raw(), Botan::TLS::Handshake_Hash::final(), Botan::generate_dsa_primes(), Botan::TLS::make_hello_random(), Botan::newhope_shareda(), Botan::newhope_sharedb(), Botan::X509_Certificate::raw_issuer_dn_sha256(), Botan::RTSS_Share::split(), and Botan::Cert_Extension::Subject_Key_ID::Subject_Key_ID().

361  {
362  if(auto hash = HashFunction::create(algo, provider))
363  {
364  return hash;
365  }
366  throw Lookup_Error("Hash", algo, provider);
367  }
virtual std::string provider() const
Definition: hash.h:58
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
Definition: hash.cpp:110
MechanismType hash

◆ final() [1/3]

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

Complete the computation and retrieve the final result.

Parameters
outThe byte array to be filled with the result. Must be of length output_length()

Definition at line 89 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().

89 { 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 96 of file buf_comp.h.

97  {
98  secure_vector<uint8_t> output(output_length());
99  final_result(output.data());
100  return output;
101  }
virtual size_t output_length() const =0

◆ final() [3/3]

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

Definition at line 111 of file buf_comp.h.

112  {
113  out.resize(output_length());
114  final_result(out.data());
115  }
virtual size_t output_length() const =0

◆ final_stdvec()

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

Definition at line 103 of file buf_comp.h.

104  {
105  std::vector<uint8_t> output(output_length());
106  final_result(output.data());
107  return output;
108  }
virtual size_t output_length() const =0

◆ 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 28 of file blake2b.h.

28 { return 128; }

◆ name()

std::string Botan::Blake2b::name ( ) const
overridevirtual
Returns
the hash function name

Implements Botan::HashFunction.

Definition at line 183 of file blake2b.cpp.

References Botan::ASN1::to_string().

184  {
185  return "Blake2b(" + std::to_string(m_output_bits) + ")";
186  }
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:210

◆ 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 29 of file blake2b.h.

29 { 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
inthe input to process as a byte array
lengththe length of the byte array
Returns
the result of the call to final()

Definition at line 124 of file buf_comp.h.

125  {
126  add_data(in, length);
127  return final();
128  }

◆ 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
inthe input to process
Returns
the result of the call to final()

Definition at line 136 of file buf_comp.h.

137  {
138  add_data(in.data(), in.size());
139  return final();
140  }

◆ 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
inthe input to process
Returns
the result of the call to final()

Definition at line 148 of file buf_comp.h.

149  {
150  add_data(in.data(), in.size());
151  return final();
152  }

◆ 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
inthe input to process as a string
Returns
the result of the call to final()

Definition at line 160 of file buf_comp.h.

References update.

161  {
162  update(in);
163  return final();
164  }
void update(const uint8_t in[], size_t length)
Definition: buf_comp.h:34

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

Definition at line 58 of file hash.h.

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

58 { 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_specalgorithm name

Definition at line 369 of file hash.cpp.

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

◆ update() [1/5]

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

Add new input to process.

Parameters
inthe input to process as a byte array
lengthof param in in bytes

Definition at line 34 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().

34 { 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
inthe input to process as a secure_vector

Definition at line 40 of file buf_comp.h.

41  {
42  add_data(in.data(), in.size());
43  }

◆ update() [3/5]

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

Add new input to process.

Parameters
inthe input to process as a std::vector

Definition at line 49 of file buf_comp.h.

50  {
51  add_data(in.data(), in.size());
52  }

◆ update() [4/5]

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

Add new input to process.

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

Definition at line 72 of file buf_comp.h.

References Botan::cast_char_ptr_to_uint8().

73  {
74  add_data(cast_char_ptr_to_uint8(str.data()), str.size());
75  }
const uint8_t * cast_char_ptr_to_uint8(const char *s)
Definition: mem_ops.h:131

◆ update() [5/5]

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

Process a single byte.

Parameters
inthe byte to process

Definition at line 81 of file buf_comp.h.

81 { add_data(&in, 1); }

◆ update_be()

template<typename T >
void Botan::Buffered_Computation::update_be ( const T  in)
inlineinherited

Add an integer in big-endian order

Parameters
inthe value

Definition at line 58 of file buf_comp.h.

References Botan::get_byte(), and T.

Referenced by Botan::pbkdf2().

59  {
60  for(size_t i = 0; i != sizeof(T); ++i)
61  {
62  uint8_t b = get_byte(i, in);
63  add_data(&b, 1);
64  }
65  }
fe T
Definition: ge.cpp:37
uint8_t get_byte(size_t byte_num, T input)
Definition: loadstor.h:39

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