AppleCSP/open_ssl/openssl/rsa.h

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