Botan::Stateful_RNG Class Reference

#include <stateful_rng.h>

Inheritance diagram for Botan::Stateful_RNG:

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

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 26 of file stateful_rng.h.

Constructor & Destructor Documentation

Stateful_RNG() [1/4]

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

inline

Parameters

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.

                                           :
         m_underlying_rng(&rng),
         m_entropy_sources(&entropy_sources),
         m_reseed_interval(reseed_interval)
         {}

Stateful_RNG() [2/4]

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

inline

Parameters

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.

                                                                       :
         m_underlying_rng(&rng),
         m_reseed_interval(reseed_interval)
         {}

Stateful_RNG() [3/4]

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

inline

Parameters

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.

                                                                             :
         m_entropy_sources(&entropy_sources),
         m_reseed_interval(reseed_interval)
         {}

Stateful_RNG() [4/4]

Botan::Stateful_RNG::Stateful_RNG ( )

inline

In this case, automatic reseeding is impossible

Definition at line 68 of file stateful_rng.h.

: m_reseed_interval(0) {}

Member Function Documentation

accepts_input()

bool Botan::Stateful_RNG::accepts_input ( ) const

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.

{ return true; }

add_entropy()

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

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.

Parameters

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.

   {
   lock_guard_type<recursive_mutex_type> lock(m_mutex);
 
   update(input, input_len);
 
   if(8*input_len >= security_level())
      {
      reset_reseed_counter();
      }
   }

References security_level(), and update().

Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), and initialize_with().

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 69 of file rng.h.

         {
         static_assert(std::is_standard_layout<T>::value && std::is_trivial<T>::value, "add_entropy_T data must be POD");
         this->add_entropy(reinterpret_cast<const uint8_t*>(&t), sizeof(T));
         }

References T.

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

clear()

void Botan::Stateful_RNG::clear ( )

finaloverridevirtual

Clear all internally held values of this RNG

Postcondition

is_seeded() == false

Implements Botan::RandomNumberGenerator.

Definition at line 17 of file stateful_rng.cpp.

   {
   lock_guard_type<recursive_mutex_type> lock(m_mutex);
   m_reseed_counter = 0;
   m_last_pid = 0;
   clear_state();
   }

References clear_state().

Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), Botan::HMAC_DRBG::HMAC_DRBG(), and initialize_with().

clear_state()

virtual void Botan::Stateful_RNG::clear_state ( )

protectedpure virtual

Referenced by clear().

force_reseed()

void Botan::Stateful_RNG::force_reseed

(

)

Mark state as requiring a reseed on next use

Definition at line 25 of file stateful_rng.cpp.

   {
   lock_guard_type<recursive_mutex_type> lock(m_mutex);
   m_reseed_counter = 0;
   }

generate_output()

virtual void Botan::Stateful_RNG::generate_output ( uint8_t  output[], size_t  output_len, const uint8_t  input[], size_t  input_len  )

protectedpure virtual

Referenced by randomize_with_input().

initialize_with()

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.

   {
   lock_guard_type<recursive_mutex_type> lock(m_mutex);
 
   clear();
   add_entropy(input, len);
   }

References add_entropy(), and clear().

is_seeded()

bool Botan::Stateful_RNG::is_seeded ( ) const

finaloverridevirtual

Check whether this RNG is seeded.

Returns

true if this RNG was already seeded, false otherwise.

Implements Botan::RandomNumberGenerator.

Definition at line 31 of file stateful_rng.cpp.

   {
   lock_guard_type<recursive_mutex_type> lock(m_mutex);
   return m_reseed_counter > 0;
   }

Referenced by reseed_check().

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.

   {
#if defined(BOTAN_HAS_AUTO_SEEDING_RNG)
   return new AutoSeeded_RNG;
#else
   throw Not_Implemented("make_rng failed, no AutoSeeded_RNG in this build");
#endif
   }

max_number_of_bytes_per_request()

virtual size_t Botan::Stateful_RNG::max_number_of_bytes_per_request ( ) const

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.

Returns

max number of bytes per request (or zero)

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

Referenced by randomize_with_input().

name()

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

pure virtualinherited

Returns

the name of this RNG type

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

next_byte()

uint8_t Botan::RandomNumberGenerator::next_byte ( )

inlineinherited

Return a random byte

Returns

random byte

Definition at line 161 of file rng.h.

         {
         uint8_t b;
         this->randomize(&b, 1);
         return b;
         }

Referenced by Botan::random_prime().

next_nonzero_byte()

uint8_t Botan::RandomNumberGenerator::next_nonzero_byte ( )

inlineinherited

Returns

a random byte that is greater than zero

Definition at line 171 of file rng.h.

         {
         uint8_t b = this->next_byte();
         while(b == 0)
            b = this->next_byte();
         return b;
         }

Referenced by Botan::EME_PKCS1v15::pad().

random_vec() [1/2]

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

inlineinherited

Return a random vector

Parameters

bytes

number of bytes in the result

Returns

randomized vector of length bytes

Definition at line 143 of file rng.h.

         {
         secure_vector<uint8_t> output;
         random_vec(output, bytes);
         return output;
         }

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

random_vec() [2/2]

template<typename Alloc >

void Botan::RandomNumberGenerator::random_vec ( std::vector< uint8_t, Alloc > &  v, size_t  bytes  )

inlineinherited

Definition at line 151 of file rng.h.

         {
         v.resize(bytes);
         this->randomize(v.data(), v.size());
         }

randomize()

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

finaloverridevirtual

Randomize a byte array.

Parameters

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.

   {
   randomize_with_input(output, output_len, nullptr, 0);
   }

References randomize_with_input().

randomize_with_input()

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

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.

Parameters

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.

   {
   if(output_len == 0)
      return;
 
   lock_guard_type<recursive_mutex_type> lock(m_mutex);
 
   const size_t max_per_request = max_number_of_bytes_per_request();
 
   if(max_per_request == 0) // no limit
      {
      reseed_check();
      this->generate_output(output, output_len, input, input_len);
      }
   else
      {
      while(output_len > 0)
         {
         const size_t this_req = std::min(max_per_request, output_len);
 
         /*
         * We split the request into several requests to the underlying DRBG but
         * pass the input to each invocation. It might be more sensible to only
         * provide it for the first invocation, however between 2.0 and 2.15
         * HMAC_DRBG always provided it for all requests so retain that here.
         */
 
         reseed_check();
         this->generate_output(output, this_req, input, input_len);
 
         output += this_req;
         output_len -= this_req;
         }
      }
   }

References generate_output(), max_number_of_bytes_per_request(), and reseed_check().

Referenced by randomize(), and randomize_with_ts_input().

randomize_with_ts_input()

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

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.

   {
   uint8_t additional_input[20] = { 0 };
 
   store_le(OS::get_high_resolution_clock(), additional_input);
 
#if defined(BOTAN_HAS_SYSTEM_RNG)
   System_RNG system_rng;
   system_rng.randomize(additional_input + 8, sizeof(additional_input) - 8);
#else
   store_le(OS::get_system_timestamp_ns(), additional_input + 8);
   store_le(OS::get_process_id(), additional_input + 16);
#endif
 
   randomize_with_input(output, output_len, additional_input, sizeof(additional_input));
   }

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

reseed()

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

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.

   {
   lock_guard_type<recursive_mutex_type> lock(m_mutex);
 
   const size_t bits_collected = RandomNumberGenerator::reseed(srcs, poll_bits, poll_timeout);
 
   if(bits_collected >= security_level())
      {
      reset_reseed_counter();
      }
 
   return bits_collected;
   }

References Botan::RandomNumberGenerator::reseed(), and security_level().

Referenced by reseed_check().

reseed_check()

void Botan::Stateful_RNG::reseed_check ( )

protected

Definition at line 150 of file stateful_rng.cpp.

   {
   // Lock is held whenever this function is called
 
   const uint32_t cur_pid = OS::get_process_id();
 
   const bool fork_detected = (m_last_pid > 0) && (cur_pid != m_last_pid);
 
   if(is_seeded() == false ||
      fork_detected ||
      (m_reseed_interval > 0 && m_reseed_counter >= m_reseed_interval))
      {
      m_reseed_counter = 0;
      m_last_pid = cur_pid;
 
      if(m_underlying_rng)
         {
         reseed_from_rng(*m_underlying_rng, security_level());
         }
 
      if(m_entropy_sources)
         {
         reseed(*m_entropy_sources, security_level());
         }
 
      if(!is_seeded())
         {
         if(fork_detected)
            throw Invalid_State("Detected use of fork but cannot reseed DRBG");
         else
            throw PRNG_Unseeded(name());
         }
      }
   else
      {
      BOTAN_ASSERT(m_reseed_counter != 0, "RNG is seeded");
      m_reseed_counter += 1;
      }
   }

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

reseed_from_rng()

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

finaloverridevirtual

Reseed by reading specified bits from the RNG

Reimplemented from Botan::RandomNumberGenerator.

Definition at line 132 of file stateful_rng.cpp.

   {
   lock_guard_type<recursive_mutex_type> lock(m_mutex);
 
   RandomNumberGenerator::reseed_from_rng(rng, poll_bits);
 
   if(poll_bits >= security_level())
      {
      reset_reseed_counter();
      }
   }

References Botan::RandomNumberGenerator::reseed_from_rng(), and security_level().

Referenced by reseed_check().

reseed_interval()

size_t Botan::Stateful_RNG::reseed_interval ( ) const

inline

Definition at line 128 of file stateful_rng.h.

{ return m_reseed_interval; }

Referenced by Botan::HMAC_DRBG::HMAC_DRBG().

security_level()

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

pure virtual

Returns

intended security level of this DRBG

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

Referenced by add_entropy(), reseed(), reseed_check(), and reseed_from_rng().

update()

virtual void Botan::Stateful_RNG::update ( const uint8_t  input[], size_t  input_len  )

protectedpure virtual

Referenced by add_entropy().

---

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

• src/lib/rng/stateful_rng/stateful_rng.h
• src/lib/rng/stateful_rng/stateful_rng.cpp