2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
62 #include <openssl/asn1.h>
64 #ifndef OPENSSL_NO_BIO
65 #include <openssl/bio.h>
67 #include <openssl/crypto.h>
68 #include <openssl/ossl_typ.h>
69 #ifndef OPENSSL_NO_DEPRECATED
70 #include <openssl/bn.h>
74 #error RSA is disabled.
81 /* Declared already in ossl_typ.h */
82 /* typedef struct rsa_st RSA; */
83 /* typedef struct rsa_meth_st RSA_METHOD; */
88 int (*rsa_pub_enc)(int flen,const unsigned char *from,
90 RSA *rsa,int padding);
91 int (*rsa_pub_dec)(int flen,const unsigned char *from,
93 RSA *rsa,int padding);
94 int (*rsa_priv_enc)(int flen,const unsigned char *from,
96 RSA *rsa,int padding);
97 int (*rsa_priv_dec)(int flen,const unsigned char *from,
99 RSA *rsa,int padding);
100 int (*rsa_mod_exp)(BIGNUM *r0,const BIGNUM *I,RSA *rsa,BN_CTX *ctx); /* Can be null */
101 int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
102 const BIGNUM *m, BN_CTX *ctx,
103 BN_MONT_CTX *m_ctx); /* Can be null */
104 int (*init)(RSA *rsa); /* called at new */
105 int (*finish)(RSA *rsa); /* called at free */
106 int flags; /* RSA_METHOD_FLAG_* things */
107 char *app_data; /* may be needed! */
108 /* New sign and verify functions: some libraries don't allow arbitrary data
109 * to be signed/verified: this allows them to be used. Note: for this to work
110 * the RSA_public_decrypt() and RSA_private_encrypt() should *NOT* be used
111 * RSA_sign(), RSA_verify() should be used instead. Note: for backwards
112 * compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER
113 * option is set in 'flags'.
115 int (*rsa_sign)(int type,
116 const unsigned char *m, unsigned int m_length,
117 unsigned char *sigret, unsigned int *siglen, const RSA *rsa);
118 int (*rsa_verify)(int dtype,
119 const unsigned char *m, unsigned int m_length,
120 const unsigned char *sigbuf, unsigned int siglen,
122 /* If this callback is NULL, the builtin software RSA key-gen will be used. This
123 * is for behavioural compatibility whilst the code gets rewired, but one day
124 * it would be nice to assume there are no such things as "builtin software"
125 * implementations. */
126 int (*rsa_keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
131 /* The first parameter is used to pickup errors where
132 * this is passed instead of aEVP_PKEY, it is set to 0 */
135 const RSA_METHOD *meth;
136 /* functional reference if 'meth' is ENGINE-provided */
146 /* be careful using this if the RSA structure is shared */
147 CRYPTO_EX_DATA ex_data;
151 /* Used to cache montgomery values */
152 BN_MONT_CTX *_method_mod_n;
153 BN_MONT_CTX *_method_mod_p;
154 BN_MONT_CTX *_method_mod_q;
156 /* all BIGNUM values are actually in the following data, if it is not
159 BN_BLINDING *blinding;
160 BN_BLINDING *mt_blinding;
164 #define RSA_F4 0x10001L
166 #define RSA_METHOD_FLAG_NO_CHECK 0x0001 /* don't check pub/private match */
168 #define RSA_FLAG_CACHE_PUBLIC 0x0002
169 #define RSA_FLAG_CACHE_PRIVATE 0x0004
170 #define RSA_FLAG_BLINDING 0x0008
171 #define RSA_FLAG_THREAD_SAFE 0x0010
172 /* This flag means the private key operations will be handled by rsa_mod_exp
173 * and that they do not depend on the private key components being present:
174 * for example a key stored in external hardware. Without this flag bn_mod_exp
175 * gets called when private key components are absent.
177 #define RSA_FLAG_EXT_PKEY 0x0020
179 /* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions.
181 #define RSA_FLAG_SIGN_VER 0x0040
183 #define RSA_FLAG_NO_BLINDING 0x0080 /* new with 0.9.6j and 0.9.7b; the built-in
184 * RSA implementation now uses blinding by
185 * default (ignoring RSA_FLAG_BLINDING),
186 * but other engines might not need it
188 #define RSA_FLAG_NO_EXP_CONSTTIME 0x0100 /* new with 0.9.7h; the built-in RSA
189 * implementation now uses constant time
190 * modular exponentiation for secret exponents
191 * by default. This flag causes the
192 * faster variable sliding window method to
193 * be used for all exponents.
196 #define EVP_PKEY_CTX_set_rsa_padding(ctx, pad) \
197 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, -1, EVP_PKEY_CTRL_RSA_PADDING, \
200 #define EVP_PKEY_CTX_set_rsa_pss_saltlen(ctx, len) \
201 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, \
202 (EVP_PKEY_OP_SIGN|EVP_PKEY_OP_VERIFY), \
203 EVP_PKEY_CTRL_RSA_PSS_SALTLEN, \
206 #define EVP_PKEY_CTRL_RSA_PADDING (EVP_PKEY_ALG_CTRL + 1)
207 #define EVP_PKEY_CTRL_RSA_PSS_SALTLEN (EVP_PKEY_ALG_CTRL + 2)
209 #define RSA_PKCS1_PADDING 1
210 #define RSA_SSLV23_PADDING 2
211 #define RSA_NO_PADDING 3
212 #define RSA_PKCS1_OAEP_PADDING 4
213 #define RSA_X931_PADDING 5
215 #define RSA_PKCS1_PSS_PADDING 6
217 #define RSA_PKCS1_PADDING_SIZE 11
219 #define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg)
220 #define RSA_get_app_data(s) RSA_get_ex_data(s,0)
223 RSA * RSA_new_method(ENGINE *engine);
224 int RSA_size(const RSA *);
226 /* Deprecated version */
227 #ifndef OPENSSL_NO_DEPRECATED
228 RSA * RSA_generate_key(int bits, unsigned long e,void
229 (*callback)(int,int,void *),void *cb_arg);
230 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
233 int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
235 int RSA_check_key(const RSA *);
236 /* next 4 return -1 on error */
237 int RSA_public_encrypt(int flen, const unsigned char *from,
238 unsigned char *to, RSA *rsa,int padding);
239 int RSA_private_encrypt(int flen, const unsigned char *from,
240 unsigned char *to, RSA *rsa,int padding);
241 int RSA_public_decrypt(int flen, const unsigned char *from,
242 unsigned char *to, RSA *rsa,int padding);
243 int RSA_private_decrypt(int flen, const unsigned char *from,
244 unsigned char *to, RSA *rsa,int padding);
245 void RSA_free (RSA *r);
246 /* "up" the RSA object's reference count */
247 int RSA_up_ref(RSA *r);
249 int RSA_flags(const RSA *r);
251 void RSA_set_default_method(const RSA_METHOD *meth);
252 const RSA_METHOD *RSA_get_default_method(void);
253 const RSA_METHOD *RSA_get_method(const RSA *rsa);
254 int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
256 /* This function needs the memory locking malloc callbacks to be installed */
257 int RSA_memory_lock(RSA *r);
259 /* these are the actual SSLeay RSA functions */
260 const RSA_METHOD *RSA_PKCS1_SSLeay(void);
262 const RSA_METHOD *RSA_null_method(void);
264 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPublicKey)
265 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPrivateKey)
267 #ifndef OPENSSL_NO_FP_API
268 int RSA_print_fp(FILE *fp, const RSA *r,int offset);
271 #ifndef OPENSSL_NO_BIO
272 int RSA_print(BIO *bp, const RSA *r,int offset);
275 int i2d_RSA_NET(const RSA *a, unsigned char **pp,
276 int (*cb)(char *buf, int len, const char *prompt, int verify),
278 RSA *d2i_RSA_NET(RSA **a, const unsigned char **pp, long length,
279 int (*cb)(char *buf, int len, const char *prompt, int verify),
282 int i2d_Netscape_RSA(const RSA *a, unsigned char **pp,
283 int (*cb)(char *buf, int len, const char *prompt,
285 RSA *d2i_Netscape_RSA(RSA **a, const unsigned char **pp, long length,
286 int (*cb)(char *buf, int len, const char *prompt,
289 /* The following 2 functions sign and verify a X509_SIG ASN1 object
290 * inside PKCS#1 padded RSA encryption */
291 int RSA_sign(int type, const unsigned char *m, unsigned int m_length,
292 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
293 int RSA_verify(int type, const unsigned char *m, unsigned int m_length,
294 const unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
296 /* The following 2 function sign and verify a ASN1_OCTET_STRING
297 * object inside PKCS#1 padded RSA encryption */
298 int RSA_sign_ASN1_OCTET_STRING(int type,
299 const unsigned char *m, unsigned int m_length,
300 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
301 int RSA_verify_ASN1_OCTET_STRING(int type,
302 const unsigned char *m, unsigned int m_length,
303 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
305 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
306 void RSA_blinding_off(RSA *rsa);
307 BN_BLINDING *RSA_setup_blinding(RSA *rsa, BN_CTX *ctx);
309 int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
310 const unsigned char *f,int fl);
311 int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
312 const unsigned char *f,int fl,int rsa_len);
313 int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
314 const unsigned char *f,int fl);
315 int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
316 const unsigned char *f,int fl,int rsa_len);
317 int PKCS1_MGF1(unsigned char *mask, long len,
318 const unsigned char *seed, long seedlen, const EVP_MD *dgst);
319 int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen,
320 const unsigned char *f,int fl,
321 const unsigned char *p,int pl);
322 int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen,
323 const unsigned char *f,int fl,int rsa_len,
324 const unsigned char *p,int pl);
325 int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
326 const unsigned char *f,int fl);
327 int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
328 const unsigned char *f,int fl,int rsa_len);
329 int RSA_padding_add_none(unsigned char *to,int tlen,
330 const unsigned char *f,int fl);
331 int RSA_padding_check_none(unsigned char *to,int tlen,
332 const unsigned char *f,int fl,int rsa_len);
333 int RSA_padding_add_X931(unsigned char *to,int tlen,
334 const unsigned char *f,int fl);
335 int RSA_padding_check_X931(unsigned char *to,int tlen,
336 const unsigned char *f,int fl,int rsa_len);
337 int RSA_X931_hash_id(int nid);
339 int RSA_verify_PKCS1_PSS(RSA *rsa, const unsigned char *mHash,
340 const EVP_MD *Hash, const unsigned char *EM, int sLen);
341 int RSA_padding_add_PKCS1_PSS(RSA *rsa, unsigned char *EM,
342 const unsigned char *mHash,
343 const EVP_MD *Hash, int sLen);
345 int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
346 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
347 int RSA_set_ex_data(RSA *r,int idx,void *arg);
348 void *RSA_get_ex_data(const RSA *r, int idx);
350 RSA *RSAPublicKey_dup(RSA *rsa);
351 RSA *RSAPrivateKey_dup(RSA *rsa);
353 /* BEGIN ERROR CODES */
354 /* The following lines are auto generated by the script mkerr.pl. Any changes
355 * made after this point may be overwritten when the script is next run.
357 void ERR_load_RSA_strings(void);
359 /* Error codes for the RSA functions. */
361 /* Function codes. */
362 #define RSA_F_CHECK_PADDING_NID 140
363 #define RSA_F_MEMORY_LOCK 100
364 #define RSA_F_PKEY_RSA_SIGN 142
365 #define RSA_F_PKEY_RSA_VERIFYRECOVER 141
366 #define RSA_F_RSA_BUILTIN_KEYGEN 129
367 #define RSA_F_RSA_CHECK_KEY 123
368 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101
369 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102
370 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103
371 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104
372 #define RSA_F_RSA_GENERATE_KEY 105
373 #define RSA_F_RSA_MEMORY_LOCK 130
374 #define RSA_F_RSA_NEW_METHOD 106
375 #define RSA_F_RSA_NULL 124
376 #define RSA_F_RSA_NULL_MOD_EXP 131
377 #define RSA_F_RSA_NULL_PRIVATE_DECRYPT 132
378 #define RSA_F_RSA_NULL_PRIVATE_ENCRYPT 133
379 #define RSA_F_RSA_NULL_PUBLIC_DECRYPT 134
380 #define RSA_F_RSA_NULL_PUBLIC_ENCRYPT 135
381 #define RSA_F_RSA_PADDING_ADD_NONE 107
382 #define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121
383 #define RSA_F_RSA_PADDING_ADD_PKCS1_PSS 125
384 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108
385 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109
386 #define RSA_F_RSA_PADDING_ADD_SSLV23 110
387 #define RSA_F_RSA_PADDING_ADD_X931 127
388 #define RSA_F_RSA_PADDING_CHECK_NONE 111
389 #define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122
390 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112
391 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113
392 #define RSA_F_RSA_PADDING_CHECK_SSLV23 114
393 #define RSA_F_RSA_PADDING_CHECK_X931 128
394 #define RSA_F_RSA_PRINT 115
395 #define RSA_F_RSA_PRINT_FP 116
396 #define RSA_F_RSA_PRIV_DECODE 137
397 #define RSA_F_RSA_PRIV_ENCODE 138
398 #define RSA_F_RSA_PUB_DECODE 139
399 #define RSA_F_RSA_SETUP_BLINDING 136
400 #define RSA_F_RSA_SIGN 117
401 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118
402 #define RSA_F_RSA_VERIFY 119
403 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120
404 #define RSA_F_RSA_VERIFY_PKCS1_PSS 126
407 #define RSA_R_ALGORITHM_MISMATCH 100
408 #define RSA_R_BAD_E_VALUE 101
409 #define RSA_R_BAD_FIXED_HEADER_DECRYPT 102
410 #define RSA_R_BAD_PAD_BYTE_COUNT 103
411 #define RSA_R_BAD_SIGNATURE 104
412 #define RSA_R_BLOCK_TYPE_IS_NOT_01 106
413 #define RSA_R_BLOCK_TYPE_IS_NOT_02 107
414 #define RSA_R_DATA_GREATER_THAN_MOD_LEN 108
415 #define RSA_R_DATA_TOO_LARGE 109
416 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110
417 #define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 132
418 #define RSA_R_DATA_TOO_SMALL 111
419 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122
420 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112
421 #define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124
422 #define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125
423 #define RSA_R_D_E_NOT_CONGRUENT_TO_1 123
424 #define RSA_R_FIRST_OCTET_INVALID 133
425 #define RSA_R_INVALID_DIGEST 105
426 #define RSA_R_INVALID_DIGEST_LENGTH 143
427 #define RSA_R_INVALID_HEADER 137
428 #define RSA_R_INVALID_MESSAGE_LENGTH 131
429 #define RSA_R_INVALID_PADDING 138
430 #define RSA_R_INVALID_PADDING_MODE 141
431 #define RSA_R_INVALID_TRAILER 139
432 #define RSA_R_INVALID_X931_DIGEST 142
433 #define RSA_R_IQMP_NOT_INVERSE_OF_Q 126
434 #define RSA_R_KEY_SIZE_TOO_SMALL 120
435 #define RSA_R_LAST_OCTET_INVALID 134
436 #define RSA_R_NO_PUBLIC_EXPONENT 140
437 #define RSA_R_NULL_BEFORE_BLOCK_MISSING 113
438 #define RSA_R_N_DOES_NOT_EQUAL_P_Q 127
439 #define RSA_R_OAEP_DECODING_ERROR 121
440 #define RSA_R_PADDING_CHECK_FAILED 114
441 #define RSA_R_P_NOT_PRIME 128
442 #define RSA_R_Q_NOT_PRIME 129
443 #define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130
444 #define RSA_R_SLEN_CHECK_FAILED 136
445 #define RSA_R_SLEN_RECOVERY_FAILED 135
446 #define RSA_R_SSLV3_ROLLBACK_ATTACK 115
447 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
448 #define RSA_R_UNKNOWN_ALGORITHM_TYPE 117
449 #define RSA_R_UNKNOWN_PADDING_TYPE 118
450 #define RSA_R_WRONG_SIGNATURE_LENGTH 119