1
/* LibTomMath, multiple-precision integer library -- Tom St Denis
3
* LibTomMath is a library that provides multiple-precision
4
* integer arithmetic as well as number theoretic functionality.
6
* The library was designed directly after the MPI library by
7
* Michael Fromberger but has been written from scratch with
8
* additional optimizations in place.
10
* The library is free for all purposes without any express
13
* Tom St Denis, tomstdenis@iahu.ca, http://math.libtomcrypt.org
24
#include <tommath_class.h>
27
#define MIN(x,y) ((x)<(y)?(x):(y))
29
#define MAX(x,y) ((x)>(y)?(x):(y))
34
/* C++ compilers don't like assigning void * to mp_digit * */
35
#define OPT_CAST(x) (x *)
39
/* C on the other hand doesn't care */
45
/* detect 64-bit mode if possible */
46
#if defined(__x86_64__)
47
#if !(defined(MP_64BIT) && defined(MP_16BIT) && defined(MP_8BIT))
52
/* some default configurations.
54
* A "mp_digit" must be able to hold DIGIT_BIT + 1 bits
55
* A "mp_word" must be able to hold 2*DIGIT_BIT + 1 bits
57
* At the very least a mp_digit must be able to hold 7 bits
58
* [any size beyond that is ok provided it doesn't overflow the data type]
61
typedef unsigned char mp_digit;
62
typedef unsigned short mp_word;
63
#elif defined(MP_16BIT)
64
typedef unsigned short mp_digit;
65
typedef unsigned long mp_word;
66
#elif defined(MP_64BIT)
67
/* for GCC only on supported platforms */
69
typedef unsigned long long ulong64;
70
typedef signed long long long64;
73
typedef unsigned long mp_digit;
74
typedef unsigned long mp_word __attribute__ ((mode(TI)));
78
/* this is the default case, 28-bit digits */
80
/* this is to make porting into LibTomCrypt easier :-) */
82
#if defined(_MSC_VER) || defined(__BORLANDC__)
83
typedef unsigned __int64 ulong64;
84
typedef signed __int64 long64;
86
typedef unsigned long long ulong64;
87
typedef signed long long long64;
91
typedef unsigned long mp_digit;
92
typedef ulong64 mp_word;
95
/* this is an extension that uses 31-bit digits */
98
/* default case is 28-bit digits, defines MP_28BIT as a handy macro to test */
104
/* define heap macros */
106
/* default to libc stuff */
108
#define XMALLOC malloc
110
#define XREALLOC realloc
111
#define XCALLOC calloc
113
/* prototypes for our heap functions */
114
extern void *XMALLOC(size_t n);
115
extern void *REALLOC(void *p, size_t n);
116
extern void *XCALLOC(size_t n, size_t s);
117
extern void XFREE(void *p);
122
/* otherwise the bits per digit is calculated automatically from the size of a mp_digit */
124
#define DIGIT_BIT ((int)((CHAR_BIT * sizeof(mp_digit) - 1))) /* bits per digit */
127
#define MP_DIGIT_BIT DIGIT_BIT
128
#define MP_MASK ((((mp_digit)1)<<((mp_digit)DIGIT_BIT))-((mp_digit)1))
129
#define MP_DIGIT_MAX MP_MASK
132
#define MP_LT -1 /* less than */
133
#define MP_EQ 0 /* equal to */
134
#define MP_GT 1 /* greater than */
136
#define MP_ZPOS 0 /* positive integer */
137
#define MP_NEG 1 /* negative */
139
#define MP_OKAY 0 /* ok result */
140
#define MP_MEM -2 /* out of mem */
141
#define MP_VAL -3 /* invalid input */
142
#define MP_RANGE MP_VAL
144
#define MP_YES 1 /* yes response */
145
#define MP_NO 0 /* no response */
147
/* Primality generation flags */
148
#define LTM_PRIME_BBS 0x0001 /* BBS style prime */
149
#define LTM_PRIME_SAFE 0x0002 /* Safe prime (p-1)/2 == prime */
150
#define LTM_PRIME_2MSB_OFF 0x0004 /* force 2nd MSB to 0 */
151
#define LTM_PRIME_2MSB_ON 0x0008 /* force 2nd MSB to 1 */
155
/* you'll have to tune these... */
156
extern int KARATSUBA_MUL_CUTOFF,
157
KARATSUBA_SQR_CUTOFF,
161
/* define this to use lower memory usage routines (exptmods mostly) */
162
/* #define MP_LOW_MEM */
164
/* default precision */
167
#define MP_PREC 64 /* default digits of precision */
169
#define MP_PREC 8 /* default digits of precision */
173
/* size of comba arrays, should be at least 2 * 2**(BITS_PER_WORD - BITS_PER_DIGIT*2) */
174
#define MP_WARRAY (1 << (sizeof(mp_word) * CHAR_BIT - 2 * DIGIT_BIT + 1))
176
/* the infamous mp_int structure */
178
int used, alloc, sign;
182
/* callback for mp_prime_random, should fill dst with random bytes and return how many read [upto len] */
183
typedef int ltm_prime_callback(unsigned char *dst, int len, void *dat);
186
#define USED(m) ((m)->used)
187
#define DIGIT(m,k) ((m)->dp[(k)])
188
#define SIGN(m) ((m)->sign)
190
/* error code to char* string */
191
char *mp_error_to_string(int code);
193
/* ---> init and deinit bignum functions <--- */
195
int mp_init(mp_int *a);
198
void mp_clear(mp_int *a);
200
/* init a null terminated series of arguments */
201
int mp_init_multi(mp_int *mp, ...);
203
/* clear a null terminated series of arguments */
204
void mp_clear_multi(mp_int *mp, ...);
206
/* exchange two ints */
207
void mp_exch(mp_int *a, mp_int *b);
209
/* shrink ram required for a bignum */
210
int mp_shrink(mp_int *a);
212
/* grow an int to a given size */
213
int mp_grow(mp_int *a, int size);
215
/* init to a given number of digits */
216
int mp_init_size(mp_int *a, int size);
218
/* ---> Basic Manipulations <--- */
219
#define mp_iszero(a) (((a)->used == 0) ? MP_YES : MP_NO)
220
#define mp_iseven(a) (((a)->used > 0 && (((a)->dp[0] & 1) == 0)) ? MP_YES : MP_NO)
221
#define mp_isodd(a) (((a)->used > 0 && (((a)->dp[0] & 1) == 1)) ? MP_YES : MP_NO)
224
void mp_zero(mp_int *a);
227
void mp_set(mp_int *a, mp_digit b);
229
/* set a 32-bit const */
230
int mp_set_int(mp_int *a, unsigned long b);
232
/* get a 32-bit value */
233
unsigned long mp_get_int(mp_int * a);
235
/* initialize and set a digit */
236
int mp_init_set (mp_int * a, mp_digit b);
238
/* initialize and set 32-bit value */
239
int mp_init_set_int (mp_int * a, unsigned long b);
242
int mp_copy(mp_int *a, mp_int *b);
244
/* inits and copies, a = b */
245
int mp_init_copy(mp_int *a, mp_int *b);
247
/* trim unused digits */
248
void mp_clamp(mp_int *a);
250
/* ---> digit manipulation <--- */
252
/* right shift by "b" digits */
253
void mp_rshd(mp_int *a, int b);
255
/* left shift by "b" digits */
256
int mp_lshd(mp_int *a, int b);
259
int mp_div_2d(mp_int *a, int b, mp_int *c, mp_int *d);
262
int mp_div_2(mp_int *a, mp_int *b);
265
int mp_mul_2d(mp_int *a, int b, mp_int *c);
268
int mp_mul_2(mp_int *a, mp_int *b);
271
int mp_mod_2d(mp_int *a, int b, mp_int *c);
273
/* computes a = 2**b */
274
int mp_2expt(mp_int *a, int b);
276
/* Counts the number of lsbs which are zero before the first zero bit */
277
int mp_cnt_lsb(mp_int *a);
281
/* makes a pseudo-random int of a given size */
282
int mp_rand(mp_int *a, int digits);
284
/* ---> binary operations <--- */
286
int mp_xor(mp_int *a, mp_int *b, mp_int *c);
289
int mp_or(mp_int *a, mp_int *b, mp_int *c);
292
int mp_and(mp_int *a, mp_int *b, mp_int *c);
294
/* ---> Basic arithmetic <--- */
297
int mp_neg(mp_int *a, mp_int *b);
300
int mp_abs(mp_int *a, mp_int *b);
303
int mp_cmp(mp_int *a, mp_int *b);
305
/* compare |a| to |b| */
306
int mp_cmp_mag(mp_int *a, mp_int *b);
309
int mp_add(mp_int *a, mp_int *b, mp_int *c);
312
int mp_sub(mp_int *a, mp_int *b, mp_int *c);
315
int mp_mul(mp_int *a, mp_int *b, mp_int *c);
318
int mp_sqr(mp_int *a, mp_int *b);
320
/* a/b => cb + d == a */
321
int mp_div(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
323
/* c = a mod b, 0 <= c < b */
324
int mp_mod(mp_int *a, mp_int *b, mp_int *c);
326
/* ---> single digit functions <--- */
328
/* compare against a single digit */
329
int mp_cmp_d(mp_int *a, mp_digit b);
332
int mp_add_d(mp_int *a, mp_digit b, mp_int *c);
335
int mp_sub_d(mp_int *a, mp_digit b, mp_int *c);
338
int mp_mul_d(mp_int *a, mp_digit b, mp_int *c);
340
/* a/b => cb + d == a */
341
int mp_div_d(mp_int *a, mp_digit b, mp_int *c, mp_digit *d);
343
/* a/3 => 3c + d == a */
344
int mp_div_3(mp_int *a, mp_int *c, mp_digit *d);
347
int mp_expt_d(mp_int *a, mp_digit b, mp_int *c);
349
/* c = a mod b, 0 <= c < b */
350
int mp_mod_d(mp_int *a, mp_digit b, mp_digit *c);
352
/* ---> number theory <--- */
354
/* d = a + b (mod c) */
355
int mp_addmod(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
357
/* d = a - b (mod c) */
358
int mp_submod(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
360
/* d = a * b (mod c) */
361
int mp_mulmod(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
363
/* c = a * a (mod b) */
364
int mp_sqrmod(mp_int *a, mp_int *b, mp_int *c);
366
/* c = 1/a (mod b) */
367
int mp_invmod(mp_int *a, mp_int *b, mp_int *c);
370
int mp_gcd(mp_int *a, mp_int *b, mp_int *c);
372
/* produces value such that U1*a + U2*b = U3 */
373
int mp_exteuclid(mp_int *a, mp_int *b, mp_int *U1, mp_int *U2, mp_int *U3);
375
/* c = [a, b] or (a*b)/(a, b) */
376
int mp_lcm(mp_int *a, mp_int *b, mp_int *c);
378
/* finds one of the b'th root of a, such that |c|**b <= |a|
380
* returns error if a < 0 and b is even
382
int mp_n_root(mp_int *a, mp_digit b, mp_int *c);
384
/* special sqrt algo */
385
int mp_sqrt(mp_int *arg, mp_int *ret);
387
/* is number a square? */
388
int mp_is_square(mp_int *arg, int *ret);
390
/* computes the jacobi c = (a | n) (or Legendre if b is prime) */
391
int mp_jacobi(mp_int *a, mp_int *n, int *c);
393
/* used to setup the Barrett reduction for a given modulus b */
394
int mp_reduce_setup(mp_int *a, mp_int *b);
396
/* Barrett Reduction, computes a (mod b) with a precomputed value c
398
* Assumes that 0 < a <= b*b, note if 0 > a > -(b*b) then you can merely
399
* compute the reduction as -1 * mp_reduce(mp_abs(a)) [pseudo code].
401
int mp_reduce(mp_int *a, mp_int *b, mp_int *c);
403
/* setups the montgomery reduction */
404
int mp_montgomery_setup(mp_int *a, mp_digit *mp);
406
/* computes a = B**n mod b without division or multiplication useful for
407
* normalizing numbers in a Montgomery system.
409
int mp_montgomery_calc_normalization(mp_int *a, mp_int *b);
411
/* computes x/R == x (mod N) via Montgomery Reduction */
412
int mp_montgomery_reduce(mp_int *a, mp_int *m, mp_digit mp);
414
/* returns 1 if a is a valid DR modulus */
415
int mp_dr_is_modulus(mp_int *a);
417
/* sets the value of "d" required for mp_dr_reduce */
418
void mp_dr_setup(mp_int *a, mp_digit *d);
420
/* reduces a modulo b using the Diminished Radix method */
421
int mp_dr_reduce(mp_int *a, mp_int *b, mp_digit mp);
423
/* returns true if a can be reduced with mp_reduce_2k */
424
int mp_reduce_is_2k(mp_int *a);
426
/* determines k value for 2k reduction */
427
int mp_reduce_2k_setup(mp_int *a, mp_digit *d);
429
/* reduces a modulo b where b is of the form 2**p - k [0 <= a] */
430
int mp_reduce_2k(mp_int *a, mp_int *n, mp_digit d);
432
/* d = a**b (mod c) */
433
int mp_exptmod(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
435
/* ---> Primes <--- */
437
/* number of primes */
439
#define PRIME_SIZE 31
441
#define PRIME_SIZE 256
444
/* table of first PRIME_SIZE primes */
445
extern const mp_digit __prime_tab[];
447
/* result=1 if a is divisible by one of the first PRIME_SIZE primes */
448
int mp_prime_is_divisible(mp_int *a, int *result);
450
/* performs one Fermat test of "a" using base "b".
451
* Sets result to 0 if composite or 1 if probable prime
453
int mp_prime_fermat(mp_int *a, mp_int *b, int *result);
455
/* performs one Miller-Rabin test of "a" using base "b".
456
* Sets result to 0 if composite or 1 if probable prime
458
int mp_prime_miller_rabin(mp_int *a, mp_int *b, int *result);
460
/* This gives [for a given bit size] the number of trials required
461
* such that Miller-Rabin gives a prob of failure lower than 2^-96
463
int mp_prime_rabin_miller_trials(int size);
465
/* performs t rounds of Miller-Rabin on "a" using the first
466
* t prime bases. Also performs an initial sieve of trial
467
* division. Determines if "a" is prime with probability
468
* of error no more than (1/4)**t.
470
* Sets result to 1 if probably prime, 0 otherwise
472
int mp_prime_is_prime(mp_int *a, int t, int *result);
474
/* finds the next prime after the number "a" using "t" trials
477
* bbs_style = 1 means the prime must be congruent to 3 mod 4
479
int mp_prime_next_prime(mp_int *a, int t, int bbs_style);
481
/* makes a truly random prime of a given size (bytes),
482
* call with bbs = 1 if you want it to be congruent to 3 mod 4
484
* You have to supply a callback which fills in a buffer with random bytes. "dat" is a parameter you can
485
* have passed to the callback (e.g. a state or something). This function doesn't use "dat" itself
488
* The prime generated will be larger than 2^(8*size).
490
#define mp_prime_random(a, t, size, bbs, cb, dat) mp_prime_random_ex(a, t, ((size) * 8) + 1, (bbs==1)?LTM_PRIME_BBS:0, cb, dat)
492
/* makes a truly random prime of a given size (bits),
494
* Flags are as follows:
496
* LTM_PRIME_BBS - make prime congruent to 3 mod 4
497
* LTM_PRIME_SAFE - make sure (p-1)/2 is prime as well (implies LTM_PRIME_BBS)
498
* LTM_PRIME_2MSB_OFF - make the 2nd highest bit zero
499
* LTM_PRIME_2MSB_ON - make the 2nd highest bit one
501
* You have to supply a callback which fills in a buffer with random bytes. "dat" is a parameter you can
502
* have passed to the callback (e.g. a state or something). This function doesn't use "dat" itself
506
int mp_prime_random_ex(mp_int *a, int t, int size, int flags, ltm_prime_callback cb, void *dat);
508
/* ---> radix conversion <--- */
509
int mp_count_bits(mp_int *a);
511
int mp_unsigned_bin_size(mp_int *a);
512
int mp_read_unsigned_bin(mp_int *a, unsigned char *b, int c);
513
int mp_to_unsigned_bin(mp_int *a, unsigned char *b);
515
int mp_signed_bin_size(mp_int *a);
516
int mp_read_signed_bin(mp_int *a, unsigned char *b, int c);
517
int mp_to_signed_bin(mp_int *a, unsigned char *b);
519
int mp_read_radix(mp_int *a, char *str, int radix);
520
int mp_toradix(mp_int *a, char *str, int radix);
521
int mp_toradix_n(mp_int * a, char *str, int radix, int maxlen);
522
int mp_radix_size(mp_int *a, int radix, int *size);
524
int mp_fread(mp_int *a, int radix, FILE *stream);
525
int mp_fwrite(mp_int *a, int radix, FILE *stream);
527
#define mp_read_raw(mp, str, len) mp_read_signed_bin((mp), (str), (len))
528
#define mp_raw_size(mp) mp_signed_bin_size(mp)
529
#define mp_toraw(mp, str) mp_to_signed_bin((mp), (str))
530
#define mp_read_mag(mp, str, len) mp_read_unsigned_bin((mp), (str), (len))
531
#define mp_mag_size(mp) mp_unsigned_bin_size(mp)
532
#define mp_tomag(mp, str) mp_to_unsigned_bin((mp), (str))
534
#define mp_tobinary(M, S) mp_toradix((M), (S), 2)
535
#define mp_tooctal(M, S) mp_toradix((M), (S), 8)
536
#define mp_todecimal(M, S) mp_toradix((M), (S), 10)
537
#define mp_tohex(M, S) mp_toradix((M), (S), 16)
539
/* lowlevel functions, do not call! */
540
int s_mp_add(mp_int *a, mp_int *b, mp_int *c);
541
int s_mp_sub(mp_int *a, mp_int *b, mp_int *c);
542
#define s_mp_mul(a, b, c) s_mp_mul_digs(a, b, c, (a)->used + (b)->used + 1)
543
int fast_s_mp_mul_digs(mp_int *a, mp_int *b, mp_int *c, int digs);
544
int s_mp_mul_digs(mp_int *a, mp_int *b, mp_int *c, int digs);
545
int fast_s_mp_mul_high_digs(mp_int *a, mp_int *b, mp_int *c, int digs);
546
int s_mp_mul_high_digs(mp_int *a, mp_int *b, mp_int *c, int digs);
547
int fast_s_mp_sqr(mp_int *a, mp_int *b);
548
int s_mp_sqr(mp_int *a, mp_int *b);
549
int mp_karatsuba_mul(mp_int *a, mp_int *b, mp_int *c);
550
int mp_toom_mul(mp_int *a, mp_int *b, mp_int *c);
551
int mp_karatsuba_sqr(mp_int *a, mp_int *b);
552
int mp_toom_sqr(mp_int *a, mp_int *b);
553
int fast_mp_invmod(mp_int *a, mp_int *b, mp_int *c);
554
int mp_invmod_slow (mp_int * a, mp_int * b, mp_int * c);
555
int fast_mp_montgomery_reduce(mp_int *a, mp_int *m, mp_digit mp);
556
int mp_exptmod_fast(mp_int *G, mp_int *X, mp_int *P, mp_int *Y, int mode);
557
int s_mp_exptmod (mp_int * G, mp_int * X, mp_int * P, mp_int * Y);
558
void bn_reverse(unsigned char *s, int len);
560
extern const char *mp_s_rmap;