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