Crypto++
5.6.4
Free C++ class library of cryptographic schemes
|
Interface for crypto material, such as public and private keys, and crypto parameters. More...
Classes | |
class | InvalidMaterial |
Exception thrown when invalid crypto material is detected. More... | |
Public Member Functions | |
virtual void | AssignFrom (const NameValuePairs &source)=0 |
Assign values to this object. More... | |
virtual bool | Validate (RandomNumberGenerator &rng, unsigned int level) const =0 |
Check this object for errors. More... | |
virtual void | ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const |
Check this object for errors. More... | |
virtual void | Save (BufferedTransformation &bt) const |
Saves a key to a BufferedTransformation. More... | |
virtual void | Load (BufferedTransformation &bt) |
Loads a key from a BufferedTransformation. 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... | |
![]() | |
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... | |
std::string | GetValueNames () const |
Get a list of value names that can be retrieved. More... | |
bool | GetIntValue (const char *name, int &value) const |
Get a named value with type int. More... | |
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... | |
void | GetRequiredIntParameter (const char *className, const char *name, int &value) const |
Retrieves a required name/value pair. More... | |
virtual bool | GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const =0 |
Get a named value. More... | |
Additional Inherited Members | |
![]() | |
static void | ThrowIfTypeMismatch (const char *name, const std::type_info &stored, const std::type_info &retrieving) |
Ensures an expected name and type is present. More... | |
Interface for crypto material, such as public and private keys, and crypto parameters.
Definition at line 2043 of file cryptlib.h.
|
pure virtual |
Assign values to this object.
This function can be used to create a public key from a private key.
Implemented in XTR_DH, InvertibleRWFunction, RWFunction, InvertibleRSAFunction, RSAFunction, InvertibleRabinFunction, RabinFunction, DL_PublicKeyImpl< GP >, DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >, DL_PrivateKeyImpl< GP >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, InvertibleLUCFunction, LUCFunction, DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >, DL_GroupParameters_IntegerBasedImpl< DL_GroupPrecomputation_LUC, DL_BasePrecomputation_LUC >, DL_GroupParameters_IntegerBasedImpl< ModExpPrecomputation >, DL_GroupParameters_IntegerBased, InvertibleESIGNFunction, ESIGNFunction, and DL_GroupParameters_EC< EC >.
|
pure virtual |
Check this object for errors.
rng | a RandomNumberGenerator for objects which use randomized testing |
level | the level of thoroughness |
Implemented in XTR_DH, InvertibleRWFunction, RWFunction, InvertibleRSAFunction, RSAFunction, InvertibleRabinFunction, RabinFunction, DL_PublicKeyImpl< GP >, DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >, DL_PrivateKeyImpl< GP >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, DL_GroupParameters< T >, DL_GroupParameters< Integer >, DL_GroupParameters< typename GROUP_PRECOMP::Element >, InvertibleLUCFunction, LUCFunction, InvertibleESIGNFunction, and ESIGNFunction.
|
inlinevirtual |
Check this object for errors.
rng | a RandomNumberGenerator for objects which use randomized testing |
level | the level of thoroughness |
InvalidMaterial | Internally, ThrowIfInvalid() calls Validate() and throws InvalidMaterial() if validation fails. |
Definition at line 2083 of file cryptlib.h.
|
inlinevirtual |
Saves a key to a BufferedTransformation.
bt | the destination BufferedTransformation |
NotImplemented | Save() writes the material to a BufferedTransformation. If the material is a key, then the key is written with ASN.1 DER encoding. The key includes an object identifier with an algorthm id, like a subjectPublicKeyInfo. A "raw" key without the "key info" can be saved using a key's DEREncode() method. If a derived class does not override Save(), then the base class throws NotImplemented(). |
Reimplemented in InvertibleRWFunction, RWFunction, InvertibleRSAFunction, ASN1CryptoMaterial< DL_GroupParameters< Integer > >, ASN1CryptoMaterial< PrivateKey >, and ASN1CryptoMaterial< PublicKey >.
Definition at line 2095 of file cryptlib.h.
|
inlinevirtual |
Loads a key from a BufferedTransformation.
bt | the source BufferedTransformation |
KeyingErr | Load() attempts to read material from a BufferedTransformation. If the material is a key that was generated outside the library, then the following usually applies:
|
Reimplemented in InvertibleRWFunction, RWFunction, InvertibleRSAFunction, ASN1CryptoMaterial< DL_GroupParameters< Integer > >, ASN1CryptoMaterial< PrivateKey >, and ASN1CryptoMaterial< PublicKey >.
Definition at line 2112 of file cryptlib.h.
|
inlinevirtual |
Determines whether the object supports precomputation.
Reimplemented in InvertibleRWFunction, DL_PublicKeyImpl< GP >, DL_PrivateKeyImpl< GP >, and DL_GroupParameters< T >.
Definition at line 2118 of file cryptlib.h.
|
inlinevirtual |
Perform precomputation.
precomputationStorage | the suggested number of objects for the precompute table |
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. |
Reimplemented in InvertibleRWFunction, DL_PublicKeyImpl< GP >, DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >, DL_PrivateKeyImpl< GP >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, DL_GroupParameters< T >, DL_GroupParameters< Integer >, and DL_GroupParameters< typename GROUP_PRECOMP::Element >.
Definition at line 2128 of file cryptlib.h.
|
inlinevirtual |
Retrieve previously saved precomputation.
storedPrecomputation | BufferedTransformation with the saved precomputation |
NotImplemented |
Reimplemented in InvertibleRWFunction, DL_PublicKeyImpl< GP >, DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >, DL_PrivateKeyImpl< GP >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, DL_GroupParameters< T >, DL_GroupParameters< Integer >, and DL_GroupParameters< typename GROUP_PRECOMP::Element >.
Definition at line 2137 of file cryptlib.h.
|
inlinevirtual |
Save precomputation for later use.
storedPrecomputation | BufferedTransformation to write the precomputation |
NotImplemented |
Reimplemented in InvertibleRWFunction, DL_PublicKeyImpl< GP >, DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >, DL_PrivateKeyImpl< GP >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, DL_GroupParameters< T >, DL_GroupParameters< Integer >, and DL_GroupParameters< typename GROUP_PRECOMP::Element >.
Definition at line 2143 of file cryptlib.h.
|
inline |
Perform a quick sanity check.
DoQuickSanityCheck() is for internal library use, and it should not be called by library users.
Definition at line 2148 of file cryptlib.h.