1 /* crypto/rsa/rsa.h */
\r
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
\r
3 * All rights reserved.
\r
5 * This package is an SSL implementation written
\r
6 * by Eric Young (eay@cryptsoft.com).
\r
7 * The implementation was written so as to conform with Netscapes SSL.
\r
9 * This library is free for commercial and non-commercial use as long as
\r
10 * the following conditions are aheared to. The following conditions
\r
11 * apply to all code found in this distribution, be it the RC4, RSA,
\r
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
\r
13 * included with this distribution is covered by the same copyright terms
\r
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
\r
16 * Copyright remains Eric Young's, and as such any Copyright notices in
\r
17 * the code are not to be removed.
\r
18 * If this package is used in a product, Eric Young should be given attribution
\r
19 * as the author of the parts of the library used.
\r
20 * This can be in the form of a textual message at program startup or
\r
21 * in documentation (online or textual) provided with the package.
\r
23 * Redistribution and use in source and binary forms, with or without
\r
24 * modification, are permitted provided that the following conditions
\r
26 * 1. Redistributions of source code must retain the copyright
\r
27 * notice, this list of conditions and the following disclaimer.
\r
28 * 2. Redistributions in binary form must reproduce the above copyright
\r
29 * notice, this list of conditions and the following disclaimer in the
\r
30 * documentation and/or other materials provided with the distribution.
\r
31 * 3. All advertising materials mentioning features or use of this software
\r
32 * must display the following acknowledgement:
\r
33 * "This product includes cryptographic software written by
\r
34 * Eric Young (eay@cryptsoft.com)"
\r
35 * The word 'cryptographic' can be left out if the rouines from the library
\r
36 * being used are not cryptographic related :-).
\r
37 * 4. If you include any Windows specific code (or a derivative thereof) from
\r
38 * the apps directory (application code) you must include an acknowledgement:
\r
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
\r
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
\r
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\r
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
\r
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
\r
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\r
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
\r
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\r
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
\r
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
\r
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
\r
53 * The licence and distribution terms for any publically available version or
\r
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
\r
55 * copied and put under another distribution licence
\r
56 * [including the GNU Public Licence.]
\r
59 #ifndef HEADER_RSA_H
\r
60 #define HEADER_RSA_H
\r
62 #include <openssl/asn1.h>
\r
64 #ifndef OPENSSL_NO_BIO
\r
65 #include <openssl/bio.h>
\r
67 #include <openssl/crypto.h>
\r
68 #include <openssl/ossl_typ.h>
\r
69 #ifndef OPENSSL_NO_DEPRECATED
\r
70 #include <openssl/bn.h>
\r
73 #ifdef OPENSSL_NO_RSA
\r
74 #error RSA is disabled.
\r
81 /* Declared already in ossl_typ.h */
\r
82 /* typedef struct rsa_st RSA; */
\r
83 /* typedef struct rsa_meth_st RSA_METHOD; */
\r
88 int (*rsa_pub_enc)(int flen,const unsigned char *from,
\r
90 RSA *rsa,int padding);
\r
91 int (*rsa_pub_dec)(int flen,const unsigned char *from,
\r
93 RSA *rsa,int padding);
\r
94 int (*rsa_priv_enc)(int flen,const unsigned char *from,
\r
96 RSA *rsa,int padding);
\r
97 int (*rsa_priv_dec)(int flen,const unsigned char *from,
\r
99 RSA *rsa,int padding);
\r
100 int (*rsa_mod_exp)(BIGNUM *r0,const BIGNUM *I,RSA *rsa,BN_CTX *ctx); /* Can be null */
\r
101 int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
\r
102 const BIGNUM *m, BN_CTX *ctx,
\r
103 BN_MONT_CTX *m_ctx); /* Can be null */
\r
104 int (*init)(RSA *rsa); /* called at new */
\r
105 int (*finish)(RSA *rsa); /* called at free */
\r
106 int flags; /* RSA_METHOD_FLAG_* things */
\r
107 char *app_data; /* may be needed! */
\r
108 /* New sign and verify functions: some libraries don't allow arbitrary data
\r
109 * to be signed/verified: this allows them to be used. Note: for this to work
\r
110 * the RSA_public_decrypt() and RSA_private_encrypt() should *NOT* be used
\r
111 * RSA_sign(), RSA_verify() should be used instead. Note: for backwards
\r
112 * compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER
\r
113 * option is set in 'flags'.
\r
115 int (*rsa_sign)(int type,
\r
116 const unsigned char *m, unsigned int m_length,
\r
117 unsigned char *sigret, unsigned int *siglen, const RSA *rsa);
\r
118 int (*rsa_verify)(int dtype,
\r
119 const unsigned char *m, unsigned int m_length,
\r
120 unsigned char *sigbuf, unsigned int siglen, const RSA *rsa);
\r
121 /* If this callback is NULL, the builtin software RSA key-gen will be used. This
\r
122 * is for behavioural compatibility whilst the code gets rewired, but one day
\r
123 * it would be nice to assume there are no such things as "builtin software"
\r
124 * implementations. */
\r
125 int (*rsa_keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
\r
130 /* The first parameter is used to pickup errors where
\r
131 * this is passed instead of aEVP_PKEY, it is set to 0 */
\r
134 const RSA_METHOD *meth;
\r
135 /* functional reference if 'meth' is ENGINE-provided */
\r
145 /* be careful using this if the RSA structure is shared */
\r
146 CRYPTO_EX_DATA ex_data;
\r
150 /* Used to cache montgomery values */
\r
151 BN_MONT_CTX *_method_mod_n;
\r
152 BN_MONT_CTX *_method_mod_p;
\r
153 BN_MONT_CTX *_method_mod_q;
\r
155 /* all BIGNUM values are actually in the following data, if it is not
\r
158 BN_BLINDING *blinding;
\r
159 BN_BLINDING *mt_blinding;
\r
163 #define RSA_F4 0x10001L
\r
165 #define RSA_METHOD_FLAG_NO_CHECK 0x0001 /* don't check pub/private match */
\r
167 #define RSA_FLAG_CACHE_PUBLIC 0x0002
\r
168 #define RSA_FLAG_CACHE_PRIVATE 0x0004
\r
169 #define RSA_FLAG_BLINDING 0x0008
\r
170 #define RSA_FLAG_THREAD_SAFE 0x0010
\r
171 /* This flag means the private key operations will be handled by rsa_mod_exp
\r
172 * and that they do not depend on the private key components being present:
\r
173 * for example a key stored in external hardware. Without this flag bn_mod_exp
\r
174 * gets called when private key components are absent.
\r
176 #define RSA_FLAG_EXT_PKEY 0x0020
\r
178 /* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions.
\r
180 #define RSA_FLAG_SIGN_VER 0x0040
\r
182 #define RSA_FLAG_NO_BLINDING 0x0080 /* new with 0.9.6j and 0.9.7b; the built-in
\r
183 * RSA implementation now uses blinding by
\r
184 * default (ignoring RSA_FLAG_BLINDING),
\r
185 * but other engines might not need it
\r
187 #define RSA_FLAG_NO_EXP_CONSTTIME 0x0100 /* new with 0.9.7h; the built-in RSA
\r
188 * implementation now uses constant time
\r
189 * modular exponentiation for secret exponents
\r
190 * by default. This flag causes the
\r
191 * faster variable sliding window method to
\r
192 * be used for all exponents.
\r
195 #define RSA_PKCS1_PADDING 1
\r
196 #define RSA_SSLV23_PADDING 2
\r
197 #define RSA_NO_PADDING 3
\r
198 #define RSA_PKCS1_OAEP_PADDING 4
\r
199 #define RSA_X931_PADDING 5
\r
201 #define RSA_PKCS1_PADDING_SIZE 11
\r
203 #define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg)
\r
204 #define RSA_get_app_data(s) RSA_get_ex_data(s,0)
\r
206 RSA * RSA_new(void);
\r
207 RSA * RSA_new_method(ENGINE *engine);
\r
208 int RSA_size(const RSA *);
\r
210 /* Deprecated version */
\r
211 #ifndef OPENSSL_NO_DEPRECATED
\r
212 RSA * RSA_generate_key(int bits, unsigned long e,void
\r
213 (*callback)(int,int,void *),void *cb_arg);
\r
214 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
\r
217 int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
\r
219 int RSA_check_key(const RSA *);
\r
220 /* next 4 return -1 on error */
\r
221 int RSA_public_encrypt(int flen, const unsigned char *from,
\r
222 unsigned char *to, RSA *rsa,int padding);
\r
223 int RSA_private_encrypt(int flen, const unsigned char *from,
\r
224 unsigned char *to, RSA *rsa,int padding);
\r
225 int RSA_public_decrypt(int flen, const unsigned char *from,
\r
226 unsigned char *to, RSA *rsa,int padding);
\r
227 int RSA_private_decrypt(int flen, const unsigned char *from,
\r
228 unsigned char *to, RSA *rsa,int padding);
\r
229 void RSA_free (RSA *r);
\r
230 /* "up" the RSA object's reference count */
\r
231 int RSA_up_ref(RSA *r);
\r
233 int RSA_flags(const RSA *r);
\r
235 void RSA_set_default_method(const RSA_METHOD *meth);
\r
236 const RSA_METHOD *RSA_get_default_method(void);
\r
237 const RSA_METHOD *RSA_get_method(const RSA *rsa);
\r
238 int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
\r
240 /* This function needs the memory locking malloc callbacks to be installed */
\r
241 int RSA_memory_lock(RSA *r);
\r
243 /* these are the actual SSLeay RSA functions */
\r
244 const RSA_METHOD *RSA_PKCS1_SSLeay(void);
\r
246 const RSA_METHOD *RSA_null_method(void);
\r
248 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPublicKey)
\r
249 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPrivateKey)
\r
251 #ifndef OPENSSL_NO_FP_API
\r
252 int RSA_print_fp(FILE *fp, const RSA *r,int offset);
\r
255 #ifndef OPENSSL_NO_BIO
\r
256 int RSA_print(BIO *bp, const RSA *r,int offset);
\r
259 int i2d_RSA_NET(const RSA *a, unsigned char **pp,
\r
260 int (*cb)(char *buf, int len, const char *prompt, int verify),
\r
262 RSA *d2i_RSA_NET(RSA **a, const unsigned char **pp, long length,
\r
263 int (*cb)(char *buf, int len, const char *prompt, int verify),
\r
266 int i2d_Netscape_RSA(const RSA *a, unsigned char **pp,
\r
267 int (*cb)(char *buf, int len, const char *prompt,
\r
269 RSA *d2i_Netscape_RSA(RSA **a, const unsigned char **pp, long length,
\r
270 int (*cb)(char *buf, int len, const char *prompt,
\r
273 /* The following 2 functions sign and verify a X509_SIG ASN1 object
\r
274 * inside PKCS#1 padded RSA encryption */
\r
275 int RSA_sign(int type, const unsigned char *m, unsigned int m_length,
\r
276 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
\r
277 int RSA_verify(int type, const unsigned char *m, unsigned int m_length,
\r
278 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
\r
280 /* The following 2 function sign and verify a ASN1_OCTET_STRING
\r
281 * object inside PKCS#1 padded RSA encryption */
\r
282 int RSA_sign_ASN1_OCTET_STRING(int type,
\r
283 const unsigned char *m, unsigned int m_length,
\r
284 unsigned char *sigret, unsigned int *siglen, RSA *rsa);
\r
285 int RSA_verify_ASN1_OCTET_STRING(int type,
\r
286 const unsigned char *m, unsigned int m_length,
\r
287 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
\r
289 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
\r
290 void RSA_blinding_off(RSA *rsa);
\r
291 BN_BLINDING *RSA_setup_blinding(RSA *rsa, BN_CTX *ctx);
\r
293 int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen,
\r
294 const unsigned char *f,int fl);
\r
295 int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen,
\r
296 const unsigned char *f,int fl,int rsa_len);
\r
297 int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen,
\r
298 const unsigned char *f,int fl);
\r
299 int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen,
\r
300 const unsigned char *f,int fl,int rsa_len);
\r
301 int PKCS1_MGF1(unsigned char *mask, long len,
\r
302 const unsigned char *seed, long seedlen, const EVP_MD *dgst);
\r
303 int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen,
\r
304 const unsigned char *f,int fl,
\r
305 const unsigned char *p,int pl);
\r
306 int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen,
\r
307 const unsigned char *f,int fl,int rsa_len,
\r
308 const unsigned char *p,int pl);
\r
309 int RSA_padding_add_SSLv23(unsigned char *to,int tlen,
\r
310 const unsigned char *f,int fl);
\r
311 int RSA_padding_check_SSLv23(unsigned char *to,int tlen,
\r
312 const unsigned char *f,int fl,int rsa_len);
\r
313 int RSA_padding_add_none(unsigned char *to,int tlen,
\r
314 const unsigned char *f,int fl);
\r
315 int RSA_padding_check_none(unsigned char *to,int tlen,
\r
316 const unsigned char *f,int fl,int rsa_len);
\r
317 int RSA_padding_add_X931(unsigned char *to,int tlen,
\r
318 const unsigned char *f,int fl);
\r
319 int RSA_padding_check_X931(unsigned char *to,int tlen,
\r
320 const unsigned char *f,int fl,int rsa_len);
\r
321 int RSA_X931_hash_id(int nid);
\r
323 int RSA_verify_PKCS1_PSS(RSA *rsa, const unsigned char *mHash,
\r
324 const EVP_MD *Hash, const unsigned char *EM, int sLen);
\r
325 int RSA_padding_add_PKCS1_PSS(RSA *rsa, unsigned char *EM,
\r
326 const unsigned char *mHash,
\r
327 const EVP_MD *Hash, int sLen);
\r
329 int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
\r
330 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
\r
331 int RSA_set_ex_data(RSA *r,int idx,void *arg);
\r
332 void *RSA_get_ex_data(const RSA *r, int idx);
\r
334 RSA *RSAPublicKey_dup(RSA *rsa);
\r
335 RSA *RSAPrivateKey_dup(RSA *rsa);
\r
337 /* BEGIN ERROR CODES */
\r
338 /* The following lines are auto generated by the script mkerr.pl. Any changes
\r
339 * made after this point may be overwritten when the script is next run.
\r
341 void ERR_load_RSA_strings(void);
\r
343 /* Error codes for the RSA functions. */
\r
345 /* Function codes. */
\r
346 #define RSA_F_MEMORY_LOCK 100
\r
347 #define RSA_F_RSA_BUILTIN_KEYGEN 129
\r
348 #define RSA_F_RSA_CHECK_KEY 123
\r
349 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101
\r
350 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102
\r
351 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103
\r
352 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104
\r
353 #define RSA_F_RSA_GENERATE_KEY 105
\r
354 #define RSA_F_RSA_MEMORY_LOCK 130
\r
355 #define RSA_F_RSA_NEW_METHOD 106
\r
356 #define RSA_F_RSA_NULL 124
\r
357 #define RSA_F_RSA_NULL_MOD_EXP 131
\r
358 #define RSA_F_RSA_NULL_PRIVATE_DECRYPT 132
\r
359 #define RSA_F_RSA_NULL_PRIVATE_ENCRYPT 133
\r
360 #define RSA_F_RSA_NULL_PUBLIC_DECRYPT 134
\r
361 #define RSA_F_RSA_NULL_PUBLIC_ENCRYPT 135
\r
362 #define RSA_F_RSA_PADDING_ADD_NONE 107
\r
363 #define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121
\r
364 #define RSA_F_RSA_PADDING_ADD_PKCS1_PSS 125
\r
365 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108
\r
366 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109
\r
367 #define RSA_F_RSA_PADDING_ADD_SSLV23 110
\r
368 #define RSA_F_RSA_PADDING_ADD_X931 127
\r
369 #define RSA_F_RSA_PADDING_CHECK_NONE 111
\r
370 #define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122
\r
371 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112
\r
372 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113
\r
373 #define RSA_F_RSA_PADDING_CHECK_SSLV23 114
\r
374 #define RSA_F_RSA_PADDING_CHECK_X931 128
\r
375 #define RSA_F_RSA_PRINT 115
\r
376 #define RSA_F_RSA_PRINT_FP 116
\r
377 #define RSA_F_RSA_SETUP_BLINDING 136
\r
378 #define RSA_F_RSA_SIGN 117
\r
379 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118
\r
380 #define RSA_F_RSA_VERIFY 119
\r
381 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120
\r
382 #define RSA_F_RSA_VERIFY_PKCS1_PSS 126
\r
384 /* Reason codes. */
\r
385 #define RSA_R_ALGORITHM_MISMATCH 100
\r
386 #define RSA_R_BAD_E_VALUE 101
\r
387 #define RSA_R_BAD_FIXED_HEADER_DECRYPT 102
\r
388 #define RSA_R_BAD_PAD_BYTE_COUNT 103
\r
389 #define RSA_R_BAD_SIGNATURE 104
\r
390 #define RSA_R_BLOCK_TYPE_IS_NOT_01 106
\r
391 #define RSA_R_BLOCK_TYPE_IS_NOT_02 107
\r
392 #define RSA_R_DATA_GREATER_THAN_MOD_LEN 108
\r
393 #define RSA_R_DATA_TOO_LARGE 109
\r
394 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110
\r
395 #define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 132
\r
396 #define RSA_R_DATA_TOO_SMALL 111
\r
397 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122
\r
398 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112
\r
399 #define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124
\r
400 #define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125
\r
401 #define RSA_R_D_E_NOT_CONGRUENT_TO_1 123
\r
402 #define RSA_R_FIRST_OCTET_INVALID 133
\r
403 #define RSA_R_INVALID_HEADER 137
\r
404 #define RSA_R_INVALID_MESSAGE_LENGTH 131
\r
405 #define RSA_R_INVALID_PADDING 138
\r
406 #define RSA_R_INVALID_TRAILER 139
\r
407 #define RSA_R_IQMP_NOT_INVERSE_OF_Q 126
\r
408 #define RSA_R_KEY_SIZE_TOO_SMALL 120
\r
409 #define RSA_R_LAST_OCTET_INVALID 134
\r
410 #define RSA_R_NO_PUBLIC_EXPONENT 140
\r
411 #define RSA_R_NULL_BEFORE_BLOCK_MISSING 113
\r
412 #define RSA_R_N_DOES_NOT_EQUAL_P_Q 127
\r
413 #define RSA_R_OAEP_DECODING_ERROR 121
\r
414 #define RSA_R_SLEN_RECOVERY_FAILED 135
\r
415 #define RSA_R_PADDING_CHECK_FAILED 114
\r
416 #define RSA_R_P_NOT_PRIME 128
\r
417 #define RSA_R_Q_NOT_PRIME 129
\r
418 #define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130
\r
419 #define RSA_R_SSLV3_ROLLBACK_ATTACK 115
\r
420 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116
\r
421 #define RSA_R_UNKNOWN_ALGORITHM_TYPE 117
\r
422 #define RSA_R_UNKNOWN_PADDING_TYPE 118
\r
423 #define RSA_R_WRONG_SIGNATURE_LENGTH 119
\r
424 #define RSA_R_SLEN_CHECK_FAILED 136
\r