gcm.h
#ifndef CRYPTOPP_GCM_H
#define CRYPTOPP_GCM_H
#include "authenc.h"
#include "modes.h"
NAMESPACE_BEGIN(CryptoPP)
//! .
enum GCM_TablesOption {GCM_2K_Tables, GCM_64K_Tables};
//! .
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE GCM_Base : public AuthenticatedSymmetricCipherBase
{
public:
// AuthenticatedSymmetricCipher
std::string AlgorithmName() const
{return GetBlockCipher().AlgorithmName() + std::string("/GCM");}
size_t MinKeyLength() const
{return GetBlockCipher().MinKeyLength();}
size_t MaxKeyLength() const
{return GetBlockCipher().MaxKeyLength();}
size_t DefaultKeyLength() const
{return GetBlockCipher().DefaultKeyLength();}
size_t GetValidKeyLength(size_t n) const
{return GetBlockCipher().GetValidKeyLength(n);}
bool IsValidKeyLength(size_t n) const
{return GetBlockCipher().IsValidKeyLength(n);}
unsigned int OptimalDataAlignment() const;
IV_Requirement IVRequirement() const
{return UNIQUE_IV;}
unsigned int IVSize() const
{return 12;}
unsigned int MinIVLength() const
{return 1;}
unsigned int MaxIVLength() const
{return UINT_MAX;} // (W64LIT(1)<<61)-1 in the standard
unsigned int DigestSize() const
{return 16;}
lword MaxHeaderLength() const
{return (W64LIT(1)<<61)-1;}
lword MaxMessageLength() const
{return ((W64LIT(1)<<39)-256)/8;}
protected:
// AuthenticatedSymmetricCipherBase
bool AuthenticationIsOnPlaintext() const
{return false;}
unsigned int AuthenticationBlockSize() const
{return HASH_BLOCKSIZE;}
void SetKeyWithoutResync(const byte *userKey, size_t keylength, const NameValuePairs &params);
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() {return m_ctr;}
virtual BlockCipher & AccessBlockCipher() =0;
virtual GCM_TablesOption GetTablesOption() const =0;
const BlockCipher & GetBlockCipher() const {return const_cast<GCM_Base *>(this)->AccessBlockCipher();};
byte *HashBuffer() {return m_buffer+REQUIRED_BLOCKSIZE;}
byte *HashKey() {return m_buffer+2*REQUIRED_BLOCKSIZE;}
byte *MulTable() {return m_buffer+3*REQUIRED_BLOCKSIZE;}
inline void ReverseHashBufferIfNeeded();
class CRYPTOPP_DLL GCTR : public CTR_Mode_ExternalCipher::Encryption
{
protected:
void IncrementCounterBy256();
};
GCTR m_ctr;
static word16 s_reductionTable[256];
static volatile bool s_reductionTableInitialized;
enum {REQUIRED_BLOCKSIZE = 16, HASH_BLOCKSIZE = 16};
};
//! .
template <class T_BlockCipher, GCM_TablesOption T_TablesOption, bool T_IsEncryption>
class GCM_Final : public GCM_Base
{
public:
static std::string StaticAlgorithmName()
{return T_BlockCipher::StaticAlgorithmName() + std::string("/GCM");}
bool IsForwardTransformation() const
{return T_IsEncryption;}
private:
GCM_TablesOption GetTablesOption() const {return T_TablesOption;}
BlockCipher & AccessBlockCipher() {return m_cipher;}
typename T_BlockCipher::Encryption m_cipher;
};
//! <a href="http://www.cryptolounge.org/wiki/GCM">GCM</a>
template <class T_BlockCipher, GCM_TablesOption T_TablesOption=GCM_2K_Tables>
struct GCM : public AuthenticatedSymmetricCipherDocumentation
{
typedef GCM_Final<T_BlockCipher, T_TablesOption, true> Encryption;
typedef GCM_Final<T_BlockCipher, T_TablesOption, false> Decryption;
};
NAMESPACE_END
#endif
GCM_Base
Definition: gcm.h:13
CipherModeFinalTemplate_ExternalCipher
_
Definition: modes.h:278
GCM_Base::MaxIVLength
unsigned int MaxIVLength() const
returns maximal length of IVs accepted by this object
Definition: gcm.h:36
GCM_Base::MinIVLength
unsigned int MinIVLength() const
returns minimal length of IVs accepted by this object
Definition: gcm.h:34
modes.h
GCM_Base::MaxHeaderLength
lword MaxHeaderLength() const
the maximum length of AAD that can be input before the encrypted data
Definition: gcm.h:40
GCM_Base::MinKeyLength
size_t MinKeyLength() const
returns smallest valid key length in bytes */
Definition: gcm.h:19
AuthenticatedSymmetricCipherDocumentation
Each class derived from this one defines two types, Encryption and Decryption, both of which implemen...
Definition: seckey.h:211
BlockCipher
interface for one direction (encryption or decryption) of a block cipher
Definition: cryptlib.h:603
StreamTransformation::OptimalDataAlignment
virtual unsigned int OptimalDataAlignment() const
returns how input should be aligned for optimal performance
GCM_Base::DigestSize
unsigned int DigestSize() const
size of the hash/digest/MAC returned by Final()
Definition: gcm.h:38
SymmetricCipher
interface for one direction (encryption or decryption) of a stream cipher or cipher mode ...
Definition: cryptlib.h:610
GCM
GCM
Definition: gcm.h:98
AuthenticatedSymmetricCipherBase
Definition: authenc.h:10
GCM_Base::MaxKeyLength
size_t MaxKeyLength() const
returns largest valid key length in bytes */
Definition: gcm.h:21
GCM_Base::DefaultKeyLength
size_t DefaultKeyLength() const
returns default (recommended) key length in bytes */
Definition: gcm.h:23
GCM_Final::IsForwardTransformation
bool IsForwardTransformation() const
returns whether this is an encryption object
Definition: gcm.h:87
GCM_Base::MaxMessageLength
lword MaxMessageLength() const
the maximum length of encrypted data
Definition: gcm.h:42
GCM_Base::GetValidKeyLength
size_t GetValidKeyLength(size_t n) const
returns the smallest valid key length in bytes that is >= min(n, GetMaxKeyLength()) ...
Definition: gcm.h:25
GCM_Base::AlgorithmName
std::string AlgorithmName() const
returns name of this algorithm, not universally implemented yet
Definition: gcm.h:17
GCM_Base::IVRequirement
IV_Requirement IVRequirement() const
returns the minimal requirement for secure IVs
Definition: gcm.h:30
GCM_Final
Definition: gcm.h:82
GCM_Base::IsValidKeyLength
bool IsValidKeyLength(size_t n) const
returns whether n is a valid key length
Definition: gcm.h:27
GCM_Base::GCTR
Definition: gcm.h:68
NameValuePairs
interface for retrieving values given their names
Definition: cryptlib.h:224