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. | |
virtual bool | Validate (RandomNumberGenerator &rng, unsigned int level) const =0 |
Check this object for errors. | |
virtual void | ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const |
Check this object for errors. | |
virtual void | Save (BufferedTransformation &bt) const |
Saves a key to a BufferedTransformation. | |
virtual void | Load (BufferedTransformation &bt) |
Loads a key from a BufferedTransformation. | |
virtual bool | SupportsPrecomputation () const |
Determines whether the object supports precomputation. | |
virtual void | Precompute (unsigned int precomputationStorage) |
Perform 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 subobject. | |
template<class T > | |
bool | GetThisPointer (T *&ptr) const |
Get a pointer to this object. | |
template<class T > | |
bool | GetValue (const char *name, T &value) const |
Get a named value. | |
template<class T > | |
T | GetValueWithDefault (const char *name, T defaultValue) const |
Get a named value. | |
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 |
Retrieves a required name/value pair. | |
void | GetRequiredIntParameter (const char *className, const char *name, int &value) const |
Retrieves a required name/value pair. | |
virtual bool | GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const =0 |
Get a named value. | |
Static Public Member Functions | |
static void | ThrowIfTypeMismatch (const char *name, const std::type_info &stored, const std::type_info &retrieving) |
Ensures an expected name and type is present. |
Interface for crypto material, such as public and private keys, and crypto parameters.
Definition at line 1904 of file cryptlib.h.
virtual void CryptoMaterial::AssignFrom | ( | const NameValuePairs & | source | ) | [pure virtual] |
Assign values to this object.
This function can be used to create a public key from a private key.
Implemented in DL_GroupParameters_EC< EC >, DL_GroupParameters_EC< EC >, ESIGNFunction, InvertibleESIGNFunction, DL_GroupParameters_IntegerBased, DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >, LUCFunction, InvertibleLUCFunction, RabinFunction, InvertibleRabinFunction, RSAFunction, InvertibleRSAFunction, RWFunction, InvertibleRWFunction, XTR_DH, DL_GroupParameters_IntegerBasedImpl< DL_GroupPrecomputation_LUC, DL_BasePrecomputation_LUC >, and DL_GroupParameters_IntegerBasedImpl< ModExpPrecomputation >.
virtual bool CryptoMaterial::Validate | ( | RandomNumberGenerator & | rng, | |
unsigned int | level | |||
) | const [pure virtual] |
Check this object for errors.
rng | a RandomNumberGenerator for objects which use randomized testing | |
level | the level of thoroughness |
There are four levels of thoroughness:
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.
Implemented in ESIGNFunction, InvertibleESIGNFunction, LUCFunction, InvertibleLUCFunction, DL_GroupParameters< T >, DL_PrivateKeyImpl< GP >, DL_PublicKeyImpl< GP >, RabinFunction, InvertibleRabinFunction, RSAFunction, InvertibleRSAFunction, RWFunction, InvertibleRWFunction, XTR_DH, DL_GroupParameters< Integer >, DL_GroupParameters< typenameEcPrecomputation< EC >::Element >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, and DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >.
virtual void CryptoMaterial::ThrowIfInvalid | ( | RandomNumberGenerator & | rng, | |
unsigned int | level | |||
) | const [inline, virtual] |
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 1939 of file cryptlib.h.
virtual void CryptoMaterial::Save | ( | BufferedTransformation & | bt | ) | const [inline, virtual] |
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 InvertibleRSAFunction, RWFunction, and InvertibleRWFunction.
Definition at line 1951 of file cryptlib.h.
virtual void CryptoMaterial::Load | ( | BufferedTransformation & | bt | ) | [inline, virtual] |
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:
"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.
Reimplemented in InvertibleRSAFunction, RWFunction, and InvertibleRWFunction.
Definition at line 1968 of file cryptlib.h.
virtual bool CryptoMaterial::SupportsPrecomputation | ( | ) | const [inline, virtual] |
Determines whether the object supports precomputation.
Reimplemented in DL_GroupParameters< T >, DL_PrivateKeyImpl< GP >, DL_PublicKeyImpl< GP >, DL_GroupParameters< Integer >, DL_GroupParameters< typenameEcPrecomputation< EC >::Element >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, and DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >.
Definition at line 1973 of file cryptlib.h.
virtual void CryptoMaterial::Precompute | ( | unsigned int | precomputationStorage | ) | [inline, virtual] |
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 DL_GroupParameters< T >, DL_PrivateKeyImpl< GP >, DL_PublicKeyImpl< GP >, DL_GroupParameters< Integer >, DL_GroupParameters< typenameEcPrecomputation< EC >::Element >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, and DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >.
Definition at line 1982 of file cryptlib.h.
bool NameValuePairs::GetThisObject | ( | T & | object | ) | const [inline, inherited] |
Get a copy of this object or subobject.
T | class or type |
object | reference to a variable that receives the value |
Definition at line 297 of file cryptlib.h.
Referenced by DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >::GenerateRandom().
bool NameValuePairs::GetThisPointer | ( | T *& | ptr | ) | const [inline, inherited] |
Get a pointer to this object.
T | class or type |
ptr | reference to a pointer to a variable that receives the value |
Definition at line 306 of file cryptlib.h.
bool NameValuePairs::GetValue | ( | const char * | name, | |
T & | value | |||
) | const [inline, inherited] |
Get a named value.
T | class or type |
name | the name of the object or value to retrieve | |
value | reference to a variable that receives the value |
Definition at line 319 of file cryptlib.h.
Referenced by DL_GroupParameters_EC< EC >::AssignFrom(), DL_GroupParameters_IntegerBased::GenerateRandom(), DL_GroupParameters_DSA::GenerateRandom(), InvertibleESIGNFunction::GenerateRandom(), Inflator::IsolatedInitialize(), StringSinkTemplate< T >::IsolatedInitialize(), ArraySink::IsolatedInitialize(), FileSink::IsolatedInitialize(), and Grouper::IsolatedInitialize().
T NameValuePairs::GetValueWithDefault | ( | const char * | name, | |
T | defaultValue | |||
) | const [inline, inherited] |
Get a named value.
T | class or type |
name | the name of the object or value to retrieve | |
defaultValue | the default value of the class or type if it does not exist |
Definition at line 332 of file cryptlib.h.
Referenced by DL_GroupParameters_EC< EC >::AssignFrom(), InvertibleRSAFunction::GenerateRandom(), InvertibleLUCFunction::GenerateRandom(), DL_GroupParameters_IntegerBased::GenerateRandom(), DL_GroupParameters_DSA::GenerateRandom(), InvertibleESIGNFunction::GenerateRandom(), Redirector::Initialize(), Deflator::IsolatedInitialize(), SignerFilter::IsolatedInitialize(), HashFilter::IsolatedInitialize(), FileSink::IsolatedInitialize(), and Base64URLEncoder::IsolatedInitialize().
std::string NameValuePairs::GetValueNames | ( | ) | const [inline, inherited] |
Get a list of value names that can be retrieved.
the items in the list are delimited with a colon.
Definition at line 344 of file cryptlib.h.
bool NameValuePairs::GetIntValue | ( | const char * | name, | |
int & | value | |||
) | const [inline, inherited] |
Get a named value with type int.
name | the name of the value to retrieve | |
value | the value retrieved upon success |
GetIntValue() is 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 355 of file cryptlib.h.
Referenced by InvertibleRWFunction::GenerateRandom(), InvertibleRSAFunction::GenerateRandom(), InvertibleRabinFunction::GenerateRandom(), InvertibleLUCFunction::GenerateRandom(), DL_GroupParameters_IntegerBased::GenerateRandom(), DL_GroupParameters_DSA::GenerateRandom(), and InvertibleESIGNFunction::GenerateRandom().
int NameValuePairs::GetIntValueWithDefault | ( | const char * | name, | |
int | defaultValue | |||
) | const [inline, inherited] |
Get a named value with type int, with default.
name | the name of the value to retrieve | |
defaultValue | the default value if the name does not exist |
Definition at line 364 of file cryptlib.h.
Referenced by DL_GroupParameters_IntegerBased::GenerateRandom(), Redirector::Initialize(), Deflator::IsolatedInitialize(), ByteQueue::IsolatedInitialize(), HashFilter::IsolatedInitialize(), Grouper::IsolatedInitialize(), Base64URLEncoder::IsolatedInitialize(), VMAC_Base::UncheckedSetKey(), SAFER::Base::UncheckedSetKey(), and Weak1::ARC4_Base::UncheckedSetKey().
static void NameValuePairs::ThrowIfTypeMismatch | ( | const char * | name, | |
const std::type_info & | stored, | |||
const std::type_info & | retrieving | |||
) | [inline, static, inherited] |
Ensures an expected name and type is present.
name | the name of the value | |
stored | the type that was stored for the name | |
retrieving | the type that is being retrieved for the name |
ValueTypeMismatch |
ThrowIfTypeMismatch() effectively performs a type safety check. stored and retrieving are C++ mangled names for the type.
Definition at line 376 of file cryptlib.h.
Referenced by DL_GroupParameters_EC< EC >::GetVoidValue().
void NameValuePairs::GetRequiredParameter | ( | const char * | className, | |
const char * | name, | |||
T & | value | |||
) | const [inline, inherited] |
Retrieves a required name/value pair.
T | class or type |
className | the name of the class | |
name | the name of the value | |
value | reference to a variable to receive the value |
InvalidArgument |
GetRequiredParameter() throws InvalidArgument if the name is not present or not of the expected type T.
Definition at line 390 of file cryptlib.h.
Referenced by DL_GroupParameters_EC< EC >::AssignFrom(), RandomNumberSink::IsolatedInitialize(), Grouper::IsolatedInitialize(), and BaseN_Decoder::IsolatedInitialize().
void NameValuePairs::GetRequiredIntParameter | ( | const char * | className, | |
const char * | name, | |||
int & | value | |||
) | const [inline, inherited] |
Retrieves a required name/value pair.
className | the name of the class | |
name | the name of the value | |
value | reference to a variable to receive the value |
InvalidArgument |
GetRequiredParameter() throws InvalidArgument if the name is not present or not of the expected type T.
Definition at line 405 of file cryptlib.h.
Referenced by BaseN_Decoder::IsolatedInitialize().
virtual bool NameValuePairs::GetVoidValue | ( | const char * | name, | |
const std::type_info & | valueType, | |||
void * | pValue | |||
) | const [pure virtual, inherited] |
Get a named value.
name | the name of the object or value to retrieve | |
valueType | reference to a variable that receives the value | |
pValue | void pointer to a variable that receives the value |
GetVoidValue() retrives the value of name if it exists.
Implemented in CombinedNameValuePairs, AlgorithmParameters, NullNameValuePairs, TestDataNameValuePairs, DL_GroupParameters_EC< EC >, DL_GroupParameters_EC< EC >, ESIGNFunction, InvertibleESIGNFunction, DL_GroupParameters_IntegerBased, DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >, DL_GroupParameters_GFP, LUCFunction, InvertibleLUCFunction, DL_GroupParameters_LUC, DL_GroupParameters< T >, RabinFunction, InvertibleRabinFunction, RSAFunction, InvertibleRSAFunction, RWFunction, InvertibleRWFunction, XTR_DH, DL_GroupParameters_IntegerBasedImpl< DL_GroupPrecomputation_LUC, DL_BasePrecomputation_LUC >, DL_GroupParameters_IntegerBasedImpl< ModExpPrecomputation >, DL_GroupParameters< Integer >, and DL_GroupParameters< typenameEcPrecomputation< EC >::Element >.