Botan::ANSI_X931_RNG Class Reference

#include <x931_rng.h>

Inheritance diagram for Botan::ANSI_X931_RNG:

Public Member Functions
void	add_entropy (const byte[], size_t)
void	add_entropy_source (EntropySource *)
	ANSI_X931_RNG (BlockCipher *cipher, RandomNumberGenerator *rng)
void	clear ()
bool	is_seeded () const
std::string	name () const
byte	next_byte ()
SecureVector< byte >	random_vec (size_t bytes)
void	randomize (byte[], size_t)
void	reseed (size_t poll_bits)
	~ANSI_X931_RNG ()

Static Public Member Functions
static RandomNumberGenerator *	make_rng ()

Detailed Description

ANSI X9.31 RNG

Definition at line 19 of file x931_rng.h.

Constructor & Destructor Documentation

ANSI_X931_RNG()

Botan::ANSI_X931_RNG::ANSI_X931_RNG	(	BlockCipher *	cipher,
		RandomNumberGenerator *	rng )

Parameters

cipher	the block cipher to use in this PRNG
rng	the underlying PRNG for generating inputs (eg, an HMAC_RNG)

Definition at line 132 of file x931_rng.cpp.

   {
   if(!prng_in || !cipher_in)
      throw Invalid_Argument("ANSI_X931_RNG constructor: NULL arguments");
 
   cipher = cipher_in;
   prng = prng_in;
 
   R.resize(cipher->block_size());
   position = 0;
   }

References Botan::RandomNumberGenerator::RandomNumberGenerator().

~ANSI_X931_RNG()

Botan::ANSI_X931_RNG::~ANSI_X931_RNG

(

)

Definition at line 148 of file x931_rng.cpp.

   {
   delete cipher;
   delete prng;
   }

Member Function Documentation

add_entropy()

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

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

Implements Botan::RandomNumberGenerator.

Definition at line 94 of file x931_rng.cpp.

   {
   prng->add_entropy(input, length);
   rekey();
   }

add_entropy_source()

void Botan::ANSI_X931_RNG::add_entropy_source ( EntropySource * source )

virtual

Add this entropy source to the RNG object

Parameters

source

the entropy source which will be retained and used by RNG

Implements Botan::RandomNumberGenerator.

Definition at line 86 of file x931_rng.cpp.

   {
   prng->add_entropy_source(src);
   }

clear()

void Botan::ANSI_X931_RNG::clear ( )

virtual

Clear all internally held values of this RNG.

Implements Botan::RandomNumberGenerator.

Definition at line 111 of file x931_rng.cpp.

   {
   cipher->clear();
   prng->clear();
   zeroise(R);
   V.clear();
 
   position = 0;
   }

References Botan::zeroise().

is_seeded()

bool Botan::ANSI_X931_RNG::is_seeded ( ) const

virtual

Check whether this RNG is seeded.

Returns

true if this RNG was already seeded, false otherwise.

Reimplemented from Botan::RandomNumberGenerator.

Definition at line 103 of file x931_rng.cpp.

   {
   return (V.size() > 0);
   }

Referenced by randomize().

make_rng()

RandomNumberGenerator * Botan::RandomNumberGenerator::make_rng ( )

staticinherited

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

std::string Botan::ANSI_X931_RNG::name ( ) const

virtual

Return the name of this object

Implements Botan::RandomNumberGenerator.

Definition at line 124 of file x931_rng.cpp.

   {
   return "X9.31(" + cipher->name() + ")";
   }

Referenced by randomize().

next_byte()

byte Botan::RandomNumberGenerator::next_byte ( )

inherited

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 )

inlineinherited

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

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

virtual

Randomize a byte array.

Parameters

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

Implements Botan::RandomNumberGenerator.

Definition at line 17 of file x931_rng.cpp.

   {
   if(!is_seeded())
      throw PRNG_Unseeded(name());
 
   while(length)
      {
      if(position == R.size())
         update_buffer();
 
      const size_t copied = std::min<size_t>(length, R.size() - position);
 
      copy_mem(out, &R[position], copied);
      out += copied;
      length -= copied;
      position += copied;
      }
   }

References Botan::copy_mem(), is_seeded(), name(), and Botan::PRNG_Unseeded::PRNG_Unseeded().

reseed()

void Botan::ANSI_X931_RNG::reseed ( size_t bits_to_collect )

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

Implements Botan::RandomNumberGenerator.

Definition at line 77 of file x931_rng.cpp.

   {
   prng->reseed(poll_bits);
   rekey();
   }

---

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

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