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

Unified Diffie-Hellman More...

+ Inheritance diagram for DH2:

Public Member Functions

 DH2 (SimpleKeyAgreementDomain &domain)
 
 DH2 (SimpleKeyAgreementDomain &staticDomain, SimpleKeyAgreementDomain &ephemeralDomain)
 
CryptoParametersAccessCryptoParameters ()
 
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...
 
void GenerateStaticKeyPair (RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const
 generate private/public key pair More...
 
unsigned int EphemeralPrivateKeyLength () const
 return length of ephemeral private keys in this domain
 
unsigned int EphemeralPublicKeyLength () const
 return length of ephemeral public keys in this domain
 
void GenerateEphemeralPrivateKey (RandomNumberGenerator &rng, byte *privateKey) const
 generate ephemeral private key More...
 
void GenerateEphemeralPublicKey (RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const
 generate ephemeral public key More...
 
void GenerateEphemeralKeyPair (RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const
 generate private/public key pair 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...
 
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 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

Unified Diffie-Hellman

Definition at line 15 of file dh2.h.

Member Function Documentation

void DH2::GenerateStaticPrivateKey ( RandomNumberGenerator rng,
byte *  privateKey 
) const
inlinevirtual

generate static private key

Precondition
size of privateKey == PrivateStaticKeyLength()

Implements AuthenticatedKeyAgreementDomain.

Definition at line 32 of file dh2.h.

void DH2::GenerateStaticPublicKey ( RandomNumberGenerator rng,
const byte *  privateKey,
byte *  publicKey 
) const
inlinevirtual

generate static public key

re size of publicKey == PublicStaticKeyLength()

Implements AuthenticatedKeyAgreementDomain.

Definition at line 34 of file dh2.h.

void DH2::GenerateStaticKeyPair ( RandomNumberGenerator rng,
byte *  privateKey,
byte *  publicKey 
) const
inlinevirtual

generate private/public key pair

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

Reimplemented from AuthenticatedKeyAgreementDomain.

Definition at line 36 of file dh2.h.

void DH2::GenerateEphemeralPrivateKey ( RandomNumberGenerator rng,
byte *  privateKey 
) const
inlinevirtual

generate ephemeral private key

Precondition
size of privateKey == PrivateEphemeralKeyLength()

Implements AuthenticatedKeyAgreementDomain.

Definition at line 43 of file dh2.h.

void DH2::GenerateEphemeralPublicKey ( RandomNumberGenerator rng,
const byte *  privateKey,
byte *  publicKey 
) const
inlinevirtual

generate ephemeral public key

re size of publicKey == PublicEphemeralKeyLength()

Implements AuthenticatedKeyAgreementDomain.

Definition at line 45 of file dh2.h.

void DH2::GenerateEphemeralKeyPair ( RandomNumberGenerator rng,
byte *  privateKey,
byte *  publicKey 
) const
inlinevirtual

generate private/public key pair

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

Reimplemented from AuthenticatedKeyAgreementDomain.

Definition at line 47 of file dh2.h.

bool DH2::Agree ( byte *  agreedValue,
const byte *  staticPrivateKey,
const byte *  ephemeralPrivateKey,
const byte *  staticOtherPublicKey,
const byte *  ephemeralOtherPublicKey,
bool  validateStaticOtherPublicKey = true 
) const
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()

Implements AuthenticatedKeyAgreementDomain.

Definition at line 15 of file dh2.cpp.

References SimpleKeyAgreementDomain::Agree(), and SimpleKeyAgreementDomain::AgreedValueLength().

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: