Botan::RandomNumberGenerator Class Reference

#include <rng.h>

Inheritance diagram for Botan::RandomNumberGenerator:

Public Member Functions
virtual void	add_entropy (const byte in[], size_t length)=0
virtual void	add_entropy_source (EntropySource *source)=0
virtual void	clear ()=0
virtual bool	is_seeded () const
virtual std::string	name () const =0
byte	next_byte ()
SecureVector< byte >	random_vec (size_t bytes)
virtual void	randomize (byte output[], size_t length)=0
	RandomNumberGenerator ()
virtual void	reseed (size_t bits_to_collect)=0
virtual	~RandomNumberGenerator ()

Static Public Member Functions
static RandomNumberGenerator *	make_rng ()

Detailed Description

This class represents a random number (RNG) generator object.

Definition at line 20 of file rng.h.

Constructor & Destructor Documentation

RandomNumberGenerator()

Botan::RandomNumberGenerator::RandomNumberGenerator ( )

inline

Definition at line 89 of file rng.h.

{}

Referenced by Botan::ANSI_X931_RNG::ANSI_X931_RNG(), and make_rng().

~RandomNumberGenerator()

virtual Botan::RandomNumberGenerator::~RandomNumberGenerator ( )

inlinevirtual

Definition at line 90 of file rng.h.

{}

Member Function Documentation

add_entropy()

virtual void Botan::RandomNumberGenerator::add_entropy ( const byte in[], size_t length )

pure virtual

Add entropy to this RNG.

Parameters

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

Implemented in Botan::ANSI_X931_RNG, Botan::AutoSeeded_RNG, Botan::HMAC_RNG, Botan::Null_RNG, and Botan::Randpool.

Referenced by Botan::DSA_Signature_Operation::sign(), Botan::ECDSA_Signature_Operation::sign(), and Botan::NR_Signature_Operation::sign().

add_entropy_source()

virtual void Botan::RandomNumberGenerator::add_entropy_source ( EntropySource * source )

pure virtual

Add this entropy source to the RNG object

Parameters

source

the entropy source which will be retained and used by RNG

Implemented in Botan::ANSI_X931_RNG, Botan::AutoSeeded_RNG, Botan::HMAC_RNG, Botan::Null_RNG, and Botan::Randpool.

clear()

virtual void Botan::RandomNumberGenerator::clear ( )

pure virtual

Clear all internally held values of this RNG.

Implemented in Botan::ANSI_X931_RNG, Botan::AutoSeeded_RNG, Botan::HMAC_RNG, Botan::Null_RNG, and Botan::Randpool.

is_seeded()

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

inlinevirtual

Check whether this RNG is seeded.

Returns

true if this RNG was already seeded, false otherwise.

Reimplemented in Botan::ANSI_X931_RNG, Botan::AutoSeeded_RNG, Botan::HMAC_RNG, Botan::Null_RNG, and Botan::Randpool.

Definition at line 57 of file rng.h.

{ return true; }

make_rng()

RandomNumberGenerator * Botan::RandomNumberGenerator::make_rng ( )

static

Create a seeded and active RNG object for general application use

Definition at line 29 of file rng.cpp.

   {
#if defined(BOTAN_HAS_AUTO_SEEDING_RNG)
   return new AutoSeeded_RNG;
#endif
 
   throw Algorithm_Not_Found("RandomNumberGenerator::make_rng - no RNG found");
   }

References Botan::Algorithm_Not_Found::Algorithm_Not_Found(), and RandomNumberGenerator().

name()

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

pure virtual

Return the name of this object

Implemented in Botan::ANSI_X931_RNG, Botan::AutoSeeded_RNG, Botan::HMAC_RNG, Botan::Null_RNG, and Botan::Randpool.

next_byte()

byte Botan::RandomNumberGenerator::next_byte

(

)

Return a random byte

Returns

random byte

Definition at line 19 of file rng.cpp.

   {
   byte out;
   this->randomize(&out, 1);
   return out;
   }

References randomize().

Referenced by Botan::random_prime().

random_vec()

SecureVector< byte > Botan::RandomNumberGenerator::random_vec ( size_t bytes )

inline

Return a random vector

Parameters

bytes

number of bytes in the result

Returns

randomized vector of length bytes

Definition at line 40 of file rng.h.

         {
         SecureVector<byte> output(bytes);
         randomize(&output[0], output.size());
         return output;
         }

References randomize(), and Botan::MemoryRegion< T >::size().

Referenced by Botan::Client_Hello::Client_Hello(), Botan::Client_Key_Exchange::Client_Key_Exchange(), Botan::KeyPair::encryption_consistency_check(), Botan::generate_bcrypt(), Botan::generate_dsa_primes(), Botan::OctetString::OctetString(), Botan::Client_Key_Exchange::pre_master_secret(), Botan::BigInt::randomize(), Botan::Server_Hello::Server_Hello(), and Botan::KeyPair::signature_consistency_check().

randomize()

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

pure virtual

Randomize a byte array.

Parameters

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

Implemented in Botan::ANSI_X931_RNG, Botan::AutoSeeded_RNG, Botan::HMAC_RNG, Botan::Null_RNG, and Botan::Randpool.

Referenced by Botan::algorithm_benchmark(), Botan::CryptoBox::encrypt(), Botan::generate_passhash9(), next_byte(), random_vec(), and Botan::RTSS_Share::split().

reseed()

virtual void Botan::RandomNumberGenerator::reseed ( size_t bits_to_collect )

pure virtual

Seed this RNG using the entropy sources it contains.

Parameters

bits_to_collect

is the number of bits of entropy to attempt to gather from the entropy sources

Implemented in Botan::ANSI_X931_RNG, Botan::AutoSeeded_RNG, Botan::HMAC_RNG, Botan::Null_RNG, and Botan::Randpool.

---

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

• src/rng/rng.h
• src/rng/rng.cpp