Security Scol plugin
Public Member Functions | Protected Member Functions | List of all members
DL_GroupParameters_GFP Class Reference

GF(p) group parameters. More...

#include <gfpcrypt.h>

Inheritance diagram for DL_GroupParameters_GFP:
DL_GroupParameters_IntegerBasedImpl< ModExpPrecomputation > DL_GroupParametersImpl< GROUP_PRECOMP, BASE_PRECOMP, BASE > DL_GroupParameters< T > CryptoParameters GeneratableCryptoMaterial CryptoMaterial NameValuePairs DL_GroupParameters_DSA DL_GroupParameters_GFP_DefaultSafePrime DL_GroupParameters_ElGamal

Public Member Functions

bool IsIdentity (const Integer &element) const
 Determines if an element is an identity.
 
void SimultaneousExponentiate (Element *results, const Element &base, const Integer *exponents, unsigned int exponentsCount) const
 Exponentiates a base to multiple exponents.
 
bool GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const
 Get a named value.
 
Element MultiplyElements (const Element &a, const Element &b) const
 
Element CascadeExponentiate (const Element &element1, const Integer &exponent1, const Element &element2, const Integer &exponent2) const
 
- Public Member Functions inherited from DL_GroupParameters_IntegerBasedImpl< ModExpPrecomputation >
bool GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const
 Get a named value.
 
void AssignFrom (const NameValuePairs &source)
 Assign values to this object.
 
const DL_FixedBasePrecomputation< Element > & GetBasePrecomputation () const
 Retrieves the group precomputation.
 
DL_FixedBasePrecomputation< Element > & AccessBasePrecomputation ()
 Retrieves the group precomputation.
 
const IntegerGetModulus () const
 Retrieve the modulus for the group.
 
const IntegerGetGenerator () const
 Retrieves a reference to the group generator.
 
void SetModulusAndSubgroupGenerator (const Integer &p, const Integer &g)
 
bool operator== (const DL_GroupParameters_IntegerBasedImpl< ModExpPrecomputation, DL_FixedBasePrecomputationImpl< typename GROUP_PRECOMP::Element > > &rhs) const
 
bool operator!= (const DL_GroupParameters_IntegerBasedImpl< ModExpPrecomputation, DL_FixedBasePrecomputationImpl< typename GROUP_PRECOMP::Element > > &rhs) const
 
- Public Member Functions inherited from DL_GroupParametersImpl< GROUP_PRECOMP, BASE_PRECOMP, BASE >
const DL_GroupPrecomputation< Element > & GetGroupPrecomputation () const
 Retrieves the group precomputation.
 
const DL_FixedBasePrecomputation< Element > & GetBasePrecomputation () const
 Retrieves the group precomputation.
 
DL_FixedBasePrecomputation< Element > & AccessBasePrecomputation ()
 Retrieves the group precomputation.
 
- Public Member Functions inherited from DL_GroupParameters< T >
bool Validate (RandomNumberGenerator &rng, unsigned int level) const
 Check this object for errors.
 
bool SupportsPrecomputation () const
 Determines whether the object supports precomputation.
 
void Precompute (unsigned int precomputationStorage=16)
 Perform precomputation.
 
void LoadPrecomputation (BufferedTransformation &storedPrecomputation)
 Retrieve previously saved precomputation.
 
void SavePrecomputation (BufferedTransformation &storedPrecomputation) const
 Save precomputation for later use.
 
virtual const Element & GetSubgroupGenerator () const
 Retrieves the subgroup generator.
 
virtual void SetSubgroupGenerator (const Element &base)
 Sets the subgroup generator.
 
virtual Element ExponentiateBase (const Integer &exponent) const
 Exponentiates the base.
 
virtual Element ExponentiateElement (const Element &base, const Integer &exponent) const
 Exponentiates an element.
 
virtual const IntegerGetSubgroupOrder () const =0
 Retrieves the subgroup order.
 
virtual Integer GetMaxExponent () const =0
 Retrieves the maximum exponent for the group.
 
virtual Integer GetGroupOrder () const
 Retrieves the order of the group.
 
virtual Integer GetCofactor () const
 Retrieves the cofactor.
 
virtual unsigned int GetEncodedElementSize (bool reversible) const =0
 Retrieves the encoded element's size.
 
virtual void EncodeElement (bool reversible, const Element &element, byte *encoded) const =0
 Encodes the element.
 
virtual Element DecodeElement (const byte *encoded, bool checkForGroupMembership) const =0
 Decodes the element.
 
virtual Integer ConvertElementToInteger (const Element &element) const =0
 Converts an element to an Integer.
 
virtual bool ValidateGroup (RandomNumberGenerator &rng, unsigned int level) const =0
 Check the group for errors.
 
virtual bool ValidateElement (unsigned int level, const Element &element, const DL_FixedBasePrecomputation< Element > *precomp) const =0
 Check the element for errors.
 
virtual bool FastSubgroupCheckAvailable () const =0
 
virtual bool IsIdentity (const Element &element) const =0
 Determines if an element is an identity.
 
virtual void SimultaneousExponentiate (Element *results, const Element &base, const Integer *exponents, unsigned int exponentsCount) const =0
 Exponentiates a base to multiple exponents.
 
- Public Member Functions inherited from GeneratableCryptoMaterial
virtual void GenerateRandom (RandomNumberGenerator &rng, const NameValuePairs &params=g_nullNameValuePairs)
 Generate a random key or crypto parameters.
 
void GenerateRandomWithKeySize (RandomNumberGenerator &rng, unsigned int keySize)
 Generate a random key or crypto parameters.
 
- Public Member Functions inherited from CryptoMaterial
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.
 
void DoQuickSanityCheck () const
 Perform a quick sanity check.
 
- Public Member Functions inherited from NameValuePairs
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 >
GetValueWithDefault (const char *name, T defaultValue) const
 Get a named value.
 
CRYPTOPP_DLL std::string GetValueNames () const
 Get a list of value names that can be retrieved.
 
CRYPTOPP_DLL bool GetIntValue (const char *name, int &value) const
 Get a named value with type int.
 
CRYPTOPP_DLL int GetIntValueWithDefault (const char *name, int defaultValue) const
 Get a named value with type int, with default.
 
CRYPTOPP_DLL bool GetWord64Value (const char *name, word64 &value) const
 Get a named value with type word64.
 
CRYPTOPP_DLL word64 GetWord64ValueWithDefault (const char *name, word64 defaultValue) const
 Get a named value with type word64, with default.
 
template<class T >
void GetRequiredParameter (const char *className, const char *name, T &value) const
 Retrieves a required name/value pair.
 
CRYPTOPP_DLL void GetRequiredIntParameter (const char *className, const char *name, int &value) const
 Retrieves a required name/value pair.
 

Protected Member Functions

int GetFieldType () const
 
- Protected Member Functions inherited from DL_GroupParameters< T >
void ParametersChanged ()
 

Additional Inherited Members

- Public Types inherited from DL_GroupParameters_IntegerBasedImpl< ModExpPrecomputation >
typedef GROUP_PRECOMP::Element Element
 
- Public Types inherited from DL_GroupParametersImpl< GROUP_PRECOMP, BASE_PRECOMP, BASE >
typedef GROUP_PRECOMP GroupPrecomputation
 
typedef GROUP_PRECOMP::Element Element
 
typedef BASE_PRECOMP BasePrecomputation
 
- Public Types inherited from DL_GroupParameters< T >
typedef T Element
 
- 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.
 
- Protected Attributes inherited from DL_GroupParametersImpl< GROUP_PRECOMP, BASE_PRECOMP, BASE >
GROUP_PRECOMP m_groupPrecomputation
 
BASE_PRECOMP m_gpc
 

Detailed Description

GF(p) group parameters.

Definition at line 224 of file gfpcrypt.h.

Constructor & Destructor Documentation

◆ ~DL_GroupParameters_GFP()

virtual DL_GroupParameters_GFP::~DL_GroupParameters_GFP ( )
inlinevirtual

Definition at line 227 of file gfpcrypt.h.

Member Function Documentation

◆ CascadeExponentiate()

DL_GroupParameters_GFP::Element DL_GroupParameters_GFP::CascadeExponentiate ( const Element &  element1,
const Integer exponent1,
const Element &  element2,
const Integer exponent2 
) const

Definition at line 316 of file gfpcrypt.cpp.

◆ GetFieldType()

int DL_GroupParameters_GFP::GetFieldType ( ) const
inlineprotected

Definition at line 270 of file gfpcrypt.h.

◆ GetVoidValue()

bool DL_GroupParameters_GFP::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< T >.

Definition at line 260 of file gfpcrypt.h.

◆ IsIdentity()

bool DL_GroupParameters_GFP::IsIdentity ( const Integer element) const
inline

Determines if an element is an identity.

Parameters
elementelement to check
Returns
true if the element is an identity, false otherwise

The identity element or or neutral element is a special element in a group that leaves other elements unchanged when combined with it.

IsIdentity() must be implemented in a derived class.

Definition at line 235 of file gfpcrypt.h.

◆ MultiplyElements()

DL_GroupParameters_GFP::Element DL_GroupParameters_GFP::MultiplyElements ( const Element &  a,
const Element &  b 
) const

Definition at line 311 of file gfpcrypt.cpp.

◆ SimultaneousExponentiate()

void DL_GroupParameters_GFP::SimultaneousExponentiate ( Element *  results,
const Element &  base,
const Integer exponents,
unsigned int  exponentsCount 
) const

Exponentiates a base to multiple exponents.

Parameters
resultsan array of Elements
basethe base to raise to the exponents
exponentsan array of exponents
exponentsCountthe number of exponents in the array

SimultaneousExponentiate() raises the base to each exponent in the exponents array and stores the result at the respective position in the results array.

SimultaneousExponentiate() must be implemented in a derived class.

Precondition
COUNTOF(results) == exponentsCount
COUNTOF(exponents) == exponentsCount

Definition at line 305 of file gfpcrypt.cpp.


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