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