#include <pubkey.h>

Inheritance diagram for DL_PrivateKeyImpl< GP >:

Collaboration diagram for DL_PrivateKeyImpl< GP >:

Public Types
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

Public Member Functions
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< GP::Element >
virtual	~DL_PrivateKey ()

void	MakePublicKey (DL_PublicKey< GP::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< GP::Element >
virtual	~DL_Key ()

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

OID	GetAlgorithmID () const

bool	BERDecodeAlgorithmParameters (BufferedTransformation &bt)

bool	DEREncodeAlgorithmParameters (BufferedTransformation &bt) const

const GP &	GetGroupParameters () const

GP &	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...

Private Attributes
Integer	m_x

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 GP>
class DL_PrivateKeyImpl< GP >

_

Definition at line 1104 of file pubkey.h.

Member Typedef Documentation

template<class GP>

typedef GP::Element DL_PrivateKeyImpl< GP >::Element

Definition at line 1107 of file pubkey.h.

Constructor & Destructor Documentation

template<class GP>

virtual DL_PrivateKeyImpl< GP >::~DL_PrivateKeyImpl ( )

inlinevirtual

Definition at line 1109 of file pubkey.h.

Member Function Documentation

template<class GP>

DL_GroupParameters<Element>& DL_PrivateKeyImpl< GP >::AccessAbstractGroupParameters ( )

inlinevirtual

Retrieves abstract group parameters.

Returns: a non-const reference to the group parameters

Implements DL_Key< GP::Element >.

Definition at line 1156 of file pubkey.h.

template<class GP>

void DL_PrivateKeyImpl< GP >::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 1130 of file pubkey.h.

template<class GP>

void DL_PrivateKeyImpl< GP >::BERDecodePrivateKey	(	BufferedTransformation &	bt,
		bool	parametersPresent,
		size_t	size
	)

inlinevirtual

decode privateKey part of privateKeyInfo, without the OCTET STRING header

Implements PKCS8PrivateKey.

Definition at line 1163 of file pubkey.h.

template<class GP>

void DL_PrivateKeyImpl< GP >::DEREncodePrivateKey ( BufferedTransformation & bt ) const

inlinevirtual

encode privateKey part of privateKeyInfo, without the OCTET STRING header

Implements PKCS8PrivateKey.

Definition at line 1165 of file pubkey.h.

template<class GP>

void DL_PrivateKeyImpl< GP >::GenerateRandom	(	RandomNumberGenerator &	rng,
		const NameValuePairs &	params
	)

inlinevirtual

Generate a random key or crypto parameters.

Parameters

rng	a RandomNumberGenerator to produce keying material
params	additional initialization parameters

Exceptions

KeyingErr if a key can't be generated or algorithm parameters are invalid

If a derived class does not override GenerateRandom, then the base class throws NotImplemented.

Reimplemented from GeneratableCryptoMaterial.

Definition at line 1135 of file pubkey.h.

template<class GP>

const DL_GroupParameters<Element>& DL_PrivateKeyImpl< GP >::GetAbstractGroupParameters ( ) const

inlinevirtual

Retrieves abstract group parameters.

Returns: a const reference to the group parameters

Implements DL_Key< GP::Element >.

Definition at line 1155 of file pubkey.h.

template<class GP>

const Integer& DL_PrivateKeyImpl< GP >::GetPrivateExponent ( ) const

inlinevirtual

Implements DL_PrivateKey< GP::Element >.

Definition at line 1159 of file pubkey.h.

template<class GP>

bool DL_PrivateKeyImpl< GP >::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 1125 of file pubkey.h.

template<class GP>

void DL_PrivateKeyImpl< GP >::LoadPrecomputation ( BufferedTransformation & storedPrecomputation )

inlinevirtual

Retrieve previously saved precomputation.

Parameters

storedPrecomputation BufferedTransformation with the saved precomputation

Exceptions

NotImplemented

See also: SupportsPrecomputation(), Precompute()

Reimplemented from CryptoMaterial.

Definition at line 1148 of file pubkey.h.

template<class GP>

void DL_PrivateKeyImpl< GP >::Precompute ( unsigned int precomputationStorage = 16 )

inlinevirtual

Perform precomputation.

Parameters

precomputationStorage the suggested number of objects for the precompute table

Exceptions

NotImplemented

The exact semantics of Precompute() varies, but it typically means calculate a table of n objects that can be used later to speed up computation.

If a derived class does not override Precompute(), then the base class throws NotImplemented.

See also: SupportsPrecomputation(), LoadPrecomputation(), SavePrecomputation()

Reimplemented from CryptoMaterial.

Definition at line 1145 of file pubkey.h.

template<class GP>

void DL_PrivateKeyImpl< GP >::SavePrecomputation ( BufferedTransformation & storedPrecomputation ) const

inlinevirtual

Save precomputation for later use.

Parameters

storedPrecomputation BufferedTransformation to write the precomputation

Exceptions

NotImplemented

See also: SupportsPrecomputation(), Precompute()

Reimplemented from CryptoMaterial.

Definition at line 1151 of file pubkey.h.

template<class GP>

void DL_PrivateKeyImpl< GP >::SetPrivateExponent ( const Integer & x )

inlinevirtual

Implements DL_PrivateKey< GP::Element >.

Definition at line 1160 of file pubkey.h.

template<class GP>

bool DL_PrivateKeyImpl< GP >::SupportsPrecomputation ( ) const

inlinevirtual

Determines whether the object supports precomputation.

Returns: true if the object supports precomputation, false otherwise

See also: Precompute()

Reimplemented from CryptoMaterial.

Definition at line 1143 of file pubkey.h.

template<class GP>

bool DL_PrivateKeyImpl< GP >::Validate	(	RandomNumberGenerator &	rng,
		unsigned int	level
	)		const

inlinevirtual

Check this object for errors.

Parameters

rng	a RandomNumberGenerator for objects which use randomized testing
level	the level of thoroughness

Returns: true if the tests succeed, false otherwise

There are four levels of thoroughness:

0 - using this object won't cause a crash or exception
1 - this object will probably function, and encrypt, sign, other operations correctly
2 - ensure this object will function correctly, and perform reasonable security checks
3 - perform reasonable security checks, and do checks that may take a long time

Level 0 does not require a RandomNumberGenerator. A NullRNG() can be used for level 0. Level 1 may not check for weak keys and such. Levels 2 and 3 are recommended.