Botan 3.9.0
Crypto and TLS for C&
|
#include <stateful_rng.h>
Public Member Functions | |
bool | accepts_input () const final |
void | add_entropy (const uint8_t input[], size_t length) |
void | add_entropy (std::span< const uint8_t > input) |
template<typename T> requires std::is_standard_layout_v<T> && std::is_trivial_v<T> | |
void | add_entropy_T (const T &t) |
void | clear () final |
void | force_reseed () |
void | initialize_with (const uint8_t input[], size_t length) |
void | initialize_with (std::span< const uint8_t > input) |
bool | is_seeded () const final |
virtual size_t | max_number_of_bytes_per_request () const =0 |
virtual std::string | name () const =0 |
uint8_t | next_byte () |
uint8_t | next_nonzero_byte () |
template<size_t bytes> | |
std::array< uint8_t, bytes > | random_array () |
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>> requires std::default_initializable<T> | |
T | random_vec (size_t bytes) |
void | random_vec (std::span< uint8_t > v) |
template<concepts::resizable_byte_buffer T> | |
void | random_vec (T &v, size_t bytes) |
void | randomize (std::span< uint8_t > output) |
void | randomize (uint8_t output[], size_t length) |
void | randomize_with_input (std::span< uint8_t > output, std::span< const uint8_t > input) |
void | randomize_with_input (uint8_t output[], size_t output_len, const uint8_t input[], size_t input_len) |
void | randomize_with_ts_input (std::span< uint8_t > output) |
void | randomize_with_ts_input (uint8_t output[], size_t output_len) |
size_t | reseed (Entropy_Sources &srcs, size_t poll_bits=RandomNumberGenerator::DefaultPollBits, std::chrono::milliseconds poll_timeout=RandomNumberGenerator::DefaultPollTimeout) override |
void | reseed_from_rng (RandomNumberGenerator &rng, size_t poll_bits=RandomNumberGenerator::DefaultPollBits) final |
size_t | reseed_interval () const |
virtual size_t | security_level () const =0 |
Stateful_RNG () | |
Stateful_RNG (Entropy_Sources &entropy_sources, size_t reseed_interval) | |
Stateful_RNG (RandomNumberGenerator &rng, Entropy_Sources &entropy_sources, size_t reseed_interval) | |
Stateful_RNG (RandomNumberGenerator &rng, size_t reseed_interval) |
Static Public Attributes | |
static constexpr size_t | DefaultPollBits = 256 |
static constexpr auto | DefaultPollTimeout = std::chrono::milliseconds(50) |
static constexpr size_t | DefaultReseedInterval = 1024 |
Protected Member Functions | |
virtual void | clear_state ()=0 |
virtual void | generate_output (std::span< uint8_t > output, std::span< const uint8_t > input)=0 |
void | reseed_check () |
virtual void | update (std::span< const uint8_t > input)=0 |
Inherited by RNGs which maintain in-process state, like HMAC_DRBG. On Unix these RNGs are vulnerable to problems with fork, where the RNG state is duplicated, and the parent and child process RNGs will produce identical output until one of them reseeds. Stateful_RNG reseeds itself whenever a fork is detected, or after a set number of bytes have been output.
Not implemented by RNGs which access an external RNG, such as the system PRNG or a hardware RNG.
Definition at line 26 of file stateful_rng.h.
|
inline |
rng | is a reference to some RNG which will be used to perform the periodic reseeding |
entropy_sources | will be polled to perform reseeding periodically |
reseed_interval | specifies a limit of how many times the RNG will be called before automatic reseeding is performed |
Definition at line 35 of file stateful_rng.h.
References Botan::RandomNumberGenerator::RandomNumberGenerator(), and reseed_interval().
Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::HMAC_DRBG::HMAC_DRBG(), Botan::HMAC_DRBG::HMAC_DRBG(), and Botan::HMAC_DRBG::HMAC_DRBG().
|
inline |
rng | is a reference to some RNG which will be used to perform the periodic reseeding |
reseed_interval | specifies a limit of how many times the RNG will be called before automatic reseeding is performed |
Definition at line 44 of file stateful_rng.h.
References Botan::RandomNumberGenerator::RandomNumberGenerator(), and reseed_interval().
|
inline |
entropy_sources | will be polled to perform reseeding periodically |
reseed_interval | specifies a limit of how many times the RNG will be called before automatic reseeding is performed |
Definition at line 52 of file stateful_rng.h.
References reseed_interval().
|
inline |
In this case, automatic reseeding is impossible
Definition at line 58 of file stateful_rng.h.
|
inlinefinalvirtual |
Returns false if it is known that this RNG object is not able to accept externally provided inputs (via add_entropy, randomize_with_input, etc). In this case, any such provided inputs are ignored.
If this function returns true, then inputs may or may not be accepted.
Implements Botan::RandomNumberGenerator.
Definition at line 71 of file stateful_rng.h.
References accepts_input().
Referenced by accepts_input().
|
inlineinherited |
Definition at line 96 of file rng.h.
References add_entropy().
Referenced by add_entropy().
|
inlineinherited |
Incorporate some additional data into the RNG state. For example adding nonces or timestamps from a peer's protocol message can help hedge against VM state rollback attacks. A few RNG types do not accept any externally provided input, in which case this function is a no-op.
input | a byte array containing the entropy to be added |
Definition at line 94 of file rng.h.
References fill_bytes_with_input().
Referenced by add_entropy_T(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::Stateful_RNG::initialize_with(), Botan::Getentropy::poll(), Botan::Intel_Rdseed::poll(), and reseed_from_rng().
|
inlineinherited |
Incorporate some additional data into the RNG state.
Definition at line 103 of file rng.h.
References add_entropy().
Referenced by Botan::Win32_EntropySource::poll().
|
finalvirtual |
Clear all internally held values of this RNG
Implements Botan::RandomNumberGenerator.
Definition at line 14 of file stateful_rng.cpp.
References clear_state(), and Botan::lock().
Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::HMAC_DRBG::HMAC_DRBG(), Botan::HMAC_DRBG::HMAC_DRBG(), Botan::HMAC_DRBG::HMAC_DRBG(), Botan::HMAC_DRBG::HMAC_DRBG(), Botan::HMAC_DRBG::HMAC_DRBG(), and initialize_with().
|
protectedpure virtual |
References clear_state(), and Botan::RandomNumberGenerator::RandomNumberGenerator().
Referenced by clear(), and clear_state().
void Botan::Stateful_RNG::force_reseed | ( | ) |
Mark state as requiring a reseed on next use
Definition at line 21 of file stateful_rng.cpp.
References Botan::lock().
|
protectedpure virtual |
References generate_output().
Referenced by generate_output().
|
inline |
Definition at line 67 of file stateful_rng.h.
References initialize_with().
Referenced by initialize_with().
void Botan::Stateful_RNG::initialize_with | ( | std::span< const uint8_t > | input | ) |
Consume this input and mark the RNG as initialized regardless of the length of the input or the current seeded state of the RNG.
Definition at line 31 of file stateful_rng.cpp.
References Botan::RandomNumberGenerator::add_entropy(), clear(), and Botan::lock().
|
finalvirtual |
Check whether this RNG is seeded.
Implements Botan::RandomNumberGenerator.
Definition at line 26 of file stateful_rng.cpp.
References Botan::lock().
Referenced by reseed_check().
|
pure virtual |
Some DRBGs have a notion of the maximum number of bytes per request. Longer requests (to randomize) will be treated as multiple requests, and may initiate reseeding multiple times, depending on the values of max_number_of_bytes_per_request and reseed_interval(). This function returns zero if the RNG in question does not have such a notion.
Implemented in Botan::ChaCha_RNG, and Botan::HMAC_DRBG.
|
pure virtualinherited |
Implemented in Botan::AutoSeeded_RNG, Botan::ChaCha_RNG, Botan::ESDM_RNG, Botan::HMAC_DRBG, Botan::Jitter_RNG, Botan::Null_RNG, Botan::PKCS11::PKCS11_RNG, Botan::Processor_RNG, Botan::System_RNG, Botan::TPM2::RandomNumberGenerator, and Botan::TPM_RNG.
Referenced by Botan::System_RNG::name(), and Botan::Stateful_RNG::reseed_check().
|
inlineinherited |
Return a random byte
PRNG_Unseeded | if the RNG fails because it has not enough entropy |
Exception | if the RNG fails |
Definition at line 247 of file rng.h.
References fill_bytes_with_input().
Referenced by next_nonzero_byte(), and Botan::random_prime().
|
inlineinherited |
PRNG_Unseeded | if the RNG fails because it has not enough entropy |
Exception | if the RNG fails |
Definition at line 258 of file rng.h.
References next_byte().
|
inlineinherited |
Create a std::array of bytes
random bytes
Definition at line 235 of file rng.h.
References random_vec().
|
inlineinherited |
Create some byte container type and fill it with some random bytes
.
T | the desired byte container type (e.g std::vector<uint8_t>) |
bytes | number of random bytes to initialize the container with |
bytes
random bytes Definition at line 225 of file rng.h.
References random_vec().
|
inlineinherited |
Fill a given byte container with bytes
random bytes
v | the container to be filled with bytes random bytes |
Definition at line 199 of file rng.h.
References randomize().
Referenced by Botan::Classic_McEliece_PrivateKey::Classic_McEliece_PrivateKey(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::PK_Decryptor::decrypt_or_random(), Botan::Dilithium_PrivateKey::Dilithium_PrivateKey(), Botan::Ed25519_PrivateKey::Ed25519_PrivateKey(), Botan::Kyber_KEM_Encryptor::encapsulate(), Botan::ML_KEM_Encryptor::encapsulate(), Botan::TLS::Session::encrypt(), Botan::KeyPair::encryption_consistency_check(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), Botan::generate_bcrypt(), Botan::HSS_LMS_PrivateKeyInternal::HSS_LMS_PrivateKeyInternal(), Botan::Kyber_PrivateKey::Kyber_PrivateKey(), Botan::TLS::make_hello_random(), Botan::OctetString::OctetString(), random_array(), random_vec(), random_vec(), Botan::BigInt::randomize(), reseed_from_rng(), Botan::SphincsPlus_PrivateKey::SphincsPlus_PrivateKey(), and Botan::X25519_PrivateKey::X25519_PrivateKey().
|
inlineinherited |
Resize a given byte container to bytes
and fill it with random bytes
T | the desired byte container type (e.g std::vector<uint8_t>) |
v | the container to be filled with bytes random bytes |
bytes | number of random bytes to initialize the container with |
Definition at line 210 of file rng.h.
References random_vec().
|
inlineinherited |
Randomize a byte array.
May block shortly if e.g. the RNG is not yet initialized or a retry because of insufficient entropy is needed.
output | the byte array to hold the random output. |
PRNG_Unseeded | if the RNG fails because it has not enough entropy |
Exception | if the RNG fails |
Definition at line 71 of file rng.h.
References fill_bytes_with_input().
Referenced by Botan::TLS::Connection_Cipher_State::aead_nonce(), Botan::argon2_generate_pwhash(), Botan::BlindedScalarBits< C, WindowBits+1 >::BlindedScalarBits(), botan_system_rng_get(), Botan::CryptoBox::encrypt(), Botan::generate_dsa_primes(), Botan::generate_passhash9(), Botan::IntMod< MontgomeryRep< ScalarParams > >::random(), Botan::random_gf2m(), Botan::McEliece_PublicKey::random_plaintext_element(), Botan::random_prime(), random_vec(), Botan::Sodium::randombytes_buf(), randomize_with_ts_input(), Botan::KeyPair::signature_consistency_check(), Botan::RTSS_Share::split(), and Botan::UUID::UUID().
|
inlineinherited |
Definition at line 73 of file rng.h.
References randomize().
Referenced by randomize().
|
inlineinherited |
Incorporate entropy into the RNG state then produce output. Some RNG types implement this using a single operation, default calls add_entropy + randomize in sequence.
Use this to further bind the outputs to your current process/protocol state. For instance if generating a new key for use in a session, include a session ID or other such value. See NIST SP 800-90 A, B, C series for more ideas.
output | buffer to hold the random output |
input | entropy buffer to incorporate |
PRNG_Unseeded | if the RNG fails because it has not enough entropy |
Exception | if the RNG fails |
Exception | may throw if the RNG accepts input, but adding the entropy failed. |
Definition at line 123 of file rng.h.
References fill_bytes_with_input().
Referenced by Botan::System_RNG::fill_bytes_with_input(), and randomize_with_input().
|
inlineinherited |
Definition at line 127 of file rng.h.
References randomize_with_input().
|
inherited |
This calls randomize_with_input using some timestamps as extra input.
For a stateful RNG using non-random but potentially unique data the extra input can help protect against problems with fork, VM state rollback, or other cases where somehow an RNG state is duplicated. If both of the duplicated RNG states later incorporate a timestamp (and the timestamps don't themselves repeat), their outputs will diverge.
output | buffer to hold the random output |
PRNG_Unseeded | if the RNG fails because it has not enough entropy |
Exception | if the RNG fails |
Exception | may throw if the RNG accepts input, but adding the entropy failed. |
Definition at line 27 of file rng.cpp.
References accepts_input(), BOTAN_UNUSED, fill_bytes_with_input(), Botan::OS::get_high_resolution_clock(), Botan::OS::get_process_id(), randomize(), Botan::store_le(), and Botan::system_rng().
Referenced by randomize_with_ts_input().
|
inlineinherited |
Definition at line 147 of file rng.h.
References randomize_with_ts_input().
|
overridevirtual |
Poll provided sources for up to poll_bits bits of entropy or until the timeout expires. Returns estimate of the number of bits collected.
Reimplemented from Botan::RandomNumberGenerator.
Definition at line 77 of file stateful_rng.cpp.
References Botan::lock(), Botan::RandomNumberGenerator::reseed(), and security_level().
Referenced by reseed_check().
|
protected |
Definition at line 104 of file stateful_rng.cpp.
References BOTAN_ASSERT, Botan::OS::get_process_id(), is_seeded(), Botan::RandomNumberGenerator::name(), reseed(), reseed_from_rng(), and security_level().
|
finalvirtual |
Reseed by reading specified bits from the RNG
Sets the seeded state to true if enough entropy was added.
Reimplemented from Botan::RandomNumberGenerator.
Definition at line 89 of file stateful_rng.cpp.
References Botan::lock(), Botan::RandomNumberGenerator::RandomNumberGenerator(), Botan::RandomNumberGenerator::reseed_from_rng(), and security_level().
Referenced by reseed_check().
|
inline |
Definition at line 106 of file stateful_rng.h.
Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::HMAC_DRBG::HMAC_DRBG(), Botan::HMAC_DRBG::HMAC_DRBG(), Botan::HMAC_DRBG::HMAC_DRBG(), Stateful_RNG(), Stateful_RNG(), and Stateful_RNG().
|
pure virtual |
Implemented in Botan::ChaCha_RNG, and Botan::HMAC_DRBG.
Referenced by reseed(), reseed_check(), and reseed_from_rng().
|
protectedpure virtual |
|
staticconstexprinherited |
Number of entropy bits polled for reseeding userspace RNGs like HMAC_DRBG
Definition at line 41 of file rng.h.
Referenced by is_seeded().
|
staticconstexprinherited |
|
staticconstexprinherited |