Crypto++
|
interface for crypto prameters More...
#include <cryptlib.h>
Public Member Functions | |
virtual void | GenerateRandom (RandomNumberGenerator &rng, const NameValuePairs ¶ms=g_nullNameValuePairs) |
generate a random key or crypto parameters | |
void | GenerateRandomWithKeySize (RandomNumberGenerator &rng, unsigned int keySize) |
calls the above function with a NameValuePairs object that just specifies "KeySize" | |
virtual void | AssignFrom (const NameValuePairs &source)=0 |
assign values from source 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 |
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 |
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 |
virtual bool | GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const =0 |
to be implemented by derived classes, users should use one of the above functions instead | |
Static Public Member Functions | |
static void | ThrowIfTypeMismatch (const char *name, const std::type_info &stored, const std::type_info &retrieving) |
used by derived classes to check for type mismatch |
interface for crypto prameters
virtual void GeneratableCryptoMaterial::GenerateRandom | ( | RandomNumberGenerator & | rng, |
const NameValuePairs & | params = g_nullNameValuePairs |
||
) | [inline, virtual, inherited] |
generate a random key or crypto parameters
KeyingErr | if algorithm parameters are invalid, or if a key can't be generated (e.g., if this is a public key object) |
Reimplemented in InvertibleESIGNFunction, InvertibleLUCFunction, InvertibleRabinFunction, and InvertibleRWFunction.
Definition at line 1107 of file cryptlib.h.
Referenced by GeneratableCryptoMaterial::GenerateRandomWithKeySize().
virtual void CryptoMaterial::AssignFrom | ( | const NameValuePairs & | source | ) | [pure virtual, inherited] |
assign values from source to this object
Implemented in InvertibleLUCFunction, InvertibleRabinFunction, InvertibleRWFunction, LUCFunction, RabinFunction, RWFunction, and XTR_DH.
virtual bool CryptoMaterial::Validate | ( | RandomNumberGenerator & | rng, |
unsigned int | level | ||
) | const [pure virtual, inherited] |
check this object for errors
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 |
Implemented in DL_GroupParameters, InvertibleLUCFunction, InvertibleRabinFunction, InvertibleRWFunction, LUCFunction, RabinFunction, RWFunction, and XTR_DH.
virtual void CryptoMaterial::Load | ( | BufferedTransformation & | bt | ) | [inline, virtual, inherited] |
load key from a BufferedTransformation
KeyingErr | if decode fails |
Definition at line 1072 of file cryptlib.h.
Referenced by AsymmetricAlgorithm::BERDecode().
virtual bool CryptoMaterial::SupportsPrecomputation | ( | ) | const [inline, virtual, inherited] |
Reimplemented in DL_GroupParameters.
Definition at line 1076 of file cryptlib.h.
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.
Definition at line 1081 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 282 of file cryptlib.h.
Referenced by InvertibleESIGNFunction::GenerateRandom(), DL_GroupParameters_DSA::GenerateRandom(), DL_GroupParameters_IntegerBased::GenerateRandom(), InvertibleLUCFunction::GenerateRandom(), InvertibleRabinFunction::GenerateRandom(), InvertibleRSAFunction::GenerateRandom(), and InvertibleRWFunction::GenerateRandom().