crypto/bn/bn.h

   1 /* crypto/bn/bn.h */
   2 /* Copyright (C) 1995-1997 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  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  60  *
  61  * Portions of the attached software ("Contribution") are developed by
  62  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
  63  *
  64  * The Contribution is licensed pursuant to the Eric Young open source
  65  * license provided above.
  66  *
  67  * The binary polynomial arithmetic software is originally written by
  68  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
  69  *
  70  */
  71
  72 #ifndef HEADER_BN_H
  73 #define HEADER_BN_H
  74
  75 #include <openssl/e_os2.h>
  76 #ifndef OPENSSL_NO_FP_API
  77 #include <stdio.h> /* FILE */
  78 #endif
  79 #include <openssl/ossl_typ.h>
  80
  81 #ifdef  __cplusplus
  82 extern "C" {
  83 #endif
  84
  85 /* These preprocessor symbols control various aspects of the bignum headers and
  86  * library code. They're not defined by any "normal" configuration, as they are
  87  * intended for development and testing purposes. NB: defining all three can be
  88  * useful for debugging application code as well as openssl itself.
  89  *
  90  * BN_DEBUG - turn on various debugging alterations to the bignum code
  91  * BN_DEBUG_RAND - uses random poisoning of unused words to trip up
  92  * mismanagement of bignum internals. You must also define BN_DEBUG.
  93  */
  94 /* #define BN_DEBUG */
  95 /* #define BN_DEBUG_RAND */
  96
  97 #define BN_MUL_COMBA
  98 #define BN_SQR_COMBA
  99 #define BN_RECURSION
 100
 101 /* This next option uses the C libraries (2 word)/(1 word) function.
 102  * If it is not defined, I use my C version (which is slower).
 103  * The reason for this flag is that when the particular C compiler
 104  * library routine is used, and the library is linked with a different
 105  * compiler, the library is missing.  This mostly happens when the
 106  * library is built with gcc and then linked using normal cc.  This would
 107  * be a common occurrence because gcc normally produces code that is
 108  * 2 times faster than system compilers for the big number stuff.
 109  * For machines with only one compiler (or shared libraries), this should
 110  * be on.  Again this in only really a problem on machines
 111  * using "long long's", are 32bit, and are not using my assembler code. */
 112 #if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || \
 113     defined(OPENSSL_SYS_WIN32) || defined(linux)
 114 # ifndef BN_DIV2W
 115 #  define BN_DIV2W
 116 # endif
 117 #endif
 118
 119 /* assuming long is 64bit - this is the DEC Alpha
 120  * unsigned long long is only 64 bits :-(, don't define
 121  * BN_LLONG for the DEC Alpha */
 122 #ifdef SIXTY_FOUR_BIT_LONG
 123 #define BN_ULLONG       unsigned long long
 124 #define BN_ULONG        unsigned long
 125 #define BN_LONG         long
 126 #define BN_BITS         128
 127 #define BN_BYTES        8
 128 #define BN_BITS2        64
 129 #define BN_BITS4        32
 130 #define BN_MASK         (0xffffffffffffffffffffffffffffffffLL)
 131 #define BN_MASK2        (0xffffffffffffffffL)
 132 #define BN_MASK2l       (0xffffffffL)
 133 #define BN_MASK2h       (0xffffffff00000000L)
 134 #define BN_MASK2h1      (0xffffffff80000000L)
 135 #define BN_TBIT         (0x8000000000000000L)
 136 #define BN_DEC_CONV     (10000000000000000000UL)
 137 #define BN_DEC_FMT1     "%lu"
 138 #define BN_DEC_FMT2     "%019lu"
 139 #define BN_DEC_NUM      19
 140 #endif
 141
 142 /* This is where the long long data type is 64 bits, but long is 32.
 143  * For machines where there are 64bit registers, this is the mode to use.
 144  * IRIX, on R4000 and above should use this mode, along with the relevant
 145  * assembler code :-).  Do NOT define BN_LLONG.
 146  */
 147 #ifdef SIXTY_FOUR_BIT
 148 #undef BN_LLONG
 149 #undef BN_ULLONG
 150 #define BN_ULONG        unsigned long long
 151 #define BN_LONG         long long
 152 #define BN_BITS         128
 153 #define BN_BYTES        8
 154 #define BN_BITS2        64
 155 #define BN_BITS4        32
 156 #define BN_MASK2        (0xffffffffffffffffLL)
 157 #define BN_MASK2l       (0xffffffffL)
 158 #define BN_MASK2h       (0xffffffff00000000LL)
 159 #define BN_MASK2h1      (0xffffffff80000000LL)
 160 #define BN_TBIT         (0x8000000000000000LL)
 161 #define BN_DEC_CONV     (10000000000000000000ULL)
 162 #define BN_DEC_FMT1     "%llu"
 163 #define BN_DEC_FMT2     "%019llu"
 164 #define BN_DEC_NUM      19
 165 #endif
 166
 167 #ifdef THIRTY_TWO_BIT
 168 #ifdef BN_LLONG
 169 # if defined(OPENSSL_SYS_WIN32) && !defined(__GNUC__)
 170 #  define BN_ULLONG     unsigned _int64
 171 # else
 172 #  define BN_ULLONG     unsigned long long
 173 # endif
 174 #endif
 175 #define BN_ULONG        unsigned long
 176 #define BN_LONG         long
 177 #define BN_BITS         64
 178 #define BN_BYTES        4
 179 #define BN_BITS2        32
 180 #define BN_BITS4        16
 181 #ifdef OPENSSL_SYS_WIN32
 182 /* VC++ doesn't like the LL suffix */
 183 #define BN_MASK         (0xffffffffffffffffL)
 184 #else
 185 #define BN_MASK         (0xffffffffffffffffLL)
 186 #endif
 187 #define BN_MASK2        (0xffffffffL)
 188 #define BN_MASK2l       (0xffff)
 189 #define BN_MASK2h1      (0xffff8000L)
 190 #define BN_MASK2h       (0xffff0000L)
 191 #define BN_TBIT         (0x80000000L)
 192 #define BN_DEC_CONV     (1000000000L)
 193 #define BN_DEC_FMT1     "%lu"
 194 #define BN_DEC_FMT2     "%09lu"
 195 #define BN_DEC_NUM      9
 196 #endif
 197
 198 #ifdef SIXTEEN_BIT
 199 #ifndef BN_DIV2W
 200 #define BN_DIV2W
 201 #endif
 202 #define BN_ULLONG       unsigned long
 203 #define BN_ULONG        unsigned short
 204 #define BN_LONG         short
 205 #define BN_BITS         32
 206 #define BN_BYTES        2
 207 #define BN_BITS2        16
 208 #define BN_BITS4        8
 209 #define BN_MASK         (0xffffffff)
 210 #define BN_MASK2        (0xffff)
 211 #define BN_MASK2l       (0xff)
 212 #define BN_MASK2h1      (0xff80)
 213 #define BN_MASK2h       (0xff00)
 214 #define BN_TBIT         (0x8000)
 215 #define BN_DEC_CONV     (100000)
 216 #define BN_DEC_FMT1     "%u"
 217 #define BN_DEC_FMT2     "%05u"
 218 #define BN_DEC_NUM      5
 219 #endif
 220
 221 #ifdef EIGHT_BIT
 222 #ifndef BN_DIV2W
 223 #define BN_DIV2W
 224 #endif
 225 #define BN_ULLONG       unsigned short
 226 #define BN_ULONG        unsigned char
 227 #define BN_LONG         char
 228 #define BN_BITS         16
 229 #define BN_BYTES        1
 230 #define BN_BITS2        8
 231 #define BN_BITS4        4
 232 #define BN_MASK         (0xffff)
 233 #define BN_MASK2        (0xff)
 234 #define BN_MASK2l       (0xf)
 235 #define BN_MASK2h1      (0xf8)
 236 #define BN_MASK2h       (0xf0)
 237 #define BN_TBIT         (0x80)
 238 #define BN_DEC_CONV     (100)
 239 #define BN_DEC_FMT1     "%u"
 240 #define BN_DEC_FMT2     "%02u"
 241 #define BN_DEC_NUM      2
 242 #endif
 243
 244 #define BN_DEFAULT_BITS 1280
 245
 246 #define BN_FLG_MALLOCED         0x01
 247 #define BN_FLG_STATIC_DATA      0x02
 248 #define BN_FLG_EXP_CONSTTIME    0x04 /* avoid leaking exponent information through timings
 249                                       * (BN_mod_exp_mont() will call BN_mod_exp_mont_consttime) */
 250 #ifndef OPENSSL_NO_DEPRECATED
 251 #define BN_FLG_FREE             0x8000  /* used for debuging */
 252 #endif
 253 #define BN_set_flags(b,n)       ((b)->flags|=(n))
 254 #define BN_get_flags(b,n)       ((b)->flags&(n))
 255
 256 #define BN_with_flags(dest,b,n)  ((dest)->d=(b)->d, \
 257                                   (dest)->top=(b)->top, \
 258                                   (dest)->dmax=(b)->dmax, \
 259                                   (dest)->neg=(b)->neg, \
 260                                   (dest)->flags=(((dest)->flags & BN_FLG_MALLOCED) \
 261                                                  |  ((b)->flags & ~BN_FLG_MALLOCED) \
 262                                                  |  BN_FLG_STATIC_DATA \
 263                                                  |  (n)))
 264
 265 /* Already declared in ossl_typ.h */
 266 #if 0
 267 typedef struct bignum_st BIGNUM;
 268 /* Used for temp variables (declaration hidden in bn_lcl.h) */
 269 typedef struct bignum_ctx BN_CTX;
 270 typedef struct bn_blinding_st BN_BLINDING;
 271 typedef struct bn_mont_ctx_st BN_MONT_CTX;
 272 typedef struct bn_recp_ctx_st BN_RECP_CTX;
 273 typedef struct bn_gencb_st BN_GENCB;
 274 #endif
 275
 276 struct bignum_st
 277         {
 278         BN_ULONG *d;    /* Pointer to an array of 'BN_BITS2' bit chunks. */
 279         int top;        /* Index of last used d +1. */
 280         /* The next are internal book keeping for bn_expand. */
 281         int dmax;       /* Size of the d array. */
 282         int neg;        /* one if the number is negative */
 283         int flags;
 284         };
 285
 286 /* Used for montgomery multiplication */
 287 struct bn_mont_ctx_st
 288         {
 289         int ri;        /* number of bits in R */
 290         BIGNUM RR;     /* used to convert to montgomery form */
 291         BIGNUM N;      /* The modulus */
 292         BIGNUM Ni;     /* R*(1/R mod N) - N*Ni = 1
 293                         * (Ni is only stored for bignum algorithm) */
 294         BN_ULONG n0;   /* least significant word of Ni */
 295         int flags;
 296         };
 297
 298 /* Used for reciprocal division/mod functions
 299  * It cannot be shared between threads
 300  */
 301 struct bn_recp_ctx_st
 302         {
 303         BIGNUM N;       /* the divisor */
 304         BIGNUM Nr;      /* the reciprocal */
 305         int num_bits;
 306         int shift;
 307         int flags;
 308         };
 309
 310 /* Used for slow "generation" functions. */
 311 struct bn_gencb_st
 312         {
 313         unsigned int ver;       /* To handle binary (in)compatibility */
 314         void *arg;              /* callback-specific data */
 315         union
 316                 {
 317                 /* if(ver==1) - handles old style callbacks */
 318                 void (*cb_1)(int, int, void *);
 319                 /* if(ver==2) - new callback style */
 320                 int (*cb_2)(int, int, BN_GENCB *);
 321                 } cb;
 322         };
 323 /* Wrapper function to make using BN_GENCB easier,  */
 324 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
 325 /* Macro to populate a BN_GENCB structure with an "old"-style callback */
 326 #define BN_GENCB_set_old(gencb, callback, cb_arg) { \
 327                 BN_GENCB *tmp_gencb = (gencb); \
 328                 tmp_gencb->ver = 1; \
 329                 tmp_gencb->arg = (cb_arg); \
 330                 tmp_gencb->cb.cb_1 = (callback); }
 331 /* Macro to populate a BN_GENCB structure with a "new"-style callback */
 332 #define BN_GENCB_set(gencb, callback, cb_arg) { \
 333                 BN_GENCB *tmp_gencb = (gencb); \
 334                 tmp_gencb->ver = 2; \
 335                 tmp_gencb->arg = (cb_arg); \
 336                 tmp_gencb->cb.cb_2 = (callback); }
 337
 338 #define BN_prime_checks 0 /* default: select number of iterations
 339                              based on the size of the number */
 340
 341 /* number of Miller-Rabin iterations for an error rate  of less than 2^-80
 342  * for random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook
 343  * of Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
 344  * original paper: Damgaard, Landrock, Pomerance: Average case error estimates
 345  * for the strong probable prime test. -- Math. Comp. 61 (1993) 177-194) */
 346 #define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
 347                                 (b) >=  850 ?  3 : \
 348                                 (b) >=  650 ?  4 : \
 349                                 (b) >=  550 ?  5 : \
 350                                 (b) >=  450 ?  6 : \
 351                                 (b) >=  400 ?  7 : \
 352                                 (b) >=  350 ?  8 : \
 353                                 (b) >=  300 ?  9 : \
 354                                 (b) >=  250 ? 12 : \
 355                                 (b) >=  200 ? 15 : \
 356                                 (b) >=  150 ? 18 : \
 357                                 /* b >= 100 */ 27)
 358
 359 #define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
 360
 361 /* Note that BN_abs_is_word didn't work reliably for w == 0 until 0.9.8 */
 362 #define BN_abs_is_word(a,w) ((((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w))) || \
 363                                 (((w) == 0) && ((a)->top == 0)))
 364 #define BN_is_zero(a)       ((a)->top == 0)
 365 #define BN_is_one(a)        (BN_abs_is_word((a),1) && !(a)->neg)
 366 #define BN_is_word(a,w)     (BN_abs_is_word((a),(w)) && (!(w) || !(a)->neg))
 367 #define BN_is_odd(a)        (((a)->top > 0) && ((a)->d[0] & 1))
 368
 369 #define BN_one(a)       (BN_set_word((a),1))
 370 #define BN_zero_ex(a) \
 371         do { \
 372                 BIGNUM *_tmp_bn = (a); \
 373                 _tmp_bn->top = 0; \
 374                 _tmp_bn->neg = 0; \
 375         } while(0)
 376 #ifdef OPENSSL_NO_DEPRECATED
 377 #define BN_zero(a)      BN_zero_ex(a)
 378 #else
 379 #define BN_zero(a)      (BN_set_word((a),0))
 380 #endif
 381
 382 const BIGNUM *BN_value_one(void);
 383 char *  BN_options(void);
 384 BN_CTX *BN_CTX_new(void);
 385 #ifndef OPENSSL_NO_DEPRECATED
 386 void    BN_CTX_init(BN_CTX *c);
 387 #endif
 388 void    BN_CTX_free(BN_CTX *c);
 389 void    BN_CTX_start(BN_CTX *ctx);
 390 BIGNUM *BN_CTX_get(BN_CTX *ctx);
 391 void    BN_CTX_end(BN_CTX *ctx);
 392 int     BN_rand(BIGNUM *rnd, int bits, int top,int bottom);
 393 int     BN_pseudo_rand(BIGNUM *rnd, int bits, int top,int bottom);
 394 int     BN_rand_range(BIGNUM *rnd, BIGNUM *range);
 395 int     BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
 396 int     BN_num_bits(const BIGNUM *a);
 397 int     BN_num_bits_word(BN_ULONG);
 398 BIGNUM *BN_new(void);
 399 void    BN_init(BIGNUM *);
 400 void    BN_clear_free(BIGNUM *a);
 401 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
 402 void    BN_swap(BIGNUM *a, BIGNUM *b);
 403 BIGNUM *BN_bin2bn(const unsigned char *s,int len,BIGNUM *ret);
 404 int     BN_bn2bin(const BIGNUM *a, unsigned char *to);
 405 BIGNUM *BN_mpi2bn(const unsigned char *s,int len,BIGNUM *ret);
 406 int     BN_bn2mpi(const BIGNUM *a, unsigned char *to);
 407 int     BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 408 int     BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 409 int     BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 410 int     BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 411 int     BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
 412 int     BN_sqr(BIGNUM *r, const BIGNUM *a,BN_CTX *ctx);
 413 /* BN_set_negative(): sets sign of a bignum */
 414 void    BN_set_negative(BIGNUM *b, int n);
 415 /* BN_get_negative():  returns 1 if the bignum is < 0 and 0 otherwise */
 416 #define BN_is_negative(a) ((a)->neg != 0)
 417
 418 int     BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
 419         BN_CTX *ctx);
 420 #define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
 421 int     BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
 422 int     BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
 423 int     BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
 424 int     BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
 425 int     BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
 426 int     BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 427         const BIGNUM *m, BN_CTX *ctx);
 428 int     BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
 429 int     BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
 430 int     BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
 431 int     BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m, BN_CTX *ctx);
 432 int     BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
 433
 434 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
 435 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
 436 int     BN_mul_word(BIGNUM *a, BN_ULONG w);
 437 int     BN_add_word(BIGNUM *a, BN_ULONG w);
 438 int     BN_sub_word(BIGNUM *a, BN_ULONG w);
 439 int     BN_set_word(BIGNUM *a, BN_ULONG w);
 440 BN_ULONG BN_get_word(const BIGNUM *a);
 441
 442 int     BN_cmp(const BIGNUM *a, const BIGNUM *b);
 443 void    BN_free(BIGNUM *a);
 444 int     BN_is_bit_set(const BIGNUM *a, int n);
 445 int     BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
 446 int     BN_lshift1(BIGNUM *r, const BIGNUM *a);
 447 int     BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,BN_CTX *ctx);
 448
 449 int     BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 450         const BIGNUM *m,BN_CTX *ctx);
 451 int     BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 452         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 453 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
 454         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont);
 455 int     BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
 456         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 457 int     BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
 458         const BIGNUM *a2, const BIGNUM *p2,const BIGNUM *m,
 459         BN_CTX *ctx,BN_MONT_CTX *m_ctx);
 460 int     BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 461         const BIGNUM *m,BN_CTX *ctx);
 462
 463 int     BN_mask_bits(BIGNUM *a,int n);
 464 #ifndef OPENSSL_NO_FP_API
 465 int     BN_print_fp(FILE *fp, const BIGNUM *a);
 466 #endif
 467 #ifdef HEADER_BIO_H
 468 int     BN_print(BIO *fp, const BIGNUM *a);
 469 #else
 470 int     BN_print(void *fp, const BIGNUM *a);
 471 #endif
 472 int     BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
 473 int     BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
 474 int     BN_rshift1(BIGNUM *r, const BIGNUM *a);
 475 void    BN_clear(BIGNUM *a);
 476 BIGNUM *BN_dup(const BIGNUM *a);
 477 int     BN_ucmp(const BIGNUM *a, const BIGNUM *b);
 478 int     BN_set_bit(BIGNUM *a, int n);
 479 int     BN_clear_bit(BIGNUM *a, int n);
 480 char *  BN_bn2hex(const BIGNUM *a);
 481 char *  BN_bn2dec(const BIGNUM *a);
 482 int     BN_hex2bn(BIGNUM **a, const char *str);
 483 int     BN_dec2bn(BIGNUM **a, const char *str);
 484 int     BN_gcd(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx);
 485 int     BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */
 486 BIGNUM *BN_mod_inverse(BIGNUM *ret,
 487         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
 488 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
 489         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
 490
 491 /* Deprecated versions */
 492 #ifndef OPENSSL_NO_DEPRECATED
 493 BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe,
 494         const BIGNUM *add, const BIGNUM *rem,
 495         void (*callback)(int,int,void *),void *cb_arg);
 496 int     BN_is_prime(const BIGNUM *p,int nchecks,
 497         void (*callback)(int,int,void *),
 498         BN_CTX *ctx,void *cb_arg);
 499 int     BN_is_prime_fasttest(const BIGNUM *p,int nchecks,
 500         void (*callback)(int,int,void *),BN_CTX *ctx,void *cb_arg,
 501         int do_trial_division);
 502 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
 503
 504 /* Newer versions */
 505 int     BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add,
 506                 const BIGNUM *rem, BN_GENCB *cb);
 507 int     BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb);
 508 int     BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx,
 509                 int do_trial_division, BN_GENCB *cb);
 510
 511 BN_MONT_CTX *BN_MONT_CTX_new(void );
 512 void BN_MONT_CTX_init(BN_MONT_CTX *ctx);
 513 int BN_mod_mul_montgomery(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,
 514         BN_MONT_CTX *mont, BN_CTX *ctx);
 515 #define BN_to_montgomery(r,a,mont,ctx)  BN_mod_mul_montgomery(\
 516         (r),(a),&((mont)->RR),(mont),(ctx))
 517 int BN_from_montgomery(BIGNUM *r,const BIGNUM *a,
 518         BN_MONT_CTX *mont, BN_CTX *ctx);
 519 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
 520 int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *mod,BN_CTX *ctx);
 521 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from);
 522 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
 523                                         const BIGNUM *mod, BN_CTX *ctx);
 524
 525 /* BN_BLINDING flags */
 526 #define BN_BLINDING_NO_UPDATE   0x00000001
 527 #define BN_BLINDING_NO_RECREATE 0x00000002
 528
 529 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
 530 void BN_BLINDING_free(BN_BLINDING *b);
 531 int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
 532 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 533 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 534 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
 535 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *);
 536 unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
 537 void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
 538 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
 539 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
 540 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
 541         const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
 542         int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 543                           const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
 544         BN_MONT_CTX *m_ctx);
 545
 546 #ifndef OPENSSL_NO_DEPRECATED
 547 void BN_set_params(int mul,int high,int low,int mont);
 548 int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */
 549 #endif
 550
 551 void    BN_RECP_CTX_init(BN_RECP_CTX *recp);
 552 BN_RECP_CTX *BN_RECP_CTX_new(void);
 553 void    BN_RECP_CTX_free(BN_RECP_CTX *recp);
 554 int     BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx);
 555 int     BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
 556         BN_RECP_CTX *recp,BN_CTX *ctx);
 557 int     BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 558         const BIGNUM *m, BN_CTX *ctx);
 559 int     BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
 560         BN_RECP_CTX *recp, BN_CTX *ctx);
 561
 562 /* Functions for arithmetic over binary polynomials represented by BIGNUMs.
 563  *
 564  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
 565  * ignored.
 566  *
 567  * Note that input arguments are not const so that their bit arrays can
 568  * be expanded to the appropriate size if needed.
 569  */
 570
 571 int     BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); /*r = a + b*/
 572 #define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
 573 int     BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p); /*r=a mod p*/
 574 int     BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 575         const BIGNUM *p, BN_CTX *ctx); /* r = (a * b) mod p */
 576 int     BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 577         BN_CTX *ctx); /* r = (a * a) mod p */
 578 int     BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p,
 579         BN_CTX *ctx); /* r = (1 / b) mod p */
 580 int     BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 581         const BIGNUM *p, BN_CTX *ctx); /* r = (a / b) mod p */
 582 int     BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 583         const BIGNUM *p, BN_CTX *ctx); /* r = (a ^ b) mod p */
 584 int     BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 585         BN_CTX *ctx); /* r = sqrt(a) mod p */
 586 int     BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 587         BN_CTX *ctx); /* r^2 + r = a mod p */
 588 #define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
 589 /* Some functions allow for representation of the irreducible polynomials
 590  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
 591  *     t^p[0] + t^p[1] + ... + t^p[k]
 592  * where m = p[0] > p[1] > ... > p[k] = 0.
 593  */
 594 int     BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[]);
 595         /* r = a mod p */
 596 int     BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 597         const unsigned int p[], BN_CTX *ctx); /* r = (a * b) mod p */
 598 int     BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[],
 599         BN_CTX *ctx); /* r = (a * a) mod p */
 600 int     BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const unsigned int p[],
 601         BN_CTX *ctx); /* r = (1 / b) mod p */
 602 int     BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 603         const unsigned int p[], BN_CTX *ctx); /* r = (a / b) mod p */
 604 int     BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 605         const unsigned int p[], BN_CTX *ctx); /* r = (a ^ b) mod p */
 606 int     BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
 607         const unsigned int p[], BN_CTX *ctx); /* r = sqrt(a) mod p */
 608 int     BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
 609         const unsigned int p[], BN_CTX *ctx); /* r^2 + r = a mod p */
 610 int     BN_GF2m_poly2arr(const BIGNUM *a, unsigned int p[], int max);
 611 int     BN_GF2m_arr2poly(const unsigned int p[], BIGNUM *a);
 612
 613 /* faster mod functions for the 'NIST primes'
 614  * 0 <= a < p^2 */
 615 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 616 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 617 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 618 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 619 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 620
 621 const BIGNUM *BN_get0_nist_prime_192(void);
 622 const BIGNUM *BN_get0_nist_prime_224(void);
 623 const BIGNUM *BN_get0_nist_prime_256(void);
 624 const BIGNUM *BN_get0_nist_prime_384(void);
 625 const BIGNUM *BN_get0_nist_prime_521(void);
 626
 627 /* library internal functions */
 628
 629 #define bn_expand(a,bits) ((((((bits+BN_BITS2-1))/BN_BITS2)) <= (a)->dmax)?\
 630         (a):bn_expand2((a),(bits+BN_BITS2-1)/BN_BITS2))
 631 #define bn_wexpand(a,words) (((words) <= (a)->dmax)?(a):bn_expand2((a),(words)))
 632 BIGNUM *bn_expand2(BIGNUM *a, int words);
 633 #ifndef OPENSSL_NO_DEPRECATED
 634 BIGNUM *bn_dup_expand(const BIGNUM *a, int words); /* unused */
 635 #endif
 636
 637 /* Bignum consistency macros
 638  * There is one "API" macro, bn_fix_top(), for stripping leading zeroes from
 639  * bignum data after direct manipulations on the data. There is also an
 640  * "internal" macro, bn_check_top(), for verifying that there are no leading
 641  * zeroes. Unfortunately, some auditing is required due to the fact that
 642  * bn_fix_top() has become an overabused duct-tape because bignum data is
 643  * occasionally passed around in an inconsistent state. So the following
 644  * changes have been made to sort this out;
 645  * - bn_fix_top()s implementation has been moved to bn_correct_top()
 646  * - if BN_DEBUG isn't defined, bn_fix_top() maps to bn_correct_top(), and
 647  *   bn_check_top() is as before.
 648  * - if BN_DEBUG *is* defined;
 649  *   - bn_check_top() tries to pollute unused words even if the bignum 'top' is
 650  *     consistent. (ed: only if BN_DEBUG_RAND is defined)
 651  *   - bn_fix_top() maps to bn_check_top() rather than "fixing" anything.
 652  * The idea is to have debug builds flag up inconsistent bignums when they
 653  * occur. If that occurs in a bn_fix_top(), we examine the code in question; if
 654  * the use of bn_fix_top() was appropriate (ie. it follows directly after code
 655  * that manipulates the bignum) it is converted to bn_correct_top(), and if it
 656  * was not appropriate, we convert it permanently to bn_check_top() and track
 657  * down the cause of the bug. Eventually, no internal code should be using the
 658  * bn_fix_top() macro. External applications and libraries should try this with
 659  * their own code too, both in terms of building against the openssl headers
 660  * with BN_DEBUG defined *and* linking with a version of OpenSSL built with it
 661  * defined. This not only improves external code, it provides more test
 662  * coverage for openssl's own code.
 663  */
 664
 665 #ifdef BN_DEBUG
 666
 667 /* We only need assert() when debugging */
 668 #include <assert.h>
 669
 670 #ifdef BN_DEBUG_RAND
 671 /* To avoid "make update" cvs wars due to BN_DEBUG, use some tricks */
 672 #ifndef RAND_pseudo_bytes
 673 int RAND_pseudo_bytes(unsigned char *buf,int num);
 674 #define BN_DEBUG_TRIX
 675 #endif
 676 #define bn_pollute(a) \
 677         do { \
 678                 const BIGNUM *_bnum1 = (a); \
 679                 if(_bnum1->top < _bnum1->dmax) { \
 680                         unsigned char _tmp_char; \
 681                         /* We cast away const without the compiler knowing, any \
 682                          * *genuinely* constant variables that aren't mutable \
 683                          * wouldn't be constructed with top!=dmax. */ \
 684                         BN_ULONG *_not_const; \
 685                         memcpy(&_not_const, &_bnum1->d, sizeof(BN_ULONG*)); \
 686                         RAND_pseudo_bytes(&_tmp_char, 1); \
 687                         memset((unsigned char *)(_not_const + _bnum1->top), _tmp_char, \
 688                                 (_bnum1->dmax - _bnum1->top) * sizeof(BN_ULONG)); \
 689                 } \
 690         } while(0)
 691 #ifdef BN_DEBUG_TRIX
 692 #undef RAND_pseudo_bytes
 693 #endif
 694 #else
 695 #define bn_pollute(a)
 696 #endif
 697 #define bn_check_top(a) \
 698         do { \
 699                 const BIGNUM *_bnum2 = (a); \
 700                 assert((_bnum2->top == 0) || \
 701                                 (_bnum2->d[_bnum2->top - 1] != 0)); \
 702                 bn_pollute(_bnum2); \
 703         } while(0)
 704
 705 #define bn_fix_top(a)           bn_check_top(a)
 706
 707 #else /* !BN_DEBUG */
 708
 709 #define bn_pollute(a)
 710 #define bn_check_top(a)
 711 #define bn_fix_top(a)           bn_correct_top(a)
 712
 713 #endif
 714
 715 #define bn_correct_top(a) \
 716         { \
 717         BN_ULONG *ftl; \
 718         if ((a)->top > 0) \
 719                 { \
 720                 for (ftl= &((a)->d[(a)->top-1]); (a)->top > 0; (a)->top--) \
 721                 if (*(ftl--)) break; \
 722                 } \
 723         bn_pollute(a); \
 724         }
 725
 726 BN_ULONG bn_mul_add_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
 727 BN_ULONG bn_mul_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
 728 void     bn_sqr_words(BN_ULONG *rp, const BN_ULONG *ap, int num);
 729 BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d);
 730 BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
 731 BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
 732
 733 int BN_bntest_rand(BIGNUM *rnd, int bits, int top,int bottom);
 734
 735 /* BEGIN ERROR CODES */
 736 /* The following lines are auto generated by the script mkerr.pl. Any changes
 737  * made after this point may be overwritten when the script is next run.
 738  */
 739 void ERR_load_BN_strings(void);
 740
 741 /* Error codes for the BN functions. */
 742
 743 /* Function codes. */
 744 #define BN_F_BNRAND                                      127
 745 #define BN_F_BN_BLINDING_CONVERT_EX                      100
 746 #define BN_F_BN_BLINDING_CREATE_PARAM                    128
 747 #define BN_F_BN_BLINDING_INVERT_EX                       101
 748 #define BN_F_BN_BLINDING_NEW                             102
 749 #define BN_F_BN_BLINDING_UPDATE                          103
 750 #define BN_F_BN_BN2DEC                                   104
 751 #define BN_F_BN_BN2HEX                                   105
 752 #define BN_F_BN_CTX_GET                                  116
 753 #define BN_F_BN_CTX_NEW                                  106
 754 #define BN_F_BN_CTX_START                                129
 755 #define BN_F_BN_DIV                                      107
 756 #define BN_F_BN_DIV_RECP                                 130
 757 #define BN_F_BN_EXP                                      123
 758 #define BN_F_BN_EXPAND2                                  108
 759 #define BN_F_BN_EXPAND_INTERNAL                          120
 760 #define BN_F_BN_GF2M_MOD                                 131
 761 #define BN_F_BN_GF2M_MOD_EXP                             132
 762 #define BN_F_BN_GF2M_MOD_MUL                             133
 763 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD                      134
 764 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                  135
 765 #define BN_F_BN_GF2M_MOD_SQR                             136
 766 #define BN_F_BN_GF2M_MOD_SQRT                            137
 767 #define BN_F_BN_MOD_EXP2_MONT                            118
 768 #define BN_F_BN_MOD_EXP_MONT                             109
 769 #define BN_F_BN_MOD_EXP_MONT_CONSTTIME                   124
 770 #define BN_F_BN_MOD_EXP_MONT_WORD                        117
 771 #define BN_F_BN_MOD_EXP_RECP                             125
 772 #define BN_F_BN_MOD_EXP_SIMPLE                           126
 773 #define BN_F_BN_MOD_INVERSE                              110
 774 #define BN_F_BN_MOD_LSHIFT_QUICK                         119
 775 #define BN_F_BN_MOD_MUL_RECIPROCAL                       111
 776 #define BN_F_BN_MOD_SQRT                                 121
 777 #define BN_F_BN_MPI2BN                                   112
 778 #define BN_F_BN_NEW                                      113
 779 #define BN_F_BN_RAND                                     114
 780 #define BN_F_BN_RAND_RANGE                               122
 781 #define BN_F_BN_USUB                                     115
 782
 783 /* Reason codes. */
 784 #define BN_R_ARG2_LT_ARG3                                100
 785 #define BN_R_BAD_RECIPROCAL                              101
 786 #define BN_R_BIGNUM_TOO_LONG                             114
 787 #define BN_R_CALLED_WITH_EVEN_MODULUS                    102
 788 #define BN_R_DIV_BY_ZERO                                 103
 789 #define BN_R_ENCODING_ERROR                              104
 790 #define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA                105
 791 #define BN_R_INPUT_NOT_REDUCED                           110
 792 #define BN_R_INVALID_LENGTH                              106
 793 #define BN_R_INVALID_RANGE                               115
 794 #define BN_R_NOT_A_SQUARE                                111
 795 #define BN_R_NOT_INITIALIZED                             107
 796 #define BN_R_NO_INVERSE                                  108
 797 #define BN_R_NO_SOLUTION                                 116
 798 #define BN_R_P_IS_NOT_PRIME                              112
 799 #define BN_R_TOO_MANY_ITERATIONS                         113
 800 #define BN_R_TOO_MANY_TEMPORARY_VARIABLES                109
 801
 802 #ifdef  __cplusplus
 803 }
 804 #endif
 805 #endif