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