Import OpenSSL-0.9.8f.
[dragonfly.git] / crypto / openssl-0.9 / 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 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60  *
61  * Portions of the attached software ("Contribution") are developed by 
62  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
63  *
64  * The Contribution is licensed pursuant to the Eric Young open source
65  * license provided above.
66  *
67  * The binary polynomial arithmetic software is originally written by 
68  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
69  *
70  */
71
72 #ifndef HEADER_BN_H
73 #define HEADER_BN_H
74
75 #include <openssl/e_os2.h>
76 #ifndef OPENSSL_NO_FP_API
77 #include <stdio.h> /* FILE */
78 #endif
79 #include <openssl/ossl_typ.h>
80
81 #ifdef  __cplusplus
82 extern "C" {
83 #endif
84
85 /* These preprocessor symbols control various aspects of the bignum headers and
86  * library code. They're not defined by any "normal" configuration, as they are
87  * intended for development and testing purposes. NB: defining all three can be
88  * useful for debugging application code as well as openssl itself.
89  *
90  * BN_DEBUG - turn on various debugging alterations to the bignum code
91  * BN_DEBUG_RAND - uses random poisoning of unused words to trip up
92  * mismanagement of bignum internals. You must also define BN_DEBUG.
93  */
94 /* #define BN_DEBUG */
95 /* #define BN_DEBUG_RAND */
96
97 #define BN_MUL_COMBA
98 #define BN_SQR_COMBA
99 #define BN_RECURSION
100
101 /* This next option uses the C libraries (2 word)/(1 word) function.
102  * If it is not defined, I use my C version (which is slower).
103  * The reason for this flag is that when the particular C compiler
104  * library routine is used, and the library is linked with a different
105  * compiler, the library is missing.  This mostly happens when the
106  * library is built with gcc and then linked using normal cc.  This would
107  * be a common occurrence because gcc normally produces code that is
108  * 2 times faster than system compilers for the big number stuff.
109  * For machines with only one compiler (or shared libraries), this should
110  * be on.  Again this in only really a problem on machines
111  * using "long long's", are 32bit, and are not using my assembler code. */
112 #if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || \
113     defined(OPENSSL_SYS_WIN32) || defined(linux)
114 # ifndef BN_DIV2W
115 #  define BN_DIV2W
116 # endif
117 #endif
118
119 /* assuming long is 64bit - this is the DEC Alpha
120  * unsigned long long is only 64 bits :-(, don't define
121  * BN_LLONG for the DEC Alpha */
122 #ifdef SIXTY_FOUR_BIT_LONG
123 #define BN_ULLONG       unsigned long long
124 #define BN_ULONG        unsigned long
125 #define BN_LONG         long
126 #define BN_BITS         128
127 #define BN_BYTES        8
128 #define BN_BITS2        64
129 #define BN_BITS4        32
130 #define BN_MASK         (0xffffffffffffffffffffffffffffffffLL)
131 #define BN_MASK2        (0xffffffffffffffffL)
132 #define BN_MASK2l       (0xffffffffL)
133 #define BN_MASK2h       (0xffffffff00000000L)
134 #define BN_MASK2h1      (0xffffffff80000000L)
135 #define BN_TBIT         (0x8000000000000000L)
136 #define BN_DEC_CONV     (10000000000000000000UL)
137 #define BN_DEC_FMT1     "%lu"
138 #define BN_DEC_FMT2     "%019lu"
139 #define BN_DEC_NUM      19
140 #endif
141
142 /* This is where the long long data type is 64 bits, but long is 32.
143  * For machines where there are 64bit registers, this is the mode to use.
144  * IRIX, on R4000 and above should use this mode, along with the relevant
145  * assembler code :-).  Do NOT define BN_LLONG.
146  */
147 #ifdef SIXTY_FOUR_BIT
148 #undef BN_LLONG
149 #undef BN_ULLONG
150 #define BN_ULONG        unsigned long long
151 #define BN_LONG         long long
152 #define BN_BITS         128
153 #define BN_BYTES        8
154 #define BN_BITS2        64
155 #define BN_BITS4        32
156 #define BN_MASK2        (0xffffffffffffffffLL)
157 #define BN_MASK2l       (0xffffffffL)
158 #define BN_MASK2h       (0xffffffff00000000LL)
159 #define BN_MASK2h1      (0xffffffff80000000LL)
160 #define BN_TBIT         (0x8000000000000000LL)
161 #define BN_DEC_CONV     (10000000000000000000ULL)
162 #define BN_DEC_FMT1     "%llu"
163 #define BN_DEC_FMT2     "%019llu"
164 #define BN_DEC_NUM      19
165 #endif
166
167 #ifdef THIRTY_TWO_BIT
168 #ifdef BN_LLONG
169 # if defined(OPENSSL_SYS_WIN32) && !defined(__GNUC__)
170 #  define BN_ULLONG     unsigned __int64
171 # else
172 #  define BN_ULLONG     unsigned long long
173 # endif
174 #endif
175 #define BN_ULONG        unsigned long
176 #define BN_LONG         long
177 #define BN_BITS         64
178 #define BN_BYTES        4
179 #define BN_BITS2        32
180 #define BN_BITS4        16
181 #ifdef OPENSSL_SYS_WIN32
182 /* VC++ doesn't like the LL suffix */
183 #define BN_MASK         (0xffffffffffffffffL)
184 #else
185 #define BN_MASK         (0xffffffffffffffffLL)
186 #endif
187 #define BN_MASK2        (0xffffffffL)
188 #define BN_MASK2l       (0xffff)
189 #define BN_MASK2h1      (0xffff8000L)
190 #define BN_MASK2h       (0xffff0000L)
191 #define BN_TBIT         (0x80000000L)
192 #define BN_DEC_CONV     (1000000000L)
193 #define BN_DEC_FMT1     "%lu"
194 #define BN_DEC_FMT2     "%09lu"
195 #define BN_DEC_NUM      9
196 #endif
197
198 #ifdef SIXTEEN_BIT
199 #ifndef BN_DIV2W
200 #define BN_DIV2W
201 #endif
202 #define BN_ULLONG       unsigned long
203 #define BN_ULONG        unsigned short
204 #define BN_LONG         short
205 #define BN_BITS         32
206 #define BN_BYTES        2
207 #define BN_BITS2        16
208 #define BN_BITS4        8
209 #define BN_MASK         (0xffffffff)
210 #define BN_MASK2        (0xffff)
211 #define BN_MASK2l       (0xff)
212 #define BN_MASK2h1      (0xff80)
213 #define BN_MASK2h       (0xff00)
214 #define BN_TBIT         (0x8000)
215 #define BN_DEC_CONV     (100000)
216 #define BN_DEC_FMT1     "%u"
217 #define BN_DEC_FMT2     "%05u"
218 #define BN_DEC_NUM      5
219 #endif
220
221 #ifdef EIGHT_BIT
222 #ifndef BN_DIV2W
223 #define BN_DIV2W
224 #endif
225 #define BN_ULLONG       unsigned short
226 #define BN_ULONG        unsigned char
227 #define BN_LONG         char
228 #define BN_BITS         16
229 #define BN_BYTES        1
230 #define BN_BITS2        8
231 #define BN_BITS4        4
232 #define BN_MASK         (0xffff)
233 #define BN_MASK2        (0xff)
234 #define BN_MASK2l       (0xf)
235 #define BN_MASK2h1      (0xf8)
236 #define BN_MASK2h       (0xf0)
237 #define BN_TBIT         (0x80)
238 #define BN_DEC_CONV     (100)
239 #define BN_DEC_FMT1     "%u"
240 #define BN_DEC_FMT2     "%02u"
241 #define BN_DEC_NUM      2
242 #endif
243
244 #define BN_DEFAULT_BITS 1280
245
246 #define BN_FLG_MALLOCED         0x01
247 #define BN_FLG_STATIC_DATA      0x02
248 #define BN_FLG_CONSTTIME        0x04 /* avoid leaking exponent information through timing,
249                                       * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
250                                       * BN_div() will call BN_div_no_branch,
251                                       * BN_mod_inverse() will call BN_mod_inverse_no_branch.
252                                       */
253
254 #ifndef OPENSSL_NO_DEPRECATED
255 #define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME /* deprecated name for the flag */
256                                       /* avoid leaking exponent information through timings
257                                       * (BN_mod_exp_mont() will call BN_mod_exp_mont_consttime) */
258 #endif
259
260 #ifndef OPENSSL_NO_DEPRECATED
261 #define BN_FLG_FREE             0x8000  /* used for debuging */
262 #endif
263 #define BN_set_flags(b,n)       ((b)->flags|=(n))
264 #define BN_get_flags(b,n)       ((b)->flags&(n))
265
266 /* get a clone of a BIGNUM with changed flags, for *temporary* use only
267  * (the two BIGNUMs cannot not be used in parallel!) */
268 #define BN_with_flags(dest,b,n)  ((dest)->d=(b)->d, \
269                                   (dest)->top=(b)->top, \
270                                   (dest)->dmax=(b)->dmax, \
271                                   (dest)->neg=(b)->neg, \
272                                   (dest)->flags=(((dest)->flags & BN_FLG_MALLOCED) \
273                                                  |  ((b)->flags & ~BN_FLG_MALLOCED) \
274                                                  |  BN_FLG_STATIC_DATA \
275                                                  |  (n)))
276
277 /* Already declared in ossl_typ.h */
278 #if 0
279 typedef struct bignum_st BIGNUM;
280 /* Used for temp variables (declaration hidden in bn_lcl.h) */
281 typedef struct bignum_ctx BN_CTX;
282 typedef struct bn_blinding_st BN_BLINDING;
283 typedef struct bn_mont_ctx_st BN_MONT_CTX;
284 typedef struct bn_recp_ctx_st BN_RECP_CTX;
285 typedef struct bn_gencb_st BN_GENCB;
286 #endif
287
288 struct bignum_st
289         {
290         BN_ULONG *d;    /* Pointer to an array of 'BN_BITS2' bit chunks. */
291         int top;        /* Index of last used d +1. */
292         /* The next are internal book keeping for bn_expand. */
293         int dmax;       /* Size of the d array. */
294         int neg;        /* one if the number is negative */
295         int flags;
296         };
297
298 /* Used for montgomery multiplication */
299 struct bn_mont_ctx_st
300         {
301         int ri;        /* number of bits in R */
302         BIGNUM RR;     /* used to convert to montgomery form */
303         BIGNUM N;      /* The modulus */
304         BIGNUM Ni;     /* R*(1/R mod N) - N*Ni = 1
305                         * (Ni is only stored for bignum algorithm) */
306         BN_ULONG n0;   /* least significant word of Ni */
307         int flags;
308         };
309
310 /* Used for reciprocal division/mod functions
311  * It cannot be shared between threads
312  */
313 struct bn_recp_ctx_st
314         {
315         BIGNUM N;       /* the divisor */
316         BIGNUM Nr;      /* the reciprocal */
317         int num_bits;
318         int shift;
319         int flags;
320         };
321
322 /* Used for slow "generation" functions. */
323 struct bn_gencb_st
324         {
325         unsigned int ver;       /* To handle binary (in)compatibility */
326         void *arg;              /* callback-specific data */
327         union
328                 {
329                 /* if(ver==1) - handles old style callbacks */
330                 void (*cb_1)(int, int, void *);
331                 /* if(ver==2) - new callback style */
332                 int (*cb_2)(int, int, BN_GENCB *);
333                 } cb;
334         };
335 /* Wrapper function to make using BN_GENCB easier,  */
336 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
337 /* Macro to populate a BN_GENCB structure with an "old"-style callback */
338 #define BN_GENCB_set_old(gencb, callback, cb_arg) { \
339                 BN_GENCB *tmp_gencb = (gencb); \
340                 tmp_gencb->ver = 1; \
341                 tmp_gencb->arg = (cb_arg); \
342                 tmp_gencb->cb.cb_1 = (callback); }
343 /* Macro to populate a BN_GENCB structure with a "new"-style callback */
344 #define BN_GENCB_set(gencb, callback, cb_arg) { \
345                 BN_GENCB *tmp_gencb = (gencb); \
346                 tmp_gencb->ver = 2; \
347                 tmp_gencb->arg = (cb_arg); \
348                 tmp_gencb->cb.cb_2 = (callback); }
349
350 #define BN_prime_checks 0 /* default: select number of iterations
351                              based on the size of the number */
352
353 /* number of Miller-Rabin iterations for an error rate  of less than 2^-80
354  * for random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook
355  * of Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
356  * original paper: Damgaard, Landrock, Pomerance: Average case error estimates
357  * for the strong probable prime test. -- Math. Comp. 61 (1993) 177-194) */
358 #define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
359                                 (b) >=  850 ?  3 : \
360                                 (b) >=  650 ?  4 : \
361                                 (b) >=  550 ?  5 : \
362                                 (b) >=  450 ?  6 : \
363                                 (b) >=  400 ?  7 : \
364                                 (b) >=  350 ?  8 : \
365                                 (b) >=  300 ?  9 : \
366                                 (b) >=  250 ? 12 : \
367                                 (b) >=  200 ? 15 : \
368                                 (b) >=  150 ? 18 : \
369                                 /* b >= 100 */ 27)
370
371 #define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
372
373 /* Note that BN_abs_is_word didn't work reliably for w == 0 until 0.9.8 */
374 #define BN_abs_is_word(a,w) ((((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w))) || \
375                                 (((w) == 0) && ((a)->top == 0)))
376 #define BN_is_zero(a)       ((a)->top == 0)
377 #define BN_is_one(a)        (BN_abs_is_word((a),1) && !(a)->neg)
378 #define BN_is_word(a,w)     (BN_abs_is_word((a),(w)) && (!(w) || !(a)->neg))
379 #define BN_is_odd(a)        (((a)->top > 0) && ((a)->d[0] & 1))
380
381 #define BN_one(a)       (BN_set_word((a),1))
382 #define BN_zero_ex(a) \
383         do { \
384                 BIGNUM *_tmp_bn = (a); \
385                 _tmp_bn->top = 0; \
386                 _tmp_bn->neg = 0; \
387         } while(0)
388 #ifdef OPENSSL_NO_DEPRECATED
389 #define BN_zero(a)      BN_zero_ex(a)
390 #else
391 #define BN_zero(a)      (BN_set_word((a),0))
392 #endif
393
394 const BIGNUM *BN_value_one(void);
395 char *  BN_options(void);
396 BN_CTX *BN_CTX_new(void);
397 #ifndef OPENSSL_NO_DEPRECATED
398 void    BN_CTX_init(BN_CTX *c);
399 #endif
400 void    BN_CTX_free(BN_CTX *c);
401 void    BN_CTX_start(BN_CTX *ctx);
402 BIGNUM *BN_CTX_get(BN_CTX *ctx);
403 void    BN_CTX_end(BN_CTX *ctx);
404 int     BN_rand(BIGNUM *rnd, int bits, int top,int bottom);
405 int     BN_pseudo_rand(BIGNUM *rnd, int bits, int top,int bottom);
406 int     BN_rand_range(BIGNUM *rnd, BIGNUM *range);
407 int     BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
408 int     BN_num_bits(const BIGNUM *a);
409 int     BN_num_bits_word(BN_ULONG);
410 BIGNUM *BN_new(void);
411 void    BN_init(BIGNUM *);
412 void    BN_clear_free(BIGNUM *a);
413 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
414 void    BN_swap(BIGNUM *a, BIGNUM *b);
415 BIGNUM *BN_bin2bn(const unsigned char *s,int len,BIGNUM *ret);
416 int     BN_bn2bin(const BIGNUM *a, unsigned char *to);
417 BIGNUM *BN_mpi2bn(const unsigned char *s,int len,BIGNUM *ret);
418 int     BN_bn2mpi(const BIGNUM *a, unsigned char *to);
419 int     BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
420 int     BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
421 int     BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
422 int     BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
423 int     BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
424 int     BN_sqr(BIGNUM *r, const BIGNUM *a,BN_CTX *ctx);
425 /** BN_set_negative sets sign of a BIGNUM
426  * \param  b  pointer to the BIGNUM object
427  * \param  n  0 if the BIGNUM b should be positive and a value != 0 otherwise 
428  */
429 void    BN_set_negative(BIGNUM *b, int n);
430 /** BN_is_negative returns 1 if the BIGNUM is negative
431  * \param  a  pointer to the BIGNUM object
432  * \return 1 if a < 0 and 0 otherwise
433  */
434 #define BN_is_negative(a) ((a)->neg != 0)
435
436 int     BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
437         BN_CTX *ctx);
438 #define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
439 int     BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
440 int     BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
441 int     BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
442 int     BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
443 int     BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
444 int     BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
445         const BIGNUM *m, BN_CTX *ctx);
446 int     BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
447 int     BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
448 int     BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
449 int     BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m, BN_CTX *ctx);
450 int     BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
451
452 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
453 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
454 int     BN_mul_word(BIGNUM *a, BN_ULONG w);
455 int     BN_add_word(BIGNUM *a, BN_ULONG w);
456 int     BN_sub_word(BIGNUM *a, BN_ULONG w);
457 int     BN_set_word(BIGNUM *a, BN_ULONG w);
458 BN_ULONG BN_get_word(const BIGNUM *a);
459
460 int     BN_cmp(const BIGNUM *a, const BIGNUM *b);
461 void    BN_free(BIGNUM *a);
462 int     BN_is_bit_set(const BIGNUM *a, int n);
463 int     BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
464 int     BN_lshift1(BIGNUM *r, const BIGNUM *a);
465 int     BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,BN_CTX *ctx);
466
467 int     BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
468         const BIGNUM *m,BN_CTX *ctx);
469 int     BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
470         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
471 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
472         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont);
473 int     BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
474         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
475 int     BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
476         const BIGNUM *a2, const BIGNUM *p2,const BIGNUM *m,
477         BN_CTX *ctx,BN_MONT_CTX *m_ctx);
478 int     BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
479         const BIGNUM *m,BN_CTX *ctx);
480
481 int     BN_mask_bits(BIGNUM *a,int n);
482 #ifndef OPENSSL_NO_FP_API
483 int     BN_print_fp(FILE *fp, const BIGNUM *a);
484 #endif
485 #ifdef HEADER_BIO_H
486 int     BN_print(BIO *fp, const BIGNUM *a);
487 #else
488 int     BN_print(void *fp, const BIGNUM *a);
489 #endif
490 int     BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
491 int     BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
492 int     BN_rshift1(BIGNUM *r, const BIGNUM *a);
493 void    BN_clear(BIGNUM *a);
494 BIGNUM *BN_dup(const BIGNUM *a);
495 int     BN_ucmp(const BIGNUM *a, const BIGNUM *b);
496 int     BN_set_bit(BIGNUM *a, int n);
497 int     BN_clear_bit(BIGNUM *a, int n);
498 char *  BN_bn2hex(const BIGNUM *a);
499 char *  BN_bn2dec(const BIGNUM *a);
500 int     BN_hex2bn(BIGNUM **a, const char *str);
501 int     BN_dec2bn(BIGNUM **a, const char *str);
502 int     BN_gcd(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx);
503 int     BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */
504 BIGNUM *BN_mod_inverse(BIGNUM *ret,
505         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
506 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
507         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
508
509 /* Deprecated versions */
510 #ifndef OPENSSL_NO_DEPRECATED
511 BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe,
512         const BIGNUM *add, const BIGNUM *rem,
513         void (*callback)(int,int,void *),void *cb_arg);
514 int     BN_is_prime(const BIGNUM *p,int nchecks,
515         void (*callback)(int,int,void *),
516         BN_CTX *ctx,void *cb_arg);
517 int     BN_is_prime_fasttest(const BIGNUM *p,int nchecks,
518         void (*callback)(int,int,void *),BN_CTX *ctx,void *cb_arg,
519         int do_trial_division);
520 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
521
522 /* Newer versions */
523 int     BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add,
524                 const BIGNUM *rem, BN_GENCB *cb);
525 int     BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb);
526 int     BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx,
527                 int do_trial_division, BN_GENCB *cb);
528
529 BN_MONT_CTX *BN_MONT_CTX_new(void );
530 void BN_MONT_CTX_init(BN_MONT_CTX *ctx);
531 int BN_mod_mul_montgomery(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,
532         BN_MONT_CTX *mont, BN_CTX *ctx);
533 #define BN_to_montgomery(r,a,mont,ctx)  BN_mod_mul_montgomery(\
534         (r),(a),&((mont)->RR),(mont),(ctx))
535 int BN_from_montgomery(BIGNUM *r,const BIGNUM *a,
536         BN_MONT_CTX *mont, BN_CTX *ctx);
537 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
538 int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *mod,BN_CTX *ctx);
539 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from);
540 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
541                                         const BIGNUM *mod, BN_CTX *ctx);
542
543 /* BN_BLINDING flags */
544 #define BN_BLINDING_NO_UPDATE   0x00000001
545 #define BN_BLINDING_NO_RECREATE 0x00000002
546
547 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, /* const */ BIGNUM *mod);
548 void BN_BLINDING_free(BN_BLINDING *b);
549 int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
550 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
551 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
552 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
553 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *);
554 unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
555 void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
556 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
557 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
558 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
559         const BIGNUM *e, /* const */ BIGNUM *m, BN_CTX *ctx,
560         int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
561                           const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
562         BN_MONT_CTX *m_ctx);
563
564 #ifndef OPENSSL_NO_DEPRECATED
565 void BN_set_params(int mul,int high,int low,int mont);
566 int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */
567 #endif
568
569 void    BN_RECP_CTX_init(BN_RECP_CTX *recp);
570 BN_RECP_CTX *BN_RECP_CTX_new(void);
571 void    BN_RECP_CTX_free(BN_RECP_CTX *recp);
572 int     BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx);
573 int     BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
574         BN_RECP_CTX *recp,BN_CTX *ctx);
575 int     BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
576         const BIGNUM *m, BN_CTX *ctx);
577 int     BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
578         BN_RECP_CTX *recp, BN_CTX *ctx);
579
580 /* Functions for arithmetic over binary polynomials represented by BIGNUMs. 
581  *
582  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
583  * ignored.
584  *
585  * Note that input arguments are not const so that their bit arrays can
586  * be expanded to the appropriate size if needed.
587  */
588
589 int     BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); /*r = a + b*/
590 #define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
591 int     BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p); /*r=a mod p*/
592 int     BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
593         const BIGNUM *p, BN_CTX *ctx); /* r = (a * b) mod p */
594 int     BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
595         BN_CTX *ctx); /* r = (a * a) mod p */
596 int     BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p,
597         BN_CTX *ctx); /* r = (1 / b) mod p */
598 int     BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
599         const BIGNUM *p, BN_CTX *ctx); /* r = (a / b) mod p */
600 int     BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
601         const BIGNUM *p, BN_CTX *ctx); /* r = (a ^ b) mod p */
602 int     BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
603         BN_CTX *ctx); /* r = sqrt(a) mod p */
604 int     BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
605         BN_CTX *ctx); /* r^2 + r = a mod p */
606 #define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
607 /* Some functions allow for representation of the irreducible polynomials
608  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
609  *     t^p[0] + t^p[1] + ... + t^p[k]
610  * where m = p[0] > p[1] > ... > p[k] = 0.
611  */
612 int     BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[]);
613         /* r = a mod p */
614 int     BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
615         const unsigned int p[], BN_CTX *ctx); /* r = (a * b) mod p */
616 int     BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[],
617         BN_CTX *ctx); /* r = (a * a) mod p */
618 int     BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const unsigned int p[],
619         BN_CTX *ctx); /* r = (1 / b) mod p */
620 int     BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
621         const unsigned int p[], BN_CTX *ctx); /* r = (a / b) mod p */
622 int     BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
623         const unsigned int p[], BN_CTX *ctx); /* r = (a ^ b) mod p */
624 int     BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
625         const unsigned int p[], BN_CTX *ctx); /* r = sqrt(a) mod p */
626 int     BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
627         const unsigned int p[], BN_CTX *ctx); /* r^2 + r = a mod p */
628 int     BN_GF2m_poly2arr(const BIGNUM *a, unsigned int p[], int max);
629 int     BN_GF2m_arr2poly(const unsigned int p[], BIGNUM *a);
630
631 /* faster mod functions for the 'NIST primes' 
632  * 0 <= a < p^2 */
633 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
634 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
635 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
636 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
637 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
638
639 const BIGNUM *BN_get0_nist_prime_192(void);
640 const BIGNUM *BN_get0_nist_prime_224(void);
641 const BIGNUM *BN_get0_nist_prime_256(void);
642 const BIGNUM *BN_get0_nist_prime_384(void);
643 const BIGNUM *BN_get0_nist_prime_521(void);
644
645 /* library internal functions */
646
647 #define bn_expand(a,bits) ((((((bits+BN_BITS2-1))/BN_BITS2)) <= (a)->dmax)?\
648         (a):bn_expand2((a),(bits+BN_BITS2-1)/BN_BITS2))
649 #define bn_wexpand(a,words) (((words) <= (a)->dmax)?(a):bn_expand2((a),(words)))
650 BIGNUM *bn_expand2(BIGNUM *a, int words);
651 #ifndef OPENSSL_NO_DEPRECATED
652 BIGNUM *bn_dup_expand(const BIGNUM *a, int words); /* unused */
653 #endif
654
655 /* Bignum consistency macros
656  * There is one "API" macro, bn_fix_top(), for stripping leading zeroes from
657  * bignum data after direct manipulations on the data. There is also an
658  * "internal" macro, bn_check_top(), for verifying that there are no leading
659  * zeroes. Unfortunately, some auditing is required due to the fact that
660  * bn_fix_top() has become an overabused duct-tape because bignum data is
661  * occasionally passed around in an inconsistent state. So the following
662  * changes have been made to sort this out;
663  * - bn_fix_top()s implementation has been moved to bn_correct_top()
664  * - if BN_DEBUG isn't defined, bn_fix_top() maps to bn_correct_top(), and
665  *   bn_check_top() is as before.
666  * - if BN_DEBUG *is* defined;
667  *   - bn_check_top() tries to pollute unused words even if the bignum 'top' is
668  *     consistent. (ed: only if BN_DEBUG_RAND is defined)
669  *   - bn_fix_top() maps to bn_check_top() rather than "fixing" anything.
670  * The idea is to have debug builds flag up inconsistent bignums when they
671  * occur. If that occurs in a bn_fix_top(), we examine the code in question; if
672  * the use of bn_fix_top() was appropriate (ie. it follows directly after code
673  * that manipulates the bignum) it is converted to bn_correct_top(), and if it
674  * was not appropriate, we convert it permanently to bn_check_top() and track
675  * down the cause of the bug. Eventually, no internal code should be using the
676  * bn_fix_top() macro. External applications and libraries should try this with
677  * their own code too, both in terms of building against the openssl headers
678  * with BN_DEBUG defined *and* linking with a version of OpenSSL built with it
679  * defined. This not only improves external code, it provides more test
680  * coverage for openssl's own code.
681  */
682
683 #ifdef BN_DEBUG
684
685 /* We only need assert() when debugging */
686 #include <assert.h>
687
688 #ifdef BN_DEBUG_RAND
689 /* To avoid "make update" cvs wars due to BN_DEBUG, use some tricks */
690 #ifndef RAND_pseudo_bytes
691 int RAND_pseudo_bytes(unsigned char *buf,int num);
692 #define BN_DEBUG_TRIX
693 #endif
694 #define bn_pollute(a) \
695         do { \
696                 const BIGNUM *_bnum1 = (a); \
697                 if(_bnum1->top < _bnum1->dmax) { \
698                         unsigned char _tmp_char; \
699                         /* We cast away const without the compiler knowing, any \
700                          * *genuinely* constant variables that aren't mutable \
701                          * wouldn't be constructed with top!=dmax. */ \
702                         BN_ULONG *_not_const; \
703                         memcpy(&_not_const, &_bnum1->d, sizeof(BN_ULONG*)); \
704                         RAND_pseudo_bytes(&_tmp_char, 1); \
705                         memset((unsigned char *)(_not_const + _bnum1->top), _tmp_char, \
706                                 (_bnum1->dmax - _bnum1->top) * sizeof(BN_ULONG)); \
707                 } \
708         } while(0)
709 #ifdef BN_DEBUG_TRIX
710 #undef RAND_pseudo_bytes
711 #endif
712 #else
713 #define bn_pollute(a)
714 #endif
715 #define bn_check_top(a) \
716         do { \
717                 const BIGNUM *_bnum2 = (a); \
718                 if (_bnum2 != NULL) { \
719                         assert((_bnum2->top == 0) || \
720                                 (_bnum2->d[_bnum2->top - 1] != 0)); \
721                         bn_pollute(_bnum2); \
722                 } \
723         } while(0)
724
725 #define bn_fix_top(a)           bn_check_top(a)
726
727 #else /* !BN_DEBUG */
728
729 #define bn_pollute(a)
730 #define bn_check_top(a)
731 #define bn_fix_top(a)           bn_correct_top(a)
732
733 #endif
734
735 #define bn_correct_top(a) \
736         { \
737         BN_ULONG *ftl; \
738         if ((a)->top > 0) \
739                 { \
740                 for (ftl= &((a)->d[(a)->top-1]); (a)->top > 0; (a)->top--) \
741                 if (*(ftl--)) break; \
742                 } \
743         bn_pollute(a); \
744         }
745
746 BN_ULONG bn_mul_add_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
747 BN_ULONG bn_mul_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
748 void     bn_sqr_words(BN_ULONG *rp, const BN_ULONG *ap, int num);
749 BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d);
750 BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
751 BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
752
753 /* Primes from RFC 2409 */
754 BIGNUM *get_rfc2409_prime_768(BIGNUM *bn);
755 BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn);
756
757 /* Primes from RFC 3526 */
758 BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn);
759 BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn);
760 BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn);
761 BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn);
762 BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn);
763 BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn);
764
765 int BN_bntest_rand(BIGNUM *rnd, int bits, int top,int bottom);
766
767 /* BEGIN ERROR CODES */
768 /* The following lines are auto generated by the script mkerr.pl. Any changes
769  * made after this point may be overwritten when the script is next run.
770  */
771 void ERR_load_BN_strings(void);
772
773 /* Error codes for the BN functions. */
774
775 /* Function codes. */
776 #define BN_F_BNRAND                                      127
777 #define BN_F_BN_BLINDING_CONVERT_EX                      100
778 #define BN_F_BN_BLINDING_CREATE_PARAM                    128
779 #define BN_F_BN_BLINDING_INVERT_EX                       101
780 #define BN_F_BN_BLINDING_NEW                             102
781 #define BN_F_BN_BLINDING_UPDATE                          103
782 #define BN_F_BN_BN2DEC                                   104
783 #define BN_F_BN_BN2HEX                                   105
784 #define BN_F_BN_CTX_GET                                  116
785 #define BN_F_BN_CTX_NEW                                  106
786 #define BN_F_BN_CTX_START                                129
787 #define BN_F_BN_DIV                                      107
788 #define BN_F_BN_DIV_NO_BRANCH                            138
789 #define BN_F_BN_DIV_RECP                                 130
790 #define BN_F_BN_EXP                                      123
791 #define BN_F_BN_EXPAND2                                  108
792 #define BN_F_BN_EXPAND_INTERNAL                          120
793 #define BN_F_BN_GF2M_MOD                                 131
794 #define BN_F_BN_GF2M_MOD_EXP                             132
795 #define BN_F_BN_GF2M_MOD_MUL                             133
796 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD                      134
797 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                  135
798 #define BN_F_BN_GF2M_MOD_SQR                             136
799 #define BN_F_BN_GF2M_MOD_SQRT                            137
800 #define BN_F_BN_MOD_EXP2_MONT                            118
801 #define BN_F_BN_MOD_EXP_MONT                             109
802 #define BN_F_BN_MOD_EXP_MONT_CONSTTIME                   124
803 #define BN_F_BN_MOD_EXP_MONT_WORD                        117
804 #define BN_F_BN_MOD_EXP_RECP                             125
805 #define BN_F_BN_MOD_EXP_SIMPLE                           126
806 #define BN_F_BN_MOD_INVERSE                              110
807 #define BN_F_BN_MOD_INVERSE_NO_BRANCH                    139
808 #define BN_F_BN_MOD_LSHIFT_QUICK                         119
809 #define BN_F_BN_MOD_MUL_RECIPROCAL                       111
810 #define BN_F_BN_MOD_SQRT                                 121
811 #define BN_F_BN_MPI2BN                                   112
812 #define BN_F_BN_NEW                                      113
813 #define BN_F_BN_RAND                                     114
814 #define BN_F_BN_RAND_RANGE                               122
815 #define BN_F_BN_USUB                                     115
816
817 /* Reason codes. */
818 #define BN_R_ARG2_LT_ARG3                                100
819 #define BN_R_BAD_RECIPROCAL                              101
820 #define BN_R_BIGNUM_TOO_LONG                             114
821 #define BN_R_CALLED_WITH_EVEN_MODULUS                    102
822 #define BN_R_DIV_BY_ZERO                                 103
823 #define BN_R_ENCODING_ERROR                              104
824 #define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA                105
825 #define BN_R_INPUT_NOT_REDUCED                           110
826 #define BN_R_INVALID_LENGTH                              106
827 #define BN_R_INVALID_RANGE                               115
828 #define BN_R_NOT_A_SQUARE                                111
829 #define BN_R_NOT_INITIALIZED                             107
830 #define BN_R_NO_INVERSE                                  108
831 #define BN_R_NO_SOLUTION                                 116
832 #define BN_R_P_IS_NOT_PRIME                              112
833 #define BN_R_TOO_MANY_ITERATIONS                         113
834 #define BN_R_TOO_MANY_TEMPORARY_VARIABLES                109
835
836 #ifdef  __cplusplus
837 }
838 #endif
839 #endif