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
  35 #ifdef  __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /*
  40  * 64-bit processor with LP64 ABI
  41  */
  42 # ifdef SIXTY_FOUR_BIT_LONG
  43 #  define BN_ULONG        unsigned long
  44 #  define BN_BYTES        8
  45 # endif
  46
  47 /*
  48  * 64-bit processor other than LP64 ABI
  49  */
  50 # ifdef SIXTY_FOUR_BIT
  51 #  define BN_ULONG        unsigned long long
  52 #  define BN_BYTES        8
  53 # endif
  54
  55 # ifdef THIRTY_TWO_BIT
  56 #  define BN_ULONG        unsigned int
  57 #  define BN_BYTES        4
  58 # endif
  59
  60 # define BN_BITS2       (BN_BYTES * 8)
  61 # define BN_BITS        (BN_BITS2 * 2)
  62 # define BN_TBIT        ((BN_ULONG)1 << (BN_BITS2 - 1))
  63
  64 # define BN_FLG_MALLOCED         0x01
  65 # define BN_FLG_STATIC_DATA      0x02
  66
  67 /*
  68  * avoid leaking exponent information through timing,
  69  * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
  70  * BN_div() will call BN_div_no_branch,
  71  * BN_mod_inverse() will call BN_mod_inverse_no_branch.
  72  */
  73 # define BN_FLG_CONSTTIME        0x04
  74 # define BN_FLG_SECURE           0x08
  75
  76 # if OPENSSL_API_COMPAT < 0x00908000L
  77 /* deprecated name for the flag */
  78 #  define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME
  79 #  define BN_FLG_FREE            0x8000 /* used for debugging */
  80 # endif
  81
  82 void BN_set_flags(BIGNUM *b, int n);
  83 int BN_get_flags(const BIGNUM *b, int n);
  84
  85 /* Values for |top| in BN_rand() */
  86 #define BN_RAND_TOP_ANY    -1
  87 #define BN_RAND_TOP_ONE     0
  88 #define BN_RAND_TOP_TWO     1
  89
  90 /* Values for |bottom| in BN_rand() */
  91 #define BN_RAND_BOTTOM_ANY  0
  92 #define BN_RAND_BOTTOM_ODD  1
  93
  94 /*
  95  * get a clone of a BIGNUM with changed flags, for *temporary* use only (the
  96  * two BIGNUMs cannot be used in parallel!). Also only for *read only* use. The
  97  * value |dest| should be a newly allocated BIGNUM obtained via BN_new() that
  98  * has not been otherwise initialised or used.
  99  */
 100 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags);
 101
 102 /* Wrapper function to make using BN_GENCB easier */
 103 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
 104
 105 BN_GENCB *BN_GENCB_new(void);
 106 void BN_GENCB_free(BN_GENCB *cb);
 107
 108 /* Populate a BN_GENCB structure with an "old"-style callback */
 109 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
 110                       void *cb_arg);
 111
 112 /* Populate a BN_GENCB structure with a "new"-style callback */
 113 void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
 114                   void *cb_arg);
 115
 116 void *BN_GENCB_get_arg(BN_GENCB *cb);
 117
 118 # define BN_prime_checks 0      /* default: select number of iterations based
 119                                  * on the size of the number */
 120
 121 /*
 122  * number of Miller-Rabin iterations for an error rate of less than 2^-80 for
 123  * random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook of
 124  * Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
 125  * original paper: Damgaard, Landrock, Pomerance: Average case error
 126  * estimates for the strong probable prime test. -- Math. Comp. 61 (1993)
 127  * 177-194)
 128  */
 129 # define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
 130                                 (b) >=  850 ?  3 : \
 131                                 (b) >=  650 ?  4 : \
 132                                 (b) >=  550 ?  5 : \
 133                                 (b) >=  450 ?  6 : \
 134                                 (b) >=  400 ?  7 : \
 135                                 (b) >=  350 ?  8 : \
 136                                 (b) >=  300 ?  9 : \
 137                                 (b) >=  250 ? 12 : \
 138                                 (b) >=  200 ? 15 : \
 139                                 (b) >=  150 ? 18 : \
 140                                 /* b >= 100 */ 27)
 141
 142 # define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
 143
 144 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
 145 int BN_is_zero(const BIGNUM *a);
 146 int BN_is_one(const BIGNUM *a);
 147 int BN_is_word(const BIGNUM *a, const BN_ULONG w);
 148 int BN_is_odd(const BIGNUM *a);
 149
 150 # define BN_one(a)       (BN_set_word((a),1))
 151
 152 void BN_zero_ex(BIGNUM *a);
 153
 154 # if OPENSSL_API_COMPAT >= 0x00908000L
 155 #  define BN_zero(a)      BN_zero_ex(a)
 156 # else
 157 #  define BN_zero(a)      (BN_set_word((a),0))
 158 # endif
 159
 160 const BIGNUM *BN_value_one(void);
 161 char *BN_options(void);
 162 BN_CTX *BN_CTX_new(void);
 163 BN_CTX *BN_CTX_secure_new(void);
 164 void BN_CTX_free(BN_CTX *c);
 165 void BN_CTX_start(BN_CTX *ctx);
 166 BIGNUM *BN_CTX_get(BN_CTX *ctx);
 167 void BN_CTX_end(BN_CTX *ctx);
 168 int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
 169 int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
 170 int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
 171 int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
 172 int BN_num_bits(const BIGNUM *a);
 173 int BN_num_bits_word(BN_ULONG l);
 174 int BN_security_bits(int L, int N);
 175 BIGNUM *BN_new(void);
 176 BIGNUM *BN_secure_new(void);
 177 void BN_clear_free(BIGNUM *a);
 178 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
 179 void BN_swap(BIGNUM *a, BIGNUM *b);
 180 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
 181 int BN_bn2bin(const BIGNUM *a, unsigned char *to);
 182 int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen);
 183 BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret);
 184 int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen);
 185 BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
 186 int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
 187 int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 188 int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 189 int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 190 int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 191 int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
 192 int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
 193 /** BN_set_negative sets sign of a BIGNUM
 194  * \param  b  pointer to the BIGNUM object
 195  * \param  n  0 if the BIGNUM b should be positive and a value != 0 otherwise
 196  */
 197 void BN_set_negative(BIGNUM *b, int n);
 198 /** BN_is_negative returns 1 if the BIGNUM is negative
 199  * \param  a  pointer to the BIGNUM object
 200  * \return 1 if a < 0 and 0 otherwise
 201  */
 202 int BN_is_negative(const BIGNUM *b);
 203
 204 int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
 205            BN_CTX *ctx);
 206 # define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
 207 int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
 208 int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
 209                BN_CTX *ctx);
 210 int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 211                      const BIGNUM *m);
 212 int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
 213                BN_CTX *ctx);
 214 int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 215                      const BIGNUM *m);
 216 int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
 217                BN_CTX *ctx);
 218 int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
 219 int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
 220 int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
 221 int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m,
 222                   BN_CTX *ctx);
 223 int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
 224
 225 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
 226 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
 227 int BN_mul_word(BIGNUM *a, BN_ULONG w);
 228 int BN_add_word(BIGNUM *a, BN_ULONG w);
 229 int BN_sub_word(BIGNUM *a, BN_ULONG w);
 230 int BN_set_word(BIGNUM *a, BN_ULONG w);
 231 BN_ULONG BN_get_word(const BIGNUM *a);
 232
 233 int BN_cmp(const BIGNUM *a, const BIGNUM *b);
 234 void BN_free(BIGNUM *a);
 235 int BN_is_bit_set(const BIGNUM *a, int n);
 236 int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
 237 int BN_lshift1(BIGNUM *r, const BIGNUM *a);
 238 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 239
 240 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 241                const BIGNUM *m, BN_CTX *ctx);
 242 int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 243                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 244 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
 245                               const BIGNUM *m, BN_CTX *ctx,
 246                               BN_MONT_CTX *in_mont);
 247 int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
 248                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 249 int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
 250                      const BIGNUM *a2, const BIGNUM *p2, const BIGNUM *m,
 251                      BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 252 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 253                       const BIGNUM *m, BN_CTX *ctx);
 254
 255 int BN_mask_bits(BIGNUM *a, int n);
 256 # ifndef OPENSSL_NO_STDIO
 257 int BN_print_fp(FILE *fp, const BIGNUM *a);
 258 # endif
 259 int BN_print(BIO *bio, const BIGNUM *a);
 260 int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
 261 int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
 262 int BN_rshift1(BIGNUM *r, const BIGNUM *a);
 263 void BN_clear(BIGNUM *a);
 264 BIGNUM *BN_dup(const BIGNUM *a);
 265 int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
 266 int BN_set_bit(BIGNUM *a, int n);
 267 int BN_clear_bit(BIGNUM *a, int n);
 268 char *BN_bn2hex(const BIGNUM *a);
 269 char *BN_bn2dec(const BIGNUM *a);
 270 int BN_hex2bn(BIGNUM **a, const char *str);
 271 int BN_dec2bn(BIGNUM **a, const char *str);
 272 int BN_asc2bn(BIGNUM **a, const char *str);
 273 int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
 274 int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); /* returns
 275                                                                   * -2 for
 276                                                                   * error */
 277 BIGNUM *BN_mod_inverse(BIGNUM *ret,
 278                        const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
 279 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
 280                     const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
 281
 282 void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
 283
 284 /* Deprecated versions */
 285 DEPRECATEDIN_0_9_8(BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
 286                                              const BIGNUM *add,
 287                                              const BIGNUM *rem,
 288                                              void (*callback) (int, int,
 289                                                                void *),
 290                                              void *cb_arg))
 291 DEPRECATEDIN_0_9_8(int
 292                    BN_is_prime(const BIGNUM *p, int nchecks,
 293                                void (*callback) (int, int, void *),
 294                                BN_CTX *ctx, void *cb_arg))
 295 DEPRECATEDIN_0_9_8(int
 296                    BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
 297                                         void (*callback) (int, int, void *),
 298                                         BN_CTX *ctx, void *cb_arg,
 299                                         int do_trial_division))
 300
 301 /* Newer versions */
 302 int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
 303                          const BIGNUM *rem, BN_GENCB *cb);
 304 int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
 305 int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
 306                             int do_trial_division, BN_GENCB *cb);
 307
 308 int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
 309
 310 int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
 311                             const BIGNUM *Xp, const BIGNUM *Xp1,
 312                             const BIGNUM *Xp2, const BIGNUM *e, BN_CTX *ctx,
 313                             BN_GENCB *cb);
 314 int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, BIGNUM *Xp1,
 315                               BIGNUM *Xp2, const BIGNUM *Xp, const BIGNUM *e,
 316                               BN_CTX *ctx, BN_GENCB *cb);
 317
 318 BN_MONT_CTX *BN_MONT_CTX_new(void);
 319 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 320                           BN_MONT_CTX *mont, BN_CTX *ctx);
 321 int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
 322                      BN_CTX *ctx);
 323 int BN_from_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
 324                        BN_CTX *ctx);
 325 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
 326 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx);
 327 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
 328 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, CRYPTO_RWLOCK *lock,
 329                                     const BIGNUM *mod, BN_CTX *ctx);
 330
 331 /* BN_BLINDING flags */
 332 # define BN_BLINDING_NO_UPDATE   0x00000001
 333 # define BN_BLINDING_NO_RECREATE 0x00000002
 334
 335 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
 336 void BN_BLINDING_free(BN_BLINDING *b);
 337 int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
 338 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 339 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 340 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
 341 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
 342                           BN_CTX *);
 343
 344 int BN_BLINDING_is_current_thread(BN_BLINDING *b);
 345 void BN_BLINDING_set_current_thread(BN_BLINDING *b);
 346 int BN_BLINDING_lock(BN_BLINDING *b);
 347 int BN_BLINDING_unlock(BN_BLINDING *b);
 348
 349 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
 350 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
 351 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
 352                                       const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
 353                                       int (*bn_mod_exp) (BIGNUM *r,
 354                                                          const BIGNUM *a,
 355                                                          const BIGNUM *p,
 356                                                          const BIGNUM *m,
 357                                                          BN_CTX *ctx,
 358                                                          BN_MONT_CTX *m_ctx),
 359                                       BN_MONT_CTX *m_ctx);
 360
 361 DEPRECATEDIN_0_9_8(void BN_set_params(int mul, int high, int low, int mont))
 362 DEPRECATEDIN_0_9_8(int BN_get_params(int which)) /* 0, mul, 1 high, 2 low, 3
 363                                                   * mont */
 364
 365 BN_RECP_CTX *BN_RECP_CTX_new(void);
 366 void BN_RECP_CTX_free(BN_RECP_CTX *recp);
 367 int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
 368 int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
 369                           BN_RECP_CTX *recp, BN_CTX *ctx);
 370 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 371                     const BIGNUM *m, BN_CTX *ctx);
 372 int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
 373                 BN_RECP_CTX *recp, BN_CTX *ctx);
 374
 375 # ifndef OPENSSL_NO_EC2M
 376
 377 /*
 378  * Functions for arithmetic over binary polynomials represented by BIGNUMs.
 379  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
 380  * ignored. Note that input arguments are not const so that their bit arrays
 381  * can be expanded to the appropriate size if needed.
 382  */
 383
 384 /*
 385  * r = a + b
 386  */
 387 int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 388 #  define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
 389 /*
 390  * r=a mod p
 391  */
 392 int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p);
 393 /* r = (a * b) mod p */
 394 int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 395                     const BIGNUM *p, BN_CTX *ctx);
 396 /* r = (a * a) mod p */
 397 int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 398 /* r = (1 / b) mod p */
 399 int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx);
 400 /* r = (a / b) mod p */
 401 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 402                     const BIGNUM *p, BN_CTX *ctx);
 403 /* r = (a ^ b) mod p */
 404 int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 405                     const BIGNUM *p, BN_CTX *ctx);
 406 /* r = sqrt(a) mod p */
 407 int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 408                      BN_CTX *ctx);
 409 /* r^2 + r = a mod p */
 410 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 411                            BN_CTX *ctx);
 412 #  define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
 413 /*-
 414  * Some functions allow for representation of the irreducible polynomials
 415  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
 416  *     t^p[0] + t^p[1] + ... + t^p[k]
 417  * where m = p[0] > p[1] > ... > p[k] = 0.
 418  */
 419 /* r = a mod p */
 420 int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
 421 /* r = (a * b) mod p */
 422 int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 423                         const int p[], BN_CTX *ctx);
 424 /* r = (a * a) mod p */
 425 int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
 426                         BN_CTX *ctx);
 427 /* r = (1 / b) mod p */
 428 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
 429                         BN_CTX *ctx);
 430 /* r = (a / b) mod p */
 431 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 432                         const int p[], BN_CTX *ctx);
 433 /* r = (a ^ b) mod p */
 434 int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 435                         const int p[], BN_CTX *ctx);
 436 /* r = sqrt(a) mod p */
 437 int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
 438                          const int p[], BN_CTX *ctx);
 439 /* r^2 + r = a mod p */
 440 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
 441                                const int p[], BN_CTX *ctx);
 442 int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
 443 int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
 444
 445 # endif
 446
 447 /*
 448  * faster mod functions for the 'NIST primes' 0 <= a < p^2
 449  */
 450 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 451 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 452 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 453 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 454 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
 455
 456 const BIGNUM *BN_get0_nist_prime_192(void);
 457 const BIGNUM *BN_get0_nist_prime_224(void);
 458 const BIGNUM *BN_get0_nist_prime_256(void);
 459 const BIGNUM *BN_get0_nist_prime_384(void);
 460 const BIGNUM *BN_get0_nist_prime_521(void);
 461
 462 int (*BN_nist_mod_func(const BIGNUM *p)) (BIGNUM *r, const BIGNUM *a,
 463                                           const BIGNUM *field, BN_CTX *ctx);
 464
 465 int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
 466                           const BIGNUM *priv, const unsigned char *message,
 467                           size_t message_len, BN_CTX *ctx);
 468
 469 /* Primes from RFC 2409 */
 470 BIGNUM *BN_get_rfc2409_prime_768(BIGNUM *bn);
 471 BIGNUM *BN_get_rfc2409_prime_1024(BIGNUM *bn);
 472
 473 /* Primes from RFC 3526 */
 474 BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *bn);
 475 BIGNUM *BN_get_rfc3526_prime_2048(BIGNUM *bn);
 476 BIGNUM *BN_get_rfc3526_prime_3072(BIGNUM *bn);
 477 BIGNUM *BN_get_rfc3526_prime_4096(BIGNUM *bn);
 478 BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *bn);
 479 BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *bn);
 480
 481 # if OPENSSL_API_COMPAT < 0x10100000L
 482 #  define get_rfc2409_prime_768 BN_get_rfc2409_prime_768
 483 #  define get_rfc2409_prime_1024 BN_get_rfc2409_prime_1024
 484 #  define get_rfc3526_prime_1536 BN_get_rfc3526_prime_1536
 485 #  define get_rfc3526_prime_2048 BN_get_rfc3526_prime_2048
 486 #  define get_rfc3526_prime_3072 BN_get_rfc3526_prime_3072
 487 #  define get_rfc3526_prime_4096 BN_get_rfc3526_prime_4096
 488 #  define get_rfc3526_prime_6144 BN_get_rfc3526_prime_6144
 489 #  define get_rfc3526_prime_8192 BN_get_rfc3526_prime_8192
 490 # endif
 491
 492 int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
 493
 494 /* BEGIN ERROR CODES */
 495 /*
 496  * The following lines are auto generated by the script mkerr.pl. Any changes
 497  * made after this point may be overwritten when the script is next run.
 498  */
 499
 500 int ERR_load_BN_strings(void);
 501
 502 /* Error codes for the BN functions. */
 503
 504 /* Function codes. */
 505 # define BN_F_BNRAND                                      127
 506 # define BN_F_BN_BLINDING_CONVERT_EX                      100
 507 # define BN_F_BN_BLINDING_CREATE_PARAM                    128
 508 # define BN_F_BN_BLINDING_INVERT_EX                       101
 509 # define BN_F_BN_BLINDING_NEW                             102
 510 # define BN_F_BN_BLINDING_UPDATE                          103
 511 # define BN_F_BN_BN2DEC                                   104
 512 # define BN_F_BN_BN2HEX                                   105
 513 # define BN_F_BN_COMPUTE_WNAF                             142
 514 # define BN_F_BN_CTX_GET                                  116
 515 # define BN_F_BN_CTX_NEW                                  106
 516 # define BN_F_BN_CTX_START                                129
 517 # define BN_F_BN_DIV                                      107
 518 # define BN_F_BN_DIV_RECP                                 130
 519 # define BN_F_BN_EXP                                      123
 520 # define BN_F_BN_EXPAND_INTERNAL                          120
 521 # define BN_F_BN_GENCB_NEW                                143
 522 # define BN_F_BN_GENERATE_DSA_NONCE                       140
 523 # define BN_F_BN_GENERATE_PRIME_EX                        141
 524 # define BN_F_BN_GF2M_MOD                                 131
 525 # define BN_F_BN_GF2M_MOD_EXP                             132
 526 # define BN_F_BN_GF2M_MOD_MUL                             133
 527 # define BN_F_BN_GF2M_MOD_SOLVE_QUAD                      134
 528 # define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                  135
 529 # define BN_F_BN_GF2M_MOD_SQR                             136
 530 # define BN_F_BN_GF2M_MOD_SQRT                            137
 531 # define BN_F_BN_LSHIFT                                   145
 532 # define BN_F_BN_MOD_EXP2_MONT                            118
 533 # define BN_F_BN_MOD_EXP_MONT                             109
 534 # define BN_F_BN_MOD_EXP_MONT_CONSTTIME                   124
 535 # define BN_F_BN_MOD_EXP_MONT_WORD                        117
 536 # define BN_F_BN_MOD_EXP_RECP                             125
 537 # define BN_F_BN_MOD_EXP_SIMPLE                           126
 538 # define BN_F_BN_MOD_INVERSE                              110
 539 # define BN_F_BN_MOD_INVERSE_NO_BRANCH                    139
 540 # define BN_F_BN_MOD_LSHIFT_QUICK                         119
 541 # define BN_F_BN_MOD_SQRT                                 121
 542 # define BN_F_BN_MPI2BN                                   112
 543 # define BN_F_BN_NEW                                      113
 544 # define BN_F_BN_RAND                                     114
 545 # define BN_F_BN_RAND_RANGE                               122
 546 # define BN_F_BN_RSHIFT                                   146
 547 # define BN_F_BN_SET_WORDS                                144
 548 # define BN_F_BN_USUB                                     115
 549
 550 /* Reason codes. */
 551 # define BN_R_ARG2_LT_ARG3                                100
 552 # define BN_R_BAD_RECIPROCAL                              101
 553 # define BN_R_BIGNUM_TOO_LONG                             114
 554 # define BN_R_BITS_TOO_SMALL                              118
 555 # define BN_R_CALLED_WITH_EVEN_MODULUS                    102
 556 # define BN_R_DIV_BY_ZERO                                 103
 557 # define BN_R_ENCODING_ERROR                              104
 558 # define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA                105
 559 # define BN_R_INPUT_NOT_REDUCED                           110
 560 # define BN_R_INVALID_LENGTH                              106
 561 # define BN_R_INVALID_RANGE                               115
 562 # define BN_R_INVALID_SHIFT                               119
 563 # define BN_R_NOT_A_SQUARE                                111
 564 # define BN_R_NOT_INITIALIZED                             107
 565 # define BN_R_NO_INVERSE                                  108
 566 # define BN_R_NO_SOLUTION                                 116
 567 # define BN_R_PRIVATE_KEY_TOO_LARGE                       117
 568 # define BN_R_P_IS_NOT_PRIME                              112
 569 # define BN_R_TOO_MANY_ITERATIONS                         113
 570 # define BN_R_TOO_MANY_TEMPORARY_VARIABLES                109
 571
 572 # ifdef  __cplusplus
 573 }
 574 # endif
 575 #endif