This commit was generated by cvs2svn to track changes on a CVS vendor
[openssl.git] / crypto / bn / bn.h
1 /* crypto/bn/bn.org */
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 /* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING 
60  *
61  * Always modify bn.org since bn.h is automatically generated from
62  * it during SSLeay configuration.
63  *
64  * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
65  */
66
67 #ifndef HEADER_BN_H
68 #define HEADER_BN_H
69
70 #ifdef  __cplusplus
71 extern "C" {
72 #endif
73
74 #undef BN_LLONG
75
76 #ifdef WIN32
77 #define BN_LLONG /* This comment stops Configure mutilating things */
78 #endif
79
80 #define RECP_MUL_MOD
81 #define MONT_MUL_MOD
82
83 /* This next option uses the C libraries (2 word)/(1 word) function.
84  * If it is not defined, I use my C version (which is slower).
85  * The reason for this flag is that when the particular C compiler
86  * library routine is used, and the library is linked with a different
87  * compiler, the library is missing.  This mostly happens when the
88  * library is built with gcc and then linked using nornal cc.  This would
89  * be a common occurance because gcc normally produces code that is
90  * 2 times faster than system compilers for the big number stuff.
91  * For machines with only one compiler (or shared libraries), this should
92  * be on.  Again this in only really a problem on machines
93  * using "long long's", are 32bit, and are not using my assember code. */
94 #if defined(MSDOS) || defined(WINDOWS) || defined(linux)
95 #define BN_DIV2W
96 #endif
97
98 /* Only one for the following should be defined */
99 /* The prime number generation stuff may not work when
100  * EIGHT_BIT but I don't care since I've only used this mode
101  * for debuging the bignum libraries */
102 #undef SIXTY_FOUR_BIT_LONG
103 #undef SIXTY_FOUR_BIT
104 #define THIRTY_TWO_BIT
105 #undef SIXTEEN_BIT
106 #undef EIGHT_BIT
107
108 /* assuming long is 64bit - this is the DEC Alpha
109  * unsigned long long is only 64 bits :-(, don't define
110  * BN_LLONG for the DEC Alpha */
111 #ifdef SIXTY_FOUR_BIT_LONG
112 #define BN_ULLONG       unsigned long long
113 #define BN_ULONG        unsigned long
114 #define BN_LONG         long
115 #define BN_BITS         128
116 #define BN_BYTES        8
117 #define BN_BITS2        64
118 #define BN_BITS4        32
119 #define BN_MASK2        (0xffffffffffffffffL)
120 #define BN_MASK2l       (0xffffffffL)
121 #define BN_MASK2h       (0xffffffff00000000L)
122 #define BN_MASK2h1      (0xffffffff80000000L)
123 #define BN_TBIT         (0x8000000000000000L)
124 #define BN_DEC_CONV     (10000000000000000000L)
125 #define BN_DEC_FMT1     "%lu"
126 #define BN_DEC_FMT2     "%019lu"
127 #define BN_DEC_NUM      19
128 #endif
129
130 #ifdef SIXTY_FOUR_BIT
131 #undef BN_LLONG
132 /* #define BN_ULLONG    unsigned long long */
133 #define BN_ULONG        unsigned long long
134 #define BN_LONG         long long
135 #define BN_BITS         128
136 #define BN_BYTES        8
137 #define BN_BITS2        64
138 #define BN_BITS4        32
139 #define BN_MASK2        (0xffffffffffffffffLL)
140 #define BN_MASK2l       (0xffffffffL)
141 #define BN_MASK2h       (0xffffffff00000000LL)
142 #define BN_MASK2h1      (0xffffffff80000000LL)
143 #define BN_TBIT         (0x8000000000000000LL)
144 #define BN_DEC_CONV     (10000000000000000000L)
145 #define BN_DEC_FMT1     "%lu"
146 #define BN_DEC_FMT2     "%019lu"
147 #define BN_DEC_NUM      19
148 #endif
149
150 #ifdef THIRTY_TWO_BIT
151 #ifdef WIN32
152 #define BN_ULLONG       unsigned _int64
153 #else
154 #define BN_ULLONG       unsigned long long
155 #endif
156 #define BN_ULONG        unsigned long
157 #define BN_LONG         long
158 #define BN_BITS         64
159 #define BN_BYTES        4
160 #define BN_BITS2        32
161 #define BN_BITS4        16
162 #define BN_MASK2        (0xffffffffL)
163 #define BN_MASK2l       (0xffff)
164 #define BN_MASK2h1      (0xffff8000L)
165 #define BN_MASK2h       (0xffff0000L)
166 #define BN_TBIT         (0x80000000L)
167 #define BN_DEC_CONV     (1000000000L)
168 #define BN_DEC_FMT1     "%lu"
169 #define BN_DEC_FMT2     "%09lu"
170 #define BN_DEC_NUM      9
171 #endif
172
173 #ifdef SIXTEEN_BIT
174 #ifndef BN_DIV2W
175 #define BN_DIV2W
176 #endif
177 #define BN_ULLONG       unsigned long
178 #define BN_ULONG        unsigned short
179 #define BN_LONG         short
180 #define BN_BITS         32
181 #define BN_BYTES        2
182 #define BN_BITS2        16
183 #define BN_BITS4        8
184 #define BN_MASK2        (0xffff)
185 #define BN_MASK2l       (0xff)
186 #define BN_MASK2h1      (0xff80)
187 #define BN_MASK2h       (0xff00)
188 #define BN_TBIT         (0x8000)
189 #define BN_DEC_CONV     (100000)
190 #define BN_DEC_FMT1     "%u"
191 #define BN_DEC_FMT2     "%05u"
192 #define BN_DEC_NUM      5
193 #endif
194
195 #ifdef EIGHT_BIT
196 #ifndef BN_DIV2W
197 #define BN_DIV2W
198 #endif
199 #define BN_ULLONG       unsigned short
200 #define BN_ULONG        unsigned char
201 #define BN_LONG         char
202 #define BN_BITS         16
203 #define BN_BYTES        1
204 #define BN_BITS2        8
205 #define BN_BITS4        4
206 #define BN_MASK2        (0xff)
207 #define BN_MASK2l       (0xf)
208 #define BN_MASK2h1      (0xf8)
209 #define BN_MASK2h       (0xf0)
210 #define BN_TBIT         (0x80)
211 #define BN_DEC_CONV     (100)
212 #define BN_DEC_FMT1     "%u"
213 #define BN_DEC_FMT2     "%02u"
214 #define BN_DEC_NUM      2
215 #endif
216
217 #define BN_DEFAULT_BITS 1280
218
219 #ifdef BIGNUM
220 #undef BIGNUM
221 #endif
222
223 typedef struct bignum_st
224         {
225         BN_ULONG *d;    /* Pointer to an array of 'BN_BITS2' bit chunks. */
226         int top;        /* Index of last used d +1. */
227         /* The next are internal book keeping for bn_expand. */
228         int max;        /* Size of the d array. */
229         int neg;        /* one if the number is negative */
230         } BIGNUM;
231
232 /* Used for temp variables */
233 #define BN_CTX_NUM      12
234 typedef struct bignum_ctx
235         {
236         int tos;
237         BIGNUM *bn[BN_CTX_NUM+1];
238         } BN_CTX;
239
240 typedef struct bn_blinding_st
241         {
242         int init;
243         BIGNUM *A;
244         BIGNUM *Ai;
245         BIGNUM *mod; /* just a reference */
246         } BN_BLINDING;
247
248 /* Used for montgomery multiplication */
249 typedef struct bn_mont_ctx_st
250         {
251         int ri;         /* number of bits in R */
252         BIGNUM *RR;     /* used to convert to montgomery form */
253         BIGNUM *N;      /* The modulus */
254         BIGNUM *Ni;     /* The inverse of N */
255         BN_ULONG n0;    /* word form of inverse, normally only one of
256                          * Ni or n0 is defined */
257         } BN_MONT_CTX;
258
259 #define BN_to_montgomery(r,a,mont,ctx)  BN_mod_mul_montgomery(\
260         r,a,(mont)->RR,(mont),ctx)
261
262 #define BN_prime_checks         (5)
263
264 #define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
265 #define BN_is_word(a,w) (((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w)))
266 #define BN_is_zero(a)   (((a)->top <= 1) && ((a)->d[0] == (BN_ULONG)0))
267 #define BN_is_one(a)    (BN_is_word((a),1))
268 #define BN_is_odd(a)    ((a)->d[0] & 1)
269 #define BN_one(a)       (BN_set_word((a),1))
270 #define BN_zero(a)      (BN_set_word((a),0))
271
272 #define BN_ascii2bn(a)  BN_hex2bn(a)
273 #define BN_bn2ascii(a)  BN_bn2hex(a)
274
275 #define bn_fix_top(a) \
276         { \
277         BN_ULONG *fix_top_l; \
278         for (fix_top_l= &((a)->d[(a)->top-1]); (a)->top > 0; (a)->top--) \
279                 if (*(fix_top_l--)) break; \
280         }
281
282 #define bn_expand(n,b) ((((b)/BN_BITS2) <= (n)->max)?\
283         (n):bn_expand2((n),(b)/BN_BITS2))
284 #define bn_wexpand(n,b) (((b) <= (n)->max)?(n):bn_expand2((n),(b)))
285
286
287 #ifndef NOPROTO
288 BIGNUM *BN_value_one(void);
289 char *  BN_options(void);
290 BN_CTX *BN_CTX_new(void);
291 void    BN_CTX_free(BN_CTX *c);
292 int     BN_rand(BIGNUM *rnd, int bits, int top,int bottom);
293 int     BN_num_bits(BIGNUM *a);
294 int     BN_num_bits_word(BN_ULONG);
295 BIGNUM *BN_new(void);
296 void    BN_clear_free(BIGNUM *a);
297 BIGNUM *BN_copy(BIGNUM *a, BIGNUM *b);
298 BIGNUM *BN_bin2bn(unsigned char *s,int len,BIGNUM *ret);
299 int     BN_bn2bin(BIGNUM *a, unsigned char *to);
300 BIGNUM *BN_mpi2bn(unsigned char *s,int len,BIGNUM *ret);
301 int     BN_bn2mpi(BIGNUM *a, unsigned char *to);
302 int     BN_sub(BIGNUM *r, BIGNUM *a, BIGNUM *b);
303 void    bn_qsub(BIGNUM *r, BIGNUM *a, BIGNUM *b);
304 void    bn_qadd(BIGNUM *r, BIGNUM *a, BIGNUM *b);
305 int     BN_add(BIGNUM *r, BIGNUM *a, BIGNUM *b);
306 int     BN_mod(BIGNUM *rem, BIGNUM *m, BIGNUM *d, BN_CTX *ctx);
307 int     BN_div(BIGNUM *dv, BIGNUM *rem, BIGNUM *m, BIGNUM *d, BN_CTX *ctx);
308 int     BN_mul(BIGNUM *r, BIGNUM *a, BIGNUM *b);
309 int     BN_sqr(BIGNUM *r, BIGNUM *a,BN_CTX *ctx);
310 BN_ULONG BN_mod_word(BIGNUM *a, unsigned long w);
311 BN_ULONG BN_div_word(BIGNUM *a, unsigned long w);
312 int     BN_mul_word(BIGNUM *a, unsigned long w);
313 int     BN_add_word(BIGNUM *a, unsigned long w);
314 int     BN_sub_word(BIGNUM *a, unsigned long w);
315 int     BN_set_word(BIGNUM *a, unsigned long w);
316 unsigned long BN_get_word(BIGNUM *a);
317 int     BN_cmp(BIGNUM *a, BIGNUM *b);
318 void    BN_free(BIGNUM *a);
319 int     BN_is_bit_set(BIGNUM *a, int n);
320 int     BN_lshift(BIGNUM *r, BIGNUM *a, int n);
321 int     BN_lshift1(BIGNUM *r, BIGNUM *a);
322 int     BN_exp(BIGNUM *r, BIGNUM *a, BIGNUM *p,BN_CTX *ctx);
323 int     BN_mod_exp(BIGNUM *r, BIGNUM *a, BIGNUM *p, BIGNUM *m,BN_CTX *ctx);
324 int     BN_mod_exp_mont(BIGNUM *r, BIGNUM *a, BIGNUM *p, BIGNUM *m,BN_CTX *ctx,
325                 BN_MONT_CTX *m_ctx);
326 int     BN_mod_exp_recp(BIGNUM *r, BIGNUM *a, BIGNUM *p, BIGNUM *m,BN_CTX *ctx);
327 int     BN_mod_exp_simple(BIGNUM *r, BIGNUM *a, BIGNUM *p,
328         BIGNUM *m,BN_CTX *ctx);
329 int     BN_mask_bits(BIGNUM *a,int n);
330 int     BN_mod_mul_reciprocal(BIGNUM *r, BIGNUM *x, BIGNUM *y, BIGNUM *m, 
331         BIGNUM *i, int nb, BN_CTX *ctx);
332 int     BN_mod_mul(BIGNUM *ret, BIGNUM *a, BIGNUM *b, BIGNUM *m,
333         BN_CTX *ctx);
334 #ifndef WIN16
335 int     BN_print_fp(FILE *fp, BIGNUM *a);
336 #endif
337 #ifdef HEADER_BIO_H
338 int     BN_print(BIO *fp, BIGNUM *a);
339 #else
340 int     BN_print(char *fp, BIGNUM *a);
341 #endif
342 int     BN_reciprocal(BIGNUM *r, BIGNUM *m, BN_CTX *ctx);
343 int     BN_rshift(BIGNUM *r, BIGNUM *a, int n);
344 int     BN_rshift1(BIGNUM *r, BIGNUM *a);
345 void    BN_clear(BIGNUM *a);
346 BIGNUM *bn_expand2(BIGNUM *b, int bits);
347 BIGNUM *BN_dup(BIGNUM *a);
348 int     BN_ucmp(BIGNUM *a, BIGNUM *b);
349 int     BN_set_bit(BIGNUM *a, int n);
350 int     BN_clear_bit(BIGNUM *a, int n);
351 char *  BN_bn2hex(BIGNUM *a);
352 char *  BN_bn2dec(BIGNUM *a);
353 int     BN_hex2bn(BIGNUM **a,char *str);
354 int     BN_dec2bn(BIGNUM **a,char *str);
355 int     BN_gcd(BIGNUM *r,BIGNUM *in_a,BIGNUM *in_b,BN_CTX *ctx);
356 BIGNUM *BN_mod_inverse(BIGNUM *a, BIGNUM *n,BN_CTX *ctx);
357 BIGNUM *BN_generate_prime(int bits,int strong,BIGNUM *add,
358                 BIGNUM *rem,void (*callback)(int,int,char *),char *cb_arg);
359 int     BN_is_prime(BIGNUM *p,int nchecks,void (*callback)(int,int,char *),
360                 BN_CTX *ctx,char *cb_arg);
361 void    ERR_load_BN_strings(void );
362
363 BN_ULONG bn_mul_add_words(BN_ULONG *rp, BN_ULONG *ap, int num, BN_ULONG w);
364 BN_ULONG bn_mul_words(BN_ULONG *rp, BN_ULONG *ap, int num, BN_ULONG w);
365 void     bn_sqr_words(BN_ULONG *rp, BN_ULONG *ap, int num);
366 BN_ULONG bn_div64(BN_ULONG h, BN_ULONG l, BN_ULONG d);
367 BN_ULONG bn_add_words(BN_ULONG *rp, BN_ULONG *ap, BN_ULONG *bp,int num);
368
369 BN_MONT_CTX *BN_MONT_CTX_new(void );
370 int BN_mod_mul_montgomery(BIGNUM *r,BIGNUM *a,BIGNUM *b,BN_MONT_CTX *mont,
371         BN_CTX *ctx);
372 int BN_from_montgomery(BIGNUM *r,BIGNUM *a,BN_MONT_CTX *mont,BN_CTX *ctx);
373 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
374 int BN_MONT_CTX_set(BN_MONT_CTX *mont,BIGNUM *modulus,BN_CTX *ctx);
375
376 BN_BLINDING *BN_BLINDING_new(BIGNUM *A,BIGNUM *Ai,BIGNUM *mod);
377 void BN_BLINDING_free(BN_BLINDING *b);
378 int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
379 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *r, BN_CTX *ctx);
380 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
381
382 #else
383
384 BIGNUM *BN_value_one();
385 char *  BN_options();
386 BN_CTX *BN_CTX_new();
387 void    BN_CTX_free();
388 int     BN_rand();
389 int     BN_num_bits();
390 int     BN_num_bits_word();
391 BIGNUM *BN_new();
392 void    BN_clear_free();
393 BIGNUM *BN_copy();
394 BIGNUM *BN_bin2bn();
395 int     BN_bn2bin();
396 BIGNUM *BN_mpi2bn();
397 int     BN_bn2mpi();
398 int     BN_sub();
399 void    bn_qsub();
400 void    bn_qadd();
401 int     BN_add();
402 int     BN_mod();
403 int     BN_div();
404 int     BN_mul();
405 int     BN_sqr();
406 BN_ULONG BN_mod_word();
407 BN_ULONG BN_div_word();
408 int     BN_add_word();
409 int     BN_sub_word();
410 int     BN_mul_word();
411 int     BN_set_word();
412 unsigned long BN_get_word();
413 int     BN_cmp();
414 void    BN_free();
415 int     BN_is_bit_set();
416 int     BN_lshift();
417 int     BN_lshift1();
418 int     BN_exp();
419 int     BN_mod_exp();
420 int     BN_mod_exp_mont();
421 int     BN_mod_exp_recp();
422 int     BN_mod_exp_simple();
423 int     BN_mask_bits();
424 int     BN_mod_mul_reciprocal();
425 int     BN_mod_mul();
426 #ifndef WIN16
427 int     BN_print_fp();
428 #endif
429 int     BN_print();
430 int     BN_reciprocal();
431 int     BN_rshift();
432 int     BN_rshift1();
433 void    BN_clear();
434 BIGNUM *bn_expand2();
435 BIGNUM *BN_dup();
436 int     BN_ucmp();
437 int     BN_set_bit();
438 int     BN_clear_bit();
439 char *  BN_bn2hex();
440 char *  BN_bn2dec();
441 int     BN_hex2bn();
442 int     BN_dec2bn();
443 int     BN_gcd();
444 BIGNUM *BN_mod_inverse();
445 BIGNUM *BN_generate_prime();
446 int     BN_is_prime();
447 void    ERR_load_BN_strings();
448
449 BN_ULONG bn_mul_add_words();
450 BN_ULONG bn_mul_words();
451 void     bn_sqr_words();
452 BN_ULONG bn_div64();
453 BN_ULONG bn_add_words();
454
455 int BN_mod_mul_montgomery();
456 int BN_from_montgomery();
457 BN_MONT_CTX *BN_MONT_CTX_new();
458 void BN_MONT_CTX_free();
459 int BN_MONT_CTX_set();
460
461 BN_BLINDING *BN_BLINDING_new();
462 void BN_BLINDING_free();
463 int BN_BLINDING_update();
464 int BN_BLINDING_convert();
465 int BN_BLINDING_invert();
466
467 #endif
468
469 /* BEGIN ERROR CODES */
470 /* Error codes for the BN functions. */
471
472 /* Function codes. */
473 #define BN_F_BN_BLINDING_CONVERT                         100
474 #define BN_F_BN_BLINDING_INVERT                          101
475 #define BN_F_BN_BLINDING_NEW                             102
476 #define BN_F_BN_BLINDING_UPDATE                          103
477 #define BN_F_BN_BN2DEC                                   104
478 #define BN_F_BN_BN2HEX                                   105
479 #define BN_F_BN_CTX_NEW                                  106
480 #define BN_F_BN_DIV                                      107
481 #define BN_F_BN_EXPAND2                                  108
482 #define BN_F_BN_MOD_EXP_MONT                             109
483 #define BN_F_BN_MOD_INVERSE                              110
484 #define BN_F_BN_MOD_MUL_RECIPROCAL                       111
485 #define BN_F_BN_MPI2BN                                   112
486 #define BN_F_BN_NEW                                      113
487 #define BN_F_BN_RAND                                     114
488
489 /* Reason codes. */
490 #define BN_R_BAD_RECIPROCAL                              100
491 #define BN_R_CALLED_WITH_EVEN_MODULUS                    101
492 #define BN_R_DIV_BY_ZERO                                 102
493 #define BN_R_ENCODING_ERROR                              103
494 #define BN_R_INVALID_LENGTH                              104
495 #define BN_R_NOT_INITALISED                              105
496 #define BN_R_NO_INVERSE                                  106
497  
498 #ifdef  __cplusplus
499 }
500 #endif
501 #endif
502