DL_PrivateKey_EC< EC > Class Template Reference

#include <eccrypto.h>

Inheritance diagram for DL_PrivateKey_EC< EC >:

DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > > DL_PrivateKey< DL_GroupParameters_EC< EC >::Element > DL_KeyImpl< PKCS8PrivateKey, DL_GroupParameters_EC< EC > > DL_Key< DL_GroupParameters_EC< EC >::Element > PKCS8PrivateKey ASN1CryptoMaterial< PrivateKey > ASN1Object PrivateKey GeneratableCryptoMaterial CryptoMaterial NameValuePairs List of all members.

Detailed Description

template<class EC>
class DL_PrivateKey_EC< EC >

EC private key.

Definition at line 159 of file eccrypto.h.

Public Types

typedef EC::Point Element
typedef DL_GroupParameters_EC<
EC > 
GroupParameters

Public Member Functions

void Initialize (const DL_GroupParameters_EC< EC > &params, const Integer &x)
void Initialize (const EC &ec, const Element &G, const Integer &n, const Integer &x)
void Initialize (RandomNumberGenerator &rng, const DL_GroupParameters_EC< EC > &params)
void Initialize (RandomNumberGenerator &rng, const EC &ec, const Element &G, const Integer &n)
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
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
void AssignFrom (const NameValuePairs &source)
void GenerateRandom (RandomNumberGenerator &rng, const NameValuePairs &params)
 generate a random key or crypto parameters
bool SupportsPrecomputation () const
 
Returns:
whether this object supports precomputation

void Precompute (unsigned int precomputationStorage=16)
 do 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
DL_GroupParameters< Element > & AccessAbstractGroupParameters ()
const IntegerGetPrivateExponent () const
void SetPrivateExponent (const Integer &x)
void MakePublicKey (DL_PublicKey< DL_GroupParameters_EC< EC >::Element > &pub) const
OID GetAlgorithmID () const
bool BERDecodeAlgorithmParameters (BufferedTransformation &bt)
bool DEREncodeAlgorithmParameters (BufferedTransformation &bt) const
const DL_GroupParameters_EC<
EC > & 
GetGroupParameters () const
DL_GroupParameters_EC< EC > & AccessGroupParameters ()
void BERDecode (BufferedTransformation &bt)
 decode this object from a BufferedTransformation, using BER (Basic Encoding Rules)
void DEREncode (BufferedTransformation &bt) const
 encode this object into a BufferedTransformation, using DER (Distinguished Encoding Rules)
virtual void BERDecodeOptionalAttributes (BufferedTransformation &bt)
 decode optional attributes including context-specific tag
virtual void DEREncodeOptionalAttributes (BufferedTransformation &bt) const
 encode optional attributes including context-specific tag
void Save (BufferedTransformation &bt) const
 save key into a BufferedTransformation
void Load (BufferedTransformation &bt)
 load key from a BufferedTransformation
virtual void BEREncode (BufferedTransformation &bt) const
 encode this object into a BufferedTransformation, using BER
void GenerateRandomWithKeySize (RandomNumberGenerator &rng, unsigned int keySize)
 calls the above function with a NameValuePairs object that just specifies "KeySize"
virtual void ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const
 throws InvalidMaterial if this object fails Validate() test
void DoQuickSanityCheck () const
template<class T>
bool GetThisObject (T &object) const
 get a copy of this object or a subobject of it
template<class T>
bool GetThisPointer (T *&p) const
 get a pointer to this object, as a pointer to T
template<class T>
bool GetValue (const char *name, T &value) const
 get a named value, returns true if the name exists
template<class T>
GetValueWithDefault (const char *name, T defaultValue) const
 get a named value, returns the default if the name doesn't exist
std::string GetValueNames () const
 get a list of value names that can be retrieved
bool GetIntValue (const char *name, int &value) const
 get a named value with type int
int GetIntValueWithDefault (const char *name, int defaultValue) const
 get a named value with type int, with default
template<class T>
void GetRequiredParameter (const char *className, const char *name, T &value) const
void GetRequiredIntParameter (const char *className, const char *name, int &value) const

Static Public Member Functions

static void __cdecl ThrowIfTypeMismatch (const char *name, const std::type_info &stored, const std::type_info &retrieving)
 used by derived classes to check for type mismatch

Protected Attributes

ByteQueue m_optionalAttributes


Member Function Documentation

bool DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >::Validate ( RandomNumberGenerator rng,
unsigned int  level 
) const [inline, virtual, inherited]

check this object for errors

Parameters:
level denotes the level of thoroughness: 0 - using this object won't cause a crash or exception (rng is ignored) 1 - this object will probably function (encrypt, sign, etc.) correctly (but may not check for weak keys and such) 2 - make sure this object will function correctly, and do reasonable security checks 3 - do checks that may take a long time
Returns:
true if the tests pass

Implements CryptoMaterial.

Definition at line 756 of file pubkey.h.

References Integer::Gcd(), Integer::IsPositive(), and Integer::One().

void DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >::GenerateRandom ( RandomNumberGenerator rng,
const NameValuePairs params 
) [inline, virtual, inherited]

generate a random key or crypto parameters

Exceptions:
KeyingErr if algorithm parameters are invalid, or if a key can't be generated (e.g., if this is a public key object)

Reimplemented from GeneratableCryptoMaterial.

Definition at line 779 of file pubkey.h.

References NameValuePairs::GetThisObject(), and Integer::One().

Referenced by DL_PrivateKey_EC< EC >::Initialize().

void DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >::Precompute ( unsigned int  n = 16  )  [inline, virtual, inherited]

do precomputation

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

Reimplemented from CryptoMaterial.

Definition at line 792 of file pubkey.h.

void PKCS8PrivateKey::BERDecodeOptionalAttributes ( BufferedTransformation bt  )  [virtual, inherited]

decode optional attributes including context-specific tag

/note default implementation stores attributes to be output in DEREncodeOptionalAttributes

Definition at line 583 of file asn.cpp.

References PKCS8PrivateKey::m_optionalAttributes.

Referenced by PKCS8PrivateKey::BERDecode().

void ASN1CryptoMaterial< PrivateKey >::Load ( BufferedTransformation bt  )  [inline, virtual, inherited]

Reimplemented from CryptoMaterial.

Reimplemented in InvertibleRSAFunction.

Definition at line 240 of file asn.h.

virtual void ASN1Object::BEREncode ( BufferedTransformation bt  )  const [inline, virtual, inherited]

encode this object into a BufferedTransformation, using BER

this may be useful if DEREncode() would be too inefficient

Definition at line 1597 of file cryptlib.h.

Referenced by ASN1CryptoMaterial< PublicKey >::Save().

bool NameValuePairs::GetIntValue ( const char *  name,
int &  value 
) const [inline, inherited]

get a named value with type int

used to ensure we don't accidentally try to get an unsigned int or some other type when we mean int (which is the most common case)

Definition at line 280 of file cryptlib.h.

Referenced by InvertibleRWFunction::GenerateRandom(), InvertibleRSAFunction::GenerateRandom(), InvertibleRabinFunction::GenerateRandom(), InvertibleLUCFunction::GenerateRandom(), DL_GroupParameters_IntegerBased::GenerateRandom(), DL_GroupParameters_DSA::GenerateRandom(), InvertibleESIGNFunction::GenerateRandom(), and Integer::GenerateRandomNoThrow().


The documentation for this class was generated from the following files:
Generated on Fri Jun 1 11:11:35 2007 for Crypto++ by  doxygen 1.5.2