include/openssl/bn.h

   1 /*
   2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /* ====================================================================
  11  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  12  *
  13  * Portions of the attached software ("Contribution") are developed by
  14  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
  15  *
  16  * The Contribution is licensed pursuant to the Eric Young open source
  17  * license provided above.
  18  *
  19  * The binary polynomial arithmetic software is originally written by
  20  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
  21  *
  22  */
  23
  24 #ifndef HEADER_BN_H
  25 # define HEADER_BN_H
  26
  27 # include <openssl/e_os2.h>
  28 # ifndef OPENSSL_NO_STDIO
  29 #  include <stdio.h>
  30 # endif
  31 # include <openssl/opensslconf.h>
  32 # include <openssl/ossl_typ.h>
  33 # include <openssl/crypto.h>
  34 # include <openssl/bnerr.h>
  35
  36 #ifdef  __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /*
  41  * 64-bit processor with LP64 ABI
  42  */
  43 # ifdef SIXTY_FOUR_BIT_LONG
  44 #  define BN_ULONG        unsigned long
  45 #  define BN_BYTES        8
  46 # endif
  47
  48 /*
  49  * 64-bit processor other than LP64 ABI
  50  */
  51 # ifdef SIXTY_FOUR_BIT
  52 #  define BN_ULONG        unsigned long long
  53 #  define BN_BYTES        8
  54 # endif
  55
  56 # ifdef THIRTY_TWO_BIT
  57 #  define BN_ULONG        unsigned int
  58 #  define BN_BYTES        4
  59 # endif
  60
  61 # define BN_BITS2       (BN_BYTES * 8)
  62 # define BN_BITS        (BN_BITS2 * 2)
  63 # define BN_TBIT        ((BN_ULONG)1 << (BN_BITS2 - 1))
  64
  65 # define BN_FLG_MALLOCED         0x01
  66 # define BN_FLG_STATIC_DATA      0x02
  67
  68 /*
  69  * avoid leaking exponent information through timing,
  70  * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
  71  * BN_div() will call BN_div_no_branch,
  72  * BN_mod_inverse() will call BN_mod_inverse_no_branch.
  73  */
  74 # define BN_FLG_CONSTTIME        0x04
  75 # define BN_FLG_SECURE           0x08
  76
  77 # if OPENSSL_API_COMPAT < 0x00908000L
  78 /* deprecated name for the flag */
  79 #  define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME
  80 #  define BN_FLG_FREE            0x8000 /* used for debugging */
  81 # endif
  82
  83 void BN_set_flags(BIGNUM *b, int n);
  84 int BN_get_flags(const BIGNUM *b, int n);
  85
  86 /* Values for |top| in BN_rand() */
  87 #define BN_RAND_TOP_ANY    -1
  88 #define BN_RAND_TOP_ONE     0
  89 #define BN_RAND_TOP_TWO     1
  90
  91 /* Values for |bottom| in BN_rand() */
  92 #define BN_RAND_BOTTOM_ANY  0
  93 #define BN_RAND_BOTTOM_ODD  1
  94
  95 /*
  96  * get a clone of a BIGNUM with changed flags, for *temporary* use only (the
  97  * two BIGNUMs cannot be used in parallel!). Also only for *read only* use. The
  98  * value |dest| should be a newly allocated BIGNUM obtained via BN_new() that
  99  * has not been otherwise initialised or used.
 100  */
 101 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags);
 102
 103 /* Wrapper function to make using BN_GENCB easier */
 104 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
 105
 106 BN_GENCB *BN_GENCB_new(void);
 107 void BN_GENCB_free(BN_GENCB *cb);
 108
 109 /* Populate a BN_GENCB structure with an "old"-style callback */
 110 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
 111                       void *cb_arg);
 112
 113 /* Populate a BN_GENCB structure with a "new"-style callback */
 114 void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
 115                   void *cb_arg);
 116
 117 void *BN_GENCB_get_arg(BN_GENCB *cb);
 118
 119 # define BN_prime_checks 0      /* default: select number of iterations based
 120                                  * on the size of the number */
 121
 122 /*
 123  * number of Miller-Rabin iterations for an error rate of less than 2^-80 for
 124  * random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook of
 125  * Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
 126  * original paper: Damgaard, Landrock, Pomerance: Average case error
 127  * estimates for the strong probable prime test. -- Math. Comp. 61 (1993)
 128  * 177-194)
 129  */
 130 # define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
 131                                 (b) >=  850 ?  3 : \
 132                                 (b) >=  650 ?  4 : \
 133                                 (b) >=  550 ?  5 : \
 134                                 (b) >=  450 ?  6 : \
 135                                 (b) >=  400 ?  7 : \
 136                                 (b) >=  350 ?  8 : \
 137                                 (b) >=  300 ?  9 : \
 138                                 (b) >=  250 ? 12 : \
 139                                 (b) >=  200 ? 15 : \
 140                                 (b) >=  150 ? 18 : \
 141                                 /* b >= 100 */ 27)
 142
 143 # define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
 144
 145 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
 146 int BN_is_zero(const BIGNUM *a);
 147 int BN_is_one(const BIGNUM *a);
 148 int BN_is_word(const BIGNUM *a, const BN_ULONG w);
 149 int BN_is_odd(const BIGNUM *a);
 150
 151 # define BN_one(a)       (BN_set_word((a),1))
 152
 153 void BN_zero_ex(BIGNUM *a);
 154
 155 # if OPENSSL_API_COMPAT >= 0x00908000L
 156 #  define BN_zero(a)      BN_zero_ex(a)
 157 # else
 158 #  define BN_zero(a)      (BN_set_word((a),0))
 159 # endif
 160
 161 const BIGNUM *BN_value_one(void);
 162 char *BN_options(void);
 163 BN_CTX *BN_CTX_new(void);
 164 BN_CTX *BN_CTX_secure_new(void);
 165 void BN_CTX_free(BN_CTX *c);
 166 void BN_CTX_start(BN_CTX *ctx);
 167 BIGNUM *BN_CTX_get(BN_CTX *ctx);
 168 void BN_CTX_end(BN_CTX *ctx);
 169 int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
 170 int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
 171 int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
 172 int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
 173 int BN_num_bits(const BIGNUM *a);
 174 int BN_num_bits_word(BN_ULONG l);
 175 int BN_security_bits(int L, int N);
 176 BIGNUM *BN_new(void);
 177 BIGNUM *BN_secure_new(void);
 178 void BN_clear_free(BIGNUM *a);
 179 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
 180 void BN_swap(BIGNUM *a, BIGNUM *b);
 181 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
 182 int BN_bn2bin(const BIGNUM *a, unsigned char *to);
 183 int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen);
 184 BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret);
 185 int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen);
 186 BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
 187 int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
 188 int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 189 int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 190 int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 191 int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 192 int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
 193 int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
 194 /** BN_set_negative sets sign of a BIGNUM
 195  * \param  b  pointer to the BIGNUM object
 196  * \param  n  0 if the BIGNUM b should be positive and a value != 0 otherwise
 197  */
 198 void BN_set_negative(BIGNUM *b, int n);
 199 /** BN_is_negative returns 1 if the BIGNUM is negative
 200  * \param  a  pointer to the BIGNUM object
 201  * \return 1 if a < 0 and 0 otherwise
 202  */
 203 int BN_is_negative(const BIGNUM *b);
 204
 205 int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
 206            BN_CTX *ctx);
 207 # define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
 208 int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
 209 int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
 210                BN_CTX *ctx);
 211 int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 212                      const BIGNUM *m);
 213 int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
 214                BN_CTX *ctx);
 215 int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 216                      const BIGNUM *m);
 217 int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
 218                BN_CTX *ctx);
 219 int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
 220 int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
 221 int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
 222 int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m,
 223                   BN_CTX *ctx);
 224 int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
 225
 226 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
 227 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
 228 int BN_mul_word(BIGNUM *a, BN_ULONG w);
 229 int BN_add_word(BIGNUM *a, BN_ULONG w);
 230 int BN_sub_word(BIGNUM *a, BN_ULONG w);
 231 int BN_set_word(BIGNUM *a, BN_ULONG w);
 232 BN_ULONG BN_get_word(const BIGNUM *a);
 233
 234 int BN_cmp(const BIGNUM *a, const BIGNUM *b);
 235 void BN_free(BIGNUM *a);
 236 int BN_is_bit_set(const BIGNUM *a, int n);
 237 int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
 238 int BN_lshift1(BIGNUM *r, const BIGNUM *a);
 239 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 240
 241 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 242                const BIGNUM *m, BN_CTX *ctx);
 243 int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 244                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 245 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
 246                               const BIGNUM *m, BN_CTX *ctx,
 247                               BN_MONT_CTX *in_mont);
 248 int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
 249                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 250 int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
 251                      const BIGNUM *a2, const BIGNUM *p2, const BIGNUM *m,
 252                      BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 253 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 254                       const BIGNUM *m, BN_CTX *ctx);
 255
 256 int BN_mask_bits(BIGNUM *a, int n);
 257 # ifndef OPENSSL_NO_STDIO
 258 int BN_print_fp(FILE *fp, const BIGNUM *a);
 259 # endif
 260 int BN_print(BIO *bio, const BIGNUM *a);
 261 int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
 262 int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
 263 int BN_rshift1(BIGNUM *r, const BIGNUM *a);
 264 void BN_clear(BIGNUM *a);
 265 BIGNUM *BN_dup(const BIGNUM *a);
 266 int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
 267 int BN_set_bit(BIGNUM *a, int n);
 268 int BN_clear_bit(BIGNUM *a, int n);
 269 char *BN_bn2hex(const BIGNUM *a);
 270 char *BN_bn2dec(const BIGNUM *a);
 271 int BN_hex2bn(BIGNUM **a, const char *str);
 272 int BN_dec2bn(BIGNUM **a, const char *str);
 273 int BN_asc2bn(BIGNUM **a, const char *str);
 274 int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
 275 int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); /* returns
 276                                                                   * -2 for
 277                                                                   * error */
 278 BIGNUM *BN_mod_inverse(BIGNUM *ret,
 279                        const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
 280 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
 281                     const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
 282
 283 void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
 284
 285 /* Deprecated versions */
 286 DEPRECATEDIN_0_9_8(BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
 287                                              const BIGNUM *add,
 288                                              const BIGNUM *rem,
 289                                              void (*callback) (int, int,
 290                                                                void *),
 291                                              void *cb_arg))
 292 DEPRECATEDIN_0_9_8(int
 293                    BN_is_prime(const BIGNUM *p, int nchecks,
 294                                void (*callback) (int, int, void *),
 295                                BN_CTX *ctx, void *cb_arg))
 296 DEPRECATEDIN_0_9_8(int
 297                    BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
 298                                         void (*callback) (int, int, void *),
 299                                         BN_CTX *ctx, void *cb_arg,
 300                                         int do_trial_division))
 301
 302 /* Newer versions */
 303 int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
 304                          const BIGNUM *rem, BN_GENCB *cb);
 305 int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
 306 int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
 307                             int do_trial_division, BN_GENCB *cb);
 308
 309 int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
 310
 311 int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
 312                             const BIGNUM *Xp, const BIGNUM *Xp1,
 313                             const BIGNUM *Xp2, const BIGNUM *e, BN_CTX *ctx,
 314                             BN_GENCB *cb);
 315 int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, BIGNUM *Xp1,
 316                               BIGNUM *Xp2, const BIGNUM *Xp, const BIGNUM *e,
 317                               BN_CTX *ctx, BN_GENCB *cb);
 318
 319 BN_MONT_CTX *BN_MONT_CTX_new(void);
 320 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 321                           BN_MONT_CTX *mont, BN_CTX *ctx);
 322 int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
 323                      BN_CTX *ctx);
 324 int BN_from_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
 325                        BN_CTX *ctx);
 326 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
 327 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx);
 328 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
 329 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, CRYPTO_RWLOCK *lock,
 330                                     const BIGNUM *mod, BN_CTX *ctx);
 331
 332 /* BN_BLINDING flags */
 333 # define BN_BLINDING_NO_UPDATE   0x00000001
 334 # define BN_BLINDING_NO_RECREATE 0x00000002
 335
 336 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
 337 void BN_BLINDING_free(BN_BLINDING *b);
 338 int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
 339 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 340 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 341 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
 342 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
 343                           BN_CTX *);
 344
 345 int BN_BLINDING_is_current_thread(BN_BLINDING *b);
 346 void BN_BLINDING_set_current_thread(BN_BLINDING *b);
 347 int BN_BLINDING_lock(BN_BLINDING *b);
 348 int BN_BLINDING_unlock(BN_BLINDING *b);
 349
 350 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
 351 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
 352 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
 353                                       const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
 354                                       int (*bn_mod_exp) (BIGNUM *r,
 355                                                          const BIGNUM *a,
 356                                                          const BIGNUM *p,
 357                                                          const BIGNUM *m,
 358                                                          BN_CTX *ctx,
 359                                                          BN_MONT_CTX *m_ctx),
 360                                       BN_MONT_CTX *m_ctx);
 361
 362 DEPRECATEDIN_0_9_8(void BN_set_params(int mul, int high, int low, int mont))
 363 DEPRECATEDIN_0_9_8(int BN_get_params(int which)) /* 0, mul, 1 high, 2 low, 3
 364                                                   * mont */
 365
 366 BN_RECP_CTX *BN_RECP_CTX_new(void);
 367 void BN_RECP_CTX_free(BN_RECP_CTX *recp);
 368 int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
 369 int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
 370                           BN_RECP_CTX *recp, BN_CTX *ctx);
 371 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 372                     const BIGNUM *m, BN_CTX *ctx);
 373 int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
 374                 BN_RECP_CTX *recp, BN_CTX *ctx);
 375
 376 # ifndef OPENSSL_NO_EC2M
 377
 378 /*
 379  * Functions for arithmetic over binary polynomials represented by BIGNUMs.
 380  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
 381  * ignored. Note that input arguments are not const so that their bit arrays
 382  * can be expanded to the appropriate size if needed.
 383  */
 384
 385 /*
 386  * r = a + b
 387  */
 388 int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 389 #  define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
 390 /*
 391  * r=a mod p
 392  */
 393 int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p);
 394 /* r = (a * b) mod p */
 395 int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 396                     const BIGNUM *p, BN_CTX *ctx);
 397 /* r = (a * a) mod p */
 398 int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 399 /* r = (1 / b) mod p */
 400 int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx);
 401 /* r = (a / b) mod p */
 402 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 403                     const BIGNUM *p, BN_CTX *ctx);
 404 /* r = (a ^ b) mod p */
 405 int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 406                     const BIGNUM *p, BN_CTX *ctx);
 407 /* r = sqrt(a) mod p */
 408 int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 409                      BN_CTX *ctx);
 410 /* r^2 + r = a mod p */
 411 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 412                            BN_CTX *ctx);
 413 #  define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
 414 /*-
 415  * Some functions allow for representation of the irreducible polynomials
 416  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
 417  *     t^p[0] + t^p[1] + ... + t^p[k]
 418  * where m = p[0] > p[1] > ... > p[k] = 0.
 419  */
 420 /* r = a mod p */
 421 int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
 422 /* r = (a * b) mod p */
 423 int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 424                         const int p[], BN_CTX *ctx);
 425 /* r = (a * a) mod p */
 426 int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
 427                         BN_CTX *ctx);
 428 /* r = (1 / b) mod p */
 429 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
 430                         BN_CTX *ctx);
 431 /* r = (a / b) mod p */
 432 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 433                         const int p[], BN_CTX *ctx);
 434 /* r = (a ^ b) mod p */
 435 int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 436                         const int p[], BN_CTX *ctx);
 437 /* r = sqrt(a) mod p */
 438 int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
 439                          const int p[], BN_CTX *ctx);
 440 /* r^2 + r = a mod p */
 441 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
 442                                const int p[], BN_CTX *ctx);
 443 int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
 444 int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
 445
 446 # endif
 447
 448 /*
 449  * faster mod functions for the 'NIST primes' 0 <= a < p^2
 450  */
 451 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 452 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 453 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 454 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 455 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 456
 457 const BIGNUM *BN_get0_nist_prime_192(void);
 458 const BIGNUM *BN_get0_nist_prime_224(void);
 459 const BIGNUM *BN_get0_nist_prime_256(void);
 460 const BIGNUM *BN_get0_nist_prime_384(void);
 461 const BIGNUM *BN_get0_nist_prime_521(void);
 462
 463 int (*BN_nist_mod_func(const BIGNUM *p)) (BIGNUM *r, const BIGNUM *a,
 464                                           const BIGNUM *field, BN_CTX *ctx);
 465
 466 int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
 467                           const BIGNUM *priv, const unsigned char *message,
 468                           size_t message_len, BN_CTX *ctx);
 469
 470 /* Primes from RFC 2409 */
 471 BIGNUM *BN_get_rfc2409_prime_768(BIGNUM *bn);
 472 BIGNUM *BN_get_rfc2409_prime_1024(BIGNUM *bn);
 473
 474 /* Primes from RFC 3526 */
 475 BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *bn);
 476 BIGNUM *BN_get_rfc3526_prime_2048(BIGNUM *bn);
 477 BIGNUM *BN_get_rfc3526_prime_3072(BIGNUM *bn);
 478 BIGNUM *BN_get_rfc3526_prime_4096(BIGNUM *bn);
 479 BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *bn);
 480 BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *bn);
 481
 482 # if OPENSSL_API_COMPAT < 0x10100000L
 483 #  define get_rfc2409_prime_768 BN_get_rfc2409_prime_768
 484 #  define get_rfc2409_prime_1024 BN_get_rfc2409_prime_1024
 485 #  define get_rfc3526_prime_1536 BN_get_rfc3526_prime_1536
 486 #  define get_rfc3526_prime_2048 BN_get_rfc3526_prime_2048
 487 #  define get_rfc3526_prime_3072 BN_get_rfc3526_prime_3072
 488 #  define get_rfc3526_prime_4096 BN_get_rfc3526_prime_4096
 489 #  define get_rfc3526_prime_6144 BN_get_rfc3526_prime_6144
 490 #  define get_rfc3526_prime_8192 BN_get_rfc3526_prime_8192
 491 # endif
 492
 493 int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
 494
 495 int ERR_load_BN_strings(void);
 496
 497 # ifdef  __cplusplus
 498 }
 499 # endif
 500 #endif