Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

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< T > DL_KeyImpl< PKCS8PrivateKey, DL_GroupParameters_EC< EC > > DL_Key< T > PKCS8PrivateKey ASN1Key PrivateKey ASN1CryptoMaterial GeneratableCryptoMaterial ASN1Object CryptoMaterial CryptoMaterial NameValuePairs NameValuePairs List of all members.

Detailed Description

template<class EC>
class DL_PrivateKey_EC< EC >

Definition at line 155 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 BERDecodeKey2 (BufferedTransformation &bt, bool parametersPresent, unsigned int size)
void DEREncodeKey (BufferedTransformation &bt) const
 encode subjectPublicKey part of subjectPublicKeyInfo, or privateKey part of privateKeyInfo, without the BIT STRING or 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
 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 BERDecodeKey (BufferedTransformation &bt)
 decode subjectPublicKey part of subjectPublicKeyInfo, or privateKey part of privateKeyInfo, without the BIT STRING or OCTET STRING header

void MakePublicKey (DL_PublicKey< T > &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)
virtual void DEREncodeOptionalAttributes (BufferedTransformation &bt) const
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

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> 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
void GenerateRandomWithKeySize (RandomNumberGenerator &rng, unsigned int keySize)
 calls the above function with a NameValuePairs object that just specifies "KeySize"


Static Public Member Functions

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


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 784 of file pubkey.h.

References Integer::Gcd(), 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 807 of file pubkey.h.

References NameValuePairs::GetThisObject().

void DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >::Precompute unsigned int  precomputationStorage = 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 820 of file pubkey.h.

void ASN1CryptoMaterial::Load BufferedTransformation bt  )  [inline, virtual, inherited]
 

load key from a BufferedTransformation

Exceptions:
KeyingErr if decode fails
Note:
Generally does not check that the key is valid. Call ValidateKey() or ThrowIfInvalidKey() to check that.

Reimplemented from CryptoMaterial.

Definition at line 49 of file simple.h.

References ASN1Object::BERDecode().

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 1551 of file cryptlib.h.

References ASN1Object::DEREncode().

Referenced by ASN1CryptoMaterial::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 258 of file cryptlib.h.

References NameValuePairs::GetValue().

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


The documentation for this class was generated from the following files:
Generated on Sun Mar 14 20:44:34 2004 for Crypto++ by doxygen 1.3.6-20040222