Crypto++ 8.2 Free C++ class library of cryptographic schemes

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