Elliptic Curve German DSA key for ISO/IEC 15946. More...

Inheritance diagram for DL_PrivateKey_ECGDSA< EC >:

Public Types
typedef EC::Point	Element

Public Types inherited from DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >
typedef DL_GroupParameters_EC< EC > ::Element	Element

Public Types inherited from DL_PrivateKey< DL_GroupParameters_EC< EC > ::Element >
typedef DL_GroupParameters_EC< EC > ::Element	Element

Public Types inherited from DL_KeyImpl< PKCS8PrivateKey, DL_GroupParameters_EC< EC > >
typedef DL_GroupParameters_EC< EC >	GroupParameters

Public Member Functions
void	Initialize (const DL_GroupParameters_EC< EC > &params, const Integer &x)
	Initialize an EC Private Key using {GP,x}. More...

void	Initialize (const EC &ec, const Element &G, const Integer &n, const Integer &x)
	Initialize an EC Private Key using {EC,G,n,x}. More...

void	Initialize (RandomNumberGenerator &rng, const DL_GroupParameters_EC< EC > &params)
	Create an EC private key. More...

void	Initialize (RandomNumberGenerator &rng, const EC &ec, const Element &G, const Integer &n)
	Create an EC private key. More...

virtual void	MakePublicKey (DL_PublicKey_ECGDSA< EC > &pub) const

virtual bool	GetVoidValue (const char name, const std::type_info &valueType, void pValue) const
	Get a named value. More...

virtual void	AssignFrom (const NameValuePairs &source)
	Assign values to this object. More...

void	BERDecodePrivateKey (BufferedTransformation &bt, bool parametersPresent, size_t size)
	decode privateKey part of privateKeyInfo, without the OCTET STRING header

void	DEREncodePrivateKey (BufferedTransformation &bt) const
	encode privateKey part of privateKeyInfo, without the OCTET STRING header

Public Member Functions inherited from DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >
bool	Validate (RandomNumberGenerator &rng, unsigned int level) const
	Check this object for errors. More...

bool	GetVoidValue (const char name, const std::type_info &valueType, void pValue) const
	Get a named value. More...

void	AssignFrom (const NameValuePairs &source)
	Assign values to this object. More...

void	GenerateRandom (RandomNumberGenerator &rng, const NameValuePairs &params)
	Generate a random key or crypto parameters. More...

bool	SupportsPrecomputation () const
	Determines whether the object supports precomputation. More...

void	Precompute (unsigned int precomputationStorage=16)
	Perform precomputation. More...

void	LoadPrecomputation (BufferedTransformation &storedPrecomputation)
	Retrieve previously saved precomputation. More...

void	SavePrecomputation (BufferedTransformation &storedPrecomputation) const
	Save precomputation for later use. More...

const DL_GroupParameters< Element > &	GetAbstractGroupParameters () const
	Retrieves abstract group parameters. More...

DL_GroupParameters< Element > &	AccessAbstractGroupParameters ()
	Retrieves abstract group parameters. More...

const Integer &	GetPrivateExponent () const
	Retrieves the private exponent. More...

void	SetPrivateExponent (const Integer &x)
	Sets the private exponent. More...

void	BERDecodePrivateKey (BufferedTransformation &bt, bool, size_t)
	decode privateKey part of privateKeyInfo, without the OCTET STRING header

void	DEREncodePrivateKey (BufferedTransformation &bt) const
	encode privateKey part of privateKeyInfo, without the OCTET STRING header

Public Member Functions inherited from DL_PrivateKey< DL_GroupParameters_EC< EC > ::Element >
void	MakePublicKey (DL_PublicKey< DL_GroupParameters_EC< EC > ::Element > &pub) const
	Initializes a public key from this key. More...

bool	GetVoidValue (const char name, const std::type_info &valueType, void pValue) const
	Get a named value. More...

void	AssignFrom (const NameValuePairs &source)
	Initialize or reinitialize this key. More...

Public Member Functions inherited from DL_KeyImpl< PKCS8PrivateKey, DL_GroupParameters_EC< EC > >
OID	GetAlgorithmID () const

bool	BERDecodeAlgorithmParameters (BufferedTransformation &bt)

bool	DEREncodeAlgorithmParameters (BufferedTransformation &bt) const

const DL_GroupParameters_EC< EC > &	GetGroupParameters () const

DL_GroupParameters_EC< EC > &	AccessGroupParameters ()

Public Member Functions inherited from PKCS8PrivateKey
void	BERDecode (BufferedTransformation &bt)
	Decode this object from a BufferedTransformation. More...

void	DEREncode (BufferedTransformation &bt) const
	Encode this object into a BufferedTransformation. More...

virtual void	BERDecodeOptionalAttributes (BufferedTransformation &bt)
	decode optional attributes including context-specific tag More...

virtual void	DEREncodeOptionalAttributes (BufferedTransformation &bt) const
	encode optional attributes including context-specific tag

Public Member Functions inherited from ASN1CryptoMaterial< PrivateKey >
void	Save (BufferedTransformation &bt) const
	DER encode ASN.1 object. More...

void	Load (BufferedTransformation &bt)
	BER decode ASN.1 object. More...

Public Member Functions inherited from ASN1Object
virtual void	BEREncode (BufferedTransformation &bt) const
	Encode this object into a BufferedTransformation. More...

Public Member Functions inherited from GeneratableCryptoMaterial
void	GenerateRandomWithKeySize (RandomNumberGenerator &rng, unsigned int keySize)
	Generate a random key or crypto parameters. More...

Public Member Functions inherited from CryptoMaterial
virtual void	ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const
	Check this object for errors. More...

void	DoQuickSanityCheck () const
	Perform a quick sanity check. More...

Public Member Functions inherited from NameValuePairs
template<class T >
bool	GetThisObject (T &object) const
	Get a copy of this object or subobject. More...

template<class T >
bool	GetThisPointer (T *&ptr) const
	Get a pointer to this object. More...

template<class T >
bool	GetValue (const char *name, T &value) const
	Get a named value. More...

template<class T >
T	GetValueWithDefault (const char *name, T defaultValue) const
	Get a named value. More...

std::string	GetValueNames () const
	Get a list of value names that can be retrieved. More...

bool	GetIntValue (const char *name, int &value) const
	Get a named value with type int. More...

int	GetIntValueWithDefault (const char *name, int defaultValue) const
	Get a named value with type int, with default. More...

bool	GetWord64Value (const char *name, word64 &value) const
	Get a named value with type word64. More...

word64	GetWord64ValueWithDefault (const char *name, word64 defaultValue) const
	Get a named value with type word64, with default. More...

template<class T >
void	GetRequiredParameter (const char className, const char name, T &value) const
	Retrieves a required name/value pair. More...

void	GetRequiredIntParameter (const char className, const char name, int &value) const
	Retrieves a required name/value pair. More...

Additional Inherited Members
Static Public Member Functions inherited from NameValuePairs
static void	ThrowIfTypeMismatch (const char *name, const std::type_info &stored, const std::type_info &retrieving)
	Ensures an expected name and type is present. More...

Detailed Description

template<class EC>
class DL_PrivateKey_ECGDSA< EC >

Elliptic Curve German DSA key for ISO/IEC 15946.

Template Parameters

EC	elliptic curve field

See also: ECGDSA

Since: Crypto++ 6.0

Definition at line 407 of file eccrypto.h.

Member Function Documentation

◆ Initialize() [1/4]

template<class EC>

void DL_PrivateKey_ECGDSA< EC >::Initialize	(	const DL_GroupParameters_EC< EC > &	params,
		const Integer &	x
	)

inline

Initialize an EC Private Key using {GP,x}.

Parameters

params	group parameters
x	the private exponent

This Initialize() function overload initializes a private key from existing parameters.

Definition at line 425 of file eccrypto.h.

◆ Initialize() [2/4]

template<class EC>

void DL_PrivateKey_ECGDSA< EC >::Initialize	(	const EC &	ec,
		const Element &	G,
		const Integer &	n,
		const Integer &	x
	)

inline

Initialize an EC Private Key using {EC,G,n,x}.

Parameters

ec	the elliptic curve
G	the base point
n	the order of the base point
x	the private exponent

This Initialize() function overload initializes a private key from existing parameters.

Definition at line 438 of file eccrypto.h.

◆ Initialize() [3/4]

template<class EC>

void DL_PrivateKey_ECGDSA< EC >::Initialize	(	RandomNumberGenerator &	rng,
		const DL_GroupParameters_EC< EC > &	params
	)

inline

Create an EC private key.

Parameters

rng	a RandomNumberGenerator derived class
params	the EC group parameters

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 451 of file eccrypto.h.

◆ Initialize() [4/4]

template<class EC>

void DL_PrivateKey_ECGDSA< EC >::Initialize	(	RandomNumberGenerator &	rng,
		const EC &	ec,
		const Element &	G,
		const Integer &	n
	)

inline

Create an EC private key.

Parameters

rng	a RandomNumberGenerator derived class
ec	the elliptic curve
G	the base point
n	the order of the base point

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 462 of file eccrypto.h.

◆ GetVoidValue()

template<class EC>

virtual bool DL_PrivateKey_ECGDSA< EC >::GetVoidValue	(	const char *	name,
		const std::type_info &	valueType,
		void *	pValue
	)		const

inlinevirtual

Get a named value.

Parameters

name	the name of the object or value to retrieve
valueType	reference to a variable that receives the value
pValue	void pointer to a variable that receives the value

Returns: true if the value was retrieved, false otherwise

GetVoidValue() retrieves the value of name if it exists.

Note: GetVoidValue() is an internal function and should be implemented by derived classes. Users should use one of the other functions instead.

See also: GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()

Implements NameValuePairs.

Definition at line 474 of file eccrypto.h.

◆ AssignFrom()

template<class EC>

virtual void DL_PrivateKey_ECGDSA< EC >::AssignFrom ( const NameValuePairs & source )

inlinevirtual

Assign values to this object.

This function can be used to create a public key from a private key.

Implements CryptoMaterial.

Definition at line 480 of file eccrypto.h.

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class EC> class DL_PrivateKey_ECGDSA< EC >

Member Function Documentation

◆ Initialize() [1/4]

◆ Initialize() [2/4]

◆ Initialize() [3/4]

◆ Initialize() [4/4]

◆ GetVoidValue()

◆ AssignFrom()

template<class EC>
class DL_PrivateKey_ECGDSA< EC >