Crypto++
5.6.3
Free C++ class library of cryptographic schemes
|
Interface for algorithms that take byte strings as keys. More...
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 | |
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... | |
Interface for algorithms that take byte strings as keys.
Definition at line 497 of file cryptlib.h.
Provides IV requirements as an enumerated value.
Definition at line 555 of file cryptlib.h.
|
pure virtual |
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.
|
inlinevirtual |
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.
|
virtual |
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().
void SimpleKeyingInterface::SetKeyWithRounds | ( | const byte * | key, |
size_t | length, | ||
int | rounds | ||
) |
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().
void SimpleKeyingInterface::SetKeyWithIV | ( | const byte * | key, |
size_t | length, | ||
const byte * | iv, | ||
size_t | ivLength | ||
) |
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().
|
inline |
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.
|
inline |
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().
|
inlinevirtual |
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().
|
virtual |
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().