6bccbfe45a0e84528c26ecf2fb2a47a1f0e6d3c6
[openssl.git] / crypto / bn / bn.h
1 /* crypto/bn/bn.h */
2 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111 /* ====================================================================
112  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
113  *
114  * Portions of the attached software ("Contribution") are developed by 
115  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
116  *
117  * The Contribution is licensed pursuant to the Eric Young open source
118  * license provided above.
119  *
120  * The binary polynomial arithmetic software is originally written by 
121  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
122  *
123  */
124
125 #ifndef HEADER_BN_H
126 #define HEADER_BN_H
127
128 #include <openssl/e_os2.h>
129 #ifndef OPENSSL_NO_FP_API
130 #include <stdio.h> /* FILE */
131 #endif
132 #include <openssl/ossl_typ.h>
133 #include <openssl/crypto.h>
134
135 #ifdef  __cplusplus
136 extern "C" {
137 #endif
138
139 /* These preprocessor symbols control various aspects of the bignum headers and
140  * library code. They're not defined by any "normal" configuration, as they are
141  * intended for development and testing purposes. NB: defining all three can be
142  * useful for debugging application code as well as openssl itself.
143  *
144  * BN_DEBUG - turn on various debugging alterations to the bignum code
145  * BN_DEBUG_RAND - uses random poisoning of unused words to trip up
146  * mismanagement of bignum internals. You must also define BN_DEBUG.
147  */
148 /* #define BN_DEBUG */
149 /* #define BN_DEBUG_RAND */
150
151 #ifndef OPENSSL_SMALL_FOOTPRINT
152 #define BN_MUL_COMBA
153 #define BN_SQR_COMBA
154 #define BN_RECURSION
155 #endif
156
157 /* This next option uses the C libraries (2 word)/(1 word) function.
158  * If it is not defined, I use my C version (which is slower).
159  * The reason for this flag is that when the particular C compiler
160  * library routine is used, and the library is linked with a different
161  * compiler, the library is missing.  This mostly happens when the
162  * library is built with gcc and then linked using normal cc.  This would
163  * be a common occurrence because gcc normally produces code that is
164  * 2 times faster than system compilers for the big number stuff.
165  * For machines with only one compiler (or shared libraries), this should
166  * be on.  Again this in only really a problem on machines
167  * using "long long's", are 32bit, and are not using my assembler code. */
168 #if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || \
169     defined(OPENSSL_SYS_WIN32) || defined(linux)
170 # ifndef BN_DIV2W
171 #  define BN_DIV2W
172 # endif
173 #endif
174
175 /* assuming long is 64bit - this is the DEC Alpha
176  * unsigned long long is only 64 bits :-(, don't define
177  * BN_LLONG for the DEC Alpha */
178 #ifdef SIXTY_FOUR_BIT_LONG
179 #define BN_ULLONG       unsigned long long
180 #define BN_ULONG        unsigned long
181 #define BN_LONG         long
182 #define BN_BITS         128
183 #define BN_BYTES        8
184 #define BN_BITS2        64
185 #define BN_BITS4        32
186 #define BN_MASK         (0xffffffffffffffffffffffffffffffffLL)
187 #define BN_MASK2        (0xffffffffffffffffL)
188 #define BN_MASK2l       (0xffffffffL)
189 #define BN_MASK2h       (0xffffffff00000000L)
190 #define BN_MASK2h1      (0xffffffff80000000L)
191 #define BN_TBIT         (0x8000000000000000L)
192 #define BN_DEC_CONV     (10000000000000000000UL)
193 #define BN_DEC_FMT1     "%lu"
194 #define BN_DEC_FMT2     "%019lu"
195 #define BN_DEC_NUM      19
196 #define BN_HEX_FMT1     "%lX"
197 #define BN_HEX_FMT2     "%016lX"
198 #endif
199
200 /* This is where the long long data type is 64 bits, but long is 32.
201  * For machines where there are 64bit registers, this is the mode to use.
202  * IRIX, on R4000 and above should use this mode, along with the relevant
203  * assembler code :-).  Do NOT define BN_LLONG.
204  */
205 #ifdef SIXTY_FOUR_BIT
206 #undef BN_LLONG
207 #undef BN_ULLONG
208 #define BN_ULONG        unsigned long long
209 #define BN_LONG         long long
210 #define BN_BITS         128
211 #define BN_BYTES        8
212 #define BN_BITS2        64
213 #define BN_BITS4        32
214 #define BN_MASK2        (0xffffffffffffffffLL)
215 #define BN_MASK2l       (0xffffffffL)
216 #define BN_MASK2h       (0xffffffff00000000LL)
217 #define BN_MASK2h1      (0xffffffff80000000LL)
218 #define BN_TBIT         (0x8000000000000000LL)
219 #define BN_DEC_CONV     (10000000000000000000ULL)
220 #define BN_DEC_FMT1     "%llu"
221 #define BN_DEC_FMT2     "%019llu"
222 #define BN_DEC_NUM      19
223 #define BN_HEX_FMT1     "%llX"
224 #define BN_HEX_FMT2     "%016llX"
225 #endif
226
227 #ifdef THIRTY_TWO_BIT
228 #ifdef BN_LLONG
229 # if defined(_WIN32) && !defined(__GNUC__)
230 #  define BN_ULLONG     unsigned __int64
231 #  define BN_MASK       (0xffffffffffffffffI64)
232 # else
233 #  define BN_ULLONG     unsigned long long
234 #  define BN_MASK       (0xffffffffffffffffLL)
235 # endif
236 #endif
237 #define BN_ULONG        unsigned int
238 #define BN_LONG         int
239 #define BN_BITS         64
240 #define BN_BYTES        4
241 #define BN_BITS2        32
242 #define BN_BITS4        16
243 #define BN_MASK2        (0xffffffffL)
244 #define BN_MASK2l       (0xffff)
245 #define BN_MASK2h1      (0xffff8000L)
246 #define BN_MASK2h       (0xffff0000L)
247 #define BN_TBIT         (0x80000000L)
248 #define BN_DEC_CONV     (1000000000L)
249 #define BN_DEC_FMT1     "%u"
250 #define BN_DEC_FMT2     "%09u"
251 #define BN_DEC_NUM      9
252 #define BN_HEX_FMT1     "%X"
253 #define BN_HEX_FMT2     "%08X"
254 #endif
255
256 #define BN_DEFAULT_BITS 1280
257
258 #define BN_FLG_MALLOCED         0x01
259 #define BN_FLG_STATIC_DATA      0x02
260 #define BN_FLG_CONSTTIME        0x04 /* avoid leaking exponent information through timing,
261                                       * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
262                                       * BN_div() will call BN_div_no_branch,
263                                       * BN_mod_inverse() will call BN_mod_inverse_no_branch.
264                                       */
265
266 #ifndef OPENSSL_NO_DEPRECATED
267 #define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME /* deprecated name for the flag */
268                                       /* avoid leaking exponent information through timings
269                                       * (BN_mod_exp_mont() will call BN_mod_exp_mont_consttime) */
270 #endif
271
272 #ifndef OPENSSL_NO_DEPRECATED
273 #define BN_FLG_FREE             0x8000  /* used for debuging */
274 #endif
275
276 void BN_set_flags(BIGNUM *b, int n);
277 int BN_get_flags(const BIGNUM *b, int n);
278
279 /* get a clone of a BIGNUM with changed flags, for *temporary* use only
280  * (the two BIGNUMs cannot not be used in parallel!) */
281 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int n);
282
283
284 /* Already declared in ossl_typ.h */
285 #if 0
286 typedef struct bignum_st BIGNUM;
287 /* Used for temp variables (declaration hidden in bn_lcl.h) */
288 typedef struct bignum_ctx BN_CTX;
289 typedef struct bn_blinding_st BN_BLINDING;
290 typedef struct bn_mont_ctx_st BN_MONT_CTX;
291 typedef struct bn_recp_ctx_st BN_RECP_CTX;
292 typedef struct bn_gencb_st BN_GENCB;
293 #endif
294
295 /* Wrapper function to make using BN_GENCB easier,  */
296 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
297
298 BN_GENCB *BN_GENCB_new(void);
299 void BN_GENCB_free(BN_GENCB *cb);
300
301 /* Populate a BN_GENCB structure with an "old"-style callback */
302 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback)(int, int, void *), void *cb_arg);
303
304 /* Populate a BN_GENCB structure with a "new"-style callback */
305 void BN_GENCB_set(BN_GENCB *gencb, int (*callback)(int, int, BN_GENCB *), void *cb_arg);
306
307
308 void *BN_GENCB_get_arg(BN_GENCB *cb);
309
310 #define BN_prime_checks 0 /* default: select number of iterations
311                              based on the size of the number */
312
313 /* number of Miller-Rabin iterations for an error rate  of less than 2^-80
314  * for random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook
315  * of Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
316  * original paper: Damgaard, Landrock, Pomerance: Average case error estimates
317  * for the strong probable prime test. -- Math. Comp. 61 (1993) 177-194) */
318 #define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
319                                 (b) >=  850 ?  3 : \
320                                 (b) >=  650 ?  4 : \
321                                 (b) >=  550 ?  5 : \
322                                 (b) >=  450 ?  6 : \
323                                 (b) >=  400 ?  7 : \
324                                 (b) >=  350 ?  8 : \
325                                 (b) >=  300 ?  9 : \
326                                 (b) >=  250 ? 12 : \
327                                 (b) >=  200 ? 15 : \
328                                 (b) >=  150 ? 18 : \
329                                 /* b >= 100 */ 27)
330
331 #define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
332
333
334 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
335 int BN_is_zero(const BIGNUM *a);
336 int BN_is_one(const BIGNUM *a);
337 int BN_is_word(const BIGNUM *a, const BN_ULONG w);
338 int BN_is_odd(const BIGNUM *a);
339
340
341 #define BN_one(a)       (BN_set_word((a),1))
342
343 void BN_zero_ex(BIGNUM *a);
344
345 #ifdef OPENSSL_NO_DEPRECATED
346 #define BN_zero(a)      BN_zero_ex(a)
347 #else
348 #define BN_zero(a)      (BN_set_word((a),0))
349 #endif
350
351 const BIGNUM *BN_value_one(void);
352 char *  BN_options(void);
353 BN_CTX *BN_CTX_new(void);
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 l);
364 int     BN_security_bits(int L, int N);
365 BIGNUM *BN_new(void);
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 
382  */
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
387  */
388 int     BN_is_negative(const BIGNUM *b);
389
390 int     BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
391         BN_CTX *ctx);
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);
405
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);
413
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);
420
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);
434
435 int     BN_mask_bits(BIGNUM *a,int n);
436 #ifndef OPENSSL_NO_FP_API
437 int     BN_print_fp(FILE *fp, const BIGNUM *a);
438 #endif
439 #ifdef HEADER_BIO_H
440 int     BN_print(BIO *fp, const BIGNUM *a);
441 #else
442 int     BN_print(void *fp, const BIGNUM *a);
443 #endif
444 int     BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
445 int     BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
446 int     BN_rshift1(BIGNUM *r, const BIGNUM *a);
447 void    BN_clear(BIGNUM *a);
448 BIGNUM *BN_dup(const BIGNUM *a);
449 int     BN_ucmp(const BIGNUM *a, const BIGNUM *b);
450 int     BN_set_bit(BIGNUM *a, int n);
451 int     BN_clear_bit(BIGNUM *a, int n);
452 char *  BN_bn2hex(const BIGNUM *a);
453 char *  BN_bn2dec(const BIGNUM *a);
454 int     BN_hex2bn(BIGNUM **a, const char *str);
455 int     BN_dec2bn(BIGNUM **a, const char *str);
456 int     BN_asc2bn(BIGNUM **a, const char *str);
457 int     BN_gcd(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx);
458 int     BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */
459 BIGNUM *BN_mod_inverse(BIGNUM *ret,
460         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
461 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
462         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
463
464 void    BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
465
466 /* Deprecated versions */
467 #ifndef OPENSSL_NO_DEPRECATED
468 BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe,
469         const BIGNUM *add, const BIGNUM *rem,
470         void (*callback)(int,int,void *),void *cb_arg);
471 int     BN_is_prime(const BIGNUM *p,int nchecks,
472         void (*callback)(int,int,void *),
473         BN_CTX *ctx,void *cb_arg);
474 int     BN_is_prime_fasttest(const BIGNUM *p,int nchecks,
475         void (*callback)(int,int,void *),BN_CTX *ctx,void *cb_arg,
476         int do_trial_division);
477 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
478
479 /* Newer versions */
480 int     BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add,
481                 const BIGNUM *rem, BN_GENCB *cb);
482 int     BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb);
483 int     BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx,
484                 int do_trial_division, BN_GENCB *cb);
485
486 int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
487
488 int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
489                         const BIGNUM *Xp, const BIGNUM *Xp1, const BIGNUM *Xp2,
490                         const BIGNUM *e, BN_CTX *ctx, BN_GENCB *cb);
491 int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
492                         BIGNUM *Xp1, BIGNUM *Xp2,
493                         const BIGNUM *Xp,
494                         const BIGNUM *e, BN_CTX *ctx,
495                         BN_GENCB *cb);
496
497 BN_MONT_CTX *BN_MONT_CTX_new(void );
498 int BN_mod_mul_montgomery(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,
499         BN_MONT_CTX *mont, BN_CTX *ctx);
500 int BN_to_montgomery(BIGNUM *r,const BIGNUM *a, BN_MONT_CTX *mont, BN_CTX *ctx);
501 int BN_from_montgomery(BIGNUM *r,const BIGNUM *a,
502         BN_MONT_CTX *mont, BN_CTX *ctx);
503 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
504 int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *mod,BN_CTX *ctx);
505 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from);
506 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
507                                         const BIGNUM *mod, BN_CTX *ctx);
508
509 /* BN_BLINDING flags */
510 #define BN_BLINDING_NO_UPDATE   0x00000001
511 #define BN_BLINDING_NO_RECREATE 0x00000002
512
513 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
514 void BN_BLINDING_free(BN_BLINDING *b);
515 int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
516 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
517 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
518 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
519 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *);
520 #ifndef OPENSSL_NO_DEPRECATED
521 unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
522 void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
523 #endif
524 CRYPTO_THREADID *BN_BLINDING_thread_id(BN_BLINDING *);
525 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
526 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
527 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
528         const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
529         int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
530                           const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
531         BN_MONT_CTX *m_ctx);
532
533 #ifndef OPENSSL_NO_DEPRECATED
534 void BN_set_params(int mul,int high,int low,int mont);
535 int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */
536 #endif
537
538 BN_RECP_CTX *BN_RECP_CTX_new(void);
539 void    BN_RECP_CTX_free(BN_RECP_CTX *recp);
540 int     BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx);
541 int     BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
542         BN_RECP_CTX *recp,BN_CTX *ctx);
543 int     BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
544         const BIGNUM *m, BN_CTX *ctx);
545 int     BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
546         BN_RECP_CTX *recp, BN_CTX *ctx);
547
548 #ifndef OPENSSL_NO_EC2M
549
550 /* Functions for arithmetic over binary polynomials represented by BIGNUMs. 
551  *
552  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
553  * ignored.
554  *
555  * Note that input arguments are not const so that their bit arrays can
556  * be expanded to the appropriate size if needed.
557  */
558
559 int     BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); /*r = a + b*/
560 #define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
561 int     BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p); /*r=a mod p*/
562 int     BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
563         const BIGNUM *p, BN_CTX *ctx); /* r = (a * b) mod p */
564 int     BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
565         BN_CTX *ctx); /* r = (a * a) mod p */
566 int     BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p,
567         BN_CTX *ctx); /* r = (1 / b) mod p */
568 int     BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
569         const BIGNUM *p, BN_CTX *ctx); /* r = (a / b) mod p */
570 int     BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
571         const BIGNUM *p, BN_CTX *ctx); /* r = (a ^ b) mod p */
572 int     BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
573         BN_CTX *ctx); /* r = sqrt(a) mod p */
574 int     BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
575         BN_CTX *ctx); /* r^2 + r = a mod p */
576 #define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
577 /* Some functions allow for representation of the irreducible polynomials
578  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
579  *     t^p[0] + t^p[1] + ... + t^p[k]
580  * where m = p[0] > p[1] > ... > p[k] = 0.
581  */
582 int     BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
583         /* r = a mod p */
584 int     BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
585         const int p[], BN_CTX *ctx); /* r = (a * b) mod p */
586 int     BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
587         BN_CTX *ctx); /* r = (a * a) mod p */
588 int     BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
589         BN_CTX *ctx); /* r = (1 / b) mod p */
590 int     BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
591         const int p[], BN_CTX *ctx); /* r = (a / b) mod p */
592 int     BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
593         const int p[], BN_CTX *ctx); /* r = (a ^ b) mod p */
594 int     BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
595         const int p[], BN_CTX *ctx); /* r = sqrt(a) mod p */
596 int     BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
597         const int p[], BN_CTX *ctx); /* r^2 + r = a mod p */
598 int     BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
599 int     BN_GF2m_arr2poly(const int p[], BIGNUM *a);
600
601 #endif
602
603 /* faster mod functions for the 'NIST primes' 
604  * 0 <= a < p^2 */
605 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
606 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
607 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
608 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
609 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
610
611 const BIGNUM *BN_get0_nist_prime_192(void);
612 const BIGNUM *BN_get0_nist_prime_224(void);
613 const BIGNUM *BN_get0_nist_prime_256(void);
614 const BIGNUM *BN_get0_nist_prime_384(void);
615 const BIGNUM *BN_get0_nist_prime_521(void);
616
617 int (*BN_nist_mod_func(const BIGNUM *p))(BIGNUM *r, const BIGNUM *a, const BIGNUM *field, BN_CTX *ctx);
618
619 int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range, const BIGNUM *priv,
620                           const unsigned char *message, size_t message_len,
621                           BN_CTX *ctx);
622
623
624 /* Primes from RFC 2409 */
625 BIGNUM *get_rfc2409_prime_768(BIGNUM *bn);
626 BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn);
627
628 /* Primes from RFC 3526 */
629 BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn);
630 BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn);
631 BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn);
632 BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn);
633 BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn);
634 BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn);
635
636 int BN_bntest_rand(BIGNUM *rnd, int bits, int top,int bottom);
637
638
639 /* BEGIN ERROR CODES */
640 /* The following lines are auto generated by the script mkerr.pl. Any changes
641  * made after this point may be overwritten when the script is next run.
642  */
643 void ERR_load_BN_strings(void);
644
645 /* Error codes for the BN functions. */
646
647 /* Function codes. */
648 #define BN_F_BNRAND                                      127
649 #define BN_F_BN_BLINDING_CONVERT_EX                      100
650 #define BN_F_BN_BLINDING_CREATE_PARAM                    128
651 #define BN_F_BN_BLINDING_INVERT_EX                       101
652 #define BN_F_BN_BLINDING_NEW                             102
653 #define BN_F_BN_BLINDING_UPDATE                          103
654 #define BN_F_BN_BN2DEC                                   104
655 #define BN_F_BN_BN2HEX                                   105
656 #define BN_F_BN_COMPUTE_WNAF                             142
657 #define BN_F_BN_CTX_GET                                  116
658 #define BN_F_BN_CTX_NEW                                  106
659 #define BN_F_BN_CTX_START                                129
660 #define BN_F_BN_DIV                                      107
661 #define BN_F_BN_DIV_NO_BRANCH                            138
662 #define BN_F_BN_DIV_RECP                                 130
663 #define BN_F_BN_EXP                                      123
664 #define BN_F_BN_EXPAND2                                  108
665 #define BN_F_BN_EXPAND_INTERNAL                          120
666 #define BN_F_BN_GENCB_NEW                                143
667 #define BN_F_BN_GENERATE_DSA_NONCE                       140
668 #define BN_F_BN_GENERATE_PRIME_EX                        141
669 #define BN_F_BN_GF2M_MOD                                 131
670 #define BN_F_BN_GF2M_MOD_EXP                             132
671 #define BN_F_BN_GF2M_MOD_MUL                             133
672 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD                      134
673 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                  135
674 #define BN_F_BN_GF2M_MOD_SQR                             136
675 #define BN_F_BN_GF2M_MOD_SQRT                            137
676 #define BN_F_BN_MOD_EXP2_MONT                            118
677 #define BN_F_BN_MOD_EXP_MONT                             109
678 #define BN_F_BN_MOD_EXP_MONT_CONSTTIME                   124
679 #define BN_F_BN_MOD_EXP_MONT_WORD                        117
680 #define BN_F_BN_MOD_EXP_RECP                             125
681 #define BN_F_BN_MOD_EXP_SIMPLE                           126
682 #define BN_F_BN_MOD_INVERSE                              110
683 #define BN_F_BN_MOD_INVERSE_NO_BRANCH                    139
684 #define BN_F_BN_MOD_LSHIFT_QUICK                         119
685 #define BN_F_BN_MOD_MUL_RECIPROCAL                       111
686 #define BN_F_BN_MOD_SQRT                                 121
687 #define BN_F_BN_MPI2BN                                   112
688 #define BN_F_BN_NEW                                      113
689 #define BN_F_BN_RAND                                     114
690 #define BN_F_BN_RAND_RANGE                               122
691 #define BN_F_BN_USUB                                     115
692
693 /* Reason codes. */
694 #define BN_R_ARG2_LT_ARG3                                100
695 #define BN_R_BAD_RECIPROCAL                              101
696 #define BN_R_BIGNUM_TOO_LONG                             114
697 #define BN_R_BITS_TOO_SMALL                              118
698 #define BN_R_CALLED_WITH_EVEN_MODULUS                    102
699 #define BN_R_DIV_BY_ZERO                                 103
700 #define BN_R_ENCODING_ERROR                              104
701 #define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA                105
702 #define BN_R_INPUT_NOT_REDUCED                           110
703 #define BN_R_INVALID_LENGTH                              106
704 #define BN_R_INVALID_RANGE                               115
705 #define BN_R_NOT_A_SQUARE                                111
706 #define BN_R_NOT_INITIALIZED                             107
707 #define BN_R_NO_INVERSE                                  108
708 #define BN_R_NO_SOLUTION                                 116
709 #define BN_R_PRIVATE_KEY_TOO_LARGE                       117
710 #define BN_R_P_IS_NOT_PRIME                              112
711 #define BN_R_TOO_MANY_ITERATIONS                         113
712 #define BN_R_TOO_MANY_TEMPORARY_VARIABLES                109
713
714 #ifdef  __cplusplus
715 }
716 #endif
717 #endif