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 unsigned char *sigbuf, unsigned int siglen, const RSA *rsa);
121 /* If this callback is NULL, the builtin software RSA key-gen will be used. This
122 * is for behavioural compatibility whilst the code gets rewired, but one day
123 * it would be nice to assume there are no such things as "builtin software"
124 * implementations. */
125 int (*rsa_keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
130 /* The first parameter is used to pickup errors where
131 * this is passed instead of aEVP_PKEY, it is set to 0 */
134 const RSA_METHOD *meth;
135 /* functional reference if 'meth' is ENGINE-provided */
145 /* be careful using this if the RSA structure is shared */
146 CRYPTO_EX_DATA ex_data;
150 /* Used to cache montgomery values */
151 BN_MONT_CTX *_method_mod_n;
152 BN_MONT_CTX *_method_mod_p;
153 BN_MONT_CTX *_method_mod_q;
155 /* all BIGNUM values are actually in the following data, if it is not
158 BN_BLINDING *blinding;
159 BN_BLINDING *mt_blinding;
163 #define RSA_F4 0x10001L
165 #define RSA_METHOD_FLAG_NO_CHECK 0x0001 /* don't check pub/private match */
167 #define RSA_FLAG_CACHE_PUBLIC 0x0002
168 #define RSA_FLAG_CACHE_PRIVATE 0x0004
169 #define RSA_FLAG_BLINDING 0x0008
170 #define RSA_FLAG_THREAD_SAFE 0x0010
171 /* This flag means the private key operations will be handled by rsa_mod_exp
172 * and that they do not depend on the private key components being present:
173 * for example a key stored in external hardware. Without this flag bn_mod_exp
174 * gets called when private key components are absent.
176 #define RSA_FLAG_EXT_PKEY 0x0020
178 /* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions.
180 #define RSA_FLAG_SIGN_VER 0x0040
182 #define RSA_FLAG_NO_BLINDING 0x0080 /* new with 0.9.6j and 0.9.7b; the built-in
183 * RSA implementation now uses blinding by
184 * default (ignoring RSA_FLAG_BLINDING),
185 * but other engines might not need it
187 #define RSA_FLAG_NO_EXP_CONSTTIME 0x0100 /* new with 0.9.7h; the built-in RSA
188 * implementation now uses constant time
189 * modular exponentiation for secret exponents
190 * by default. This flag causes the
191 * faster variable sliding window method to
192 * be used for all exponents.
195 #define RSA_PKCS1_PADDING 1
196 #define RSA_SSLV23_PADDING 2
197 #define RSA_NO_PADDING 3
198 #define RSA_PKCS1_OAEP_PADDING 4
200 #define RSA_PKCS1_PADDING_SIZE 11
202 #define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg)
203 #define RSA_get_app_data(s) RSA_get_ex_data(s,0)
206 RSA * RSA_new_method(ENGINE *engine);
207 int RSA_size(const RSA *);
209 /* Deprecated version */
210 #ifndef OPENSSL_NO_DEPRECATED
211 RSA * RSA_generate_key(int bits, unsigned long e,void
212 (*callback)(int,int,void *),void *cb_arg);
213 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
216 int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
218 int RSA_check_key(const RSA *);
219 /* next 4 return -1 on error */
220 int RSA_public_encrypt(int flen, const unsigned char *from,
221 unsigned char *to, RSA *rsa,int padding);
222 int RSA_private_encrypt(int flen, const unsigned char *from,
223 unsigned char *to, RSA *rsa,int padding);
224 int RSA_public_decrypt(int flen, const unsigned char *from,
225 unsigned char *to, RSA *rsa,int padding);
226 int RSA_private_decrypt(int flen, const unsigned char *from,
227 unsigned char *to, RSA *rsa,int padding);
228 void RSA_free (RSA *r);
229 /* "up" the RSA object's reference count */
230 int RSA_up_ref(RSA *r);
232 int RSA_flags(const RSA *r);
234 void RSA_set_default_method(const RSA_METHOD *meth);
235 const RSA_METHOD *RSA_get_default_method(void);
236 const RSA_METHOD *RSA_get_method(const RSA *rsa);
237 int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
239 /* This function needs the memory locking malloc callbacks to be installed */
240 int RSA_memory_lock(RSA *r);
242 /* these are the actual SSLeay RSA functions */
243 const RSA_METHOD *RSA_PKCS1_SSLeay(void);
245 const RSA_METHOD *RSA_null_method(void);
247 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPublicKey)
248 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPrivateKey)
250 #ifndef OPENSSL_NO_FP_API
251 int RSA_print_fp(FILE *fp, const RSA *r,int offset);
254 #ifndef OPENSSL_NO_BIO
255 int RSA_print(BIO *bp, const RSA *r,int offset);
258 int i2d_RSA_NET(const RSA *a, unsigned char **pp,
259 int (*cb)(char *buf, int len, const char *prompt, int verify),
261 RSA *d2i_RSA_NET(RSA **a, const unsigned char **pp, long length,
262 int (*cb)(char *buf, int len, const char *prompt, int verify),
265 int i2d_Netscape_RSA(const RSA *a, unsigned char **pp,
266 int (*cb)(char *buf, int len, const char *prompt,
268 RSA *d2i_Netscape_RSA(RSA **a, const unsigned char **pp, long length,
269 int (*cb)(char *buf, int len, const char *prompt,
272 /* The following 2 functions sign and verify a X509_SIG ASN1 object
273 * inside PKCS#1 padded RSA encryption */
274 int RSA_sign(int type, const unsigned char *m, unsigned int m_length,
275 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
276 int RSA_verify(int type, const unsigned char *m, unsigned int m_length,
277 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
279 /* The following 2 function sign and verify a ASN1_OCTET_STRING
280 * object inside PKCS#1 padded RSA encryption */
281 int RSA_sign_ASN1_OCTET_STRING(int type,
282 const unsigned char *m, unsigned int m_length,
283 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
284 int RSA_verify_ASN1_OCTET_STRING(int type,
285 const unsigned char *m, unsigned int m_length,
286 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
288 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
289 void RSA_blinding_off(RSA *rsa);
290 BN_BLINDING *RSA_setup_blinding(RSA *rsa, BN_CTX *ctx);
292 int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
293 const unsigned char *f,int fl);
294 int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
295 const unsigned char *f,int fl,int rsa_len);
296 int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
297 const unsigned char *f,int fl);
298 int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
299 const unsigned char *f,int fl,int rsa_len);
300 int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen,
301 const unsigned char *f,int fl,
302 const unsigned char *p,int pl);
303 int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen,
304 const unsigned char *f,int fl,int rsa_len,
305 const unsigned char *p,int pl);
306 int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
307 const unsigned char *f,int fl);
308 int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
309 const unsigned char *f,int fl,int rsa_len);
310 int RSA_padding_add_none(unsigned char *to,int tlen,
311 const unsigned char *f,int fl);
312 int RSA_padding_check_none(unsigned char *to,int tlen,
313 const unsigned char *f,int fl,int rsa_len);
315 int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
316 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
317 int RSA_set_ex_data(RSA *r,int idx,void *arg);
318 void *RSA_get_ex_data(const RSA *r, int idx);
320 RSA *RSAPublicKey_dup(RSA *rsa);
321 RSA *RSAPrivateKey_dup(RSA *rsa);
323 /* BEGIN ERROR CODES */
324 /* The following lines are auto generated by the script mkerr.pl. Any changes
325 * made after this point may be overwritten when the script is next run.
327 void ERR_load_RSA_strings(void);
329 /* Error codes for the RSA functions. */
331 /* Function codes. */
332 #define RSA_F_RSA_BUILTIN_KEYGEN 105
333 #define RSA_F_RSA_CHECK_KEY 123
334 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101
335 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102
336 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103
337 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104
338 #define RSA_F_RSA_MEMORY_LOCK 100
339 #define RSA_F_RSA_NEW_METHOD 106
340 #define RSA_F_RSA_NULL 124
341 #define RSA_F_RSA_NULL_MOD_EXP 126
342 #define RSA_F_RSA_NULL_PRIVATE_DECRYPT 127
343 #define RSA_F_RSA_NULL_PRIVATE_ENCRYPT 128
344 #define RSA_F_RSA_NULL_PUBLIC_DECRYPT 129
345 #define RSA_F_RSA_NULL_PUBLIC_ENCRYPT 130
346 #define RSA_F_RSA_PADDING_ADD_NONE 107
347 #define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121
348 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108
349 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109
350 #define RSA_F_RSA_PADDING_ADD_SSLV23 110
351 #define RSA_F_RSA_PADDING_CHECK_NONE 111
352 #define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122
353 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112
354 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113
355 #define RSA_F_RSA_PADDING_CHECK_SSLV23 114
356 #define RSA_F_RSA_PRINT 115
357 #define RSA_F_RSA_PRINT_FP 116
358 #define RSA_F_RSA_SETUP_BLINDING 125
359 #define RSA_F_RSA_SIGN 117
360 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118
361 #define RSA_F_RSA_VERIFY 119
362 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120
365 #define RSA_R_ALGORITHM_MISMATCH 100
366 #define RSA_R_BAD_E_VALUE 101
367 #define RSA_R_BAD_FIXED_HEADER_DECRYPT 102
368 #define RSA_R_BAD_PAD_BYTE_COUNT 103
369 #define RSA_R_BAD_SIGNATURE 104
370 #define RSA_R_BLOCK_TYPE_IS_NOT_01 106
371 #define RSA_R_BLOCK_TYPE_IS_NOT_02 107
372 #define RSA_R_DATA_GREATER_THAN_MOD_LEN 108
373 #define RSA_R_DATA_TOO_LARGE 109
374 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110
375 #define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 132
376 #define RSA_R_DATA_TOO_SMALL 111
377 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122
378 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112
379 #define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124
380 #define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125
381 #define RSA_R_D_E_NOT_CONGRUENT_TO_1 123
382 #define RSA_R_INVALID_MESSAGE_LENGTH 131
383 #define RSA_R_IQMP_NOT_INVERSE_OF_Q 126
384 #define RSA_R_KEY_SIZE_TOO_SMALL 120
385 #define RSA_R_NO_PUBLIC_EXPONENT 133
386 #define RSA_R_NULL_BEFORE_BLOCK_MISSING 113
387 #define RSA_R_N_DOES_NOT_EQUAL_P_Q 127
388 #define RSA_R_OAEP_DECODING_ERROR 121
389 #define RSA_R_PADDING_CHECK_FAILED 114
390 #define RSA_R_P_NOT_PRIME 128
391 #define RSA_R_Q_NOT_PRIME 129
392 #define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130
393 #define RSA_R_SSLV3_ROLLBACK_ATTACK 115
394 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
395 #define RSA_R_UNKNOWN_ALGORITHM_TYPE 117
396 #define RSA_R_UNKNOWN_PADDING_TYPE 118
397 #define RSA_R_WRONG_SIGNATURE_LENGTH 119