Crypto++  5.6.5
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 //! \since Crypto++ 1.0
24 class CRYPTOPP_DLL RSAFunction : public TrapdoorFunction, public X509PublicKey
25 {
26  typedef RSAFunction ThisClass;
27 
28 public:
29  //! \brief Initialize a RSA public key
30  //! \param n the modulus
31  //! \param e the public exponent
32  void Initialize(const Integer &n, const Integer &e)
33  {m_n = n; m_e = e;}
34 
35  // X509PublicKey
36  OID GetAlgorithmID() const;
37  void BERDecodePublicKey(BufferedTransformation &bt, bool parametersPresent, size_t size);
38  void DEREncodePublicKey(BufferedTransformation &bt) const;
39 
40  // CryptoMaterial
41  bool Validate(RandomNumberGenerator &rng, unsigned int level) const;
42  bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const;
43  void AssignFrom(const NameValuePairs &source);
44 
45  // TrapdoorFunction
46  Integer ApplyFunction(const Integer &x) const;
47  Integer PreimageBound() const {return m_n;}
48  Integer ImageBound() const {return m_n;}
49 
50  // non-derived
51  const Integer & GetModulus() const {return m_n;}
52  const Integer & GetPublicExponent() const {return m_e;}
53 
54  void SetModulus(const Integer &n) {m_n = n;}
55  void SetPublicExponent(const Integer &e) {m_e = e;}
56 
57 protected:
58  Integer m_n, m_e;
59 };
60 
61 //! \class InvertibleRSAFunction
62 //! \brief RSA trapdoor function using the private key
63 //! \since Crypto++ 1.0
64 class CRYPTOPP_DLL InvertibleRSAFunction : public RSAFunction, public TrapdoorFunctionInverse, public PKCS8PrivateKey
65 {
67 
68 public:
69  //! \brief Create a RSA private key
70  //! \param rng a RandomNumberGenerator derived class
71  //! \param modulusBits the size of the modulus, in bits
72  //! \param e the desired public exponent
73  //! \details Initialize() creates a new keypair using a public exponent of 17.
74  //! \details This function overload of Initialize() creates a new private key because it
75  //! takes a RandomNumberGenerator() as a parameter. If you have an existing keypair,
76  //! then use one of the other Initialize() overloads.
77  void Initialize(RandomNumberGenerator &rng, unsigned int modulusBits, const Integer &e = 17);
78 
79  //! \brief Initialize a RSA private key
80  //! \param n modulus
81  //! \param e public exponent
82  //! \param d private exponent
83  //! \param p first prime factor
84  //! \param q second prime factor
85  //! \param dp d mod p
86  //! \param dq d mod q
87  //! \param u q<sup>-1</sup> mod p
88  //! \details This Initialize() function overload initializes a private key from existing parameters.
89  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)
90  {m_n = n; m_e = e; m_d = d; m_p = p; m_q = q; m_dp = dp; m_dq = dq; m_u = u;}
91 
92  //! \brief Initialize a RSA private key
93  //! \param n modulus
94  //! \param e public exponent
95  //! \param d private exponent
96  //! \details This Initialize() function overload initializes a private key from existing parameters.
97  //! Initialize() will factor n using d and populate {p,q,dp,dq,u}.
98  void Initialize(const Integer &n, const Integer &e, const Integer &d);
99 
100  // PKCS8PrivateKey
107  void Save(BufferedTransformation &bt) const
110  void BERDecodePrivateKey(BufferedTransformation &bt, bool parametersPresent, size_t size);
112 
113  // TrapdoorFunctionInverse
115 
116  // GeneratableCryptoMaterial
117  bool Validate(RandomNumberGenerator &rng, unsigned int level) const;
118  /*! parameters: (ModulusSize, PublicExponent (default 17)) */
119  void GenerateRandom(RandomNumberGenerator &rng, const NameValuePairs &alg);
120  bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const;
121  void AssignFrom(const NameValuePairs &source);
122 
123  // non-derived interface
124  const Integer& GetPrime1() const {return m_p;}
125  const Integer& GetPrime2() const {return m_q;}
126  const Integer& GetPrivateExponent() const {return m_d;}
127  const Integer& GetModPrime1PrivateExponent() const {return m_dp;}
128  const Integer& GetModPrime2PrivateExponent() const {return m_dq;}
129  const Integer& GetMultiplicativeInverseOfPrime2ModPrime1() const {return m_u;}
130 
131  void SetPrime1(const Integer &p) {m_p = p;}
132  void SetPrime2(const Integer &q) {m_q = q;}
133  void SetPrivateExponent(const Integer &d) {m_d = d;}
134  void SetModPrime1PrivateExponent(const Integer &dp) {m_dp = dp;}
135  void SetModPrime2PrivateExponent(const Integer &dq) {m_dq = dq;}
136  void SetMultiplicativeInverseOfPrime2ModPrime1(const Integer &u) {m_u = u;}
137 
138 protected:
139  Integer m_d, m_p, m_q, m_dp, m_dq, m_u;
140 };
141 
142 //! \class RSAFunction_ISO
143 //! \brief RSA trapdoor function using the public key
144 //! \since Crypto++ 1.0
145 class CRYPTOPP_DLL RSAFunction_ISO : public RSAFunction
146 {
147 public:
148  Integer ApplyFunction(const Integer &x) const;
149  Integer PreimageBound() const {return ++(m_n>>1);}
150 };
151 
152 //! \class InvertibleRSAFunction_ISO
153 //! \brief RSA trapdoor function using the private key
154 //! \since Crypto++ 1.0
156 {
157 public:
159  Integer PreimageBound() const {return ++(m_n>>1);}
160 };
161 
162 //! \class RSA
163 //! \brief RSA algorithm
164 //! \since Crypto++ 1.0
165 struct CRYPTOPP_DLL RSA
166 {
167  CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "RSA";}
168  typedef RSAFunction PublicKey;
170 };
171 
172 //! \class RSAES
173 //! \brief RSA encryption algorithm
174 //! \tparam STANDARD signature standard
175 //! \sa <a href="http://www.weidai.com/scan-mirror/ca.html#RSA">RSA cryptosystem</a>
176 //! \since Crypto++ 1.0
177 template <class STANDARD>
178 struct RSAES : public TF_ES<RSA, STANDARD>
179 {
180 };
181 
182 //! \class RSASS
183 //! \brief RSA signature algorithm
184 //! \tparam STANDARD signature standard
185 //! \tparam H hash transformation
186 //! \details See documentation of PKCS1v15 for a list of hash functions that can be used with it.
187 //! \sa <a href="http://www.weidai.com/scan-mirror/sig.html#RSA">RSA signature scheme with appendix</a>
188 //! \since Crypto++ 1.0
189 template <class STANDARD, class H>
190 struct RSASS : public TF_SS<RSA, STANDARD, H>
191 {
192 };
193 
194 //! \class RSA_ISO
195 //! \brief RSA algorithm
196 //! \since Crypto++ 1.0
197 struct CRYPTOPP_DLL RSA_ISO
198 {
199  CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "RSA-ISO";}
200  typedef RSAFunction_ISO PublicKey;
202 };
203 
204 //! \class RSASS_ISO
205 //! \brief RSA signature algorithm
206 //! \tparam H hash transformation
207 //! \since Crypto++ 1.0
208 template <class H>
209 struct RSASS_ISO : public TF_SS<RSA_ISO, P1363_EMSA2, H>
210 {
211 };
212 
213 //! \brief \ref RSAES<STANDARD> "RSAES<PKCS1v15>::Decryptor" typedef
214 //! \details RSA encryption scheme defined in PKCS #1 v2.0
216 //! \brief \ref RSAES<STANDARD> "RSAES<PKCS1v15>::Encryptor" typedef
217 //! \details RSA encryption scheme defined in PKCS #1 v2.0
219 
220 //! \brief \ref RSAES<STANDARD> "RSAES<OAEP<SHA>>::Decryptor" typedef
221 //! \details RSA encryption scheme defined in PKCS #1 v2.0
222 DOCUMENTED_TYPEDEF(RSAES<OAEP<SHA> >::Decryptor, RSAES_OAEP_SHA_Decryptor);
223 //! \brief \ref RSAES<STANDARD> "RSAES<OAEP<SHA>>::Encryptor" typedef
224 //! \details RSA encryption scheme defined in PKCS #1 v2.0
225 DOCUMENTED_TYPEDEF(RSAES<OAEP<SHA> >::Encryptor, RSAES_OAEP_SHA_Encryptor);
226 
227 #ifdef CRYPTOPP_DOXYGEN_PROCESSING
228 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15,SHA>::Signer" typedef
229 //! \details RSA signature schemes defined in PKCS #1 v2.0
230 //! \since Crypto++ 1.0
231 class RSASSA_PKCS1v15_SHA_Signer : public RSASS<PKCS1v15,SHA>::Signer {};
232 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15,SHA>::Verifier" typedef
233 //! \details RSA signature schemes defined in PKCS #1 v2.0
234 //! \since Crypto++ 1.0
235 class RSASSA_PKCS1v15_SHA_Verifier : public RSASS<PKCS1v15,SHA>::Verifier {};
236 
237 namespace Weak {
238 
239 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD2>::Signer" typedef
240 //! \details RSA signature schemes defined in PKCS #1 v2.0
241 //! \since Crypto++ 1.0
242 class RSASSA_PKCS1v15_MD2_Signer : public RSASS<PKCS1v15, Weak1::MD2>::Signer {};
243 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD2>::Verifier" typedef
244 //! \details RSA signature schemes defined in PKCS #1 v2.0
245 //! \since Crypto++ 1.0
246 class RSASSA_PKCS1v15_MD2_Verifier : public RSASS<PKCS1v15, Weak1::MD2>::Verifier {};
247 
248 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD5>::Signer" typedef
249 //! \details RSA signature schemes defined in PKCS #1 v2.0
250 //! \since Crypto++ 1.0
251 class RSASSA_PKCS1v15_MD5_Signer : public RSASS<PKCS1v15, Weak1::MD5>::Signer {};
252 //! \brief \ref RSASS<STANDARD,HASH> "RSASS<PKCS1v15, Weak::MD5>::Verifier" typedef
253 //! \details RSA signature schemes defined in PKCS #1 v2.0
254 //! \since Crypto++ 1.0
255 class RSASSA_PKCS1v15_MD5_Verifier : public RSASS<PKCS1v15, Weak1::MD5>::Verifier {};
256 }
257 
258 #else
261 
262 namespace Weak {
263  typedef RSASS<PKCS1v15, Weak1::MD2>::Signer RSASSA_PKCS1v15_MD2_Signer;
264  typedef RSASS<PKCS1v15, Weak1::MD2>::Verifier RSASSA_PKCS1v15_MD2_Verifier;
265  typedef RSASS<PKCS1v15, Weak1::MD5>::Signer RSASSA_PKCS1v15_MD5_Signer;
266  typedef RSASS<PKCS1v15, Weak1::MD5>::Verifier RSASSA_PKCS1v15_MD5_Verifier;
267 }
268 #endif // CRYPTOPP_DOXYGEN_PROCESSING
269 
270 NAMESPACE_END
271 
272 #endif
virtual void AssignFrom(const NameValuePairs &source)=0
Assign values to this object.
RSAES::Encryptor typedef
Definition: rsa.h:218
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:103
void Load(BufferedTransformation &bt)
Loads a key from a BufferedTransformation.
Definition: rsa.h:105
Trapdoor Function (TF) encryption scheme.
Definition: pubkey.h:2043
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:414
RSASS::Verifier typedef
Definition: rsa.h:246
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:1188
OID GetAlgorithmID() const
Retrieves the OID of the algorithm.
Definition: rsa.h:109
void BERDecode(BufferedTransformation &bt)
Decode this object from a BufferedTransformation.
Definition: asn.cpp:556
Interface for buffered transformations.
Definition: cryptlib.h:1352
virtual Integer CalculateInverse(RandomNumberGenerator &rng, const Integer &x) const =0
Calculates the inverse of an element.
RSASS::Signer typedef
Definition: rsa.h:242
RSASS::Signer typedef
Definition: rsa.h:251
Applies the inverse of the trapdoor function.
Definition: pubkey.h:183
Classes for PKCS padding schemes.
RSAES>::Decryptor typedef
Definition: rsa.h:222
void Save(BufferedTransformation &bt) const
Saves a key to a BufferedTransformation.
Definition: rsa.h:107
RSASS::Verifier typedef
Definition: rsa.h:235
RSAES>::Encryptor typedef
Definition: rsa.h:225
Multiple precision integer with arithmetic operations.
Definition: integer.h:43
RSA trapdoor function using the private key.
Definition: rsa.h:155
void Initialize(const Integer &n, const Integer &e)
Initialize a RSA public key.
Definition: rsa.h:32
Applies the trapdoor function.
Definition: pubkey.h:128
void BERDecode(BufferedTransformation &bt)
Decode this object from a BufferedTransformation.
Definition: rsa.h:101
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:149
RSAES::Decryptor typedef
Definition: rsa.h:215
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.
Definition: rsa.h:89
RSA signature algorithm.
Definition: rsa.h:190
virtual bool Validate(RandomNumberGenerator &rng, unsigned int level) const =0
Check this object for errors.
RSASS::Verifier typedef
Definition: rsa.h:255
virtual void GenerateRandom(RandomNumberGenerator &rng, const NameValuePairs &params=g_nullNameValuePairs)
Generate a random key or crypto parameters.
Definition: cryptlib.h:2166
Integer ImageBound() const
Returns the maximum size of a message after the trapdoor function is applied.
Definition: rsa.h:48
OID GetAlgorithmID() const
Retrieves the OID of the algorithm.
Definition: rsa.cpp:43
RSA encryption algorithm.
Definition: rsa.h:178
Multiple precision integer with arithmetic operations.
RSA trapdoor function using the public key.
Definition: rsa.h:145
Crypto++ library namespace.
Integer ApplyFunction(const Integer &x) const
Applies the trapdoor.
Definition: rsa.cpp:64
RSA algorithm.
Definition: rsa.h:197
Encodes and decodes subjectPublicKeyInfo.
Definition: asn.h:391
RSASS::Signer typedef
Definition: rsa.h:231
Integer PreimageBound() const
Returns the maximum size of a message before the trapdoor function is applied.
Definition: rsa.h:159
Object Identifier.
Definition: asn.h:165
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:47
Namespace containing weak and wounded algorithms.
Definition: arc4.cpp:14
RSA trapdoor function using the public key.
Definition: rsa.h:24
OAEP padding.
Definition: oaep.h:28
RSA algorithm.
Definition: rsa.h:165
Interface for retrieving values given their names.
Definition: cryptlib.h:279
Template implementing constructors for public key algorithm classes.
Definition: pubkey.h:1954
Trapdoor Function (TF) Signature Scheme.
Definition: pubkey.h:2070
RSA trapdoor function using the private key.
Definition: rsa.h:64
RSA signature algorithm.
Definition: rsa.h:209