Crypto++  8.2
Free C++ class library of cryptographic schemes
Public Types | Public Member Functions | List of all members
DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP > Class Template Reference

Integer-based GroupParameters default implementation. More...

+ Inheritance diagram for DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >:

Public Types

typedef GROUP_PRECOMP::Element Element
 
- Public Types inherited from DL_GroupParametersImpl< GROUP_PRECOMP, DL_FixedBasePrecomputationImpl< typename GROUP_PRECOMP::Element >, DL_GroupParameters_IntegerBased >
typedef GROUP_PRECOMP GroupPrecomputation
 
typedef GROUP_PRECOMP::Element Element
 
typedef DL_FixedBasePrecomputationImpl< typename GROUP_PRECOMP::Element > BasePrecomputation
 
- Public Types inherited from DL_GroupParameters< Integer >
typedef Integer Element
 

Public Member Functions

bool GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const
 Get a named value. More...
 
void AssignFrom (const NameValuePairs &source)
 Initialize or reinitialize this key. More...
 
const DL_FixedBasePrecomputation< Element > & GetBasePrecomputation () const
 
DL_FixedBasePrecomputation< Element > & AccessBasePrecomputation ()
 Retrieves the group precomputation. More...
 
const IntegerGetModulus () const
 Retrieve the modulus for the group. More...
 
const IntegerGetGenerator () const
 Retrieves a reference to the group generator. More...
 
void SetModulusAndSubgroupGenerator (const Integer &p, const Integer &g)
 Set group parameters. More...
 
bool operator== (const DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP > &rhs) const
 
bool operator!= (const DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP > &rhs) const
 
- Public Member Functions inherited from DL_GroupParametersImpl< GROUP_PRECOMP, DL_FixedBasePrecomputationImpl< typename GROUP_PRECOMP::Element >, DL_GroupParameters_IntegerBased >
const DL_GroupPrecomputation< Element > & GetGroupPrecomputation () const
 Retrieves the group precomputation. More...
 
const DL_FixedBasePrecomputation< Element > & GetBasePrecomputation () const
 Retrieves the group precomputation. More...
 
DL_FixedBasePrecomputation< Element > & AccessBasePrecomputation ()
 Retrieves the group precomputation. More...
 
- Public Member Functions inherited from DL_GroupParameters_IntegerBased
void Initialize (const DL_GroupParameters_IntegerBased &params)
 Initialize a group parameters over integers. More...
 
void Initialize (RandomNumberGenerator &rng, unsigned int pbits)
 Create a group parameters over integers. More...
 
void Initialize (const Integer &p, const Integer &g)
 Initialize a group parameters over integers. More...
 
void Initialize (const Integer &p, const Integer &q, const Integer &g)
 Initialize a group parameters over integers. More...
 
void BERDecode (BufferedTransformation &bt)
 Decode this object from a BufferedTransformation. More...
 
void DEREncode (BufferedTransformation &bt) const
 Encode this object into a BufferedTransformation. More...
 
void GenerateRandom (RandomNumberGenerator &rng, const NameValuePairs &alg)
 Generate a random key. More...
 
const IntegerGetSubgroupOrder () const
 
Integer GetGroupOrder () const
 
bool ValidateGroup (RandomNumberGenerator &rng, unsigned int level) const
 Check the group for errors. More...
 
bool ValidateElement (unsigned int level, const Integer &element, const DL_FixedBasePrecomputation< Integer > *precomp) const
 Check the element for errors. More...
 
bool FastSubgroupCheckAvailable () const
 Determine if subgroup membership check is fast. More...
 
void EncodeElement (bool reversible, const Element &element, byte *encoded) const
 Encodes the element. More...
 
unsigned int GetEncodedElementSize (bool reversible) const
 Retrieve the encoded element's size. More...
 
Integer DecodeElement (const byte *encoded, bool checkForGroupMembership) const
 Decodes the element. More...
 
Integer ConvertElementToInteger (const Element &element) const
 Converts an element to an Integer. More...
 
Integer GetMaxExponent () const
 Retrieve the maximum exponent for the group. More...
 
OID GetAlgorithmID () const
 Retrieve the OID of the algorithm. More...
 
void SetSubgroupOrder (const Integer &q)
 Set subgroup order. More...
 
- Public Member Functions inherited from ASN1CryptoMaterial< DL_GroupParameters< Integer > >
void Save (BufferedTransformation &bt) const
 DER encode ASN.1 object. More...
 
void Load (BufferedTransformation &bt)
 BER decode ASN.1 object. More...
 
- Public Member Functions inherited from ASN1Object
virtual void BEREncode (BufferedTransformation &bt) const
 Encode this object into a BufferedTransformation. More...
 
- Public Member Functions inherited from DL_GroupParameters< Integer >
bool Validate (RandomNumberGenerator &rng, unsigned int level) const
 Check this object for errors. More...
 
bool GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const
 Get a named value. More...
 
bool SupportsPrecomputation () const
 Determines whether the object supports precomputation. More...
 
void Precompute (unsigned int precomputationStorage=16)
 Perform precomputation. More...
 
void LoadPrecomputation (BufferedTransformation &storedPrecomputation)
 Retrieve previously saved precomputation. More...
 
void SavePrecomputation (BufferedTransformation &storedPrecomputation) const
 Save precomputation for later use. More...
 
virtual const ElementGetSubgroupGenerator () const
 Retrieves the subgroup generator. More...
 
virtual void SetSubgroupGenerator (const Element &base)
 Sets the subgroup generator. More...
 
virtual Element ExponentiateBase (const Integer &exponent) const
 Exponentiates the base. More...
 
virtual Element ExponentiateElement (const Element &base, const Integer &exponent) const
 Exponentiates an element. More...
 
virtual const IntegerGetSubgroupOrder () const=0
 Retrieves the subgroup order. More...
 
virtual Integer GetMaxExponent () const=0
 Retrieves the maximum exponent for the group. More...
 
virtual Integer GetGroupOrder () const
 Retrieves the order of the group. More...
 
virtual Integer GetCofactor () const
 Retrieves the cofactor. More...
 
virtual bool FastSubgroupCheckAvailable () const=0
 
virtual bool IsIdentity (const Element &element) const=0
 Determines if an element is an identity. More...
 
virtual void SimultaneousExponentiate (Element *results, const Element &base, const Integer *exponents, unsigned int exponentsCount) const=0
 Exponentiates a base to multiple exponents. More...
 
- Public Member Functions inherited from GeneratableCryptoMaterial
void GenerateRandomWithKeySize (RandomNumberGenerator &rng, unsigned int keySize)
 Generate a random key or crypto parameters. More...
 
- Public Member Functions inherited from CryptoMaterial
virtual void ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const
 Check this object for errors. More...
 
virtual bool SupportsPrecomputation () const
 Determines whether the object supports precomputation. 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...
 
CRYPTOPP_DLL std::string GetValueNames () const
 Get a list of value names that can be retrieved. More...
 
CRYPTOPP_DLL bool GetIntValue (const char *name, int &value) const
 Get a named value with type int. More...
 
CRYPTOPP_DLL int GetIntValueWithDefault (const char *name, int defaultValue) const
 Get a named value with type int, with default. More...
 
CRYPTOPP_DLL bool GetWord64Value (const char *name, word64 &value) const
 Get a named value with type word64. More...
 
CRYPTOPP_DLL word64 GetWord64ValueWithDefault (const char *name, word64 defaultValue) const
 Get a named value with type word64, with default. More...
 
template<class T >
void GetRequiredParameter (const char *className, const char *name, T &value) const
 Retrieves a required name/value pair. More...
 
CRYPTOPP_DLL void GetRequiredIntParameter (const char *className, const char *name, int &value) const
 Retrieves a required name/value pair. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DL_GroupParameters_IntegerBased
static std::string CRYPTOPP_API StaticAlgorithmNamePrefix ()
 
- Static Public Member Functions inherited from NameValuePairs
static CRYPTOPP_DLL void CRYPTOPP_API 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

template<class GROUP_PRECOMP, class BASE_PRECOMP = DL_FixedBasePrecomputationImpl<typename GROUP_PRECOMP::Element>>
class DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >

Integer-based GroupParameters default implementation.

Template Parameters
GROUP_PRECOMPgroup parameters precomputation specialization
BASE_PRECOMPbase class precomputation specialization

Definition at line 182 of file gfpcrypt.h.

Member Function Documentation

◆ GetVoidValue()

template<class GROUP_PRECOMP , class BASE_PRECOMP = DL_FixedBasePrecomputationImpl<typename GROUP_PRECOMP::Element>>
bool DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >::GetVoidValue ( const char *  name,
const std::type_info &  valueType,
void *  pValue 
) const
inlinevirtual

Get a named value.

Parameters
namethe name of the object or value to retrieve
valueTypereference to a variable that receives the value
pValuevoid pointer to a variable that receives the value
Returns
true if the value was retrieved, false otherwise

GetVoidValue() retrieves the value of name if it exists.

Note
GetVoidValue() is an internal function and should be implemented by derived classes. Users should use one of the other functions instead.
See also
GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()

Reimplemented from DL_GroupParameters_IntegerBased.

Definition at line 192 of file gfpcrypt.h.

◆ AssignFrom()

template<class GROUP_PRECOMP , class BASE_PRECOMP = DL_FixedBasePrecomputationImpl<typename GROUP_PRECOMP::Element>>
void DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >::AssignFrom ( const NameValuePairs source)
inlinevirtual

Initialize or reinitialize this key.

Parameters
sourceNameValuePairs to assign

Reimplemented from DL_GroupParameters_IntegerBased.

Definition at line 195 of file gfpcrypt.h.

◆ AccessBasePrecomputation()

template<class GROUP_PRECOMP , class BASE_PRECOMP = DL_FixedBasePrecomputationImpl<typename GROUP_PRECOMP::Element>>
DL_FixedBasePrecomputation<Element>& DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >::AccessBasePrecomputation ( )
inlinevirtual

Retrieves the group precomputation.

Returns
a non-const reference to the group precomputation using a fixed base

Implements DL_GroupParameters< Integer >.

Definition at line 200 of file gfpcrypt.h.

◆ GetModulus()

template<class GROUP_PRECOMP , class BASE_PRECOMP = DL_FixedBasePrecomputationImpl<typename GROUP_PRECOMP::Element>>
const Integer& DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >::GetModulus ( ) const
inlinevirtual

Retrieve the modulus for the group.

Returns
the modulus for the group

Implements DL_GroupParameters_IntegerBased.

Definition at line 205 of file gfpcrypt.h.

◆ GetGenerator()

template<class GROUP_PRECOMP , class BASE_PRECOMP = DL_FixedBasePrecomputationImpl<typename GROUP_PRECOMP::Element>>
const Integer& DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >::GetGenerator ( ) const
inline

Retrieves a reference to the group generator.

Returns
const reference to the group generator

Definition at line 209 of file gfpcrypt.h.

◆ SetModulusAndSubgroupGenerator()

template<class GROUP_PRECOMP , class BASE_PRECOMP = DL_FixedBasePrecomputationImpl<typename GROUP_PRECOMP::Element>>
void DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >::SetModulusAndSubgroupGenerator ( const Integer p,
const Integer g 
)
inlinevirtual

Set group parameters.

Parameters
pthe prime modulus
gthe group generator

Implements DL_GroupParameters_IntegerBased.

Definition at line 211 of file gfpcrypt.h.


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