GCM block cipher final implementation. More...
#include <gcm.h>
Inheritance diagram for GCM_Final< T_BlockCipher, T_TablesOption, T_IsEncryption >:
Public Member Functions | |
| bool | IsForwardTransformation () const |
| Determines if the cipher is being operated in its forward direction. | |
 Public Member Functions inherited from GCM_Base | |
| std::string | AlgorithmName () const |
| Provides the name of this algorithm. | |
| std::string | AlgorithmProvider () const |
| Retrieve the provider of this algorithm. | |
| size_t | MinKeyLength () const |
| Returns smallest valid key length. | |
| size_t | MaxKeyLength () const |
| Returns largest valid key length. | |
| size_t | DefaultKeyLength () const |
| Returns default key length. | |
| size_t | GetValidKeyLength (size_t n) const |
| Returns a valid key length for the algorithm. | |
| bool | IsValidKeyLength (size_t n) const |
| Returns whether keylength is a valid key length. | |
| unsigned int | OptimalDataAlignment () const |
| Provides input and output data alignment for optimal performance. | |
| IV_Requirement | IVRequirement () const |
| Minimal requirement for secure IVs. | |
| unsigned int | IVSize () const |
| Returns length of the IV accepted by this object. | |
| unsigned int | MinIVLength () const |
| Provides the minimum size of an IV. | |
| unsigned int | MaxIVLength () const |
| Provides the maximum size of an IV. | |
| unsigned int | DigestSize () const |
| lword | MaxHeaderLength () const |
| Provides the maximum length of AAD that can be input. | |
| lword | MaxMessageLength () const |
| Provides the maximum length of encrypted data. | |
| Public Member Functions inherited from AuthenticatedSymmetricCipherBase | |
| bool | IsRandomAccess () const |
| Determines whether the cipher supports random access. | |
| bool | IsSelfInverting () const |
| Determines whether the cipher is self-inverting. | |
| void | SetKey (const byte *userKey, size_t keylength, const NameValuePairs ¶ms) |
| Sets or reset the key of this object. | |
| void | Restart () |
| Restart the hash. | |
| void | Resynchronize (const byte *iv, int length=-1) |
| Resynchronize with an IV. | |
| void | Update (const byte *input, size_t length) |
| Updates a hash with additional input. | |
| void | ProcessData (byte *outString, const byte *inString, size_t length) |
| Encrypt or decrypt an array of bytes. | |
| void | TruncatedFinal (byte *mac, size_t macSize) |
| Computes the hash of the current message. | |
| Public Member Functions inherited from AuthenticatedSymmetricCipher | |
| virtual lword | MaxFooterLength () const |
| Provides the maximum length of AAD. | |
| virtual bool | NeedsPrespecifiedDataLengths () const |
| Determines if data lengths must be specified prior to inputting data. | |
| void | SpecifyDataLengths (lword headerLength, lword messageLength, lword footerLength=0) |
| Prescribes the data lengths. | |
| virtual void | EncryptAndAuthenticate (byte *ciphertext, byte *mac, size_t macSize, const byte *iv, int ivLength, const byte *header, size_t headerLength, const byte *message, size_t messageLength) |
| Encrypts and calculates a MAC in one call. | |
| virtual bool | DecryptAndVerify (byte *message, const byte *mac, size_t macSize, const byte *iv, int ivLength, const byte *header, size_t headerLength, const byte *ciphertext, size_t ciphertextLength) |
| Decrypts and verifies a MAC in one call. | |
| Public Member Functions inherited from SimpleKeyingInterface | |
| 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. | |
| 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. | |
| unsigned int | DefaultIVLength () const |
| Provides the default size of 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 | OptimalBlockSize () const |
| Provides the input block size most efficient for this hash. | |
| 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. | |
| Public Member Functions inherited from Clonable | |
| virtual Clonable * | Clone () const |
| Copies this object. | |
| Public Member Functions inherited from StreamTransformation | |
| StreamTransformation & | Ref () |
| Provides a reference to this object. | |
| virtual unsigned int | MandatoryBlockSize () const |
| Provides the mandatory block size of the cipher. | |
| virtual unsigned int | OptimalBlockSize () const |
| Provides the input block size most efficient for this cipher. | |
| virtual unsigned int | GetOptimalBlockSizeUsed () const |
| Provides the number of bytes used in the current block when processing at optimal block size. | |
| virtual size_t | ProcessLastBlock (byte *outString, size_t outLength, const byte *inString, size_t inLength) |
| Encrypt or decrypt the last block of data. | |
| virtual unsigned int | MinLastBlockSize () const |
| Provides the size of the last block. | |
| virtual bool | IsLastBlockSpecial () const |
| Determines if the last block receives special processing. | |
| void | ProcessString (byte *inoutString, size_t length) |
| Encrypt or decrypt a string of bytes. | |
| void | ProcessString (byte *outString, const byte *inString, size_t length) |
| Encrypt or decrypt a string of bytes. | |
| byte | ProcessByte (byte input) |
| Encrypt or decrypt a byte. | |
| virtual void | Seek (lword pos) |
| Seek to an absolute position. | |
Static Public Member Functions | |
| static std::string | StaticAlgorithmName () |
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... | |
| Protected Types inherited from GCM_Base | |
| enum | { REQUIRED_BLOCKSIZE = 16 , HASH_BLOCKSIZE = 16 } |
| Protected Types inherited from AuthenticatedSymmetricCipherBase | |
| enum | State { State_Start , State_KeySet , State_IVSet , State_AuthUntransformed , State_AuthTransformed , State_AuthFooter } |
| Protected Member Functions inherited from GCM_Base | |
| bool | AuthenticationIsOnPlaintext () const |
| unsigned int | AuthenticationBlockSize () const |
| void | SetKeyWithoutResync (const byte *userKey, size_t keylength, const NameValuePairs ¶ms) |
| void | Resync (const byte *iv, size_t len) |
| size_t | AuthenticateBlocks (const byte *data, size_t len) |
| void | AuthenticateLastHeaderBlock () |
| void | AuthenticateLastConfidentialBlock () |
| void | AuthenticateLastFooterBlock (byte *mac, size_t macSize) |
| SymmetricCipher & | AccessSymmetricCipher () |
| const BlockCipher & | GetBlockCipher () const |
| byte * | HashBuffer () |
| byte * | HashKey () |
| byte * | MulTable () |
| void | ReverseHashBufferIfNeeded () |
| Protected Member Functions inherited from AuthenticatedSymmetricCipherBase | |
| void | UncheckedSetKey (const byte *key, unsigned int length, const CryptoPP::NameValuePairs ¶ms) |
| void | AuthenticateData (const byte *data, size_t len) |
| const SymmetricCipher & | GetSymmetricCipher () const |
| Protected Member Functions inherited from AuthenticatedSymmetricCipher | |
| const Algorithm & | GetAlgorithm () const |
| Returns the base class Algorithm. | |
| virtual void | UncheckedSpecifyDataLengths (lword headerLength, lword messageLength, lword footerLength) |
| Protected Member Functions inherited from MessageAuthenticationCode | |
| Protected Member Functions inherited from SimpleKeyingInterface | |
| virtual void | UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs ¶ms)=0 |
| Sets the key for this object without performing parameter validation. | |
| 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. | |
| Protected Attributes inherited from GCM_Base | |
| GCTR | m_ctr |
| Protected Attributes inherited from AuthenticatedSymmetricCipherBase | |
| AlignedSecByteBlock | m_buffer |
| lword | m_totalHeaderLength |
| lword | m_totalMessageLength |
| lword | m_totalFooterLength |
| unsigned int | m_bufferedDataLength |
| State | m_state |
| Static Protected Attributes inherited from GCM_Base | |
| static word16 | s_reductionTable [256] |
| static volatile bool | s_reductionTableInitialized = false |
Detailed Description
template<class T_BlockCipher, GCM_TablesOption T_TablesOption, bool T_IsEncryption>
class GCM_Final< T_BlockCipher, T_TablesOption, T_IsEncryption >
class GCM_Final< T_BlockCipher, T_TablesOption, T_IsEncryption >
GCM block cipher final implementation.
- Template Parameters
-
T_BlockCipher block cipher T_TablesOption table size, either GCM_2K_TablesorGCM_64K_TablesT_IsEncryption direction in which to operate the cipher
- Since
- Crypto++ 5.6.0
Member Function Documentation
◆ IsForwardTransformation()
template<class T_BlockCipher , GCM_TablesOption T_TablesOption, bool T_IsEncryption>
|
inlinevirtual |
Determines if the cipher is being operated in its forward direction.
- Returns
- true if DIR is ENCRYPTION, false otherwise
- See also
- IsForwardTransformation(), IsPermutation(), GetCipherDirection()
Implements StreamTransformation.
◆ StaticAlgorithmName()
template<class T_BlockCipher , GCM_TablesOption T_TablesOption, bool T_IsEncryption>
|
inlinestatic |
The documentation for this class was generated from the following file:
- G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/gcm.h
