Crypto++  5.6.4
Free C++ class library of cryptographic schemes
rsa.h
Go to the documentation of this file.
1 // rsa.h - written and placed in the public domain by Wei Dai
2 
3 //! \file rsa.h
4 //! \brief Classes for the RSA cryptosystem
5 //! \details This file contains classes that implement the RSA
6 //! ciphers and signature schemes as defined in PKCS #1 v2.0.
7 
8 #ifndef CRYPTOPP_RSA_H
9 #define CRYPTOPP_RSA_H
10 
11 #include "cryptlib.h"
12 #include "pubkey.h"
13 #include "integer.h"
14 #include "pkcspad.h"
15 #include "oaep.h"
16 #include "emsa2.h"
17 #include "asn.h"
18 
19 NAMESPACE_BEGIN(CryptoPP)
20 
21 //! \class RSAFunction
22 //! \brief RSA trapdoor function using the public key
23 class CRYPTOPP_DLL RSAFunction : public TrapdoorFunction, public X509PublicKey
24 {
25  typedef RSAFunction ThisClass;
26 
27 public:
28  //! \brief Initialize a RSA public key with {n,e}
29  //! \param n the modulus
30  //! \param e the public exponent
31  void Initialize(const Integer &n, const Integer &e)
32  {m_n = n; m_e = e;}
33 
34  // X509PublicKey
35  OID GetAlgorithmID() const;
36  void BERDecodePublicKey(BufferedTransformation &bt, bool parametersPresent, size_t size);
37  void DEREncodePublicKey(BufferedTransformation &bt) const;
38 
39  // CryptoMaterial
40  bool Validate(RandomNumberGenerator &rng, unsigned int level) const;
41  bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const;
42  void AssignFrom(const NameValuePairs &source);
43 
44  // TrapdoorFunction
45  Integer ApplyFunction(const Integer &x) const;
46  Integer PreimageBound() const {return m_n;}
47  Integer ImageBound() const {return m_n;}
48 
49  // non-derived
50  const Integer & GetModulus() const {return m_n;}
51  const Integer & GetPublicExponent() const {return m_e;}
52 
53  void SetModulus(const Integer &n) {m_n = n;}
54  void SetPublicExponent(const Integer &e) {m_e = e;}
55 
56 protected:
57  Integer m_n, m_e;
58 };
59 
60 //! \class InvertibleRSAFunction
61 //! \brief RSA trapdoor function using the private key
62 class CRYPTOPP_DLL InvertibleRSAFunction : public RSAFunction, public TrapdoorFunctionInverse, public PKCS8PrivateKey
63 {
65 
66 public:
67  //! \brief Create a RSA private key
68  //! \param rng a RandomNumberGenerator derived class
69  //! \param modulusBits the size of the modulud, in bits
70  //! \param e the desired public exponent
71  void Initialize(RandomNumberGenerator &rng, unsigned int modulusBits, const Integer &e = 17);
72 
73  //! \brief Initialize a RSA private key with {n,e,d,p,q,dp,dq,u}
74  //! \param n modulus
75  //! \param e public exponent
76  //! \param d private exponent
77  //! \param p first prime factor
78  //! \param q second prime factor
79  //! \param dp d mod p
80  //! \param dq d mod q
81  //! \param u q<sup>-1</sup> mod p
82  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)
83  {m_n = n; m_e = e; m_d = d; m_p = p; m_q = q; m_dp = dp; m_dq = dq; m_u = u;}
84  //! \brief Initialize a RSA private key with {n,e,d}
85  //! \param n modulus
86  //! \param e public exponent
87  //! \param d private exponent
88  //! \details Initialize() will factor n using d and populate {p,q,dp,dq,u}.
89  void Initialize(const Integer &n, const Integer &e, const Integer &d);
90 
91  // PKCS8PrivateKey
98  void Save(BufferedTransformation &bt) const
101  void BERDecodePrivateKey(BufferedTransformation &bt, bool parametersPresent, size_t size);
103 
104  // TrapdoorFunctionInverse
106 
107  // GeneratableCryptoMaterial
108  bool Validate(RandomNumberGenerator &rng, unsigned int level) const;
109  /*! parameters: (ModulusSize, PublicExponent (default 17)) */
110  void GenerateRandom(RandomNumberGenerator &rng, const NameValuePairs &alg);
111  bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const;
112  void AssignFrom(const NameValuePairs &source);
113 
114  // non-derived interface
115  const Integer& GetPrime1() const {return m_p;}
116  const Integer& GetPrime2() const {return m_q;}
117  const Integer& GetPrivateExponent() const {return m_d;}
118  const Integer& GetModPrime1PrivateExponent() const {return m_dp;}
119  const Integer& GetModPrime2PrivateExponent() const {return m_dq;}
120  const Integer& GetMultiplicativeInverseOfPrime2ModPrime1() const {return m_u;}
121 
122  void SetPrime1(const Integer &p) {m_p = p;}
123  void SetPrime2(const Integer &q) {m_q = q;}
124  void SetPrivateExponent(const Integer &d) {m_d = d;}
125  void SetModPrime1PrivateExponent(const Integer &dp) {m_dp = dp;}
126  void SetModPrime2PrivateExponent(const Integer &dq) {m_dq = dq;}
127  void SetMultiplicativeInverseOfPrime2ModPrime1(const Integer &u) {m_u = u;}
128 
129 protected:
130  Integer m_d, m_p, m_q, m_dp, m_dq, m_u;
131 };
132 
133 //! \class RSAFunction_ISO
134 //! \brief RSA trapdoor function using the public key
135 class CRYPTOPP_DLL RSAFunction_ISO : public RSAFunction
136 {
137 public:
138  Integer ApplyFunction(const Integer &x) const;
139  Integer PreimageBound() const {return ++(m_n>>1);}
140 };
141 
142 //! \class InvertibleRSAFunction_ISO
143 //! \brief RSA trapdoor function using the private key
145 {
146 public:
148  Integer PreimageBound() const {return ++(m_n>>1);}
149 };
150 
151 //! \class RSA
152 //! \brief RSA algorithm
153 struct CRYPTOPP_DLL RSA
154 {
155  CRYPTOPP_CONSTEXPR static const char * CRYPTOPP_API StaticAlgorithmName() {return "RSA";}
156  typedef RSAFunction PublicKey;
158 };
159 
160 //! \class RSAES
161 //! \brief RSA encryption algorithm
162 //! \tparam STANDARD signature standard
163 //! \sa <a href="http://www.weidai.com/scan-mirror/ca.html#RSA">RSA cryptosystem</a>
164 template <class STANDARD>
165 struct RSAES : public TF_ES<STANDARD, RSA>
166 {
167 };
168 
169 //! \class RSASS
170 //! \brief RSA signature algorithm
171 //! \tparam STANDARD signature standard
172 //! \tparam H hash transformation
173 //! \details See documentation of PKCS1v15 for a list of hash functions that can be used with it.
174 //! \sa <a href="http://www.weidai.com/scan-mirror/sig.html#RSA">RSA signature scheme with appendix</a>
175 template <class STANDARD, class H>
176 struct RSASS : public TF_SS<STANDARD, H, RSA>
177 {
178 };
179 
180 //! \class RSA_ISO
181 //! \brief RSA algorithm
182 struct CRYPTOPP_DLL RSA_ISO
183 {
184  CRYPTOPP_CONSTEXPR static const char * CRYPTOPP_API StaticAlgorithmName() {return "RSA-ISO";}
185  typedef RSAFunction_ISO PublicKey;
187 };
188 
189 //! \class RSASS_ISO
190 //! \brief RSA signature algorithm
191 //! \tparam H hash transformation
192 template <class H>
193 struct RSASS_ISO : public TF_SS<P1363_EMSA2, H, RSA_ISO>
194 {
195 };
196 
197 //! \brief \ref RSAES<STANDARD> "RSAES<PKCS1v15>::Decryptor" typedef
198 //! \details RSA encryption scheme defined in PKCS #1 v2.0
200 //! \brief \ref RSAES<STANDARD> "RSAES<PKCS1v15>::Encryptor" typedef
201 //! \details RSA encryption scheme defined in PKCS #1 v2.0
203 
204 //! \brief \ref RSAES<STANDARD> "RSAES<OAEP<SHA>>::Decryptor" typedef
205 //! \details RSA encryption scheme defined in PKCS #1 v2.0
206 DOCUMENTED_TYPEDEF(RSAES<OAEP<SHA> >::Decryptor, RSAES_OAEP_SHA_Decryptor);
207 //! \brief \ref RSAES<STANDARD> "RSAES<OAEP<SHA>>::Encryptor" typedef
208 //! \details RSA encryption scheme defined in PKCS #1 v2.0
209 DOCUMENTED_TYPEDEF(RSAES<OAEP<SHA> >::Encryptor, RSAES_OAEP_SHA_Encryptor);
210 
211 #ifdef CRYPTOPP_DOXYGEN_PROCESSING
212 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15,SHA>::Signer" typedef
213 //! \details RSA signature schemes defined in PKCS #1 v2.0
214 class RSASSA_PKCS1v15_SHA_Signer : public RSASS<PKCS1v15,SHA>::Signer {};
215 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15,SHA>::Verifier" typedef
216 //! \details RSA signature schemes defined in PKCS #1 v2.0
217 class RSASSA_PKCS1v15_SHA_Verifier : public RSASS<PKCS1v15,SHA>::Verifier {};
218 
219 namespace Weak {
220 
221 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD2>::Signer" typedef
222 //! \details RSA signature schemes defined in PKCS #1 v2.0
223 class RSASSA_PKCS1v15_MD2_Signer : public RSASS<PKCS1v15, Weak1::MD2>::Signer {};
224 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD2>::Verifier" typedef
225 //! \details RSA signature schemes defined in PKCS #1 v2.0
226 class RSASSA_PKCS1v15_MD2_Verifier : public RSASS<PKCS1v15, Weak1::MD2>::Verifier {};
227 
228 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD5>::Signer" typedef
229 //! \details RSA signature schemes defined in PKCS #1 v2.0
230 class RSASSA_PKCS1v15_MD5_Signer : public RSASS<PKCS1v15, Weak1::MD5>::Signer {};
231 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD5>::Verifier" typedef
232 //! \details RSA signature schemes defined in PKCS #1 v2.0
233 class RSASSA_PKCS1v15_MD5_Verifier : public RSASS<PKCS1v15, Weak1::MD5>::Verifier {};
234 }
235 
236 #else
239 
240 namespace Weak {
241  typedef RSASS<PKCS1v15, Weak1::MD2>::Signer RSASSA_PKCS1v15_MD2_Signer;
242  typedef RSASS<PKCS1v15, Weak1::MD2>::Verifier RSASSA_PKCS1v15_MD2_Verifier;
243  typedef RSASS<PKCS1v15, Weak1::MD5>::Signer RSASSA_PKCS1v15_MD5_Signer;
244  typedef RSASS<PKCS1v15, Weak1::MD5>::Verifier RSASSA_PKCS1v15_MD5_Verifier;
245 }
246 #endif // CRYPTOPP_DOXYGEN_PROCESSING
247 
248 NAMESPACE_END
249 
250 #endif
virtual void AssignFrom(const NameValuePairs &source)=0
Assign values to this object.
RSAES::Encryptor typedef
Definition: rsa.h:202
virtual void BERDecodePrivateKey(BufferedTransformation &bt, bool parametersPresent, size_t size)=0
decode privateKey part of privateKeyInfo, without the OCTET STRING header
void DEREncode(BufferedTransformation &bt) const
Encode this object into a BufferedTransformation.
Definition: rsa.h:94
void Load(BufferedTransformation &bt)
Loads a key from a BufferedTransformation.
Definition: rsa.h:96
Trapdoor Function (TF) encryption scheme.
Definition: pubkey.h:2160
Classes and functions for various padding schemes used in public key algorithms.
This file contains helper classes/functions for implementing public key algorithms.
Encodes and decodesprivateKeyInfo.
Definition: asn.h:404
RSASS::Verifier typedef
Definition: rsa.h:226
Abstract base classes that provide a uniform interface to this library.
virtual bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const =0
Get a named value.
virtual void DEREncodePrivateKey(BufferedTransformation &bt) const =0
encode privateKey part of privateKeyInfo, without the OCTET STRING header
void DEREncode(BufferedTransformation &bt) const
Encode this object into a BufferedTransformation.
Definition: asn.cpp:576
Interface for random number generators.
Definition: cryptlib.h:1193
OID GetAlgorithmID() const
Retrieves the OID of the algorithm.
Definition: rsa.h:100
void BERDecode(BufferedTransformation &bt)
Decode this object from a BufferedTransformation.
Definition: asn.cpp:556
Interface for buffered transformations.
Definition: cryptlib.h:1359
virtual Integer CalculateInverse(RandomNumberGenerator &rng, const Integer &x) const =0
Calculates the inverse of an element.
RSASS::Signer typedef
Definition: rsa.h:223
RSASS::Signer typedef
Definition: rsa.h:230
Applies the inverse of the trapdoor function.
Definition: pubkey.h:190
RSAES>::Decryptor typedef
Definition: rsa.h:206
void Save(BufferedTransformation &bt) const
Saves a key to a BufferedTransformation.
Definition: rsa.h:98
RSASS::Verifier typedef
Definition: rsa.h:217
RSAES>::Encryptor typedef
Definition: rsa.h:209
Multiple precision integer with arithmetic operations.
Definition: integer.h:45
RSA trapdoor function using the private key.
Definition: rsa.h:144
void Initialize(const Integer &n, const Integer &e)
Initialize a RSA public key with {n,e}.
Definition: rsa.h:31
Applies the trapdoor function.
Definition: pubkey.h:133
void BERDecode(BufferedTransformation &bt)
Decode this object from a BufferedTransformation.
Definition: rsa.h:92
Classes and functions for working with ANS.1 objects.
Integer PreimageBound() const
Returns the maximum size of a message before the trapdoor function is applied.
Definition: rsa.h:139
RSAES::Decryptor typedef
Definition: rsa.h:199
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
RSA signature algorithm.
Definition: rsa.h:176
virtual bool Validate(RandomNumberGenerator &rng, unsigned int level) const =0
Check this object for errors.
RSASS::Verifier typedef
Definition: rsa.h:233
virtual void GenerateRandom(RandomNumberGenerator &rng, const NameValuePairs &params=g_nullNameValuePairs)
Generate a random key or crypto parameters.
Definition: cryptlib.h:2178
Integer ImageBound() const
Returns the maximum size of a message after the trapdoor function is applied.
Definition: rsa.h:47
OID GetAlgorithmID() const
Retrieves the OID of the algorithm.
Definition: rsa.cpp:43
RSA encryption algorithm.
Definition: rsa.h:165
Multiple precision integer with arithmetic operations.
RSA trapdoor function using the public key.
Definition: rsa.h:135
Crypto++ library namespace.
Integer ApplyFunction(const Integer &x) const
Applies the trapdoor.
Definition: rsa.cpp:64
RSA algorithm.
Definition: rsa.h:182
Encodes and decodes subjectPublicKeyInfo.
Definition: asn.h:383
RSASS::Signer typedef
Definition: rsa.h:214
Integer PreimageBound() const
Returns the maximum size of a message before the trapdoor function is applied.
Definition: rsa.h:148
Object Identifier.
Definition: asn.h:158
Integer CalculateInverse(RandomNumberGenerator &rng, const Integer &x) const
Calculates the inverse of an element.
Definition: rsa.cpp:227
Integer PreimageBound() const
Returns the maximum size of a message before the trapdoor function is applied.
Definition: rsa.h:46
Namespace containing weak and wounded algorithms.
Definition: arc4.cpp:14
RSA trapdoor function using the public key.
Definition: rsa.h:23
EME-OAEP, for use with classes derived from TF_ES
Definition: oaep.h:27
RSA algorithm.
Definition: rsa.h:153
Interface for retrieving values given their names.
Definition: cryptlib.h:282
Template implementing constructors for public key algorithm classes.
Definition: pubkey.h:2037
Trapdoor Function (TF) Signature Scheme.
Definition: pubkey.h:2187
RSA trapdoor function using the private key.
Definition: rsa.h:62
RSA signature algorithm.
Definition: rsa.h:193