PublicBlumBlumShub Class Reference

BlumBlumShub without factorization of the modulus. More...

Inheritance diagram for PublicBlumBlumShub:
RandomNumberGenerator StreamTransformation Algorithm Algorithm Clonable Clonable BlumBlumShub

List of all members.

Public Member Functions

 PublicBlumBlumShub (const Integer &n, const Integer &seed)
unsigned int GenerateBit ()
 Generate new random bit and return it.
byte GenerateByte ()
 Generate new random byte and return it.
void GenerateBlock (byte *output, size_t size)
 Generate random array of bytes.
void ProcessData (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt an array of bytes.
bool IsSelfInverting () const
 Determines whether the cipher is self-inverting.
bool IsForwardTransformation () const
 Determines if the cipher is being operated in its forward direction.
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 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.
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.
StreamTransformationRef ()
 Provides a reference to this object.
virtual unsigned int MandatoryBlockSize () const
 Provides the mandatory block size of the cipher.
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this cipher.
virtual unsigned int GetOptimalBlockSizeUsed () const
 Provides the number of bytes used in the current block when processing at optimal block size.
virtual unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance.
virtual void ProcessLastBlock (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt the last block of data.
virtual unsigned int MinLastBlockSize () const
 returns the minimum size of the last block, 0 indicating the last block is not special
void ProcessString (byte *inoutString, size_t length)
 Encrypt or decrypt a string of bytes.
void ProcessString (byte *outString, const byte *inString, size_t length)
 Encrypt or decrypt a string of bytes.
byte ProcessByte (byte input)
 Encrypt or decrypt a byte.
virtual bool IsRandomAccess () const =0
 Determines whether the cipher supports random access.
virtual void Seek (lword pos)
 Seek to an absolute position.

Protected Attributes

ModularArithmetic modn
Integer current
word maxBits
word bitsLeft

Detailed Description

BlumBlumShub without factorization of the modulus.

Definition at line 17 of file blumshub.h.


Member Function Documentation

unsigned int PublicBlumBlumShub::GenerateBit (  )  [virtual]

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

Definition at line 17 of file blumshub.cpp.

References Integer::GetBit().

Referenced by GenerateByte().

byte PublicBlumBlumShub::GenerateByte (  )  [virtual]

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

Definition at line 28 of file blumshub.cpp.

References GenerateBit().

Referenced by GenerateBlock(), and ProcessData().

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

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

Definition at line 36 of file blumshub.cpp.

References GenerateByte().

void PublicBlumBlumShub::ProcessData ( byte *  outString,
const byte *  inString,
size_t  length 
) [virtual]

Encrypt or decrypt an array of bytes.

Parameters:
outString the output byte buffer
inString the input byte buffer
length the size of the input and output byte buffers, in bytes

Either inString == outString, or they must not overlap.

Implements StreamTransformation.

Definition at line 42 of file blumshub.cpp.

References GenerateByte().

bool PublicBlumBlumShub::IsSelfInverting (  )  const [inline, virtual]

Determines whether the cipher is self-inverting.

Returns:
true if the cipher is self-inverting, false otherwise

IsSelfInverting determines whether this transformation is self-inverting (e.g. xor with a keystream).

Implements StreamTransformation.

Definition at line 28 of file blumshub.h.

bool PublicBlumBlumShub::IsForwardTransformation (  )  const [inline, virtual]

Determines if the cipher is being operated in its forward direction.

Returns:
true if DIR is ENCRYPTION, false otherwise
See also:
IsForwardTransformation(), IsPermutation(), GetCipherDirection()

Implements StreamTransformation.

Definition at line 29 of file blumshub.h.

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

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

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.

StreamTransformation& StreamTransformation::Ref (  )  [inline, inherited]

Provides a reference to this object.

Returns:
A reference to this object

Useful for passing a temporary object to a function that takes a non-const reference

Definition at line 758 of file cryptlib.h.

virtual unsigned int StreamTransformation::MandatoryBlockSize (  )  const [inline, virtual, inherited]

Provides the mandatory block size of the cipher.

Returns:
The block size of the cipher if input must be processed in blocks, 1 otherwise

Reimplemented in BlockOrientedCipherModeBase.

Definition at line 762 of file cryptlib.h.

Referenced by StreamTransformation::ProcessLastBlock().

virtual unsigned int StreamTransformation::OptimalBlockSize (  )  const [inline, virtual, inherited]

Provides the input block size most efficient for this cipher.

Returns:
The input block size that is most efficient for the cipher

The base class implemnetation returns MandatoryBlockSize().

Note:
Optimal input length is n * OptimalBlockSize() - GetOptimalBlockSizeUsed() for any n > 0.

Reimplemented in ECB_OneWay.

Definition at line 769 of file cryptlib.h.

virtual unsigned int StreamTransformation::GetOptimalBlockSizeUsed (  )  const [inline, virtual, inherited]

Provides the number of bytes used in the current block when processing at optimal block size.

Returns:
the number of bytes used in the current block when processing at the optimal block size

Definition at line 773 of file cryptlib.h.

unsigned int StreamTransformation::OptimalDataAlignment (  )  const [virtual, inherited]

Provides input and output data alignment for optimal performance.

Returns:
the input data alignment that provides optimal performance

Reimplemented in CCM_Base, EAX_Base, GCM_Base, and CipherModeBase.

Definition at line 237 of file cryptlib.cpp.

void StreamTransformation::ProcessLastBlock ( byte *  outString,
const byte *  inString,
size_t  length 
) [virtual, inherited]

Encrypt or decrypt the last block of data.

Parameters:
outString the output byte buffer
inString the input byte buffer
length the size of the input and output byte buffers, in bytes ProcessLastBlock is used when the last block of data is special. Currently the only use of this function is CBC-CTS mode.

Reimplemented in CBC_CTS_Encryption, and CBC_CTS_Decryption.

Definition at line 247 of file cryptlib.cpp.

References Algorithm::AlgorithmName(), StreamTransformation::MandatoryBlockSize(), StreamTransformation::MinLastBlockSize(), and StreamTransformation::ProcessData().

void StreamTransformation::ProcessString ( byte *  inoutString,
size_t  length 
) [inline, inherited]

Encrypt or decrypt a string of bytes.

Parameters:
inoutString the string to process
length the size of the inoutString, in bytes

Internally, the base class implementation calls ProcessData().

Definition at line 801 of file cryptlib.h.

Referenced by AuthenticatedSymmetricCipher::DecryptAndVerify(), and AuthenticatedSymmetricCipher::EncryptAndAuthenticate().

void StreamTransformation::ProcessString ( byte *  outString,
const byte *  inString,
size_t  length 
) [inline, inherited]

Encrypt or decrypt a string of bytes.

Parameters:
outString the output string to process
inString the input string to process
length the size of the input and output strings, in bytes

Internally, the base class implementation calls ProcessData().

Definition at line 809 of file cryptlib.h.

byte StreamTransformation::ProcessByte ( byte  input  )  [inline, inherited]

Encrypt or decrypt a byte.

Parameters:
input the input byte to process

Internally, the base class implementation calls ProcessData() with a size of 1.

Definition at line 815 of file cryptlib.h.

virtual bool StreamTransformation::IsRandomAccess (  )  const [pure virtual, inherited]

Determines whether the cipher supports random access.

Returns:
true if the cipher supports random access, false otherwise

Implemented in Weak1::ARC4_Base, AuthenticatedSymmetricCipherBase, BlumBlumShub, and BlockOrientedCipherModeBase.

virtual void StreamTransformation::Seek ( lword  pos  )  [inline, virtual, inherited]

Seek to an absolute position.

Parameters:
pos position to seek
Exceptions:
NotImplemented 

The base class implementation throws NotImplemented. The function asserts IsRandomAccess() in debug builds.

Reimplemented in BlumBlumShub.

Definition at line 827 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