rsa.h
Go to the documentation of this file.
// rsa.h - written and placed in the public domain by Wei Dai
//! \file rsa.h
//! \brief Classes for the RSA cryptosystem
//! \details This file contains classes that implement the RSA
//! ciphers and signature schemes as defined in PKCS #1 v2.0.
#ifndef CRYPTOPP_RSA_H
#define CRYPTOPP_RSA_H
#include "cryptlib.h"
#include "pubkey.h"
#include "integer.h"
#include "pkcspad.h"
#include "oaep.h"
#include "emsa2.h"
#include "asn.h"
NAMESPACE_BEGIN(CryptoPP)
//! \class RSAFunction
//! \brief RSA trapdoor function using the public key
class CRYPTOPP_DLL RSAFunction : public TrapdoorFunction, public X509PublicKey
{
typedef RSAFunction ThisClass;
public:
//! \brief Initialize a RSA public key with {n,e}
//! \param n the modulus
//! \param e the public exponent
void Initialize(const Integer &n, const Integer &e)
{m_n = n; m_e = e;}
// X509PublicKey
OID GetAlgorithmID() const;
void BERDecodePublicKey(BufferedTransformation &bt, bool parametersPresent, size_t size);
void DEREncodePublicKey(BufferedTransformation &bt) const;
// CryptoMaterial
bool Validate(RandomNumberGenerator &rng, unsigned int level) const;
bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const;
void AssignFrom(const NameValuePairs &source);
// TrapdoorFunction
Integer ApplyFunction(const Integer &x) const;
Integer PreimageBound() const {return m_n;}
Integer ImageBound() const {return m_n;}
// non-derived
const Integer & GetModulus() const {return m_n;}
const Integer & GetPublicExponent() const {return m_e;}
void SetModulus(const Integer &n) {m_n = n;}
void SetPublicExponent(const Integer &e) {m_e = e;}
protected:
Integer m_n, m_e;
};
//! \class InvertibleRSAFunction
//! \brief RSA trapdoor function using the private key
class CRYPTOPP_DLL InvertibleRSAFunction : public RSAFunction, public TrapdoorFunctionInverse, public PKCS8PrivateKey
{
typedef InvertibleRSAFunction ThisClass;
public:
//! \brief Create a RSA private key
//! \param rng a RandomNumberGenerator derived class
//! \param modulusBits the size of the modulud, in bits
//! \param e the desired public exponent
void Initialize(RandomNumberGenerator &rng, unsigned int modulusBits, const Integer &e = 17);
//! \brief Initialize a RSA private key with {n,e,d,p,q,dp,dq,u}
//! \param n modulus
//! \param e public exponent
//! \param d private exponent
//! \param p first prime factor
//! \param q second prime factor
//! \param dp d mod p
//! \param dq d mod q
//! \param u q<sup>-1</sup> mod p
void Initialize(const Integer &n, const Integer &e, const Integer &d, const Integer &p, const Integer &q, const Integer &dp, const Integer &dq, const Integer &u)
{m_n = n; m_e = e; m_d = d; m_p = p; m_q = q; m_dp = dp; m_dq = dq; m_u = u;}
//! \brief Initialize a RSA private key with {n,e,d}
//! \param n modulus
//! \param e public exponent
//! \param d private exponent
//! \details Initialize() will factor n using d and populate {p,q,dp,dq,u}.
void Initialize(const Integer &n, const Integer &e, const Integer &d);
// PKCS8PrivateKey
void BERDecode(BufferedTransformation &bt)
{PKCS8PrivateKey::BERDecode(bt);}
void DEREncode(BufferedTransformation &bt) const
{PKCS8PrivateKey::DEREncode(bt);}
void Load(BufferedTransformation &bt)
{PKCS8PrivateKey::BERDecode(bt);}
void Save(BufferedTransformation &bt) const
{PKCS8PrivateKey::DEREncode(bt);}
OID GetAlgorithmID() const {return RSAFunction::GetAlgorithmID();}
void BERDecodePrivateKey(BufferedTransformation &bt, bool parametersPresent, size_t size);
void DEREncodePrivateKey(BufferedTransformation &bt) const;
// TrapdoorFunctionInverse
Integer CalculateInverse(RandomNumberGenerator &rng, const Integer &x) const;
// GeneratableCryptoMaterial
bool Validate(RandomNumberGenerator &rng, unsigned int level) const;
/*! parameters: (ModulusSize, PublicExponent (default 17)) */
void GenerateRandom(RandomNumberGenerator &rng, const NameValuePairs &alg);
bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const;
void AssignFrom(const NameValuePairs &source);
// non-derived interface
const Integer& GetPrime1() const {return m_p;}
const Integer& GetPrime2() const {return m_q;}
const Integer& GetPrivateExponent() const {return m_d;}
const Integer& GetModPrime1PrivateExponent() const {return m_dp;}
const Integer& GetModPrime2PrivateExponent() const {return m_dq;}
const Integer& GetMultiplicativeInverseOfPrime2ModPrime1() const {return m_u;}
void SetPrime1(const Integer &p) {m_p = p;}
void SetPrime2(const Integer &q) {m_q = q;}
void SetPrivateExponent(const Integer &d) {m_d = d;}
void SetModPrime1PrivateExponent(const Integer &dp) {m_dp = dp;}
void SetModPrime2PrivateExponent(const Integer &dq) {m_dq = dq;}
void SetMultiplicativeInverseOfPrime2ModPrime1(const Integer &u) {m_u = u;}
protected:
Integer m_d, m_p, m_q, m_dp, m_dq, m_u;
};
//! \class RSAFunction_ISO
//! \brief RSA trapdoor function using the public key
class CRYPTOPP_DLL RSAFunction_ISO : public RSAFunction
{
public:
Integer ApplyFunction(const Integer &x) const;
Integer PreimageBound() const {return ++(m_n>>1);}
};
//! \class InvertibleRSAFunction_ISO
//! \brief RSA trapdoor function using the private key
class CRYPTOPP_DLL InvertibleRSAFunction_ISO : public InvertibleRSAFunction
{
public:
Integer CalculateInverse(RandomNumberGenerator &rng, const Integer &x) const;
Integer PreimageBound() const {return ++(m_n>>1);}
};
//! \class RSA
//! \brief RSA algorithm
struct CRYPTOPP_DLL RSA
{
CRYPTOPP_CONSTEXPR static const char * CRYPTOPP_API StaticAlgorithmName() {return "RSA";}
typedef RSAFunction PublicKey;
typedef InvertibleRSAFunction PrivateKey;
};
//! \class RSAES
//! \brief RSA encryption algorithm
//! \tparam STANDARD signature standard
//! \sa <a href="http://www.weidai.com/scan-mirror/ca.html#RSA">RSA cryptosystem</a>
template <class STANDARD>
struct RSAES : public TF_ES<STANDARD, RSA>
{
};
//! \class RSASS
//! \brief RSA signature algorithm
//! \tparam STANDARD signature standard
//! \tparam H hash transformation
//! \details See documentation of PKCS1v15 for a list of hash functions that can be used with it.
//! \sa <a href="http://www.weidai.com/scan-mirror/sig.html#RSA">RSA signature scheme with appendix</a>
template <class STANDARD, class H>
struct RSASS : public TF_SS<STANDARD, H, RSA>
{
};
//! \class RSA_ISO
//! \brief RSA algorithm
struct CRYPTOPP_DLL RSA_ISO
{
CRYPTOPP_CONSTEXPR static const char * CRYPTOPP_API StaticAlgorithmName() {return "RSA-ISO";}
typedef RSAFunction_ISO PublicKey;
typedef InvertibleRSAFunction_ISO PrivateKey;
};
//! \class RSASS_ISO
//! \brief RSA signature algorithm
//! \tparam H hash transformation
template <class H>
struct RSASS_ISO : public TF_SS<P1363_EMSA2, H, RSA_ISO>
{
};
//! \brief \ref RSAES<STANDARD> "RSAES<PKCS1v15>::Decryptor" typedef
//! \details RSA encryption scheme defined in PKCS #1 v2.0
DOCUMENTED_TYPEDEF(RSAES<PKCS1v15>::Decryptor, RSAES_PKCS1v15_Decryptor);
//! \brief \ref RSAES<STANDARD> "RSAES<PKCS1v15>::Encryptor" typedef
//! \details RSA encryption scheme defined in PKCS #1 v2.0
DOCUMENTED_TYPEDEF(RSAES<PKCS1v15>::Encryptor, RSAES_PKCS1v15_Encryptor);
//! \brief \ref RSAES<STANDARD> "RSAES<OAEP<SHA>>::Decryptor" typedef
//! \details RSA encryption scheme defined in PKCS #1 v2.0
DOCUMENTED_TYPEDEF(RSAES<OAEP<SHA> >::Decryptor, RSAES_OAEP_SHA_Decryptor);
//! \brief \ref RSAES<STANDARD> "RSAES<OAEP<SHA>>::Encryptor" typedef
//! \details RSA encryption scheme defined in PKCS #1 v2.0
DOCUMENTED_TYPEDEF(RSAES<OAEP<SHA> >::Encryptor, RSAES_OAEP_SHA_Encryptor);
#ifdef CRYPTOPP_DOXYGEN_PROCESSING
//! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15,SHA>::Signer" typedef
//! \details RSA signature schemes defined in PKCS #1 v2.0
class RSASSA_PKCS1v15_SHA_Signer : public RSASS<PKCS1v15,SHA>::Signer {};
//! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15,SHA>::Verifier" typedef
//! \details RSA signature schemes defined in PKCS #1 v2.0
class RSASSA_PKCS1v15_SHA_Verifier : public RSASS<PKCS1v15,SHA>::Verifier {};
namespace Weak {
//! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD2>::Signer" typedef
//! \details RSA signature schemes defined in PKCS #1 v2.0
class RSASSA_PKCS1v15_MD2_Signer : public RSASS<PKCS1v15, Weak1::MD2>::Signer {};
//! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD2>::Verifier" typedef
//! \details RSA signature schemes defined in PKCS #1 v2.0
class RSASSA_PKCS1v15_MD2_Verifier : public RSASS<PKCS1v15, Weak1::MD2>::Verifier {};
//! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD5>::Signer" typedef
//! \details RSA signature schemes defined in PKCS #1 v2.0
class RSASSA_PKCS1v15_MD5_Signer : public RSASS<PKCS1v15, Weak1::MD5>::Signer {};
//! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD5>::Verifier" typedef
//! \details RSA signature schemes defined in PKCS #1 v2.0
class RSASSA_PKCS1v15_MD5_Verifier : public RSASS<PKCS1v15, Weak1::MD5>::Verifier {};
}
#else
typedef RSASS<PKCS1v15,SHA>::Signer RSASSA_PKCS1v15_SHA_Signer;
typedef RSASS<PKCS1v15,SHA>::Verifier RSASSA_PKCS1v15_SHA_Verifier;
namespace Weak {
typedef RSASS<PKCS1v15, Weak1::MD2>::Signer RSASSA_PKCS1v15_MD2_Signer;
typedef RSASS<PKCS1v15, Weak1::MD2>::Verifier RSASSA_PKCS1v15_MD2_Verifier;
typedef RSASS<PKCS1v15, Weak1::MD5>::Signer RSASSA_PKCS1v15_MD5_Signer;
typedef RSASS<PKCS1v15, Weak1::MD5>::Verifier RSASSA_PKCS1v15_MD5_Verifier;
}
#endif // CRYPTOPP_DOXYGEN_PROCESSING
NAMESPACE_END
#endif
CryptoMaterial::AssignFrom
virtual void AssignFrom(const NameValuePairs &source)=0
Assign values to this object.
RSAES_PKCS1v15_Encryptor
RSAES<PKCS1v15>::Encryptor typedef
Definition: rsa.h:202
PKCS8PrivateKey::BERDecodePrivateKey
virtual void BERDecodePrivateKey(BufferedTransformation &bt, bool parametersPresent, size_t size)=0
decode privateKey part of privateKeyInfo, without the OCTET STRING header
InvertibleRSAFunction::Load
void Load(BufferedTransformation &bt)
Loads a key from a BufferedTransformation.
Definition: rsa.h:96
TF_ES
Trapdoor Function (TF) encryption scheme.
Definition: pubkey.h:2153
emsa2.h
Classes and functions for various padding schemes used in public key algorithms.
pubkey.h
This file contains helper classes/functions for implementing public key algorithms.
InvertibleRSAFunction::Save
void Save(BufferedTransformation &bt) const
Saves a key to a BufferedTransformation.
Definition: rsa.h:98
PKCS8PrivateKey
Encodes and decodesprivateKeyInfo.
Definition: asn.h:405
Weak::RSASSA_PKCS1v15_MD2_Verifier
RSASS<PKCS1v15, Weak::MD2>::Verifier typedef
Definition: rsa.h:226
cryptlib.h
Abstract base classes that provide a uniform interface to this library.
RSAFunction::GetAlgorithmID
OID GetAlgorithmID() const
Retrieves the OID of the algorithm.
Definition: rsa.cpp:43
RandomNumberGenerator
Interface for random number generators.
Definition: cryptlib.h:1186
PKCS8PrivateKey::DEREncodePrivateKey
virtual void DEREncodePrivateKey(BufferedTransformation &bt) const =0
encode privateKey part of privateKeyInfo, without the OCTET STRING header
PKCS8PrivateKey::BERDecode
void BERDecode(BufferedTransformation &bt)
Decode this object from a BufferedTransformation.
Definition: asn.cpp:567
BufferedTransformation
Interface for buffered transformations.
Definition: cryptlib.h:1352
RSAFunction::ApplyFunction
Integer ApplyFunction(const Integer &x) const
Applies the trapdoor.
Definition: rsa.cpp:64
Weak::RSASSA_PKCS1v15_MD2_Signer
RSASS<PKCS1v15, Weak::MD2>::Signer typedef
Definition: rsa.h:223
Weak::RSASSA_PKCS1v15_MD5_Signer
RSASS<PKCS1v15, Weak::MD5>::Signer typedef
Definition: rsa.h:230
TrapdoorFunctionInverse
Applies the inverse of the trapdoor function.
Definition: pubkey.h:184
CryptoMaterial::Validate
virtual bool Validate(RandomNumberGenerator &rng, unsigned int level) const =0
Check this object for errors.
RSAES_OAEP_SHA_Decryptor
RSAES<OAEP<SHA>>::Decryptor typedef
Definition: rsa.h:206
RSAFunction::ImageBound
Integer ImageBound() const
Returns the maximum size of a message after the trapdoor function is applied.
Definition: rsa.h:47
RSASSA_PKCS1v15_SHA_Verifier
RSASS<PKCS1v15,SHA>::Verifier typedef
Definition: rsa.h:217
RSAES_OAEP_SHA_Encryptor
RSAES<OAEP<SHA>>::Encryptor typedef
Definition: rsa.h:209
Integer
Multiple precision integer with arithmetic operations.
Definition: integer.h:45
InvertibleRSAFunction_ISO
RSA trapdoor function using the private key.
Definition: rsa.h:144
RSAFunction::Initialize
void Initialize(const Integer &n, const Integer &e)
Initialize a RSA public key with {n,e}.
Definition: rsa.h:31
InvertibleRSAFunction::DEREncode
void DEREncode(BufferedTransformation &bt) const
Encode this object into a BufferedTransformation.
Definition: rsa.h:94
NameValuePairs::GetVoidValue
virtual bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const =0
Get a named value.
TrapdoorFunction
Applies the trapdoor function.
Definition: pubkey.h:127
InvertibleRSAFunction::CalculateInverse
Integer CalculateInverse(RandomNumberGenerator &rng, const Integer &x) const
Calculates the inverse of an element.
Definition: rsa.cpp:227
InvertibleRSAFunction::BERDecode
void BERDecode(BufferedTransformation &bt)
Decode this object from a BufferedTransformation.
Definition: rsa.h:92
TrapdoorFunctionInverse::CalculateInverse
virtual Integer CalculateInverse(RandomNumberGenerator &rng, const Integer &x) const =0
Calculates the inverse of an element.
asn.h
Classes and functions for working with ANS.1 objects.
RSAES_PKCS1v15_Decryptor
RSAES<PKCS1v15>::Decryptor typedef
Definition: rsa.h:199
InvertibleRSAFunction::Initialize
void Initialize(const Integer &n, const Integer &e, const Integer &d, const Integer &p, const Integer &q, const Integer &dp, const Integer &dq, const Integer &u)
Initialize a RSA private key with {n,e,d,p,q,dp,dq,u}.
Definition: rsa.h:82
RSASS
RSA signature algorithm.
Definition: rsa.h:176
Weak::RSASSA_PKCS1v15_MD5_Verifier
RSASS<PKCS1v15, Weak::MD5>::Verifier typedef
Definition: rsa.h:233
PKCS8PrivateKey::DEREncode
void DEREncode(BufferedTransformation &bt) const
Encode this object into a BufferedTransformation.
Definition: asn.cpp:587
GeneratableCryptoMaterial::GenerateRandom
virtual void GenerateRandom(RandomNumberGenerator &rng, const NameValuePairs &params=g_nullNameValuePairs)
Generate a random key or crypto parameters.
Definition: cryptlib.h:2171
RSAES
RSA encryption algorithm.
Definition: rsa.h:165
integer.h
Multiple precision integer with arithmetic operations.
RSAFunction_ISO
RSA trapdoor function using the public key.
Definition: rsa.h:135
CryptoPP
Crypto++ library namespace.
RSA_ISO
RSA algorithm.
Definition: rsa.h:182
X509PublicKey
Encodes and decodes subjectPublicKeyInfo.
Definition: asn.h:384
RSASSA_PKCS1v15_SHA_Signer
RSASS<PKCS1v15,SHA>::Signer typedef
Definition: rsa.h:214
InvertibleRSAFunction_ISO::PreimageBound
Integer PreimageBound() const
Returns the maximum size of a message before the trapdoor function is applied.
Definition: rsa.h:148
OID
Object Identifier.
Definition: asn.h:159
Weak
Namespace containing weak and wounded algorithms.
Definition: arc4.cpp:14
RSAFunction
RSA trapdoor function using the public key.
Definition: rsa.h:23
RSAFunction::PreimageBound
Integer PreimageBound() const
Returns the maximum size of a message before the trapdoor function is applied.
Definition: rsa.h:46
InvertibleRSAFunction::GetAlgorithmID
OID GetAlgorithmID() const
Retrieves the OID of the algorithm.
Definition: rsa.h:100
RSAFunction_ISO::PreimageBound
Integer PreimageBound() const
Returns the maximum size of a message before the trapdoor function is applied.
Definition: rsa.h:139
OAEP
EME-OAEP, for use with classes derived from TF_ES
Definition: oaep.h:27
RSA
RSA algorithm.
Definition: rsa.h:153
NameValuePairs
Interface for retrieving values given their names.
Definition: cryptlib.h:277
PK_FinalTemplate
Template implementing constructors for public key algorithm classes.
Definition: pubkey.h:2030
TF_SS
Trapdoor Function (TF) Signature Scheme.
Definition: pubkey.h:2180
InvertibleRSAFunction
RSA trapdoor function using the private key.
Definition: rsa.h:62
RSASS_ISO
RSA signature algorithm.
Definition: rsa.h:193