Botan::PKCS11::PKCS11_RNG Class Reference

A random generator that only fetches random from the PKCS#11 RNG. More...

#include <p11_randomgenerator.h>

Inheritance diagram for Botan::PKCS11::PKCS11_RNG:

Public Member Functions
bool	accepts_input () const override
void	add_entropy (const uint8_t in[], std::size_t length) override
	Calls C_SeedRandom to add entropy to the random generation function of the token/middleware. More...
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
bool	is_seeded () const override
	Always returns true. More...
Module &	module () const
std::string	name () const override
uint8_t	next_byte ()
uint8_t	next_nonzero_byte ()
	PKCS11_RNG (Session &session)
	Initialize the RNG with the PKCS#11 session that provides access to the cryptoki functions. More...
secure_vector< uint8_t >	random_vec (size_t bytes)
template<typename Alloc >
void	random_vec (std::vector< uint8_t, Alloc > &v, size_t bytes)
virtual void	randomize (uint8_t output[], size_t length)=0
void	randomize (uint8_t output[], std::size_t length) override
	Calls C_GenerateRandom to generate random data. More...
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)
size_t	reseed (Entropy_Sources &, size_t, std::chrono::milliseconds) override
	No operation - always returns 0. More...
virtual void	reseed_from_rng (RandomNumberGenerator &rng, size_t poll_bits=BOTAN_RNG_RESEED_POLL_BITS)

Static Public Member Functions
static RandomNumberGenerator *	make_rng ()

Detailed Description

A random generator that only fetches random from the PKCS#11 RNG.

Definition at line 25 of file p11_randomgenerator.h.

Constructor & Destructor Documentation

PKCS11_RNG()

Botan::PKCS11::PKCS11_RNG::PKCS11_RNG ( Session &  session )

explicit

Initialize the RNG with the PKCS#11 session that provides access to the cryptoki functions.

Definition at line 15 of file p11_randomgenerator.cpp.

   : m_session(session)
   {}

Member Function Documentation

accepts_input()

bool Botan::PKCS11::PKCS11_RNG::accepts_input ( ) const

inlineoverridevirtual

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 61 of file p11_randomgenerator.h.

{ return true; }

add_entropy() [1/2]

void Botan::PKCS11::PKCS11_RNG::add_entropy ( const uint8_t  in[], std::size_t  length  )

override

Calls C_SeedRandom to add entropy to the random generation function of the token/middleware.

Definition at line 24 of file p11_randomgenerator.cpp.

References Botan::PKCS11::LowLevel::C_SeedRandom(), and module().

   {
   module()->C_SeedRandom(m_session.get().handle(), const_cast<uint8_t*>(in), Ulong(length));
   }

add_entropy() [2/2]

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

input	a byte array containg the entropy to be added
length	the length of the byte array in

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

Referenced by Botan::System_RNG::add_entropy(), botan_rng_add_entropy(), Botan::Stateful_RNG::initialize_with(), Botan::POWER9_DARN::poll(), Botan::Intel_Rdrand::poll(), Botan::Intel_Rdseed::poll(), Botan::Getentropy::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().

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

clear()

virtual void Botan::Hardware_RNG::clear ( )

inlinefinaloverridevirtualinherited

Clear all internally held values of this RNG

Postcondition

is_seeded() == false

Implements Botan::RandomNumberGenerator.

Definition at line 197 of file rng.h.

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

is_seeded()

bool Botan::PKCS11::PKCS11_RNG::is_seeded ( ) const

inlineoverridevirtual

Always returns true.

Implements Botan::RandomNumberGenerator.

Definition at line 37 of file p11_randomgenerator.h.

         {
         return true;
         }

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
   }

module()

Module& Botan::PKCS11::PKCS11_RNG::module ( ) const

inline

Returns

the module used by this RNG

Definition at line 49 of file p11_randomgenerator.h.

Referenced by add_entropy(), and randomize().

         {
         return m_session.get().module();
         }

name()

std::string Botan::PKCS11::PKCS11_RNG::name ( ) const

inlineoverridevirtual

Returns

the name of this RNG type

Implements Botan::RandomNumberGenerator.

Definition at line 31 of file p11_randomgenerator.h.

         {
         return "PKCS11_RNG";
         }

next_byte()

uint8_t Botan::RandomNumberGenerator::next_byte ( )

inlineinherited

Return a random byte

Returns

random byte

Definition at line 159 of file rng.h.

Referenced by Botan::random_prime().

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

next_nonzero_byte()

uint8_t Botan::RandomNumberGenerator::next_nonzero_byte ( )

inlineinherited

Returns

a random byte that is greater than zero

Definition at line 169 of file rng.h.

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

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

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

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

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

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

randomize() [1/2]

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

pure virtualinherited

Randomize a byte array.

Parameters

output	the byte array to hold the random output.
length	the length of the byte array output in bytes.

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

Referenced by Botan::TLS::Connection_Cipher_State::aead_nonce(), Botan::argon2_generate_pwhash(), botan_rng_get(), Botan::CryptoBox::encrypt(), Botan::generate_dsa_primes(), Botan::generate_passhash9(), Botan::TLS::make_hello_random(), Botan::newhope_keygen(), Botan::Roughtime::Nonce::Nonce(), Botan::EME_PKCS1v15::pad(), Botan::random_gf2m(), Botan::McEliece_PublicKey::random_plaintext_element(), Botan::Sodium::randombytes_buf(), Botan::System_RNG::randomize(), Botan::RandomNumberGenerator::randomize_with_input(), Botan::RandomNumberGenerator::randomize_with_ts_input(), Botan::RandomNumberGenerator::reseed_from_rng(), Botan::KeyPair::signature_consistency_check(), Botan::RTSS_Share::split(), and Botan::UUID::UUID().

randomize() [2/2]

void Botan::PKCS11::PKCS11_RNG::randomize ( uint8_t  output[], std::size_t  length  )

override

Calls C_GenerateRandom to generate random data.

Definition at line 19 of file p11_randomgenerator.cpp.

References Botan::PKCS11::LowLevel::C_GenerateRandom(), and module().

   {
   module()->C_GenerateRandom(m_session.get().handle(), output, Ulong(length));
   }

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

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

   {
   this->add_entropy(input, input_len);
   this->randomize(output, output_len);
   }

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

   {
   if(this->accepts_input())
      {
      /*
      Form additional input which is provided to the PRNG implementation
      to paramaterize the KDF output.
      */
      uint8_t additional_input[16] = { 0 };
      store_le(OS::get_system_timestamp_ns(), additional_input);
      store_le(OS::get_high_resolution_clock(), additional_input + 8);

      this->randomize_with_input(output, output_len, additional_input, sizeof(additional_input));
      }
   else
      {
      this->randomize(output, output_len);
      }
   }

reseed()

size_t Botan::PKCS11::PKCS11_RNG::reseed ( Entropy_Sources &  , size_t  , std::chrono::milliseconds    )

inlineoverridevirtual

No operation - always returns 0.

Reimplemented from Botan::RandomNumberGenerator.

Definition at line 43 of file p11_randomgenerator.h.

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

   {
   if(this->accepts_input())
      {
      secure_vector<uint8_t> buf(poll_bits / 8);
      rng.randomize(buf.data(), buf.size());
      this->add_entropy(buf.data(), buf.size());
      }
   }

---

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

• src/lib/prov/pkcs11/p11_randomgenerator.h
• src/lib/prov/pkcs11/p11_randomgenerator.cpp