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