RDRAND Class Reference

Hardware generated random numbers using RDRAND instruction. More...

Inheritance diagram for RDRAND:
RandomNumberGenerator Algorithm Clonable

List of all members.

Public Member Functions

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

Detailed Description

Hardware generated random numbers using RDRAND instruction.

See also:
MaurerRandomnessTest() for random bit generators

Definition at line 37 of file rdrand.h.


Constructor & Destructor Documentation

RDRAND::RDRAND ( unsigned int  retries = 8  )  [inline]

Construct a RDRAND generator.

Parameters:
retries the number of retries for failed calls to the hardware

RDRAND() constructs a generator with a maximum number of retires for failed generation attempts.

Definition at line 46 of file rdrand.h.


Member Function Documentation

std::string RDRAND::AlgorithmName (  )  const [inline, virtual]

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 from Algorithm.

Definition at line 40 of file rdrand.h.

unsigned int RDRAND::GetRetries (  )  const [inline]

Retrieve the number of retries used by the generator.

Returns:
the number of times GenerateBlock() will attempt to recover from a failed generation

Definition at line 52 of file rdrand.h.

void RDRAND::SetRetries ( unsigned int  retries  )  [inline]

Set the number of retries used by the generator.

Parameters:
retries number of times GenerateBlock() will attempt to recover from a failed generation

Definition at line 59 of file rdrand.h.

virtual void RDRAND::GenerateBlock ( byte *  output,
size_t  size 
) [inline, virtual]

Generate random array of bytes.

Parameters:
output the byte buffer
size the length of the buffer, in bytes

Reimplemented from RandomNumberGenerator.

Definition at line 70 of file rdrand.h.

virtual void RDRAND::DiscardBytes ( size_t  n  )  [inline, virtual]

Generate and discard n bytes.

Parameters:
n the number of bytes to generate and discard

the RDSEED generator discards words, not bytes. If n is not a multiple of a machine word, then it is rounded up to that size.

Reimplemented from RandomNumberGenerator.

Definition at line 84 of file rdrand.h.

virtual void RDRAND::IncorporateEntropy ( const byte *  input,
size_t  length 
) [inline, virtual]

Update RNG state with additional unpredictable values.

Parameters:
input unused
length unused

The operation is a nop for this generator.

Reimplemented from RandomNumberGenerator.

Definition at line 94 of file rdrand.h.

virtual bool RandomNumberGenerator::CanIncorporateEntropy (  )  const [inline, virtual, inherited]

Determines if a generator can accept additional entropy.

Returns:
true if IncorporateEntropy() is implemented

Reimplemented in ClassNullRNG, AutoSeededX917RNG< BLOCK_CIPHER >, and RandomPool.

Definition at line 1104 of file cryptlib.h.

Referenced by DL_SignerBase< SCHEME_OPTIONS::Element >::SignAndRestart().

byte RandomNumberGenerator::GenerateByte (  )  [virtual, inherited]

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 PublicBlumBlumShub, and ClassNullRNG.

Definition at line 294 of file cryptlib.cpp.

References RandomNumberGenerator::GenerateBlock().

Referenced by RandomNumberGenerator::GenerateBit().

unsigned int RandomNumberGenerator::GenerateBit (  )  [virtual, inherited]

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 PublicBlumBlumShub, and ClassNullRNG.

Definition at line 289 of file cryptlib.cpp.

References RandomNumberGenerator::GenerateByte().

word32 RandomNumberGenerator::GenerateWord32 ( word32  min = 0,
word32  max = 0xffffffffUL 
) [virtual, inherited]

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

Parameters:
min the lower bound of the range
max the 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(), Crop(), and RandomNumberGenerator::GenerateBlock().

Referenced by MaurerProvablePrime(), and MihailescuProvablePrime().

void RandomNumberGenerator::GenerateIntoBufferedTransformation ( BufferedTransformation target,
const std::string &  channel,
lword  length 
) [virtual, inherited]

Generate random bytes into a BufferedTransformation.

Parameters:
target the BufferedTransformation object which receives the bytes
channel the channel on which the bytes should be pumped
length the 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 in ClassNullRNG, AutoSeededX917RNG< BLOCK_CIPHER >, RandomPool, and X917RNG.

Definition at line 347 of file cryptlib.cpp.

References BufferedTransformation::ChannelPut(), RandomNumberGenerator::GenerateBlock(), SecBlock< T, A >::size(), and UnsignedMin().

Referenced by RandomNumberGenerator::DiscardBytes(), and RandomNumberGenerator::GenerateBlock().

template<class IT >
void RandomNumberGenerator::Shuffle ( IT  begin,
IT  end 
) [inline, inherited]

Randomly shuffle the specified array.

Parameters:
begin an iterator to the first element in the array
end an iterator beyond the last element in the array

The resulting permutation is uniformly distributed.

Reimplemented in ClassNullRNG.

Definition at line 1159 of file cryptlib.h.

virtual Clonable* Clonable::Clone (  )  const [inline, virtual, inherited]

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 file:

Generated on 24 Mar 2016 for Crypto++ by  doxygen 1.6.1