Botan 3.14.1
Crypto and TLS for C&
Botan::Streebog Class Referencefinal

#include <streebog.h>

Inheritance diagram for Botan::Streebog:
Botan::HashFunction Botan::Buffered_Computation

Public Member Functions

void clear () override
HashFunction * clone () const
std::unique_ptr< HashFunction > copy_state () const override
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T final ()
void final (std::span< uint8_t > out)
template<concepts::resizable_byte_buffer T>
void final (T &out)
void final (uint8_t out[])
std::vector< uint8_t > final_stdvec ()
size_t hash_block_size () const override
std::string name () const override
std::unique_ptr< HashFunction > new_object () const override
size_t output_length () const override
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T process (const uint8_t in[], size_t length)
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T process (std::span< const uint8_t > in)
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T process (std::string_view in)
std::string provider () const override
virtual size_t security_level () const
 Streebog (size_t output_bits)
void update (const uint8_t in[], size_t length)
void update (std::span< const uint8_t > in)
void update (std::string_view 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 (std::string_view algo_spec, std::string_view provider="")
static std::unique_ptr< HashFunction > create_or_throw (std::string_view algo_spec, std::string_view provider="")
static std::vector< std::string > providers (std::string_view algo_spec)

Protected Member Functions

void add_data (std::span< const uint8_t > input) override
void compress (const uint8_t input[], bool lastblock=false)
void compress_64 (const uint64_t input[], bool lastblock=false)
void final_result (std::span< uint8_t > out) override

Detailed Description

Streebog (GOST R 34.11-2012) RFC 6986

Definition at line 21 of file streebog.h.

Constructor & Destructor Documentation

◆ Streebog()

Botan::Streebog::Streebog ( size_t output_bits)
explicit

Definition at line 73 of file streebog.cpp.

73 : m_output_bits(output_bits), m_count(0), m_h(8), m_S(8) {
74 if(output_bits != 256 && output_bits != 512) {
75 throw Invalid_Argument(fmt("Streebog: Invalid output length {}", output_bits));
76 }
77
78 clear();
79}
void clear() override
Definition streebog.cpp:98
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

References clear(), and Botan::fmt().

Member Function Documentation

◆ add_data()

void Botan::Streebog::add_data ( std::span< const uint8_t > input)
overrideprotectedvirtual

Add more data to the computation

Parameters
inputis an input buffer

Implements Botan::Buffered_Computation.

Definition at line 110 of file streebog.cpp.

110 {
111 BufferSlicer in(input);
112
113 while(!in.empty()) {
114 if(const auto one_block = m_buffer.handle_unaligned_data(in)) {
115 compress(one_block->data());
116 m_count += 512;
117 }
118
119 if(m_buffer.in_alignment()) {
120 while(const auto aligned_block = m_buffer.next_aligned_block_to_process(in)) {
121 compress(aligned_block->data());
122 m_count += 512;
123 }
124 }
125 }
126}
void compress(const uint8_t input[], bool lastblock=false)
Definition streebog.cpp:153

References compress(), and Botan::BufferSlicer::empty().

◆ clear()

void Botan::Streebog::clear ( )
overridevirtual

Reset the state.

Implements Botan::HashFunction.

Definition at line 98 of file streebog.cpp.

98 {
99 m_count = 0;
100 m_buffer.clear();
101 zeroise(m_S);
102
103 const uint64_t fill = (m_output_bits == 512) ? 0 : 0x0101010101010101;
104 std::fill(m_h.begin(), m_h.end(), fill);
105}
void zeroise(std::vector< T, Alloc > &vec)
Definition secmem.h:241

References Botan::zeroise().

Referenced by final_result(), and Streebog().

◆ clone()

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

Create a new uninitialized object of the same type

Returns
new object representing the same algorithm as *this

Definition at line 100 of file hash.h.

100{ return this->new_object().release(); }
virtual std::unique_ptr< HashFunction > new_object() const =0

References new_object().

◆ compress()

void Botan::Streebog::compress ( const uint8_t input[],
bool lastblock = false )
protected

Definition at line 153 of file streebog.cpp.

153 {
154 uint64_t M[8];
155 typecast_copy(M, std::span<const uint8_t>(input, 64));
156 compress_64(M, last_block);
157}
void compress_64(const uint64_t input[], bool lastblock=false)
Definition streebog.cpp:179
constexpr void typecast_copy(ToR &&out, const FromR &in)
Definition mem_ops.h:176

References compress_64(), and Botan::typecast_copy().

Referenced by add_data(), and final_result().

◆ compress_64()

void Botan::Streebog::compress_64 ( const uint64_t input[],
bool lastblock = false )
protected

Definition at line 179 of file streebog.cpp.

179 {
180 const uint64_t N = last_block ? 0 : force_le(m_count);
181
182#if defined(BOTAN_HAS_STREEBOG_AVX512_GFNI)
184 compress_64_avx512_gfni(m_h.data(), M, N);
185 increment_s(last_block, M, m_S.data());
186 return;
187 }
188#endif
189
190 uint64_t hN[8];
191 uint64_t A[8];
192
193 copy_mem(hN, m_h.data(), 8);
194 hN[0] ^= N;
195 lps(hN);
196
197 copy_mem(A, hN, 8);
198
199 for(size_t i = 0; i != 8; ++i) {
200 hN[i] ^= M[i];
201 }
202
203 for(size_t i = 0; i < 12; ++i) { // NOLINT(modernize-loop-convert)
204 for(size_t j = 0; j != 8; ++j) {
205 A[j] ^= force_le(STREEBOG_C[i][7 - j]);
206 }
207 lps(A);
208
209 lps(hN);
210 for(size_t j = 0; j != 8; ++j) {
211 hN[j] ^= A[j];
212 }
213 }
214
215 for(size_t i = 0; i != 8; ++i) {
216 m_h[i] ^= hN[i] ^ M[i];
217 }
218
219 increment_s(last_block, M, m_S.data());
220}
static bool has(CPUID::Feature feat)
Definition cpuid.h:93
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition mem_ops.h:144
constexpr uint64_t STREEBOG_C[12][8]

References Botan::CPUFeature::AVX512, Botan::copy_mem(), Botan::CPUFeature::GFNI, Botan::CPUID::has(), and Botan::STREEBOG_C.

Referenced by compress(), and final_result().

◆ copy_state()

std::unique_ptr< HashFunction > Botan::Streebog::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 69 of file streebog.cpp.

69 {
70 return std::make_unique<Streebog>(*this);
71}

◆ create()

std::unique_ptr< HashFunction > Botan::HashFunction::create ( std::string_view algo_spec,
std::string_view 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 112 of file hash.cpp.

112 {
113#if defined(BOTAN_HAS_COMMONCRYPTO)
114 if(provider.empty() || provider == "commoncrypto") {
115 if(auto hash = make_commoncrypto_hash(algo_spec))
116 return hash;
117
118 if(!provider.empty())
119 return nullptr;
120 }
121#endif
122
123 if(provider.empty() == false && provider != "base") {
124 return nullptr; // unknown provider
125 }
126
127#if defined(BOTAN_HAS_SHA1)
128 if(algo_spec == "SHA-1") {
129 return std::make_unique<SHA_1>();
130 }
131#endif
132
133#if defined(BOTAN_HAS_SHA2_32)
134 if(algo_spec == "SHA-224") {
135 return std::make_unique<SHA_224>();
136 }
137
138 if(algo_spec == "SHA-256") {
139 return std::make_unique<SHA_256>();
140 }
141#endif
142
143#if defined(BOTAN_HAS_SHA2_64)
144 if(algo_spec == "SHA-384") {
145 return std::make_unique<SHA_384>();
146 }
147
148 if(algo_spec == "SHA-512") {
149 return std::make_unique<SHA_512>();
150 }
151
152 if(algo_spec == "SHA-512-256") {
153 return std::make_unique<SHA_512_256>();
154 }
155#endif
156
157#if defined(BOTAN_HAS_RIPEMD_160)
158 if(algo_spec == "RIPEMD-160") {
159 return std::make_unique<RIPEMD_160>();
160 }
161#endif
162
163#if defined(BOTAN_HAS_WHIRLPOOL)
164 if(algo_spec == "Whirlpool") {
165 return std::make_unique<Whirlpool>();
166 }
167#endif
168
169#if defined(BOTAN_HAS_MD5)
170 if(algo_spec == "MD5") {
171 return std::make_unique<MD5>();
172 }
173#endif
174
175#if defined(BOTAN_HAS_MD4)
176 if(algo_spec == "MD4") {
177 return std::make_unique<MD4>();
178 }
179#endif
180
181#if defined(BOTAN_HAS_GOST_34_11)
182 if(algo_spec == "GOST-R-34.11-94" || algo_spec == "GOST-34.11") {
183 return std::make_unique<GOST_34_11>();
184 }
185#endif
186
187#if defined(BOTAN_HAS_ADLER32)
188 if(algo_spec == "Adler32") {
189 return std::make_unique<Adler32>();
190 }
191#endif
192
193#if defined(BOTAN_HAS_ASCON_HASH256)
194 if(algo_spec == "Ascon-Hash256") {
195 return std::make_unique<Ascon_Hash256>();
196 }
197#endif
198
199#if defined(BOTAN_HAS_CRC24)
200 if(algo_spec == "CRC24") {
201 return std::make_unique<CRC24>();
202 }
203#endif
204
205#if defined(BOTAN_HAS_CRC32)
206 if(algo_spec == "CRC32") {
207 return std::make_unique<CRC32>();
208 }
209#endif
210
211#if defined(BOTAN_HAS_STREEBOG)
212 if(algo_spec == "Streebog-256") {
213 return std::make_unique<Streebog>(256);
214 }
215 if(algo_spec == "Streebog-512") {
216 return std::make_unique<Streebog>(512);
217 }
218#endif
219
220#if defined(BOTAN_HAS_SM3)
221 if(algo_spec == "SM3") {
222 return std::make_unique<SM3>();
223 }
224#endif
225
226 const AlgorithmSpec req(algo_spec);
227
228#if defined(BOTAN_HAS_SKEIN_512)
229 if(auto m = req.match("Skein-512({bits:int=512},{personalization:str=})")) {
230 return std::make_unique<Skein_512>(m->integer("bits"), m->str("personalization"));
231 }
232#endif
233
234#if defined(BOTAN_HAS_BLAKE2B)
235 if(auto m = req.match("BLAKE2b|Blake2b({bits:int=512})")) {
236 return std::make_unique<BLAKE2b>(m->integer("bits"));
237 }
238#endif
239
240#if defined(BOTAN_HAS_BLAKE2S)
241 if(auto m = req.match("BLAKE2s|Blake2s({bits:int=256})")) {
242 return std::make_unique<BLAKE2s>(m->integer("bits"));
243 }
244#endif
245
246#if defined(BOTAN_HAS_KECCAK)
247 if(auto m = req.match("Keccak-1600({bits:int=512})")) {
248 return std::make_unique<Keccak_1600>(m->integer("bits"));
249 }
250#endif
251
252#if defined(BOTAN_HAS_SHA3)
253 if(auto m = req.match("SHA-3({bits:int=512})")) {
254 return std::make_unique<SHA_3>(m->integer("bits"));
255 }
256#endif
257
258#if defined(BOTAN_HAS_SHAKE)
259 if(auto m = req.match("SHAKE-128({bits:int})")) {
260 return std::make_unique<SHAKE_128>(m->integer("bits"));
261 }
262 if(auto m = req.match("SHAKE-256({bits:int})")) {
263 return std::make_unique<SHAKE_256>(m->integer("bits"));
264 }
265#endif
266
267#if defined(BOTAN_HAS_PARALLEL_HASH)
268 if(auto m = req.match("Parallel({hash}...)")) {
269 std::vector<std::unique_ptr<HashFunction>> hashes;
270
271 for(const auto& hash_spec : m->rest("hash")) {
272 auto h = HashFunction::create(hash_spec.to_string());
273 if(!h) {
274 return nullptr;
275 }
276 hashes.push_back(std::move(h));
277 }
278
279 return std::make_unique<Parallel>(hashes);
280 }
281#endif
282
283#if defined(BOTAN_HAS_TRUNCATED_HASH)
284 if(auto m = req.match("Truncated({hash},{bits:int})")) {
285 auto hash = HashFunction::create(m->str("hash"));
286 if(!hash) {
287 return nullptr;
288 }
289
290 return std::make_unique<Truncated_Hash>(std::move(hash), m->integer("bits"));
291 }
292#endif
293
294#if defined(BOTAN_HAS_COMB4P)
295 if(auto m = req.match("Comb4P({hash1},{hash2})")) {
296 auto h1 = HashFunction::create(m->str("hash1"));
297 auto h2 = HashFunction::create(m->str("hash2"));
298
299 if(h1 && h2) {
300 return std::make_unique<Comb4P>(std::move(h1), std::move(h2));
301 }
302 }
303#endif
304
305 BOTAN_UNUSED(req);
306
307 return nullptr;
308}
#define BOTAN_UNUSED
Definition assert.h:151
virtual std::string provider() const
Definition hash.h:51
static std::unique_ptr< HashFunction > create(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:112
std::unique_ptr< HashFunction > make_commoncrypto_hash(std::string_view name)

References BOTAN_UNUSED, create(), Botan::make_commoncrypto_hash(), Botan::AlgorithmSpec::match(), and provider().

Referenced by botan_hash_init(), Botan::BlockCipher::create(), create(), Botan::KDF::create(), Botan::MessageAuthenticationCode::create(), Botan::PasswordHashFamily::create(), Botan::PBKDF::create(), create_or_throw(), Botan::SignaturePaddingScheme::create_or_throw(), and Botan::EC_Group_Data::hash_to_curve_supported().

◆ create_or_throw()

std::unique_ptr< HashFunction > Botan::HashFunction::create_or_throw ( std::string_view algo_spec,
std::string_view 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 311 of file hash.cpp.

311 {
312 if(auto hash = HashFunction::create(algo, provider)) {
313 return hash;
314 }
315 throw Lookup_Error("Hash", algo, provider);
316}

References create(), and provider().

Referenced by botan_pubkey_fingerprint(), botan_pubkey_sm2_compute_za(), Botan::OCSP::CertID::CertID(), Botan::TLS::Client_Hello_Internal::Client_Hello_Internal(), Botan::SPAKE2p::SystemParameters::confirmation_size(), Botan::Kyber_90s_Symmetric_Primitives::create_G(), Botan::Kyber_Modern_Symmetric_Primitives::create_G(), Botan::ML_KEM_Symmetric_Primitives::create_G(), Botan::Kyber_90s_Symmetric_Primitives::create_H(), Botan::Kyber_Modern_Symmetric_Primitives::create_H(), Botan::ML_KEM_Symmetric_Primitives::create_H(), Botan::create_hex_fingerprint(), Botan::ML_KEM_Symmetric_Primitives::create_J(), Botan::Kyber_90s_Symmetric_Primitives::create_KDF(), Botan::Kyber_Modern_Symmetric_Primitives::create_KDF(), Botan::Sodium::crypto_hash_sha256(), Botan::Sodium::crypto_hash_sha512(), Botan::TLS::PSKImporter::derive_imported_psk(), Botan::Bcrypt_PBKDF::derive_key(), Botan::PKCS12::export_to(), Botan::TLS::Handshake_Hash::final(), Botan::X509_Certificate_Cache::find_or_insert(), Botan::generate_dsa_primes(), Botan::h2c_expand_message(), Botan::LMOTS_Params::hash(), Botan::LMS_Params::hash(), Botan::Classic_McEliece_Parameters::hash_func(), Botan::Stateful_Key_Index_Registry::KeyId::KeyId(), Botan::TLS::make_hello_random(), Botan::Roughtime::nonce_from_blind(), Botan::OAEP::OAEP(), Botan::PKCS1v15_Raw_SignaturePaddingScheme::PKCS1v15_Raw_SignaturePaddingScheme(), Botan::TLS::Transcript_Hash_State::set_algorithm(), Botan::RTSS_Share::split(), Botan::srp6_client_agree(), Botan::srp6_generate_verifier(), Botan::SRP6_Server_Session::step1(), Botan::SRP6_Server_Session::step2(), Botan::Cert_Extension::Subject_Key_ID::Subject_Key_ID(), Botan::Cert_Extension::Subject_Key_ID::Subject_Key_ID(), and Botan::PK_Ops::Verification_with_Hash::Verification_with_Hash().

◆ final() [1/4]

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T Botan::Buffered_Computation::final ( )
inlineinherited

Complete the computation and retrieve the final result as a container.

Returns
a contiguous container holding the result

Definition at line 104 of file buf_comp.h.

104 {
105 T output(output_length());
106 final_result(output);
107 return output;
108 }
virtual size_t output_length() const =0

References output_length().

◆ final() [2/4]

void Botan::Buffered_Computation::final ( std::span< uint8_t > out)
inherited

Complete the computation and retrieve the final result

Parameters
outthe buffer to write the result to, must be output_length() bytes

Definition at line 54 of file buf_comp.cpp.

54 {
55 BOTAN_ARG_CHECK(out.size() >= output_length(), "Output buffer has insufficient capacity");
56 // Pass exactly output_length() bytes so that an oversized buffer has the
57 // result written to its leading bytes with the remainder left untouched.
58 final_result(out.first(output_length()));
59}
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:33

References BOTAN_ARG_CHECK, and output_length().

◆ final() [3/4]

template<concepts::resizable_byte_buffer T>
void Botan::Buffered_Computation::final ( T & out)
inlineinherited

Complete the computation and retrieve the final result

Parameters
outa container which is resized to hold the result

Definition at line 127 of file buf_comp.h.

127 {
128 out.resize(output_length());
129 final_result(out);
130 }

References output_length().

◆ final() [4/4]

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, which must be of length output_length()

Definition at line 97 of file buf_comp.h.

97{ final_result({out, output_length()}); }

References output_length().

Referenced by Botan::expand_message_xmd(), final_stdvec(), Botan::PseudorandomKeyGeneration::gen(), Botan::TPM2::Verification_Operation::is_valid_signature(), Botan::mgf1_mask(), Botan::KMAC::operator=(), Botan::pbkdf2(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), process(), process(), process(), and Botan::TPM2::Signature_Operation::sign().

◆ final_result()

void Botan::Streebog::final_result ( std::span< uint8_t > out)
overrideprotectedvirtual

Write the final output to out

Parameters
outis an output buffer of output_length()

Implements Botan::Buffered_Computation.

Definition at line 131 of file streebog.cpp.

131 {
132 const auto pos = m_buffer.elements_in_buffer();
133
134 const uint8_t padding = 0x01;
135 m_buffer.append({&padding, 1});
136 m_buffer.fill_up_with_zeros();
137
138 compress(m_buffer.consume().data());
139 m_count += pos * 8;
140
141 m_buffer.fill_up_with_zeros();
142 store_le(m_count, m_buffer.directly_modify_first(sizeof(m_count)).data());
143 compress(m_buffer.consume().data(), true);
144
145 compress_64(m_S.data(), true);
146
147 const size_t offset = 8 - output_length() / 8;
148 const size_t count = output_length() / sizeof(uint64_t);
149 typecast_copy(output, std::span<const uint64_t>(&m_h[offset], count));
150 clear();
151}
size_t output_length() const override
Definition streebog.h:23
constexpr auto store_le(ParamTs &&... params)
Definition loadstor.h:736

References clear(), compress(), compress_64(), output_length(), Botan::store_le(), and Botan::typecast_copy().

◆ final_stdvec()

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

Complete the computation and retrieve the final result

Returns
a std::vector holding the result

Definition at line 114 of file buf_comp.h.

114{ return final<std::vector<uint8_t>>(); }
void final(uint8_t out[])
Definition buf_comp.h:97

References final().

Referenced by Botan::expand_message_xmd().

◆ hash_block_size()

size_t Botan::Streebog::hash_block_size ( ) const
inlineoverridevirtual

Return the internal block size of this hash function

Returns
hash block size as defined for this algorithm

Reimplemented from Botan::HashFunction.

Definition at line 31 of file streebog.h.

31{ return 64; }

◆ name()

std::string Botan::Streebog::name ( ) const
overridevirtual

Return the name of this hash function

Returns
the hash function name

Implements Botan::HashFunction.

Definition at line 81 of file streebog.cpp.

81 {
82 return fmt("Streebog-{}", m_output_bits);
83}

References Botan::fmt().

◆ new_object()

std::unique_ptr< HashFunction > Botan::Streebog::new_object ( ) const
inlineoverridevirtual

Create a new uninitialized object of the same type

Returns
new object representing the same algorithm as *this

Implements Botan::HashFunction.

Definition at line 25 of file streebog.h.

25{ return std::make_unique<Streebog>(m_output_bits); }

◆ output_length()

size_t Botan::Streebog::output_length ( ) const
inlineoverridevirtual

Return the output length of this function

Returns
length of the output of this function in bytes

Implements Botan::Buffered_Computation.

Definition at line 23 of file streebog.h.

23{ return m_output_bits / 8; }

Referenced by final_result().

◆ process() [1/3]

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
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 140 of file buf_comp.h.

140 {
141 update(in, length);
142 return final<T>();
143 }
void update(const uint8_t in[], size_t length)
Definition buf_comp.h:35

References final(), and update().

◆ process() [2/3]

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T Botan::Buffered_Computation::process ( std::span< const uint8_t > in)
inlineinherited

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

Parameters
inthe input to process as a contiguous container
Returns
the result of the call to final()

Definition at line 164 of file buf_comp.h.

164 {
165 update(in);
166 return final<T>();
167 }

References final(), and update().

◆ process() [3/3]

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T Botan::Buffered_Computation::process ( std::string_view 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 152 of file buf_comp.h.

152 {
153 update(in);
154 return final<T>();
155 }

References final(), and update().

◆ provider()

std::string Botan::Streebog::provider ( ) const
overridevirtual

Return the name of the provider implementing this object

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

Reimplemented from Botan::HashFunction.

Definition at line 85 of file streebog.cpp.

85 {
86#if defined(BOTAN_HAS_STREEBOG_AVX512_GFNI)
88 return *feat;
89 }
90#endif
91
92 return "base";
93}
static std::optional< std::string > check(CPUID::Feature feat)
Definition cpuid.h:66

References Botan::CPUFeature::AVX512, Botan::CPUID::check(), and Botan::CPUFeature::GFNI.

◆ providers()

std::vector< std::string > Botan::HashFunction::providers ( std::string_view algo_spec)
staticinherited

List the providers available for a given hash

Returns
list of available providers for this algorithm, empty if not available
Parameters
algo_specalgorithm name

Definition at line 318 of file hash.cpp.

318 {
319 return probe_providers_of<HashFunction>(algo_spec, {"base", "commoncrypto"});
320}
std::vector< std::string > probe_providers_of(std::string_view algo_spec, const std::vector< std::string > &possible={"base"})

References Botan::probe_providers_of().

◆ security_level()

virtual size_t Botan::HashFunction::security_level ( ) const
inlinevirtualinherited

Return an estimate, in bits, of the security level of this hash function, with respect to collision resistance. For most hashes this is simply half the output length, matching the generic birthday attack. It is lower for hash functions with a known collision attack, and zero for checksums and any hash where finding collisions is trivial.

Reimplemented in Botan::Adler32, Botan::Comb4P, Botan::CRC24, Botan::CRC32, Botan::GOST_34_11, Botan::MD4, Botan::MD5, Botan::Parallel, Botan::SHA_1, Botan::SHAKE_128, Botan::SHAKE_256, Botan::TPM2::HashFunction, and Botan::Truncated_Hash.

Definition at line 77 of file hash.h.

77{ return 4 * output_length(); }

References Botan::Buffered_Computation::output_length().

Referenced by Botan::TPM2::HashFunction::security_level().

◆ update() [1/4]

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 35 of file buf_comp.h.

35{ add_data({in, length}); }

Referenced by Botan::expand_message_xmd(), Botan::PseudorandomKeyGeneration::gen(), Botan::mgf1_mask(), Botan::pbkdf2(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), process(), process(), and process().

◆ update() [2/4]

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

Add new input to process.

Parameters
inthe input to process as a contiguous data range

Definition at line 41 of file buf_comp.h.

41{ add_data(in); }

◆ update() [3/4]

void Botan::Buffered_Computation::update ( std::string_view str)
inherited

Add new input to process.

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

Definition at line 14 of file buf_comp.cpp.

14 {
15 add_data(as_span_of_bytes(str));
16}
std::span< const uint8_t > as_span_of_bytes(const char *s, size_t len)
Definition mem_utils.h:59

References Botan::as_span_of_bytes().

◆ update() [4/4]

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

Process a single byte.

Parameters
inthe byte to process

Definition at line 90 of file buf_comp.h.

90{ add_data({&in, 1}); }

◆ update_be() [1/3]

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

Add new input to process, encoded as a big-endian integer

Parameters
valthe value to process

Definition at line 18 of file buf_comp.cpp.

18 {
19 uint8_t inb[sizeof(val)];
20 store_be(val, inb);
21 add_data({inb, sizeof(inb)});
22}
constexpr auto store_be(ParamTs &&... params)
Definition loadstor.h:745

References Botan::store_be().

Referenced by Botan::expand_message_xmd(), Botan::mgf1_mask(), and Botan::pbkdf2().

◆ update_be() [2/3]

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

Add new input to process, encoded as a big-endian integer

Parameters
valthe value to process

Definition at line 24 of file buf_comp.cpp.

24 {
25 uint8_t inb[sizeof(val)];
26 store_be(val, inb);
27 add_data({inb, sizeof(inb)});
28}

References Botan::store_be().

◆ update_be() [3/3]

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

Add new input to process, encoded as a big-endian integer

Parameters
valthe value to process

Definition at line 30 of file buf_comp.cpp.

30 {
31 uint8_t inb[sizeof(val)];
32 store_be(val, inb);
33 add_data({inb, sizeof(inb)});
34}

References Botan::store_be().

◆ update_le() [1/3]

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

Add new input to process, encoded as a little-endian integer

Parameters
valthe value to process

Definition at line 36 of file buf_comp.cpp.

36 {
37 uint8_t inb[sizeof(val)];
38 store_le(val, inb);
39 add_data({inb, sizeof(inb)});
40}

References Botan::store_le().

◆ update_le() [2/3]

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

Add new input to process, encoded as a little-endian integer

Parameters
valthe value to process

Definition at line 42 of file buf_comp.cpp.

42 {
43 uint8_t inb[sizeof(val)];
44 store_le(val, inb);
45 add_data({inb, sizeof(inb)});
46}

References Botan::store_le().

◆ update_le() [3/3]

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

Add new input to process, encoded as a little-endian integer

Parameters
valthe value to process

Definition at line 48 of file buf_comp.cpp.

48 {
49 uint8_t inb[sizeof(val)];
50 store_le(val, inb);
51 add_data({inb, sizeof(inb)});
52}

References Botan::store_le().


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