Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Classes | Public Member Functions | List of all members
CryptoMaterial Class Referenceabstract

Interface for crypto material, such as public and private keys, and crypto parameters. More...

+ Inheritance diagram for CryptoMaterial:

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...
 
- Public Member Functions inherited from 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 >
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 Public Member Functions inherited from NameValuePairs
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...
 

Detailed Description

Interface for crypto material, such as public and private keys, and crypto parameters.

Definition at line 2043 of file cryptlib.h.

Member Function Documentation

virtual void CryptoMaterial::AssignFrom ( const NameValuePairs source)
pure virtual
virtual bool CryptoMaterial::Validate ( RandomNumberGenerator rng,
unsigned int  level 
) const
pure 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()

Implemented in 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 EcPrecomputation< EC >::Element >, InvertibleRSAFunction, InvertibleLUCFunction, InvertibleRWFunction, InvertibleESIGNFunction, InvertibleRabinFunction, LUCFunction, RWFunction, RSAFunction, RabinFunction, ESIGNFunction, and XTR_DH.

virtual void CryptoMaterial::ThrowIfInvalid ( RandomNumberGenerator rng,
unsigned int  level 
) const
inlinevirtual

Check this object for errors.

Parameters
rnga RandomNumberGenerator for objects which use randomized testing
levelthe level of thoroughness
Exceptions
InvalidMaterial

Internally, ThrowIfInvalid() calls Validate() and throws InvalidMaterial() if validation fails.

See also
Validate()

Definition at line 2083 of file cryptlib.h.

virtual void CryptoMaterial::Save ( BufferedTransformation bt) const
inlinevirtual

Saves a key to a BufferedTransformation.

Parameters
btthe destination BufferedTransformation
Exceptions
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 ASN1CryptoMaterial< PrivateKey >, ASN1CryptoMaterial< DL_GroupParameters< Integer > >, ASN1CryptoMaterial< PublicKey >, InvertibleRSAFunction, InvertibleRWFunction, and RWFunction.

Definition at line 2095 of file cryptlib.h.

virtual void CryptoMaterial::Load ( BufferedTransformation bt)
inlinevirtual

Loads a key from a BufferedTransformation.

Parameters
btthe source BufferedTransformation
Exceptions
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:

  • the key should be ASN.1 BER encoded
  • the key should be a "key info"

"key info" means the key should have an object identifier with an algorthm id, like a subjectPublicKeyInfo.

To read a "raw" key without the "key info", then call the key's BERDecode() method.

Note
Load generally does not check that the key is valid. Call Validate(), if needed.

Reimplemented in ASN1CryptoMaterial< PrivateKey >, ASN1CryptoMaterial< DL_GroupParameters< Integer > >, ASN1CryptoMaterial< PublicKey >, InvertibleRSAFunction, InvertibleRWFunction, and RWFunction.

Definition at line 2112 of file cryptlib.h.

virtual bool CryptoMaterial::SupportsPrecomputation ( ) const
inlinevirtual
virtual void CryptoMaterial::Precompute ( unsigned int  precomputationStorage)
inlinevirtual

Perform precomputation.

Parameters
precomputationStoragethe suggested number of objects for the precompute table
Exceptions
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.

See also
SupportsPrecomputation(), LoadPrecomputation(), SavePrecomputation()

Reimplemented in 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 EcPrecomputation< EC >::Element >, and InvertibleRWFunction.

Definition at line 2128 of file cryptlib.h.

virtual void CryptoMaterial::LoadPrecomputation ( BufferedTransformation storedPrecomputation)
inlinevirtual
virtual void CryptoMaterial::SavePrecomputation ( BufferedTransformation storedPrecomputation) const
inlinevirtual
void CryptoMaterial::DoQuickSanityCheck ( ) const
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.


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