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 #include <openssl/ossl_typ.h> 70 71 #ifdef OPENSSL_NO_RSA 72 #error RSA is disabled. 73 #endif 74 75 #if defined(OPENSSL_FIPS) 76 #define FIPS_RSA_SIZE_T int 77 #endif 78 79 #ifdef __cplusplus 80 extern "C" { 81 #endif 82 83 typedef struct rsa_st RSA; 84 85 typedef struct rsa_meth_st 86 { 87 const char *name; 88 int (*rsa_pub_enc)(int flen,const unsigned char *from, 89 unsigned char *to, 90 RSA *rsa,int padding); 91 int (*rsa_pub_dec)(int flen,const unsigned char *from, 92 unsigned char *to, 93 RSA *rsa,int padding); 94 int (*rsa_priv_enc)(int flen,const unsigned char *from, 95 unsigned char *to, 96 RSA *rsa,int padding); 97 int (*rsa_priv_dec)(int flen,const unsigned char *from, 98 unsigned char *to, 99 RSA *rsa,int padding); 100 int (*rsa_mod_exp)(BIGNUM *r0,const BIGNUM *I,RSA *rsa); /* Can be null */ 101 int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 102 const BIGNUM *m, BN_CTX *ctx, 103 BN_MONT_CTX *m_ctx); /* Can be null */ 104 int (*init)(RSA *rsa); /* called at new */ 105 int (*finish)(RSA *rsa); /* called at free */ 106 int flags; /* RSA_METHOD_FLAG_* things */ 107 char *app_data; /* may be needed! */ 108 /* New sign and verify functions: some libraries don't allow arbitrary data 109 * to be signed/verified: this allows them to be used. Note: for this to work 110 * the RSA_public_decrypt() and RSA_private_encrypt() should *NOT* be used 111 * RSA_sign(), RSA_verify() should be used instead. Note: for backwards 112 * compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER 113 * option is set in 'flags'. 114 */ 115 int (*rsa_sign)(int type, 116 const unsigned char *m, unsigned int m_length, 117 unsigned char *sigret, unsigned int *siglen, const RSA *rsa); 118 int (*rsa_verify)(int dtype, 119 const unsigned char *m, unsigned int m_length, 120 unsigned char *sigbuf, unsigned int siglen, const RSA *rsa); 121 122 } RSA_METHOD; 123 124 struct rsa_st 125 { 126 /* The first parameter is used to pickup errors where 127 * this is passed instead of aEVP_PKEY, it is set to 0 */ 128 int pad; 129 long version; 130 const RSA_METHOD *meth; 131 /* functional reference if 'meth' is ENGINE-provided */ 132 ENGINE *engine; 133 BIGNUM *n; 134 BIGNUM *e; 135 BIGNUM *d; 136 BIGNUM *p; 137 BIGNUM *q; 138 BIGNUM *dmp1; 139 BIGNUM *dmq1; 140 BIGNUM *iqmp; 141 /* be careful using this if the RSA structure is shared */ 142 CRYPTO_EX_DATA ex_data; 143 int references; 144 int flags; 145 146 /* Used to cache montgomery values */ 147 BN_MONT_CTX *_method_mod_n; 148 BN_MONT_CTX *_method_mod_p; 149 BN_MONT_CTX *_method_mod_q; 150 151 /* all BIGNUM values are actually in the following data, if it is not 152 * NULL */ 153 char *bignum_data; 154 BN_BLINDING *blinding; 155 }; 156 157 #ifndef OPENSSL_RSA_MAX_MODULUS_BITS 158 # define OPENSSL_RSA_MAX_MODULUS_BITS 16384 159 #endif 160 161 #ifndef OPENSSL_RSA_SMALL_MODULUS_BITS 162 # define OPENSSL_RSA_SMALL_MODULUS_BITS 3072 163 #endif 164 #ifndef OPENSSL_RSA_MAX_PUBEXP_BITS 165 # define OPENSSL_RSA_MAX_PUBEXP_BITS 64 166 #endif 167 168 #define RSA_F4 0x10001L 169 170 #define RSA_METHOD_FLAG_NO_CHECK 0x0001 /* don't check pub/private match */ 171 172 #define RSA_FLAG_CACHE_PUBLIC 0x0002 173 #define RSA_FLAG_CACHE_PRIVATE 0x0004 174 #define RSA_FLAG_BLINDING 0x0008 175 #define RSA_FLAG_THREAD_SAFE 0x0010 176 /* This flag means the private key operations will be handled by rsa_mod_exp 177 * and that they do not depend on the private key components being present: 178 * for example a key stored in external hardware. Without this flag bn_mod_exp 179 * gets called when private key components are absent. 180 */ 181 #define RSA_FLAG_EXT_PKEY 0x0020 182 183 /* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions. 184 */ 185 #define RSA_FLAG_SIGN_VER 0x0040 186 187 #define RSA_FLAG_NO_BLINDING 0x0080 /* new with 0.9.6j and 0.9.7b; the built-in 188 * RSA implementation now uses blinding by 189 * default (ignoring RSA_FLAG_BLINDING), 190 * but other engines might not need it 191 */ 192 #define RSA_FLAG_NO_EXP_CONSTTIME 0x0100 /* new with 0.9.7h; the built-in RSA 193 * implementation now uses constant time 194 * modular exponentiation for secret exponents 195 * by default. This flag causes the 196 * faster variable sliding window method to 197 * be used for all exponents. 198 */ 199 200 #define RSA_PKCS1_PADDING 1 201 #define RSA_SSLV23_PADDING 2 202 #define RSA_NO_PADDING 3 203 #define RSA_PKCS1_OAEP_PADDING 4 204 #define RSA_X931_PADDING 5 205 206 #define RSA_PKCS1_PADDING_SIZE 11 207 208 #define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg) 209 #define RSA_get_app_data(s) RSA_get_ex_data(s,0) 210 211 RSA * RSA_new(void); 212 RSA * RSA_new_method(ENGINE *engine); 213 int RSA_size(const RSA *); 214 RSA * RSA_generate_key(int bits, unsigned long e,void 215 (*callback)(int,int,void *),void *cb_arg); 216 int RSA_check_key(const RSA *); 217 #ifdef OPENSSL_FIPS 218 int RSA_X931_derive(RSA *rsa, BIGNUM *p1, BIGNUM *p2, BIGNUM *q1, BIGNUM *q2, 219 void (*cb)(int, int, void *), void *cb_arg, 220 const BIGNUM *Xp1, const BIGNUM *Xp2, const BIGNUM *Xp, 221 const BIGNUM *Xq1, const BIGNUM *Xq2, const BIGNUM *Xq, 222 const BIGNUM *e); 223 RSA *RSA_X931_generate_key(int bits, const BIGNUM *e, 224 void (*cb)(int,int,void *), void *cb_arg); 225 #endif 226 /* next 4 return -1 on error */ 227 int RSA_public_encrypt(int flen, const unsigned char *from, 228 unsigned char *to, RSA *rsa,int padding); 229 int RSA_private_encrypt(int flen, const unsigned char *from, 230 unsigned char *to, RSA *rsa,int padding); 231 int RSA_public_decrypt(int flen, const unsigned char *from, 232 unsigned char *to, RSA *rsa,int padding); 233 int RSA_private_decrypt(int flen, const unsigned char *from, 234 unsigned char *to, RSA *rsa,int padding); 235 void RSA_free (RSA *r); 236 /* "up" the RSA object's reference count */ 237 int RSA_up_ref(RSA *r); 238 239 int RSA_flags(const RSA *r); 240 241 void RSA_set_default_method(const RSA_METHOD *meth); 242 const RSA_METHOD *RSA_get_default_method(void); 243 const RSA_METHOD *RSA_get_method(const RSA *rsa); 244 int RSA_set_method(RSA *rsa, const RSA_METHOD *meth); 245 246 /* This function needs the memory locking malloc callbacks to be installed */ 247 int RSA_memory_lock(RSA *r); 248 249 /* these are the actual SSLeay RSA functions */ 250 const RSA_METHOD *RSA_PKCS1_SSLeay(void); 251 252 const RSA_METHOD *RSA_null_method(void); 253 254 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPublicKey) 255 DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPrivateKey) 256 257 #ifndef OPENSSL_NO_FP_API 258 int RSA_print_fp(FILE *fp, const RSA *r,int offset); 259 #endif 260 261 #ifndef OPENSSL_NO_BIO 262 int RSA_print(BIO *bp, const RSA *r,int offset); 263 #endif 264 265 int i2d_RSA_NET(const RSA *a, unsigned char **pp, int (*cb)(), int sgckey); 266 RSA *d2i_RSA_NET(RSA **a, const unsigned char **pp, long length, int (*cb)(), int sgckey); 267 268 int i2d_Netscape_RSA(const RSA *a, unsigned char **pp, int (*cb)()); 269 RSA *d2i_Netscape_RSA(RSA **a, const unsigned char **pp, long length, int (*cb)()); 270 271 /* The following 2 functions sign and verify a X509_SIG ASN1 object 272 * inside PKCS#1 padded RSA encryption */ 273 int RSA_sign(int type, const unsigned char *m, unsigned int m_length, 274 unsigned char *sigret, unsigned int *siglen, RSA *rsa); 275 int RSA_verify(int type, const unsigned char *m, unsigned int m_length, 276 unsigned char *sigbuf, unsigned int siglen, RSA *rsa); 277 278 /* The following 2 function sign and verify a ASN1_OCTET_STRING 279 * object inside PKCS#1 padded RSA encryption */ 280 int RSA_sign_ASN1_OCTET_STRING(int type, 281 const unsigned char *m, unsigned int m_length, 282 unsigned char *sigret, unsigned int *siglen, RSA *rsa); 283 int RSA_verify_ASN1_OCTET_STRING(int type, 284 const unsigned char *m, unsigned int m_length, 285 unsigned char *sigbuf, unsigned int siglen, RSA *rsa); 286 287 int RSA_blinding_on(RSA *rsa, BN_CTX *ctx); 288 void RSA_blinding_off(RSA *rsa); 289 290 int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen, 291 const unsigned char *f,int fl); 292 int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen, 293 const unsigned char *f,int fl,int rsa_len); 294 int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen, 295 const unsigned char *f,int fl); 296 int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen, 297 const unsigned char *f,int fl,int rsa_len); 298 int PKCS1_MGF1(unsigned char *mask, long len, 299 const unsigned char *seed, long seedlen, const EVP_MD *dgst); 300 int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen, 301 const unsigned char *f,int fl, 302 const unsigned char *p,int pl); 303 int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen, 304 const unsigned char *f,int fl,int rsa_len, 305 const unsigned char *p,int pl); 306 int RSA_padding_add_SSLv23(unsigned char *to,int tlen, 307 const unsigned char *f,int fl); 308 int RSA_padding_check_SSLv23(unsigned char *to,int tlen, 309 const unsigned char *f,int fl,int rsa_len); 310 int RSA_padding_add_none(unsigned char *to,int tlen, 311 const unsigned char *f,int fl); 312 int RSA_padding_check_none(unsigned char *to,int tlen, 313 const unsigned char *f,int fl,int rsa_len); 314 int RSA_padding_add_X931(unsigned char *to,int tlen, 315 const unsigned char *f,int fl); 316 int RSA_padding_check_X931(unsigned char *to,int tlen, 317 const unsigned char *f,int fl,int rsa_len); 318 int RSA_X931_hash_id(int nid); 319 320 int RSA_verify_PKCS1_PSS(RSA *rsa, const unsigned char *mHash, 321 const EVP_MD *Hash, const unsigned char *EM, int sLen); 322 int RSA_padding_add_PKCS1_PSS(RSA *rsa, unsigned char *EM, 323 const unsigned char *mHash, 324 const EVP_MD *Hash, int sLen); 325 326 int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 327 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 328 int RSA_set_ex_data(RSA *r,int idx,void *arg); 329 void *RSA_get_ex_data(const RSA *r, int idx); 330 331 RSA *RSAPublicKey_dup(RSA *rsa); 332 RSA *RSAPrivateKey_dup(RSA *rsa); 333 334 /* BEGIN ERROR CODES */ 335 /* The following lines are auto generated by the script mkerr.pl. Any changes 336 * made after this point may be overwritten when the script is next run. 337 */ 338 void ERR_load_RSA_strings(void); 339 340 /* Error codes for the RSA functions. */ 341 342 /* Function codes. */ 343 #define RSA_F_MEMORY_LOCK 100 344 #define RSA_F_RSA_CHECK_KEY 123 345 #define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101 346 #define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102 347 #define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103 348 #define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104 349 #define RSA_F_RSA_GENERATE_KEY 105 350 #define RSA_F_RSA_NEW_METHOD 106 351 #define RSA_F_RSA_NULL 124 352 #define RSA_F_RSA_PADDING_ADD_NONE 107 353 #define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121 354 #define RSA_F_RSA_PADDING_ADD_PKCS1_PSS 125 355 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108 356 #define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109 357 #define RSA_F_RSA_PADDING_ADD_SSLV23 110 358 #define RSA_F_RSA_PADDING_ADD_X931 127 359 #define RSA_F_RSA_PADDING_CHECK_NONE 111 360 #define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122 361 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112 362 #define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113 363 #define RSA_F_RSA_PADDING_CHECK_SSLV23 114 364 #define RSA_F_RSA_PADDING_CHECK_X931 128 365 #define RSA_F_RSA_PRINT 115 366 #define RSA_F_RSA_PRINT_FP 116 367 #define RSA_F_RSA_SIGN 117 368 #define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118 369 #define RSA_F_RSA_VERIFY 119 370 #define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120 371 #define RSA_F_RSA_VERIFY_PKCS1_PSS 126 372 373 /* Reason codes. */ 374 #define RSA_R_ALGORITHM_MISMATCH 100 375 #define RSA_R_BAD_E_VALUE 101 376 #define RSA_R_BAD_FIXED_HEADER_DECRYPT 102 377 #define RSA_R_BAD_PAD_BYTE_COUNT 103 378 #define RSA_R_BAD_SIGNATURE 104 379 #define RSA_R_BLOCK_TYPE_IS_NOT_01 106 380 #define RSA_R_BLOCK_TYPE_IS_NOT_02 107 381 #define RSA_R_DATA_GREATER_THAN_MOD_LEN 108 382 #define RSA_R_DATA_TOO_LARGE 109 383 #define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110 384 #define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 132 385 #define RSA_R_DATA_TOO_SMALL 111 386 #define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122 387 #define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112 388 #define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124 389 #define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125 390 #define RSA_R_D_E_NOT_CONGRUENT_TO_1 123 391 #define RSA_R_FIRST_OCTET_INVALID 133 392 #define RSA_R_INVALID_HEADER 137 393 #define RSA_R_INVALID_MESSAGE_LENGTH 131 394 #define RSA_R_INVALID_PADDING 138 395 #define RSA_R_INVALID_TRAILER 139 396 #define RSA_R_IQMP_NOT_INVERSE_OF_Q 126 397 #define RSA_R_KEY_SIZE_TOO_SMALL 120 398 #define RSA_R_LAST_OCTET_INVALID 134 399 #define RSA_R_MODULUS_TOO_LARGE 105 400 #define RSA_R_NULL_BEFORE_BLOCK_MISSING 113 401 #define RSA_R_N_DOES_NOT_EQUAL_P_Q 127 402 #define RSA_R_OAEP_DECODING_ERROR 121 403 #define RSA_R_PADDING_CHECK_FAILED 114 404 #define RSA_R_P_NOT_PRIME 128 405 #define RSA_R_Q_NOT_PRIME 129 406 #define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130 407 #define RSA_R_SLEN_CHECK_FAILED 136 408 #define RSA_R_SLEN_RECOVERY_FAILED 135 409 #define RSA_R_SSLV3_ROLLBACK_ATTACK 115 410 #define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116 411 #define RSA_R_UNKNOWN_ALGORITHM_TYPE 117 412 #define RSA_R_UNKNOWN_PADDING_TYPE 118 413 #define RSA_R_WRONG_SIGNATURE_LENGTH 119 414 415 #ifdef __cplusplus 416 } 417 #endif 418 #endif 419