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

#include <eccrypto.h>

Inheritance diagram for DL_PrivateKey_ECGDSA_ISO15946< EC >:

Collaboration diagram for DL_PrivateKey_ECGDSA_ISO15946< 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
virtual	~DL_PrivateKey_ECGDSA_ISO15946 ()

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_ISO15946< 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 More...

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

Public Member Functions inherited from DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >
virtual	~DL_PrivateKeyImpl ()

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

void	SetPrivateExponent (const Integer &x)

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

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

Public Member Functions inherited from DL_PrivateKey< DL_GroupParameters_EC< EC >::Element >
virtual	~DL_PrivateKey ()

void	MakePublicKey (DL_PublicKey< DL_GroupParameters_EC< EC >::Element > &pub) const

bool	GetVoidValue (const char name, const std::type_info &valueType, void pValue) const

void	AssignFrom (const NameValuePairs &source)

Public Member Functions inherited from DL_Key< DL_GroupParameters_EC< EC >::Element >
virtual	~DL_Key ()

Public Member Functions inherited from DL_KeyImpl< PKCS8PrivateKey, DL_GroupParameters_EC< EC > >
virtual	~DL_KeyImpl ()

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
virtual	~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 More...

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	~ASN1Object ()

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

Public Member Functions inherited from GeneratableCryptoMaterial
virtual	~GeneratableCryptoMaterial ()

void	GenerateRandomWithKeySize (RandomNumberGenerator &rng, unsigned int keySize)
	Generate a random key or crypto parameters. More...

Public Member Functions inherited from CryptoMaterial
virtual	~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
virtual	~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...

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

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

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

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

CRYPTOPP_DLL 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 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. More...

Protected Attributes inherited from PKCS8PrivateKey
ByteQueue	m_optionalAttributes

Detailed Description

template<class EC>
class DL_PrivateKey_ECGDSA_ISO15946< EC >

Elliptic Curve German DSA key for ISO/IEC 15946.

Template Parameters

EC	elliptic curve field

See also: ECGDSA_ISO15946

Since: Crypto++ 5.7

Definition at line 411 of file eccrypto.h.

Member Typedef Documentation

template<class EC>

typedef EC::Point DL_PrivateKey_ECGDSA_ISO15946< EC >::Element

Definition at line 422 of file eccrypto.h.

Constructor & Destructor Documentation

template<class EC>

virtual DL_PrivateKey_ECGDSA_ISO15946< EC >::~DL_PrivateKey_ECGDSA_ISO15946 ( )

inlinevirtual

Definition at line 424 of file eccrypto.h.

Member Function Documentation

template<class EC>

virtual void DL_PrivateKey_ECGDSA_ISO15946< 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 476 of file eccrypto.h.

template<class EC >

void DL_PrivateKey_ECGDSA_ISO15946< EC >::BERDecodePrivateKey	(	BufferedTransformation &	bt,
		bool	parametersPresent,
		size_t	size
	)

virtual

decode privateKey part of privateKeyInfo, without the OCTET STRING header

Implements PKCS8PrivateKey.

Definition at line 740 of file eccrypto.cpp.

Here is the call graph for this function:

template<class EC >

void DL_PrivateKey_ECGDSA_ISO15946< EC >::DEREncodePrivateKey ( BufferedTransformation & bt ) const

virtual

encode privateKey part of privateKeyInfo, without the OCTET STRING header

Implements PKCS8PrivateKey.

Definition at line 779 of file eccrypto.cpp.

template<class EC>

virtual bool DL_PrivateKey_ECGDSA_ISO15946< 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 470 of file eccrypto.h.

template<class EC>

void DL_PrivateKey_ECGDSA_ISO15946< 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 430 of file eccrypto.h.

Here is the call graph for this function:

template<class EC>

void DL_PrivateKey_ECGDSA_ISO15946< 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 439 of file eccrypto.h.

Here is the call graph for this function:

template<class EC>

void DL_PrivateKey_ECGDSA_ISO15946< 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 448 of file eccrypto.h.

template<class EC>

void DL_PrivateKey_ECGDSA_ISO15946< 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 459 of file eccrypto.h.

template<class EC>

virtual void DL_PrivateKey_ECGDSA_ISO15946< EC >::MakePublicKey ( DL_PublicKey_ECGDSA_ISO15946< EC > & pub ) const

inlinevirtual

Definition at line 462 of file eccrypto.h.

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/cryptopp/eccrypto.h
src/cryptopp/eccrypto.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class EC> class DL_PrivateKey_ECGDSA_ISO15946< EC >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class EC>
class DL_PrivateKey_ECGDSA_ISO15946< EC >