Botan  2.6.0
Crypto and TLS for C++11
Public Member Functions | Static Public Member Functions | List of all members
Botan::PKCS11::PKCS11_RNG Class Referencefinalabstract

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

#include <p11_randomgenerator.h>

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

Public Member Functions

virtual void add_entropy (const uint8_t input[], size_t length)=0
 
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...
 
template<typename T >
void add_entropy_T (const T &t)
 
virtual void clear () final override
 
bool is_seeded () const override
 Always returns true. More...
 
Modulemodule () 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)
 
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 RandomNumberGeneratormake_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.

16  : m_session(session)
17  {}

Member Function Documentation

◆ add_entropy() [1/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
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::Stateful_RNG::initialize_with(), Botan::Getentropy::poll(), Botan::Intel_Rdrand::poll(), Botan::Darwin_SecRandom::poll(), Botan::Device_EntropySource::poll(), Botan::RandomNumberGenerator::randomize_with_input(), and Botan::RandomNumberGenerator::reseed_from_rng().

◆ add_entropy() [2/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().

25  {
26  module()->C_SeedRandom(m_session.get().handle(), const_cast<uint8_t*>(in), length);
27  }
bool C_SeedRandom(SessionHandle session, Byte *seed_ptr, Ulong seed_len, ReturnValue *return_value=ThrowException) const
Definition: p11.cpp:734

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

References T.

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

60  {
61  this->add_entropy(reinterpret_cast<const uint8_t*>(&t), sizeof(T));
62  }
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 ( )
inlinefinaloverridevirtualinherited

Clear all internally held values of this RNG

Postcondition
is_seeded() == false

Implements Botan::RandomNumberGenerator.

Definition at line 182 of file rng.h.

182 { /* 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.

38  {
39  return true;
40  }

◆ 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 52 of file rng.cpp.

53  {
54 #if defined(BOTAN_HAS_AUTO_SEEDING_RNG)
55  return new AutoSeeded_RNG;
56 #else
57  throw Exception("make_rng failed, no AutoSeeded_RNG in this build");
58 #endif
59  }

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

50  {
51  return m_session.get().module();
52  }

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

32  {
33  return "PKCS11_RNG";
34  }

◆ next_byte()

uint8_t Botan::RandomNumberGenerator::next_byte ( )
inlineinherited

Return a random byte

Returns
random byte

Definition at line 143 of file rng.h.

Referenced by Botan::random_prime().

144  {
145  uint8_t b;
146  this->randomize(&b, 1);
147  return b;
148  }
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 153 of file rng.h.

154  {
155  uint8_t b = this->next_byte();
156  while(b == 0)
157  b = this->next_byte();
158  return b;
159  }

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

133  {
134  secure_vector<uint8_t> output(bytes);
135  this->randomize(output.data(), output.size());
136  return output;
137  }
virtual void randomize(uint8_t output[], size_t length)=0

◆ randomize() [1/2]

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

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

20  {
21  module()->C_GenerateRandom(m_session.get().handle(), output, length);
22  }
bool C_GenerateRandom(SessionHandle session, Byte *random_data_ptr, Ulong random_len, ReturnValue *return_value=ThrowException) const
Definition: p11.cpp:742

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

33  {
34  this->add_entropy(input, input_len);
35  this->randomize(output, output_len);
36  }
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::OS::get_high_resolution_clock(), Botan::OS::get_system_timestamp_ns(), Botan::RandomNumberGenerator::randomize_with_input(), and Botan::store_le().

Referenced by Botan::AutoSeeded_RNG::randomize().

19  {
20  /*
21  Form additional input which is provided to the PRNG implementation
22  to paramaterize the KDF output.
23  */
24  uint8_t additional_input[16] = { 0 };
25  store_le(OS::get_system_timestamp_ns(), additional_input);
26  store_le(OS::get_high_resolution_clock(), additional_input + 8);
27 
28  randomize_with_input(output, output_len, additional_input, sizeof(additional_input));
29  }
virtual void randomize_with_input(uint8_t output[], size_t output_len, const uint8_t input[], size_t input_len)
Definition: rng.cpp:31
uint64_t BOTAN_TEST_API get_system_timestamp_ns()
Definition: os_utils.cpp:186
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:138

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

44  {
45  return 0;
46  }

◆ 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 45 of file rng.cpp.

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

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

46  {
47  secure_vector<uint8_t> buf(poll_bits / 8);
48  rng.randomize(buf.data(), buf.size());
49  this->add_entropy(buf.data(), buf.size());
50  }
virtual void add_entropy(const uint8_t input[], size_t length)=0

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