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

#include <keccak.h>

Inheritance diagram for Botan::Keccak_1600:
Botan::HashFunction Botan::Buffered_Computation

Public Member Functions

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
 
 Keccak_1600 (size_t output_bits=512)
 
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

Keccak[1600], a SHA-3 candidate

Definition at line 20 of file keccak.h.

Constructor & Destructor Documentation

◆ Keccak_1600()

Botan::Keccak_1600::Keccak_1600 ( size_t  output_bits = 512)
explicit
Parameters
output_bitsthe size of the hash output; must be one of 224, 256, 384, or 512

Definition at line 19 of file keccak.cpp.

References Botan::ASN1::to_string().

Referenced by clone(), and copy_state().

19  :
20  m_output_bits(output_bits),
21  m_bitrate(1600 - 2*output_bits),
22  m_S(25),
23  m_S_pos(0)
24  {
25  // We only support the parameters for the SHA-3 proposal
26 
27  if(output_bits != 224 && output_bits != 256 &&
28  output_bits != 384 && output_bits != 512)
29  throw Invalid_Argument("Keccak_1600: Invalid output length " +
30  std::to_string(output_bits));
31  }
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:108

Member Function Documentation

◆ clear()

void Botan::Keccak_1600::clear ( )
overridevirtual

Reset the state.

Implements Botan::HashFunction.

Definition at line 43 of file keccak.cpp.

References Botan::SHA_3::absorb(), Botan::get_byte(), and Botan::zeroise().

44  {
45  zeroise(m_S);
46  m_S_pos = 0;
47  }
void zeroise(std::vector< T, Alloc > &vec)
Definition: secmem.h:181

◆ clone()

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

Implements Botan::HashFunction.

Definition at line 38 of file keccak.cpp.

References Keccak_1600().

39  {
40  return new Keccak_1600(m_output_bits);
41  }
Keccak_1600(size_t output_bits=512)
Definition: keccak.cpp:19

◆ copy_state()

std::unique_ptr< HashFunction > Botan::Keccak_1600::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 14 of file keccak.cpp.

References Keccak_1600().

15  {
16  return std::unique_ptr<HashFunction>(new Keccak_1600(*this));
17  }
Keccak_1600(size_t output_bits=512)
Definition: keccak.cpp:19

◆ 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 hash, Botan::make_bearssl_hash(), and Botan::make_openssl_hash().

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

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

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

Referenced by botan_pubkey_sm2_compute_za(), Botan::OCSP::CertID::CertID(), Botan::choose_sig_format(), Botan::create_hex_fingerprint(), Botan::TLS::Handshake_Hash::final(), Botan::generate_dsa_primes(), Botan::make_hash_function(), 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().

347  {
348  if(auto hash = HashFunction::create(algo, provider))
349  {
350  return hash;
351  }
352  throw Lookup_Error("Hash", algo, provider);
353  }
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:106
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_hash_final(), 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(), Botan::mgf1_mask(), Botan::pbkdf2(), Botan::sm2_compute_za(), and Botan::TLS_PRF::TLS_PRF().

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::Keccak_1600::hash_block_size ( ) const
inlineoverridevirtual
Returns
hash block size as defined for this algorithm

Reimplemented from Botan::HashFunction.

Definition at line 30 of file keccak.h.

30 { return m_bitrate / 8; }

◆ name()

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

Implements Botan::HashFunction.

Definition at line 33 of file keccak.cpp.

References Botan::ASN1::to_string().

34  {
35  return "Keccak-1600(" + std::to_string(m_output_bits) + ")";
36  }
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:108

◆ output_length()

size_t Botan::Keccak_1600::output_length ( ) const
inlineoverridevirtual
Returns
length of the output of this function in bytes

Implements Botan::Buffered_Computation.

Definition at line 31 of file keccak.h.

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

Referenced by Botan::TLS_PRF::TLS_PRF().

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.

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.

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 355 of file hash.cpp.

Referenced by Botan::TLS::Ciphersuite::by_id(), and Botan::get_hash_function_providers().

356  {
357  return probe_providers_of<HashFunction>(algo_spec, {"base", "bearssl", "openssl"});
358  }

◆ update() [1/5]

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

◆ 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:120

◆ 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::mgf1_mask(), and 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: