Fabcoin Core  0.16.2
P2P Digital Currency
Public Member Functions | Protected Attributes | Private Types | List of all members
InvertibleESIGNFunction Class Reference

ESIGN trapdoor function using the private key. More...

#include <esign.h>

Inheritance diagram for InvertibleESIGNFunction:
[legend]
Collaboration diagram for InvertibleESIGNFunction:
[legend]

Public Member Functions

void Initialize (const Integer &n, const Integer &e, const Integer &p, const Integer &q)
 Initialize a ESIGN private key with {n,e,p,q}. More...
 
void Initialize (RandomNumberGenerator &rng, unsigned int modulusBits)
 Create a ESIGN private key. More...
 
void BERDecode (BufferedTransformation &bt)
 Decode this object from a BufferedTransformation. More...
 
void DEREncode (BufferedTransformation &bt) const
 Encode this object into a BufferedTransformation. More...
 
Integer CalculateRandomizedInverse (RandomNumberGenerator &rng, const Integer &x) const
 Applies the inverse of the trapdoor function, using random data if required. More...
 
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 &alg)
 
const IntegerGetPrime1 () const
 
const IntegerGetPrime2 () const
 
void SetPrime1 (const Integer &p)
 
void SetPrime2 (const Integer &q)
 
- Public Member Functions inherited from ESIGNFunction
void Initialize (const Integer &n, const Integer &e)
 Initialize a ESIGN public key with {n,e}. More...
 
Integer ApplyFunction (const Integer &x) const
 Applies the trapdoor. More...
 
Integer PreimageBound () const
 Returns the maximum size of a message before the trapdoor function is applied. More...
 
Integer ImageBound () const
 Returns the maximum size of a message after the trapdoor function is applied. More...
 
const IntegerGetModulus () const
 
const IntegerGetPublicExponent () const
 
void SetModulus (const Integer &n)
 
void SetPublicExponent (const Integer &e)
 
- Public Member Functions inherited from TrapdoorFunction
virtual ~TrapdoorFunction ()
 
Integer ApplyRandomizedFunction (RandomNumberGenerator &rng, const Integer &x) const
 Applies the trapdoor function. More...
 
bool IsRandomized () const
 Determines if the encryption algorithm is randomized. More...
 
- Public Member Functions inherited from RandomizedTrapdoorFunction
virtual ~RandomizedTrapdoorFunction ()
 
- Public Member Functions inherited from TrapdoorFunctionBounds
virtual ~TrapdoorFunctionBounds ()
 
virtual Integer MaxPreimage () const
 Returns the maximum size of a message before the trapdoor function is applied bound to a public key. More...
 
virtual Integer MaxImage () const
 Returns the maximum size of a message after the trapdoor function is applied bound to a public key. More...
 
- Public Member Functions inherited from ASN1CryptoMaterial< PublicKey >
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 CryptoMaterial
virtual ~CryptoMaterial ()
 
virtual void ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const
 Check this object for errors. More...
 
virtual bool SupportsPrecomputation () const
 Determines whether the object supports precomputation. More...
 
virtual void Precompute (unsigned int precomputationStorage)
 Perform precomputation. More...
 
virtual void LoadPrecomputation (BufferedTransformation &storedPrecomputation)
 Retrieve previously saved precomputation. More...
 
virtual void SavePrecomputation (BufferedTransformation &storedPrecomputation) const
 Save precomputation for later use. 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...
 
- Public Member Functions inherited from RandomizedTrapdoorFunctionInverse
virtual ~RandomizedTrapdoorFunctionInverse ()
 
virtual bool IsRandomized () const
 Determines if the decryption algorithm is randomized. More...
 
- Public Member Functions inherited from GeneratableCryptoMaterial
virtual ~GeneratableCryptoMaterial ()
 
void GenerateRandomWithKeySize (RandomNumberGenerator &rng, unsigned int keySize)
 Generate a random key or crypto parameters. More...
 

Protected Attributes

Integer m_p
 
Integer m_q
 
- Protected Attributes inherited from ESIGNFunction
Integer m_n
 
Integer m_e
 

Private Types

typedef InvertibleESIGNFunction ThisClass
 

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 Member Functions inherited from ESIGNFunction
unsigned int GetK () const
 

Detailed Description

ESIGN trapdoor function using the private key.

Since
Crypto++ 5.0

Definition at line 64 of file esign.h.

Member Typedef Documentation

Definition at line 66 of file esign.h.

Member Function Documentation

void InvertibleESIGNFunction::AssignFrom ( const NameValuePairs source)
virtual

Assign values to this object.

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

Reimplemented from ESIGNFunction.

Definition at line 213 of file esign.cpp.

Here is the caller graph for this function:

void InvertibleESIGNFunction::BERDecode ( BufferedTransformation bt)
virtual

Decode this object from a BufferedTransformation.

Parameters
btBufferedTransformation object

Uses Basic Encoding Rules (BER)

Reimplemented from ESIGNFunction.

Definition at line 131 of file esign.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Integer InvertibleESIGNFunction::CalculateRandomizedInverse ( RandomNumberGenerator rng,
const Integer x 
) const
virtual

Applies the inverse of the trapdoor function, using random data if required.

Parameters
rnga RandomNumberGenerator derived class
xthe message on which the decryption function is applied
Returns
the message x decrypted under the private key

CalculateRandomizedInverse is a generalization of decryption using the private key The RandomNumberGenerator may (or may not) be required. Derived classes must implement it.

Implements RandomizedTrapdoorFunctionInverse.

Definition at line 151 of file esign.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void InvertibleESIGNFunction::DEREncode ( BufferedTransformation bt) const
virtual

Encode this object into a BufferedTransformation.

Parameters
btBufferedTransformation object

Uses Distinguished Encoding Rules (DER)

Reimplemented from ESIGNFunction.

Definition at line 141 of file esign.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void InvertibleESIGNFunction::GenerateRandom ( RandomNumberGenerator rng,
const NameValuePairs alg 
)
virtual

parameters: (ModulusSize)

Reimplemented from GeneratableCryptoMaterial.

Definition at line 86 of file esign.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

const Integer& InvertibleESIGNFunction::GetPrime1 ( ) const
inline

Definition at line 100 of file esign.h.

const Integer& InvertibleESIGNFunction::GetPrime2 ( ) const
inline

Definition at line 101 of file esign.h.

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

Get a named value.

Parameters
namethe name of the object or value to retrieve
valueTypereference to a variable that receives the value
pValuevoid 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()

Reimplemented from ESIGNFunction.

Definition at line 205 of file esign.cpp.

Here is the caller graph for this function:

void InvertibleESIGNFunction::Initialize ( const Integer n,
const Integer e,
const Integer p,
const Integer q 
)
inline

Initialize a ESIGN private key with {n,e,p,q}.

Parameters
nmodulus
epublic exponent
pfirst prime factor
qsecond prime factor

This Initialize() function overload initializes a private key from existing parameters.

Definition at line 76 of file esign.h.

void InvertibleESIGNFunction::Initialize ( RandomNumberGenerator rng,
unsigned int  modulusBits 
)
inline

Create a ESIGN private key.

Parameters
rnga RandomNumberGenerator derived class
modulusBitsthe size of the modulud, in bits

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 85 of file esign.h.

Here is the call graph for this function:

void InvertibleESIGNFunction::SetPrime1 ( const Integer p)
inline

Definition at line 103 of file esign.h.

void InvertibleESIGNFunction::SetPrime2 ( const Integer q)
inline

Definition at line 104 of file esign.h.

bool InvertibleESIGNFunction::Validate ( RandomNumberGenerator rng,
unsigned int  level 
) const
virtual

Check this object for errors.

Parameters
rnga RandomNumberGenerator for objects which use randomized testing
levelthe 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.

See also
ThrowIfInvalid()

Reimplemented from ESIGNFunction.

Definition at line 192 of file esign.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Integer InvertibleESIGNFunction::m_p
protected

Definition at line 107 of file esign.h.

Integer InvertibleESIGNFunction::m_q
protected

Definition at line 107 of file esign.h.


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