Move more BN internals to bn_lcl.h
[openssl.git] / include / openssl / bn.h
1 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57 /* ====================================================================
58  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  *    notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  *    notice, this list of conditions and the following disclaimer in
69  *    the documentation and/or other materials provided with the
70  *    distribution.
71  *
72  * 3. All advertising materials mentioning features or use of this
73  *    software must display the following acknowledgment:
74  *    "This product includes software developed by the OpenSSL Project
75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76  *
77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78  *    endorse or promote products derived from this software without
79  *    prior written permission. For written permission, please contact
80  *    openssl-core@openssl.org.
81  *
82  * 5. Products derived from this software may not be called "OpenSSL"
83  *    nor may "OpenSSL" appear in their names without prior written
84  *    permission of the OpenSSL Project.
85  *
86  * 6. Redistributions of any form whatsoever must retain the following
87  *    acknowledgment:
88  *    "This product includes software developed by the OpenSSL Project
89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90  *
91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102  * OF THE POSSIBILITY OF SUCH DAMAGE.
103  * ====================================================================
104  *
105  * This product includes cryptographic software written by Eric Young
106  * (eay@cryptsoft.com).  This product includes software written by Tim
107  * Hudson (tjh@cryptsoft.com).
108  *
109  */
110 /* ====================================================================
111  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
112  *
113  * Portions of the attached software ("Contribution") are developed by
114  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
115  *
116  * The Contribution is licensed pursuant to the Eric Young open source
117  * license provided above.
118  *
119  * The binary polynomial arithmetic software is originally written by
120  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
121  *
122  */
123
124 #ifndef HEADER_BN_H
125 # define HEADER_BN_H
126
127 # include <openssl/e_os2.h>
128 # ifndef OPENSSL_NO_STDIO
129 #  include <stdio.h>            /* FILE */
130 # endif
131 # include <openssl/opensslconf.h>
132 # include <openssl/ossl_typ.h>
133 # include <openssl/crypto.h>
134
135 #ifdef  __cplusplus
136 extern "C" {
137 #endif
138
139 /*
140  * 64-bit processor with LP64 ABI
141  */
142 # ifdef SIXTY_FOUR_BIT_LONG
143 #  define BN_ULONG        unsigned long
144 #  define BN_BYTES        8
145 # endif
146
147 /*
148  * 64-bit processor other than LP64 ABI
149  */
150 # ifdef SIXTY_FOUR_BIT
151 #  define BN_ULONG        unsigned long long
152 #  define BN_BYTES        8
153 # endif
154
155 # ifdef THIRTY_TWO_BIT
156 #  define BN_ULONG        unsigned int
157 #  define BN_BYTES        4
158 # endif
159
160 # define BN_BITS2       (BN_BYTES * 8)
161 # define BN_BITS        (BN_BITS2 * 2)
162 # define BN_TBIT        ((BN_ULONG)1 << (BN_BITS2 - 1))
163
164 # define BN_FLG_MALLOCED         0x01
165 # define BN_FLG_STATIC_DATA      0x02
166
167 /*
168  * avoid leaking exponent information through timing,
169  * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
170  * BN_div() will call BN_div_no_branch,
171  * BN_mod_inverse() will call BN_mod_inverse_no_branch.
172  */
173 # define BN_FLG_CONSTTIME        0x04
174 # define BN_FLG_SECURE           0x08
175
176 # if OPENSSL_API_COMPAT < 0x00908000L
177 /* deprecated name for the flag */
178 #  define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME
179 #  define BN_FLG_FREE            0x8000 /* used for debuging */
180 # endif
181
182 void BN_set_flags(BIGNUM *b, int n);
183 int BN_get_flags(const BIGNUM *b, int n);
184
185 /*
186  * get a clone of a BIGNUM with changed flags, for *temporary* use only (the
187  * two BIGNUMs cannot be used in parallel!). Also only for *read only* use. The
188  * value |dest| should be a newly allocated BIGNUM obtained via BN_new() that
189  * has not been otherwise initialised or used.
190  */
191 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags);
192
193 /* Wrapper function to make using BN_GENCB easier,  */
194 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
195
196 BN_GENCB *BN_GENCB_new(void);
197 void BN_GENCB_free(BN_GENCB *cb);
198
199 /* Populate a BN_GENCB structure with an "old"-style callback */
200 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
201                       void *cb_arg);
202
203 /* Populate a BN_GENCB structure with a "new"-style callback */
204 void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
205                   void *cb_arg);
206
207 void *BN_GENCB_get_arg(BN_GENCB *cb);
208
209 # define BN_prime_checks 0      /* default: select number of iterations based
210                                  * on the size of the number */
211
212 /*
213  * number of Miller-Rabin iterations for an error rate of less than 2^-80 for
214  * random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook of
215  * Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
216  * original paper: Damgaard, Landrock, Pomerance: Average case error
217  * estimates for the strong probable prime test. -- Math. Comp. 61 (1993)
218  * 177-194)
219  */
220 # define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
221                                 (b) >=  850 ?  3 : \
222                                 (b) >=  650 ?  4 : \
223                                 (b) >=  550 ?  5 : \
224                                 (b) >=  450 ?  6 : \
225                                 (b) >=  400 ?  7 : \
226                                 (b) >=  350 ?  8 : \
227                                 (b) >=  300 ?  9 : \
228                                 (b) >=  250 ? 12 : \
229                                 (b) >=  200 ? 15 : \
230                                 (b) >=  150 ? 18 : \
231                                 /* b >= 100 */ 27)
232
233 # define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
234
235 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
236 int BN_is_zero(const BIGNUM *a);
237 int BN_is_one(const BIGNUM *a);
238 int BN_is_word(const BIGNUM *a, const BN_ULONG w);
239 int BN_is_odd(const BIGNUM *a);
240
241 # define BN_one(a)       (BN_set_word((a),1))
242
243 void BN_zero_ex(BIGNUM *a);
244
245 # if OPENSSL_API_COMPAT >= 0x00908000L
246 #  define BN_zero(a)      BN_zero_ex(a)
247 # else
248 #  define BN_zero(a)      (BN_set_word((a),0))
249 # endif
250
251 const BIGNUM *BN_value_one(void);
252 char *BN_options(void);
253 BN_CTX *BN_CTX_new(void);
254 BN_CTX *BN_CTX_secure_new(void);
255 void BN_CTX_free(BN_CTX *c);
256 void BN_CTX_start(BN_CTX *ctx);
257 BIGNUM *BN_CTX_get(BN_CTX *ctx);
258 void BN_CTX_end(BN_CTX *ctx);
259 int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
260 int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
261 int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
262 int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
263 int BN_num_bits(const BIGNUM *a);
264 int BN_num_bits_word(BN_ULONG l);
265 int BN_security_bits(int L, int N);
266 BIGNUM *BN_new(void);
267 BIGNUM *BN_secure_new(void);
268 void BN_clear_free(BIGNUM *a);
269 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
270 void BN_swap(BIGNUM *a, BIGNUM *b);
271 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
272 int BN_bn2bin(const BIGNUM *a, unsigned char *to);
273 BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
274 int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
275 int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
276 int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
277 int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
278 int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
279 int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
280 int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
281 /** BN_set_negative sets sign of a BIGNUM
282  * \param  b  pointer to the BIGNUM object
283  * \param  n  0 if the BIGNUM b should be positive and a value != 0 otherwise
284  */
285 void BN_set_negative(BIGNUM *b, int n);
286 /** BN_is_negative returns 1 if the BIGNUM is negative
287  * \param  a  pointer to the BIGNUM object
288  * \return 1 if a < 0 and 0 otherwise
289  */
290 int BN_is_negative(const BIGNUM *b);
291
292 int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
293            BN_CTX *ctx);
294 # define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
295 int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
296 int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
297                BN_CTX *ctx);
298 int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
299                      const BIGNUM *m);
300 int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
301                BN_CTX *ctx);
302 int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
303                      const BIGNUM *m);
304 int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
305                BN_CTX *ctx);
306 int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
307 int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
308 int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
309 int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m,
310                   BN_CTX *ctx);
311 int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
312
313 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
314 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
315 int BN_mul_word(BIGNUM *a, BN_ULONG w);
316 int BN_add_word(BIGNUM *a, BN_ULONG w);
317 int BN_sub_word(BIGNUM *a, BN_ULONG w);
318 int BN_set_word(BIGNUM *a, BN_ULONG w);
319 BN_ULONG BN_get_word(const BIGNUM *a);
320
321 int BN_cmp(const BIGNUM *a, const BIGNUM *b);
322 void BN_free(BIGNUM *a);
323 int BN_is_bit_set(const BIGNUM *a, int n);
324 int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
325 int BN_lshift1(BIGNUM *r, const BIGNUM *a);
326 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
327
328 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
329                const BIGNUM *m, BN_CTX *ctx);
330 int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
331                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
332 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
333                               const BIGNUM *m, BN_CTX *ctx,
334                               BN_MONT_CTX *in_mont);
335 int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
336                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
337 int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
338                      const BIGNUM *a2, const BIGNUM *p2, const BIGNUM *m,
339                      BN_CTX *ctx, BN_MONT_CTX *m_ctx);
340 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
341                       const BIGNUM *m, BN_CTX *ctx);
342
343 int BN_mask_bits(BIGNUM *a, int n);
344 # ifndef OPENSSL_NO_STDIO
345 int BN_print_fp(FILE *fp, const BIGNUM *a);
346 # endif
347 int BN_print(BIO *bio, const BIGNUM *a);
348 int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
349 int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
350 int BN_rshift1(BIGNUM *r, const BIGNUM *a);
351 void BN_clear(BIGNUM *a);
352 BIGNUM *BN_dup(const BIGNUM *a);
353 int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
354 int BN_set_bit(BIGNUM *a, int n);
355 int BN_clear_bit(BIGNUM *a, int n);
356 char *BN_bn2hex(const BIGNUM *a);
357 char *BN_bn2dec(const BIGNUM *a);
358 int BN_hex2bn(BIGNUM **a, const char *str);
359 int BN_dec2bn(BIGNUM **a, const char *str);
360 int BN_asc2bn(BIGNUM **a, const char *str);
361 int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
362 int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); /* returns
363                                                                   * -2 for
364                                                                   * error */
365 BIGNUM *BN_mod_inverse(BIGNUM *ret,
366                        const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
367 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
368                     const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
369
370 void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
371
372 /* Deprecated versions */
373 DEPRECATEDIN_0_9_8(BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
374                                              const BIGNUM *add,
375                                              const BIGNUM *rem,
376                                              void (*callback) (int, int,
377                                                                void *),
378                                              void *cb_arg))
379 DEPRECATEDIN_0_9_8(int
380                    BN_is_prime(const BIGNUM *p, int nchecks,
381                                void (*callback) (int, int, void *),
382                                BN_CTX *ctx, void *cb_arg))
383 DEPRECATEDIN_0_9_8(int
384                    BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
385                                         void (*callback) (int, int, void *),
386                                         BN_CTX *ctx, void *cb_arg,
387                                         int do_trial_division))
388
389 /* Newer versions */
390 int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
391                          const BIGNUM *rem, BN_GENCB *cb);
392 int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
393 int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
394                             int do_trial_division, BN_GENCB *cb);
395
396 int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
397
398 int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
399                             const BIGNUM *Xp, const BIGNUM *Xp1,
400                             const BIGNUM *Xp2, const BIGNUM *e, BN_CTX *ctx,
401                             BN_GENCB *cb);
402 int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, BIGNUM *Xp1,
403                               BIGNUM *Xp2, const BIGNUM *Xp, const BIGNUM *e,
404                               BN_CTX *ctx, BN_GENCB *cb);
405
406 BN_MONT_CTX *BN_MONT_CTX_new(void);
407 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
408                           BN_MONT_CTX *mont, BN_CTX *ctx);
409 int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
410                      BN_CTX *ctx);
411 int BN_from_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
412                        BN_CTX *ctx);
413 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
414 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx);
415 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
416 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
417                                     const BIGNUM *mod, BN_CTX *ctx);
418
419 /* BN_BLINDING flags */
420 # define BN_BLINDING_NO_UPDATE   0x00000001
421 # define BN_BLINDING_NO_RECREATE 0x00000002
422
423 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
424 void BN_BLINDING_free(BN_BLINDING *b);
425 int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
426 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
427 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
428 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
429 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
430                           BN_CTX *);
431 DEPRECATEDIN_1_0_0(unsigned long
432                    BN_BLINDING_get_thread_id(const BN_BLINDING *))
433 DEPRECATEDIN_1_0_0(void
434                    BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long))
435 CRYPTO_THREADID *BN_BLINDING_thread_id(BN_BLINDING *);
436 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
437 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
438 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
439                                       const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
440                                       int (*bn_mod_exp) (BIGNUM *r,
441                                                          const BIGNUM *a,
442                                                          const BIGNUM *p,
443                                                          const BIGNUM *m,
444                                                          BN_CTX *ctx,
445                                                          BN_MONT_CTX *m_ctx),
446                                       BN_MONT_CTX *m_ctx);
447
448 DEPRECATEDIN_0_9_8(void BN_set_params(int mul, int high, int low, int mont))
449 DEPRECATEDIN_0_9_8(int BN_get_params(int which)) /* 0, mul, 1 high, 2 low, 3
450                                                   * mont */
451
452 BN_RECP_CTX *BN_RECP_CTX_new(void);
453 void BN_RECP_CTX_free(BN_RECP_CTX *recp);
454 int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
455 int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
456                           BN_RECP_CTX *recp, BN_CTX *ctx);
457 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
458                     const BIGNUM *m, BN_CTX *ctx);
459 int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
460                 BN_RECP_CTX *recp, BN_CTX *ctx);
461
462 # ifndef OPENSSL_NO_EC2M
463
464 /*
465  * Functions for arithmetic over binary polynomials represented by BIGNUMs.
466  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
467  * ignored. Note that input arguments are not const so that their bit arrays
468  * can be expanded to the appropriate size if needed.
469  */
470
471 /*
472  * r = a + b
473  */
474 int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
475 #  define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
476 /*
477  * r=a mod p
478  */
479 int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p);
480 /* r = (a * b) mod p */
481 int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
482                     const BIGNUM *p, BN_CTX *ctx);
483 /* r = (a * a) mod p */
484 int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
485 /* r = (1 / b) mod p */
486 int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx);
487 /* r = (a / b) mod p */
488 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
489                     const BIGNUM *p, BN_CTX *ctx);
490 /* r = (a ^ b) mod p */
491 int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
492                     const BIGNUM *p, BN_CTX *ctx);
493 /* r = sqrt(a) mod p */
494 int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
495                      BN_CTX *ctx);
496 /* r^2 + r = a mod p */
497 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
498                            BN_CTX *ctx);
499 #  define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
500 /*-
501  * Some functions allow for representation of the irreducible polynomials
502  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
503  *     t^p[0] + t^p[1] + ... + t^p[k]
504  * where m = p[0] > p[1] > ... > p[k] = 0.
505  */
506 /* r = a mod p */
507 int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
508 /* r = (a * b) mod p */
509 int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
510                         const int p[], BN_CTX *ctx);
511 /* r = (a * a) mod p */
512 int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
513                         BN_CTX *ctx);
514 /* r = (1 / b) mod p */
515 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
516                         BN_CTX *ctx);
517 /* r = (a / b) mod p */
518 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
519                         const int p[], BN_CTX *ctx);
520 /* r = (a ^ b) mod p */
521 int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
522                         const int p[], BN_CTX *ctx);
523 /* r = sqrt(a) mod p */
524 int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
525                          const int p[], BN_CTX *ctx);
526 /* r^2 + r = a mod p */
527 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
528                                const int p[], BN_CTX *ctx);
529 int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
530 int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
531
532 # endif
533
534 /*
535  * faster mod functions for the 'NIST primes' 0 <= a < p^2
536  */
537 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
538 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
539 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
540 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
541 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
542
543 const BIGNUM *BN_get0_nist_prime_192(void);
544 const BIGNUM *BN_get0_nist_prime_224(void);
545 const BIGNUM *BN_get0_nist_prime_256(void);
546 const BIGNUM *BN_get0_nist_prime_384(void);
547 const BIGNUM *BN_get0_nist_prime_521(void);
548
549 int (*BN_nist_mod_func(const BIGNUM *p)) (BIGNUM *r, const BIGNUM *a,
550                                           const BIGNUM *field, BN_CTX *ctx);
551
552 int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
553                           const BIGNUM *priv, const unsigned char *message,
554                           size_t message_len, BN_CTX *ctx);
555
556 /* Primes from RFC 2409 */
557 BIGNUM *get_rfc2409_prime_768(BIGNUM *bn);
558 BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn);
559
560 /* Primes from RFC 3526 */
561 BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn);
562 BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn);
563 BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn);
564 BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn);
565 BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn);
566 BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn);
567
568 int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
569
570 /* BEGIN ERROR CODES */
571 /*
572  * The following lines are auto generated by the script mkerr.pl. Any changes
573  * made after this point may be overwritten when the script is next run.
574  */
575 void ERR_load_BN_strings(void);
576
577 /* Error codes for the BN functions. */
578
579 /* Function codes. */
580 # define BN_F_BNRAND                                      127
581 # define BN_F_BN_BLINDING_CONVERT_EX                      100
582 # define BN_F_BN_BLINDING_CREATE_PARAM                    128
583 # define BN_F_BN_BLINDING_INVERT_EX                       101
584 # define BN_F_BN_BLINDING_NEW                             102
585 # define BN_F_BN_BLINDING_UPDATE                          103
586 # define BN_F_BN_BN2DEC                                   104
587 # define BN_F_BN_BN2HEX                                   105
588 # define BN_F_BN_COMPUTE_WNAF                             142
589 # define BN_F_BN_CTX_GET                                  116
590 # define BN_F_BN_CTX_NEW                                  106
591 # define BN_F_BN_CTX_START                                129
592 # define BN_F_BN_DIV                                      107
593 # define BN_F_BN_DIV_NO_BRANCH                            138
594 # define BN_F_BN_DIV_RECP                                 130
595 # define BN_F_BN_EXP                                      123
596 # define BN_F_BN_EXPAND2                                  108
597 # define BN_F_BN_EXPAND_INTERNAL                          120
598 # define BN_F_BN_GENCB_NEW                                143
599 # define BN_F_BN_GENERATE_DSA_NONCE                       140
600 # define BN_F_BN_GENERATE_PRIME_EX                        141
601 # define BN_F_BN_GF2M_MOD                                 131
602 # define BN_F_BN_GF2M_MOD_EXP                             132
603 # define BN_F_BN_GF2M_MOD_MUL                             133
604 # define BN_F_BN_GF2M_MOD_SOLVE_QUAD                      134
605 # define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                  135
606 # define BN_F_BN_GF2M_MOD_SQR                             136
607 # define BN_F_BN_GF2M_MOD_SQRT                            137
608 # define BN_F_BN_LSHIFT                                   145
609 # define BN_F_BN_MOD_EXP2_MONT                            118
610 # define BN_F_BN_MOD_EXP_MONT                             109
611 # define BN_F_BN_MOD_EXP_MONT_CONSTTIME                   124
612 # define BN_F_BN_MOD_EXP_MONT_WORD                        117
613 # define BN_F_BN_MOD_EXP_RECP                             125
614 # define BN_F_BN_MOD_EXP_SIMPLE                           126
615 # define BN_F_BN_MOD_INVERSE                              110
616 # define BN_F_BN_MOD_INVERSE_NO_BRANCH                    139
617 # define BN_F_BN_MOD_LSHIFT_QUICK                         119
618 # define BN_F_BN_MOD_MUL_RECIPROCAL                       111
619 # define BN_F_BN_MOD_SQRT                                 121
620 # define BN_F_BN_MPI2BN                                   112
621 # define BN_F_BN_NEW                                      113
622 # define BN_F_BN_RAND                                     114
623 # define BN_F_BN_RAND_RANGE                               122
624 # define BN_F_BN_RSHIFT                                   146
625 # define BN_F_BN_SET_WORDS                                144
626 # define BN_F_BN_USUB                                     115
627
628 /* Reason codes. */
629 # define BN_R_ARG2_LT_ARG3                                100
630 # define BN_R_BAD_RECIPROCAL                              101
631 # define BN_R_BIGNUM_TOO_LONG                             114
632 # define BN_R_BITS_TOO_SMALL                              118
633 # define BN_R_CALLED_WITH_EVEN_MODULUS                    102
634 # define BN_R_DIV_BY_ZERO                                 103
635 # define BN_R_ENCODING_ERROR                              104
636 # define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA                105
637 # define BN_R_INPUT_NOT_REDUCED                           110
638 # define BN_R_INVALID_LENGTH                              106
639 # define BN_R_INVALID_RANGE                               115
640 # define BN_R_INVALID_SHIFT                               119
641 # define BN_R_NOT_A_SQUARE                                111
642 # define BN_R_NOT_INITIALIZED                             107
643 # define BN_R_NO_INVERSE                                  108
644 # define BN_R_NO_SOLUTION                                 116
645 # define BN_R_PRIVATE_KEY_TOO_LARGE                       117
646 # define BN_R_P_IS_NOT_PRIME                              112
647 # define BN_R_TOO_MANY_ITERATIONS                         113
648 # define BN_R_TOO_MANY_TEMPORARY_VARIABLES                109
649
650 #ifdef  __cplusplus
651 }
652 #endif
653 #endif