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