Botan 3.14.1
Crypto and TLS for C&
Botan::Stateful_RNG Class Referenceabstract

#include <stateful_rng.h>

Inheritance diagram for Botan::Stateful_RNG:
Botan::RandomNumberGenerator Botan::ChaCha_RNG Botan::HMAC_DRBG

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

Detailed Description

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.

Constructor & Destructor Documentation

◆ Stateful_RNG() [1/6]

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

Parameters
Random Number Generatorsis a reference to some RNG which will be used to perform the periodic reseeding
entropy_sourceswill be polled to perform reseeding periodically
reseed_intervalspecifies 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.

19 :
20 m_underlying_rng(&rng),
21 m_entropy_sources(&entropy_sources),
22 m_reseed_interval(reseed_interval),
23 m_fork_detector(std::make_unique<OS::Fork_Detector>()) {}
size_t reseed_interval() const

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().

◆ Stateful_RNG() [2/6]

Botan::Stateful_RNG::Stateful_RNG ( RandomNumberGenerator & rng,
size_t reseed_interval )

Create a Stateful_RNG which reseeds from another RNG

Parameters
Random Number Generatorsis a reference to some RNG which will be used to perform the periodic reseeding
reseed_intervalspecifies 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.

25 :
26 m_underlying_rng(&rng),
27 m_reseed_interval(reseed_interval),
28 m_fork_detector(std::make_unique<OS::Fork_Detector>()) {}

References Botan::RandomNumberGenerator::RandomNumberGenerator(), and reseed_interval().

◆ Stateful_RNG() [3/6]

Botan::Stateful_RNG::Stateful_RNG ( Entropy_Sources & entropy_sources,
size_t reseed_interval )

Create a Stateful_RNG which reseeds from entropy sources

Parameters
entropy_sourceswill be polled to perform reseeding periodically
reseed_intervalspecifies 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.

30 :
31 m_entropy_sources(&entropy_sources),
32 m_reseed_interval(reseed_interval),
33 m_fork_detector(std::make_unique<OS::Fork_Detector>()) {}

References reseed_interval().

◆ Stateful_RNG() [4/6]

Botan::Stateful_RNG::Stateful_RNG ( )

In this case, automatic reseeding is impossible

Definition at line 35 of file stateful_rng.cpp.

35: m_reseed_interval(0), m_fork_detector(std::make_unique<OS::Fork_Detector>()) {}

◆ ~Stateful_RNG()

Botan::Stateful_RNG::~Stateful_RNG ( )
overridedefault

◆ Stateful_RNG() [5/6]

Botan::Stateful_RNG::Stateful_RNG ( const Stateful_RNG & other)
delete

References Stateful_RNG().

◆ Stateful_RNG() [6/6]

Botan::Stateful_RNG::Stateful_RNG ( Stateful_RNG && other)
delete

References Stateful_RNG().

Member Function Documentation

◆ accepts_input()

bool Botan::Stateful_RNG::accepts_input ( ) const
inlinefinalvirtual

Test whether this RNG accepts externally provided input

Returns
false if this RNG is known to ignore provided inputs

Implements Botan::RandomNumberGenerator.

Definition at line 103 of file stateful_rng.h.

103{ return true; }

References accepts_input().

Referenced by accepts_input().

◆ add_entropy() [1/2]

void Botan::RandomNumberGenerator::add_entropy ( const uint8_t input[],
size_t length )
inlineinherited

Provide seed material to the RNG, see add_entropy

Parameters
inputa byte array containing the entropy to be added
lengththe number of bytes in input

Definition at line 128 of file rng.h.

128{ this->add_entropy(std::span(input, length)); }
void add_entropy(std::span< const uint8_t > input)
Definition rng.h:121

References add_entropy().

Referenced by add_entropy().

◆ add_entropy() [2/2]

void Botan::RandomNumberGenerator::add_entropy ( std::span< const uint8_t > input)
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.

Parameters
inputa byte array containing the entropy to be added
Exceptions
Exceptionmay throw if the RNG accepts input, but adding the entropy failed.

Definition at line 121 of file rng.h.

121{ this->accept_seed_material(input); }
virtual void accept_seed_material(std::span< const uint8_t > input)
Definition rng.cpp:30

References accept_seed_material().

Referenced by add_entropy_T(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::Stateful_RNG::initialize_with(), and reseed_from_rng().

◆ add_entropy_T()

template<typename T>
void Botan::RandomNumberGenerator::add_entropy_T ( const T & t)
inlineinherited

Provide seed material to the RNG, see add_entropy

Definition at line 135 of file rng.h.

135 {
136 this->add_entropy(reinterpret_cast<const uint8_t*>(&t), sizeof(T));
137 }

References add_entropy().

◆ clear()

void Botan::Stateful_RNG::clear ( )
finalvirtual

Clear all internally held values of this RNG

Implements Botan::RandomNumberGenerator.

Definition at line 39 of file stateful_rng.cpp.

39 {
41 m_reseed_counter = 0;
42 // The cleared state has nothing left to inherit from a parent process
43 m_fork_detector->rebaseline();
45}
virtual void clear_state()=0
secure_vector< T > lock(const std::vector< T > &in)
Definition secmem.h:145
lock_guard< T > lock_guard_type
Definition mutex.h:58

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().

◆ clear_state()

virtual void Botan::Stateful_RNG::clear_state ( )
protectedpure virtual

Clear the subclass specific portion of the RNG state

References clear_state(), and Botan::RandomNumberGenerator::RandomNumberGenerator().

Referenced by clear(), and clear_state().

◆ force_reseed()

void Botan::Stateful_RNG::force_reseed ( )

Mark state as requiring a reseed on next use

Definition at line 47 of file stateful_rng.cpp.

47 {
49 m_reseed_counter = 0;
50}

References Botan::lock().

◆ generate_output()

virtual void Botan::Stateful_RNG::generate_output ( std::span< uint8_t > output,
std::span< const uint8_t > input )
protectedpure virtual

Generate output, incorporating the provided input

Parameters
outputthe buffer to fill
inputadditional input to incorporate

References generate_output().

Referenced by generate_output().

◆ initialize_with() [1/2]

void Botan::Stateful_RNG::initialize_with ( const uint8_t input[],
size_t length )
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.

Parameters
inputthe seed material
lengththe number of bytes in input

Definition at line 91 of file stateful_rng.h.

91{ this->initialize_with(std::span(input, length)); }
void initialize_with(std::span< const uint8_t > input)

References initialize_with().

Referenced by initialize_with().

◆ initialize_with() [2/2]

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.

57 {
59
60 clear();
61 add_entropy(input);
62}

References Botan::RandomNumberGenerator::add_entropy(), clear(), and Botan::lock().

Referenced by operator=().

◆ is_seeded()

bool Botan::Stateful_RNG::is_seeded ( ) const
finalvirtual

Test whether this RNG has been seeded

Returns
true if this RNG is seeded and ready for use

Implements Botan::RandomNumberGenerator.

Definition at line 52 of file stateful_rng.cpp.

52 {
54 return m_reseed_counter > 0;
55}

References Botan::lock().

Referenced by reseed_check().

◆ max_number_of_bytes_per_request()

virtual size_t Botan::Stateful_RNG::max_number_of_bytes_per_request ( ) const
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.

Returns
max number of bytes per request (or zero)

Implemented in Botan::ChaCha_RNG, and Botan::HMAC_DRBG.

◆ name()

virtual std::string Botan::RandomNumberGenerator::name ( ) const
pure virtualinherited

◆ next_byte()

uint8_t Botan::RandomNumberGenerator::next_byte ( )
inlineinherited

Return a random byte

Returns
random byte
Exceptions
PRNG_Unseededif the RNG fails because it has not enough entropy
Exceptionif the RNG fails

Definition at line 302 of file rng.h.

302 {
303 uint8_t b = 0;
304 this->fill_bytes_with_input(std::span(&b, 1), {});
305 return b;
306 }
virtual void fill_bytes_with_input(std::span< uint8_t > output, std::span< const uint8_t > input)=0

References fill_bytes_with_input().

Referenced by next_nonzero_byte(), and Botan::random_prime().

◆ next_nonzero_byte()

uint8_t Botan::RandomNumberGenerator::next_nonzero_byte ( )
inlineinherited

Generate a single random byte which is not zero

Returns
a random byte that is greater than zero
Exceptions
PRNG_Unseededif the RNG fails because it has not enough entropy
Exceptionif the RNG fails

Definition at line 314 of file rng.h.

314 {
315 uint8_t b = this->next_byte();
316 while(b == 0) {
317 b = this->next_byte();
318 }
319 return b;
320 }

References next_byte().

◆ operator=() [1/2]

Stateful_RNG & Botan::Stateful_RNG::operator= ( const Stateful_RNG & other)
delete

References Stateful_RNG().

◆ operator=() [2/2]

Stateful_RNG & Botan::Stateful_RNG::operator= ( Stateful_RNG && other)
delete

◆ random_array()

template<size_t bytes>
std::array< uint8_t, bytes > Botan::RandomNumberGenerator::random_array ( )
inlineinherited

Create a std::array of bytes random bytes

Definition at line 290 of file rng.h.

290 {
291 std::array<uint8_t, bytes> result{};
292 random_vec(result);
293 return result;
294 }
void random_vec(std::span< uint8_t > v)
Definition rng.h:254

References random_vec().

Referenced by Botan::generate_rsa_prime().

◆ random_vec() [1/3]

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T Botan::RandomNumberGenerator::random_vec ( size_t bytes)
inlineinherited

Create some byte container type and fill it with some random bytes.

Template Parameters
Tthe desired byte container type (e.g std::vector<uint8_t>)
Parameters
bytesnumber of random bytes to initialize the container with
Returns
a container of type T with bytes random bytes
Exceptions
Exceptionif RNG or memory allocation fails

Definition at line 280 of file rng.h.

280 {
281 T result;
282 random_vec(result, bytes);
283 return result;
284 }

References random_vec().

◆ random_vec() [2/3]

◆ random_vec() [3/3]

template<concepts::resizable_byte_buffer T>
void Botan::RandomNumberGenerator::random_vec ( T & v,
size_t bytes )
inlineinherited

Resize a given byte container to bytes and fill it with random bytes

Template Parameters
Tthe desired byte container type (e.g std::vector<uint8_t>)
Parameters
vthe container to be filled with bytes random bytes
bytesnumber of random bytes to initialize the container with
Exceptions
Exceptionif RNG or memory allocation fails

Definition at line 265 of file rng.h.

265 {
266 v.resize(bytes);
267 random_vec(v);
268 }

References random_vec().

◆ randomize() [1/2]

void Botan::RandomNumberGenerator::randomize ( std::span< uint8_t > output)
inlineinherited

◆ randomize() [2/2]

void Botan::RandomNumberGenerator::randomize ( uint8_t output[],
size_t length )
inlineinherited

Randomize a byte array

Parameters
outputthe byte array to hold the random output
lengththe number of bytes to generate

Definition at line 93 of file rng.h.

93{ this->randomize(std::span(output, length)); }

References randomize().

Referenced by randomize().

◆ randomize_with_input() [1/2]

void Botan::RandomNumberGenerator::randomize_with_input ( std::span< uint8_t > output,
std::span< const uint8_t > input )
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.

Parameters
outputbuffer to hold the random output
inputentropy buffer to incorporate
Exceptions
PRNG_Unseededif the RNG fails because it has not enough entropy
Exceptionif the RNG fails
Exceptionmay throw if the RNG accepts input, but adding the entropy failed.

Definition at line 158 of file rng.h.

158 {
159 this->fill_bytes_with_input(output, input);
160 }

References fill_bytes_with_input().

Referenced by Botan::System_RNG::fill_bytes_with_input(), and randomize_with_input().

◆ randomize_with_input() [2/2]

void Botan::RandomNumberGenerator::randomize_with_input ( uint8_t output[],
size_t output_len,
const uint8_t input[],
size_t input_len )
inlineinherited

Randomize a byte array, first incorporating additional input

Parameters
outputthe byte array to hold the random output
output_lenthe number of bytes to generate
inputa byte array containing the entropy to be added
input_lenthe number of bytes in input

Definition at line 169 of file rng.h.

169 {
170 this->randomize_with_input(std::span(output, output_len), std::span(input, input_len));
171 }
void randomize_with_input(std::span< uint8_t > output, std::span< const uint8_t > input)
Definition rng.h:158

References randomize_with_input().

◆ randomize_with_ts_input() [1/2]

void Botan::RandomNumberGenerator::randomize_with_ts_input ( std::span< uint8_t > output)
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.

Parameters
outputbuffer to hold the random output
Exceptions
PRNG_Unseededif the RNG fails because it has not enough entropy
Exceptionif the RNG fails
Exceptionmay throw if the RNG accepts input, but adding the entropy failed.

Definition at line 73 of file rng.cpp.

73 {
74 if(!this->accepts_input()) {
75 this->fill_bytes_with_input(output, {});
76 return;
77 }
78
79 // TODO(C++26): let rollback_unique_input return std::inplace_vector
80 std::array<uint8_t, RollbackInputBytes> additional_input = {0};
81 const size_t written = rollback_unique_input(additional_input);
82 this->fill_bytes_with_input(output, std::span{additional_input}.first(written));
83}
virtual bool accepts_input() const =0

References accepts_input(), and fill_bytes_with_input().

Referenced by randomize_with_ts_input().

◆ randomize_with_ts_input() [2/2]

void Botan::RandomNumberGenerator::randomize_with_ts_input ( uint8_t output[],
size_t output_len )
inlineinherited

Randomize a byte array, using timestamps as additional input

Parameters
outputthe byte array to hold the random output
output_lenthe number of bytes to generate

Definition at line 200 of file rng.h.

200 {
201 this->randomize_with_ts_input(std::span(output, output_len));
202 }
void randomize_with_ts_input(std::span< uint8_t > output)
Definition rng.cpp:73

References randomize_with_ts_input().

◆ reseed()

size_t Botan::RandomNumberGenerator::reseed ( Entropy_Sources & srcs,
size_t poll_bits = RandomNumberGenerator::DefaultPollBits,
std::chrono::milliseconds = DefaultPollTimeout )
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.

349 {
350 return reseed_from(srcs, poll_bits);
351 }
size_t reseed_from(Entropy_Sources &srcs, size_t poll_bits=RandomNumberGenerator::DefaultPollBits)
Definition rng.h:229

References DefaultPollBits, DefaultPollTimeout, RandomNumberGenerator(), reseed(), and reseed_from().

Referenced by reseed().

◆ reseed_check()

void Botan::Stateful_RNG::reseed_check ( )
protected

Reseed if the reseed interval has elapsed, or throw if unseeded

Definition at line 160 of file stateful_rng.cpp.

160 {
161 // Lock is held whenever this function is called
162
163 const bool fork_detected = this->fork_detected();
164
165 if(is_seeded() == false || fork_detected || (m_reseed_interval > 0 && m_reseed_counter >= m_reseed_interval)) {
166 // The fork baselines are only updated by a successful reseed
167 m_reseed_counter = 0;
168
169 if(m_underlying_rng != nullptr) {
170 reseed_from_rng(*m_underlying_rng, security_level());
171 }
172
173 if(m_entropy_sources != nullptr) {
174 reseed_from_sources(*m_entropy_sources, security_level());
175 }
176
177 if(!is_seeded()) {
178 if(fork_detected) {
179 throw Invalid_State("Detected use of fork but cannot reseed DRBG");
180 } else {
181 throw PRNG_Unseeded(name());
182 }
183 }
184 } else {
185 BOTAN_ASSERT(m_reseed_counter != 0, "RNG is seeded");
186 m_reseed_counter += 1;
187 }
188}
#define BOTAN_ASSERT(expr, assertion_made)
Definition assert.h:69
virtual std::string name() const =0
bool is_seeded() const final
void reseed_from_rng(RandomNumberGenerator &rng, size_t poll_bits=RandomNumberGenerator::DefaultPollBits) final
virtual size_t security_level() const =0
size_t reseed_from_sources(Entropy_Sources &srcs, size_t poll_bits=RandomNumberGenerator::DefaultPollBits) final

References BOTAN_ASSERT, is_seeded(), Botan::RandomNumberGenerator::name(), reseed_from_rng(), reseed_from_sources(), and security_level().

◆ reseed_from() [1/2]

size_t Botan::RandomNumberGenerator::reseed_from ( Entropy_Sources & srcs,
size_t poll_bits = RandomNumberGenerator::DefaultPollBits )
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.

Exceptions
Exceptionif RNG accepts input but reseeding failed.

Definition at line 229 of file rng.h.

229 {
230 return reseed_from_sources(srcs, poll_bits);
231 }
virtual size_t reseed_from_sources(Entropy_Sources &srcs, size_t poll_bits=RandomNumberGenerator::DefaultPollBits)
Definition rng.cpp:85

References DefaultPollBits, and reseed_from_sources().

Referenced by reseed().

◆ reseed_from() [2/2]

void Botan::RandomNumberGenerator::reseed_from ( RandomNumberGenerator & rng,
size_t poll_bits = RandomNumberGenerator::DefaultPollBits )
inlineinherited

Reseed by reading specified bits from the RNG

Sets the seeded state to true if enough entropy was added.

Exceptions
Exceptionif RNG accepts input but reseeding failed.

Definition at line 240 of file rng.h.

240 {
241 return reseed_from_rng(rng, poll_bits);
242 }
virtual void reseed_from_rng(RandomNumberGenerator &rng, size_t poll_bits=RandomNumberGenerator::DefaultPollBits)
Definition rng.cpp:99

References DefaultPollBits, RandomNumberGenerator(), and reseed_from_rng().

◆ reseed_from_rng()

void Botan::Stateful_RNG::reseed_from_rng ( RandomNumberGenerator & rng,
size_t poll_bits = RandomNumberGenerator::DefaultPollBits )
finalvirtual

Reseed this RNG from another RNG

Parameters
Random Number Generatorsthe RNG to draw seed material from
poll_bitsthe number of bits to collect

Reimplemented from Botan::RandomNumberGenerator.

Definition at line 139 of file stateful_rng.cpp.

139 {
141
142 const auto seed = rng.random_vec(poll_bits / 8);
143 this->update(seed);
144
145 // The caller designated this RNG as a seed source, so its output is credited in full
146 finish_reseed(8 * seed.size());
147}
virtual void update(std::span< const uint8_t > input)=0

References Botan::lock(), Botan::RandomNumberGenerator::random_vec(), Botan::RandomNumberGenerator::RandomNumberGenerator(), and update().

Referenced by reseed_check().

◆ reseed_from_sources()

size_t Botan::Stateful_RNG::reseed_from_sources ( Entropy_Sources & srcs,
size_t poll_bits = RandomNumberGenerator::DefaultPollBits )
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.

126 {
128
129#if defined(BOTAN_HAS_ENTROPY_SOURCE)
130 Entropy_Accumulator acc(poll_bits, [this](std::span<const uint8_t> in) { this->update(in); });
131 srcs._gather(acc);
132 return finish_reseed(acc.bits_collected());
133#else
134 BOTAN_UNUSED(srcs, poll_bits);
135 return finish_reseed(0);
136#endif
137}
#define BOTAN_UNUSED
Definition assert.h:151

References Botan::Entropy_Sources::_gather(), BOTAN_UNUSED, Botan::lock(), and update().

Referenced by reseed_check().

◆ reseed_interval()

size_t Botan::Stateful_RNG::reseed_interval ( ) const
inline

Return how many requests may be made before automatic reseeding

Returns
the reseed interval, or zero if automatic reseeding is disabled

Definition at line 147 of file stateful_rng.h.

147{ return m_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(), Stateful_RNG(), Stateful_RNG(), and Stateful_RNG().

◆ security_level()

virtual size_t Botan::Stateful_RNG::security_level ( ) const
pure virtual

Return the security level of this DRBG

Returns
intended security level of this DRBG

Implemented in Botan::ChaCha_RNG, and Botan::HMAC_DRBG.

Referenced by reseed_check().

◆ update()

virtual void Botan::Stateful_RNG::update ( std::span< const uint8_t > input)
protectedpure virtual

Incorporate the provided input into the RNG state

Parameters
inputthe seed material

References update().

Referenced by reseed_from_rng(), reseed_from_sources(), and update().

Member Data Documentation

◆ DefaultPollBits

size_t Botan::RandomNumberGenerator::DefaultPollBits = 256
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().

◆ DefaultPollTimeout

auto Botan::RandomNumberGenerator::DefaultPollTimeout = std::chrono::milliseconds(50)
staticconstexprinherited

Default poll timeout

Definition at line 336 of file rng.h.

Referenced by reseed().

◆ DefaultReseedInterval

size_t Botan::RandomNumberGenerator::DefaultReseedInterval = 1024
staticconstexprinherited

Userspace RNGs like HMAC_DRBG will reseed after a specified number of outputs are generated. Set to zero to disable automatic reseeding.

Definition at line 45 of file rng.h.


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