GCM block cipher base implementation. More...

#include <gcm.h>

Inheritance diagram for GCM_Base:

Classes
class	GCTR

Public Member Functions
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 &params)
	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.

virtual bool	IsForwardTransformation () const =0
	Determines if the cipher is being operated in its forward direction.

Protected Types
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
bool	AuthenticationIsOnPlaintext () const

unsigned int	AuthenticationBlockSize () const

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 ()

virtual BlockCipher &	AccessBlockCipher ()=0

virtual GCM_TablesOption	GetTablesOption () const =0

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 &params)

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
const Algorithm &	GetAlgorithm () const
	Returns the base class Algorithm.

Protected Member Functions inherited from SimpleKeyingInterface
virtual void	UncheckedSetKey (const byte *key, unsigned int length, const NameValuePairs &params)=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 &params, 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
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
static word16	s_reductionTable [256]

static volatile bool	s_reductionTableInitialized = false

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...

Detailed Description

GCM block cipher base implementation.

Base implementation of the AuthenticatedSymmetricCipher interface

Since: Crypto++ 5.6.0

Definition at line 32 of file gcm.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Definition at line 98 of file gcm.h.

Member Function Documentation

◆ AccessSymmetricCipher()

SymmetricCipher & GCM_Base::AccessSymmetricCipher ( )

inlineprotectedvirtual

Implements AuthenticatedSymmetricCipherBase.

Definition at line 78 of file gcm.h.

◆ AlgorithmName()

std::string GCM_Base::AlgorithmName ( ) const

inlinevirtual

Provides the name of this algorithm.

Returns: the standard algorithm name

The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.

Reimplemented from AuthenticatedSymmetricCipher.

Definition at line 36 of file gcm.h.

◆ AlgorithmProvider()

std::string GCM_Base::AlgorithmProvider ( ) const

inlinevirtual

Retrieve the provider of this algorithm.

Returns: the algorithm provider

The algorithm provider can be a name like "C++", "SSE", "NEON", "AESNI", "ARMv8" and "Power8". C++ is standard C++ code. Other labels, like SSE, usually indicate a specialized implementation using instructions from a higher instruction set architecture (ISA). Future labels may include external hardware like a hardware security module (HSM).

Generally speaking Wei Dai's original IA-32 ASM code falls under "SSE2". Labels like "SSSE3" and "SSE4.1" follow after Wei's code and use intrinsics instead of ASM.

Algorithms which combine different instructions or ISAs provide the dominant one. For example on x86 AES/GCM returns "AESNI" rather than "CLMUL" or "AES+SSE4.1" or "AES+CLMUL" or "AES+SSE4.1+CLMUL".

Note: Provider is not universally implemented yet.

Since: Crypto++ 8.0

Reimplemented from AuthenticatedSymmetricCipher.

Definition at line 38 of file gcm.h.

◆ AuthenticateBlocks()

size_t GCM_Base::AuthenticateBlocks	(	const byte *	data,
		size_t	len
	)

protectedvirtual

Implements AuthenticatedSymmetricCipherBase.

Definition at line 389 of file gcm.cpp.

◆ AuthenticateLastConfidentialBlock()

void GCM_Base::AuthenticateLastConfidentialBlock ( )

protectedvirtual

Reimplemented from AuthenticatedSymmetricCipherBase.

Definition at line 834 of file gcm.cpp.

◆ AuthenticateLastFooterBlock()

void GCM_Base::AuthenticateLastFooterBlock	(	byte *	mac,
		size_t	macSize
	)

protectedvirtual

Implements AuthenticatedSymmetricCipherBase.

Definition at line 841 of file gcm.cpp.

◆ AuthenticateLastHeaderBlock()

void GCM_Base::AuthenticateLastHeaderBlock ( )

protectedvirtual

Implements AuthenticatedSymmetricCipherBase.

Definition at line 824 of file gcm.cpp.

◆ AuthenticationBlockSize()

unsigned int GCM_Base::AuthenticationBlockSize ( ) const

inlineprotectedvirtual

Implements AuthenticatedSymmetricCipherBase.

Definition at line 70 of file gcm.h.

◆ AuthenticationIsOnPlaintext()

bool GCM_Base::AuthenticationIsOnPlaintext ( ) const

inlineprotectedvirtual

Implements AuthenticatedSymmetricCipherBase.

Definition at line 68 of file gcm.h.

◆ DefaultKeyLength()

size_t GCM_Base::DefaultKeyLength ( ) const

inlinevirtual

Returns default key length.

Returns: the default key length, in bytes

Implements SimpleKeyingInterface.

Definition at line 44 of file gcm.h.

◆ DigestSize()

unsigned int GCM_Base::DigestSize ( ) const

inlinevirtual

Provides the digest size of the hash

Returns: the digest size of the hash.

Implements HashTransformation.

Definition at line 59 of file gcm.h.

◆ GetBlockCipher()

const BlockCipher & GCM_Base::GetBlockCipher ( ) const

inlineprotected

Definition at line 83 of file gcm.h.

◆ GetValidKeyLength()

size_t GCM_Base::GetValidKeyLength ( size_t keylength ) const

inlinevirtual

Returns a valid key length for the algorithm.

Parameters

keylength the size of the key, in bytes

Returns: the valid key length, 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.

Implements SimpleKeyingInterface.

Definition at line 46 of file gcm.h.

◆ HashBuffer()

byte * GCM_Base::HashBuffer ( )

inlineprotected

Definition at line 84 of file gcm.h.

◆ HashKey()

byte * GCM_Base::HashKey ( )

inlineprotected

Definition at line 85 of file gcm.h.

◆ IsValidKeyLength()

bool GCM_Base::IsValidKeyLength ( size_t keylength ) const

inlinevirtual

Returns whether keylength is a valid key length.

Parameters

keylength the requested keylength

Returns: true if keylength is valid, false otherwise

Internally the function calls GetValidKeyLength()

Reimplemented from SimpleKeyingInterface.

Definition at line 48 of file gcm.h.

◆ IVRequirement()

IV_Requirement GCM_Base::IVRequirement ( ) const

inlinevirtual

Minimal requirement for secure IVs.

Returns: the secure IV requirement of the algorithm

Implements SimpleKeyingInterface.

Definition at line 51 of file gcm.h.

◆ IVSize()

unsigned int GCM_Base::IVSize ( ) const

inlinevirtual

Returns length of the IV accepted by this object.

Returns: the size of an IV, in bytes

Exceptions

NotImplemented() if the object does not support resynchronization

The default implementation throws NotImplemented

Reimplemented from SimpleKeyingInterface.

Definition at line 53 of file gcm.h.

◆ MaxHeaderLength()

lword GCM_Base::MaxHeaderLength ( ) const

inlinevirtual

Provides the maximum length of AAD that can be input.

Returns: the maximum length of AAD that can be input before the encrypted data

Implements AuthenticatedSymmetricCipher.

Definition at line 61 of file gcm.h.

◆ MaxIVLength()

unsigned int GCM_Base::MaxIVLength ( ) const

inlinevirtual

Provides the maximum size of an IV.

Returns: maximal length of IVs accepted by this object, in bytes

Exceptions

NotImplemented() if the object does not support resynchronization

Reimplemented from SimpleKeyingInterface.

Definition at line 57 of file gcm.h.

◆ MaxKeyLength()

size_t GCM_Base::MaxKeyLength ( ) const

inlinevirtual

Returns largest valid key length.

Returns: the maximum key length, in bytes

Implements SimpleKeyingInterface.

Definition at line 42 of file gcm.h.

◆ MaxMessageLength()

lword GCM_Base::MaxMessageLength ( ) const

inlinevirtual

Provides the maximum length of encrypted data.

Returns: the maximum length of encrypted data

Implements AuthenticatedSymmetricCipher.

Definition at line 63 of file gcm.h.

◆ MinIVLength()

unsigned int GCM_Base::MinIVLength ( ) const

inlinevirtual

Provides the minimum size of an IV.

Returns: minimal length of IVs accepted by this object, in bytes

Exceptions

NotImplemented() if the object does not support resynchronization

Reimplemented from SimpleKeyingInterface.

Definition at line 55 of file gcm.h.

◆ MinKeyLength()

size_t GCM_Base::MinKeyLength ( ) const

inlinevirtual

Returns smallest valid key length.

Returns: the minimum key length, in bytes

Implements SimpleKeyingInterface.

Definition at line 40 of file gcm.h.

◆ MulTable()

byte * GCM_Base::MulTable ( )

inlineprotected

Definition at line 86 of file gcm.h.

◆ OptimalDataAlignment()

unsigned int GCM_Base::OptimalDataAlignment ( ) const

virtual

Provides input and output data alignment for optimal performance.

Returns: the input data alignment that provides optimal performance

See also: GetAlignment() and OptimalBlockSize()

Reimplemented from HashTransformation.

Definition at line 361 of file gcm.cpp.

◆ Resync()

void GCM_Base::Resync	(	const byte *	iv,
		size_t	len
	)

protectedvirtual

Implements AuthenticatedSymmetricCipherBase.

Definition at line 316 of file gcm.cpp.

◆ ReverseHashBufferIfNeeded()

void GCM_Base::ReverseHashBufferIfNeeded ( )

inlineprotected

Definition at line 296 of file gcm.cpp.

◆ SetKeyWithoutResync()

void GCM_Base::SetKeyWithoutResync	(	const byte *	userKey,
		size_t	keylength,
		const NameValuePairs &	params
	)

protectedvirtual

Implements AuthenticatedSymmetricCipherBase.

Definition at line 99 of file gcm.cpp.

Member Data Documentation

◆ m_ctr

GCTR GCM_Base::m_ctr

protected

Definition at line 95 of file gcm.h.

◆ s_reductionTable

word16 GCM_Base::s_reductionTable

staticprotected

Definition at line 96 of file gcm.h.

◆ s_reductionTableInitialized

volatile bool GCM_Base::s_reductionTableInitialized = false

staticprotected

Definition at line 97 of file gcm.h.

The documentation for this class was generated from the following files:

G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/gcm.h
G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/gcm.cpp

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ AccessSymmetricCipher()

◆ AlgorithmName()

◆ AlgorithmProvider()

◆ AuthenticateBlocks()

◆ AuthenticateLastConfidentialBlock()

◆ AuthenticateLastFooterBlock()

◆ AuthenticateLastHeaderBlock()

◆ AuthenticationBlockSize()

◆ AuthenticationIsOnPlaintext()

◆ DefaultKeyLength()

◆ DigestSize()

◆ GetBlockCipher()

◆ GetValidKeyLength()

◆ HashBuffer()

◆ HashKey()

◆ IsValidKeyLength()

◆ IVRequirement()

◆ IVSize()

◆ MaxHeaderLength()

◆ MaxIVLength()

◆ MaxKeyLength()

◆ MaxMessageLength()

◆ MinIVLength()

◆ MinKeyLength()

◆ MulTable()

◆ OptimalDataAlignment()

◆ Resync()

◆ ReverseHashBufferIfNeeded()

◆ SetKeyWithoutResync()

Member Data Documentation

◆ m_ctr

◆ s_reductionTable

◆ s_reductionTableInitialized