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