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