2f53ff04b9e065352d5755da613d7c5ad8ec5608
[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 <openssl/bn.h>
67 #include <openssl/crypto.h>
68
69 #ifdef NO_RSA
70 #error RSA is disabled.
71 #endif
72
73 typedef struct rsa_st RSA;
74
75 typedef struct rsa_meth_st
76         {
77         const char *name;
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, BIGNUM *p, BIGNUM *m,
88                           BN_CTX *ctx,BN_MONT_CTX *m_ctx); /* Can be null */
89         int (*init)(RSA *rsa);          /* called at new */
90         int (*finish)(RSA *rsa);        /* called at free */
91         int flags;                      /* RSA_METHOD_FLAG_* things */
92         char *app_data;                 /* may be needed! */
93         } RSA_METHOD;
94
95 struct rsa_st
96         {
97         /* The first parameter is used to pickup errors where
98          * this is passed instead of aEVP_PKEY, it is set to 0 */
99         int pad;
100         int version;
101         RSA_METHOD *meth;
102         BIGNUM *n;
103         BIGNUM *e;
104         BIGNUM *d;
105         BIGNUM *p;
106         BIGNUM *q;
107         BIGNUM *dmp1;
108         BIGNUM *dmq1;
109         BIGNUM *iqmp;
110         /* be carefull using this if the RSA structure is shared */
111         CRYPTO_EX_DATA ex_data;
112         int references;
113         int flags;
114
115         /* Used to cache montgomery values */
116         BN_MONT_CTX *_method_mod_n;
117         BN_MONT_CTX *_method_mod_p;
118         BN_MONT_CTX *_method_mod_q;
119
120         /* all BIGNUM values are actually in the following data, if it is not
121          * NULL */
122         char *bignum_data;
123         BN_BLINDING *blinding;
124         };
125
126 #define RSA_3   0x3L
127 #define RSA_F4  0x10001L
128
129 #define RSA_METHOD_FLAG_NO_CHECK        0x01 /* don't check pub/private match */
130
131 #define RSA_FLAG_CACHE_PUBLIC           0x02
132 #define RSA_FLAG_CACHE_PRIVATE          0x04
133 #define RSA_FLAG_BLINDING               0x08
134 #define RSA_FLAG_THREAD_SAFE            0x10
135
136 #define RSA_PKCS1_PADDING       1
137 #define RSA_SSLV23_PADDING      2
138 #define RSA_NO_PADDING          3
139 #define RSA_PKCS1_OAEP_PADDING  4
140
141 #define RSA_set_app_data(s,arg)         RSA_set_ex_data(s,0,(char *)arg)
142 #define RSA_get_app_data(s)             RSA_get_ex_data(s,0)
143
144 RSA *   RSA_new(void);
145 RSA *   RSA_new_method(RSA_METHOD *method);
146 int     RSA_size(RSA *);
147 RSA *   RSA_generate_key(int bits, unsigned long e,void
148                 (*callback)(int,int,char *),char *cb_arg);
149         /* next 4 return -1 on error */
150 int     RSA_public_encrypt(int flen, unsigned char *from,
151                 unsigned char *to, RSA *rsa,int padding);
152 int     RSA_private_encrypt(int flen, unsigned char *from,
153                 unsigned char *to, RSA *rsa,int padding);
154 int     RSA_public_decrypt(int flen, unsigned char *from, 
155                 unsigned char *to, RSA *rsa,int padding);
156 int     RSA_private_decrypt(int flen, unsigned char *from, 
157                 unsigned char *to, RSA *rsa,int padding);
158 void    RSA_free (RSA *r);
159
160 int     RSA_flags(RSA *r);
161
162 void RSA_set_default_method(RSA_METHOD *meth);
163
164 /* This function needs the memory locking malloc callbacks to be installed */
165 int RSA_memory_lock(RSA *r);
166
167 /* If you have RSAref compiled in. */
168 RSA_METHOD *RSA_PKCS1_RSAref(void);
169
170 /* these are the actual SSLeay RSA functions */
171 RSA_METHOD *RSA_PKCS1_SSLeay(void);
172
173 void    ERR_load_RSA_strings(void );
174
175 RSA *   d2i_RSAPublicKey(RSA **a, unsigned char **pp, long length);
176 int     i2d_RSAPublicKey(RSA *a, unsigned char **pp);
177 RSA *   d2i_RSAPrivateKey(RSA **a, unsigned char **pp, long length);
178 int     i2d_RSAPrivateKey(RSA *a, unsigned char **pp);
179 #ifndef NO_FP_API
180 int     RSA_print_fp(FILE *fp, RSA *r,int offset);
181 #endif
182
183 #ifdef HEADER_BIO_H
184 int     RSA_print(BIO *bp, RSA *r,int offset);
185 #endif
186
187 int i2d_Netscape_RSA(RSA *a, unsigned char **pp, int (*cb)());
188 RSA *d2i_Netscape_RSA(RSA **a, unsigned char **pp, long length, int (*cb)());
189 /* Naughty internal function required elsewhere, to handle a MS structure
190  * that is the same as the netscape one :-) */
191 RSA *d2i_Netscape_RSA_2(RSA **a, unsigned char **pp, long length, int (*cb)());
192
193 /* The following 2 functions sign and verify a X509_SIG ASN1 object
194  * inside PKCS#1 padded RSA encryption */
195 int RSA_sign(int type, unsigned char *m, unsigned int m_len,
196         unsigned char *sigret, unsigned int *siglen, RSA *rsa);
197 int RSA_verify(int type, unsigned char *m, unsigned int m_len,
198         unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
199
200 /* The following 2 function sign and verify a ASN1_OCTET_STRING
201  * object inside PKCS#1 padded RSA encryption */
202 int RSA_sign_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_len,
203         unsigned char *sigret, unsigned int *siglen, RSA *rsa);
204 int RSA_verify_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_len,
205         unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
206
207 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
208 void RSA_blinding_off(RSA *rsa);
209
210 int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
211         unsigned char *f,int fl);
212 int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
213         unsigned char *f,int fl,int rsa_len);
214 int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
215         unsigned char *f,int fl);
216 int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
217         unsigned char *f,int fl,int rsa_len);
218 int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen,
219                                unsigned char *f,int fl,unsigned char *p,
220                                int pl);
221 int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen,
222                                  unsigned char *f,int fl,int rsa_len,
223                                  unsigned char *p,int pl);
224 int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
225         unsigned char *f,int fl);
226 int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
227         unsigned char *f,int fl,int rsa_len);
228 int RSA_padding_add_none(unsigned char *to,int tlen,
229         unsigned char *f,int fl);
230 int RSA_padding_check_none(unsigned char *to,int tlen,
231         unsigned char *f,int fl,int rsa_len);
232
233 int RSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
234         int (*dup_func)(), void (*free_func)());
235 int RSA_set_ex_data(RSA *r,int idx,char *arg);
236 char *RSA_get_ex_data(RSA *r, int idx);
237
238 /* BEGIN ERROR CODES */
239 /* The following lines are auto generated by the script mkerr.pl. Any changes
240  * made after this point may be overwritten when the script is next run.
241  */
242
243 /* Error codes for the RSA functions. */
244
245 /* Function codes. */
246 #define RSA_F_MEMORY_LOCK                                100
247 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT                    101
248 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT                    102
249 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT                     103
250 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT                     104
251 #define RSA_F_RSA_GENERATE_KEY                           105
252 #define RSA_F_RSA_NEW_METHOD                             106
253 #define RSA_F_RSA_PADDING_ADD_NONE                       107
254 #define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP                 121
255 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1               108
256 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2               109
257 #define RSA_F_RSA_PADDING_ADD_SSLV23                     110
258 #define RSA_F_RSA_PADDING_CHECK_NONE                     111
259 #define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP               122
260 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1             112
261 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2             113
262 #define RSA_F_RSA_PADDING_CHECK_SSLV23                   114
263 #define RSA_F_RSA_PRINT                                  115
264 #define RSA_F_RSA_PRINT_FP                               116
265 #define RSA_F_RSA_SIGN                                   117
266 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING                 118
267 #define RSA_F_RSA_VERIFY                                 119
268 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING               120
269
270 /* Reason codes. */
271 #define RSA_R_ALGORITHM_MISMATCH                         100
272 #define RSA_R_BAD_E_VALUE                                101
273 #define RSA_R_BAD_FIXED_HEADER_DECRYPT                   102
274 #define RSA_R_BAD_PAD_BYTE_COUNT                         103
275 #define RSA_R_BAD_SIGNATURE                              104
276 #define RSA_R_BLOCK_TYPE_IS_NOT_01                       106
277 #define RSA_R_BLOCK_TYPE_IS_NOT_02                       107
278 #define RSA_R_DATA_GREATER_THAN_MOD_LEN                  108
279 #define RSA_R_DATA_TOO_LARGE                             109
280 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                110
281 #define RSA_R_DATA_TOO_SMALL                             111
282 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE                122
283 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY                 112
284 #define RSA_R_KEY_SIZE_TOO_SMALL                         120
285 #define RSA_R_NULL_BEFORE_BLOCK_MISSING                  113
286 #define RSA_R_OAEP_DECODING_ERROR                        121
287 #define RSA_R_PADDING_CHECK_FAILED                       114
288 #define RSA_R_SSLV3_ROLLBACK_ATTACK                      115
289 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
290 #define RSA_R_UNKNOWN_ALGORITHM_TYPE                     117
291 #define RSA_R_UNKNOWN_PADDING_TYPE                       118
292 #define RSA_R_WRONG_SIGNATURE_LENGTH                     119
293
294 #ifdef  __cplusplus
295 }
296 #endif
297 #endif
298