b7c02fdab7006f94f3e97d4749fcf374f005693a
[openssl.git] / crypto / rsa / rsa.h
1 /* crypto/rsa/rsa.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
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.
8  * 
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).
15  * 
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.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
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)"
40  * 
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
51  * SUCH DAMAGE.
52  * 
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.]
57  */
58
59 #ifndef HEADER_RSA_H
60 #define HEADER_RSA_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 #include "bn.h"
67 #include "crypto.h"
68
69 typedef struct rsa_meth_st
70         {
71         char *name;
72         int (*rsa_pub_enc)();
73         int (*rsa_pub_dec)();
74         int (*rsa_priv_enc)();
75         int (*rsa_priv_dec)();
76         int (*rsa_mod_exp)();           /* Can be null */
77         int (*bn_mod_exp)();            /* Can be null */
78         int (*init)(/* RSA * */);       /* called at new */
79         int (*finish)(/* RSA * */);     /* called at free */
80
81         int flags;                      /* RSA_METHOD_FLAG_* things */
82         char *app_data;                 /* may be needed! */
83         } RSA_METHOD;
84
85 typedef struct rsa_st
86         {
87         /* The first parameter is used to pickup errors where
88          * this is passed instead of aEVP_PKEY, it is set to 0 */
89         int pad;
90         int version;
91         RSA_METHOD *meth;
92         BIGNUM *n;
93         BIGNUM *e;
94         BIGNUM *d;
95         BIGNUM *p;
96         BIGNUM *q;
97         BIGNUM *dmp1;
98         BIGNUM *dmq1;
99         BIGNUM *iqmp;
100         /* be carefull using this if the RSA structure is shared */
101         CRYPTO_EX_DATA ex_data;
102         int references;
103         int flags;
104
105         /* Normally used to cache montgomery values */
106         char *method_mod_n;
107         char *method_mod_p;
108         char *method_mod_q;
109
110         /* all BIGNUM values are actually in the following data, if it is not
111          * NULL */
112         char *bignum_data;
113         BN_BLINDING *blinding;
114         } RSA;
115
116 #define RSA_3   0x3L
117 #define RSA_F4  0x10001L
118
119 #define RSA_METHOD_FLAG_NO_CHECK        0x01 /* don't check pub/private match */
120
121 #define RSA_FLAG_CACHE_PUBLIC           0x02
122 #define RSA_FLAG_CACHE_PRIVATE          0x04
123 #define RSA_FLAG_BLINDING               0x08
124 #define RSA_FLAG_THREAD_SAFE            0x10
125
126 #define RSA_PKCS1_PADDING       1
127 #define RSA_SSLV23_PADDING      2
128 #define RSA_NO_PADDING          3
129
130 #define RSA_set_app_data(s,arg)         RSA_set_ex_data(s,0,(char *)arg)
131 #define RSA_get_app_data(s)             RSA_get_ex_data(s,0)
132
133 #ifndef NOPROTO
134 RSA *   RSA_new(void);
135 RSA *   RSA_new_method(RSA_METHOD *method);
136 int     RSA_size(RSA *);
137 RSA *   RSA_generate_key(int bits, unsigned long e,void
138                 (*callback)(int,int,char *),char *cb_arg);
139         /* next 4 return -1 on error */
140 int     RSA_public_encrypt(int flen, unsigned char *from,
141                 unsigned char *to, RSA *rsa,int padding);
142 int     RSA_private_encrypt(int flen, unsigned char *from,
143                 unsigned char *to, RSA *rsa,int padding);
144 int     RSA_public_decrypt(int flen, unsigned char *from, 
145                 unsigned char *to, RSA *rsa,int padding);
146 int     RSA_private_decrypt(int flen, unsigned char *from, 
147                 unsigned char *to, RSA *rsa,int padding);
148 void    RSA_free (RSA *r);
149
150 int     RSA_flags(RSA *r);
151
152 void RSA_set_default_method(RSA_METHOD *meth);
153
154 /* This function needs the memory locking malloc callbacks to be installed */
155 int RSA_memory_lock(RSA *r);
156
157 /* If you have RSAref compiled in. */
158 RSA_METHOD *RSA_PKCS1_RSAref(void);
159
160 /* these are the actual SSLeay RSA functions */
161 RSA_METHOD *RSA_PKCS1_SSLeay(void);
162
163 void    ERR_load_RSA_strings(void );
164
165 RSA *   d2i_RSAPublicKey(RSA **a, unsigned char **pp, long length);
166 int     i2d_RSAPublicKey(RSA *a, unsigned char **pp);
167 RSA *   d2i_RSAPrivateKey(RSA **a, unsigned char **pp, long length);
168 int     i2d_RSAPrivateKey(RSA *a, unsigned char **pp);
169 #ifndef NO_FP_API
170 int     RSA_print_fp(FILE *fp, RSA *r,int offset);
171 #endif
172
173 #ifdef HEADER_BIO_H
174 int     RSA_print(BIO *bp, RSA *r,int offset);
175 #endif
176
177 int i2d_Netscape_RSA(RSA *a, unsigned char **pp, int (*cb)());
178 RSA *d2i_Netscape_RSA(RSA **a, unsigned char **pp, long length, int (*cb)());
179 /* Naughty internal function required elsewhere, to handle a MS structure
180  * that is the same as the netscape one :-) */
181 RSA *d2i_Netscape_RSA_2(RSA **a, unsigned char **pp, long length, int (*cb)());
182
183 /* The following 2 functions sign and verify a X509_SIG ASN1 object
184  * inside PKCS#1 padded RSA encryption */
185 int RSA_sign(int type, unsigned char *m, unsigned int m_len,
186         unsigned char *sigret, unsigned int *siglen, RSA *rsa);
187 int RSA_verify(int type, unsigned char *m, unsigned int m_len,
188         unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
189
190 /* The following 2 function sign and verify a ASN1_OCTET_STRING
191  * object inside PKCS#1 padded RSA encryption */
192 int RSA_sign_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_len,
193         unsigned char *sigret, unsigned int *siglen, RSA *rsa);
194 int RSA_verify_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_len,
195         unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
196
197 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
198 void RSA_blinding_off(RSA *rsa);
199
200 int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
201         unsigned char *f,int fl);
202 int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
203         unsigned char *f,int fl,int rsa_len);
204 int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
205         unsigned char *f,int fl);
206 int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
207         unsigned char *f,int fl,int rsa_len);
208 int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
209         unsigned char *f,int fl);
210 int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
211         unsigned char *f,int fl,int rsa_len);
212 int RSA_padding_add_none(unsigned char *to,int tlen,
213         unsigned char *f,int fl);
214 int RSA_padding_check_none(unsigned char *to,int tlen,
215         unsigned char *f,int fl,int rsa_len);
216
217 int RSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
218         int (*dup_func)(), void (*free_func)());
219 int RSA_set_ex_data(RSA *r,int idx,char *arg);
220 char *RSA_get_ex_data(RSA *r, int idx);
221
222 #else
223
224 RSA *   RSA_new();
225 RSA *   RSA_new_method();
226 int     RSA_size();
227 RSA *   RSA_generate_key();
228 int     RSA_public_encrypt();
229 int     RSA_private_encrypt();
230 int     RSA_public_decrypt();
231 int     RSA_private_decrypt();
232 void    RSA_free ();
233
234 int     RSA_flags();
235
236 void RSA_set_default_method();
237 int RSA_memory_lock();
238
239 /* RSA_METHOD *RSA_PKCS1_RSAref(); */
240 RSA_METHOD *RSA_PKCS1_SSLeay();
241
242 void    ERR_load_RSA_strings();
243
244 RSA *   d2i_RSAPublicKey();
245 int     i2d_RSAPublicKey();
246 RSA *   d2i_RSAPrivateKey();
247 int     i2d_RSAPrivateKey();
248 #ifndef NO_FP_API
249 int     RSA_print_fp();
250 #endif
251
252 int     RSA_print();
253
254 int i2d_Netscape_RSA();
255 RSA *d2i_Netscape_RSA();
256 RSA *d2i_Netscape_RSA_2();
257
258 int RSA_sign();
259 int RSA_verify();
260
261 int RSA_sign_ASN1_OCTET_STRING();
262 int RSA_verify_ASN1_OCTET_STRING();
263 int RSA_blinding_on();
264 void RSA_blinding_off();
265
266 int RSA_padding_add_PKCS1_type_1();
267 int RSA_padding_check_PKCS1_type_1();
268 int RSA_padding_add_PKCS1_type_2();
269 int RSA_padding_check_PKCS1_type_2();
270 int RSA_padding_add_SSLv23();
271 int RSA_padding_check_SSLv23();
272 int RSA_padding_add_none();
273 int RSA_padding_check_none();
274
275 int RSA_get_ex_new_index();
276 int RSA_set_ex_data();
277 char *RSA_get_ex_data();
278
279 #endif
280
281 /* BEGIN ERROR CODES */
282 /* Error codes for the RSA functions. */
283
284 /* Function codes. */
285 #define RSA_F_MEMORY_LOCK                                100
286 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT                    101
287 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT                    102
288 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT                     103
289 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT                     104
290 #define RSA_F_RSA_GENERATE_KEY                           105
291 #define RSA_F_RSA_NEW_METHOD                             106
292 #define RSA_F_RSA_PADDING_ADD_NONE                       107
293 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1               108
294 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2               109
295 #define RSA_F_RSA_PADDING_ADD_SSLV23                     110
296 #define RSA_F_RSA_PADDING_CHECK_NONE                     111
297 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1             112
298 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2             113
299 #define RSA_F_RSA_PADDING_CHECK_SSLV23                   114
300 #define RSA_F_RSA_PRINT                                  115
301 #define RSA_F_RSA_PRINT_FP                               116
302 #define RSA_F_RSA_SIGN                                   117
303 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING                 118
304 #define RSA_F_RSA_VERIFY                                 119
305 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING               120
306
307 /* Reason codes. */
308 #define RSA_R_ALGORITHM_MISMATCH                         100
309 #define RSA_R_BAD_E_VALUE                                101
310 #define RSA_R_BAD_FIXED_HEADER_DECRYPT                   102
311 #define RSA_R_BAD_PAD_BYTE_COUNT                         103
312 #define RSA_R_BAD_SIGNATURE                              104
313 #define RSA_R_BAD_ZERO_BYTE                              105
314 #define RSA_R_BLOCK_TYPE_IS_NOT_01                       106
315 #define RSA_R_BLOCK_TYPE_IS_NOT_02                       107
316 #define RSA_R_DATA_GREATER_THAN_MOD_LEN                  108
317 #define RSA_R_DATA_TOO_LARGE                             109
318 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                110
319 #define RSA_R_DATA_TOO_SMALL                             111
320 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY                 112
321 #define RSA_R_NULL_BEFORE_BLOCK_MISSING                  113
322 #define RSA_R_PADDING_CHECK_FAILED                       114
323 #define RSA_R_SSLV3_ROLLBACK_ATTACK                      115
324 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
325 #define RSA_R_UNKNOWN_ALGORITHM_TYPE                     117
326 #define RSA_R_UNKNOWN_PADDING_TYPE                       118
327 #define RSA_R_WRONG_SIGNATURE_LENGTH                     119
328  
329 #ifdef  __cplusplus
330 }
331 #endif
332 #endif
333