1 /* $OpenBSD: bn.h,v 1.30 2016/03/04 16:06:38 doug Exp $ */
2 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
58 /* ====================================================================
59 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
111 /* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
114 * Portions of the attached software ("Contribution") are developed by
115 * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
117 * The Contribution is licensed pursuant to the Eric Young open source
118 * license provided above.
120 * The binary polynomial arithmetic software is originally written by
121 * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
131 #include <openssl/opensslconf.h>
133 #include <openssl/ossl_typ.h>
134 #include <openssl/crypto.h>
135 #include <openssl/bio.h>
141 /* These preprocessor symbols control various aspects of the bignum headers and
142 * library code. They're not defined by any "normal" configuration, as they are
143 * intended for development and testing purposes. NB: defining all three can be
144 * useful for debugging application code as well as openssl itself.
146 * BN_DEBUG - turn on various debugging alterations to the bignum code
147 * BN_DEBUG_RAND - uses random poisoning of unused words to trip up
148 * mismanagement of bignum internals. You must also define BN_DEBUG.
150 /* #define BN_DEBUG */
151 /* #define BN_DEBUG_RAND */
153 #ifndef OPENSSL_SMALL_FOOTPRINT
159 /* This next option uses the C libraries (2 word)/(1 word) function.
160 * If it is not defined, I use my C version (which is slower).
161 * The reason for this flag is that when the particular C compiler
162 * library routine is used, and the library is linked with a different
163 * compiler, the library is missing. This mostly happens when the
164 * library is built with gcc and then linked using normal cc. This would
165 * be a common occurrence because gcc normally produces code that is
166 * 2 times faster than system compilers for the big number stuff.
167 * For machines with only one compiler (or shared libraries), this should
168 * be on. Again this in only really a problem on machines
169 * using "long long's", are 32bit, and are not using my assembler code. */
170 /* #define BN_DIV2W */
174 #define BN_ULONG unsigned long
180 #define BN_MASK2 (0xffffffffffffffffL)
181 #define BN_MASK2l (0xffffffffL)
182 #define BN_MASK2h (0xffffffff00000000L)
183 #define BN_MASK2h1 (0xffffffff80000000L)
184 #define BN_TBIT (0x8000000000000000L)
185 #define BN_DEC_CONV (10000000000000000000UL)
186 #define BN_DEC_FMT1 "%lu"
187 #define BN_DEC_FMT2 "%019lu"
188 #define BN_DEC_NUM 19
189 #define BN_HEX_FMT1 "%lX"
190 #define BN_HEX_FMT2 "%016lX"
192 #define BN_ULLONG unsigned long long
194 #define BN_ULONG unsigned int
200 #define BN_MASK (0xffffffffffffffffLL)
201 #define BN_MASK2 (0xffffffffL)
202 #define BN_MASK2l (0xffff)
203 #define BN_MASK2h1 (0xffff8000L)
204 #define BN_MASK2h (0xffff0000L)
205 #define BN_TBIT (0x80000000L)
206 #define BN_DEC_CONV (1000000000L)
207 #define BN_DEC_FMT1 "%u"
208 #define BN_DEC_FMT2 "%09u"
210 #define BN_HEX_FMT1 "%X"
211 #define BN_HEX_FMT2 "%08X"
214 #define BN_FLG_MALLOCED 0x01
215 #define BN_FLG_STATIC_DATA 0x02
216 #define BN_FLG_CONSTTIME 0x04 /* avoid leaking exponent information through timing,
217 * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
218 * BN_div() will call BN_div_no_branch,
219 * BN_mod_inverse() will call BN_mod_inverse_no_branch.
222 #ifndef OPENSSL_NO_DEPRECATED
223 #define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME /* deprecated name for the flag */
224 /* avoid leaking exponent information through timings
225 * (BN_mod_exp_mont() will call BN_mod_exp_mont_consttime) */
228 #ifndef OPENSSL_NO_DEPRECATED
229 #define BN_FLG_FREE 0x8000 /* used for debuging */
231 #define BN_set_flags(b,n) ((b)->flags|=(n))
232 #define BN_get_flags(b,n) ((b)->flags&(n))
234 /* get a clone of a BIGNUM with changed flags, for *temporary* use only
235 * (the two BIGNUMs cannot not be used in parallel!) */
236 #define BN_with_flags(dest,b,n) ((dest)->d=(b)->d, \
237 (dest)->top=(b)->top, \
238 (dest)->dmax=(b)->dmax, \
239 (dest)->neg=(b)->neg, \
240 (dest)->flags=(((dest)->flags & BN_FLG_MALLOCED) \
241 | ((b)->flags & ~BN_FLG_MALLOCED) \
242 | BN_FLG_STATIC_DATA \
246 BN_ULONG *d; /* Pointer to an array of 'BN_BITS2' bit chunks. */
247 int top; /* Index of last used d +1. */
248 /* The next are internal book keeping for bn_expand. */
249 int dmax; /* Size of the d array. */
250 int neg; /* one if the number is negative */
254 /* Used for montgomery multiplication */
255 struct bn_mont_ctx_st {
256 int ri; /* number of bits in R */
257 BIGNUM RR; /* used to convert to montgomery form */
258 BIGNUM N; /* The modulus */
259 BIGNUM Ni; /* R*(1/R mod N) - N*Ni = 1
260 * (Ni is only stored for bignum algorithm) */
261 BN_ULONG n0[2];/* least significant word(s) of Ni;
262 (type changed with 0.9.9, was "BN_ULONG n0;" before) */
266 /* Used for reciprocal division/mod functions
267 * It cannot be shared between threads
269 struct bn_recp_ctx_st {
270 BIGNUM N; /* the divisor */
271 BIGNUM Nr; /* the reciprocal */
277 /* Used for slow "generation" functions. */
279 unsigned int ver; /* To handle binary (in)compatibility */
280 void *arg; /* callback-specific data */
282 /* if(ver==1) - handles old style callbacks */
283 void (*cb_1)(int, int, void *);
284 /* if(ver==2) - new callback style */
285 int (*cb_2)(int, int, BN_GENCB *);
288 /* Wrapper function to make using BN_GENCB easier, */
289 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
290 /* Macro to populate a BN_GENCB structure with an "old"-style callback */
291 #define BN_GENCB_set_old(gencb, callback, cb_arg) { \
292 BN_GENCB *tmp_gencb = (gencb); \
293 tmp_gencb->ver = 1; \
294 tmp_gencb->arg = (cb_arg); \
295 tmp_gencb->cb.cb_1 = (callback); }
296 /* Macro to populate a BN_GENCB structure with a "new"-style callback */
297 #define BN_GENCB_set(gencb, callback, cb_arg) { \
298 BN_GENCB *tmp_gencb = (gencb); \
299 tmp_gencb->ver = 2; \
300 tmp_gencb->arg = (cb_arg); \
301 tmp_gencb->cb.cb_2 = (callback); }
303 #define BN_prime_checks 0 /* default: select number of iterations
304 based on the size of the number */
306 /* number of Miller-Rabin iterations for an error rate of less than 2^-80
307 * for random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook
308 * of Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
309 * original paper: Damgaard, Landrock, Pomerance: Average case error estimates
310 * for the strong probable prime test. -- Math. Comp. 61 (1993) 177-194) */
311 #define BN_prime_checks_for_size(b) ((b) >= 1300 ? 2 : \
324 #define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
326 /* Note that BN_abs_is_word didn't work reliably for w == 0 until 0.9.8 */
327 #define BN_abs_is_word(a,w) ((((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w))) || \
328 (((w) == 0) && ((a)->top == 0)))
329 #define BN_is_zero(a) ((a)->top == 0)
330 #define BN_is_one(a) (BN_abs_is_word((a),1) && !(a)->neg)
331 #define BN_is_word(a,w) (BN_abs_is_word((a),(w)) && (!(w) || !(a)->neg))
332 #define BN_is_odd(a) (((a)->top > 0) && ((a)->d[0] & 1))
334 #define BN_one(a) (BN_set_word((a),1))
335 #define BN_zero_ex(a) \
337 BIGNUM *_tmp_bn = (a); \
342 #ifdef OPENSSL_NO_DEPRECATED
343 #define BN_zero(a) BN_zero_ex(a)
345 #define BN_zero(a) (BN_set_word((a),0))
348 const BIGNUM *BN_value_one(void);
349 char * BN_options(void);
350 BN_CTX *BN_CTX_new(void);
351 #ifndef OPENSSL_NO_DEPRECATED
352 void BN_CTX_init(BN_CTX *c);
354 void BN_CTX_free(BN_CTX *c);
355 void BN_CTX_start(BN_CTX *ctx);
356 BIGNUM *BN_CTX_get(BN_CTX *ctx);
357 void BN_CTX_end(BN_CTX *ctx);
358 int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
359 int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
360 int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
361 int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
362 int BN_num_bits(const BIGNUM *a);
363 int BN_num_bits_word(BN_ULONG);
364 BIGNUM *BN_new(void);
365 void BN_init(BIGNUM *);
366 void BN_clear_free(BIGNUM *a);
367 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
368 void BN_swap(BIGNUM *a, BIGNUM *b);
369 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
370 int BN_bn2bin(const BIGNUM *a, unsigned char *to);
371 BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
372 int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
373 int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
374 int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
375 int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
376 int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
377 int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
378 int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
379 /** BN_set_negative sets sign of a BIGNUM
380 * \param b pointer to the BIGNUM object
381 * \param n 0 if the BIGNUM b should be positive and a value != 0 otherwise
383 void BN_set_negative(BIGNUM *b, int n);
384 /** BN_is_negative returns 1 if the BIGNUM is negative
385 * \param a pointer to the BIGNUM object
386 * \return 1 if a < 0 and 0 otherwise
388 #define BN_is_negative(a) ((a)->neg != 0)
390 int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
392 #define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
393 int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
394 int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
395 int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
396 int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
397 int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
398 int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
399 const BIGNUM *m, BN_CTX *ctx);
400 int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
401 int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
402 int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
403 int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m, BN_CTX *ctx);
404 int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
406 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
407 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
408 int BN_mul_word(BIGNUM *a, BN_ULONG w);
409 int BN_add_word(BIGNUM *a, BN_ULONG w);
410 int BN_sub_word(BIGNUM *a, BN_ULONG w);
411 int BN_set_word(BIGNUM *a, BN_ULONG w);
412 BN_ULONG BN_get_word(const BIGNUM *a);
414 int BN_cmp(const BIGNUM *a, const BIGNUM *b);
415 void BN_free(BIGNUM *a);
416 int BN_is_bit_set(const BIGNUM *a, int n);
417 int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
418 int BN_lshift1(BIGNUM *r, const BIGNUM *a);
419 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
421 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
422 const BIGNUM *m, BN_CTX *ctx);
423 int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
424 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
425 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
426 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont);
427 int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
428 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
429 int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
430 const BIGNUM *a2, const BIGNUM *p2, const BIGNUM *m,
431 BN_CTX *ctx, BN_MONT_CTX *m_ctx);
432 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
433 const BIGNUM *m, BN_CTX *ctx);
435 int BN_mask_bits(BIGNUM *a, int n);
436 int BN_print_fp(FILE *fp, const BIGNUM *a);
437 int BN_print(BIO *fp, const BIGNUM *a);
438 int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
439 int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
440 int BN_rshift1(BIGNUM *r, const BIGNUM *a);
441 void BN_clear(BIGNUM *a);
442 BIGNUM *BN_dup(const BIGNUM *a);
443 int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
444 int BN_set_bit(BIGNUM *a, int n);
445 int BN_clear_bit(BIGNUM *a, int n);
446 char * BN_bn2hex(const BIGNUM *a);
447 char * BN_bn2dec(const BIGNUM *a);
448 int BN_hex2bn(BIGNUM **a, const char *str);
449 int BN_dec2bn(BIGNUM **a, const char *str);
450 int BN_asc2bn(BIGNUM **a, const char *str);
451 int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
452 int BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */
453 BIGNUM *BN_mod_inverse(BIGNUM *ret,
454 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
455 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
456 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
458 void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
460 /* Deprecated versions */
461 #ifndef OPENSSL_NO_DEPRECATED
462 BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
463 const BIGNUM *add, const BIGNUM *rem,
464 void (*callback)(int, int, void *), void *cb_arg);
465 int BN_is_prime(const BIGNUM *p, int nchecks,
466 void (*callback)(int, int, void *),
467 BN_CTX *ctx, void *cb_arg);
468 int BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
469 void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg,
470 int do_trial_division);
471 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
474 int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
475 const BIGNUM *rem, BN_GENCB *cb);
476 int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
477 int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
478 int do_trial_division, BN_GENCB *cb);
480 int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
482 int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
483 const BIGNUM *Xp, const BIGNUM *Xp1, const BIGNUM *Xp2,
484 const BIGNUM *e, BN_CTX *ctx, BN_GENCB *cb);
485 int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
486 BIGNUM *Xp1, BIGNUM *Xp2,
488 const BIGNUM *e, BN_CTX *ctx,
491 BN_MONT_CTX *BN_MONT_CTX_new(void );
492 void BN_MONT_CTX_init(BN_MONT_CTX *ctx);
493 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
494 BN_MONT_CTX *mont, BN_CTX *ctx);
495 #define BN_to_montgomery(r,a,mont,ctx) BN_mod_mul_montgomery(\
496 (r),(a),&((mont)->RR),(mont),(ctx))
497 int BN_from_montgomery(BIGNUM *r, const BIGNUM *a,
498 BN_MONT_CTX *mont, BN_CTX *ctx);
499 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
500 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx);
501 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
502 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
503 const BIGNUM *mod, BN_CTX *ctx);
505 /* BN_BLINDING flags */
506 #define BN_BLINDING_NO_UPDATE 0x00000001
507 #define BN_BLINDING_NO_RECREATE 0x00000002
509 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
510 void BN_BLINDING_free(BN_BLINDING *b);
511 int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
512 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
513 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
514 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
515 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *);
516 #ifndef OPENSSL_NO_DEPRECATED
517 unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
518 void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
520 CRYPTO_THREADID *BN_BLINDING_thread_id(BN_BLINDING *);
521 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
522 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
523 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
524 const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
525 int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
526 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
529 #ifndef OPENSSL_NO_DEPRECATED
530 void BN_set_params(int mul, int high, int low, int mont);
531 int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */
534 void BN_RECP_CTX_init(BN_RECP_CTX *recp);
535 BN_RECP_CTX *BN_RECP_CTX_new(void);
536 void BN_RECP_CTX_free(BN_RECP_CTX *recp);
537 int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
538 int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
539 BN_RECP_CTX *recp, BN_CTX *ctx);
540 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
541 const BIGNUM *m, BN_CTX *ctx);
542 int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
543 BN_RECP_CTX *recp, BN_CTX *ctx);
545 #ifndef OPENSSL_NO_EC2M
547 /* Functions for arithmetic over binary polynomials represented by BIGNUMs.
549 * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
552 * Note that input arguments are not const so that their bit arrays can
553 * be expanded to the appropriate size if needed.
556 int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); /*r = a + b*/
557 #define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
558 int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p); /*r=a mod p*/
560 BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
561 const BIGNUM *p, BN_CTX *ctx); /* r = (a * b) mod p */
563 BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
564 BN_CTX *ctx); /* r = (a * a) mod p */
566 BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p,
567 BN_CTX *ctx); /* r = (1 / b) mod p */
569 BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
570 const BIGNUM *p, BN_CTX *ctx); /* r = (a / b) mod p */
572 BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
573 const BIGNUM *p, BN_CTX *ctx); /* r = (a ^ b) mod p */
575 BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
576 BN_CTX *ctx); /* r = sqrt(a) mod p */
577 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
578 BN_CTX *ctx); /* r^2 + r = a mod p */
579 #define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
580 /* Some functions allow for representation of the irreducible polynomials
581 * as an unsigned int[], say p. The irreducible f(t) is then of the form:
582 * t^p[0] + t^p[1] + ... + t^p[k]
583 * where m = p[0] > p[1] > ... > p[k] = 0.
585 int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
587 int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
588 const int p[], BN_CTX *ctx); /* r = (a * b) mod p */
589 int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
590 BN_CTX *ctx); /* r = (a * a) mod p */
591 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
592 BN_CTX *ctx); /* r = (1 / b) mod p */
593 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
594 const int p[], BN_CTX *ctx); /* r = (a / b) mod p */
595 int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
596 const int p[], BN_CTX *ctx); /* r = (a ^ b) mod p */
597 int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
598 const int p[], BN_CTX *ctx); /* r = sqrt(a) mod p */
599 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
600 const int p[], BN_CTX *ctx); /* r^2 + r = a mod p */
601 int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
602 int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
606 /* faster mod functions for the 'NIST primes'
608 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
609 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
610 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
611 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
612 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
614 const BIGNUM *BN_get0_nist_prime_192(void);
615 const BIGNUM *BN_get0_nist_prime_224(void);
616 const BIGNUM *BN_get0_nist_prime_256(void);
617 const BIGNUM *BN_get0_nist_prime_384(void);
618 const BIGNUM *BN_get0_nist_prime_521(void);
620 /* library internal functions */
622 #define bn_wexpand(a,words) (((words) <= (a)->dmax)?(a):bn_expand2((a),(words)))
623 BIGNUM *bn_expand2(BIGNUM *a, int words);
624 BIGNUM *bn_expand(BIGNUM *a, int bits);
626 #ifndef OPENSSL_NO_DEPRECATED
627 BIGNUM *bn_dup_expand(const BIGNUM *a, int words); /* unused */
630 /* Bignum consistency macros
631 * There is one "API" macro, bn_fix_top(), for stripping leading zeroes from
632 * bignum data after direct manipulations on the data. There is also an
633 * "internal" macro, bn_check_top(), for verifying that there are no leading
634 * zeroes. Unfortunately, some auditing is required due to the fact that
635 * bn_fix_top() has become an overabused duct-tape because bignum data is
636 * occasionally passed around in an inconsistent state. So the following
637 * changes have been made to sort this out;
638 * - bn_fix_top()s implementation has been moved to bn_correct_top()
639 * - if BN_DEBUG isn't defined, bn_fix_top() maps to bn_correct_top(), and
640 * bn_check_top() is as before.
641 * - if BN_DEBUG *is* defined;
642 * - bn_check_top() tries to pollute unused words even if the bignum 'top' is
643 * consistent. (ed: only if BN_DEBUG_RAND is defined)
644 * - bn_fix_top() maps to bn_check_top() rather than "fixing" anything.
645 * The idea is to have debug builds flag up inconsistent bignums when they
646 * occur. If that occurs in a bn_fix_top(), we examine the code in question; if
647 * the use of bn_fix_top() was appropriate (ie. it follows directly after code
648 * that manipulates the bignum) it is converted to bn_correct_top(), and if it
649 * was not appropriate, we convert it permanently to bn_check_top() and track
650 * down the cause of the bug. Eventually, no internal code should be using the
651 * bn_fix_top() macro. External applications and libraries should try this with
652 * their own code too, both in terms of building against the openssl headers
653 * with BN_DEBUG defined *and* linking with a version of OpenSSL built with it
654 * defined. This not only improves external code, it provides more test
655 * coverage for openssl's own code.
660 /* We only need assert() when debugging */
664 #define bn_pollute(a) \
666 const BIGNUM *_bnum1 = (a); \
667 if(_bnum1->top < _bnum1->dmax) { \
668 unsigned char _tmp_char; \
669 /* We cast away const without the compiler knowing, any \
670 * *genuinely* constant variables that aren't mutable \
671 * wouldn't be constructed with top!=dmax. */ \
672 BN_ULONG *_not_const; \
673 memcpy(&_not_const, &_bnum1->d, sizeof(BN_ULONG*)); \
674 arc4random_buf(&_tmp_char, 1); \
675 memset((unsigned char *)(_not_const + _bnum1->top), _tmp_char, \
676 (_bnum1->dmax - _bnum1->top) * sizeof(BN_ULONG)); \
680 #define bn_pollute(a)
683 #define bn_check_top(a) \
685 const BIGNUM *_bnum2 = (a); \
686 if (_bnum2 != NULL) { \
687 assert((_bnum2->top == 0) || \
688 (_bnum2->d[_bnum2->top - 1] != 0)); \
689 bn_pollute(_bnum2); \
693 #define bn_fix_top(a) bn_check_top(a)
695 #define bn_check_size(bn, bits) bn_wcheck_size(bn, ((bits+BN_BITS2-1))/BN_BITS2)
696 #define bn_wcheck_size(bn, words) \
698 const BIGNUM *_bnum2 = (bn); \
699 assert(words <= (_bnum2)->dmax && words >= (_bnum2)->top); \
702 #else /* !BN_DEBUG */
704 #define bn_pollute(a)
705 #define bn_check_top(a)
706 #define bn_fix_top(a) bn_correct_top(a)
707 #define bn_check_size(bn, bits)
708 #define bn_wcheck_size(bn, words)
712 #define bn_correct_top(a) \
715 int tmp_top = (a)->top; \
718 for (ftl= &((a)->d[tmp_top-1]); tmp_top > 0; tmp_top--) \
719 if (*(ftl--)) break; \
720 (a)->top = tmp_top; \
725 BN_ULONG bn_mul_add_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
726 BN_ULONG bn_mul_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
727 void bn_sqr_words(BN_ULONG *rp, const BN_ULONG *ap, int num);
728 BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d);
729 BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp, int num);
730 BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp, int num);
732 /* Primes from RFC 2409 */
733 BIGNUM *get_rfc2409_prime_768(BIGNUM *bn);
734 BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn);
736 /* Primes from RFC 3526 */
737 BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn);
738 BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn);
739 BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn);
740 BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn);
741 BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn);
742 BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn);
744 int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
746 /* BEGIN ERROR CODES */
747 /* The following lines are auto generated by the script mkerr.pl. Any changes
748 * made after this point may be overwritten when the script is next run.
750 void ERR_load_BN_strings(void);
752 /* Error codes for the BN functions. */
754 /* Function codes. */
755 #define BN_F_BNRAND 127
756 #define BN_F_BN_BLINDING_CONVERT_EX 100
757 #define BN_F_BN_BLINDING_CREATE_PARAM 128
758 #define BN_F_BN_BLINDING_INVERT_EX 101
759 #define BN_F_BN_BLINDING_NEW 102
760 #define BN_F_BN_BLINDING_UPDATE 103
761 #define BN_F_BN_BN2DEC 104
762 #define BN_F_BN_BN2HEX 105
763 #define BN_F_BN_CTX_GET 116
764 #define BN_F_BN_CTX_NEW 106
765 #define BN_F_BN_CTX_START 129
766 #define BN_F_BN_DIV 107
767 #define BN_F_BN_DIV_NO_BRANCH 138
768 #define BN_F_BN_DIV_RECP 130
769 #define BN_F_BN_EXP 123
770 #define BN_F_BN_EXPAND2 108
771 #define BN_F_BN_GENERATE_PRIME_EX 140
772 #define BN_F_BN_EXPAND_INTERNAL 120
773 #define BN_F_BN_GF2M_MOD 131
774 #define BN_F_BN_GF2M_MOD_EXP 132
775 #define BN_F_BN_GF2M_MOD_MUL 133
776 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD 134
777 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR 135
778 #define BN_F_BN_GF2M_MOD_SQR 136
779 #define BN_F_BN_GF2M_MOD_SQRT 137
780 #define BN_F_BN_MOD_EXP2_MONT 118
781 #define BN_F_BN_MOD_EXP_MONT 109
782 #define BN_F_BN_MOD_EXP_MONT_CONSTTIME 124
783 #define BN_F_BN_MOD_EXP_MONT_WORD 117
784 #define BN_F_BN_MOD_EXP_RECP 125
785 #define BN_F_BN_MOD_EXP_SIMPLE 126
786 #define BN_F_BN_MOD_INVERSE 110
787 #define BN_F_BN_MOD_INVERSE_NO_BRANCH 139
788 #define BN_F_BN_MOD_LSHIFT_QUICK 119
789 #define BN_F_BN_MOD_MUL_RECIPROCAL 111
790 #define BN_F_BN_MOD_SQRT 121
791 #define BN_F_BN_MPI2BN 112
792 #define BN_F_BN_NEW 113
793 #define BN_F_BN_RAND 114
794 #define BN_F_BN_RAND_RANGE 122
795 #define BN_F_BN_USUB 115
798 #define BN_R_ARG2_LT_ARG3 100
799 #define BN_R_BAD_RECIPROCAL 101
800 #define BN_R_BIGNUM_TOO_LONG 114
801 #define BN_R_BITS_TOO_SMALL 117
802 #define BN_R_CALLED_WITH_EVEN_MODULUS 102
803 #define BN_R_DIV_BY_ZERO 103
804 #define BN_R_ENCODING_ERROR 104
805 #define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA 105
806 #define BN_R_INPUT_NOT_REDUCED 110
807 #define BN_R_INVALID_LENGTH 106
808 #define BN_R_INVALID_RANGE 115
809 #define BN_R_NOT_A_SQUARE 111
810 #define BN_R_NOT_INITIALIZED 107
811 #define BN_R_NO_INVERSE 108
812 #define BN_R_NO_SOLUTION 116
813 #define BN_R_P_IS_NOT_PRIME 112
814 #define BN_R_TOO_MANY_ITERATIONS 113
815 #define BN_R_TOO_MANY_TEMPORARY_VARIABLES 109