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/bn.h>
68 #include <openssl/crypto.h>
69 #include <openssl/ossl_typ.h>
72 #error RSA is disabled.
75 #if defined(OPENSSL_FIPS)
76 #define FIPS_RSA_SIZE_T int
83 typedef struct rsa_st RSA
;
85 typedef struct rsa_meth_st
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
); /* 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
);
126 /* The first parameter is used to pickup errors where
127 * this is passed instead of aEVP_PKEY, it is set to 0 */
130 const RSA_METHOD
*meth
;
131 /* functional reference if 'meth' is ENGINE-provided */
141 /* be careful using this if the RSA structure is shared */
142 CRYPTO_EX_DATA ex_data
;
146 /* Used to cache montgomery values */
147 BN_MONT_CTX
*_method_mod_n
;
148 BN_MONT_CTX
*_method_mod_p
;
149 BN_MONT_CTX
*_method_mod_q
;
151 /* all BIGNUM values are actually in the following data, if it is not
154 BN_BLINDING
*blinding
;
158 #define RSA_F4 0x10001L
160 #define RSA_METHOD_FLAG_NO_CHECK 0x01 /* don't check pub/private match */
162 #define RSA_FLAG_CACHE_PUBLIC 0x02
163 #define RSA_FLAG_CACHE_PRIVATE 0x04
164 #define RSA_FLAG_BLINDING 0x08
165 #define RSA_FLAG_THREAD_SAFE 0x10
166 /* This flag means the private key operations will be handled by rsa_mod_exp
167 * and that they do not depend on the private key components being present:
168 * for example a key stored in external hardware. Without this flag bn_mod_exp
169 * gets called when private key components are absent.
171 #define RSA_FLAG_EXT_PKEY 0x20
173 /* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions.
175 #define RSA_FLAG_SIGN_VER 0x40
177 #define RSA_FLAG_NO_BLINDING 0x80 /* new with 0.9.6j and 0.9.7b; the built-in
178 * RSA implementation now uses blinding by
179 * default (ignoring RSA_FLAG_BLINDING),
180 * but other engines might not need it
183 #define RSA_PKCS1_PADDING 1
184 #define RSA_SSLV23_PADDING 2
185 #define RSA_NO_PADDING 3
186 #define RSA_PKCS1_OAEP_PADDING 4
188 #define RSA_PKCS1_PADDING_SIZE 11
190 #define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg)
191 #define RSA_get_app_data(s) RSA_get_ex_data(s,0)
194 RSA
* RSA_new_method(ENGINE
*engine
);
195 int RSA_size(const RSA
*);
196 RSA
* RSA_generate_key(int bits
, unsigned long e
,void
197 (*callback
)(int,int,void *),void *cb_arg
);
198 int RSA_check_key(const RSA
*);
199 /* next 4 return -1 on error */
200 int RSA_public_encrypt(int flen
, const unsigned char *from
,
201 unsigned char *to
, RSA
*rsa
,int padding
);
202 int RSA_private_encrypt(int flen
, const unsigned char *from
,
203 unsigned char *to
, RSA
*rsa
,int padding
);
204 int RSA_public_decrypt(int flen
, const unsigned char *from
,
205 unsigned char *to
, RSA
*rsa
,int padding
);
206 int RSA_private_decrypt(int flen
, const unsigned char *from
,
207 unsigned char *to
, RSA
*rsa
,int padding
);
208 void RSA_free (RSA
*r
);
209 /* "up" the RSA object's reference count */
210 int RSA_up_ref(RSA
*r
);
212 int RSA_flags(const RSA
*r
);
214 void RSA_set_default_method(const RSA_METHOD
*meth
);
215 const RSA_METHOD
*RSA_get_default_method(void);
216 const RSA_METHOD
*RSA_get_method(const RSA
*rsa
);
217 int RSA_set_method(RSA
*rsa
, const RSA_METHOD
*meth
);
219 /* This function needs the memory locking malloc callbacks to be installed */
220 int RSA_memory_lock(RSA
*r
);
222 /* these are the actual SSLeay RSA functions */
223 const RSA_METHOD
*RSA_PKCS1_SSLeay(void);
225 const RSA_METHOD
*RSA_null_method(void);
227 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA
, RSAPublicKey
)
228 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA
, RSAPrivateKey
)
230 #ifndef OPENSSL_NO_FP_API
231 int RSA_print_fp(FILE *fp
, const RSA
*r
,int offset
);
234 #ifndef OPENSSL_NO_BIO
235 int RSA_print(BIO
*bp
, const RSA
*r
,int offset
);
238 int i2d_RSA_NET(const RSA
*a
, unsigned char **pp
, int (*cb
)(), int sgckey
);
239 RSA
*d2i_RSA_NET(RSA
**a
, const unsigned char **pp
, long length
, int (*cb
)(), int sgckey
);
241 int i2d_Netscape_RSA(const RSA
*a
, unsigned char **pp
, int (*cb
)());
242 RSA
*d2i_Netscape_RSA(RSA
**a
, const unsigned char **pp
, long length
, int (*cb
)());
244 /* The following 2 functions sign and verify a X509_SIG ASN1 object
245 * inside PKCS#1 padded RSA encryption */
246 int RSA_sign(int type
, const unsigned char *m
, unsigned int m_length
,
247 unsigned char *sigret
, unsigned int *siglen
, RSA
*rsa
);
248 int RSA_verify(int type
, const unsigned char *m
, unsigned int m_length
,
249 unsigned char *sigbuf
, unsigned int siglen
, RSA
*rsa
);
251 /* The following 2 function sign and verify a ASN1_OCTET_STRING
252 * object inside PKCS#1 padded RSA encryption */
253 int RSA_sign_ASN1_OCTET_STRING(int type
,
254 const unsigned char *m
, unsigned int m_length
,
255 unsigned char *sigret
, unsigned int *siglen
, RSA
*rsa
);
256 int RSA_verify_ASN1_OCTET_STRING(int type
,
257 const unsigned char *m
, unsigned int m_length
,
258 unsigned char *sigbuf
, unsigned int siglen
, RSA
*rsa
);
260 int RSA_blinding_on(RSA
*rsa
, BN_CTX
*ctx
);
261 void RSA_blinding_off(RSA
*rsa
);
263 int RSA_padding_add_PKCS1_type_1(unsigned char *to
,int tlen
,
264 const unsigned char *f
,int fl
);
265 int RSA_padding_check_PKCS1_type_1(unsigned char *to
,int tlen
,
266 const unsigned char *f
,int fl
,int rsa_len
);
267 int RSA_padding_add_PKCS1_type_2(unsigned char *to
,int tlen
,
268 const unsigned char *f
,int fl
);
269 int RSA_padding_check_PKCS1_type_2(unsigned char *to
,int tlen
,
270 const unsigned char *f
,int fl
,int rsa_len
);
271 int RSA_padding_add_PKCS1_OAEP(unsigned char *to
,int tlen
,
272 const unsigned char *f
,int fl
,
273 const unsigned char *p
,int pl
);
274 int RSA_padding_check_PKCS1_OAEP(unsigned char *to
,int tlen
,
275 const unsigned char *f
,int fl
,int rsa_len
,
276 const unsigned char *p
,int pl
);
277 int RSA_padding_add_SSLv23(unsigned char *to
,int tlen
,
278 const unsigned char *f
,int fl
);
279 int RSA_padding_check_SSLv23(unsigned char *to
,int tlen
,
280 const unsigned char *f
,int fl
,int rsa_len
);
281 int RSA_padding_add_none(unsigned char *to
,int tlen
,
282 const unsigned char *f
,int fl
);
283 int RSA_padding_check_none(unsigned char *to
,int tlen
,
284 const unsigned char *f
,int fl
,int rsa_len
);
286 int RSA_get_ex_new_index(long argl
, void *argp
, CRYPTO_EX_new
*new_func
,
287 CRYPTO_EX_dup
*dup_func
, CRYPTO_EX_free
*free_func
);
288 int RSA_set_ex_data(RSA
*r
,int idx
,void *arg
);
289 void *RSA_get_ex_data(const RSA
*r
, int idx
);
291 RSA
*RSAPublicKey_dup(RSA
*rsa
);
292 RSA
*RSAPrivateKey_dup(RSA
*rsa
);
294 /* BEGIN ERROR CODES */
295 /* The following lines are auto generated by the script mkerr.pl. Any changes
296 * made after this point may be overwritten when the script is next run.
298 void ERR_load_RSA_strings(void);
300 /* Error codes for the RSA functions. */
302 /* Function codes. */
303 #define RSA_F_MEMORY_LOCK 100
304 #define RSA_F_RSA_CHECK_KEY 123
305 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101
306 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102
307 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103
308 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104
309 #define RSA_F_RSA_GENERATE_KEY 105
310 #define RSA_F_RSA_NEW_METHOD 106
311 #define RSA_F_RSA_NULL 124
312 #define RSA_F_RSA_PADDING_ADD_NONE 107
313 #define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121
314 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108
315 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109
316 #define RSA_F_RSA_PADDING_ADD_SSLV23 110
317 #define RSA_F_RSA_PADDING_CHECK_NONE 111
318 #define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122
319 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112
320 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113
321 #define RSA_F_RSA_PADDING_CHECK_SSLV23 114
322 #define RSA_F_RSA_PRINT 115
323 #define RSA_F_RSA_PRINT_FP 116
324 #define RSA_F_RSA_SIGN 117
325 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118
326 #define RSA_F_RSA_VERIFY 119
327 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120
330 #define RSA_R_ALGORITHM_MISMATCH 100
331 #define RSA_R_BAD_E_VALUE 101
332 #define RSA_R_BAD_FIXED_HEADER_DECRYPT 102
333 #define RSA_R_BAD_PAD_BYTE_COUNT 103
334 #define RSA_R_BAD_SIGNATURE 104
335 #define RSA_R_BLOCK_TYPE_IS_NOT_01 106
336 #define RSA_R_BLOCK_TYPE_IS_NOT_02 107
337 #define RSA_R_DATA_GREATER_THAN_MOD_LEN 108
338 #define RSA_R_DATA_TOO_LARGE 109
339 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110
340 #define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 132
341 #define RSA_R_DATA_TOO_SMALL 111
342 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122
343 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112
344 #define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124
345 #define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125
346 #define RSA_R_D_E_NOT_CONGRUENT_TO_1 123
347 #define RSA_R_INVALID_MESSAGE_LENGTH 131
348 #define RSA_R_IQMP_NOT_INVERSE_OF_Q 126
349 #define RSA_R_KEY_SIZE_TOO_SMALL 120
350 #define RSA_R_NULL_BEFORE_BLOCK_MISSING 113
351 #define RSA_R_N_DOES_NOT_EQUAL_P_Q 127
352 #define RSA_R_OAEP_DECODING_ERROR 121
353 #define RSA_R_PADDING_CHECK_FAILED 114
354 #define RSA_R_P_NOT_PRIME 128
355 #define RSA_R_Q_NOT_PRIME 129
356 #define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130
357 #define RSA_R_SSLV3_ROLLBACK_ATTACK 115
358 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
359 #define RSA_R_UNKNOWN_ALGORITHM_TYPE 117
360 #define RSA_R_UNKNOWN_PADDING_TYPE 118
361 #define RSA_R_WRONG_SIGNATURE_LENGTH 119