Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
AuthenticatedKeyAgreementDomain Class Referenceabstract

Interface for domains of authenticated key agreement protocols. More...

+ Inheritance diagram for AuthenticatedKeyAgreementDomain:

Public Member Functions

virtual unsigned int AgreedValueLength () const =0
 return length of agreed value produced
 
virtual unsigned int StaticPrivateKeyLength () const =0
 return length of static private keys in this domain
 
virtual unsigned int StaticPublicKeyLength () const =0
 return length of static public keys in this domain
 
virtual void GenerateStaticPrivateKey (RandomNumberGenerator &rng, byte *privateKey) const =0
 generate static private key More...
 
virtual void GenerateStaticPublicKey (RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const =0
 generate static public key More...
 
virtual void GenerateStaticKeyPair (RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const
 generate private/public key pair More...
 
virtual unsigned int EphemeralPrivateKeyLength () const =0
 return length of ephemeral private keys in this domain
 
virtual unsigned int EphemeralPublicKeyLength () const =0
 return length of ephemeral public keys in this domain
 
virtual void GenerateEphemeralPrivateKey (RandomNumberGenerator &rng, byte *privateKey) const =0
 generate ephemeral private key More...
 
virtual void GenerateEphemeralPublicKey (RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const =0
 generate ephemeral public key More...
 
virtual void GenerateEphemeralKeyPair (RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const
 generate private/public key pair More...
 
virtual bool Agree (byte *agreedValue, const byte *staticPrivateKey, const byte *ephemeralPrivateKey, const byte *staticOtherPublicKey, const byte *ephemeralOtherPublicKey, bool validateStaticOtherPublicKey=true) const =0
 derive agreed value from your private keys and couterparty's public keys, return false in case of failure More...
 
CryptoMaterialAccessMaterial ()
 returns a reference to the crypto material used by this object
 
const CryptoMaterialGetMaterial () const
 returns a const reference to the crypto material used by this object
 
virtual CryptoParametersAccessCryptoParameters ()=0
 
virtual const CryptoParametersGetCryptoParameters () const
 
void BERDecode (BufferedTransformation &bt)
 for backwards compatibility, calls AccessMaterial().Load(bt)
 
void DEREncode (BufferedTransformation &bt) const
 for backwards compatibility, calls GetMaterial().Save(bt)
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
virtual ClonableClone () const
 Copies this object. More...
 

Detailed Description

Interface for domains of authenticated key agreement protocols.

In an authenticated key agreement protocol, each party has two key pairs. The long-lived key pair is called the static key pair, and the short-lived key pair is called the ephemeral key pair.

Definition at line 2444 of file cryptlib.h.

Member Function Documentation

virtual void AuthenticatedKeyAgreementDomain::GenerateStaticPrivateKey ( RandomNumberGenerator rng,
byte *  privateKey 
) const
pure virtual

generate static private key

Precondition
size of privateKey == PrivateStaticKeyLength()

Implemented in MQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, and DH2.

virtual void AuthenticatedKeyAgreementDomain::GenerateStaticPublicKey ( RandomNumberGenerator rng,
const byte *  privateKey,
byte *  publicKey 
) const
pure virtual

generate static public key

re size of publicKey == PublicStaticKeyLength()

Implemented in MQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, and DH2.

void AuthenticatedKeyAgreementDomain::GenerateStaticKeyPair ( RandomNumberGenerator rng,
byte *  privateKey,
byte *  publicKey 
) const
virtual

generate private/public key pair

Note
equivalent to calling GenerateStaticPrivateKey() and then GenerateStaticPublicKey()

Reimplemented in DH2.

Definition at line 927 of file cryptlib.cpp.

Referenced by FixedRNG::GenerateBlock().

virtual void AuthenticatedKeyAgreementDomain::GenerateEphemeralPrivateKey ( RandomNumberGenerator rng,
byte *  privateKey 
) const
pure virtual

generate ephemeral private key

Precondition
size of privateKey == PrivateEphemeralKeyLength()

Implemented in MQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, and DH2.

virtual void AuthenticatedKeyAgreementDomain::GenerateEphemeralPublicKey ( RandomNumberGenerator rng,
const byte *  privateKey,
byte *  publicKey 
) const
pure virtual

generate ephemeral public key

re size of publicKey == PublicEphemeralKeyLength()

Implemented in MQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, and DH2.

void AuthenticatedKeyAgreementDomain::GenerateEphemeralKeyPair ( RandomNumberGenerator rng,
byte *  privateKey,
byte *  publicKey 
) const
virtual

generate private/public key pair

Note
equivalent to calling GenerateEphemeralPrivateKey() and then GenerateEphemeralPublicKey()

Reimplemented in DH2.

Definition at line 933 of file cryptlib.cpp.

Referenced by FixedRNG::GenerateBlock().

virtual bool AuthenticatedKeyAgreementDomain::Agree ( byte *  agreedValue,
const byte *  staticPrivateKey,
const byte *  ephemeralPrivateKey,
const byte *  staticOtherPublicKey,
const byte *  ephemeralOtherPublicKey,
bool  validateStaticOtherPublicKey = true 
) const
pure virtual

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. re size of agreedValue == AgreedValueLength() re length of staticPrivateKey == StaticPrivateKeyLength() re length of ephemeralPrivateKey == EphemeralPrivateKeyLength() re length of staticOtherPublicKey == StaticPublicKeyLength() re length of ephemeralOtherPublicKey == EphemeralPublicKeyLength()

Implemented in MQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, and DH2.

Referenced by FixedRNG::GenerateBlock().

virtual std::string Algorithm::AlgorithmName ( ) const
inlinevirtualinherited

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.

Note
AlgorithmName is not universally implemented yet

Reimplemented in AuthenticatedSymmetricCipher, SignatureVerificationFilter, SignerFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, HashFilter, StreamTransformationFilter, ClassNullRNG, BitBucket, RDSEED, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, HMAC< T >, RDRAND, CRC32, GCM_Base, Adler32, EAX_Base, CCM_Base, SHA3, and VMAC_Base.

Definition at line 488 of file cryptlib.h.

Referenced by VariableRounds< 6, 2 >::StaticGetDefaultRounds().

virtual Clonable* Clonable::Clone ( ) const
inlinevirtualinherited

Copies this object.

Returns
a copy of this object
Exceptions
NotImplemented
Note
this is not implemented by most classes
See also
NotCopyable

Definition at line 464 of file cryptlib.h.


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