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