9116a6e5679fbf56bb89f97057f05700609b3cf9
[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 #include <openssl/asn1.h>
63
64 #ifndef OPENSSL_NO_BIO
65 #include <openssl/bio.h>
66 #endif
67 #include <openssl/bn.h>
68 #include <openssl/crypto.h>
69
70 #ifdef OPENSSL_NO_RSA
71 #error RSA is disabled.
72 #endif
73
74 #ifdef  __cplusplus
75 extern "C" {
76 #endif
77
78 typedef struct rsa_st RSA;
79
80 typedef struct rsa_meth_st
81         {
82         const char *name;
83         int (*rsa_pub_enc)(int flen,const unsigned char *from,
84                            unsigned char *to,
85                            RSA *rsa,int padding);
86         int (*rsa_pub_dec)(int flen,const unsigned char *from,
87                            unsigned char *to,
88                            RSA *rsa,int padding);
89         int (*rsa_priv_enc)(int flen,const unsigned char *from,
90                             unsigned char *to,
91                             RSA *rsa,int padding);
92         int (*rsa_priv_dec)(int flen,const unsigned char *from,
93                             unsigned char *to,
94                             RSA *rsa,int padding);
95         int (*rsa_mod_exp)(BIGNUM *r0,const BIGNUM *I,RSA *rsa); /* Can be null */
96         int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
97                           const BIGNUM *m, BN_CTX *ctx,
98                           BN_MONT_CTX *m_ctx); /* Can be null */
99         int (*init)(RSA *rsa);          /* called at new */
100         int (*finish)(RSA *rsa);        /* called at free */
101         int flags;                      /* RSA_METHOD_FLAG_* things */
102         char *app_data;                 /* may be needed! */
103 /* New sign and verify functions: some libraries don't allow arbitrary data
104  * to be signed/verified: this allows them to be used. Note: for this to work
105  * the RSA_public_decrypt() and RSA_private_encrypt() should *NOT* be used
106  * RSA_sign(), RSA_verify() should be used instead. Note: for backwards
107  * compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER
108  * option is set in 'flags'.
109  */
110         int (*rsa_sign)(int type,
111                 const unsigned char *m, unsigned int m_len,
112                 unsigned char *sigret, unsigned int *siglen, const RSA *rsa);
113         int (*rsa_verify)(int dtype,
114                 const unsigned char *m, unsigned int m_len,
115                 unsigned char *sigbuf, unsigned int siglen, const RSA *rsa);
116
117         } RSA_METHOD;
118
119 struct rsa_st
120         {
121         /* The first parameter is used to pickup errors where
122          * this is passed instead of aEVP_PKEY, it is set to 0 */
123         int pad;
124         long version;
125 #if 0
126         RSA_METHOD *meth;
127 #else
128         struct engine_st *engine;
129 #endif
130         BIGNUM *n;
131         BIGNUM *e;
132         BIGNUM *d;
133         BIGNUM *p;
134         BIGNUM *q;
135         BIGNUM *dmp1;
136         BIGNUM *dmq1;
137         BIGNUM *iqmp;
138         /* be careful using this if the RSA structure is shared */
139         CRYPTO_EX_DATA ex_data;
140         int references;
141         int flags;
142
143         /* Used to cache montgomery values */
144         BN_MONT_CTX *_method_mod_n;
145         BN_MONT_CTX *_method_mod_p;
146         BN_MONT_CTX *_method_mod_q;
147
148         /* all BIGNUM values are actually in the following data, if it is not
149          * NULL */
150         char *bignum_data;
151         BN_BLINDING *blinding;
152         };
153
154 #define RSA_3   0x3L
155 #define RSA_F4  0x10001L
156
157 #define RSA_METHOD_FLAG_NO_CHECK        0x01 /* don't check pub/private match */
158
159 #define RSA_FLAG_CACHE_PUBLIC           0x02
160 #define RSA_FLAG_CACHE_PRIVATE          0x04
161 #define RSA_FLAG_BLINDING               0x08
162 #define RSA_FLAG_THREAD_SAFE            0x10
163 /* This flag means the private key operations will be handled by rsa_mod_exp
164  * and that they do not depend on the private key components being present:
165  * for example a key stored in external hardware. Without this flag bn_mod_exp
166  * gets called when private key components are absent.
167  */
168 #define RSA_FLAG_EXT_PKEY               0x20
169
170 /* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions.
171  */
172 #define RSA_FLAG_SIGN_VER               0x40
173
174 #define RSA_PKCS1_PADDING       1
175 #define RSA_SSLV23_PADDING      2
176 #define RSA_NO_PADDING          3
177 #define RSA_PKCS1_OAEP_PADDING  4
178
179 #define RSA_set_app_data(s,arg)         RSA_set_ex_data(s,0,arg)
180 #define RSA_get_app_data(s)             RSA_get_ex_data(s,0)
181
182 RSA *   RSA_new(void);
183 #if 0
184 RSA *   RSA_new_method(RSA_METHOD *method);
185 #else
186 RSA *   RSA_new_method(struct engine_st *engine);
187 #endif
188 int     RSA_size(const RSA *);
189 RSA *   RSA_generate_key(int bits, unsigned long e,void
190                 (*callback)(int,int,void *),void *cb_arg);
191 int     RSA_check_key(const RSA *);
192         /* next 4 return -1 on error */
193 int     RSA_public_encrypt(int flen, const unsigned char *from,
194                 unsigned char *to, RSA *rsa,int padding);
195 int     RSA_private_encrypt(int flen, const unsigned char *from,
196                 unsigned char *to, RSA *rsa,int padding);
197 int     RSA_public_decrypt(int flen, const unsigned char *from, 
198                 unsigned char *to, RSA *rsa,int padding);
199 int     RSA_private_decrypt(int flen, const unsigned char *from, 
200                 unsigned char *to, RSA *rsa,int padding);
201 void    RSA_free (RSA *r);
202 /* "up" the RSA object's reference count */
203 int     RSA_up(RSA *r);
204
205 int     RSA_flags(const RSA *r);
206
207 void RSA_set_default_openssl_method(const RSA_METHOD *meth);
208 const RSA_METHOD *RSA_get_default_openssl_method(void);
209 const RSA_METHOD *RSA_get_method(const RSA *rsa);
210 #if 0
211 RSA_METHOD *RSA_set_method(RSA *rsa, RSA_METHOD *meth);
212 #else
213 int RSA_set_method(RSA *rsa, struct engine_st *engine);
214 #endif
215
216 /* This function needs the memory locking malloc callbacks to be installed */
217 int RSA_memory_lock(RSA *r);
218
219 /* these are the actual SSLeay RSA functions */
220 const RSA_METHOD *RSA_PKCS1_SSLeay(void);
221
222 const RSA_METHOD *RSA_null_method(void);
223
224 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPublicKey)
225 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPrivateKey)
226
227 #ifndef OPENSSL_NO_FP_API
228 int     RSA_print_fp(FILE *fp, const RSA *r,int offset);
229 #endif
230
231 #ifndef OPENSSL_NO_BIO
232 int     RSA_print(BIO *bp, const RSA *r,int offset);
233 #endif
234
235 int i2d_RSA_NET(const RSA *a, unsigned char **pp, int (*cb)(), int sgckey);
236 RSA *d2i_RSA_NET(RSA **a, const unsigned char **pp, long length, int (*cb)(), int sgckey);
237
238 int i2d_Netscape_RSA(const RSA *a, unsigned char **pp, int (*cb)());
239 RSA *d2i_Netscape_RSA(RSA **a, const unsigned char **pp, long length, int (*cb)());
240
241 /* The following 2 functions sign and verify a X509_SIG ASN1 object
242  * inside PKCS#1 padded RSA encryption */
243 int RSA_sign(int type, const unsigned char *m, unsigned int m_len,
244         unsigned char *sigret, unsigned int *siglen, RSA *rsa);
245 int RSA_verify(int type, const unsigned char *m, unsigned int m_len,
246         unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
247
248 /* The following 2 function sign and verify a ASN1_OCTET_STRING
249  * object inside PKCS#1 padded RSA encryption */
250 int RSA_sign_ASN1_OCTET_STRING(int type,
251         const unsigned char *m, unsigned int m_len,
252         unsigned char *sigret, unsigned int *siglen, RSA *rsa);
253 int RSA_verify_ASN1_OCTET_STRING(int type,
254         const unsigned char *m, unsigned int m_len,
255         unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
256
257 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
258 void RSA_blinding_off(RSA *rsa);
259
260 int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
261         const unsigned char *f,int fl);
262 int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
263         const unsigned char *f,int fl,int rsa_len);
264 int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
265         const unsigned char *f,int fl);
266 int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
267         const unsigned char *f,int fl,int rsa_len);
268 int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen,
269         const unsigned char *f,int fl,
270         const unsigned char *p,int pl);
271 int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen,
272         const unsigned char *f,int fl,int rsa_len,
273         const unsigned char *p,int pl);
274 int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
275         const unsigned char *f,int fl);
276 int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
277         const unsigned char *f,int fl,int rsa_len);
278 int RSA_padding_add_none(unsigned char *to,int tlen,
279         const unsigned char *f,int fl);
280 int RSA_padding_check_none(unsigned char *to,int tlen,
281         const unsigned char *f,int fl,int rsa_len);
282
283 int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
284         CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
285 int RSA_set_ex_data(RSA *r,int idx,void *arg);
286 void *RSA_get_ex_data(const RSA *r, int idx);
287
288 /* BEGIN ERROR CODES */
289 /* The following lines are auto generated by the script mkerr.pl. Any changes
290  * made after this point may be overwritten when the script is next run.
291  */
292 void ERR_load_RSA_strings(void);
293
294 /* Error codes for the RSA functions. */
295
296 /* Function codes. */
297 #define RSA_F_MEMORY_LOCK                                100
298 #define RSA_F_RSA_CHECK_KEY                              123
299 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT                    101
300 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT                    102
301 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT                     103
302 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT                     104
303 #define RSA_F_RSA_GENERATE_KEY                           105
304 #define RSA_F_RSA_NEW_METHOD                             106
305 #define RSA_F_RSA_NULL                                   124
306 #define RSA_F_RSA_PADDING_ADD_NONE                       107
307 #define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP                 121
308 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1               108
309 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2               109
310 #define RSA_F_RSA_PADDING_ADD_SSLV23                     110
311 #define RSA_F_RSA_PADDING_CHECK_NONE                     111
312 #define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP               122
313 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1             112
314 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2             113
315 #define RSA_F_RSA_PADDING_CHECK_SSLV23                   114
316 #define RSA_F_RSA_PRINT                                  115
317 #define RSA_F_RSA_PRINT_FP                               116
318 #define RSA_F_RSA_SIGN                                   117
319 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING                 118
320 #define RSA_F_RSA_VERIFY                                 119
321 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING               120
322
323 /* Reason codes. */
324 #define RSA_R_ALGORITHM_MISMATCH                         100
325 #define RSA_R_BAD_E_VALUE                                101
326 #define RSA_R_BAD_FIXED_HEADER_DECRYPT                   102
327 #define RSA_R_BAD_PAD_BYTE_COUNT                         103
328 #define RSA_R_BAD_SIGNATURE                              104
329 #define RSA_R_BLOCK_TYPE_IS_NOT_01                       106
330 #define RSA_R_BLOCK_TYPE_IS_NOT_02                       107
331 #define RSA_R_DATA_GREATER_THAN_MOD_LEN                  108
332 #define RSA_R_DATA_TOO_LARGE                             109
333 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                110
334 #define RSA_R_DATA_TOO_LARGE_FOR_MODULUS                 132
335 #define RSA_R_DATA_TOO_SMALL                             111
336 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE                122
337 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY                 112
338 #define RSA_R_DMP1_NOT_CONGRUENT_TO_D                    124
339 #define RSA_R_DMQ1_NOT_CONGRUENT_TO_D                    125
340 #define RSA_R_D_E_NOT_CONGRUENT_TO_1                     123
341 #define RSA_R_INVALID_MESSAGE_LENGTH                     131
342 #define RSA_R_IQMP_NOT_INVERSE_OF_Q                      126
343 #define RSA_R_KEY_SIZE_TOO_SMALL                         120
344 #define RSA_R_NULL_BEFORE_BLOCK_MISSING                  113
345 #define RSA_R_N_DOES_NOT_EQUAL_P_Q                       127
346 #define RSA_R_OAEP_DECODING_ERROR                        121
347 #define RSA_R_PADDING_CHECK_FAILED                       114
348 #define RSA_R_P_NOT_PRIME                                128
349 #define RSA_R_Q_NOT_PRIME                                129
350 #define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED               130
351 #define RSA_R_SSLV3_ROLLBACK_ATTACK                      115
352 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
353 #define RSA_R_UNKNOWN_ALGORITHM_TYPE                     117
354 #define RSA_R_UNKNOWN_PADDING_TYPE                       118
355 #define RSA_R_WRONG_SIGNATURE_LENGTH                     119
356
357 #ifdef  __cplusplus
358 }
359 #endif
360 #endif