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

#include <jitter_rng.h>

Inheritance diagram for Botan::Jitter_RNG:
Botan::RandomNumberGenerator

Public Types

enum class  Mode : uint8_t { Default , FIPS , NTG1 }

Public Member Functions

bool accepts_input () const override
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 () override
bool is_seeded () const override
 Jitter_RNG (const Jitter_RNG &other)=delete
 Jitter_RNG (Jitter_RNG &&other)=default
 Jitter_RNG (Mode mode=Mode::Default, size_t osr=default_osr)
std::string name () const override
uint8_t next_byte ()
uint8_t next_nonzero_byte ()
Jitter_RNG & operator= (const Jitter_RNG &other)=delete
Jitter_RNG & operator= (Jitter_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)
virtual void reseed_from_rng (RandomNumberGenerator &rng, size_t poll_bits=RandomNumberGenerator::DefaultPollBits)
 ~Jitter_RNG () override

Static Public Member Functions

static bool ntg1_supported ()

Static Public Attributes

static constexpr size_t default_osr = 0
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 accept_seed_material (std::span< const uint8_t > input)
virtual size_t reseed_from_sources (Entropy_Sources &srcs, size_t poll_bits=RandomNumberGenerator::DefaultPollBits)

Detailed Description

RNG using jitterentropy (https://github.com/smuellerDD/jitterentropy-library)

Definition at line 22 of file jitter_rng.h.

Member Enumeration Documentation

◆ Mode

enum class Botan::Jitter_RNG::Mode : uint8_t
strong

The compliance mode requested from the underlying jitterentropy library

Enumerator
Default 

Leave the library at its defaults. The SP800-90B health tests are then only enforced if the system itself runs in FIPS mode.

FIPS 

Force full SP800-90B compliance, including the online health tests, regardless of the state of the system (JENT_FORCE_FIPS).

NTG1 

Request AIS 20/31 NTG.1 compliance (JENT_NTG1). This implies FIPS mode and additionally disables the internal timer, so it is not available on platforms which have no usable high resolution timer.

Requires jitterentropy 3.7.0 or later, both at build and at run time; the constructor throws Not_Implemented otherwise. See ntg1_supported().

Definition at line 27 of file jitter_rng.h.

27 : uint8_t {
28 /**
29 * Leave the library at its defaults. The SP800-90B health tests are
30 * then only enforced if the system itself runs in FIPS mode.
31 */
32 Default,
33
34 /**
35 * Force full SP800-90B compliance, including the online health tests,
36 * regardless of the state of the system (``JENT_FORCE_FIPS``).
37 */
38 FIPS,
39
40 /**
41 * Request AIS 20/31 NTG.1 compliance (``JENT_NTG1``). This implies
42 * FIPS mode and additionally disables the internal timer, so it is not
43 * available on platforms which have no usable high resolution timer.
44 *
45 * Requires jitterentropy 3.7.0 or later, both at build and at run
46 * time; the constructor throws Not_Implemented otherwise. See
47 * ntg1_supported().
48 */
49 NTG1,
50 };

Constructor & Destructor Documentation

◆ Jitter_RNG() [1/3]

Botan::Jitter_RNG::Jitter_RNG ( Mode mode = Mode::Default,
size_t osr = default_osr )
explicit

Create a Jitter_RNG, throwing if jitterentropy cannot be initialized

Parameters
modethe compliance mode to request from jitterentropy
osrthe oversampling rate to use. Higher values collect more timing samples per output bit, which is slower but more conservative. The default lets the library apply its own (minimal) rate. Values the library considers out of range cause the constructor to throw.

Definition at line 166 of file jitter_rng.cpp.

166: m_jitter{std::make_unique<Jitter_RNG_Internal>(mode, osr)} {}

Referenced by Jitter_RNG(), Jitter_RNG(), operator=(), and operator=().

◆ ~Jitter_RNG()

Botan::Jitter_RNG::~Jitter_RNG ( )
overridedefault

◆ Jitter_RNG() [2/3]

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

References Jitter_RNG().

◆ Jitter_RNG() [3/3]

Botan::Jitter_RNG::Jitter_RNG ( Jitter_RNG && other)
default

Move constructor

References Jitter_RNG().

Member Function Documentation

◆ accept_seed_material()

void Botan::RandomNumberGenerator::accept_seed_material ( std::span< const uint8_t > input)
protectedvirtualinherited

Consume seed material provided via add_entropy

This is the only path through which application provided input may mark an RNG as seeded. The default implementation forwards the input to fill_bytes_with_input with an empty output buffer, which is appropriate for RNGs which do not track a seeded state. RNGs which do track a seeded state must override this function.

Definition at line 30 of file rng.cpp.

30 {
31 this->fill_bytes_with_input({}, input);
32}
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 add_entropy().

◆ accepts_input()

bool Botan::Jitter_RNG::accepts_input ( ) const
inlineoverridevirtual

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 99 of file jitter_rng.h.

99{ return false; }

◆ 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::Jitter_RNG::clear ( )
overridevirtual

Clear all internally held values of this RNG

Implements Botan::RandomNumberGenerator.

Definition at line 170 of file jitter_rng.cpp.

170 {
171 /* ignored - jitterentropy library does not support this */
172}

◆ is_seeded()

bool Botan::Jitter_RNG::is_seeded ( ) const
inlineoverridevirtual

Test whether this RNG has been seeded

Returns
true if this RNG is seeded and ready for use

Implements Botan::RandomNumberGenerator.

Definition at line 93 of file jitter_rng.h.

93{ return true; }

◆ name()

std::string Botan::Jitter_RNG::name ( ) const
inlineoverridevirtual

Return the name of this RNG type

Returns
the name of this RNG type

Implements Botan::RandomNumberGenerator.

Definition at line 87 of file jitter_rng.h.

87{ return "JitterRNG"; }

◆ 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 }

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

◆ ntg1_supported()

bool Botan::Jitter_RNG::ntg1_supported ( )
static
Returns
true if the linked jitterentropy supports Mode::NTG1

Definition at line 79 of file jitter_rng.cpp.

79 {
80#if defined(BOTAN_JITTER_RNG_HAS_NTG1)
81 return jent_version() >= BOTAN_JITTER_RNG_NTG1_MIN_VERSION;
82#else
83 return false;
84#endif
85}
#define BOTAN_JITTER_RNG_NTG1_MIN_VERSION

References BOTAN_JITTER_RNG_NTG1_MIN_VERSION.

◆ operator=() [1/2]

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

References Jitter_RNG().

◆ operator=() [2/2]

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

References Jitter_RNG().

◆ 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_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::RandomNumberGenerator::reseed_from_rng ( RandomNumberGenerator & rng,
size_t poll_bits = RandomNumberGenerator::DefaultPollBits )
virtualinherited

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.

Reimplemented in Botan::Stateful_RNG.

Definition at line 99 of file rng.cpp.

99 {
100 if(this->accepts_input()) {
101 this->add_entropy(rng.random_vec(poll_bits / 8));
102 }
103}

References accepts_input(), add_entropy(), random_vec(), and RandomNumberGenerator().

Referenced by reseed_from().

◆ reseed_from_sources()

size_t Botan::RandomNumberGenerator::reseed_from_sources ( Entropy_Sources & srcs,
size_t poll_bits = RandomNumberGenerator::DefaultPollBits )
protectedvirtualinherited

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.

Reimplemented in Botan::AutoSeeded_RNG, Botan::PKCS11::PKCS11_RNG, and Botan::Stateful_RNG.

Definition at line 85 of file rng.cpp.

85 {
86 if(this->accepts_input()) {
87#if defined(BOTAN_HAS_ENTROPY_SOURCE)
88 Entropy_Accumulator acc(poll_bits, [this](std::span<const uint8_t> in) { this->fill_bytes_with_input({}, in); });
89 srcs._gather(acc);
90 return acc.bits_collected();
91#else
92 BOTAN_UNUSED(srcs, poll_bits);
93#endif
94 }
95
96 return 0;
97}
#define BOTAN_UNUSED
Definition assert.h:151

References Botan::Entropy_Sources::_gather(), accepts_input(), BOTAN_UNUSED, and fill_bytes_with_input().

Referenced by reseed_from().

Member Data Documentation

◆ default_osr

size_t Botan::Jitter_RNG::default_osr = 0
staticconstexpr

Let jitterentropy pick the oversampling rate

Definition at line 55 of file jitter_rng.h.

◆ 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: