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>
73 # ifdef OPENSSL_NO_RSA
74 # error RSA is disabled.
78 * If this flag is set the RSA method is FIPS compliant and can be used in
79 * FIPS mode. This is set in the validated module method. If an application
80 * sets this flag in its own methods it is its reposibility to ensure the
81 * result is compliant.
84 # define RSA_FLAG_FIPS_METHOD 0x0400
87 * If this flag is set the operations normally disabled in FIPS mode are
88 * permitted it is then the applications responsibility to ensure that the
92 # define RSA_FLAG_NON_FIPS_ALLOW 0x0400
95 # define FIPS_RSA_SIZE_T int
102 /* Declared already in ossl_typ.h */
103 /* typedef struct rsa_st RSA; */
104 /* typedef struct rsa_meth_st RSA_METHOD; */
108 int (*rsa_pub_enc) (int flen, const unsigned char *from,
109 unsigned char *to, RSA *rsa, int padding);
110 int (*rsa_pub_dec) (int flen, const unsigned char *from,
111 unsigned char *to, RSA *rsa, int padding);
112 int (*rsa_priv_enc) (int flen, const unsigned char *from,
113 unsigned char *to, RSA *rsa, int padding);
114 int (*rsa_priv_dec) (int flen, const unsigned char *from,
115 unsigned char *to, RSA *rsa, int padding);
117 int (*rsa_mod_exp) (BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx);
119 int (*bn_mod_exp) (BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
120 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
122 int (*init) (RSA *rsa);
124 int (*finish) (RSA *rsa);
125 /* RSA_METHOD_FLAG_* things */
130 * New sign and verify functions: some libraries don't allow arbitrary
131 * data to be signed/verified: this allows them to be used. Note: for
132 * this to work the RSA_public_decrypt() and RSA_private_encrypt() should
133 * *NOT* be used RSA_sign(), RSA_verify() should be used instead. Note:
134 * for backwards compatibility this functionality is only enabled if the
135 * RSA_FLAG_SIGN_VER option is set in 'flags'.
137 int (*rsa_sign) (int type,
138 const unsigned char *m, unsigned int m_length,
139 unsigned char *sigret, unsigned int *siglen,
141 int (*rsa_verify) (int dtype, const unsigned char *m,
142 unsigned int m_length, unsigned char *sigbuf,
143 unsigned int siglen, const RSA *rsa);
145 * If this callback is NULL, the builtin software RSA key-gen will be
146 * used. This is for behavioural compatibility whilst the code gets
147 * rewired, but one day it would be nice to assume there are no such
148 * things as "builtin software" implementations.
150 int (*rsa_keygen) (RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
155 * The first parameter is used to pickup errors where this is passed
156 * instead of aEVP_PKEY, it is set to 0
160 const RSA_METHOD *meth;
161 /* functional reference if 'meth' is ENGINE-provided */
171 /* be careful using this if the RSA structure is shared */
172 CRYPTO_EX_DATA ex_data;
175 /* Used to cache montgomery values */
176 BN_MONT_CTX *_method_mod_n;
177 BN_MONT_CTX *_method_mod_p;
178 BN_MONT_CTX *_method_mod_q;
180 * all BIGNUM values are actually in the following data, if it is not
184 BN_BLINDING *blinding;
185 BN_BLINDING *mt_blinding;
188 # ifndef OPENSSL_RSA_MAX_MODULUS_BITS
189 # define OPENSSL_RSA_MAX_MODULUS_BITS 16384
192 # define OPENSSL_RSA_FIPS_MIN_MODULUS_BITS 1024
194 # ifndef OPENSSL_RSA_SMALL_MODULUS_BITS
195 # define OPENSSL_RSA_SMALL_MODULUS_BITS 3072
197 # ifndef OPENSSL_RSA_MAX_PUBEXP_BITS
199 /* exponent limit enforced for "large" modulus only */
200 # define OPENSSL_RSA_MAX_PUBEXP_BITS 64
204 # define RSA_F4 0x10001L
206 # define RSA_METHOD_FLAG_NO_CHECK 0x0001/* don't check pub/private
209 # define RSA_FLAG_CACHE_PUBLIC 0x0002
210 # define RSA_FLAG_CACHE_PRIVATE 0x0004
211 # define RSA_FLAG_BLINDING 0x0008
212 # define RSA_FLAG_THREAD_SAFE 0x0010
214 * This flag means the private key operations will be handled by rsa_mod_exp
215 * and that they do not depend on the private key components being present:
216 * for example a key stored in external hardware. Without this flag
217 * bn_mod_exp gets called when private key components are absent.
219 # define RSA_FLAG_EXT_PKEY 0x0020
222 * This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify
225 # define RSA_FLAG_SIGN_VER 0x0040
228 * new with 0.9.6j and 0.9.7b; the built-in
229 * RSA implementation now uses blinding by
230 * default (ignoring RSA_FLAG_BLINDING),
231 * but other engines might not need it
233 # define RSA_FLAG_NO_BLINDING 0x0080
235 * new with 0.9.8f; the built-in RSA
236 * implementation now uses constant time
237 * operations by default in private key operations,
238 * e.g., constant time modular exponentiation,
239 * modular inverse without leaking branches,
240 * division without leaking branches. This
241 * flag disables these constant time
242 * operations and results in faster RSA
243 * private key operations.
245 # define RSA_FLAG_NO_CONSTTIME 0x0100
246 # ifdef OPENSSL_USE_DEPRECATED
247 /* deprecated name for the flag*/
249 * new with 0.9.7h; the built-in RSA
250 * implementation now uses constant time
251 * modular exponentiation for secret exponents
252 * by default. This flag causes the
253 * faster variable sliding window method to
254 * be used for all exponents.
256 # define RSA_FLAG_NO_EXP_CONSTTIME RSA_FLAG_NO_CONSTTIME
259 # define RSA_PKCS1_PADDING 1
260 # define RSA_SSLV23_PADDING 2
261 # define RSA_NO_PADDING 3
262 # define RSA_PKCS1_OAEP_PADDING 4
263 # define RSA_X931_PADDING 5
265 # define RSA_PKCS1_PADDING_SIZE 11
267 # define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg)
268 # define RSA_get_app_data(s) RSA_get_ex_data(s,0)
271 RSA *RSA_new_method(ENGINE *engine);
272 int RSA_size(const RSA *);
274 /* Deprecated version */
275 # ifndef OPENSSL_NO_DEPRECATED
276 RSA *RSA_generate_key(int bits, unsigned long e, void
277 (*callback) (int, int, void *), void *cb_arg);
278 # endif /* !defined(OPENSSL_NO_DEPRECATED) */
281 int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
282 int RSA_X931_derive_ex(RSA *rsa, BIGNUM *p1, BIGNUM *p2, BIGNUM *q1,
283 BIGNUM *q2, const BIGNUM *Xp1, const BIGNUM *Xp2,
284 const BIGNUM *Xp, const BIGNUM *Xq1, const BIGNUM *Xq2,
285 const BIGNUM *Xq, const BIGNUM *e, BN_GENCB *cb);
286 int RSA_X931_generate_key_ex(RSA *rsa, int bits, const BIGNUM *e,
289 int RSA_check_key(const RSA *);
290 /* next 4 return -1 on error */
291 int RSA_public_encrypt(int flen, const unsigned char *from,
292 unsigned char *to, RSA *rsa, int padding);
293 int RSA_private_encrypt(int flen, const unsigned char *from,
294 unsigned char *to, RSA *rsa, int padding);
295 int RSA_public_decrypt(int flen, const unsigned char *from,
296 unsigned char *to, RSA *rsa, int padding);
297 int RSA_private_decrypt(int flen, const unsigned char *from,
298 unsigned char *to, RSA *rsa, int padding);
299 void RSA_free(RSA *r);
300 /* "up" the RSA object's reference count */
301 int RSA_up_ref(RSA *r);
303 int RSA_flags(const RSA *r);
306 RSA *FIPS_rsa_new(void);
307 void FIPS_rsa_free(RSA *r);
310 void RSA_set_default_method(const RSA_METHOD *meth);
311 const RSA_METHOD *RSA_get_default_method(void);
312 const RSA_METHOD *RSA_get_method(const RSA *rsa);
313 int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
315 /* This function needs the memory locking malloc callbacks to be installed */
316 int RSA_memory_lock(RSA *r);
318 /* these are the actual SSLeay RSA functions */
319 const RSA_METHOD *RSA_PKCS1_SSLeay(void);
321 const RSA_METHOD *RSA_null_method(void);
323 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPublicKey)
324 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPrivateKey)
326 # ifndef OPENSSL_NO_FP_API
327 int RSA_print_fp(FILE *fp, const RSA *r, int offset);
330 # ifndef OPENSSL_NO_BIO
331 int RSA_print(BIO *bp, const RSA *r, int offset);
334 # ifndef OPENSSL_NO_RC4
335 int i2d_RSA_NET(const RSA *a, unsigned char **pp,
336 int (*cb) (char *buf, int len, const char *prompt,
337 int verify), int sgckey);
338 RSA *d2i_RSA_NET(RSA **a, const unsigned char **pp, long length,
339 int (*cb) (char *buf, int len, const char *prompt,
340 int verify), int sgckey);
342 int i2d_Netscape_RSA(const RSA *a, unsigned char **pp,
343 int (*cb) (char *buf, int len, const char *prompt,
345 RSA *d2i_Netscape_RSA(RSA **a, const unsigned char **pp, long length,
346 int (*cb) (char *buf, int len, const char *prompt,
351 * The following 2 functions sign and verify a X509_SIG ASN1 object inside
352 * PKCS#1 padded RSA encryption
354 int RSA_sign(int type, const unsigned char *m, unsigned int m_length,
355 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
356 int RSA_verify(int type, const unsigned char *m, unsigned int m_length,
357 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
360 * The following 2 function sign and verify a ASN1_OCTET_STRING object inside
361 * PKCS#1 padded RSA encryption
363 int RSA_sign_ASN1_OCTET_STRING(int type,
364 const unsigned char *m, unsigned int m_length,
365 unsigned char *sigret, unsigned int *siglen,
367 int RSA_verify_ASN1_OCTET_STRING(int type, const unsigned char *m,
368 unsigned int m_length, unsigned char *sigbuf,
369 unsigned int siglen, RSA *rsa);
371 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
372 void RSA_blinding_off(RSA *rsa);
373 BN_BLINDING *RSA_setup_blinding(RSA *rsa, BN_CTX *ctx);
375 int RSA_padding_add_PKCS1_type_1(unsigned char *to, int tlen,
376 const unsigned char *f, int fl);
377 int RSA_padding_check_PKCS1_type_1(unsigned char *to, int tlen,
378 const unsigned char *f, int fl,
380 int RSA_padding_add_PKCS1_type_2(unsigned char *to, int tlen,
381 const unsigned char *f, int fl);
382 int RSA_padding_check_PKCS1_type_2(unsigned char *to, int tlen,
383 const unsigned char *f, int fl,
385 int PKCS1_MGF1(unsigned char *mask, long len, const unsigned char *seed,
386 long seedlen, const EVP_MD *dgst);
387 int RSA_padding_add_PKCS1_OAEP(unsigned char *to, int tlen,
388 const unsigned char *f, int fl,
389 const unsigned char *p, int pl);
390 int RSA_padding_check_PKCS1_OAEP(unsigned char *to, int tlen,
391 const unsigned char *f, int fl, int rsa_len,
392 const unsigned char *p, int pl);
393 int RSA_padding_add_SSLv23(unsigned char *to, int tlen,
394 const unsigned char *f, int fl);
395 int RSA_padding_check_SSLv23(unsigned char *to, int tlen,
396 const unsigned char *f, int fl, int rsa_len);
397 int RSA_padding_add_none(unsigned char *to, int tlen, const unsigned char *f,
399 int RSA_padding_check_none(unsigned char *to, int tlen,
400 const unsigned char *f, int fl, int rsa_len);
401 int RSA_padding_add_X931(unsigned char *to, int tlen, const unsigned char *f,
403 int RSA_padding_check_X931(unsigned char *to, int tlen,
404 const unsigned char *f, int fl, int rsa_len);
405 int RSA_X931_hash_id(int nid);
407 int RSA_verify_PKCS1_PSS(RSA *rsa, const unsigned char *mHash,
408 const EVP_MD *Hash, const unsigned char *EM,
410 int RSA_padding_add_PKCS1_PSS(RSA *rsa, unsigned char *EM,
411 const unsigned char *mHash, const EVP_MD *Hash,
414 int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
415 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
416 int RSA_set_ex_data(RSA *r, int idx, void *arg);
417 void *RSA_get_ex_data(const RSA *r, int idx);
419 RSA *RSAPublicKey_dup(RSA *rsa);
420 RSA *RSAPrivateKey_dup(RSA *rsa);
422 /* BEGIN ERROR CODES */
424 * The following lines are auto generated by the script mkerr.pl. Any changes
425 * made after this point may be overwritten when the script is next run.
427 void ERR_load_RSA_strings(void);
429 /* Error codes for the RSA functions. */
431 /* Function codes. */
432 # define RSA_F_FIPS_RSA_SIGN 140
433 # define RSA_F_FIPS_RSA_VERIFY 141
434 # define RSA_F_MEMORY_LOCK 100
435 # define RSA_F_RSA_BUILTIN_KEYGEN 129
436 # define RSA_F_RSA_CHECK_KEY 123
437 # define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101
438 # define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102
439 # define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103
440 # define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104
441 # define RSA_F_RSA_GENERATE_KEY 105
442 # define RSA_F_RSA_MEMORY_LOCK 130
443 # define RSA_F_RSA_NEW_METHOD 106
444 # define RSA_F_RSA_NULL 124
445 # define RSA_F_RSA_NULL_MOD_EXP 131
446 # define RSA_F_RSA_NULL_PRIVATE_DECRYPT 132
447 # define RSA_F_RSA_NULL_PRIVATE_ENCRYPT 133
448 # define RSA_F_RSA_NULL_PUBLIC_DECRYPT 134
449 # define RSA_F_RSA_NULL_PUBLIC_ENCRYPT 135
450 # define RSA_F_RSA_PADDING_ADD_NONE 107
451 # define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121
452 # define RSA_F_RSA_PADDING_ADD_PKCS1_PSS 125
453 # define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108
454 # define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109
455 # define RSA_F_RSA_PADDING_ADD_SSLV23 110
456 # define RSA_F_RSA_PADDING_ADD_X931 127
457 # define RSA_F_RSA_PADDING_CHECK_NONE 111
458 # define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122
459 # define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112
460 # define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113
461 # define RSA_F_RSA_PADDING_CHECK_SSLV23 114
462 # define RSA_F_RSA_PADDING_CHECK_X931 128
463 # define RSA_F_RSA_PRINT 115
464 # define RSA_F_RSA_PRINT_FP 116
465 # define RSA_F_RSA_PRIVATE_ENCRYPT 137
466 # define RSA_F_RSA_PUBLIC_DECRYPT 138
467 # define RSA_F_RSA_SETUP_BLINDING 136
468 # define RSA_F_RSA_SET_DEFAULT_METHOD 139
469 # define RSA_F_RSA_SET_METHOD 142
470 # define RSA_F_RSA_SIGN 117
471 # define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118
472 # define RSA_F_RSA_VERIFY 119
473 # define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120
474 # define RSA_F_RSA_VERIFY_PKCS1_PSS 126
477 # define RSA_R_ALGORITHM_MISMATCH 100
478 # define RSA_R_BAD_E_VALUE 101
479 # define RSA_R_BAD_FIXED_HEADER_DECRYPT 102
480 # define RSA_R_BAD_PAD_BYTE_COUNT 103
481 # define RSA_R_BAD_SIGNATURE 104
482 # define RSA_R_BLOCK_TYPE_IS_NOT_01 106
483 # define RSA_R_BLOCK_TYPE_IS_NOT_02 107
484 # define RSA_R_DATA_GREATER_THAN_MOD_LEN 108
485 # define RSA_R_DATA_TOO_LARGE 109
486 # define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110
487 # define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 132
488 # define RSA_R_DATA_TOO_SMALL 111
489 # define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122
490 # define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112
491 # define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124
492 # define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125
493 # define RSA_R_D_E_NOT_CONGRUENT_TO_1 123
494 # define RSA_R_FIRST_OCTET_INVALID 133
495 # define RSA_R_INVALID_HEADER 137
496 # define RSA_R_INVALID_MESSAGE_LENGTH 131
497 # define RSA_R_INVALID_PADDING 138
498 # define RSA_R_INVALID_TRAILER 139
499 # define RSA_R_IQMP_NOT_INVERSE_OF_Q 126
500 # define RSA_R_KEY_SIZE_TOO_SMALL 120
501 # define RSA_R_LAST_OCTET_INVALID 134
502 # define RSA_R_MODULUS_TOO_LARGE 105
503 # define RSA_R_NON_FIPS_METHOD 141
504 # define RSA_R_NO_PUBLIC_EXPONENT 140
505 # define RSA_R_NULL_BEFORE_BLOCK_MISSING 113
506 # define RSA_R_N_DOES_NOT_EQUAL_P_Q 127
507 # define RSA_R_OAEP_DECODING_ERROR 121
508 # define RSA_R_OPERATION_NOT_ALLOWED_IN_FIPS_MODE 142
509 # define RSA_R_PADDING_CHECK_FAILED 114
510 # define RSA_R_PKCS_DECODING_ERROR 159
511 # define RSA_R_P_NOT_PRIME 128
512 # define RSA_R_Q_NOT_PRIME 129
513 # define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130
514 # define RSA_R_SLEN_CHECK_FAILED 136
515 # define RSA_R_SLEN_RECOVERY_FAILED 135
516 # define RSA_R_SSLV3_ROLLBACK_ATTACK 115
517 # define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
518 # define RSA_R_UNKNOWN_ALGORITHM_TYPE 117
519 # define RSA_R_UNKNOWN_PADDING_TYPE 118
520 # define RSA_R_WRONG_SIGNATURE_LENGTH 119