Crypto++ 8.9
Free C++ class library of cryptographic schemes
|
Interface for algorithms that take byte strings as keys. More...
#include <cryptlib.h>
Public Types | |
enum | IV_Requirement { UNIQUE_IV = 0 , RANDOM_IV , UNPREDICTABLE_RANDOM_IV , INTERNALLY_GENERATED_IV , NOT_RESYNCHRONIZABLE } |
Secure IVs requirements as enumerated values. More... | |
Public Member Functions | |
virtual size_t | MinKeyLength () const =0 |
Returns smallest valid key length. | |
virtual size_t | MaxKeyLength () const =0 |
Returns largest valid key length. | |
virtual size_t | DefaultKeyLength () const =0 |
Returns default key length. | |
virtual size_t | GetValidKeyLength (size_t keylength) const =0 |
Returns a valid key length for the algorithm. | |
virtual bool | IsValidKeyLength (size_t keylength) const |
Returns whether keylength is a valid key length. | |
virtual void | SetKey (const byte *key, size_t length, const NameValuePairs ¶ms=g_nullNameValuePairs) |
Sets or reset the key of this object. | |
void | SetKeyWithRounds (const byte *key, size_t length, int rounds) |
Sets or reset the key of this object. | |
void | SetKeyWithIV (const byte *key, size_t length, const byte *iv, size_t ivLength) |
Sets or reset the key of this object. | |
void | SetKeyWithIV (const byte *key, size_t length, const byte *iv) |
Sets or reset the key of this object. | |
virtual IV_Requirement | IVRequirement () const =0 |
Minimal requirement for secure IVs. | |
bool | IsResynchronizable () const |
Determines if the object can be resynchronized. | |
bool | CanUseRandomIVs () const |
Determines if the object can use random IVs. | |
bool | CanUsePredictableIVs () const |
Determines if the object can use random but possibly predictable IVs. | |
bool | CanUseStructuredIVs () const |
Determines if the object can use structured IVs. | |
virtual unsigned int | IVSize () const |
Returns length of the IV accepted by this object. | |
unsigned int | DefaultIVLength () const |
Provides the default size of an IV. | |
virtual unsigned int | MinIVLength () const |
Provides the minimum size of an IV. | |
virtual unsigned int | MaxIVLength () const |
Provides the maximum size of an IV. | |
virtual void | Resynchronize (const byte *iv, int ivLength=-1) |
Resynchronize with an IV. | |
virtual void | GetNextIV (RandomNumberGenerator &rng, byte *iv) |
Retrieves a secure IV for the next message. | |
Interface for algorithms that take byte strings as keys.
Definition at line 646 of file cryptlib.h.
Secure IVs requirements as enumerated values.
Provides secure IV requirements as a monotonically increasing enumerated values. Requirements can be compared using less than (<) and greater than (>). For example, UNIQUE_IV < RANDOM_IV
and UNPREDICTABLE_RANDOM_IV > RANDOM_IV
.
Objects that use SimpleKeyingInterface do not support an optional IV. That is, an IV must be present or it must be absent. If you wish to support an optional IV then provide two classes - one with an IV and one without an IV.
Definition at line 724 of file cryptlib.h.
|
inlinevirtual |
Definition at line 649 of file cryptlib.h.
|
pure virtual |
Returns smallest valid key length.
Implemented in CCM_Base, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, GCM_Base, CipherModeBase, SimpleKeyingInterfaceImpl< BlockCipher, BTEA_Info >, SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T_BlockCipher > >, SimpleKeyingInterfaceImpl< DMAC_Base< T >, DMAC_Base< T > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< H > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< SHA256 > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< T > >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2b_Info >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2s_Info >, SimpleKeyingInterfaceImpl< Poly1305_Base< T >, Poly1305_Base< T > >, SimpleKeyingInterfaceImpl< Poly1305TLS_Base, Poly1305TLS_Base >, SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > >, SipHash_Base< C, D, T_128bit >, SipHash_Base< 2, 4, false >, and XTS_ModeBase.
|
pure virtual |
Returns largest valid key length.
Implemented in CCM_Base, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, GCM_Base, CipherModeBase, SimpleKeyingInterfaceImpl< BlockCipher, BTEA_Info >, SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T_BlockCipher > >, SimpleKeyingInterfaceImpl< DMAC_Base< T >, DMAC_Base< T > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< H > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< SHA256 > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< T > >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2b_Info >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2s_Info >, SimpleKeyingInterfaceImpl< Poly1305_Base< T >, Poly1305_Base< T > >, SimpleKeyingInterfaceImpl< Poly1305TLS_Base, Poly1305TLS_Base >, SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > >, SipHash_Base< C, D, T_128bit >, SipHash_Base< 2, 4, false >, and XTS_ModeBase.
|
pure virtual |
Returns default key length.
Implemented in CCM_Base, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, GCM_Base, CipherModeBase, SimpleKeyingInterfaceImpl< BlockCipher, BTEA_Info >, SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T_BlockCipher > >, SimpleKeyingInterfaceImpl< DMAC_Base< T >, DMAC_Base< T > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< H > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< SHA256 > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< T > >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2b_Info >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2s_Info >, SimpleKeyingInterfaceImpl< Poly1305_Base< T >, Poly1305_Base< T > >, SimpleKeyingInterfaceImpl< Poly1305TLS_Base, Poly1305TLS_Base >, SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > >, SipHash_Base< C, D, T_128bit >, SipHash_Base< 2, 4, false >, and XTS_ModeBase.
|
pure virtual |
Returns a valid key length for the algorithm.
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.
Implemented in CCM_Base, CipherModeBase, SimpleKeyingInterfaceImpl< BlockCipher, BTEA_Info >, SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T_BlockCipher > >, SimpleKeyingInterfaceImpl< DMAC_Base< T >, DMAC_Base< T > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< H > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< SHA256 > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< T > >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2b_Info >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2s_Info >, SimpleKeyingInterfaceImpl< Poly1305_Base< T >, Poly1305_Base< T > >, SimpleKeyingInterfaceImpl< Poly1305TLS_Base, Poly1305TLS_Base >, SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > >, SipHash_Base< C, D, T_128bit >, SipHash_Base< 2, 4, false >, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, GCM_Base, and XTS_ModeBase.
|
inlinevirtual |
Returns whether keylength is a valid key length.
keylength | the requested keylength |
Internally the function calls GetValidKeyLength()
Reimplemented in CCM_Base, CipherModeBase, XTS_ModeBase, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, and GCM_Base.
Definition at line 677 of file cryptlib.h.
|
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 to configure this object |
Reimplemented in ECB_OneWay, XTS_ModeBase, and AuthenticatedSymmetricCipherBase.
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 a NameValuePairs object that only specifies rounds. rounds is an integer parameter, and -1
means use the default number of 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 initialization vector to use when keying the object |
ivLength | the size of the iv, in bytes |
SetKeyWithIV() calls SetKey() with a NameValuePairs that only specifies IV. The IV is a byte buffer with size ivLength. ivLength is an integer parameter, and -1
means use IVSize().
|
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 initialization vector to use when keying the object |
SetKeyWithIV() calls SetKey() with a NameValuePairs() object that only specifies iv. iv is a byte buffer, and it must have a size IVSize().
Definition at line 713 of file cryptlib.h.
|
pure virtual |
Minimal requirement for secure IVs.
Implemented in CCM_Base, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, GCM_Base, CFB_ModePolicy, OFB_ModePolicy, CTR_ModePolicy, ECB_OneWay, CBC_ModeBase, SimpleKeyingInterfaceImpl< BlockCipher, BTEA_Info >, SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T_BlockCipher > >, SimpleKeyingInterfaceImpl< DMAC_Base< T >, DMAC_Base< T > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< H > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< SHA256 > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< T > >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2b_Info >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2s_Info >, SimpleKeyingInterfaceImpl< Poly1305_Base< T >, Poly1305_Base< T > >, SimpleKeyingInterfaceImpl< Poly1305TLS_Base, Poly1305TLS_Base >, SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > >, SipHash_Base< C, D, T_128bit >, SipHash_Base< 2, 4, false >, XTS_ModeBase, and CipherModeBase.
|
inline |
Determines if the object can be resynchronized.
CanUseStructuredIVs()==true
, an IV of all 0's will be assumed. Definition at line 745 of file cryptlib.h.
|
inline |
Determines if the object can use random IVs.
Definition at line 749 of file cryptlib.h.
|
inline |
Determines if the object can use random but possibly predictable IVs.
Definition at line 754 of file cryptlib.h.
|
inline |
Determines if the object can use structured IVs.
CanUseStructuredIVs() indicates whether the object can use structured IVs; for example a counter (in addition to ones returned by GetNextIV).
Definition at line 760 of file cryptlib.h.
|
inlinevirtual |
Returns length of the IV accepted by this object.
NotImplemented() | if the object does not support resynchronization |
The default implementation throws NotImplemented
Reimplemented in CCM_Base, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, GCM_Base, CipherModeBase, SimpleKeyingInterfaceImpl< BlockCipher, BTEA_Info >, SimpleKeyingInterfaceImpl< CBC_MAC_Base, CBC_MAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T > >, SimpleKeyingInterfaceImpl< CMAC_Base, CMAC< T_BlockCipher > >, SimpleKeyingInterfaceImpl< DMAC_Base< T >, DMAC_Base< T > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< H > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< SHA256 > >, SimpleKeyingInterfaceImpl< HMAC_Base, HMAC< T > >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2b_Info >, SimpleKeyingInterfaceImpl< MessageAuthenticationCode, BLAKE2s_Info >, SimpleKeyingInterfaceImpl< Poly1305_Base< T >, Poly1305_Base< T > >, SimpleKeyingInterfaceImpl< Poly1305TLS_Base, Poly1305TLS_Base >, SimpleKeyingInterfaceImpl< VMAC_Base, SameKeyLengthAs< T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE > >, SipHash_Base< C, D, T_128bit >, SipHash_Base< 2, 4, false >, and VMAC_Base.
Definition at line 766 of file cryptlib.h.
|
inline |
Provides the default size of an IV.
Definition at line 771 of file cryptlib.h.
|
inlinevirtual |
Provides the minimum size of an IV.
NotImplemented() | if the object does not support resynchronization |
Reimplemented in CCM_Base, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, GCM_Base, and VMAC_Base.
Definition at line 776 of file cryptlib.h.
|
inlinevirtual |
Provides the maximum size of an IV.
NotImplemented() | if the object does not support resynchronization |
Reimplemented in CCM_Base, ChaCha20Poly1305_Base, XChaCha20Poly1305_Base, EAX_Base, and GCM_Base.
Definition at line 781 of file cryptlib.h.
|
inlinevirtual |
Resynchronize with an IV.
iv | the initialization vector |
ivLength | the size of the initialization vector, in bytes |
Resynchronize() resynchronizes with an IV provided by the caller. ivLength=-1
means use IVSize().
NotImplemented() | if the object does not support resynchronization |
Reimplemented in Poly1305_Base< T >, XTS_ModeBase, AuthenticatedSymmetricCipherBase, BlockOrientedCipherModeBase, AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > >, CFB_CipherTemplate< AbstractPolicyHolder< CFB_CipherAbstractPolicy, SymmetricCipher > >, and VMAC_Base.
Definition at line 788 of file cryptlib.h.
|
virtual |
Retrieves a secure IV for the next message.
rng | a RandomNumberGenerator to produce keying material |
iv | a block of bytes to receive the IV |
The IV must be at least IVSize() in length.
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.
Internally, the base class implementation calls RandomNumberGenerator's GenerateBlock()
Reimplemented in Poly1305_Base< T >, and VMAC_Base.