Crypto++
5.6.3
Free C++ class library of cryptographic schemes
|
Class specific methods used to operate the cipher. More...
Public Types | |
typedef SymmetricCipherFinal< ARC4_Base > | Encryption |
typedef SymmetricCipherFinal< ARC4_Base > | Decryption |
enum | IV_Requirement { UNIQUE_IV = 0, RANDOM_IV, UNPREDICTABLE_RANDOM_IV, INTERNALLY_GENERATED_IV, NOT_RESYNCHRONIZABLE } |
Provides IV requirements as an enumerated value. More... | |
Public Member Functions | |
void | GenerateBlock (byte *output, size_t size) |
Generate random array of bytes. More... | |
void | DiscardBytes (size_t n) |
Generate and discard n bytes. More... | |
void | ProcessData (byte *outString, const byte *inString, size_t length) |
Encrypt or decrypt an array of bytes. More... | |
bool | IsRandomAccess () const |
Determines whether the cipher supports random access. More... | |
bool | IsSelfInverting () const |
Determines whether the cipher is self-inverting. More... | |
bool | IsForwardTransformation () const |
Determines if the cipher is being operated in its forward direction. More... | |
virtual void | IncorporateEntropy (const byte *input, size_t length) |
Update RNG state with additional unpredictable values. More... | |
virtual bool | CanIncorporateEntropy () const |
Determines if a generator can accept additional entropy. More... | |
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 | GenerateIntoBufferedTransformation (BufferedTransformation &target, const std::string &channel, lword length) |
Generate random bytes into a BufferedTransformation. 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 Clonable * | Clone () const |
Copies this object. More... | |
virtual size_t | MinKeyLength () const =0 |
Returns smallest valid key length in bytes. | |
virtual size_t | MaxKeyLength () const =0 |
Returns largest valid key length in bytes. | |
virtual size_t | DefaultKeyLength () const =0 |
Returns default (recommended) key length in bytes. | |
virtual size_t | GetValidKeyLength (size_t n) const =0 |
virtual bool | IsValidKeyLength (size_t keylength) const |
Returns whether keylength is a valid key length. More... | |
virtual void | SetKey (const byte *key, size_t length, const NameValuePairs ¶ms=g_nullNameValuePairs) |
Sets or reset the key of this object. More... | |
void | SetKeyWithRounds (const byte *key, size_t length, int rounds) |
Sets or reset the key of this object. More... | |
void | SetKeyWithIV (const byte *key, size_t length, const byte *iv, size_t ivLength) |
Sets or reset the key of this object. More... | |
void | SetKeyWithIV (const byte *key, size_t length, const byte *iv) |
Sets or reset the key of this object. More... | |
virtual IV_Requirement | IVRequirement () const =0 |
returns the minimal requirement for secure IVs | |
bool | IsResynchronizable () const |
returns whether the object can be resynchronized (i.e. supports initialization vectors) More... | |
bool | CanUseRandomIVs () const |
returns whether the object can use random IVs (in addition to ones returned by GetNextIV) | |
bool | CanUsePredictableIVs () const |
returns whether the object can use random but possibly predictable IVs (in addition to ones returned by GetNextIV) | |
bool | CanUseStructuredIVs () const |
returns whether the object can use structured IVs, for example a counter (in addition to ones returned by GetNextIV) | |
virtual unsigned int | IVSize () const |
Returns length of the IV accepted by this object. More... | |
unsigned int | DefaultIVLength () const |
returns default length of IVs accepted by this object | |
virtual unsigned int | MinIVLength () const |
returns minimal length of IVs accepted by this object | |
virtual unsigned int | MaxIVLength () const |
returns maximal length of IVs accepted by this object | |
virtual void | Resynchronize (const byte *iv, int ivLength=-1) |
resynchronize with an IV. ivLength=-1 means use IVSize() | |
virtual void | GetNextIV (RandomNumberGenerator &rng, byte *iv) |
Gets a secure IV for the next message. More... | |
StreamTransformation & | Ref () |
Provides a reference to this object. More... | |
virtual unsigned int | MandatoryBlockSize () const |
Provides the mandatory block size of the cipher. More... | |
virtual unsigned int | OptimalBlockSize () const |
Provides the input block size most efficient for this cipher. More... | |
virtual unsigned int | GetOptimalBlockSizeUsed () const |
Provides the number of bytes used in the current block when processing at optimal block size. More... | |
virtual unsigned int | OptimalDataAlignment () const |
Provides input and output data alignment for optimal performance. More... | |
virtual void | ProcessLastBlock (byte *outString, const byte *inString, size_t length) |
Encrypt or decrypt the last block of data. More... | |
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. More... | |
void | ProcessString (byte *outString, const byte *inString, size_t length) |
Encrypt or decrypt a string of bytes. More... | |
byte | ProcessByte (byte input) |
Encrypt or decrypt a byte. More... | |
virtual void | Seek (lword pos) |
Seek to an absolute position. More... | |
Static Public Member Functions | |
static const char * | StaticAlgorithmName () |
static size_t | StaticGetValidKeyLength (size_t keylength) |
Provides a valid key length for the cipher provided by a static function. More... | |
Static Public Attributes | |
static const int | MIN_KEYLENGTH |
The minimum key length used by the cipher provided as a constant. More... | |
static const int | MAX_KEYLENGTH |
The maximum key length used by the cipher provided as a constant. More... | |
static const int | DEFAULT_KEYLENGTH |
The default key length used by the cipher provided as a constant. More... | |
static const int | KEYLENGTH_MULTIPLE |
The key length multiple used by the cipher provided as a constant. More... | |
static const int | IV_REQUIREMENT |
The default IV requirements for the cipher provided as a constant. More... | |
static const int | IV_LENGTH |
The default initialization vector length for the cipher provided as a constant. More... | |
Class specific methods used to operate the cipher.
Implementations and overrides in Base
apply to both ENCRYPTION
and DECRYPTION
directions
|
inherited |
Provides IV requirements as an enumerated value.
Definition at line 555 of file cryptlib.h.
|
virtual |
Generate random array of bytes.
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.
Reimplemented from RandomNumberGenerator.
|
virtual |
Generate and discard n bytes.
n | the number of bytes to generate and discard |
Reimplemented from RandomNumberGenerator.
|
virtual |
Encrypt or decrypt an array of bytes.
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.
|
inlinevirtual |
Determines whether the cipher supports random access.
Implements StreamTransformation.
|
inlinevirtual |
Determines whether the cipher is self-inverting.
IsSelfInverting determines whether this transformation is self-inverting (e.g. xor with a keystream).
Implements StreamTransformation.
|
inlinevirtual |
Determines if the cipher is being operated in its forward direction.
Implements StreamTransformation.
|
inlinestaticinherited |
Provides a valid key length for the cipher provided by a static function.
keylength | the size of the key, in bytes |
If keylength is less than MIN_KEYLENGTH, then the function returns MIN_KEYLENGTH. If keylength is greater than MAX_KEYLENGTH, then the function returns MAX_KEYLENGTH. If keylength is a multiple of KEYLENGTH_MULTIPLE, then keylength is returned. Otherwise, the function returns keylength rounded down to the next smaller multiple of KEYLENGTH_MULTIPLE.
keylength is provided in bytes, not bits.
|
inlinevirtualinherited |
Update RNG state with additional unpredictable values.
input | the entropy to add to the generator |
length | the size of the input buffer |
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 >, RDSEED, RDRAND, and RandomPool.
Definition at line 1096 of file cryptlib.h.
Referenced by DL_SignerBase< SCHEME_OPTIONS::Element >::SignAndRestart().
|
inlinevirtualinherited |
Determines if a generator can accept additional entropy.
Reimplemented in ClassNullRNG, AutoSeededX917RNG< BLOCK_CIPHER >, and RandomPool.
Definition at line 1104 of file cryptlib.h.
Referenced by DL_SignerBase< SCHEME_OPTIONS::Element >::SignAndRestart().
|
virtualinherited |
Generate new random byte and return it.
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.
|
virtualinherited |
Generate new random bit and return it.
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().
|
virtualinherited |
Generate a random 32 bit word in the range min to max, inclusive.
min | the lower bound of the range |
max | the upper bound of the range |
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().
|
virtualinherited |
Generate random bytes into a BufferedTransformation.
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.
Reimplemented in ClassNullRNG, AutoSeededX917RNG< BLOCK_CIPHER >, X917RNG, and RandomPool.
Definition at line 347 of file cryptlib.cpp.
References BufferedTransformation::ChannelPut(), SecBlock< T, A >::size(), and UnsignedMin().
|
inlineinherited |
Randomly shuffle the specified array.
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.
Definition at line 1159 of file cryptlib.h.
|
inlinevirtualinherited |
Provides the name of this algorithm.
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.
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().
|
inlinevirtualinherited |
Copies this object.
NotImplemented |
Definition at line 464 of file cryptlib.h.
|
pure virtualinherited |
min(n, GetMaxKeyLength())
Implemented in SimpleKeyingInterfaceImpl< TTMAC_Base, TTMAC_Base >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< T > >, SimpleKeyingInterfaceImpl< DMAC_Base< T >, DMAC_Base< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T > >, SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > >, SimpleKeyingInterfaceImpl< BlockCipher, BTEA_Info >, SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T_BlockCipher > >, CipherModeBase, GCM_Base, EAX_Base, and CCM_Base.
|
inlinevirtualinherited |
Returns whether keylength is a valid key length.
Internally the function calls GetValidKeyLength()
Reimplemented in CipherModeBase, GCM_Base, EAX_Base, and CCM_Base.
Definition at line 515 of file cryptlib.h.
References g_nullNameValuePairs.
|
virtualinherited |
Sets or reset the key of this object.
key | the key to use when keying the object |
length | the size of the key, in bytes |
params | additional initialization parameters that cannot be passed directly through the constructor |
Reimplemented in ECB_OneWay, and AuthenticatedSymmetricCipherBase.
Definition at line 100 of file cryptlib.cpp.
Referenced by HKDF< T >::DeriveKey(), RandomPool::GenerateIntoBufferedTransformation(), TestDataNameValuePairs::GetVoidValue(), CBC_MAC_Base::UncheckedSetKey(), CMAC_Base::UncheckedSetKey(), VMAC_Base::UncheckedSetKey(), and BlockOrientedCipherModeBase::UncheckedSetKey().
|
inherited |
Sets or reset the key of this object.
key | the key to use when keying the object |
length | the size of the key, in bytes |
rounds | the number of rounds to apply the transformation function, if applicable |
SetKeyWithRounds calls SetKey with an NameValuePairs object that just specifies rounds. rounds is an integer parameter, and -1
means use the default number of rounds.
Definition at line 106 of file cryptlib.cpp.
References MakeParameters(), and Name::Rounds().
|
inherited |
Sets or reset the key of this object.
key | the key to use when keying the object |
length | the size of the key, in bytes |
iv | the intiialization vector to use when keying the object |
ivLength | the size of the iv, in bytes |
SetKeyWithIV calls SetKey with an NameValuePairs object that just specifies iv. iv is a byte buffer with size ivLength.
Definition at line 111 of file cryptlib.cpp.
References NameValuePairs::GetValue(), IntToString(), Name::IV(), and MakeParameters().
|
inlineinherited |
Sets or reset the key of this object.
key | the key to use when keying the object |
length | the size of the key, in bytes |
iv | the intiialization vector to use when keying the object |
SetKeyWithIV calls SetKey with an NameValuePairs object that just specifies iv. iv is a byte buffer, and it must have a size IVSize.
Definition at line 551 of file cryptlib.h.
|
inlineinherited |
returns whether the object can be resynchronized (i.e. supports initialization vectors)
If this function returns true, and no IV is passed to SetKey() and CanUseStructuredIVs()==true, an IV of all 0's will be assumed.
Definition at line 573 of file cryptlib.h.
Referenced by CipherModeBase::IVSize(), and BlockOrientedCipherModeBase::UncheckedSetKey().
|
inlinevirtualinherited |
Returns length of the IV accepted by this object.
The default implementation throws NotImplemented
Reimplemented in SimpleKeyingInterfaceImpl< TTMAC_Base, TTMAC_Base >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< T > >, SimpleKeyingInterfaceImpl< DMAC_Base< T >, DMAC_Base< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T > >, SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > >, SimpleKeyingInterfaceImpl< BlockCipher, BTEA_Info >, SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T_BlockCipher > >, CipherModeBase, GCM_Base, EAX_Base, CCM_Base, and VMAC_Base.
Definition at line 583 of file cryptlib.h.
Referenced by TestDataNameValuePairs::GetVoidValue(), and FilterTester::Put2().
|
virtualinherited |
Gets a secure IV for the next message.
rng | a RandomNumberGenerator to produce keying material |
iv | a block of bytes to receive the IV |
This method should be called after you finish encrypting one message and are ready to start the next one. After calling it, you must call SetKey() or Resynchronize() before using this object again.
key must be at least IVSize() in length.
Reimplemented in VMAC_Base.
Definition at line 176 of file cryptlib.cpp.
References RandomNumberGenerator::GenerateBlock().
Referenced by VMAC_Base::GetNextIV(), and FilterTester::Put2().
|
inlineinherited |
Provides 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.
|
inlinevirtualinherited |
Provides the mandatory block size of the cipher.
Reimplemented in BlockOrientedCipherModeBase.
Definition at line 762 of file cryptlib.h.
Referenced by ArrayXorSink::Put2().
|
inlinevirtualinherited |
Provides the input block size most efficient for this cipher.
The base class implemnetation returns MandatoryBlockSize().
n * OptimalBlockSize() - GetOptimalBlockSizeUsed()
for any n > 0
. Reimplemented in ECB_OneWay.
Definition at line 769 of file cryptlib.h.
|
inlinevirtualinherited |
Provides the number of bytes used in the current block when processing at optimal block size.
Definition at line 773 of file cryptlib.h.
|
virtualinherited |
Provides input and output data alignment for optimal performance.
Reimplemented in CipherModeBase, GCM_Base, EAX_Base, and CCM_Base.
Definition at line 237 of file cryptlib.cpp.
Referenced by GCM_Base::IsValidKeyLength().
|
virtualinherited |
Encrypt or decrypt the last block of data.
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_Decryption, and CBC_CTS_Encryption.
Definition at line 247 of file cryptlib.cpp.
|
inlineinherited |
Encrypt or decrypt a string of bytes.
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 TestDataNameValuePairs::GetVoidValue().
|
inlineinherited |
Encrypt or decrypt a string of bytes.
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.
|
inlineinherited |
Encrypt or decrypt a byte.
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.
|
inlinevirtualinherited |
Seek to an absolute position.
pos | position to seek |
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.
Referenced by TestDataNameValuePairs::GetVoidValue().
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
The default IV requirements for the cipher provided as a constant.
The default value is NOT_RESYNCHRONIZABLE. See IV_Requirement in cryptlib.h for allowed values.
|
staticinherited |