rsa.h revision 68654
1/* crypto/rsa/rsa.h */ 2/* $FreeBSD: head/crypto/openssl/crypto/rsa/rsa.h 68654 2000-11-13 02:20:29Z kris $ */ 3/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 4 * All rights reserved. 5 * 6 * This package is an SSL implementation written 7 * by Eric Young (eay@cryptsoft.com). 8 * The implementation was written so as to conform with Netscapes SSL. 9 * 10 * This library is free for commercial and non-commercial use as long as 11 * the following conditions are aheared to. The following conditions 12 * apply to all code found in this distribution, be it the RC4, RSA, 13 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 14 * included with this distribution is covered by the same copyright terms 15 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 16 * 17 * Copyright remains Eric Young's, and as such any Copyright notices in 18 * the code are not to be removed. 19 * If this package is used in a product, Eric Young should be given attribution 20 * as the author of the parts of the library used. 21 * This can be in the form of a textual message at program startup or 22 * in documentation (online or textual) provided with the package. 23 * 24 * Redistribution and use in source and binary forms, with or without 25 * modification, are permitted provided that the following conditions 26 * are met: 27 * 1. Redistributions of source code must retain the copyright 28 * notice, this list of conditions and the following disclaimer. 29 * 2. Redistributions in binary form must reproduce the above copyright 30 * notice, this list of conditions and the following disclaimer in the 31 * documentation and/or other materials provided with the distribution. 32 * 3. All advertising materials mentioning features or use of this software 33 * must display the following acknowledgement: 34 * "This product includes cryptographic software written by 35 * Eric Young (eay@cryptsoft.com)" 36 * The word 'cryptographic' can be left out if the rouines from the library 37 * being used are not cryptographic related :-). 38 * 4. If you include any Windows specific code (or a derivative thereof) from 39 * the apps directory (application code) you must include an acknowledgement: 40 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 41 * 42 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 43 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 44 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 45 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 46 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 47 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 48 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 49 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 50 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 51 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 52 * SUCH DAMAGE. 53 * 54 * The licence and distribution terms for any publically available version or 55 * derivative of this code cannot be changed. i.e. this code cannot simply be 56 * copied and put under another distribution licence 57 * [including the GNU Public Licence.] 58 */ 59 60#ifndef HEADER_RSA_H 61#define HEADER_RSA_H 62 63#ifndef NO_BIO 64#include <openssl/bio.h> 65#endif 66#include <openssl/bn.h> 67#include <openssl/crypto.h> 68 69#ifdef NO_RSA 70#error RSA is disabled. 71#endif 72 73#ifdef __cplusplus 74extern "C" { 75#endif 76 77typedef struct rsa_st RSA; 78 79typedef struct rsa_meth_st 80 { 81 const char *name; 82 int (*rsa_pub_enc)(int flen,unsigned char *from,unsigned char *to, 83 RSA *rsa,int padding); 84 int (*rsa_pub_dec)(int flen,unsigned char *from,unsigned char *to, 85 RSA *rsa,int padding); 86 int (*rsa_priv_enc)(int flen,unsigned char *from,unsigned char *to, 87 RSA *rsa,int padding); 88 int (*rsa_priv_dec)(int flen,unsigned char *from,unsigned char *to, 89 RSA *rsa,int padding); 90 int (*rsa_mod_exp)(BIGNUM *r0,BIGNUM *I,RSA *rsa); /* Can be null */ 91 int (*bn_mod_exp)(BIGNUM *r, BIGNUM *a, const BIGNUM *p, 92 const BIGNUM *m, BN_CTX *ctx, 93 BN_MONT_CTX *m_ctx); /* Can be null */ 94 int (*init)(RSA *rsa); /* called at new */ 95 int (*finish)(RSA *rsa); /* called at free */ 96 int flags; /* RSA_METHOD_FLAG_* things */ 97 char *app_data; /* may be needed! */ 98/* New sign and verify functions: some libraries don't allow arbitrary data 99 * to be signed/verified: this allows them to be used. Note: for this to work 100 * the RSA_public_decrypt() and RSA_private_encrypt() should *NOT* be used 101 * RSA_sign(), RSA_verify() should be used instead. Note: for backwards 102 * compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER 103 * option is set in 'flags'. 104 */ 105 int (*rsa_sign)(int type, unsigned char *m, unsigned int m_len, 106 unsigned char *sigret, unsigned int *siglen, RSA *rsa); 107 int (*rsa_verify)(int dtype, unsigned char *m, unsigned int m_len, 108 unsigned char *sigbuf, unsigned int siglen, RSA *rsa); 109 110 } RSA_METHOD; 111 112struct rsa_st 113 { 114 /* The first parameter is used to pickup errors where 115 * this is passed instead of aEVP_PKEY, it is set to 0 */ 116 int pad; 117 int version; 118 RSA_METHOD *meth; 119 BIGNUM *n; 120 BIGNUM *e; 121 BIGNUM *d; 122 BIGNUM *p; 123 BIGNUM *q; 124 BIGNUM *dmp1; 125 BIGNUM *dmq1; 126 BIGNUM *iqmp; 127 /* be careful using this if the RSA structure is shared */ 128 CRYPTO_EX_DATA ex_data; 129 int references; 130 int flags; 131 132 /* Used to cache montgomery values */ 133 BN_MONT_CTX *_method_mod_n; 134 BN_MONT_CTX *_method_mod_p; 135 BN_MONT_CTX *_method_mod_q; 136 137 /* all BIGNUM values are actually in the following data, if it is not 138 * NULL */ 139 char *bignum_data; 140 BN_BLINDING *blinding; 141 }; 142 143#define RSA_3 0x3L 144#define RSA_F4 0x10001L 145 146#define RSA_METHOD_FLAG_NO_CHECK 0x01 /* don't check pub/private match */ 147 148#define RSA_FLAG_CACHE_PUBLIC 0x02 149#define RSA_FLAG_CACHE_PRIVATE 0x04 150#define RSA_FLAG_BLINDING 0x08 151#define RSA_FLAG_THREAD_SAFE 0x10 152/* This flag means the private key operations will be handled by rsa_mod_exp 153 * and that they do not depend on the private key components being present: 154 * for example a key stored in external hardware. Without this flag bn_mod_exp 155 * gets called when private key components are absent. 156 */ 157#define RSA_FLAG_EXT_PKEY 0x20 158 159/* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions. 160 */ 161#define RSA_FLAG_SIGN_VER 0x40 162 163#define RSA_PKCS1_PADDING 1 164#define RSA_SSLV23_PADDING 2 165#define RSA_NO_PADDING 3 166#define RSA_PKCS1_OAEP_PADDING 4 167 168#define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg) 169#define RSA_get_app_data(s) RSA_get_ex_data(s,0) 170 171RSA * RSA_new(void); 172RSA * RSA_new_method(RSA_METHOD *method); 173int RSA_size(RSA *); 174RSA * RSA_generate_key(int bits, unsigned long e,void 175 (*callback)(int,int,void *),void *cb_arg); 176int RSA_check_key(RSA *); 177 /* next 4 return -1 on error */ 178int RSA_public_encrypt(int flen, unsigned char *from, 179 unsigned char *to, RSA *rsa,int padding); 180int RSA_private_encrypt(int flen, unsigned char *from, 181 unsigned char *to, RSA *rsa,int padding); 182int RSA_public_decrypt(int flen, unsigned char *from, 183 unsigned char *to, RSA *rsa,int padding); 184int RSA_private_decrypt(int flen, unsigned char *from, 185 unsigned char *to, RSA *rsa,int padding); 186void RSA_free (RSA *r); 187 188int RSA_flags(RSA *r); 189 190void RSA_set_default_method(RSA_METHOD *meth); 191RSA_METHOD *RSA_get_default_method(void); 192RSA_METHOD *RSA_get_method(RSA *rsa); 193RSA_METHOD *RSA_set_method(RSA *rsa, RSA_METHOD *meth); 194 195/* This function needs the memory locking malloc callbacks to be installed */ 196int RSA_memory_lock(RSA *r); 197 198/* If you have RSAref compiled in. */ 199RSA_METHOD *RSA_PKCS1_RSAref(void); 200 201/* these are the actual SSLeay RSA functions */ 202RSA_METHOD *RSA_PKCS1_SSLeay(void); 203 204RSA_METHOD *RSA_null_method(void); 205 206void ERR_load_RSA_strings(void ); 207 208RSA * d2i_RSAPublicKey(RSA **a, unsigned char **pp, long length); 209int i2d_RSAPublicKey(RSA *a, unsigned char **pp); 210RSA * d2i_RSAPrivateKey(RSA **a, unsigned char **pp, long length); 211int i2d_RSAPrivateKey(RSA *a, unsigned char **pp); 212#ifndef NO_FP_API 213int RSA_print_fp(FILE *fp, RSA *r,int offset); 214#endif 215 216#ifndef NO_BIO 217int RSA_print(BIO *bp, RSA *r,int offset); 218#endif 219 220int i2d_RSA_NET(RSA *a, unsigned char **pp, int (*cb)(), int sgckey); 221RSA *d2i_RSA_NET(RSA **a, unsigned char **pp, long length, int (*cb)(), int sgckey); 222RSA *d2i_RSA_NET_2(RSA **a, unsigned char **pp, long length, int (*cb)(), int sgckey); 223 224int i2d_Netscape_RSA(RSA *a, unsigned char **pp, int (*cb)()); 225RSA *d2i_Netscape_RSA(RSA **a, unsigned char **pp, long length, int (*cb)()); 226/* Naughty internal function required elsewhere, to handle a MS structure 227 * that is the same as the netscape one :-) */ 228RSA *d2i_Netscape_RSA_2(RSA **a, unsigned char **pp, long length, int (*cb)()); 229 230/* The following 2 functions sign and verify a X509_SIG ASN1 object 231 * inside PKCS#1 padded RSA encryption */ 232int RSA_sign(int type, unsigned char *m, unsigned int m_len, 233 unsigned char *sigret, unsigned int *siglen, RSA *rsa); 234int RSA_verify(int type, unsigned char *m, unsigned int m_len, 235 unsigned char *sigbuf, unsigned int siglen, RSA *rsa); 236 237/* The following 2 function sign and verify a ASN1_OCTET_STRING 238 * object inside PKCS#1 padded RSA encryption */ 239int RSA_sign_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_len, 240 unsigned char *sigret, unsigned int *siglen, RSA *rsa); 241int RSA_verify_ASN1_OCTET_STRING(int type, unsigned char *m, unsigned int m_len, 242 unsigned char *sigbuf, unsigned int siglen, RSA *rsa); 243 244int RSA_blinding_on(RSA *rsa, BN_CTX *ctx); 245void RSA_blinding_off(RSA *rsa); 246 247int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen, 248 unsigned char *f,int fl); 249int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen, 250 unsigned char *f,int fl,int rsa_len); 251int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen, 252 unsigned char *f,int fl); 253int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen, 254 unsigned char *f,int fl,int rsa_len); 255int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen, 256 unsigned char *f,int fl,unsigned char *p, 257 int pl); 258int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen, 259 unsigned char *f,int fl,int rsa_len, 260 unsigned char *p,int pl); 261int RSA_padding_add_SSLv23(unsigned char *to,int tlen, 262 unsigned char *f,int fl); 263int RSA_padding_check_SSLv23(unsigned char *to,int tlen, 264 unsigned char *f,int fl,int rsa_len); 265int RSA_padding_add_none(unsigned char *to,int tlen, 266 unsigned char *f,int fl); 267int RSA_padding_check_none(unsigned char *to,int tlen, 268 unsigned char *f,int fl,int rsa_len); 269 270int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 271 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 272int RSA_set_ex_data(RSA *r,int idx,void *arg); 273void *RSA_get_ex_data(RSA *r, int idx); 274 275/* BEGIN ERROR CODES */ 276/* The following lines are auto generated by the script mkerr.pl. Any changes 277 * made after this point may be overwritten when the script is next run. 278 */ 279 280/* Error codes for the RSA functions. */ 281 282/* Function codes. */ 283#define RSA_F_MEMORY_LOCK 100 284#define RSA_F_RSA_CHECK_KEY 123 285#define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101 286#define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102 287#define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103 288#define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104 289#define RSA_F_RSA_GENERATE_KEY 105 290#define RSA_F_RSA_NEW_METHOD 106 291#define RSA_F_RSA_NULL 124 292#define RSA_F_RSA_PADDING_ADD_NONE 107 293#define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121 294#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108 295#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109 296#define RSA_F_RSA_PADDING_ADD_SSLV23 110 297#define RSA_F_RSA_PADDING_CHECK_NONE 111 298#define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122 299#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112 300#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113 301#define RSA_F_RSA_PADDING_CHECK_SSLV23 114 302#define RSA_F_RSA_PRINT 115 303#define RSA_F_RSA_PRINT_FP 116 304#define RSA_F_RSA_SIGN 117 305#define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118 306#define RSA_F_RSA_VERIFY 119 307#define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120 308 309/* Reason codes. */ 310#define RSA_R_ALGORITHM_MISMATCH 100 311#define RSA_R_BAD_E_VALUE 101 312#define RSA_R_BAD_FIXED_HEADER_DECRYPT 102 313#define RSA_R_BAD_PAD_BYTE_COUNT 103 314#define RSA_R_BAD_SIGNATURE 104 315#define RSA_R_BLOCK_TYPE_IS_NOT_01 106 316#define RSA_R_BLOCK_TYPE_IS_NOT_02 107 317#define RSA_R_DATA_GREATER_THAN_MOD_LEN 108 318#define RSA_R_DATA_TOO_LARGE 109 319#define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110 320#define RSA_R_DATA_TOO_SMALL 111 321#define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122 322#define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112 323#define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124 324#define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125 325#define RSA_R_D_E_NOT_CONGRUENT_TO_1 123 326#define RSA_R_INVALID_MESSAGE_LENGTH 131 327#define RSA_R_IQMP_NOT_INVERSE_OF_Q 126 328#define RSA_R_KEY_SIZE_TOO_SMALL 120 329#define RSA_R_NULL_BEFORE_BLOCK_MISSING 113 330#define RSA_R_N_DOES_NOT_EQUAL_P_Q 127 331#define RSA_R_OAEP_DECODING_ERROR 121 332#define RSA_R_PADDING_CHECK_FAILED 114 333#define RSA_R_P_NOT_PRIME 128 334#define RSA_R_Q_NOT_PRIME 129 335#define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130 336#define RSA_R_SSLV3_ROLLBACK_ATTACK 115 337#define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116 338#define RSA_R_UNKNOWN_ALGORITHM_TYPE 117 339#define RSA_R_UNKNOWN_PADDING_TYPE 118 340#define RSA_R_WRONG_SIGNATURE_LENGTH 119 341 342#ifdef __cplusplus 343} 344#endif 345#endif 346 347