Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
AutoSeededRandomPool Class Reference

Automatically Seeded Randomness Pool. More...

+ Inheritance diagram for AutoSeededRandomPool:

Public Member Functions

 AutoSeededRandomPool (bool blocking=false, unsigned int seedSize=32)
 Construct an AutoSeededRandomPool. More...
 
void Reseed (bool blocking=false, unsigned int seedSize=32)
 Reseed an AutoSeededRandomPool. More...
 
bool CanIncorporateEntropy () const
 Determines if a generator can accept additional entropy. More...
 
void IncorporateEntropy (const byte *input, size_t length)
 Update RNG state with additional unpredictable values. More...
 
void GenerateIntoBufferedTransformation (BufferedTransformation &target, const std::string &channel, lword size)
 Generate random bytes into a BufferedTransformation. More...
 
void Put (const byte *input, size_t length)
 
virtual byte GenerateByte ()
 Generate new random byte and return it. More...
 
virtual unsigned int GenerateBit ()
 Generate new random bit and return it. More...
 
virtual word32 GenerateWord32 (word32 min=0, word32 max=0xffffffffUL)
 Generate a random 32 bit word in the range min to max, inclusive. More...
 
virtual void GenerateBlock (byte *output, size_t size)
 Generate random array of bytes. More...
 
virtual void DiscardBytes (size_t n)
 Generate and discard n bytes. More...
 
template<class IT >
void Shuffle (IT begin, IT end)
 Randomly shuffle the specified array. More...
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
virtual ClonableClone () const
 Copies this object. More...
 

Detailed Description

Automatically Seeded Randomness Pool.

This class seeds itself using an operating system provided RNG.

Definition at line 140 of file osrng.h.

Constructor & Destructor Documentation

AutoSeededRandomPool::AutoSeededRandomPool ( bool  blocking = false,
unsigned int  seedSize = 32 
)
inlineexplicit

Construct an AutoSeededRandomPool.

Parameters
blockingcontrols seeding with BlockingRng or NonblockingRng
seedSizethe size of the seed, in bytes

Use blocking to choose seeding with BlockingRng or NonblockingRng. The parameter is ignored if only one of these is available.

Definition at line 148 of file osrng.h.

Member Function Documentation

void AutoSeededRandomPool::Reseed ( bool  blocking = false,
unsigned int  seedSize = 32 
)

Reseed an AutoSeededRandomPool.

Parameters
blockingcontrols seeding with BlockingRng or NonblockingRng
seedSizethe size of the seed, in bytes

Definition at line 181 of file osrng.cpp.

References OS_GenerateRandomBlock().

bool RandomPool::CanIncorporateEntropy ( ) const
inlinevirtualinherited

Determines if a generator can accept additional entropy.

Returns
true if IncorporateEntropy() is implemented

Reimplemented from RandomNumberGenerator.

Definition at line 20 of file randpool.h.

void RandomPool::IncorporateEntropy ( const byte *  input,
size_t  length 
)
virtualinherited

Update RNG state with additional unpredictable values.

Parameters
inputthe entropy to add to the generator
lengththe size of the input buffer
Exceptions
NotImplemented

A generator may or may not accept additional entropy. Call CanIncorporateEntropy() to test for the ability to use additional entropy.

If a derived class does not override IncorporateEntropy(), then the base class throws NotImplemented.

Reimplemented from RandomNumberGenerator.

Definition at line 26 of file randpool.cpp.

References HashTransformation::Final().

void RandomPool::GenerateIntoBufferedTransformation ( BufferedTransformation target,
const std::string &  channel,
lword  length 
)
virtualinherited

Generate random bytes into a BufferedTransformation.

Parameters
targetthe BufferedTransformation object which receives the bytes
channelthe channel on which the bytes should be pumped
lengththe number of bytes to generate

The default implementation calls GenerateBlock() and pumps the result into the DEFAULT_CHANNEL of the target.

All generated values are uniformly distributed over the range specified within the the contraints of a particular generator.

Note
A derived generator must override either GenerateBlock() or GenerateIntoBufferedTransformation(). They can override both, or have one call the other.

Reimplemented from RandomNumberGenerator.

Definition at line 35 of file randpool.cpp.

References BufferedTransformation::ChannelPut(), CRYPTOPP_COMPILE_ASSERT, SecBlock< T, A >::data(), BlockTransformation::ProcessBlock(), SimpleKeyingInterface::SetKey(), SecBlock< T, A >::size(), and UnsignedMin().

byte RandomNumberGenerator::GenerateByte ( )
virtualinherited

Generate new random byte and return it.

Returns
a random 8-bit byte

Default implementation calls GenerateBlock() with one byte.

All generated values are uniformly distributed over the range specified within the the contraints of a particular generator.

Reimplemented in ClassNullRNG, and PublicBlumBlumShub.

Definition at line 294 of file cryptlib.cpp.

unsigned int RandomNumberGenerator::GenerateBit ( )
virtualinherited

Generate new random bit and return it.

Returns
a random bit

The default implementation calls GenerateByte() and return its lowest bit.

All generated values are uniformly distributed over the range specified within the the contraints of a particular generator.

Reimplemented in ClassNullRNG, and PublicBlumBlumShub.

Definition at line 289 of file cryptlib.cpp.

Referenced by TestDataNameValuePairs::GetVoidValue().

word32 RandomNumberGenerator::GenerateWord32 ( word32  min = 0,
word32  max = 0xffffffffUL 
)
virtualinherited

Generate a random 32 bit word in the range min to max, inclusive.

Parameters
minthe lower bound of the range
maxthe upper bound of the range
Returns
a random 32-bit word

The default implementation calls Crop() on the difference between max and min, and then returns the result added to min.

All generated values are uniformly distributed over the range specified within the the contraints of a particular generator.

Reimplemented in ClassNullRNG, and MersenneTwister< K, M, N, F, S >.

Definition at line 301 of file cryptlib.cpp.

References BitPrecision(), and Crop().

Referenced by MaurerProvablePrime(), PKCS_EncryptionPaddingScheme::MaxUnpaddedLength(), MihailescuProvablePrime(), and FilterTester::Put2().

void RandomNumberGenerator::GenerateBlock ( byte *  output,
size_t  size 
)
virtualinherited

Generate random array of bytes.

Parameters
outputthe byte buffer
sizethe length of the buffer, in bytes

All generated values are uniformly distributed over the range specified within the the contraints of a particular generator.

Note
A derived generator must override either GenerateBlock() or GenerateIntoBufferedTransformation(). They can override both, or have one call the other.

Reimplemented in KDF2_RNG, ClassNullRNG, RDSEED, AdditiveCipherTemplate< BASE >, AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > >, BlockingRng, NonblockingRng, RDRAND, FixedRNG, MersenneTwister< K, M, N, F, S >, Weak::ARC4_Base, LC_RNG, and PublicBlumBlumShub.

Definition at line 329 of file cryptlib.cpp.

Referenced by FixedRNG::GenerateBlock(), SimpleKeyingInterface::GetNextIV(), OAEP_Base::MaxUnpaddedLength(), PolynomialMod2::PolynomialMod2(), FilterTester::Put2(), Integer::Randomize(), and X917RNG::X917RNG().

void RandomNumberGenerator::DiscardBytes ( size_t  n)
virtualinherited

Generate and discard n bytes.

Parameters
nthe number of bytes to generate and discard

Reimplemented in ClassNullRNG, RDSEED, MersenneTwister< K, M, N, F, S >, RDRAND, and Weak::ARC4_Base.

Definition at line 342 of file cryptlib.cpp.

References TheBitBucket().

template<class IT >
void RandomNumberGenerator::Shuffle ( IT  begin,
IT  end 
)
inlineinherited

Randomly shuffle the specified array.

Parameters
beginan iterator to the first element in the array
endan iterator beyond the last element in the array

The resulting permutation is uniformly distributed.

Definition at line 1159 of file cryptlib.h.

References GetByte(), and NullRNG().

virtual std::string Algorithm::AlgorithmName ( ) const
inlinevirtualinherited

Provides the name of this algorithm.

Returns
the standard algorithm name

The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.

Note
AlgorithmName is not universally implemented yet

Reimplemented in AuthenticatedSymmetricCipher, SignatureVerificationFilter, SignerFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, HashFilter, StreamTransformationFilter, ClassNullRNG, BitBucket, RDSEED, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, HMAC< T >, RDRAND, CRC32, GCM_Base, Adler32, EAX_Base, CCM_Base, SHA3, and VMAC_Base.

Definition at line 488 of file cryptlib.h.

Referenced by VariableRounds< 6, 2 >::StaticGetDefaultRounds().

virtual Clonable* Clonable::Clone ( ) const
inlinevirtualinherited

Copies this object.

Returns
a copy of this object
Exceptions
NotImplemented
Note
this is not implemented by most classes
See also
NotCopyable

Definition at line 464 of file cryptlib.h.


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