Security Scol plugin
Public Member Functions | List of all members
DL_PrivateKey_GFP< GP > Class Template Reference

Discrete Log (DL) private key in GF(p) groups. More...

#include <gfpcrypt.h>

Inheritance diagram for DL_PrivateKey_GFP< GP >:
DL_PrivateKeyImpl< GP > DL_PrivateKey< GP::Element > DL_KeyImpl< PKCS8PrivateKey, GP > DL_Key< T > PKCS8PrivateKey ASN1CryptoMaterial< PrivateKey > ASN1Object PrivateKey GeneratableCryptoMaterial CryptoMaterial NameValuePairs

Public Member Functions

void Initialize (RandomNumberGenerator &rng, unsigned int modulusBits)
 Create a private key.
 
void Initialize (RandomNumberGenerator &rng, const Integer &p, const Integer &g)
 Create a private key.
 
void Initialize (RandomNumberGenerator &rng, const Integer &p, const Integer &q, const Integer &g)
 Create a private key.
 
void Initialize (const DL_GroupParameters_IntegerBased &params, const Integer &x)
 Initialize a private key over GF(p)
 
void Initialize (const Integer &p, const Integer &g, const Integer &x)
 Initialize a private key over GF(p)
 
void Initialize (const Integer &p, const Integer &q, const Integer &g, const Integer &x)
 Initialize a private key over GF(p)
 
- Public Member Functions inherited from DL_PrivateKeyImpl< GP >
bool Validate (RandomNumberGenerator &rng, unsigned int level) const
 Check this object for errors.
 
bool GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const
 Get a named value.
 
void AssignFrom (const NameValuePairs &source)
 Assign values to this object.
 
void GenerateRandom (RandomNumberGenerator &rng, const NameValuePairs &params)
 Generate a random key or crypto parameters.
 
bool SupportsPrecomputation () const
 Determines whether the object supports precomputation.
 
void Precompute (unsigned int precomputationStorage=16)
 Perform precomputation.
 
void LoadPrecomputation (BufferedTransformation &storedPrecomputation)
 Retrieve previously saved precomputation.
 
void SavePrecomputation (BufferedTransformation &storedPrecomputation) const
 Save precomputation for later use.
 
const DL_GroupParameters< Element > & GetAbstractGroupParameters () const
 Retrieves abstract group parameters.
 
DL_GroupParameters< Element > & AccessAbstractGroupParameters ()
 Retrieves abstract group parameters.
 
const IntegerGetPrivateExponent () const
 Retrieves the private exponent.
 
void SetPrivateExponent (const Integer &x)
 Sets the private exponent.
 
void BERDecodePrivateKey (BufferedTransformation &bt, bool, size_t)
 Decode privateKey part of privateKeyInfo.
 
void DEREncodePrivateKey (BufferedTransformation &bt) const
 Encode privateKey part of privateKeyInfo.
 
- Public Member Functions inherited from DL_PrivateKey< GP::Element >
void MakePublicKey (DL_PublicKey< GP::Element > &pub) const
 Initializes a public key from this key.
 
bool GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const
 Get a named value.
 
void AssignFrom (const NameValuePairs &source)
 Initialize or reinitialize this key.
 
- Public Member Functions inherited from DL_KeyImpl< PKCS8PrivateKey, GP >
OID GetAlgorithmID () const
 
bool BERDecodeAlgorithmParameters (BufferedTransformation &bt)
 
bool DEREncodeAlgorithmParameters (BufferedTransformation &bt) const
 
const GP & GetGroupParameters () const
 
GP & AccessGroupParameters ()
 
- Public Member Functions inherited from PKCS8PrivateKey
void BERDecode (BufferedTransformation &bt)
 Decode this object from a BufferedTransformation.
 
void DEREncode (BufferedTransformation &bt) const
 Encode this object into a BufferedTransformation.
 
virtual void BERDecodeOptionalAttributes (BufferedTransformation &bt)
 Decode optional attributes.
 
virtual void DEREncodeOptionalAttributes (BufferedTransformation &bt) const
 Encode optional attributes.
 
- Public Member Functions inherited from ASN1CryptoMaterial< PrivateKey >
void Save (BufferedTransformation &bt) const
 DER encode ASN.1 object.
 
void Load (BufferedTransformation &bt)
 BER decode ASN.1 object.
 
- Public Member Functions inherited from ASN1Object
virtual void BEREncode (BufferedTransformation &bt) const
 Encode this object into a BufferedTransformation.
 
- Public Member Functions inherited from GeneratableCryptoMaterial
void GenerateRandomWithKeySize (RandomNumberGenerator &rng, unsigned int keySize)
 Generate a random key or crypto parameters.
 
- Public Member Functions inherited from CryptoMaterial
virtual void ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const
 Check this object for errors.
 
void DoQuickSanityCheck () const
 Perform a quick sanity check.
 
- Public Member Functions inherited from NameValuePairs
template<class T >
bool GetThisObject (T &object) const
 Get a copy of this object or subobject.
 
template<class T >
bool GetThisPointer (T *&ptr) const
 Get a pointer to this object.
 
template<class T >
bool GetValue (const char *name, T &value) const
 Get a named value.
 
template<class T >
GetValueWithDefault (const char *name, T defaultValue) const
 Get a named value.
 
CRYPTOPP_DLL std::string GetValueNames () const
 Get a list of value names that can be retrieved.
 
CRYPTOPP_DLL bool GetIntValue (const char *name, int &value) const
 Get a named value with type int.
 
CRYPTOPP_DLL int GetIntValueWithDefault (const char *name, int defaultValue) const
 Get a named value with type int, with default.
 
CRYPTOPP_DLL bool GetWord64Value (const char *name, word64 &value) const
 Get a named value with type word64.
 
CRYPTOPP_DLL word64 GetWord64ValueWithDefault (const char *name, word64 defaultValue) const
 Get a named value with type word64, with default.
 
template<class T >
void GetRequiredParameter (const char *className, const char *name, T &value) const
 Retrieves a required name/value pair.
 
CRYPTOPP_DLL void GetRequiredIntParameter (const char *className, const char *name, int &value) const
 Retrieves a required name/value pair.
 

Additional Inherited Members

- Public Types inherited from DL_PrivateKeyImpl< GP >
typedef GP::Element Element
 
- Public Types inherited from DL_PrivateKey< GP::Element >
typedef GP::Element Element
 
- Public Types inherited from DL_KeyImpl< PKCS8PrivateKey, GP >
typedef GP GroupParameters
 
- Static Public Member Functions inherited from NameValuePairs
static CRYPTOPP_DLL void CRYPTOPP_API ThrowIfTypeMismatch (const char *name, const std::type_info &stored, const std::type_info &retrieving)
 Ensures an expected name and type is present.
 
- Protected Attributes inherited from PKCS8PrivateKey
ByteQueue m_optionalAttributes
 

Detailed Description

template<class GP>
class DL_PrivateKey_GFP< GP >

Discrete Log (DL) private key in GF(p) groups.

Template Parameters
GPGroupParameters derived class

Definition at line 613 of file gfpcrypt.h.

Constructor & Destructor Documentation

◆ ~DL_PrivateKey_GFP()

template<class GP >
DL_PrivateKey_GFP< GP >::~DL_PrivateKey_GFP ( )
virtual

Definition at line 672 of file gfpcrypt.h.

Member Function Documentation

◆ Initialize() [1/6]

template<class GP >
void DL_PrivateKey_GFP< GP >::Initialize ( const DL_GroupParameters_IntegerBased params,
const Integer x 
)
inline

Initialize a private key over GF(p)

Parameters
paramsthe group parameters
xthe private exponent

Definition at line 651 of file gfpcrypt.h.

◆ Initialize() [2/6]

template<class GP >
void DL_PrivateKey_GFP< GP >::Initialize ( const Integer p,
const Integer g,
const Integer x 
)
inline

Initialize a private key over GF(p)

Parameters
pthe modulus
gthe generator
xthe private exponent

Definition at line 658 of file gfpcrypt.h.

◆ Initialize() [3/6]

template<class GP >
void DL_PrivateKey_GFP< GP >::Initialize ( const Integer p,
const Integer q,
const Integer g,
const Integer x 
)
inline

Initialize a private key over GF(p)

Parameters
pthe modulus
qthe subgroup order
gthe generator
xthe private exponent

Definition at line 666 of file gfpcrypt.h.

◆ Initialize() [4/6]

template<class GP >
void DL_PrivateKey_GFP< GP >::Initialize ( RandomNumberGenerator rng,
const Integer p,
const Integer g 
)
inline

Create a private key.

Parameters
rnga RandomNumberGenerator derived class
pthe modulus
gthe generator

This function overload of Initialize() creates a new private key because it takes a RandomNumberGenerator() as a parameter. If you have an existing keypair, then use one of the other Initialize() overloads.

Definition at line 634 of file gfpcrypt.h.

◆ Initialize() [5/6]

template<class GP >
void DL_PrivateKey_GFP< GP >::Initialize ( RandomNumberGenerator rng,
const Integer p,
const Integer q,
const Integer g 
)
inline

Create a private key.

Parameters
rnga RandomNumberGenerator derived class
pthe modulus
qthe subgroup order
gthe generator

This function overload of Initialize() creates a new private key because it takes a RandomNumberGenerator() as a parameter. If you have an existing keypair, then use one of the other Initialize() overloads.

Definition at line 645 of file gfpcrypt.h.

◆ Initialize() [6/6]

template<class GP >
void DL_PrivateKey_GFP< GP >::Initialize ( RandomNumberGenerator rng,
unsigned int  modulusBits 
)
inline

Create a private key.

Parameters
rnga RandomNumberGenerator derived class
modulusBitsthe size of the modulus, in bits

This function overload of Initialize() creates a new private key because it takes a RandomNumberGenerator() as a parameter. If you have an existing keypair, then use one of the other Initialize() overloads.

Definition at line 624 of file gfpcrypt.h.


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