Interface for domains of simple key agreement protocols. More...
Inheritance diagram for SimpleKeyAgreementDomain:
Public Member Functions | |
| virtual unsigned int | AgreedValueLength () const =0 |
| Provides the size of the agreed value. More... | |
| virtual unsigned int | PrivateKeyLength () const =0 |
| Provides the size of the private key. More... | |
| virtual unsigned int | PublicKeyLength () const =0 |
| Provides the size of the public key. More... | |
| virtual void | GeneratePrivateKey (RandomNumberGenerator &rng, byte *privateKey) const =0 |
| Generate private key in this domain. More... | |
| virtual void | GeneratePublicKey (RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const =0 |
| Generate a public key from a private key in this domain. More... | |
| virtual void | GenerateKeyPair (RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const |
| Generate a private/public key pair. More... | |
| virtual bool | Agree (byte *agreedValue, const byte *privateKey, const byte *otherPublicKey, bool validateOtherPublicKey=true) const =0 |
| Derive agreed value. 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 CryptoParameters & | AccessCryptoParameters ()=0 |
| 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
Interface for domains of simple key agreement protocols.
A key agreement domain is a set of parameters that must be shared by two parties in a key agreement protocol, along with the algorithms for generating key pairs and deriving agreed values.
- Since
- Crypto++ 3.0
Definition at line 2995 of file cryptlib.h.
Member Function Documentation
◆ AgreedValueLength()
|
pure virtual |
Provides the size of the agreed value.
- Returns
- size of agreed value produced in this domain
Implemented in XTR_DH, x25519, and DL_SimpleKeyAgreementDomainBase< T >.
◆ PrivateKeyLength()
|
pure virtual |
Provides the size of the private key.
- Returns
- size of private keys in this domain
Implemented in XTR_DH, x25519, and DL_SimpleKeyAgreementDomainBase< T >.
◆ PublicKeyLength()
|
pure virtual |
Provides the size of the public key.
- Returns
- size of public keys in this domain
Implemented in XTR_DH, x25519, and DL_SimpleKeyAgreementDomainBase< T >.
◆ GeneratePrivateKey()
|
pure virtual |
Generate private key in this domain.
- Parameters
-
rng a RandomNumberGenerator derived class privateKey a byte buffer for the generated private key in this domain
- Precondition
COUNTOF(privateKey) == PrivateKeyLength()
Implemented in XTR_DH, x25519, DL_SimpleKeyAgreementDomainBase< T >, and DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element >.
◆ GeneratePublicKey()
|
pure virtual |
Generate a public key from a private key in this domain.
- Parameters
-
rng a RandomNumberGenerator derived class privateKey a byte buffer with the previously generated private key publicKey a byte buffer for the generated public key in this domain
- Precondition
COUNTOF(publicKey) == PublicKeyLength()
Implemented in XTR_DH, x25519, DL_SimpleKeyAgreementDomainBase< T >, DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element >, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, and DH_Domain< DL_GroupParameters_GFP_DefaultSafePrime >.
◆ GenerateKeyPair()
|
virtual |
Generate a private/public key pair.
- Parameters
-
rng a RandomNumberGenerator derived class privateKey a byte buffer for the generated private key in this domain publicKey a byte buffer for the generated public key in this domain GenerateKeyPair() is equivalent to calling GeneratePrivateKey() and then GeneratePublicKey().
- Precondition
COUNTOF(privateKey) == PrivateKeyLength()-
COUNTOF(publicKey) == PublicKeyLength()
◆ Agree()
|
pure virtual |
Derive agreed value.
- Parameters
-
agreedValue a byte buffer for the shared secret privateKey a byte buffer with your private key in this domain otherPublicKey a byte buffer with the other party's public key in this domain validateOtherPublicKey a flag indicating if the other party's public key should be validated
- Returns
- true upon success, false in case of failure Agree() derives an agreed value from your private keys and couterparty's public keys. The other party's public key is validated by default. If you have previously validated the static public key, use
validateStaticOtherPublicKey=falseto save time.
- Precondition
COUNTOF(agreedValue) == AgreedValueLength()-
COUNTOF(privateKey) == PrivateKeyLength() -
COUNTOF(otherPublicKey) == PublicKeyLength()
Implemented in XTR_DH, x25519, DL_SimpleKeyAgreementDomainBase< T >, and DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element >.
The documentation for this class was generated from the following file:
