Botan  2.8.0
Crypto and TLS for C++11
Public Member Functions | Static Public Member Functions | List of all members
Botan::Hardware_RNG Class Referenceabstract

#include <rng.h>

Inheritance diagram for Botan::Hardware_RNG:
Botan::RandomNumberGenerator Botan::PKCS11::PKCS11_RNG Botan::RDRAND_RNG Botan::TPM_RNG

Public Member Functions

virtual bool accepts_input () const =0
 
virtual void add_entropy (const uint8_t input[], size_t length)=0
 
template<typename T >
void add_entropy_T (const T &t)
 
virtual void clear () final override
 
virtual bool is_seeded () 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)
 
virtual void randomize (uint8_t output[], size_t length)=0
 
virtual void randomize_with_input (uint8_t output[], size_t output_len, const uint8_t input[], size_t input_len)
 
virtual void randomize_with_ts_input (uint8_t output[], size_t output_len)
 
virtual 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)
 
virtual void reseed_from_rng (RandomNumberGenerator &rng, size_t poll_bits=BOTAN_RNG_RESEED_POLL_BITS)
 

Static Public Member Functions

static RandomNumberGeneratormake_rng ()
 

Detailed Description

Hardware_RNG exists to tag hardware RNG types (PKCS11_RNG, TPM_RNG, RDRAND_RNG)

Definition at line 187 of file rng.h.

Member Function Documentation

◆ accepts_input()

virtual bool Botan::RandomNumberGenerator::accepts_input ( ) const
pure virtualinherited

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.

Implemented in Botan::Null_RNG, Botan::TPM_RNG, Botan::Stateful_RNG, Botan::PKCS11::PKCS11_RNG, Botan::RDRAND_RNG, Botan::System_RNG, and Botan::AutoSeeded_RNG.

Referenced by Botan::System_RNG::accepts_input(), Botan::RandomNumberGenerator::randomize_with_ts_input(), Botan::RandomNumberGenerator::reseed(), and Botan::RandomNumberGenerator::reseed_from_rng().

◆ add_entropy()

virtual void Botan::RandomNumberGenerator::add_entropy ( const uint8_t  input[],
size_t  length 
)
pure virtualinherited

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.

Parameters
inputa byte array containg the entropy to be added
lengththe length of the byte array in

Implemented in Botan::Null_RNG, Botan::HMAC_DRBG, Botan::ChaCha_RNG, Botan::TPM_RNG, Botan::RDRAND_RNG, Botan::AutoSeeded_RNG, and Botan::System_RNG.

Referenced by Botan::System_RNG::add_entropy(), botan_rng_add_entropy(), Botan::Stateful_RNG::initialize_with(), Botan::Getentropy::poll(), Botan::Intel_Rdrand::poll(), Botan::Device_EntropySource::poll(), Botan::RandomNumberGenerator::randomize_with_input(), and Botan::RandomNumberGenerator::reseed_from_rng().

◆ add_entropy_T()

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

Incorporate some additional data into the RNG state.

Definition at line 68 of file rng.h.

References T.

Referenced by Botan::Win32_EntropySource::poll().

69  {
70  this->add_entropy(reinterpret_cast<const uint8_t*>(&t), sizeof(T));
71  }
virtual void add_entropy(const uint8_t input[], size_t length)=0
fe T
Definition: ge.cpp:37

◆ clear()

virtual void Botan::Hardware_RNG::clear ( )
inlinefinaloverridevirtual

Clear all internally held values of this RNG

Postcondition
is_seeded() == false

Implements Botan::RandomNumberGenerator.

Definition at line 190 of file rng.h.

190 { /* no way to clear state of hardware RNG */ }

◆ is_seeded()

virtual bool Botan::RandomNumberGenerator::is_seeded ( ) const
pure virtualinherited

Check whether this RNG is seeded.

Returns
true if this RNG was already seeded, false otherwise.

Implemented in Botan::Null_RNG, Botan::TPM_RNG, Botan::Stateful_RNG, Botan::RDRAND_RNG, Botan::PKCS11::PKCS11_RNG, Botan::System_RNG, and Botan::AutoSeeded_RNG.

Referenced by Botan::is_prime(), and Botan::System_RNG::is_seeded().

◆ make_rng()

RandomNumberGenerator * Botan::RandomNumberGenerator::make_rng ( )
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.

70  {
71 #if defined(BOTAN_HAS_AUTO_SEEDING_RNG)
72  return new AutoSeeded_RNG;
73 #else
74  throw Exception("make_rng failed, no AutoSeeded_RNG in this build");
75 #endif
76  }

◆ 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

Definition at line 152 of file rng.h.

Referenced by Botan::random_prime().

153  {
154  uint8_t b;
155  this->randomize(&b, 1);
156  return b;
157  }
virtual void randomize(uint8_t output[], size_t length)=0

◆ next_nonzero_byte()

uint8_t Botan::RandomNumberGenerator::next_nonzero_byte ( )
inlineinherited
Returns
a random byte that is greater than zero

Definition at line 162 of file rng.h.

163  {
164  uint8_t b = this->next_byte();
165  while(b == 0)
166  b = this->next_byte();
167  return b;
168  }

◆ random_vec()

secure_vector<uint8_t> Botan::RandomNumberGenerator::random_vec ( size_t  bytes)
inlineinherited

Return a random vector

Parameters
bytesnumber of bytes in the result
Returns
randomized vector of length bytes

Definition at line 141 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().

142  {
143  secure_vector<uint8_t> output(bytes);
144  this->randomize(output.data(), output.size());
145  return output;
146  }
virtual void randomize(uint8_t output[], size_t length)=0

◆ randomize()

virtual void Botan::RandomNumberGenerator::randomize ( uint8_t  output[],
size_t  length 
)
pure virtualinherited

◆ randomize_with_input()

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

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.

Parameters
outputbuffer to hold the random output
output_lensize of the output buffer in bytes
inputentropy buffer to incorporate
input_lensize of the input buffer in bytes

Reimplemented in Botan::HMAC_DRBG, Botan::ChaCha_RNG, and Botan::AutoSeeded_RNG.

Definition at line 38 of file rng.cpp.

References Botan::RandomNumberGenerator::add_entropy(), and Botan::RandomNumberGenerator::randomize().

Referenced by Botan::Stateful_RNG::randomize_with_ts_input(), and Botan::RandomNumberGenerator::randomize_with_ts_input().

40  {
41  this->add_entropy(input, input_len);
42  this->randomize(output, output_len);
43  }
virtual void add_entropy(const uint8_t input[], size_t length)=0
virtual void randomize(uint8_t output[], size_t length)=0

◆ randomize_with_ts_input()

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

This calls randomize_with_input using some timestamps as extra input.

For a stateful RNG using non-random but potentially unique data 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 a timestamp (and the timestamps don't themselves repeat), their outputs will diverge.

Reimplemented in Botan::Stateful_RNG.

Definition at line 18 of file rng.cpp.

References Botan::RandomNumberGenerator::accepts_input(), Botan::OS::get_high_resolution_clock(), Botan::OS::get_system_timestamp_ns(), Botan::RandomNumberGenerator::randomize(), Botan::RandomNumberGenerator::randomize_with_input(), and Botan::store_le().

19  {
20  if(this->accepts_input())
21  {
22  /*
23  Form additional input which is provided to the PRNG implementation
24  to paramaterize the KDF output.
25  */
26  uint8_t additional_input[16] = { 0 };
27  store_le(OS::get_system_timestamp_ns(), additional_input);
28  store_le(OS::get_high_resolution_clock(), additional_input + 8);
29 
30  this->randomize_with_input(output, output_len, additional_input, sizeof(additional_input));
31  }
32  else
33  {
34  this->randomize(output, output_len);
35  }
36  }
virtual void randomize_with_input(uint8_t output[], size_t output_len, const uint8_t input[], size_t input_len)
Definition: rng.cpp:38
virtual void randomize(uint8_t output[], size_t length)=0
virtual bool accepts_input() const =0
uint64_t BOTAN_TEST_API get_system_timestamp_ns()
Definition: os_utils.cpp:203
void store_le(uint16_t in, uint8_t out[2])
Definition: loadstor.h:450
uint64_t BOTAN_TEST_API get_high_resolution_clock()
Definition: os_utils.cpp:155

◆ reseed()

size_t Botan::RandomNumberGenerator::reseed ( Entropy_Sources srcs,
size_t  poll_bits = BOTAN_RNG_RESEED_POLL_BITS,
std::chrono::milliseconds  poll_timeout = BOTAN_RNG_RESEED_DEFAULT_TIMEOUT 
)
virtualinherited

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 in Botan::Stateful_RNG, Botan::RDRAND_RNG, Botan::PKCS11::PKCS11_RNG, and Botan::AutoSeeded_RNG.

Definition at line 45 of file rng.cpp.

References Botan::RandomNumberGenerator::accepts_input(), and Botan::Entropy_Sources::poll().

Referenced by Botan::Stateful_RNG::reseed().

48  {
49  if(this->accepts_input())
50  {
51  return srcs.poll(*this, poll_bits, poll_timeout);
52  }
53  else
54  {
55  return 0;
56  }
57  }
virtual bool accepts_input() const =0

◆ reseed_from_rng()

void Botan::RandomNumberGenerator::reseed_from_rng ( RandomNumberGenerator rng,
size_t  poll_bits = BOTAN_RNG_RESEED_POLL_BITS 
)
virtualinherited

Reseed by reading specified bits from the RNG

Reimplemented in Botan::Stateful_RNG.

Definition at line 59 of file rng.cpp.

References Botan::RandomNumberGenerator::accepts_input(), Botan::RandomNumberGenerator::add_entropy(), and Botan::RandomNumberGenerator::randomize().

Referenced by botan_rng_reseed(), botan_rng_reseed_from_rng(), and Botan::Stateful_RNG::reseed_from_rng().

60  {
61  if(this->accepts_input())
62  {
63  secure_vector<uint8_t> buf(poll_bits / 8);
64  rng.randomize(buf.data(), buf.size());
65  this->add_entropy(buf.data(), buf.size());
66  }
67  }
virtual void add_entropy(const uint8_t input[], size_t length)=0
virtual bool accepts_input() const =0

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