|
Botan 3.14.1
Crypto and TLS for C&
|
#include <jitter_rng.h>
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) |
RNG using jitterentropy (https://github.com/smuellerDD/jitterentropy-library)
Definition at line 22 of file jitter_rng.h.
|
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.
|
explicit |
Create a Jitter_RNG, throwing if jitterentropy cannot be initialized
| mode | the compliance mode to request from jitterentropy |
| osr | the 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.
Referenced by Jitter_RNG(), Jitter_RNG(), operator=(), and operator=().
|
overridedefault |
|
delete |
References Jitter_RNG().
|
default |
Move constructor
References Jitter_RNG().
|
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.
References fill_bytes_with_input().
Referenced by add_entropy().
|
inlineoverridevirtual |
Test whether this RNG accepts externally provided input
Implements Botan::RandomNumberGenerator.
Definition at line 99 of file jitter_rng.h.
|
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().
|
overridevirtual |
Clear all internally held values of this RNG
Implements Botan::RandomNumberGenerator.
Definition at line 170 of file jitter_rng.cpp.
|
inlineoverridevirtual |
Test whether this RNG has been seeded
Implements Botan::RandomNumberGenerator.
Definition at line 93 of file jitter_rng.h.
|
inlineoverridevirtual |
Return the name of this RNG type
Implements Botan::RandomNumberGenerator.
Definition at line 87 of file jitter_rng.h.
|
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().
|
static |
Definition at line 79 of file jitter_rng.cpp.
References BOTAN_JITTER_RNG_NTG1_MIN_VERSION.
|
delete |
References Jitter_RNG().
|
delete |
References Jitter_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().
|
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().
|
virtualinherited |
Reseed by reading specified bits from the RNG
Sets the seeded state to true if enough entropy was added.
Reimplemented in Botan::Stateful_RNG.
Definition at line 99 of file rng.cpp.
References accepts_input(), add_entropy(), random_vec(), and RandomNumberGenerator().
Referenced by reseed_from().
|
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.
Reimplemented in Botan::AutoSeeded_RNG, Botan::PKCS11::PKCS11_RNG, and Botan::Stateful_RNG.
Definition at line 85 of file rng.cpp.
References Botan::Entropy_Sources::_gather(), accepts_input(), BOTAN_UNUSED, and fill_bytes_with_input().
Referenced by reseed_from().
|
staticconstexpr |
Let jitterentropy pick the oversampling rate
Definition at line 55 of file jitter_rng.h.
|
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 |