X917RNG Class Reference

ANSI X9.17 RNG. More...

Inheritance diagram for X917RNG:
RandomNumberGenerator NotCopyable Algorithm Clonable

List of all members.

Public Member Functions

 X917RNG (BlockTransformation *cipher, const byte *seed, const byte *deterministicTimeVector=0)
 Construct a X917RNG.
void GenerateIntoBufferedTransformation (BufferedTransformation &target, const std::string &channel, lword size)
 Generate random bytes into a BufferedTransformation.
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 GenerateBlock (byte *output, size_t size)
 Generate random array of bytes.
virtual void DiscardBytes (size_t n)
 Generate and discard n bytes.
template<class IT >
void Shuffle (IT begin, IT end)
 Randomly shuffle the specified array.
virtual std::string AlgorithmName () const
 Provides the name of this algorithm.
virtual ClonableClone () const
 Copies this object.

Detailed Description

ANSI X9.17 RNG.

X917RNG is from ANSI X9.17 Appendix C.

See also:
AutoSeededX917RNG, DefaultAutoSeededRNG

Definition at line 47 of file rng.h.


Constructor & Destructor Documentation

X917RNG::X917RNG ( BlockTransformation cipher,
const byte *  seed,
const byte *  deterministicTimeVector = 0 
)

Construct a X917RNG.

Parameters:
cipher the block cipher to use for the generator
seed a byte buffer to use as a seed
deterministicTimeVector additional entropy

cipher will be deleted by the destructor. seed must be at least BlockSize() in length. deterministicTimeVector = 0 means obtain time vector from the system.

When constructing an AutoSeededX917RNG, the generator must be keyed or an access violation will occur because the time vector is encrypted using the block cipher. To key the generator during constructions, perform the following:

	      SecByteBlock key(AES::DEFAULT_KEYLENGTH), seed(AES::BLOCKSIZE);
	      OS_GenerateRandomBlock(false, key, key.size());
	      OS_GenerateRandomBlock(false, seed, seed.size());
	      X917RNG prng(new AES::Encryption(key, AES::DEFAULT_KEYLENGTH), seed, NULL);
	    
See also:
AutoSeededX917RNG

Definition at line 61 of file rng.cpp.

References RandomNumberGenerator::GenerateBlock(), and UnsignedMin().


Member Function Documentation

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

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

Definition at line 83 of file rng.cpp.

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

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

Update RNG state with additional unpredictable values.

Parameters:
input the entropy to add to the generator
length the 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 in ClassNullRNG, AutoSeededX917RNG< BLOCK_CIPHER >, RandomPool, RDRAND, and RDSEED.

Definition at line 1096 of file cryptlib.h.

Referenced by RandomNumberSink::Put2(), and DL_SignerBase< SCHEME_OPTIONS::Element >::SignAndRestart().

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::GenerateBlock ( byte *  output,
size_t  size 
) [virtual, inherited]

Generate random array of bytes.

Parameters:
output the byte buffer
size the 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 Weak1::ARC4_Base, PublicBlumBlumShub, ClassNullRNG, KDF2_RNG, MersenneTwister< K, M, N, F, S >, NonblockingRng, BlockingRng, RDRAND, RDSEED, LC_RNG, AdditiveCipherTemplate< BASE >, FixedRNG, and AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > >.

Definition at line 329 of file cryptlib.cpp.

References RandomNumberGenerator::GenerateIntoBufferedTransformation().

Referenced by RandomNumberGenerator::GenerateByte(), RandomNumberGenerator::GenerateIntoBufferedTransformation(), RandomNumberGenerator::GenerateWord32(), SimpleKeyingInterface::GetNextIV(), Integer::Randomize(), and X917RNG().

void RandomNumberGenerator::DiscardBytes ( size_t  n  )  [virtual, inherited]

Generate and discard n bytes.

Parameters:
n the number of bytes to generate and discard

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

Definition at line 342 of file cryptlib.cpp.

References RandomNumberGenerator::GenerateIntoBufferedTransformation().

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 std::string Algorithm::AlgorithmName (  )  const [inline, virtual, inherited]

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 Adler32, CCM_Base, CRC32, ClassNullRNG, AuthenticatedSymmetricCipher, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, EAX_Base, StreamTransformationFilter, HashFilter, HashVerificationFilter, AuthenticatedDecryptionFilter, SignerFilter, SignatureVerificationFilter, GCM_Base, HMAC< T >, RDRAND, RDSEED, SHA3, BitBucket, and VMAC_Base.

Definition at line 488 of file cryptlib.h.

Referenced by BufferedTransformation::ChannelCreatePutSpace(), BufferedTransformation::ChannelFlush(), BufferedTransformation::ChannelMessageSeriesEnd(), BufferedTransformation::ChannelPut2(), TF_DecryptorBase::Decrypt(), TF_EncryptorBase::Encrypt(), StreamTransformation::ProcessLastBlock(), and PK_DefaultDecryptionFilter::Put2().

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

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