include/openssl/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 (c) 1998-2006 The OpenSSL Project.  All rights reserved.
  60  *
  61  * Redistribution and use in source and binary forms, with or without
  62  * modification, are permitted provided that the following conditions
  63  * are met:
  64  *
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  *
  68  * 2. Redistributions in binary form must reproduce the above copyright
  69  *    notice, this list of conditions and the following disclaimer in
  70  *    the documentation and/or other materials provided with the
  71  *    distribution.
  72  *
  73  * 3. All advertising materials mentioning features or use of this
  74  *    software must display the following acknowledgment:
  75  *    "This product includes software developed by the OpenSSL Project
  76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77  *
  78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79  *    endorse or promote products derived from this software without
  80  *    prior written permission. For written permission, please contact
  81  *    openssl-core@openssl.org.
  82  *
  83  * 5. Products derived from this software may not be called "OpenSSL"
  84  *    nor may "OpenSSL" appear in their names without prior written
  85  *    permission of the OpenSSL Project.
  86  *
  87  * 6. Redistributions of any form whatsoever must retain the following
  88  *    acknowledgment:
  89  *    "This product includes software developed by the OpenSSL Project
  90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91  *
  92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 103  * OF THE POSSIBILITY OF SUCH DAMAGE.
 104  * ====================================================================
 105  *
 106  * This product includes cryptographic software written by Eric Young
 107  * (eay@cryptsoft.com).  This product includes software written by Tim
 108  * Hudson (tjh@cryptsoft.com).
 109  *
 110  */
 111 /* ====================================================================
 112  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
 113  *
 114  * Portions of the attached software ("Contribution") are developed by
 115  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
 116  *
 117  * The Contribution is licensed pursuant to the Eric Young open source
 118  * license provided above.
 119  *
 120  * The binary polynomial arithmetic software is originally written by
 121  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
 122  *
 123  */
 124
 125 #ifndef HEADER_BN_H
 126 # define HEADER_BN_H
 127
 128 # include <openssl/e_os2.h>
 129 # ifndef OPENSSL_NO_STDIO
 130 #  include <stdio.h>            /* FILE */
 131 # endif
 132 # include <openssl/ossl_typ.h>
 133 # include <openssl/crypto.h>
 134
 135 #ifdef  __cplusplus
 136 extern "C" {
 137 #endif
 138
 139 /*
 140  * These preprocessor symbols control various aspects of the bignum headers
 141  * and library code. They're not defined by any "normal" configuration, as
 142  * they are intended for development and testing purposes. NB: defining all
 143  * three can be useful for debugging application code as well as openssl
 144  * itself. BN_DEBUG - turn on various debugging alterations to the bignum
 145  * code BN_DEBUG_RAND - uses random poisoning of unused words to trip up
 146  * mismanagement of bignum internals. You must also define BN_DEBUG.
 147  */
 148 /* #define BN_DEBUG */
 149 /* #define BN_DEBUG_RAND */
 150
 151 # ifndef OPENSSL_SMALL_FOOTPRINT
 152 #  define BN_MUL_COMBA
 153 #  define BN_SQR_COMBA
 154 #  define BN_RECURSION
 155 # endif
 156
 157 /*
 158  * This next option uses the C libraries (2 word)/(1 word) function. If it is
 159  * not defined, I use my C version (which is slower). The reason for this
 160  * flag is that when the particular C compiler library routine is used, and
 161  * the library is linked with a different compiler, the library is missing.
 162  * This mostly happens when the library is built with gcc and then linked
 163  * using normal cc.  This would be a common occurrence because gcc normally
 164  * produces code that is 2 times faster than system compilers for the big
 165  * number stuff. For machines with only one compiler (or shared libraries),
 166  * this should be on.  Again this in only really a problem on machines using
 167  * "long long's", are 32bit, and are not using my assembler code.
 168  */
 169 # if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || \
 170     defined(OPENSSL_SYS_WIN32) || defined(linux)
 171 #  ifndef BN_DIV2W
 172 #   define BN_DIV2W
 173 #  endif
 174 # endif
 175
 176 /*
 177  * assuming long is 64bit - this is the DEC Alpha unsigned long long is only
 178  * 64 bits :-(, don't define BN_LLONG for the DEC Alpha
 179  */
 180 # ifdef SIXTY_FOUR_BIT_LONG
 181 #  define BN_ULLONG       unsigned long long
 182 #  define BN_ULONG        unsigned long
 183 #  define BN_LONG         long
 184 #  define BN_BITS         128
 185 #  define BN_BYTES        8
 186 #  define BN_BITS2        64
 187 #  define BN_BITS4        32
 188 #  define BN_MASK         (0xffffffffffffffffffffffffffffffffLL)
 189 #  define BN_MASK2        (0xffffffffffffffffL)
 190 #  define BN_MASK2l       (0xffffffffL)
 191 #  define BN_MASK2h       (0xffffffff00000000L)
 192 #  define BN_MASK2h1      (0xffffffff80000000L)
 193 #  define BN_TBIT         (0x8000000000000000L)
 194 #  define BN_DEC_CONV     (10000000000000000000UL)
 195 #  define BN_DEC_FMT1     "%lu"
 196 #  define BN_DEC_FMT2     "%019lu"
 197 #  define BN_DEC_NUM      19
 198 #  define BN_HEX_FMT1     "%lX"
 199 #  define BN_HEX_FMT2     "%016lX"
 200 # endif
 201
 202 /*
 203  * This is where the long long data type is 64 bits, but long is 32. For
 204  * machines where there are 64bit registers, this is the mode to use. IRIX,
 205  * on R4000 and above should use this mode, along with the relevant assembler
 206  * code :-).  Do NOT define BN_LLONG.
 207  */
 208 # ifdef SIXTY_FOUR_BIT
 209 #  undef BN_LLONG
 210 #  undef BN_ULLONG
 211 #  define BN_ULONG        unsigned long long
 212 #  define BN_LONG         long long
 213 #  define BN_BITS         128
 214 #  define BN_BYTES        8
 215 #  define BN_BITS2        64
 216 #  define BN_BITS4        32
 217 #  define BN_MASK2        (0xffffffffffffffffLL)
 218 #  define BN_MASK2l       (0xffffffffL)
 219 #  define BN_MASK2h       (0xffffffff00000000LL)
 220 #  define BN_MASK2h1      (0xffffffff80000000LL)
 221 #  define BN_TBIT         (0x8000000000000000LL)
 222 #  define BN_DEC_CONV     (10000000000000000000ULL)
 223 #  define BN_DEC_FMT1     "%llu"
 224 #  define BN_DEC_FMT2     "%019llu"
 225 #  define BN_DEC_NUM      19
 226 #  define BN_HEX_FMT1     "%llX"
 227 #  define BN_HEX_FMT2     "%016llX"
 228 # endif
 229
 230 # ifdef THIRTY_TWO_BIT
 231 #  ifdef BN_LLONG
 232 #   if defined(_WIN32) && !defined(__GNUC__)
 233 #    define BN_ULLONG     unsigned __int64
 234 #    define BN_MASK       (0xffffffffffffffffI64)
 235 #   else
 236 #    define BN_ULLONG     unsigned long long
 237 #    define BN_MASK       (0xffffffffffffffffLL)
 238 #   endif
 239 #  endif
 240 #  define BN_ULONG        unsigned int
 241 #  define BN_LONG         int
 242 #  define BN_BITS         64
 243 #  define BN_BYTES        4
 244 #  define BN_BITS2        32
 245 #  define BN_BITS4        16
 246 #  define BN_MASK2        (0xffffffffL)
 247 #  define BN_MASK2l       (0xffff)
 248 #  define BN_MASK2h1      (0xffff8000L)
 249 #  define BN_MASK2h       (0xffff0000L)
 250 #  define BN_TBIT         (0x80000000L)
 251 #  define BN_DEC_CONV     (1000000000L)
 252 #  define BN_DEC_FMT1     "%u"
 253 #  define BN_DEC_FMT2     "%09u"
 254 #  define BN_DEC_NUM      9
 255 #  define BN_HEX_FMT1     "%X"
 256 #  define BN_HEX_FMT2     "%08X"
 257 # endif
 258
 259 # define BN_DEFAULT_BITS 1280
 260
 261 # define BN_FLG_MALLOCED         0x01
 262 # define BN_FLG_STATIC_DATA      0x02
 263
 264 /*
 265  * avoid leaking exponent information through timing,
 266  * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
 267  * BN_div() will call BN_div_no_branch,
 268  * BN_mod_inverse() will call BN_mod_inverse_no_branch.
 269  */
 270 # define BN_FLG_CONSTTIME        0x04
 271
 272 # ifdef OPENSSL_USE_DEPRECATED
 273 /* deprecated name for the flag */
 274 #  define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME
 275 /*
 276  * avoid leaking exponent information through timings
 277  * (BN_mod_exp_mont() will call BN_mod_exp_mont_consttime)
 278  */
 279 # endif
 280
 281 # ifdef OPENSSL_USE_DEPRECATED
 282 #  define BN_FLG_FREE             0x8000
 283                                        /* used for debuging */
 284 # endif
 285
 286 void BN_set_flags(BIGNUM *b, int n);
 287 int BN_get_flags(const BIGNUM *b, int n);
 288
 289 /*
 290  * get a clone of a BIGNUM with changed flags, for *temporary* use only (the
 291  * two BIGNUMs cannot not be used in parallel!)
 292  */
 293 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int n);
 294
 295 /* Wrapper function to make using BN_GENCB easier,  */
 296 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
 297
 298 BN_GENCB *BN_GENCB_new(void);
 299 void BN_GENCB_free(BN_GENCB *cb);
 300
 301 /* Populate a BN_GENCB structure with an "old"-style callback */
 302 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
 303                       void *cb_arg);
 304
 305 /* Populate a BN_GENCB structure with a "new"-style callback */
 306 void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
 307                   void *cb_arg);
 308
 309 void *BN_GENCB_get_arg(BN_GENCB *cb);
 310
 311 # define BN_prime_checks 0      /* default: select number of iterations based
 312                                  * on the size of the number */
 313
 314 /*
 315  * number of Miller-Rabin iterations for an error rate of less than 2^-80 for
 316  * random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook of
 317  * Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
 318  * original paper: Damgaard, Landrock, Pomerance: Average case error
 319  * estimates for the strong probable prime test. -- Math. Comp. 61 (1993)
 320  * 177-194)
 321  */
 322 # define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
 323                                 (b) >=  850 ?  3 : \
 324                                 (b) >=  650 ?  4 : \
 325                                 (b) >=  550 ?  5 : \
 326                                 (b) >=  450 ?  6 : \
 327                                 (b) >=  400 ?  7 : \
 328                                 (b) >=  350 ?  8 : \
 329                                 (b) >=  300 ?  9 : \
 330                                 (b) >=  250 ? 12 : \
 331                                 (b) >=  200 ? 15 : \
 332                                 (b) >=  150 ? 18 : \
 333                                 /* b >= 100 */ 27)
 334
 335 # define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
 336
 337 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
 338 int BN_is_zero(const BIGNUM *a);
 339 int BN_is_one(const BIGNUM *a);
 340 int BN_is_word(const BIGNUM *a, const BN_ULONG w);
 341 int BN_is_odd(const BIGNUM *a);
 342
 343 # define BN_one(a)       (BN_set_word((a),1))
 344
 345 void BN_zero_ex(BIGNUM *a);
 346
 347 # ifndef OPENSSL_USE_DEPRECATED
 348 #  define BN_zero(a)      BN_zero_ex(a)
 349 # else
 350 #  define BN_zero(a)      (BN_set_word((a),0))
 351 # endif
 352
 353 const BIGNUM *BN_value_one(void);
 354 char *BN_options(void);
 355 BN_CTX *BN_CTX_new(void);
 356 void BN_CTX_free(BN_CTX *c);
 357 void BN_CTX_start(BN_CTX *ctx);
 358 BIGNUM *BN_CTX_get(BN_CTX *ctx);
 359 void BN_CTX_end(BN_CTX *ctx);
 360 int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
 361 int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
 362 int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
 363 int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
 364 int BN_num_bits(const BIGNUM *a);
 365 int BN_num_bits_word(BN_ULONG l);
 366 int BN_security_bits(int L, int N);
 367 BIGNUM *BN_new(void);
 368 void BN_clear_free(BIGNUM *a);
 369 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
 370 void BN_swap(BIGNUM *a, BIGNUM *b);
 371 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
 372 int BN_bn2bin(const BIGNUM *a, unsigned char *to);
 373 BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
 374 int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
 375 int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 376 int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 377 int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 378 int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 379 int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
 380 int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
 381 /** BN_set_negative sets sign of a BIGNUM
 382  * \param  b  pointer to the BIGNUM object
 383  * \param  n  0 if the BIGNUM b should be positive and a value != 0 otherwise
 384  */
 385 void BN_set_negative(BIGNUM *b, int n);
 386 /** BN_is_negative returns 1 if the BIGNUM is negative
 387  * \param  a  pointer to the BIGNUM object
 388  * \return 1 if a < 0 and 0 otherwise
 389  */
 390 int BN_is_negative(const BIGNUM *b);
 391
 392 int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
 393            BN_CTX *ctx);
 394 # define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
 395 int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
 396 int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
 397                BN_CTX *ctx);
 398 int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 399                      const BIGNUM *m);
 400 int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
 401                BN_CTX *ctx);
 402 int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 403                      const BIGNUM *m);
 404 int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
 405                BN_CTX *ctx);
 406 int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
 407 int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
 408 int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
 409 int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m,
 410                   BN_CTX *ctx);
 411 int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
 412
 413 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
 414 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
 415 int BN_mul_word(BIGNUM *a, BN_ULONG w);
 416 int BN_add_word(BIGNUM *a, BN_ULONG w);
 417 int BN_sub_word(BIGNUM *a, BN_ULONG w);
 418 int BN_set_word(BIGNUM *a, BN_ULONG w);
 419 BN_ULONG BN_get_word(const BIGNUM *a);
 420
 421 int BN_cmp(const BIGNUM *a, const BIGNUM *b);
 422 void BN_free(BIGNUM *a);
 423 int BN_is_bit_set(const BIGNUM *a, int n);
 424 int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
 425 int BN_lshift1(BIGNUM *r, const BIGNUM *a);
 426 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 427
 428 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 429                const BIGNUM *m, BN_CTX *ctx);
 430 int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 431                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 432 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
 433                               const BIGNUM *m, BN_CTX *ctx,
 434                               BN_MONT_CTX *in_mont);
 435 int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
 436                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 437 int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
 438                      const BIGNUM *a2, const BIGNUM *p2, const BIGNUM *m,
 439                      BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 440 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 441                       const BIGNUM *m, BN_CTX *ctx);
 442
 443 int BN_mask_bits(BIGNUM *a, int n);
 444 # ifndef OPENSSL_NO_STDIO
 445 int BN_print_fp(FILE *fp, const BIGNUM *a);
 446 # endif
 447 # ifdef HEADER_BIO_H
 448 int BN_print(BIO *fp, const BIGNUM *a);
 449 # else
 450 int BN_print(void *fp, const BIGNUM *a);
 451 # endif
 452 int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
 453 int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
 454 int BN_rshift1(BIGNUM *r, const BIGNUM *a);
 455 void BN_clear(BIGNUM *a);
 456 BIGNUM *BN_dup(const BIGNUM *a);
 457 int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
 458 int BN_set_bit(BIGNUM *a, int n);
 459 int BN_clear_bit(BIGNUM *a, int n);
 460 char *BN_bn2hex(const BIGNUM *a);
 461 char *BN_bn2dec(const BIGNUM *a);
 462 int BN_hex2bn(BIGNUM **a, const char *str);
 463 int BN_dec2bn(BIGNUM **a, const char *str);
 464 int BN_asc2bn(BIGNUM **a, const char *str);
 465 int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
 466 int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); /* returns
 467                                                                   * -2 for
 468                                                                   * error */
 469 BIGNUM *BN_mod_inverse(BIGNUM *ret,
 470                        const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
 471 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
 472                     const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
 473
 474 void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
 475
 476 /* Deprecated versions */
 477 # ifdef OPENSSL_USE_DEPRECATED
 478 DECLARE_DEPRECATED(BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
 479                                              const BIGNUM *add,
 480                                              const BIGNUM *rem,
 481                                              void (*callback) (int, int,
 482                                                                void *),
 483                                              void *cb_arg));
 484 DECLARE_DEPRECATED(int
 485                    BN_is_prime(const BIGNUM *p, int nchecks,
 486                                void (*callback) (int, int, void *),
 487                                BN_CTX *ctx, void *cb_arg));
 488 DECLARE_DEPRECATED(int
 489                    BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
 490                                         void (*callback) (int, int, void *),
 491                                         BN_CTX *ctx, void *cb_arg,
 492                                         int do_trial_division));
 493 # endif                         /* defined(OPENSSL_USE_DEPRECATED) */
 494
 495 /* Newer versions */
 496 int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
 497                          const BIGNUM *rem, BN_GENCB *cb);
 498 int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
 499 int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
 500                             int do_trial_division, BN_GENCB *cb);
 501
 502 int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
 503
 504 int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
 505                             const BIGNUM *Xp, const BIGNUM *Xp1,
 506                             const BIGNUM *Xp2, const BIGNUM *e, BN_CTX *ctx,
 507                             BN_GENCB *cb);
 508 int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, BIGNUM *Xp1,
 509                               BIGNUM *Xp2, const BIGNUM *Xp, const BIGNUM *e,
 510                               BN_CTX *ctx, BN_GENCB *cb);
 511
 512 BN_MONT_CTX *BN_MONT_CTX_new(void);
 513 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 514                           BN_MONT_CTX *mont, BN_CTX *ctx);
 515 int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
 516                      BN_CTX *ctx);
 517 int BN_from_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
 518                        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,
 536                           BN_CTX *);
 537 # ifdef OPENSSL_USE_DEPRECATED
 538 DECLARE_DEPRECATED(unsigned long
 539                    BN_BLINDING_get_thread_id(const BN_BLINDING *));
 540 DECLARE_DEPRECATED(void
 541                    BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long));
 542 # endif
 543 CRYPTO_THREADID *BN_BLINDING_thread_id(BN_BLINDING *);
 544 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
 545 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
 546 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
 547                                       const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
 548                                       int (*bn_mod_exp) (BIGNUM *r,
 549                                                          const BIGNUM *a,
 550                                                          const BIGNUM *p,
 551                                                          const BIGNUM *m,
 552                                                          BN_CTX *ctx,
 553                                                          BN_MONT_CTX *m_ctx),
 554                                       BN_MONT_CTX *m_ctx);
 555
 556 # ifdef OPENSSL_USE_DEPRECATED
 557 DECLARE_DEPRECATED(void BN_set_params(int mul, int high, int low, int mont));
 558 DECLARE_DEPRECATED(int BN_get_params(int which)); /* 0, mul, 1 high, 2 low, 3
 559                                                    * mont */
 560 # endif
 561
 562 BN_RECP_CTX *BN_RECP_CTX_new(void);
 563 void BN_RECP_CTX_free(BN_RECP_CTX *recp);
 564 int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
 565 int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
 566                           BN_RECP_CTX *recp, BN_CTX *ctx);
 567 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 568                     const BIGNUM *m, BN_CTX *ctx);
 569 int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
 570                 BN_RECP_CTX *recp, BN_CTX *ctx);
 571
 572 # ifndef OPENSSL_NO_EC2M
 573
 574 /*
 575  * Functions for arithmetic over binary polynomials represented by BIGNUMs.
 576  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
 577  * ignored. Note that input arguments are not const so that their bit arrays
 578  * can be expanded to the appropriate size if needed.
 579  */
 580
 581 /*
 582  * r = a + b
 583  */
 584 int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 585 #  define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
 586 /*
 587  * r=a mod p
 588  */
 589 int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p);
 590 /* r = (a * b) mod p */
 591 int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 592                     const BIGNUM *p, BN_CTX *ctx);
 593 /* r = (a * a) mod p */
 594 int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 595 /* r = (1 / b) mod p */
 596 int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx);
 597 /* r = (a / b) mod p */
 598 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 599                     const BIGNUM *p, BN_CTX *ctx);
 600 /* r = (a ^ b) mod p */
 601 int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 602                     const BIGNUM *p, BN_CTX *ctx);
 603 /* r = sqrt(a) mod p */
 604 int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 605                      BN_CTX *ctx);
 606 /* r^2 + r = a mod p */
 607 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 608                            BN_CTX *ctx);
 609 #  define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
 610 /*-
 611  * Some functions allow for representation of the irreducible polynomials
 612  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
 613  *     t^p[0] + t^p[1] + ... + t^p[k]
 614  * where m = p[0] > p[1] > ... > p[k] = 0.
 615  */
 616 /* r = a mod p */
 617 int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
 618 /* r = (a * b) mod p */
 619 int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 620                         const int p[], BN_CTX *ctx);
 621 /* r = (a * a) mod p */
 622 int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
 623                         BN_CTX *ctx);
 624 /* r = (1 / b) mod p */
 625 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
 626                         BN_CTX *ctx);
 627 /* r = (a / b) mod p */
 628 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 629                         const int p[], BN_CTX *ctx);
 630 /* r = (a ^ b) mod p */
 631 int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 632                         const int p[], BN_CTX *ctx);
 633 /* r = sqrt(a) mod p */
 634 int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
 635                          const int p[], BN_CTX *ctx);
 636 /* r^2 + r = a mod p */
 637 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
 638                                const int p[], BN_CTX *ctx);
 639 int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
 640 int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
 641
 642 # endif
 643
 644 /*
 645  * faster mod functions for the 'NIST primes' 0 <= a < p^2
 646  */
 647 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 648 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 649 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 650 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 651 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 652
 653 const BIGNUM *BN_get0_nist_prime_192(void);
 654 const BIGNUM *BN_get0_nist_prime_224(void);
 655 const BIGNUM *BN_get0_nist_prime_256(void);
 656 const BIGNUM *BN_get0_nist_prime_384(void);
 657 const BIGNUM *BN_get0_nist_prime_521(void);
 658
 659 int (*BN_nist_mod_func(const BIGNUM *p)) (BIGNUM *r, const BIGNUM *a,
 660                                           const BIGNUM *field, BN_CTX *ctx);
 661
 662 int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
 663                           const BIGNUM *priv, const unsigned char *message,
 664                           size_t message_len, BN_CTX *ctx);
 665
 666 /* Primes from RFC 2409 */
 667 BIGNUM *get_rfc2409_prime_768(BIGNUM *bn);
 668 BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn);
 669
 670 /* Primes from RFC 3526 */
 671 BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn);
 672 BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn);
 673 BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn);
 674 BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn);
 675 BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn);
 676 BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn);
 677
 678 int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
 679
 680 /* BEGIN ERROR CODES */
 681 /*
 682  * The following lines are auto generated by the script mkerr.pl. Any changes
 683  * made after this point may be overwritten when the script is next run.
 684  */
 685 void ERR_load_BN_strings(void);
 686
 687 /* Error codes for the BN functions. */
 688
 689 /* Function codes. */
 690 # define BN_F_BNRAND                                      127
 691 # define BN_F_BN_BLINDING_CONVERT_EX                      100
 692 # define BN_F_BN_BLINDING_CREATE_PARAM                    128
 693 # define BN_F_BN_BLINDING_INVERT_EX                       101
 694 # define BN_F_BN_BLINDING_NEW                             102
 695 # define BN_F_BN_BLINDING_UPDATE                          103
 696 # define BN_F_BN_BN2DEC                                   104
 697 # define BN_F_BN_BN2HEX                                   105
 698 # define BN_F_BN_COMPUTE_WNAF                             142
 699 # define BN_F_BN_CTX_GET                                  116
 700 # define BN_F_BN_CTX_NEW                                  106
 701 # define BN_F_BN_CTX_START                                129
 702 # define BN_F_BN_DIV                                      107
 703 # define BN_F_BN_DIV_NO_BRANCH                            138
 704 # define BN_F_BN_DIV_RECP                                 130
 705 # define BN_F_BN_EXP                                      123
 706 # define BN_F_BN_EXPAND2                                  108
 707 # define BN_F_BN_EXPAND_INTERNAL                          120
 708 # define BN_F_BN_GENCB_NEW                                143
 709 # define BN_F_BN_GENERATE_DSA_NONCE                       140
 710 # define BN_F_BN_GENERATE_PRIME_EX                        141
 711 # define BN_F_BN_GF2M_MOD                                 131
 712 # define BN_F_BN_GF2M_MOD_EXP                             132
 713 # define BN_F_BN_GF2M_MOD_MUL                             133
 714 # define BN_F_BN_GF2M_MOD_SOLVE_QUAD                      134
 715 # define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                  135
 716 # define BN_F_BN_GF2M_MOD_SQR                             136
 717 # define BN_F_BN_GF2M_MOD_SQRT                            137
 718 # define BN_F_BN_MOD_EXP2_MONT                            118
 719 # define BN_F_BN_MOD_EXP_MONT                             109
 720 # define BN_F_BN_MOD_EXP_MONT_CONSTTIME                   124
 721 # define BN_F_BN_MOD_EXP_MONT_WORD                        117
 722 # define BN_F_BN_MOD_EXP_RECP                             125
 723 # define BN_F_BN_MOD_EXP_SIMPLE                           126
 724 # define BN_F_BN_MOD_INVERSE                              110
 725 # define BN_F_BN_MOD_INVERSE_NO_BRANCH                    139
 726 # define BN_F_BN_MOD_LSHIFT_QUICK                         119
 727 # define BN_F_BN_MOD_MUL_RECIPROCAL                       111
 728 # define BN_F_BN_MOD_SQRT                                 121
 729 # define BN_F_BN_MPI2BN                                   112
 730 # define BN_F_BN_NEW                                      113
 731 # define BN_F_BN_RAND                                     114
 732 # define BN_F_BN_RAND_RANGE                               122
 733 # define BN_F_BN_SET_WORDS                                144
 734 # define BN_F_BN_USUB                                     115
 735
 736 /* Reason codes. */
 737 # define BN_R_ARG2_LT_ARG3                                100
 738 # define BN_R_BAD_RECIPROCAL                              101
 739 # define BN_R_BIGNUM_TOO_LONG                             114
 740 # define BN_R_BITS_TOO_SMALL                              118
 741 # define BN_R_CALLED_WITH_EVEN_MODULUS                    102
 742 # define BN_R_DIV_BY_ZERO                                 103
 743 # define BN_R_ENCODING_ERROR                              104
 744 # define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA                105
 745 # define BN_R_INPUT_NOT_REDUCED                           110
 746 # define BN_R_INVALID_LENGTH                              106
 747 # define BN_R_INVALID_RANGE                               115
 748 # define BN_R_NOT_A_SQUARE                                111
 749 # define BN_R_NOT_INITIALIZED                             107
 750 # define BN_R_NO_INVERSE                                  108
 751 # define BN_R_NO_SOLUTION                                 116
 752 # define BN_R_PRIVATE_KEY_TOO_LARGE                       117
 753 # define BN_R_P_IS_NOT_PRIME                              112
 754 # define BN_R_TOO_MANY_ITERATIONS                         113
 755 # define BN_R_TOO_MANY_TEMPORARY_VARIABLES                109
 756
 757 #ifdef  __cplusplus
 758 }
 759 #endif
 760 #endif