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.]
63 #include <openssl/bio.h>
65 #include <openssl/bn.h>
66 #include <openssl/crypto.h>
69 #error RSA is disabled.
76 typedef struct rsa_st RSA;
78 typedef struct rsa_meth_st
81 int (*rsa_pub_enc)(int flen,unsigned char *from,unsigned char *to,
82 RSA *rsa,int padding);
83 int (*rsa_pub_dec)(int flen,unsigned char *from,unsigned char *to,
84 RSA *rsa,int padding);
85 int (*rsa_priv_enc)(int flen,unsigned char *from,unsigned char *to,
86 RSA *rsa,int padding);
87 int (*rsa_priv_dec)(int flen,unsigned char *from,unsigned char *to,
88 RSA *rsa,int padding);
89 int (*rsa_mod_exp)(BIGNUM *r0,BIGNUM *I,RSA *rsa); /* Can be null */
90 int (*bn_mod_exp)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
91 const BIGNUM *m, BN_CTX *ctx,
92 BN_MONT_CTX *m_ctx); /* Can be null */
93 int (*init)(RSA *rsa); /* called at new */
94 int (*finish)(RSA *rsa); /* called at free */
95 int flags; /* RSA_METHOD_FLAG_* things */
96 char *app_data; /* may be needed! */
97 /* New sign and verify functions: some libraries don't allow arbitrary data
98 * to be signed/verified: this allows them to be used. Note: for this to work
99 * the RSA_public_decrypt() and RSA_private_encrypt() should *NOT* be used
100 * RSA_sign(), RSA_verify() should be used instead. Note: for backwards
101 * compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER
102 * option is set in 'flags'.
105 /* changed m_len to m_length to avoid a conflict with a #define in
106 vxworks for m_len for the mbuf code. This only shows up in apps
107 that have USE_SOCKETS defined */
109 int (*rsa_sign)(int type, unsigned char *m, unsigned int m_length,
110 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
111 int (*rsa_verify)(int dtype, unsigned char *m, unsigned int m_length,
112 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
118 /* The first parameter is used to pickup errors where
119 * this is passed instead of aEVP_PKEY, it is set to 0 */
131 /* be careful using this if the RSA structure is shared */
132 CRYPTO_EX_DATA ex_data;
136 /* Used to cache montgomery values */
137 BN_MONT_CTX *_method_mod_n;
138 BN_MONT_CTX *_method_mod_p;
139 BN_MONT_CTX *_method_mod_q;
141 /* all BIGNUM values are actually in the following data, if it is not
144 BN_BLINDING *blinding;
148 #define RSA_F4 0x10001L
150 #define RSA_METHOD_FLAG_NO_CHECK 0x01 /* don't check pub/private match */
152 #define RSA_FLAG_CACHE_PUBLIC 0x02
153 #define RSA_FLAG_CACHE_PRIVATE 0x04
154 #define RSA_FLAG_BLINDING 0x08
155 #define RSA_FLAG_THREAD_SAFE 0x10
156 /* This flag means the private key operations will be handled by rsa_mod_exp
157 * and that they do not depend on the private key components being present:
158 * for example a key stored in external hardware. Without this flag bn_mod_exp
159 * gets called when private key components are absent.
161 #define RSA_FLAG_EXT_PKEY 0x20
163 /* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions.
165 #define RSA_FLAG_SIGN_VER 0x40
167 #define RSA_PKCS1_PADDING 1
168 #define RSA_SSLV23_PADDING 2
169 #define RSA_NO_PADDING 3
170 #define RSA_PKCS1_OAEP_PADDING 4
172 #define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg)
173 #define RSA_get_app_data(s) RSA_get_ex_data(s,0)
176 RSA * RSA_new_method(RSA_METHOD *method);
178 RSA * RSA_generate_key(int bits, unsigned long e,void
179 (*callback)(int,int,void *),void *cb_arg);
180 int RSA_check_key(RSA *);
181 /* next 4 return -1 on error */
182 int RSA_public_encrypt(int flen, unsigned char *from,
183 unsigned char *to, RSA *rsa,int padding);
184 int RSA_private_encrypt(int flen, unsigned char *from,
185 unsigned char *to, RSA *rsa,int padding);
186 int RSA_public_decrypt(int flen, unsigned char *from,
187 unsigned char *to, RSA *rsa,int padding);
188 int RSA_private_decrypt(int flen, unsigned char *from,
189 unsigned char *to, RSA *rsa,int padding);
190 void RSA_free (RSA *r);
192 int RSA_flags(RSA *r);
194 void RSA_set_default_method(RSA_METHOD *meth);
195 RSA_METHOD *RSA_get_default_method(void);
196 RSA_METHOD *RSA_get_method(RSA *rsa);
197 RSA_METHOD *RSA_set_method(RSA *rsa, RSA_METHOD *meth);
199 /* This function needs the memory locking malloc callbacks to be installed */
200 int RSA_memory_lock(RSA *r);
202 /* If you have RSAref compiled in. */
203 RSA_METHOD *RSA_PKCS1_RSAref(void);
205 /* these are the actual SSLeay RSA functions */
206 RSA_METHOD *RSA_PKCS1_SSLeay(void);
208 RSA_METHOD *RSA_null_method(void);
210 RSA * d2i_RSAPublicKey(RSA **a, unsigned char **pp, long length);
211 int i2d_RSAPublicKey(RSA *a, unsigned char **pp);
212 RSA * d2i_RSAPrivateKey(RSA **a, unsigned char **pp, long length);
213 int i2d_RSAPrivateKey(RSA *a, unsigned char **pp);
215 int RSA_print_fp(FILE *fp, RSA *r,int offset);
219 int RSA_print(BIO *bp, RSA *r,int offset);
222 int i2d_RSA_NET(RSA *a, unsigned char **pp, int (*cb)(), int sgckey);
223 RSA *d2i_RSA_NET(RSA **a, unsigned char **pp, long length, int (*cb)(), int sgckey);
224 RSA *d2i_RSA_NET_2(RSA **a, unsigned char **pp, long length, int (*cb)(), int sgckey);
226 int i2d_Netscape_RSA(RSA *a, unsigned char **pp, int (*cb)());
227 RSA *d2i_Netscape_RSA(RSA **a, unsigned char **pp, long length, int (*cb)());
228 /* Naughty internal function required elsewhere, to handle a MS structure
229 * that is the same as the netscape one :-) */
230 RSA *d2i_Netscape_RSA_2(RSA **a, unsigned char **pp, long length, int (*cb)());
232 /* The following 2 functions sign and verify a X509_SIG ASN1 object
233 * inside PKCS#1 padded RSA encryption */
234 int RSA_sign(int type, unsigned char *m, unsigned int m_length,
235 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
236 int RSA_verify(int type, unsigned char *m, unsigned int m_length,
237 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
239 /* The following 2 function sign and verify a ASN1_OCTET_STRING
240 * object inside PKCS#1 padded RSA encryption */
241 int RSA_sign_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_length,
242 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
243 int RSA_verify_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_length,
244 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
246 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
247 void RSA_blinding_off(RSA *rsa);
249 int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
250 unsigned char *f,int fl);
251 int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
252 unsigned char *f,int fl,int rsa_len);
253 int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
254 unsigned char *f,int fl);
255 int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
256 unsigned char *f,int fl,int rsa_len);
257 int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen,
258 unsigned char *f,int fl,unsigned char *p,
260 int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen,
261 unsigned char *f,int fl,int rsa_len,
262 unsigned char *p,int pl);
263 int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
264 unsigned char *f,int fl);
265 int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
266 unsigned char *f,int fl,int rsa_len);
267 int RSA_padding_add_none(unsigned char *to,int tlen,
268 unsigned char *f,int fl);
269 int RSA_padding_check_none(unsigned char *to,int tlen,
270 unsigned char *f,int fl,int rsa_len);
272 int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
273 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
274 int RSA_set_ex_data(RSA *r,int idx,void *arg);
275 void *RSA_get_ex_data(RSA *r, int idx);
277 /* BEGIN ERROR CODES */
278 /* The following lines are auto generated by the script mkerr.pl. Any changes
279 * made after this point may be overwritten when the script is next run.
281 void ERR_load_RSA_strings(void);
283 /* Error codes for the RSA functions. */
285 /* Function codes. */
286 #define RSA_F_MEMORY_LOCK 100
287 #define RSA_F_RSA_CHECK_KEY 123
288 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101
289 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102
290 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103
291 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104
292 #define RSA_F_RSA_GENERATE_KEY 105
293 #define RSA_F_RSA_NEW_METHOD 106
294 #define RSA_F_RSA_NULL 124
295 #define RSA_F_RSA_PADDING_ADD_NONE 107
296 #define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121
297 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108
298 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109
299 #define RSA_F_RSA_PADDING_ADD_SSLV23 110
300 #define RSA_F_RSA_PADDING_CHECK_NONE 111
301 #define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122
302 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112
303 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113
304 #define RSA_F_RSA_PADDING_CHECK_SSLV23 114
305 #define RSA_F_RSA_PRINT 115
306 #define RSA_F_RSA_PRINT_FP 116
307 #define RSA_F_RSA_SIGN 117
308 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118
309 #define RSA_F_RSA_VERIFY 119
310 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120
313 #define RSA_R_ALGORITHM_MISMATCH 100
314 #define RSA_R_BAD_E_VALUE 101
315 #define RSA_R_BAD_FIXED_HEADER_DECRYPT 102
316 #define RSA_R_BAD_PAD_BYTE_COUNT 103
317 #define RSA_R_BAD_SIGNATURE 104
318 #define RSA_R_BLOCK_TYPE_IS_NOT_01 106
319 #define RSA_R_BLOCK_TYPE_IS_NOT_02 107
320 #define RSA_R_DATA_GREATER_THAN_MOD_LEN 108
321 #define RSA_R_DATA_TOO_LARGE 109
322 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110
323 #define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 132
324 #define RSA_R_DATA_TOO_SMALL 111
325 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122
326 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112
327 #define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124
328 #define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125
329 #define RSA_R_D_E_NOT_CONGRUENT_TO_1 123
330 #define RSA_R_INVALID_MESSAGE_LENGTH 131
331 #define RSA_R_IQMP_NOT_INVERSE_OF_Q 126
332 #define RSA_R_KEY_SIZE_TOO_SMALL 120
333 #define RSA_R_NULL_BEFORE_BLOCK_MISSING 113
334 #define RSA_R_N_DOES_NOT_EQUAL_P_Q 127
335 #define RSA_R_OAEP_DECODING_ERROR 121
336 #define RSA_R_PADDING_CHECK_FAILED 114
337 #define RSA_R_P_NOT_PRIME 128
338 #define RSA_R_Q_NOT_PRIME 129
339 #define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130
340 #define RSA_R_SSLV3_ROLLBACK_ATTACK 115
341 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
342 #define RSA_R_UNKNOWN_ALGORITHM_TYPE 117
343 #define RSA_R_UNKNOWN_PADDING_TYPE 118
344 #define RSA_R_WRONG_SIGNATURE_LENGTH 119