HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH > Class Template Reference

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

Inheritance 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
	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
unsigned int	StaticPrivateKeyLength () const
	return length of static private keys in this domain
unsigned int	StaticPublicKeyLength () const
	return length of static public keys in this domain
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
void	GenerateEphemeralPublicKey (RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const
	return length of ephemeral public keys in this domain
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 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
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 Algorithm
	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...
virtual std::string	AlgorithmName () const
	Provides the name of this algorithm. More...
virtual std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm. More...
Public Member Functions inherited from Clonable
virtual Clonable *	Clone () const
	Copies this object. More...

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 Function Documentation

AccessCryptoParameters()

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.

GenerateStaticPrivateKey()

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.

GenerateStaticPublicKey()

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.

EphemeralPrivateKeyLength()

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.

EphemeralPublicKeyLength()

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.

Agree()

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.

---

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

• hmqv.h