]>
git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/rsa/rsa.h
9230b2fcc9b4c0f9775a7369e13778225ec95514
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! */
98 /* The first parameter is used to pickup errors where
99 * this is passed instead of aEVP_PKEY, it is set to 0 */
111 /* be careful using this if the RSA structure is shared */
112 CRYPTO_EX_DATA ex_data
;
116 /* Used to cache montgomery values */
117 BN_MONT_CTX
*_method_mod_n
;
118 BN_MONT_CTX
*_method_mod_p
;
119 BN_MONT_CTX
*_method_mod_q
;
121 /* all BIGNUM values are actually in the following data, if it is not
124 BN_BLINDING
*blinding
;
128 #define RSA_F4 0x10001L
130 #define RSA_METHOD_FLAG_NO_CHECK 0x01 /* don't check pub/private match */
132 #define RSA_FLAG_CACHE_PUBLIC 0x02
133 #define RSA_FLAG_CACHE_PRIVATE 0x04
134 #define RSA_FLAG_BLINDING 0x08
135 #define RSA_FLAG_THREAD_SAFE 0x10
136 /* This flag means the private key operations will be handled by rsa_mod_exp
137 * and that they do not depend on the private key components being present:
138 * for example a key stored in external hardware. Without this flag bn_mod_exp
139 * gets called when private key components are absent.
141 #define RSA_FLAG_EXT_PKEY 0x20
143 #define RSA_PKCS1_PADDING 1
144 #define RSA_SSLV23_PADDING 2
145 #define RSA_NO_PADDING 3
146 #define RSA_PKCS1_OAEP_PADDING 4
148 #define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,(char *)arg)
149 #define RSA_get_app_data(s) RSA_get_ex_data(s,0)
152 RSA
* RSA_new_method(RSA_METHOD
*method
);
154 RSA
* RSA_generate_key(int bits
, unsigned long e
,void
155 (*callback
)(int,int,void *),void *cb_arg
);
156 int RSA_check_key(RSA
*);
157 /* next 4 return -1 on error */
158 int RSA_public_encrypt(int flen
, unsigned char *from
,
159 unsigned char *to
, RSA
*rsa
,int padding
);
160 int RSA_private_encrypt(int flen
, unsigned char *from
,
161 unsigned char *to
, RSA
*rsa
,int padding
);
162 int RSA_public_decrypt(int flen
, unsigned char *from
,
163 unsigned char *to
, RSA
*rsa
,int padding
);
164 int RSA_private_decrypt(int flen
, unsigned char *from
,
165 unsigned char *to
, RSA
*rsa
,int padding
);
166 void RSA_free (RSA
*r
);
168 int RSA_flags(RSA
*r
);
170 void RSA_set_default_method(RSA_METHOD
*meth
);
171 RSA_METHOD
*RSA_get_default_method(void);
172 RSA_METHOD
*RSA_get_method(RSA
*rsa
);
173 RSA_METHOD
*RSA_set_method(RSA
*rsa
, RSA_METHOD
*meth
);
175 /* This function needs the memory locking malloc callbacks to be installed */
176 int RSA_memory_lock(RSA
*r
);
178 /* If you have RSAref compiled in. */
179 RSA_METHOD
*RSA_PKCS1_RSAref(void);
181 /* these are the actual SSLeay RSA functions */
182 RSA_METHOD
*RSA_PKCS1_SSLeay(void);
184 void ERR_load_RSA_strings(void );
186 RSA
* d2i_RSAPublicKey(RSA
**a
, unsigned char **pp
, long length
);
187 int i2d_RSAPublicKey(RSA
*a
, unsigned char **pp
);
188 RSA
* d2i_RSAPrivateKey(RSA
**a
, unsigned char **pp
, long length
);
189 int i2d_RSAPrivateKey(RSA
*a
, unsigned char **pp
);
191 int RSA_print_fp(FILE *fp
, RSA
*r
,int offset
);
195 int RSA_print(BIO
*bp
, RSA
*r
,int offset
);
198 int i2d_Netscape_RSA(RSA
*a
, unsigned char **pp
, int (*cb
)());
199 RSA
*d2i_Netscape_RSA(RSA
**a
, unsigned char **pp
, long length
, int (*cb
)());
200 /* Naughty internal function required elsewhere, to handle a MS structure
201 * that is the same as the netscape one :-) */
202 RSA
*d2i_Netscape_RSA_2(RSA
**a
, unsigned char **pp
, long length
, int (*cb
)());
204 /* The following 2 functions sign and verify a X509_SIG ASN1 object
205 * inside PKCS#1 padded RSA encryption */
206 int RSA_sign(int type
, unsigned char *m
, unsigned int m_len
,
207 unsigned char *sigret
, unsigned int *siglen
, RSA
*rsa
);
208 int RSA_verify(int type
, unsigned char *m
, unsigned int m_len
,
209 unsigned char *sigbuf
, unsigned int siglen
, RSA
*rsa
);
211 /* The following 2 function sign and verify a ASN1_OCTET_STRING
212 * object inside PKCS#1 padded RSA encryption */
213 int RSA_sign_ASN1_OCTET_STRING(int type
, unsigned char *m
, unsigned int m_len
,
214 unsigned char *sigret
, unsigned int *siglen
, RSA
*rsa
);
215 int RSA_verify_ASN1_OCTET_STRING(int type
, unsigned char *m
, unsigned int m_len
,
216 unsigned char *sigbuf
, unsigned int siglen
, RSA
*rsa
);
218 int RSA_blinding_on(RSA
*rsa
, BN_CTX
*ctx
);
219 void RSA_blinding_off(RSA
*rsa
);
221 int RSA_padding_add_PKCS1_type_1(unsigned char *to
,int tlen
,
222 unsigned char *f
,int fl
);
223 int RSA_padding_check_PKCS1_type_1(unsigned char *to
,int tlen
,
224 unsigned char *f
,int fl
,int rsa_len
);
225 int RSA_padding_add_PKCS1_type_2(unsigned char *to
,int tlen
,
226 unsigned char *f
,int fl
);
227 int RSA_padding_check_PKCS1_type_2(unsigned char *to
,int tlen
,
228 unsigned char *f
,int fl
,int rsa_len
);
229 int RSA_padding_add_PKCS1_OAEP(unsigned char *to
,int tlen
,
230 unsigned char *f
,int fl
,unsigned char *p
,
232 int RSA_padding_check_PKCS1_OAEP(unsigned char *to
,int tlen
,
233 unsigned char *f
,int fl
,int rsa_len
,
234 unsigned char *p
,int pl
);
235 int RSA_padding_add_SSLv23(unsigned char *to
,int tlen
,
236 unsigned char *f
,int fl
);
237 int RSA_padding_check_SSLv23(unsigned char *to
,int tlen
,
238 unsigned char *f
,int fl
,int rsa_len
);
239 int RSA_padding_add_none(unsigned char *to
,int tlen
,
240 unsigned char *f
,int fl
);
241 int RSA_padding_check_none(unsigned char *to
,int tlen
,
242 unsigned char *f
,int fl
,int rsa_len
);
244 int RSA_get_ex_new_index(long argl
, char *argp
, int (*new_func
)(),
245 int (*dup_func
)(), void (*free_func
)());
246 int RSA_set_ex_data(RSA
*r
,int idx
,char *arg
);
247 char *RSA_get_ex_data(RSA
*r
, int idx
);
249 /* BEGIN ERROR CODES */
250 /* The following lines are auto generated by the script mkerr.pl. Any changes
251 * made after this point may be overwritten when the script is next run.
254 /* Error codes for the RSA functions. */
256 /* Function codes. */
257 #define RSA_F_MEMORY_LOCK 100
258 #define RSA_F_RSA_CHECK_KEY 123
259 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101
260 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102
261 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103
262 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104
263 #define RSA_F_RSA_GENERATE_KEY 105
264 #define RSA_F_RSA_NEW_METHOD 106
265 #define RSA_F_RSA_PADDING_ADD_NONE 107
266 #define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121
267 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108
268 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109
269 #define RSA_F_RSA_PADDING_ADD_SSLV23 110
270 #define RSA_F_RSA_PADDING_CHECK_NONE 111
271 #define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122
272 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112
273 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113
274 #define RSA_F_RSA_PADDING_CHECK_SSLV23 114
275 #define RSA_F_RSA_PRINT 115
276 #define RSA_F_RSA_PRINT_FP 116
277 #define RSA_F_RSA_SIGN 117
278 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118
279 #define RSA_F_RSA_VERIFY 119
280 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120
283 #define RSA_R_ALGORITHM_MISMATCH 100
284 #define RSA_R_BAD_E_VALUE 101
285 #define RSA_R_BAD_FIXED_HEADER_DECRYPT 102
286 #define RSA_R_BAD_PAD_BYTE_COUNT 103
287 #define RSA_R_BAD_SIGNATURE 104
288 #define RSA_R_BLOCK_TYPE_IS_NOT_01 106
289 #define RSA_R_BLOCK_TYPE_IS_NOT_02 107
290 #define RSA_R_DATA_GREATER_THAN_MOD_LEN 108
291 #define RSA_R_DATA_TOO_LARGE 109
292 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110
293 #define RSA_R_DATA_TOO_SMALL 111
294 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122
295 #define RSA_R_D_E_NOT_CONGRUENT_TO_1 123
296 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112
297 #define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124
298 #define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125
299 #define RSA_R_IQMP_NOT_INVERSE_OF_Q 126
300 #define RSA_R_KEY_SIZE_TOO_SMALL 120
301 #define RSA_R_NULL_BEFORE_BLOCK_MISSING 113
302 #define RSA_R_N_DOES_NOT_EQUAL_P_Q 127
303 #define RSA_R_OAEP_DECODING_ERROR 121
304 #define RSA_R_PADDING_CHECK_FAILED 114
305 #define RSA_R_P_NOT_PRIME 128
306 #define RSA_R_Q_NOT_PRIME 129
307 #define RSA_R_SSLV3_ROLLBACK_ATTACK 115
308 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
309 #define RSA_R_UNKNOWN_ALGORITHM_TYPE 117
310 #define RSA_R_UNKNOWN_PADDING_TYPE 118
311 #define RSA_R_WRONG_SIGNATURE_LENGTH 119