Crypto++
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
RabinFunction Class Reference

_ More...

#include <rabin.h>

Inheritance diagram for RabinFunction:
TrapdoorFunction PublicKey RandomizedTrapdoorFunction CryptoMaterial TrapdoorFunctionBounds NameValuePairs InvertibleRabinFunction

Public Member Functions

void Initialize (const Integer &n, const Integer &r, const Integer &s)
 
void BERDecode (BufferedTransformation &bt)
 
void DEREncode (BufferedTransformation &bt) const
 
Integer ApplyFunction (const Integer &x) const
 
Integer PreimageBound () const
 
Integer ImageBound () const
 
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
 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 More...
 
const IntegerGetModulus () const
 
const IntegerGetQuadraticResidueModPrime1 () const
 
const IntegerGetQuadraticResidueModPrime2 () const
 
void SetModulus (const Integer &n)
 
void SetQuadraticResidueModPrime1 (const Integer &r)
 
void SetQuadraticResidueModPrime2 (const Integer &s)
 
Integer ApplyRandomizedFunction (RandomNumberGenerator &rng, const Integer &x) const
 
bool IsRandomized () const
 
virtual Integer MaxPreimage () const
 
virtual Integer MaxImage () const
 
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 More...
 
virtual bool SupportsPrecomputation () const
 
virtual void Precompute (unsigned int n)
 do precomputation More...
 
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 >
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 More...
 
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
 

Protected Attributes

Integer m_n
 
Integer m_r
 
Integer m_s
 

Detailed Description

_

Definition at line 14 of file rabin.h.

Member Function Documentation

bool RabinFunction::Validate ( RandomNumberGenerator rng,
unsigned int  level 
) const
virtual

check this object for errors

Parameters
leveldenotes 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
Returns
true if the tests pass

Implements CryptoMaterial.

Reimplemented in InvertibleRabinFunction.

void RabinFunction::AssignFrom ( const NameValuePairs source)
virtual

assign values from source to this object

Note
This function can be used to create a public key from a private key.

Implements CryptoMaterial.

Reimplemented in InvertibleRabinFunction.

virtual void CryptoMaterial::Load ( BufferedTransformation bt)
inlinevirtualinherited

load key from a BufferedTransformation

Exceptions
KeyingErrif decode fails
Note
Generally does not check that the key is valid. Call ValidateKey() or ThrowIfInvalidKey() to check that.

Reimplemented in InvertibleRSAFunction.

Definition at line 1071 of file cryptlib.h.

virtual bool CryptoMaterial::SupportsPrecomputation ( ) const
inlinevirtualinherited
virtual void CryptoMaterial::Precompute ( unsigned int  n)
inlinevirtualinherited

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_PublicKeyImpl< GP >, DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >, DL_PrivateKeyImpl< GP >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, DL_GroupParameters< T >, and DL_GroupParameters< Integer >.

Definition at line 1080 of file cryptlib.h.

bool NameValuePairs::GetIntValue ( const char *  name,
int &  value 
) const
inlineinherited

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.


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