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

ESIGNFunction Class Reference

#include <esign.h>

Inheritance diagram for ESIGNFunction:

TrapdoorFunction PublicKey ASN1CryptoMaterial RandomizedTrapdoorFunction CryptoMaterial ASN1Object CryptoMaterial TrapdoorFunctionBounds NameValuePairs NameValuePairs InvertibleESIGNFunction List of all members.

Detailed Description

Definition at line 15 of file esign.h.

Public Member Functions

void Initialize (const Integer &n, const Integer &e)
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)

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
 to be implemented by derived classes, users should use one of the above functions instead

void AssignFrom (const NameValuePairs &source)
 assign values from source to this object

Integer ApplyFunction (const Integer &x) const
Integer PreimageBound () const
Integer ImageBound () const
const IntegerGetModulus () const
const IntegerGetPublicExponent () const
void SetModulus (const Integer &n)
void SetPublicExponent (const Integer &e)
Integer ApplyRandomizedFunction (RandomNumberGenerator &rng, const Integer &x) const
bool IsRandomized () const
virtual Integer MaxPreimage () const
virtual Integer MaxImage () const
virtual void ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const
 throws InvalidMaterial if this object fails Validate() test

virtual void Save (BufferedTransformation &bt) const
 save key into a BufferedTransformation

virtual void Load (BufferedTransformation &bt)
 load key from a BufferedTransformation

virtual bool SupportsPrecomputation () const
 whether this object supports precomputation

virtual void Precompute (unsigned int n)
 do precomputation

virtual void LoadPrecomputation (BufferedTransformation &storedPrecomputation)
 retrieve previously saved precomputation

virtual void SavePrecomputation (BufferedTransformation &storedPrecomputation) const
 save precomputation for later use

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


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


Protected Member Functions

unsigned int GetK () const

Protected Attributes

Integer m_n
Integer m_e


Member Function Documentation

bool ESIGNFunction::Validate RandomNumberGenerator rng,
unsigned int  level
const [virtual]
 

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.

Reimplemented in InvertibleESIGNFunction.

Definition at line 49 of file esign.cpp.

References Integer::IsOdd(), Integer::One(), and Validate().

Referenced by Validate().

void ESIGNFunction::AssignFrom const NameValuePairs source  )  [virtual]
 

assign values from source to this object

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

Implements CryptoMaterial.

Reimplemented in InvertibleESIGNFunction.

Definition at line 65 of file esign.cpp.

References AssignFrom().

Referenced by AssignFrom().

virtual void CryptoMaterial::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 in ASN1CryptoMaterial.

Definition at line 966 of file cryptlib.h.

Referenced by AsymmetricAlgorithm::BERDecode().

virtual void CryptoMaterial::Precompute unsigned int  n  )  [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 in DL_GroupParameters< T >, DL_PrivateKeyImpl< GP >, DL_PublicKeyImpl< GP >, DL_GroupParameters< Integer >, DL_GroupParameters< typename EcPrecomputation< EC >::Element >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, and DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >.

Definition at line 975 of file cryptlib.h.

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::GetIntValue().

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

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 ASN1CryptoMaterial::Load().

Referenced by ASN1CryptoMaterial::Load().

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.


The documentation for this class was generated from the following files:
Generated on Wed Jul 28 08:07:13 2004 for Crypto++ by doxygen 1.3.7