|
Botan 3.14.1
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> | |
| 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 () |
| Stateful_RNG & | operator= (const Stateful_RNG &other)=delete |
| Stateful_RNG & | operator= (Stateful_RNG &&other)=delete |
| template<size_t bytes> | |
| std::array< uint8_t, bytes > | random_array () |
| template<concepts::resizable_byte_buffer T = secure_vector<uint8_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=DefaultPollTimeout) |
| size_t | reseed_from (Entropy_Sources &srcs, size_t poll_bits=RandomNumberGenerator::DefaultPollBits) |
| void | reseed_from (RandomNumberGenerator &rng, size_t poll_bits=RandomNumberGenerator::DefaultPollBits) |
| void | reseed_from_rng (RandomNumberGenerator &rng, size_t poll_bits=RandomNumberGenerator::DefaultPollBits) final |
| size_t | reseed_from_sources (Entropy_Sources &srcs, size_t poll_bits=RandomNumberGenerator::DefaultPollBits) final |
| size_t | reseed_interval () const |
| virtual size_t | security_level () const =0 |
| Stateful_RNG () | |
| Stateful_RNG (const Stateful_RNG &other)=delete | |
| 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) | |
| Stateful_RNG (Stateful_RNG &&other)=delete | |
| ~Stateful_RNG () override | |
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 31 of file stateful_rng.h.
| Botan::Stateful_RNG::Stateful_RNG | ( | RandomNumberGenerator & | rng, |
| Entropy_Sources & | entropy_sources, | ||
| size_t | reseed_interval ) |
Create a Stateful_RNG which reseeds from both an RNG and entropy sources
| Random Number Generators | 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 19 of file stateful_rng.cpp.
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(), Botan::HMAC_DRBG::HMAC_DRBG(), operator=(), operator=(), Stateful_RNG(), and Stateful_RNG().
| Botan::Stateful_RNG::Stateful_RNG | ( | RandomNumberGenerator & | rng, |
| size_t | reseed_interval ) |
Create a Stateful_RNG which reseeds from another RNG
| Random Number Generators | 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 25 of file stateful_rng.cpp.
References Botan::RandomNumberGenerator::RandomNumberGenerator(), and reseed_interval().
| Botan::Stateful_RNG::Stateful_RNG | ( | Entropy_Sources & | entropy_sources, |
| size_t | reseed_interval ) |
Create a Stateful_RNG which reseeds from entropy sources
| 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 30 of file stateful_rng.cpp.
References reseed_interval().
| Botan::Stateful_RNG::Stateful_RNG | ( | ) |
In this case, automatic reseeding is impossible
Definition at line 35 of file stateful_rng.cpp.
|
overridedefault |
|
delete |
References Stateful_RNG().
|
delete |
References Stateful_RNG().
|
inlinefinalvirtual |
Test whether this RNG accepts externally provided input
Implements Botan::RandomNumberGenerator.
Definition at line 103 of file stateful_rng.h.
References accepts_input().
Referenced by accepts_input().
|
inlineinherited |
Provide seed material to the RNG, see add_entropy
| input | a byte array containing the entropy to be added |
| length | the number of bytes in input |
Definition at line 128 of file rng.h.
References add_entropy().
Referenced by add_entropy().
|
inlineinherited |
Provide seed material to the RNG.
The caller asserts that the input is full entropy seed material. For a stateful RNG such as HMAC_DRBG, an input of at least security_level() bits marks the RNG as seeded.
To mix in data of unknown quality (nonces, timestamps, values from a peer's protocol message) without affecting the seeded state, instead call randomize_with_input with an empty output buffer.
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 121 of file rng.h.
References accept_seed_material().
Referenced by add_entropy_T(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::Stateful_RNG::initialize_with(), and reseed_from_rng().
|
inlineinherited |
Provide seed material to the RNG, see add_entropy
Definition at line 135 of file rng.h.
References add_entropy().
|
finalvirtual |
Clear all internally held values of this RNG
Implements Botan::RandomNumberGenerator.
Definition at line 39 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::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 |
Clear the subclass specific portion of the RNG state
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 47 of file stateful_rng.cpp.
References Botan::lock().
|
protectedpure virtual |
Generate output, incorporating the provided input
| output | the buffer to fill |
| input | additional input to incorporate |
References generate_output().
Referenced by generate_output().
|
inline |
Reset the RNG then consume this input as seed material
The RNG is marked as seeded only if the input is at least security_level() bits long.
| input | the seed material |
| length | the number of bytes in input |
Definition at line 91 of file stateful_rng.h.
References initialize_with().
Referenced by initialize_with().
| void Botan::Stateful_RNG::initialize_with | ( | std::span< const uint8_t > | input | ) |
Reset the RNG then consume this input as seed material
The RNG is marked as seeded only if the input is at least security_level() bits long.
Definition at line 57 of file stateful_rng.cpp.
References Botan::RandomNumberGenerator::add_entropy(), clear(), and Botan::lock().
Referenced by operator=().
|
finalvirtual |
Test whether this RNG has been seeded
Implements Botan::RandomNumberGenerator.
Definition at line 52 of file stateful_rng.cpp.
References Botan::lock().
Referenced by reseed_check().
|
pure virtual |
Return the largest number of bytes this DRBG will produce per request 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 |
Return the name of this RNG type
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 302 of file rng.h.
References fill_bytes_with_input().
Referenced by next_nonzero_byte(), and Botan::random_prime().
|
inlineinherited |
Generate a single random byte which is not zero
| PRNG_Unseeded | if the RNG fails because it has not enough entropy |
| Exception | if the RNG fails |
Definition at line 314 of file rng.h.
References next_byte().
|
delete |
References Stateful_RNG().
|
delete |
References initialize_with(), and Stateful_RNG().
|
inlineinherited |
Create a std::array of bytes random bytes
Definition at line 290 of file rng.h.
References random_vec().
Referenced by Botan::generate_rsa_prime().
|
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 280 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 254 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::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::Stateful_RNG::reseed_from_rng(), Botan::SphincsPlus_PrivateKey::SphincsPlus_PrivateKey(), Botan::X25519_PrivateKey::X25519_PrivateKey(), and Botan::XMSS_PublicKey::XMSS_PublicKey().
|
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 265 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 86 of file rng.h.
References fill_bytes_with_input().
Referenced by Botan::TLS::Connection_Cipher_State::aead_nonce(), Botan::argon2_generate_pwhash(), Botan::BlindingRandomness< BlindedScalar, Scalars >::BlindingRandomness(), botan_system_rng_get(), Botan::CryptoBox::encrypt(), Botan::PKCS12::export_to(), Botan::generate_dsa_primes(), Botan::generate_passhash9(), Botan::pkcs12_pbe_encrypt(), Botan::IntMod< MontgomeryRep< ScalarParams > >::random(), Botan::X509_Serial_Number::random(), Botan::random_gf2m(), Botan::McEliece_PublicKeyInternal::random_plaintext_element(), Botan::random_prime(), random_vec(), Botan::Sodium::randombytes_buf(), Botan::KeyPair::signature_consistency_check(), Botan::RTSS_Share::split(), and Botan::UUID::UUID().
|
inlineinherited |
Randomize a byte array
| output | the byte array to hold the random output |
| length | the number of bytes to generate |
Definition at line 93 of file rng.h.
References randomize().
Referenced by randomize().
|
inlineinherited |
Incorporate additional input into the RNG state then produce output.
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.
The input is never credited as entropy: if the output buffer is empty, the input is mixed into the state of a stateful RNG without affecting whether it is considered seeded. Use add_entropy to provide seed material.
| 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 158 of file rng.h.
References fill_bytes_with_input().
Referenced by Botan::System_RNG::fill_bytes_with_input(), and randomize_with_input().
|
inlineinherited |
Randomize a byte array, first incorporating additional input
| output | the byte array to hold the random output |
| output_len | the number of bytes to generate |
| input | a byte array containing the entropy to be added |
| input_len | the number of bytes in input |
Definition at line 169 of file rng.h.
References randomize_with_input().
|
inherited |
This calls randomize_with_input using system specific values
This first attempts to provide input to the underlying RNG from some system specific source. The additional input consists of an 8 byte timestamp from the local clock. The remainder of the 22 byte input is filled from the system RNG if available, otherwise the current process ID is appended.
For a stateful RNG that was already correctly seeded with sufficient cryptographically secure material, using non-random but potentially unique data as 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 some input, even predictable input, 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 73 of file rng.cpp.
References accepts_input(), and fill_bytes_with_input().
Referenced by randomize_with_ts_input().
|
inlineinherited |
Randomize a byte array, using timestamps as additional input
| output | the byte array to hold the random output |
| output_len | the number of bytes to generate |
Definition at line 200 of file rng.h.
References randomize_with_ts_input().
|
inlineinherited |
Poll provided sources for up to poll_bits bits of entropy. Returns estimate of the number of bits collected.
Sets the seeded state to true if enough entropy was added.
TODO(Botan4) remove this function
Definition at line 347 of file rng.h.
References DefaultPollBits, DefaultPollTimeout, RandomNumberGenerator(), reseed(), and reseed_from().
Referenced by reseed().
|
protected |
Reseed if the reseed interval has elapsed, or throw if unseeded
Definition at line 160 of file stateful_rng.cpp.
References BOTAN_ASSERT, is_seeded(), Botan::RandomNumberGenerator::name(), reseed_from_rng(), reseed_from_sources(), and security_level().
|
inlineinherited |
Poll provided sources for up to poll_bits bits of entropy. Returns estimate of the number of bits collected. Sets the seeded state to true if enough entropy was added.
Definition at line 229 of file rng.h.
References DefaultPollBits, and reseed_from_sources().
Referenced by reseed().
|
inlineinherited |
Reseed by reading specified bits from the RNG
Sets the seeded state to true if enough entropy was added.
Definition at line 240 of file rng.h.
References DefaultPollBits, RandomNumberGenerator(), and reseed_from_rng().
|
finalvirtual |
Reseed this RNG from another RNG
| Random Number Generators | the RNG to draw seed material from |
| poll_bits | the number of bits to collect |
Reimplemented from Botan::RandomNumberGenerator.
Definition at line 139 of file stateful_rng.cpp.
References Botan::lock(), Botan::RandomNumberGenerator::random_vec(), Botan::RandomNumberGenerator::RandomNumberGenerator(), and update().
Referenced by reseed_check().
|
finalvirtual |
Poll provided sources for up to poll_bits bits of entropy. Returns estimate of the number of bits collected.
Reimplemented from Botan::RandomNumberGenerator.
Definition at line 126 of file stateful_rng.cpp.
References Botan::Entropy_Sources::_gather(), BOTAN_UNUSED, Botan::lock(), and update().
Referenced by reseed_check().
|
inline |
Return how many requests may be made before automatic reseeding
Definition at line 147 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 |
Return the security level of this DRBG
Implemented in Botan::ChaCha_RNG, and Botan::HMAC_DRBG.
Referenced by reseed_check().
|
protectedpure virtual |
Incorporate the provided input into the RNG state
| input | the seed material |
References update().
Referenced by reseed_from_rng(), reseed_from_sources(), and update().
|
staticconstexprinherited |
Number of entropy bits polled for reseeding userspace RNGs like HMAC_DRBG
Definition at line 50 of file rng.h.
Referenced by Botan::Entropy_Source::poll(), Botan::Entropy_Sources::poll_just(), reseed(), reseed_from(), and reseed_from().
|
staticconstexprinherited |
|
staticconstexprinherited |