#include <xtrcrypt.h>
Public Member Functions | |
XTR_DH (const Integer &p, const Integer &q, const GFP2Element &g) | |
XTR_DH (RandomNumberGenerator &rng, unsigned int pbits, unsigned int qbits) | |
XTR_DH (BufferedTransformation &domainParams) | |
void | DEREncode (BufferedTransformation &domainParams) const |
for backwards compatibility, calls GetMaterial().Save(bt) | |
bool | Validate (RandomNumberGenerator &rng, unsigned int level) const |
check this object for errors | |
bool | GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const |
to be implemented by derived classes, users should use one of the above functions instead | |
void | AssignFrom (const NameValuePairs &source) |
assign values from source to this object | |
CryptoParameters & | AccessCryptoParameters () |
unsigned int | AgreedValueLength () const |
return length of agreed value produced | |
unsigned int | PrivateKeyLength () const |
return length of private keys in this domain | |
unsigned int | PublicKeyLength () const |
return length of public keys in this domain | |
void | GeneratePrivateKey (RandomNumberGenerator &rng, byte *privateKey) const |
generate private key | |
void | GeneratePublicKey (RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const |
generate public key | |
bool | Agree (byte *agreedValue, const byte *privateKey, const byte *otherPublicKey, bool validateOtherPublicKey=true) const |
derive agreed value from your private key and couterparty's public key, return false in case of failure | |
const Integer & | GetModulus () const |
const Integer & | GetSubgroupOrder () const |
const GFP2Element & | GetSubgroupGenerator () const |
void | SetModulus (const Integer &p) |
void | SetSubgroupOrder (const Integer &q) |
void | SetSubgroupGenerator (const GFP2Element &g) |
virtual void | GenerateKeyPair (RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const |
generate private/public key pair | |
CryptoMaterial & | AccessMaterial () |
returns a reference to the crypto material used by this object | |
const CryptoMaterial & | GetMaterial () const |
returns a const reference to the crypto material used by this object | |
virtual const CryptoParameters & | GetCryptoParameters () const |
void | BERDecode (BufferedTransformation &bt) |
for backwards compatibility, calls AccessMaterial().Load(bt) | |
virtual std::string | AlgorithmName () const |
returns name of this algorithm, not universally implemented yet | |
virtual Clonable * | Clone () const |
this is not implemented by most classes yet | |
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 | 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 |
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 |
Definition at line 14 of file xtrcrypt.h.
bool XTR_DH::Validate | ( | RandomNumberGenerator & | rng, | |
unsigned int | level | |||
) | const [virtual] |
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 |
Implements CryptoMaterial.
void XTR_DH::AssignFrom | ( | const NameValuePairs & | source | ) | [virtual] |
assign values from source to this object
Implements CryptoMaterial.
void XTR_DH::GeneratePrivateKey | ( | RandomNumberGenerator & | rng, | |
byte * | privateKey | |||
) | const [virtual] |
generate private key
Implements SimpleKeyAgreementDomain.
void XTR_DH::GeneratePublicKey | ( | RandomNumberGenerator & | rng, | |
const byte * | privateKey, | |||
byte * | publicKey | |||
) | const [virtual] |
generate public key
Implements SimpleKeyAgreementDomain.
bool XTR_DH::Agree | ( | byte * | agreedValue, | |
const byte * | privateKey, | |||
const byte * | otherPublicKey, | |||
bool | validateOtherPublicKey = true | |||
) | const [virtual] |
derive agreed value from your private key and couterparty's public key, return false in case of failure
length of privateKey == PrivateKeyLength()
length of otherPublicKey == PublicKeyLength()
Implements SimpleKeyAgreementDomain.
virtual void SimpleKeyAgreementDomain::GenerateKeyPair | ( | RandomNumberGenerator & | rng, | |
byte * | privateKey, | |||
byte * | publicKey | |||
) | const [virtual, inherited] |
generate private/public key pair
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 DL_GroupParameters_EC< EC >, InvertibleESIGNFunction, DL_GroupParameters_IntegerBased, DL_GroupParameters_DSA, InvertibleLUCFunction, DL_PrivateKeyImpl< GP >, InvertibleRabinFunction, InvertibleRSAFunction, InvertibleRWFunction, and DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >.
Definition at line 1106 of file cryptlib.h.
virtual void CryptoMaterial::Load | ( | BufferedTransformation & | bt | ) | [inline, virtual, inherited] |
load key from a BufferedTransformation
KeyingErr | if decode fails |
Reimplemented in InvertibleRSAFunction.
Definition at line 1071 of file cryptlib.h.
virtual bool CryptoMaterial::SupportsPrecomputation | ( | ) | const [inline, virtual, inherited] |
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 1075 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< 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 1080 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 281 of file cryptlib.h.