Crypto++
5.6.3
Free C++ class library of cryptographic schemes
|
Public Types | |
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 | |
CMAC (const byte *key, size_t length=SameKeyLengthAs< T >::DEFAULT_KEYLENGTH) | |
std::string | AlgorithmName () const |
size_t | MinKeyLength () const |
The minimum key length used by the cipher. | |
size_t | MaxKeyLength () const |
The maximum key length used by the cipher. | |
size_t | DefaultKeyLength () const |
The default key length used by the cipher. | |
size_t | GetValidKeyLength (size_t keylength) const |
Provides a valid key length for the cipher. More... | |
SimpleKeyingInterface::IV_Requirement | IVRequirement () const |
The default IV requirements for the cipher. More... | |
unsigned int | IVSize () const |
The default initialization vector length for the cipher. More... | |
void | UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs ¶ms) |
Sets the key for this object without performing parameter validation. More... | |
void | Update (const byte *input, size_t length) |
Updates a hash with additional input. More... | |
void | TruncatedFinal (byte *mac, size_t size) |
Computes the hash of the current message. More... | |
unsigned int | DigestSize () const |
Provides the digest size of the hash. More... | |
unsigned int | OptimalBlockSize () const |
Provides the input block size most efficient for this hash. More... | |
unsigned int | OptimalDataAlignment () const |
Provides input and output data alignment for optimal performance. More... | |
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... | |
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) | |
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... | |
HashTransformation & | Ref () |
Provides a reference to this object. More... | |
virtual byte * | CreateUpdateSpace (size_t &size) |
Request space which can be written into by the caller. More... | |
virtual void | Final (byte *digest) |
Computes the hash of the current message. More... | |
virtual void | Restart () |
Restart the hash. More... | |
unsigned int | TagSize () const |
Provides the tag size of the hash. More... | |
virtual unsigned int | BlockSize () const |
Provides the block size of the compression function. More... | |
virtual void | CalculateDigest (byte *digest, const byte *input, size_t length) |
Updates the hash with additional input and computes the hash of the current message. More... | |
virtual bool | Verify (const byte *digest) |
Verifies the hash of the current message. More... | |
virtual bool | VerifyDigest (const byte *digest, const byte *input, size_t length) |
Updates the hash with additional input and verifies the hash of the current message. More... | |
virtual void | CalculateTruncatedDigest (byte *digest, size_t digestSize, const byte *input, size_t length) |
Updates the hash with additional input and computes the hash of the current message. More... | |
virtual bool | TruncatedVerify (const byte *digest, size_t digestLength) |
Verifies the hash of the current message. More... | |
virtual bool | VerifyTruncatedDigest (const byte *digest, size_t digestLength, const byte *input, size_t length) |
Updates the hash with additional input and verifies the hash of the current message. More... | |
virtual Clonable * | Clone () const |
Copies this object. More... | |
Static Public Member Functions | |
static std::string | 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 | 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... | |
Template parameter T should be a class derived from BlockCipherDocumentation, for example AES, with a block size of 8, 16, or 32
|
inherited |
Provides IV requirements as an enumerated value.
Definition at line 555 of file cryptlib.h.
|
inlinevirtualinherited |
Provides a valid key length for the cipher.
keylength | the size of the key, in bytes |
keylength is provided in bytes, not bits. 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 If keylength is a multiple of KEYLENGTH_MULTIPLE, then keylength is returned. Otherwise, the function returns a lower multiple of KEYLENGTH_MULTIPLE.
Implements SimpleKeyingInterface.
|
inlinevirtualinherited |
The default IV requirements for the cipher.
The default value is NOT_RESYNCHRONIZABLE. See IV_Requirement in cryptlib.h for allowed values.
Implements SimpleKeyingInterface.
|
inlinevirtualinherited |
The default initialization vector length for the cipher.
IVSize is provided in bytes, not bits. The default implementation uses IV_LENGTH, which is 0.
Reimplemented from SimpleKeyingInterface.
|
virtualinherited |
Sets the key for this object without performing parameter validation.
key | a byte buffer used to key the cipher |
length | the length of the byte buffer |
params | additional parameters passed as NameValuePairs |
key must be at least DEFAULT_KEYLENGTH in length.
Implements SimpleKeyingInterface.
Definition at line 43 of file cmac.cpp.
References BlockTransformation::BlockSize(), SecBlock< T, A >::CleanNew(), BlockTransformation::ProcessBlock(), and SimpleKeyingInterface::SetKey().
|
virtualinherited |
Updates a hash with additional input.
input | the additional input as a buffer |
length | the size of the buffer, in bytes |
Implements HashTransformation.
Definition at line 58 of file cmac.cpp.
References BlockTransformation::AdvancedProcessBlocks(), BlockTransformation::BlockSize(), BlockTransformation::BT_DontIncrementInOutPointers, BlockTransformation::ProcessBlock(), UnsignedMin(), and xorbuf().
|
virtualinherited |
Computes the hash of the current message.
digest | a pointer to the buffer to receive the hash |
digestSize | the size of the truncated digest, in bytes |
TruncatedFinal() call Final() and then copies digestSize bytes to digest
TruncatedFinal() restarts the hash for the next nmessage.
Implements HashTransformation.
Definition at line 103 of file cmac.cpp.
References BlockTransformation::AdvancedProcessBlocks(), BlockTransformation::BlockSize(), and BlockTransformation::BT_DontIncrementInOutPointers.
|
inlinevirtualinherited |
Provides the digest size of the hash.
Calls to Final() require a buffer that is equal to (or greater than) DigestSize().
Implements HashTransformation.
|
inlinevirtualinherited |
Provides the input block size most efficient for this hash.
The base class implemnetation returns MandatoryBlockSize().
n * OptimalBlockSize() - GetOptimalBlockSizeUsed()
for any n > 0
. Reimplemented from HashTransformation.
|
inlinevirtualinherited |
Provides input and output data alignment for optimal performance.
Reimplemented from HashTransformation.
|
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(), CMAC_Base::UncheckedSetKey(), CBC_MAC_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().
|
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 864 of file cryptlib.h.
|
inlinevirtualinherited |
Request space which can be written into by the caller.
size | the requested size of the buffer |
The purpose of this method is to help avoid extra memory allocations.
size is an IN and OUT parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.
The base class implementation sets size to 0 and returns NULL.
Definition at line 879 of file cryptlib.h.
|
inlinevirtualinherited |
Computes the hash of the current message.
digest | a pointer to the buffer to receive the hash |
digest must be equal to (or greater than) DigestSize(). Final() restarts the hash for a new message.
Definition at line 885 of file cryptlib.h.
References Name::DigestSize().
Referenced by DefaultDecryptor::DefaultDecryptor(), DefaultEncryptor::DefaultEncryptor(), PKCS5_PBKDF2_HMAC< T >::DeriveKey(), RandomPool::IncorporateEntropy(), PKCS_EncryptionPaddingScheme::MaxUnpaddedLength(), and HMAC_Base::TruncatedFinal().
|
inlinevirtualinherited |
Restart the hash.
Discards the current state, and restart for a new message
Reimplemented in TruncatedHashTemplate< T >, AuthenticatedSymmetricCipherBase, SHA3, and HMAC_Base.
Definition at line 890 of file cryptlib.h.
References Name::DigestSize().
Referenced by Gunzip::Gunzip(), HMAC_Base::Restart(), and ZlibDecompressor::ZlibDecompressor().
|
inlineinherited |
Provides the tag size of the hash.
Same as DigestSize().
Definition at line 901 of file cryptlib.h.
References Name::DigestSize().
|
inlinevirtualinherited |
Provides the block size of the compression function.
BlockSize() will return 0 if the hash is not block based. For example, SHA3 is a recursive hash (not an iterative hash), and it does not have a block size.
Reimplemented in VMAC_Base, and Weak::MD2.
Definition at line 907 of file cryptlib.h.
Referenced by CBC_MAC_Base::DigestSize(), HMAC_Base::DigestSize(), CBC_MAC_Base::TruncatedFinal(), HMAC_Base::TruncatedFinal(), and HMAC_Base::UncheckedSetKey().
|
inlinevirtualinherited |
Updates the hash with additional input and computes the hash of the current message.
digest | a pointer to the buffer to receive the hash |
input | the additional input as a buffer |
length | the size of the buffer, in bytes |
Use this if your input is in one piece and you don't want to call Update() and Final() separately
CalculateDigest() restarts the hash for the next nmessage.
Definition at line 927 of file cryptlib.h.
Referenced by HKDF< T >::DeriveKey(), PKCS5_PBKDF2_HMAC< T >::DeriveKey(), and OAEP_Base::MaxUnpaddedLength().
|
inlinevirtualinherited |
Verifies the hash of the current message.
digest | a pointer to the buffer of an existing hash |
true
if the existing hash matches the computed hash, false
otherwise ThrowIfInvalidTruncatedSize() | if the existing hash's size exceeds DigestSize() |
Calls to Verify() require a buffer that is equal to (or greater than) DigestSize().
Verify() performs a bitwise compare on the buffers using VerifyBufsEqual(), which is a constant time comparison function. digestLength cannot exceed DigestSize().
Verify() restarts the hash for the next nmessage.
Definition at line 938 of file cryptlib.h.
References Name::DigestSize().
Referenced by Gunzip::Gunzip(), and ZlibDecompressor::ZlibDecompressor().
|
inlinevirtualinherited |
Updates the hash with additional input and verifies the hash of the current message.
digest | a pointer to the buffer of an existing hash |
input | the additional input as a buffer |
length | the size of the buffer, in bytes |
true
if the existing hash matches the computed hash, false
otherwise ThrowIfInvalidTruncatedSize() | if the existing hash's size exceeds DigestSize() |
Use this if your input is in one piece and you don't want to call Update() and Verify() separately
VerifyDigest() performs a bitwise compare on the buffers using VerifyBufsEqual(), which is a constant time comparison function. digestLength cannot exceed DigestSize().
VerifyDigest() restarts the hash for the next nmessage.
Definition at line 952 of file cryptlib.h.
Referenced by OAEP_Base::MaxUnpaddedLength().
|
inlinevirtualinherited |
Updates the hash with additional input and computes the hash of the current message.
digest | a pointer to the buffer to receive the hash |
digestSize | the length of the truncated hash, in bytes |
input | the additional input as a buffer |
length | the size of the buffer, in bytes |
Use this if your input is in one piece and you don't want to call Update() and CalculateDigest() separately.
CalculateTruncatedDigest() restarts the hash for the next nmessage.
Definition at line 970 of file cryptlib.h.
|
virtualinherited |
Verifies the hash of the current message.
digest | a pointer to the buffer of an existing hash |
digestLength | the size of the truncated hash, in bytes |
true
if the existing hash matches the computed hash, false
otherwise ThrowIfInvalidTruncatedSize() | if digestLength exceeds DigestSize() |
TruncatedVerify() is a truncated version of Verify(). It can operate on a buffer smaller than DigestSize(). However, digestLength cannot exceed DigestSize().
Verify() performs a bitwise compare on the buffers using VerifyBufsEqual(), which is a constant time comparison function. digestLength cannot exceed DigestSize().
TruncatedVerify() restarts the hash for the next nmessage.
Reimplemented in TruncatedHashTemplate< T >, and NullHash.
Definition at line 411 of file cryptlib.cpp.
References Name::DigestSize(), IntToString(), and VerifyBufsEqual().
|
inlinevirtualinherited |
Updates the hash with additional input and verifies the hash of the current message.
digest | a pointer to the buffer of an existing hash |
digestLength | the size of the truncated hash, in bytes |
input | the additional input as a buffer |
length | the size of the buffer, in bytes |
true
if the existing hash matches the computed hash, false
otherwise ThrowIfInvalidTruncatedSize() | if digestLength exceeds DigestSize() |
Use this if your input is in one piece and you don't want to call Update() and TruncatedVerify() separately.
VerifyTruncatedDigest() is a truncated version of VerifyDigest(). It can operate on a buffer smaller than DigestSize(). However, digestLength cannot exceed DigestSize().
VerifyTruncatedDigest() restarts the hash for the next nmessage.
Definition at line 997 of file cryptlib.h.
|
inlinevirtualinherited |
Copies this object.
NotImplemented |
Definition at line 464 of file cryptlib.h.
|
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.
|
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 |