Security Scol plugin
|
#include <hmac.h>
Public Member Functions | |
HMAC_Base () | |
Construct a HMAC_Base. | |
void | UncheckedSetKey (const byte *userKey, unsigned int keylength, const NameValuePairs ¶ms) |
Sets the key for this object without performing parameter validation. | |
void | Restart () |
Restart the hash. | |
void | Update (const byte *input, size_t length) |
Updates a hash with additional input. | |
void | TruncatedFinal (byte *mac, size_t size) |
Computes the hash of the current message. | |
unsigned int | OptimalBlockSize () const |
Provides the input block size most efficient for this hash. | |
unsigned int | DigestSize () const |
Public Member Functions inherited from VariableKeyLength< 16, 0, INT_MAX > | |
CRYPTOPP_CONSTANT (MIN_KEYLENGTH=N) | |
The minimum key length used by the algorithm provided as a constant. | |
CRYPTOPP_CONSTANT (MAX_KEYLENGTH=M) | |
The maximum key length used by the algorithm provided as a constant. | |
CRYPTOPP_CONSTANT (DEFAULT_KEYLENGTH=D) | |
The default key length used by the algorithm provided as a constant. | |
CRYPTOPP_CONSTANT (KEYLENGTH_MULTIPLE=1) | |
The key length multiple used by the algorithm provided as a constant. | |
CRYPTOPP_CONSTANT (IV_REQUIREMENT=SimpleKeyingInterface::NOT_RESYNCHRONIZABLE) | |
The default IV requirements for the algorithm provided as a constant. | |
CRYPTOPP_CONSTANT (IV_LENGTH=0) | |
The default initialization vector length for the algorithm provided as a constant. | |
CRYPTOPP_STATIC_CONSTEXPR size_t CRYPTOPP_API | StaticGetValidKeyLength (size_t keylength) |
Provides a valid key length for the algorithm provided by a static function. | |
Public Member Functions inherited from SimpleKeyingInterface | |
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. | |
Public Member Functions inherited from HashTransformation | |
HashTransformation & | Ref () |
Provides a reference to this object. | |
virtual byte * | CreateUpdateSpace (size_t &size) |
Request space which can be written into by the caller. | |
virtual void | Final (byte *digest) |
Computes the hash of the current message. | |
unsigned int | TagSize () const |
virtual unsigned int | BlockSize () const |
Provides the block size of the compression function. | |
virtual unsigned int | OptimalDataAlignment () const |
Provides input and output data alignment for optimal performance. | |
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. | |
virtual bool | Verify (const byte *digest) |
Verifies the hash of the current message. | |
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. | |
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. | |
virtual bool | TruncatedVerify (const byte *digest, size_t digestLength) |
Verifies the hash of the current message. | |
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. | |
Public Member Functions inherited from Algorithm | |
Algorithm (bool checkSelfTestStatus=true) | |
Interface for all crypto algorithms. | |
virtual std::string | AlgorithmName () const |
Provides the name of this algorithm. | |
virtual std::string | AlgorithmProvider () const |
Retrieve the provider of this algorithm. | |
Public Member Functions inherited from Clonable | |
virtual Clonable * | Clone () const |
Copies this object. | |
Protected Member Functions | |
virtual HashTransformation & | AccessHash ()=0 |
byte * | AccessIpad () |
byte * | AccessOpad () |
byte * | AccessInnerHash () |
Protected Member Functions inherited from SimpleKeyingInterface | |
void | ThrowIfInvalidKeyLength (size_t length) |
Validates the key length. | |
void | ThrowIfResynchronizable () |
Validates the object. | |
void | ThrowIfInvalidIV (const byte *iv) |
Validates the IV. | |
size_t | ThrowIfInvalidIVLength (int length) |
Validates the IV length. | |
const byte * | GetIVAndThrowIfInvalid (const NameValuePairs ¶ms, size_t &size) |
Retrieves and validates the IV. | |
void | AssertValidKeyLength (size_t length) const |
Validates the key length. | |
Protected Member Functions inherited from HashTransformation | |
void | ThrowIfInvalidTruncatedSize (size_t size) const |
Validates a truncated digest size. | |
Additional Inherited Members | |
Public Types inherited from SimpleKeyingInterface | |
enum | IV_Requirement { UNIQUE_IV = 0 , RANDOM_IV , UNPREDICTABLE_RANDOM_IV , INTERNALLY_GENERATED_IV , NOT_RESYNCHRONIZABLE } |
Secure IVs requirements as enumerated values. More... | |
HMAC information.
HMAC_Base derives from VariableKeyLength and MessageAuthenticationCode
|
inlinevirtual |
Provides the digest size of the hash
Implements HashTransformation.
|
inlinevirtual |
Provides the input block size most efficient for this hash.
The base class implementation returns MandatoryBlockSize().
Optimal input length is n * OptimalBlockSize() - GetOptimalBlockSizeUsed()
for any n > 0
.
Reimplemented from HashTransformation.
|
virtual |
Restart the hash.
Discards the current state, and restart for a new message
Reimplemented from HashTransformation.
|
virtual |
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() calls Final() and then copies digestSize bytes to digest. The hash is restarted the hash for the next message.
COUNTOF(digest) <= DigestSize()
or COUNTOF(digest) <= HASH::DIGESTSIZE
ensures the output byte buffer is a valid size. Implements HashTransformation.
|
virtual |
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.
|
virtual |
Updates a hash with additional input.
input | the additional input as a buffer |
length | the size of the buffer, in bytes |
Implements HashTransformation.