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