Hashed Menezes-Qu-Vanstone in GF(p) More...

#include <hmqv.h>

Inheritance diagram for HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >:

Collaboration diagram for HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >:

Public Types
typedef GROUP_PARAMETERS	GroupParameters

typedef GroupParameters::Element	Element

typedef HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >	Domain

Public Member Functions
virtual	~HMQV_Domain ()

	HMQV_Domain (bool clientRole=true)

	HMQV_Domain (const GroupParameters &params, bool clientRole=true)

	HMQV_Domain (BufferedTransformation &bt, bool clientRole=true)

template<class T1 >
	HMQV_Domain (T1 v1, bool clientRole=true)

template<class T1 , class T2 >
	HMQV_Domain (T1 v1, T2 v2, bool clientRole=true)

template<class T1 , class T2 , class T3 >
	HMQV_Domain (T1 v1, T2 v2, T3 v3, bool clientRole=true)

template<class T1 , class T2 , class T3 , class T4 >
	HMQV_Domain (T1 v1, T2 v2, T3 v3, T4 v4, bool clientRole=true)

const GroupParameters &	GetGroupParameters () const

GroupParameters &	AccessGroupParameters ()

CryptoParameters &	AccessCryptoParameters ()
	Retrieves a reference to Crypto Parameters. More...

unsigned int	AgreedValueLength () const
	return length of agreed value produced More...

unsigned int	StaticPrivateKeyLength () const
	return length of static private keys in this domain More...

unsigned int	StaticPublicKeyLength () const
	return length of static public keys in this domain More...

void	GenerateStaticPrivateKey (RandomNumberGenerator &rng, byte *privateKey) const
	generate static private key More...

void	GenerateStaticPublicKey (RandomNumberGenerator &rng, const byte privateKey, byte publicKey) const
	generate static public key More...

unsigned int	EphemeralPrivateKeyLength () const
	Provides the size of ephemeral private key. More...

unsigned int	EphemeralPublicKeyLength () const
	Provides the size of ephemeral public key. More...

void	GenerateEphemeralPrivateKey (RandomNumberGenerator &rng, byte *privateKey) const
	return length of ephemeral private keys in this domain More...

void	GenerateEphemeralPublicKey (RandomNumberGenerator &rng, const byte privateKey, byte publicKey) const
	return length of ephemeral public keys in this domain More...

bool	Agree (byte agreedValue, const byte staticPrivateKey, const byte ephemeralPrivateKey, const byte staticOtherPublicKey, const byte *ephemeralOtherPublicKey, bool validateStaticOtherPublicKey=true) const
	derive agreed value from your private keys and couterparty's public keys, return false in case of failure More...

Public Member Functions inherited from AuthenticatedKeyAgreementDomain
virtual	~AuthenticatedKeyAgreementDomain ()

virtual void	GenerateStaticKeyPair (RandomNumberGenerator &rng, byte privateKey, byte publicKey) const
	Generate a static private/public key pair. More...

virtual void	GenerateEphemeralKeyPair (RandomNumberGenerator &rng, byte privateKey, byte publicKey) const
	Generate private/public key pair. More...

Public Member Functions inherited from KeyAgreementAlgorithm
virtual	~KeyAgreementAlgorithm ()

CryptoMaterial &	AccessMaterial ()
	Retrieves a reference to Crypto Parameters. More...

const CryptoMaterial &	GetMaterial () const
	Retrieves a reference to Crypto Parameters. More...

virtual const CryptoParameters &	GetCryptoParameters () const
	Retrieves a reference to Crypto Parameters. More...

Public Member Functions inherited from AsymmetricAlgorithm
virtual	~AsymmetricAlgorithm ()

void	BERDecode (BufferedTransformation &bt)
	Loads this object from a BufferedTransformation. More...

void	DEREncode (BufferedTransformation &bt) const
	Saves this object to a BufferedTransformation. More...

Public Member Functions inherited from Algorithm
virtual	~Algorithm ()

	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...

virtual std::string	AlgorithmName () const
	Provides the name of this algorithm. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()

virtual Clonable *	Clone () const
	Copies this object. More...

Protected Member Functions
void	Hash (const Element sigma, const byte e1, size_t e1len, const byte s1, size_t s1len, byte digest, size_t dlen) const

Private Types
enum	KeyAgreementRole { RoleServer = 1, RoleClient }

Private Member Functions
DL_GroupParameters< Element > &	AccessAbstractGroupParameters ()

const DL_GroupParameters< Element > &	GetAbstractGroupParameters () const

Private Attributes
GroupParameters	m_groupParameters

KeyAgreementRole	m_role

Detailed Description

template<class GROUP_PARAMETERS, class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>
class HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >

Hashed Menezes-Qu-Vanstone in GF(p)

This implementation follows Hugo Krawczyk's HMQV: A High-Performance Secure Diffie-Hellman Protocol. Note: this implements HMQV only. HMQV-C with Key Confirmation is not provided.

See also: MQV, HMQV, FHMQV, and AuthenticatedKeyAgreementDomain

Since: Crypto++ 5.6.4

Definition at line 23 of file hmqv.h.

Member Typedef Documentation

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

typedef HMQV_Domain<GROUP_PARAMETERS, COFACTOR_OPTION, HASH> HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::Domain

Definition at line 28 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

typedef GroupParameters::Element HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::Element

Definition at line 27 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

typedef GROUP_PARAMETERS HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::GroupParameters

Definition at line 26 of file hmqv.h.

Member Enumeration Documentation

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

enum HMQV_Domain::KeyAgreementRole

private

Enumerator
RoleServer
RoleClient

Definition at line 292 of file hmqv.h.

Constructor & Destructor Documentation

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

virtual HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::~HMQV_Domain ( )

inlinevirtual

Definition at line 30 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::HMQV_Domain ( bool clientRole = true )

inline

Definition at line 32 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::HMQV_Domain	(	const GroupParameters &	params,
		bool	clientRole = `true`
	)

inline

Definition at line 34 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::HMQV_Domain	(	BufferedTransformation &	bt,
		bool	clientRole = `true`
	)

inline

Definition at line 37 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

template<class T1 >

HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::HMQV_Domain	(	T1	v1,
		bool	clientRole = `true`
	)

inline

Definition at line 42 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

template<class T1 , class T2 >

HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::HMQV_Domain	(	T1	v1,
		T2	v2,
		bool	clientRole = `true`
	)

inline

Definition at line 47 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

template<class T1 , class T2 , class T3 >

HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::HMQV_Domain	(	T1	v1,
		T2	v2,
		T3	v3,
		bool	clientRole = `true`
	)

inline

Definition at line 52 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

template<class T1 , class T2 , class T3 , class T4 >

HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::HMQV_Domain	(	T1	v1,
		T2	v2,
		T3	v3,
		T4	v4,
		bool	clientRole = `true`
	)

inline

Definition at line 57 of file hmqv.h.

Member Function Documentation

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

DL_GroupParameters<Element>& HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::AccessAbstractGroupParameters ( )

inlineprivate

Definition at line 294 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

CryptoParameters& HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::AccessCryptoParameters ( )

inlinevirtual

Retrieves a reference to Crypto Parameters.

Returns: a reference the crypto parameters

Implements KeyAgreementAlgorithm.

Definition at line 66 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

GroupParameters& HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::AccessGroupParameters ( )

inline

Definition at line 64 of file hmqv.h.

Here is the caller graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

bool HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::Agree	(	byte *	agreedValue,
		const byte *	staticPrivateKey,
		const byte *	ephemeralPrivateKey,
		const byte *	staticOtherPublicKey,
		const byte *	ephemeralOtherPublicKey,
		bool	validateStaticOtherPublicKey = `true`
	)		const

inlinevirtual

derive agreed value from your private keys and couterparty's public keys, return false in case of failure

Note: The ephemeral public key will always be validated. If you have previously validated the static public key, use validateStaticOtherPublicKey=false to save time.

Precondition: size of agreedValue == AgreedValueLength(); length of staticPrivateKey == StaticPrivateKeyLength(); length of ephemeralPrivateKey == EphemeralPrivateKeyLength(); length of staticOtherPublicKey == StaticPublicKeyLength(); length of ephemeralOtherPublicKey == EphemeralPublicKeyLength()

Implements AuthenticatedKeyAgreementDomain.

Definition at line 123 of file hmqv.h.

Here is the call graph for this function:

Here is the caller graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

unsigned int HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::AgreedValueLength ( ) const

inlinevirtual

return length of agreed value produced

Implements AuthenticatedKeyAgreementDomain.

Definition at line 69 of file hmqv.h.

Here is the caller graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

unsigned int HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::EphemeralPrivateKeyLength ( ) const

inlinevirtual

Provides the size of ephemeral private key.

Returns: the size of ephemeral private key in this domain

Implements AuthenticatedKeyAgreementDomain.

Definition at line 94 of file hmqv.h.

Here is the caller graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

unsigned int HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::EphemeralPublicKeyLength ( ) const

inlinevirtual

Provides the size of ephemeral public key.

Returns: the size of ephemeral public key in this domain

Implements AuthenticatedKeyAgreementDomain.

Definition at line 95 of file hmqv.h.

Here is the caller graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

void HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::GenerateEphemeralPrivateKey	(	RandomNumberGenerator &	rng,
		byte *	privateKey
	)		const

inlinevirtual

return length of ephemeral private keys in this domain

Implements AuthenticatedKeyAgreementDomain.

Definition at line 98 of file hmqv.h.

Here is the call graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

void HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::GenerateEphemeralPublicKey	(	RandomNumberGenerator &	rng,
		const byte *	privateKey,
		byte *	publicKey
	)		const

inlinevirtual

return length of ephemeral public keys in this domain

Implements AuthenticatedKeyAgreementDomain.

Definition at line 108 of file hmqv.h.

Here is the call graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

void HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::GenerateStaticPrivateKey	(	RandomNumberGenerator &	rng,
		byte *	privateKey
	)		const

inlinevirtual

generate static private key

Precondition: size of privateKey == PrivateStaticKeyLength()

Implements AuthenticatedKeyAgreementDomain.

Definition at line 77 of file hmqv.h.

Here is the call graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

void HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::GenerateStaticPublicKey	(	RandomNumberGenerator &	rng,
		const byte *	privateKey,
		byte *	publicKey
	)		const

inlinevirtual

generate static public key

Precondition: size of publicKey == PublicStaticKeyLength()

Implements AuthenticatedKeyAgreementDomain.

Definition at line 85 of file hmqv.h.

Here is the call graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

const DL_GroupParameters<Element>& HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::GetAbstractGroupParameters ( ) const

inlineprivate

Definition at line 295 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

const GroupParameters& HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::GetGroupParameters ( ) const

inline

Definition at line 63 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

void HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::Hash	(	const Element *	sigma,
		const byte *	e1,
		size_t	e1len,
		const byte *	s1,
		size_t	s1len,
		byte *	digest,
		size_t	dlen
	)		const

inlineprotected

Definition at line 247 of file hmqv.h.

Here is the call graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

unsigned int HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::StaticPrivateKeyLength ( ) const

inlinevirtual

return length of static private keys in this domain

Implements AuthenticatedKeyAgreementDomain.

Definition at line 71 of file hmqv.h.

Here is the caller graph for this function:

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

unsigned int HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::StaticPublicKeyLength ( ) const

inlinevirtual

return length of static public keys in this domain

Implements AuthenticatedKeyAgreementDomain.

Definition at line 73 of file hmqv.h.

Here is the caller graph for this function:

Member Data Documentation

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

GroupParameters HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::m_groupParameters

private

Definition at line 297 of file hmqv.h.

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>

KeyAgreementRole HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >::m_role

private

Definition at line 298 of file hmqv.h.

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

src/cryptopp/hmqv.h

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<class GROUP_PARAMETERS, class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512> class HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class GROUP_PARAMETERS, class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption, class HASH = SHA512>
class HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >