Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Types | Public Member Functions | Static Public Member Functions | List of all members
DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION > Class Template Reference

, More...

+ Inheritance diagram for DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >:

Public Types

typedef GROUP_PARAMETERS GroupParameters
 
typedef GroupParameters::Element Element
 
typedef DL_KeyAgreementAlgorithm_DH< Element, COFACTOR_OPTION > DH_Algorithm
 
typedef DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION > Domain
 

Public Member Functions

 DH_Domain (const GroupParameters &params)
 
 DH_Domain (BufferedTransformation &bt)
 
template<class T2 >
 DH_Domain (RandomNumberGenerator &v1, const T2 &v2)
 
template<class T2 , class T3 >
 DH_Domain (RandomNumberGenerator &v1, const T2 &v2, const T3 &v3)
 
template<class T2 , class T3 , class T4 >
 DH_Domain (RandomNumberGenerator &v1, const T2 &v2, const T3 &v3, const T4 &v4)
 
template<class T1 , class T2 >
 DH_Domain (const T1 &v1, const T2 &v2)
 
template<class T1 , class T2 , class T3 >
 DH_Domain (const T1 &v1, const T2 &v2, const T3 &v3)
 
template<class T1 , class T2 , class T3 , class T4 >
 DH_Domain (const T1 &v1, const T2 &v2, const T3 &v3, const T4 &v4)
 
const GroupParameters & GetGroupParameters () const
 
GroupParameters & AccessGroupParameters ()
 
void GeneratePublicKey (RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const
 generate public key More...
 
std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
CryptoParametersAccessCryptoParameters ()
 
unsigned int AgreedValueLength () const
 return length of agreed value produced
 
unsigned int PrivateKeyLength () const
 return length of private keys in this domain
 
unsigned int PublicKeyLength () const
 return length of public keys in this domain
 
void GeneratePrivateKey (RandomNumberGenerator &rng, byte *privateKey) const
 generate private key More...
 
bool Agree (byte *agreedValue, const byte *privateKey, const byte *otherPublicKey, bool validateOtherPublicKey=true) const
 derive agreed value from your private key and couterparty's public key, return false in case of failure More...
 
const Element & GetGenerator () const
 
virtual void GenerateKeyPair (RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const
 generate private/public key pair 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 ClonableClone () const
 Copies this object. More...
 

Static Public Member Functions

static std::string StaticAlgorithmName ()
 

Detailed Description

template<class GROUP_PARAMETERS, class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption>
class DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >

,

Definition at line 17 of file dh.h.

Member Function Documentation

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption>
void DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >::GeneratePublicKey ( RandomNumberGenerator rng,
const byte *  privateKey,
byte *  publicKey 
) const
inlinevirtual

generate public key

re size of publicKey == PublicKeyLength()

Implements SimpleKeyAgreementDomain.

Definition at line 62 of file dh.h.

References FIPS_140_2_ComplianceEnabled().

template<class GROUP_PARAMETERS , class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption>
std::string DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >::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.

Note
AlgorithmName is not universally implemented yet

Reimplemented from Algorithm.

Definition at line 85 of file dh.h.

void DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element >::GeneratePrivateKey ( RandomNumberGenerator rng,
byte *  privateKey 
) const
inlinevirtualinherited

generate private key

Precondition
size of privateKey == PrivateKeyLength()

Implements SimpleKeyAgreementDomain.

Definition at line 1659 of file pubkey.h.

References Integer::Encode(), and Integer::One().

bool DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element >::Agree ( byte *  agreedValue,
const byte *  privateKey,
const byte *  otherPublicKey,
bool  validateOtherPublicKey = true 
) const
inlinevirtualinherited

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

Note
If you have previously validated the public key, use validateOtherPublicKey=false to save time. re size of agreedValue == AgreedValueLength() re length of privateKey == PrivateKeyLength() re length of otherPublicKey == PublicKeyLength()

Implements SimpleKeyAgreementDomain.

Definition at line 1674 of file pubkey.h.

void SimpleKeyAgreementDomain::GenerateKeyPair ( RandomNumberGenerator rng,
byte *  privateKey,
byte *  publicKey 
) const
virtualinherited

generate private/public key pair

Note
equivalent to calling GeneratePrivateKey() and then GeneratePublicKey()

Definition at line 921 of file cryptlib.cpp.

Referenced by FixedRNG::GenerateBlock().

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 file: