RSA trapdoor function using the public key. More...

#include <rsa.h>

Inheritance diagram for RSAFunction:

Public Member Functions
void	Initialize (const Integer &n, const Integer &e)
	Initialize a RSA public key. More...

OID	GetAlgorithmID () const
	Retrieves the OID of the algorithm. More...

void	BERDecodePublicKey (BufferedTransformation &bt, bool parametersPresent, size_t size)
	Decode subjectPublicKey part of subjectPublicKeyInfo. More...

void	DEREncodePublicKey (BufferedTransformation &bt) const
	Encode subjectPublicKey part of subjectPublicKeyInfo. More...

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...

void	AssignFrom (const NameValuePairs &source)
	Assign values to this object. More...

Integer	ApplyFunction (const Integer &x) const
	Applies the trapdoor. More...

Integer	PreimageBound () const
	Returns the maximum size of a message before the trapdoor function is applied. More...

Integer	ImageBound () const
	Returns the maximum size of a representation after the trapdoor function is applied. More...

const Integer &	GetModulus () const

const Integer &	GetPublicExponent () const

void	SetModulus (const Integer &n)

void	SetPublicExponent (const Integer &e)

Public Member Functions inherited from TrapdoorFunction
Integer	ApplyRandomizedFunction (RandomNumberGenerator &rng, const Integer &x) const
	Applies the trapdoor function. More...

bool	IsRandomized () const
	Determines if the encryption algorithm is randomized. More...

virtual Integer	ApplyFunction (const Integer &x) const =0
	Applies the trapdoor. More...

virtual Integer	ApplyRandomizedFunction (RandomNumberGenerator &rng, const Integer &x) const =0
	Applies the trapdoor function, using random data if required. More...

virtual bool	IsRandomized () const
	Determines if the encryption algorithm is randomized. More...

Public Member Functions inherited from TrapdoorFunctionBounds
virtual Integer	PreimageBound () const =0
	Returns the maximum size of a message before the trapdoor function is applied. More...

virtual Integer	ImageBound () const =0
	Returns the maximum size of a representation after the trapdoor function is applied. More...

virtual Integer	MaxPreimage () const
	Returns the maximum size of a message before the trapdoor function is applied bound to a public key. More...

virtual Integer	MaxImage () const
	Returns the maximum size of a representation after the trapdoor function is applied bound to a public key. More...

Public Member Functions inherited from X509PublicKey
void	BERDecode (BufferedTransformation &bt)
	Decode this object from a BufferedTransformation. More...

void	DEREncode (BufferedTransformation &bt) const
	Encode this object into a BufferedTransformation. More...

virtual OID	GetAlgorithmID () const =0
	Retrieves the OID of the algorithm. More...

virtual bool	BERDecodeAlgorithmParameters (BufferedTransformation &bt)
	Decode algorithm parameters. More...

virtual bool	DEREncodeAlgorithmParameters (BufferedTransformation &bt) const
	Encode algorithm parameters. More...

virtual void	BERDecodePublicKey (BufferedTransformation &bt, bool parametersPresent, size_t size)=0
	Decode subjectPublicKey part of subjectPublicKeyInfo. More...

virtual void	DEREncodePublicKey (BufferedTransformation &bt) const =0
	Encode subjectPublicKey part of subjectPublicKeyInfo. More...

Public Member Functions inherited from ASN1CryptoMaterial< PublicKey >
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	BERDecode (BufferedTransformation &bt)=0
	Decode this object from a BufferedTransformation. More...

virtual void	DEREncode (BufferedTransformation &bt) const =0
	Encode this object into a BufferedTransformation. More...

virtual void	BEREncode (BufferedTransformation &bt) const
	Encode this object into a BufferedTransformation. More...

Public Member Functions inherited from CryptoMaterial
virtual void	AssignFrom (const NameValuePairs &source)=0
	Assign values to this object. More...

virtual bool	Validate (RandomNumberGenerator &rng, unsigned int level) const =0
	Check this object for errors. More...

virtual void	ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const
	Check this object for errors. More...

virtual void	Save (BufferedTransformation &bt) const
	Saves a key to a BufferedTransformation. More...

virtual void	Load (BufferedTransformation &bt)
	Loads a key from a BufferedTransformation. More...

virtual bool	SupportsPrecomputation () const
	Determines whether the object supports precomputation. More...

virtual void	Precompute (unsigned int precomputationStorage)
	Perform precomputation. More...

virtual void	LoadPrecomputation (BufferedTransformation &storedPrecomputation)
	Retrieve previously saved precomputation. More...

virtual void	SavePrecomputation (BufferedTransformation &storedPrecomputation) const
	Save precomputation for later use. 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 >
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...

virtual CRYPTOPP_DLL bool	GetVoidValue (const char name, const std::type_info &valueType, void pValue) const =0
	Get a named value. More...

Additional Inherited Members
Static Public Member Functions inherited from NameValuePairs
static CRYPTOPP_DLL void	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

RSA trapdoor function using the public key.

Since: Crypto++ 1.0

Definition at line 23 of file rsa.h.

Member Function Documentation

◆ Initialize()

void RSAFunction::Initialize	(	const Integer &	n,
		const Integer &	e
	)

inline

Initialize a RSA public key.

Parameters

n	the modulus
e	the public exponent

Definition at line 31 of file rsa.h.

◆ GetAlgorithmID()

OID RSAFunction::GetAlgorithmID ( ) const

virtual

Retrieves the OID of the algorithm.

Returns: OID of the algorithm

Implements X509PublicKey.

Reimplemented in InvertibleRSAFunction.

◆ BERDecodePublicKey()

void RSAFunction::BERDecodePublicKey	(	BufferedTransformation &	bt,
		bool	parametersPresent,
		size_t	size
	)

virtual

Decode subjectPublicKey part of subjectPublicKeyInfo.

Parameters

bt	BufferedTransformation object
parametersPresent	flag indicating if algorithm parameters are present
size	number of octets to read for the parameters, in bytes

BERDecodePublicKey() the decodes subjectPublicKey part of subjectPublicKeyInfo, without the BIT STRING header.

When parametersPresent = true then BERDecodePublicKey() calls BERDecodeAlgorithmParameters() to parse algorithm parameters.

See also: BERDecodeAlgorithmParameters

Implements X509PublicKey.

◆ DEREncodePublicKey()

void RSAFunction::DEREncodePublicKey ( BufferedTransformation & bt ) const

virtual

Encode subjectPublicKey part of subjectPublicKeyInfo.

Parameters

bt	BufferedTransformation object

DEREncodePublicKey() encodes the subjectPublicKey part of subjectPublicKeyInfo, without the BIT STRING header.

See also: DEREncodeAlgorithmParameters

Implements X509PublicKey.

◆ Validate()

bool RSAFunction::Validate	(	RandomNumberGenerator &	rng,
		unsigned int	level
	)		const

virtual

Check this object for errors.

Parameters

rng	a RandomNumberGenerator for objects which use randomized testing
level	the level of thoroughness

Returns: true if the tests succeed, false otherwise

There are four levels of thoroughness:

0 - using this object won't cause a crash or exception
1 - this object will probably function, and encrypt, sign, other operations correctly
2 - ensure this object will function correctly, and perform reasonable security checks
3 - perform reasonable security checks, and do checks that may take a long time

Level 0 does not require a RandomNumberGenerator. A NullRNG() can be used for level 0. Level 1 may not check for weak keys and such. Levels 2 and 3 are recommended.

See also: ThrowIfInvalid()

Implements CryptoMaterial.

Reimplemented in InvertibleRSAFunction.

◆ GetVoidValue()

bool RSAFunction::GetVoidValue	(	const char *	name,
		const std::type_info &	valueType,
		void *	pValue
	)		const

virtual

Get a named value.

Parameters

name	the name of the object or value to retrieve
valueType	reference to a variable that receives the value
pValue	void 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()

Implements NameValuePairs.

Reimplemented in InvertibleRSAFunction.

◆ AssignFrom()

void RSAFunction::AssignFrom ( const NameValuePairs & source )

virtual

Assign values to this object.

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

Implements CryptoMaterial.

Reimplemented in InvertibleRSAFunction.

◆ ApplyFunction()

Integer RSAFunction::ApplyFunction ( const Integer & x ) const

virtual

Applies the trapdoor.

Parameters

x	the message on which the encryption function is applied

Returns: the message x encrypted under the public key

ApplyFunction is a generalization of encryption under a public key cryptosystem. Derived classes must implement it.

Implements TrapdoorFunction.

Reimplemented in RSAFunction_ISO.

◆ PreimageBound()

Integer RSAFunction::PreimageBound ( ) const

inlinevirtual

Returns the maximum size of a message before the trapdoor function is applied.

Returns: the maximum size of a message before the trapdoor function is applied

Derived classes must implement PreimageBound().

Implements TrapdoorFunctionBounds.

Reimplemented in RSAFunction_ISO, and InvertibleRSAFunction_ISO.

Definition at line 46 of file rsa.h.

◆ ImageBound()

Integer RSAFunction::ImageBound ( ) const

inlinevirtual

Returns the maximum size of a representation after the trapdoor function is applied.

Returns: the maximum size of a representation after the trapdoor function is applied

Derived classes must implement ImageBound().

Implements TrapdoorFunctionBounds.

Definition at line 47 of file rsa.h.

◆ GetModulus()

const Integer & RSAFunction::GetModulus ( ) const

inline

Definition at line 50 of file rsa.h.

◆ GetPublicExponent()

const Integer & RSAFunction::GetPublicExponent ( ) const

inline

Definition at line 51 of file rsa.h.

◆ SetModulus()

void RSAFunction::SetModulus ( const Integer & n )

inline

Definition at line 53 of file rsa.h.

◆ SetPublicExponent()

void RSAFunction::SetPublicExponent ( const Integer & e )

inline

Definition at line 54 of file rsa.h.

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

rsa.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Initialize()

◆ GetAlgorithmID()

◆ BERDecodePublicKey()

◆ DEREncodePublicKey()

◆ Validate()

◆ GetVoidValue()

◆ AssignFrom()

◆ ApplyFunction()

◆ PreimageBound()

◆ ImageBound()

◆ GetModulus()

◆ GetPublicExponent()

◆ SetModulus()

◆ SetPublicExponent()