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