Botan 2.19.1
Crypto and TLS for C&
|
#include <stateful_rng.h>
Public Member Functions | |
bool | accepts_input () const override final |
void | add_entropy (const uint8_t input[], size_t input_len) override final |
template<typename T > | |
void | add_entropy_T (const T &t) |
void | clear () override final |
void | force_reseed () |
void | initialize_with (const uint8_t input[], size_t length) |
bool | is_seeded () const override 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 () |
secure_vector< uint8_t > | random_vec (size_t bytes) |
template<typename Alloc > | |
void | random_vec (std::vector< uint8_t, Alloc > &v, size_t bytes) |
void | randomize (uint8_t output[], size_t output_len) override final |
void | randomize_with_input (uint8_t output[], size_t output_len, const uint8_t input[], size_t input_len) override final |
void | randomize_with_ts_input (uint8_t output[], size_t output_len) override final |
size_t | reseed (Entropy_Sources &srcs, size_t poll_bits=BOTAN_RNG_RESEED_POLL_BITS, std::chrono::milliseconds poll_timeout=BOTAN_RNG_RESEED_DEFAULT_TIMEOUT) override |
void | reseed_from_rng (RandomNumberGenerator &rng, size_t poll_bits=BOTAN_RNG_RESEED_POLL_BITS) override 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 Member Functions | |
static RandomNumberGenerator * | make_rng () |
Protected Member Functions | |
virtual void | clear_state ()=0 |
virtual void | generate_output (uint8_t output[], size_t output_len, const uint8_t input[], size_t input_len)=0 |
void | reseed_check () |
virtual void | update (const uint8_t input[], size_t input_len)=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 36 of file stateful_rng.h.
|
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 50 of file stateful_rng.h.
|
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 60 of file stateful_rng.h.
|
inline |
In this case, automatic reseeding is impossible
Definition at line 68 of file stateful_rng.h.
|
inlinefinaloverridevirtual |
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 79 of file stateful_rng.h.
|
finaloverridevirtual |
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 containg the entropy to be added |
length | the length of the byte array in |
Implements Botan::RandomNumberGenerator.
Definition at line 37 of file stateful_rng.cpp.
References security_level(), and update().
Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), and initialize_with().
|
inlineinherited |
Incorporate some additional data into the RNG state.
Definition at line 69 of file rng.h.
References T.
Referenced by Botan::Win32_EntropySource::poll().
|
finaloverridevirtual |
Clear all internally held values of this RNG
Implements Botan::RandomNumberGenerator.
Definition at line 17 of file stateful_rng.cpp.
References clear_state().
Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), Botan::HMAC_DRBG::HMAC_DRBG(), and initialize_with().
|
protectedpure virtual |
Referenced by clear().
void Botan::Stateful_RNG::force_reseed | ( | ) |
Mark state as requiring a reseed on next use
Definition at line 25 of file stateful_rng.cpp.
|
protectedpure virtual |
Referenced by randomize_with_input().
void Botan::Stateful_RNG::initialize_with | ( | const uint8_t | input[], |
size_t | length | ||
) |
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 49 of file stateful_rng.cpp.
References add_entropy(), and clear().
|
finaloverridevirtual |
Check whether this RNG is seeded.
Implements Botan::RandomNumberGenerator.
Definition at line 31 of file stateful_rng.cpp.
Referenced by reseed_check().
|
staticinherited |
Create a seeded and active RNG object for general application use Added in 1.8.0 Use AutoSeeded_RNG instead
Definition at line 69 of file rng.cpp.
|
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.
Referenced by randomize_with_input().
|
pure virtualinherited |
Implemented in Botan::PKCS11::PKCS11_RNG, Botan::TPM_RNG, Botan::AutoSeeded_RNG, Botan::ChaCha_RNG, Botan::HMAC_DRBG, Botan::Processor_RNG, Botan::RDRAND_RNG, Botan::Null_RNG, and Botan::System_RNG.
Referenced by Botan::System_RNG::name(), and reseed_check().
|
inlineinherited |
Return a random byte
Definition at line 161 of file rng.h.
Referenced by Botan::random_prime().
|
inlineinherited |
Definition at line 171 of file rng.h.
Referenced by Botan::EME_PKCS1v15::pad().
|
inlineinherited |
Return a random vector
bytes | number of bytes in the result |
Definition at line 143 of file rng.h.
Referenced by Botan::CECPQ1_accept(), Botan::CECPQ1_offer(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::Curve25519_PrivateKey::Curve25519_PrivateKey(), Botan::PK_Decryptor::decrypt_or_random(), Botan::Ed25519_PrivateKey::Ed25519_PrivateKey(), Botan::TLS::Session::encrypt(), Botan::KeyPair::encryption_consistency_check(), Botan::generate_bcrypt(), Botan::mceies_encrypt(), Botan::OctetString::OctetString(), Botan::BigInt::randomize(), and Botan::TLS::Session_Manager_In_Memory::remove_all().
|
inlineinherited |
|
finaloverridevirtual |
Randomize a byte array.
output | the byte array to hold the random output. |
length | the length of the byte array output in bytes. |
Implements Botan::RandomNumberGenerator.
Definition at line 57 of file stateful_rng.cpp.
References randomize_with_input().
|
finaloverridevirtual |
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 |
output_len | size of the output buffer in bytes |
input | entropy buffer to incorporate |
input_len | size of the input buffer in bytes |
Reimplemented from Botan::RandomNumberGenerator.
Definition at line 79 of file stateful_rng.cpp.
References generate_output(), max_number_of_bytes_per_request(), and reseed_check().
Referenced by randomize(), and randomize_with_ts_input().
|
finaloverridevirtual |
Overrides default implementation and also includes the current process ID and the reseed counter.
Reimplemented from Botan::RandomNumberGenerator.
Definition at line 62 of file stateful_rng.cpp.
References Botan::OS::get_high_resolution_clock(), Botan::OS::get_process_id(), Botan::OS::get_system_timestamp_ns(), Botan::RandomNumberGenerator::randomize(), randomize_with_input(), Botan::store_le(), and Botan::system_rng().
|
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 116 of file stateful_rng.cpp.
References Botan::RandomNumberGenerator::reseed(), and security_level().
Referenced by reseed_check().
|
protected |
Definition at line 150 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().
Referenced by randomize_with_input().
|
finaloverridevirtual |
Reseed by reading specified bits from the RNG
Reimplemented from Botan::RandomNumberGenerator.
Definition at line 132 of file stateful_rng.cpp.
References Botan::RandomNumberGenerator::reseed_from_rng(), and security_level().
Referenced by reseed_check().
|
inline |
Definition at line 128 of file stateful_rng.h.
Referenced by Botan::HMAC_DRBG::HMAC_DRBG().
|
pure virtual |
Implemented in Botan::ChaCha_RNG, and Botan::HMAC_DRBG.
Referenced by add_entropy(), reseed(), reseed_check(), and reseed_from_rng().
|
protectedpure virtual |
Referenced by add_entropy().