libtommath/tommath.h

650 lines
21 KiB
C
Raw Normal View History

2019-04-07 13:29:11 +00:00
/* LibTomMath, multiple-precision integer library -- Tom St Denis */
/* SPDX-License-Identifier: Unlicense */
2003-02-28 16:02:06 +00:00
#ifndef BN_H_
#define BN_H_
#include <stdint.h>
2003-02-28 16:02:06 +00:00
#include <limits.h>
2019-04-26 10:39:26 +00:00
#ifdef LTM_NO_FILE
2019-04-26 10:35:39 +00:00
# warning LTM_NO_FILE has been deprecated, use MP_NO_FILE.
# define MP_NO_FILE
#endif
#ifndef MP_NO_FILE
# include <stdio.h>
#endif
#include "tommath_class.h"
2004-10-29 22:07:18 +00:00
2003-02-28 16:06:56 +00:00
#ifdef __cplusplus
extern "C" {
2003-03-22 15:10:20 +00:00
#endif
2003-02-28 16:06:56 +00:00
/* MS Visual C++ doesn't have a 128bit type for words, so fall back to 32bit MPI's (where words are 64bit) */
2018-02-26 08:32:12 +00:00
#if defined(_MSC_VER) || defined(__LLP64__) || defined(__e2k__) || defined(__LCC__)
# define MP_32BIT
#endif
2004-10-29 22:07:18 +00:00
/* detect 64-bit mode if possible */
#if defined(__x86_64__) || defined(_M_X64) || defined(_M_AMD64) || \
defined(__powerpc64__) || defined(__ppc64__) || defined(__PPC64__) || \
defined(__s390x__) || defined(__arch64__) || defined(__aarch64__) || \
defined(__sparcv9) || defined(__sparc_v9__) || defined(__sparc64__) || \
defined(__ia64) || defined(__ia64__) || defined(__itanium__) || defined(_M_IA64) || \
defined(__LP64__) || defined(_LP64) || defined(__64BIT__)
# if !(defined(MP_32BIT) || defined(MP_16BIT) || defined(MP_8BIT))
2018-05-28 20:02:13 +00:00
# if defined(__GNUC__)
2018-09-23 19:37:58 +00:00
/* we support 128bit integers only via: __attribute__((mode(TI))) */
2018-05-28 20:02:13 +00:00
# define MP_64BIT
# else
2018-09-23 19:37:58 +00:00
/* otherwise we fall back to MP_32BIT even on 64bit platforms */
2018-05-28 20:02:13 +00:00
# define MP_32BIT
# endif
# endif
2004-10-29 22:07:18 +00:00
#endif
2003-05-17 12:33:54 +00:00
/* some default configurations.
2003-02-28 16:02:06 +00:00
*
2019-04-13 06:46:57 +00:00
* A "mp_digit" must be able to hold MP_DIGIT_BIT + 1 bits
* A "mp_word" must be able to hold 2*MP_DIGIT_BIT + 1 bits
2003-02-28 16:02:06 +00:00
*
2003-05-17 12:33:54 +00:00
* At the very least a mp_digit must be able to hold 7 bits
* [any size beyond that is ok provided it doesn't overflow the data type]
2003-02-28 16:02:06 +00:00
*/
#ifdef MP_8BIT
2017-08-30 17:15:27 +00:00
typedef uint8_t mp_digit;
typedef uint16_t mp_word;
# define MP_SIZEOF_MP_DIGIT 1
2019-04-13 06:46:57 +00:00
# ifdef MP_DIGIT_BIT
# error You must not define MP_DIGIT_BIT when using MP_8BIT
# endif
2003-02-28 16:02:06 +00:00
#elif defined(MP_16BIT)
2017-08-30 17:15:27 +00:00
typedef uint16_t mp_digit;
typedef uint32_t mp_word;
# define MP_SIZEOF_MP_DIGIT 2
2019-04-13 06:46:57 +00:00
# ifdef MP_DIGIT_BIT
# error You must not define MP_DIGIT_BIT when using MP_16BIT
# endif
2003-05-17 12:33:54 +00:00
#elif defined(MP_64BIT)
2017-08-30 17:15:27 +00:00
/* for GCC only on supported platforms */
typedef uint64_t mp_digit;
typedef unsigned long mp_word __attribute__((mode(TI)));
2019-04-13 06:46:57 +00:00
# define MP_DIGIT_BIT 60
2003-02-28 16:02:06 +00:00
#else
2017-08-30 17:15:27 +00:00
/* this is the default case, 28-bit digits */
2014-02-14 10:30:15 +00:00
2017-08-30 17:15:27 +00:00
/* this is to make porting into LibTomCrypt easier :-) */
typedef uint32_t mp_digit;
typedef uint64_t mp_word;
2003-05-17 12:33:54 +00:00
# ifdef MP_31BIT
2017-08-30 17:15:27 +00:00
/* this is an extension that uses 31-bit digits */
2019-04-13 06:46:57 +00:00
# define MP_DIGIT_BIT 31
# else
2017-08-30 17:15:27 +00:00
/* default case is 28-bit digits, defines MP_28BIT as a handy macro to test */
2019-04-13 06:46:57 +00:00
# define MP_DIGIT_BIT 28
# define MP_28BIT
# endif
2003-05-17 12:33:54 +00:00
#endif
2003-02-28 16:02:06 +00:00
/* otherwise the bits per digit is calculated automatically from the size of a mp_digit */
2019-04-13 06:46:57 +00:00
#ifndef MP_DIGIT_BIT
# define MP_DIGIT_BIT (((CHAR_BIT * MP_SIZEOF_MP_DIGIT) - 1)) /* bits per digit */
#endif
2019-04-13 06:46:57 +00:00
#define MP_MASK ((((mp_digit)1)<<((mp_digit)MP_DIGIT_BIT))-((mp_digit)1))
2003-05-17 12:33:54 +00:00
#define MP_DIGIT_MAX MP_MASK
2003-02-28 16:02:06 +00:00
/* equalities */
#define MP_LT -1 /* less than */
#define MP_EQ 0 /* equal to */
#define MP_GT 1 /* greater than */
#define MP_ZPOS 0 /* positive integer */
#define MP_NEG 1 /* negative */
#define MP_OKAY 0 /* ok result */
#define MP_ERR -1 /* unknown error */
2003-02-28 16:03:48 +00:00
#define MP_MEM -2 /* out of mem */
#define MP_VAL -3 /* invalid input */
#define MP_RANGE MP_VAL
#define MP_ITER -4 /* Max. iterations reached */
2003-02-28 16:02:06 +00:00
2003-12-24 18:59:22 +00:00
#define MP_YES 1 /* yes response */
#define MP_NO 0 /* no response */
2004-04-11 20:46:22 +00:00
/* Primality generation flags */
#define MP_PRIME_BBS 0x0001 /* BBS style prime */
#define MP_PRIME_SAFE 0x0002 /* Safe prime (p-1)/2 == prime */
#define MP_PRIME_2MSB_ON 0x0008 /* force 2nd MSB to 1 */
#define LTM_PRIME_BBS (MP_DEPRECATED_PRAGMA("LTM_PRIME_BBS has been deprecated, use MP_PRIME_BBS") MP_PRIME_BBS)
#define LTM_PRIME_SAFE (MP_DEPRECATED_PRAGMA("LTM_PRIME_SAFE has been deprecated, use MP_PRIME_SAFE") MP_PRIME_SAFE)
#define LTM_PRIME_2MSB_ON (MP_DEPRECATED_PRAGMA("LTM_PRIME_2MSB_ON has been deprecated, use MP_PRIME_2MSB_ON") MP_PRIME_2MSB_ON)
2004-04-11 20:46:22 +00:00
2003-02-28 16:04:58 +00:00
typedef int mp_err;
/* tunable cutoffs */
#ifndef MP_FIXED_CUTOFFS
extern int
KARATSUBA_MUL_CUTOFF,
KARATSUBA_SQR_CUTOFF,
TOOM_MUL_CUTOFF,
TOOM_SQR_CUTOFF;
#endif
2003-02-28 16:06:22 +00:00
2003-05-17 12:33:54 +00:00
/* define this to use lower memory usage routines (exptmods mostly) */
/* #define MP_LOW_MEM */
2004-04-11 20:46:22 +00:00
/* default precision */
#ifndef MP_PREC
# ifndef MP_LOW_MEM
# define MP_PREC 32 /* default digits of precision */
# else
# define MP_PREC 8 /* default digits of precision */
# endif
2004-04-11 20:46:22 +00:00
#endif
2003-05-17 12:33:54 +00:00
/* size of comba arrays, should be at least 2 * 2**(BITS_PER_WORD - BITS_PER_DIGIT*2) */
2019-04-25 13:36:35 +00:00
#define PRIVATE_MP_WARRAY (1u << (((CHAR_BIT * sizeof(mp_word)) - (2 * MP_DIGIT_BIT)) + 1))
#define MP_WARRAY (MP_DEPRECATED_PRAGMA("MP_WARRAY is an internal macro") PRIVATE_MP_WARRAY)
2003-02-28 16:02:06 +00:00
2019-04-25 17:35:19 +00:00
#if defined(__GNUC__) && __GNUC__ >= 4
# define MP_NULL_TERMINATED __attribute__((sentinel))
#else
# define MP_NULL_TERMINATED
#endif
#if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 301)
# define MP_DEPRECATED(x) __attribute__((deprecated("replaced by " #x)))
2019-04-25 13:36:35 +00:00
# define PRIVATE_MP_DEPRECATED_PRAGMA(s) _Pragma(#s)
# define MP_DEPRECATED_PRAGMA(s) PRIVATE_MP_DEPRECATED_PRAGMA(GCC warning s)
#elif defined(_MSC_VER) && _MSC_VER >= 1500
# define MP_DEPRECATED(x) __declspec(deprecated("replaced by " #x))
# define MP_DEPRECATED_PRAGMA(s) __pragma(message(s))
#else
# define MP_DEPRECATED
# define MP_DEPRECATED_PRAGMA(s)
#endif
2003-12-24 18:59:22 +00:00
2019-04-13 06:46:57 +00:00
#define DIGIT_BIT (MP_DEPRECATED_PRAGMA("DIGIT_BIT macro is deprecated, MP_DIGIT_BIT instead") MP_DIGIT_BIT)
#define USED(m) (MP_DEPRECATED_PRAGMA("USED macro is deprecated, use z->used instead") (m)->used)
#define DIGIT(m, k) (MP_DEPRECATED_PRAGMA("DIGIT macro is deprecated, use z->dp instead") (m)->dp[(k)])
#define SIGN(m) (MP_DEPRECATED_PRAGMA("SIGN macro is deprecated, use z->sign instead") (m)->sign)
2003-02-28 16:03:48 +00:00
2019-04-26 10:39:26 +00:00
/* the infamous mp_int structure */
typedef struct {
int used, alloc, sign;
mp_digit *dp;
} mp_int;
/* callback for mp_prime_random, should fill dst with random bytes and return how many read [upto len] */
typedef int mp_prime_callback(unsigned char *dst, int len, void *dat);
typedef mp_prime_callback ltm_prime_callback MP_DEPRECATED(mp_prime_callback);
2003-08-05 01:24:44 +00:00
/* error code to char* string */
2012-01-09 05:50:09 +00:00
const char *mp_error_to_string(int code);
2003-02-28 16:02:06 +00:00
2003-08-05 01:24:44 +00:00
/* ---> init and deinit bignum functions <--- */
2003-02-28 16:02:06 +00:00
/* init a bignum */
int mp_init(mp_int *a);
/* free a bignum */
void mp_clear(mp_int *a);
2003-05-17 12:33:54 +00:00
/* init a null terminated series of arguments */
2019-04-25 17:35:19 +00:00
int mp_init_multi(mp_int *mp, ...) MP_NULL_TERMINATED;
2003-05-17 12:33:54 +00:00
/* clear a null terminated series of arguments */
2019-04-25 17:35:19 +00:00
void mp_clear_multi(mp_int *mp, ...) MP_NULL_TERMINATED;
2003-05-17 12:33:54 +00:00
2003-02-28 16:04:18 +00:00
/* exchange two ints */
void mp_exch(mp_int *a, mp_int *b);
2003-02-28 16:02:06 +00:00
/* shrink ram required for a bignum */
int mp_shrink(mp_int *a);
2003-03-29 18:16:01 +00:00
/* grow an int to a given size */
int mp_grow(mp_int *a, int size);
/* init to a given number of digits */
int mp_init_size(mp_int *a, int size);
2003-02-28 16:02:06 +00:00
/* ---> Basic Manipulations <--- */
2003-12-24 18:59:22 +00:00
#define mp_iszero(a) (((a)->used == 0) ? MP_YES : MP_NO)
int mp_iseven(const mp_int *a);
int mp_isodd(const mp_int *a);
#define mp_isneg(a) (((a)->sign != MP_ZPOS) ? MP_YES : MP_NO)
2003-02-28 16:02:06 +00:00
/* set to zero */
void mp_zero(mp_int *a);
/* set to a digit */
void mp_set(mp_int *a, mp_digit b);
2018-09-10 16:51:26 +00:00
/* set a double */
int mp_set_double(mp_int *a, double b);
2003-02-28 16:02:06 +00:00
/* set a 32-bit const */
2003-12-24 18:59:22 +00:00
int mp_set_int(mp_int *a, unsigned long b);
2003-02-28 16:02:06 +00:00
/* set a platform dependent unsigned long value */
int mp_set_long(mp_int *a, unsigned long b);
/* set a platform dependent unsigned long long value */
int mp_set_long_long(mp_int *a, unsigned long long b);
2018-09-10 16:51:26 +00:00
/* get a double */
double mp_get_double(const mp_int *a);
2004-04-11 20:46:22 +00:00
/* get a 32-bit value */
2017-09-20 14:59:43 +00:00
unsigned long mp_get_int(const mp_int *a);
2004-04-11 20:46:22 +00:00
/* get a platform dependent unsigned long value */
2017-09-20 14:59:43 +00:00
unsigned long mp_get_long(const mp_int *a);
/* get a platform dependent unsigned long long value */
2017-09-20 14:59:43 +00:00
unsigned long long mp_get_long_long(const mp_int *a);
2004-04-11 20:46:22 +00:00
/* initialize and set a digit */
2017-08-30 17:15:27 +00:00
int mp_init_set(mp_int *a, mp_digit b);
2004-04-11 20:46:22 +00:00
/* initialize and set 32-bit value */
2017-08-30 17:15:27 +00:00
int mp_init_set_int(mp_int *a, unsigned long b);
2004-04-11 20:46:22 +00:00
2003-02-28 16:02:06 +00:00
/* copy, b = a */
int mp_copy(const mp_int *a, mp_int *b);
2003-02-28 16:02:06 +00:00
/* inits and copies, a = b */
int mp_init_copy(mp_int *a, const mp_int *b);
2003-02-28 16:02:06 +00:00
2003-02-28 16:08:34 +00:00
/* trim unused digits */
void mp_clamp(mp_int *a);
2013-01-22 20:29:12 +00:00
/* import binary data */
2017-08-30 17:15:27 +00:00
int mp_import(mp_int *rop, size_t count, int order, size_t size, int endian, size_t nails, const void *op);
2013-01-22 20:29:12 +00:00
/* export binary data */
2017-09-30 20:57:00 +00:00
int mp_export(void *rop, size_t *countp, int order, size_t size, int endian, size_t nails, const mp_int *op);
2013-01-22 20:29:12 +00:00
2003-02-28 16:02:06 +00:00
/* ---> digit manipulation <--- */
/* right shift by "b" digits */
void mp_rshd(mp_int *a, int b);
/* left shift by "b" digits */
int mp_lshd(mp_int *a, int b);
/* c = a / 2**b, implemented as c = a >> b */
int mp_div_2d(const mp_int *a, int b, mp_int *c, mp_int *d);
2003-02-28 16:02:06 +00:00
/* b = a/2 */
2017-09-20 14:59:43 +00:00
int mp_div_2(const mp_int *a, mp_int *b);
2003-02-28 16:02:06 +00:00
/* c = a * 2**b, implemented as c = a << b */
int mp_mul_2d(const mp_int *a, int b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* b = a*2 */
2017-09-20 14:59:43 +00:00
int mp_mul_2(const mp_int *a, mp_int *b);
2003-02-28 16:02:06 +00:00
2013-09-02 15:52:11 +00:00
/* c = a mod 2**b */
int mp_mod_2d(const mp_int *a, int b, mp_int *c);
2003-02-28 16:02:06 +00:00
2003-05-17 12:33:54 +00:00
/* computes a = 2**b */
2003-02-28 16:07:58 +00:00
int mp_2expt(mp_int *a, int b);
2003-07-02 15:39:39 +00:00
/* Counts the number of lsbs which are zero before the first zero bit */
int mp_cnt_lsb(const mp_int *a);
2003-07-02 15:39:39 +00:00
2003-12-24 18:59:22 +00:00
/* I Love Earth! */
/* makes a pseudo-random mp_int of a given size */
2003-02-28 16:08:34 +00:00
int mp_rand(mp_int *a, int digits);
/* makes a pseudo-random small int of a given size */
MP_DEPRECATED(mp_rand) int mp_rand_digit(mp_digit *r);
/* use custom random data source instead of source provided the platform */
void mp_rand_source(int source(void *, size_t));
2003-02-28 16:08:34 +00:00
#ifdef MP_PRNG_ENABLE_LTM_RNG
# warning MP_PRNG_ENABLE_LTM_RNG has been deprecated, use mp_rand_source instead.
2018-12-26 14:19:07 +00:00
/* A last resort to provide random data on systems without any of the other
* implemented ways to gather entropy.
* It is compatible with `rng_get_bytes()` from libtomcrypt so you could
* provide that one and then set `ltm_rng = rng_get_bytes;` */
extern unsigned long (*ltm_rng)(unsigned char *out, unsigned long outlen, void (*callback)(void));
extern void (*ltm_rng_callback)(void);
#endif
2003-02-28 16:08:34 +00:00
/* ---> binary operations <--- */
/* c = a XOR b */
2017-09-20 14:59:43 +00:00
int mp_xor(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:08:34 +00:00
/* c = a OR b */
2017-09-20 14:59:43 +00:00
int mp_or(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:08:34 +00:00
/* c = a AND b */
2017-09-20 14:59:43 +00:00
int mp_and(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:08:34 +00:00
/* Checks the bit at position b and returns MP_YES
if the bit is 1, MP_NO if it is 0 and MP_VAL
in case of error */
int mp_get_bit(const mp_int *a, int b);
/* c = a XOR b (two complement) */
int mp_tc_xor(const mp_int *a, const mp_int *b, mp_int *c);
/* c = a OR b (two complement) */
int mp_tc_or(const mp_int *a, const mp_int *b, mp_int *c);
/* c = a AND b (two complement) */
int mp_tc_and(const mp_int *a, const mp_int *b, mp_int *c);
/* right shift (two complement) */
int mp_tc_div_2d(const mp_int *a, int b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* ---> Basic arithmetic <--- */
/* b = ~a */
int mp_complement(const mp_int *a, mp_int *b);
2003-02-28 16:03:08 +00:00
/* b = -a */
int mp_neg(const mp_int *a, mp_int *b);
2003-02-28 16:03:08 +00:00
/* b = |a| */
2017-09-20 14:59:43 +00:00
int mp_abs(const mp_int *a, mp_int *b);
2003-02-28 16:03:08 +00:00
2003-02-28 16:02:06 +00:00
/* compare a to b */
int mp_cmp(const mp_int *a, const mp_int *b);
2003-02-28 16:02:06 +00:00
2003-02-28 16:03:08 +00:00
/* compare |a| to |b| */
int mp_cmp_mag(const mp_int *a, const mp_int *b);
2003-02-28 16:03:08 +00:00
2003-02-28 16:02:06 +00:00
/* c = a + b */
2017-09-20 14:59:43 +00:00
int mp_add(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* c = a - b */
2017-09-20 14:59:43 +00:00
int mp_sub(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* c = a * b */
2017-09-20 14:59:43 +00:00
int mp_mul(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:02:06 +00:00
2003-05-17 12:33:54 +00:00
/* b = a*a */
2017-09-20 14:59:43 +00:00
int mp_sqr(const mp_int *a, mp_int *b);
2003-02-28 16:02:06 +00:00
/* a/b => cb + d == a */
2017-09-20 14:59:43 +00:00
int mp_div(const mp_int *a, const mp_int *b, mp_int *c, mp_int *d);
2003-02-28 16:02:06 +00:00
2003-02-28 16:03:48 +00:00
/* c = a mod b, 0 <= c < b */
2017-09-20 14:59:43 +00:00
int mp_mod(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* ---> single digit functions <--- */
/* compare against a single digit */
int mp_cmp_d(const mp_int *a, mp_digit b);
2003-02-28 16:02:06 +00:00
/* c = a + b */
2017-09-20 14:59:43 +00:00
int mp_add_d(const mp_int *a, mp_digit b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* Increment "a" by one like "a++". Changes input! */
int mp_incr(mp_int *a);
2003-02-28 16:02:06 +00:00
/* c = a - b */
2017-09-20 14:59:43 +00:00
int mp_sub_d(const mp_int *a, mp_digit b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* Decrement "a" by one like "a--". Changes input! */
int mp_decr(mp_int *a);
2003-02-28 16:02:06 +00:00
/* c = a * b */
2017-09-20 14:59:43 +00:00
int mp_mul_d(const mp_int *a, mp_digit b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* a/b => cb + d == a */
2017-09-20 14:59:43 +00:00
int mp_div_d(const mp_int *a, mp_digit b, mp_int *c, mp_digit *d);
2003-02-28 16:02:06 +00:00
2003-05-29 13:35:26 +00:00
/* a/3 => 3c + d == a */
2017-09-20 14:59:43 +00:00
int mp_div_3(const mp_int *a, mp_int *c, mp_digit *d);
2003-05-29 13:35:26 +00:00
2003-05-17 12:33:54 +00:00
/* c = a**b */
2017-09-20 14:59:43 +00:00
int mp_expt_d(const mp_int *a, mp_digit b, mp_int *c);
int mp_expt_d_ex(const mp_int *a, mp_digit b, mp_int *c, int fast);
2003-02-28 16:03:48 +00:00
/* c = a mod b, 0 <= c < b */
2017-09-20 14:59:43 +00:00
int mp_mod_d(const mp_int *a, mp_digit b, mp_digit *c);
2003-02-28 16:02:06 +00:00
/* ---> number theory <--- */
/* d = a + b (mod c) */
2017-09-20 14:59:43 +00:00
int mp_addmod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d);
2003-02-28 16:02:06 +00:00
/* d = a - b (mod c) */
2017-09-20 14:59:43 +00:00
int mp_submod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d);
2003-02-28 16:02:06 +00:00
/* d = a * b (mod c) */
2017-09-20 14:59:43 +00:00
int mp_mulmod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d);
2003-02-28 16:02:06 +00:00
/* c = a * a (mod b) */
2017-09-20 14:59:43 +00:00
int mp_sqrmod(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* c = 1/a (mod b) */
2017-09-20 14:59:43 +00:00
int mp_invmod(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:02:06 +00:00
/* c = (a, b) */
2017-09-20 14:59:43 +00:00
int mp_gcd(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:02:06 +00:00
2004-01-25 17:40:21 +00:00
/* produces value such that U1*a + U2*b = U3 */
2017-09-20 14:59:43 +00:00
int mp_exteuclid(const mp_int *a, const mp_int *b, mp_int *U1, mp_int *U2, mp_int *U3);
2004-01-25 17:40:21 +00:00
2003-02-28 16:02:06 +00:00
/* c = [a, b] or (a*b)/(a, b) */
2017-09-20 14:59:43 +00:00
int mp_lcm(const mp_int *a, const mp_int *b, mp_int *c);
2003-02-28 16:02:06 +00:00
2003-05-17 12:33:54 +00:00
/* finds one of the b'th root of a, such that |c|**b <= |a|
2003-02-28 16:05:52 +00:00
*
* returns error if a < 0 and b is even
*/
2017-09-20 14:59:43 +00:00
int mp_n_root(const mp_int *a, mp_digit b, mp_int *c);
int mp_n_root_ex(const mp_int *a, mp_digit b, mp_int *c, int fast);
2003-02-28 16:05:52 +00:00
2004-04-11 20:46:22 +00:00
/* special sqrt algo */
2017-09-20 14:59:43 +00:00
int mp_sqrt(const mp_int *arg, mp_int *ret);
2004-04-11 20:46:22 +00:00
2015-04-17 20:46:11 +00:00
/* special sqrt (mod prime) */
int mp_sqrtmod_prime(const mp_int *n, const mp_int *prime, mp_int *ret);
2015-04-17 20:46:11 +00:00
2004-04-11 20:46:22 +00:00
/* is number a square? */
2017-09-20 14:59:43 +00:00
int mp_is_square(const mp_int *arg, int *ret);
2003-02-28 16:05:52 +00:00
2003-02-28 16:06:56 +00:00
/* computes the jacobi c = (a | n) (or Legendre if b is prime) */
2017-09-20 14:59:43 +00:00
int mp_jacobi(const mp_int *a, const mp_int *n, int *c);
2003-02-28 16:06:56 +00:00
/* computes the Kronecker symbol c = (a | p) (like jacobi() but with {a,p} in Z */
int mp_kronecker(const mp_int *a, const mp_int *p, int *c);
2003-02-28 16:02:06 +00:00
/* used to setup the Barrett reduction for a given modulus b */
2017-09-20 14:59:43 +00:00
int mp_reduce_setup(mp_int *a, const mp_int *b);
2003-02-28 16:02:06 +00:00
2003-02-28 16:08:34 +00:00
/* Barrett Reduction, computes a (mod b) with a precomputed value c
2003-02-28 16:04:18 +00:00
*
* Assumes that 0 < x <= m*m, note if 0 > x > -(m*m) then you can merely
* compute the reduction as -1 * mp_reduce(mp_abs(x)) [pseudo code].
2003-02-28 16:04:18 +00:00
*/
int mp_reduce(mp_int *x, const mp_int *m, const mp_int *mu);
2003-02-28 16:07:32 +00:00
/* setups the montgomery reduction */
int mp_montgomery_setup(const mp_int *n, mp_digit *rho);
2003-02-28 16:07:32 +00:00
2003-05-17 12:33:54 +00:00
/* computes a = B**n mod b without division or multiplication useful for
2003-02-28 16:09:08 +00:00
* normalizing numbers in a Montgomery system.
*/
2017-09-20 14:59:43 +00:00
int mp_montgomery_calc_normalization(mp_int *a, const mp_int *b);
2003-02-28 16:09:08 +00:00
2003-05-17 12:33:54 +00:00
/* computes x/R == x (mod N) via Montgomery Reduction */
int mp_montgomery_reduce(mp_int *x, const mp_int *n, mp_digit rho);
2003-02-28 16:08:34 +00:00
2003-03-22 15:10:20 +00:00
/* returns 1 if a is a valid DR modulus */
2017-09-20 14:59:43 +00:00
int mp_dr_is_modulus(const mp_int *a);
2003-03-22 15:10:20 +00:00
/* sets the value of "d" required for mp_dr_reduce */
2017-09-20 14:59:43 +00:00
void mp_dr_setup(const mp_int *a, mp_digit *d);
2003-03-22 15:10:20 +00:00
/* reduces a modulo n using the Diminished Radix method */
int mp_dr_reduce(mp_int *x, const mp_int *n, mp_digit k);
2003-03-22 15:10:20 +00:00
2003-05-29 13:35:26 +00:00
/* returns true if a can be reduced with mp_reduce_2k */
2017-09-20 14:59:43 +00:00
int mp_reduce_is_2k(const mp_int *a);
2003-05-29 13:35:26 +00:00
/* determines k value for 2k reduction */
2017-09-20 14:59:43 +00:00
int mp_reduce_2k_setup(const mp_int *a, mp_digit *d);
2003-05-29 13:35:26 +00:00
/* reduces a modulo b where b is of the form 2**p - k [0 <= a] */
2017-09-20 14:59:43 +00:00
int mp_reduce_2k(mp_int *a, const mp_int *n, mp_digit d);
2003-05-29 13:35:26 +00:00
2005-02-12 08:40:15 +00:00
/* returns true if a can be reduced with mp_reduce_2k_l */
2017-09-20 14:59:43 +00:00
int mp_reduce_is_2k_l(const mp_int *a);
2005-02-12 08:40:15 +00:00
/* determines k value for 2k reduction */
2017-09-20 14:59:43 +00:00
int mp_reduce_2k_setup_l(const mp_int *a, mp_int *d);
2005-02-12 08:40:15 +00:00
/* reduces a modulo b where b is of the form 2**p - k [0 <= a] */
2017-09-30 20:57:00 +00:00
int mp_reduce_2k_l(mp_int *a, const mp_int *n, const mp_int *d);
2005-02-12 08:40:15 +00:00
/* Y = G**X (mod P) */
int mp_exptmod(const mp_int *G, const mp_int *X, const mp_int *P, mp_int *Y);
2003-02-28 16:02:06 +00:00
2003-03-22 15:10:20 +00:00
/* ---> Primes <--- */
2003-05-17 12:33:54 +00:00
/* number of primes */
#ifdef MP_8BIT
# define MP_PRIME_SIZE 31
2003-05-17 12:33:54 +00:00
#else
# define MP_PRIME_SIZE 256
2003-05-17 12:33:54 +00:00
#endif
#define PRIME_SIZE (MP_DEPRECATED_PRAGMA("PRIME_SIZE has been deprecated, use MP_PRIME_SIZE") MP_PRIME_SIZE)
2003-05-17 12:33:54 +00:00
/* table of first MP_PRIME_SIZE primes */
extern const mp_digit ltm_prime_tab[MP_PRIME_SIZE];
2003-03-22 15:10:20 +00:00
/* result=1 if a is divisible by one of the first MP_PRIME_SIZE primes */
2017-09-20 14:59:43 +00:00
int mp_prime_is_divisible(const mp_int *a, int *result);
2003-03-22 15:10:20 +00:00
2003-05-17 12:33:54 +00:00
/* performs one Fermat test of "a" using base "b".
* Sets result to 0 if composite or 1 if probable prime
2003-03-22 15:10:20 +00:00
*/
2017-09-20 14:59:43 +00:00
int mp_prime_fermat(const mp_int *a, const mp_int *b, int *result);
2003-03-22 15:10:20 +00:00
/* performs one Miller-Rabin test of "a" using base "b".
2003-05-17 12:33:54 +00:00
* Sets result to 0 if composite or 1 if probable prime
2003-03-22 15:10:20 +00:00
*/
2017-09-20 14:59:43 +00:00
int mp_prime_miller_rabin(const mp_int *a, const mp_int *b, int *result);
2003-03-22 15:10:20 +00:00
2003-12-24 18:59:22 +00:00
/* This gives [for a given bit size] the number of trials required
2014-02-14 10:30:15 +00:00
* such that Miller-Rabin gives a prob of failure lower than 2^-96
2003-12-24 18:59:22 +00:00
*/
int mp_prime_rabin_miller_trials(int size);
/* performs one strong Lucas-Selfridge test of "a".
* Sets result to 0 if composite or 1 if probable prime
*/
int mp_prime_strong_lucas_selfridge(const mp_int *a, int *result);
/* performs one Frobenius test of "a" as described by Paul Underwood.
* Sets result to 0 if composite or 1 if probable prime
*/
int mp_prime_frobenius_underwood(const mp_int *N, int *result);
/* performs t random rounds of Miller-Rabin on "a" additional to
* bases 2 and 3. Also performs an initial sieve of trial
2003-03-22 15:10:20 +00:00
* division. Determines if "a" is prime with probability
2003-05-17 12:33:54 +00:00
* of error no more than (1/4)**t.
* Both a strong Lucas-Selfridge to complete the BPSW test
* and a separate Frobenius test are available at compile time.
* With t<0 a deterministic test is run for primes up to
* 318665857834031151167461. With t<13 (abs(t)-13) additional
* tests with sequential small primes are run starting at 43.
* Is Fips 186.4 compliant if called with t as computed by
* mp_prime_rabin_miller_trials();
2003-03-22 15:10:20 +00:00
*
* Sets result to 1 if probably prime, 0 otherwise
*/
2017-09-20 14:59:43 +00:00
int mp_prime_is_prime(const mp_int *a, int t, int *result);
2003-03-22 15:10:20 +00:00
/* finds the next prime after the number "a" using "t" trials
* of Miller-Rabin.
2003-07-12 14:31:43 +00:00
*
* bbs_style = 1 means the prime must be congruent to 3 mod 4
2003-03-22 15:10:20 +00:00
*/
2003-07-12 14:31:43 +00:00
int mp_prime_next_prime(mp_int *a, int t, int bbs_style);
2003-03-22 15:10:20 +00:00
2003-12-24 18:59:22 +00:00
/* makes a truly random prime of a given size (bytes),
2014-02-14 10:30:15 +00:00
* call with bbs = 1 if you want it to be congruent to 3 mod 4
2003-12-24 18:59:22 +00:00
*
* You have to supply a callback which fills in a buffer with random bytes. "dat" is a parameter you can
* have passed to the callback (e.g. a state or something). This function doesn't use "dat" itself
* so it can be NULL
*
* The prime generated will be larger than 2^(8*size).
*/
#define mp_prime_random(a, t, size, bbs, cb, dat) mp_prime_random_ex(a, t, ((size) * 8) + 1, (bbs==1)?MP_PRIME_BBS:0, cb, dat)
2003-12-24 18:59:22 +00:00
2004-04-11 20:46:22 +00:00
/* makes a truly random prime of a given size (bits),
*
* Flags are as follows:
2014-02-14 10:30:15 +00:00
*
* MP_PRIME_BBS - make prime congruent to 3 mod 4
* MP_PRIME_SAFE - make sure (p-1)/2 is prime as well (implies MP_PRIME_BBS)
* MP_PRIME_2MSB_ON - make the 2nd highest bit one
2004-04-11 20:46:22 +00:00
*
* You have to supply a callback which fills in a buffer with random bytes. "dat" is a parameter you can
* have passed to the callback (e.g. a state or something). This function doesn't use "dat" itself
* so it can be NULL
*
*/
2019-04-26 10:39:26 +00:00
int mp_prime_random_ex(mp_int *a, int t, int size, int flags, mp_prime_callback cb, void *dat);
2003-12-24 18:59:22 +00:00
2019-04-03 21:50:57 +00:00
/* Integer logarithm to integer base */
int mp_ilogb(mp_int *a, mp_digit base, mp_int *c);
2003-02-28 16:02:06 +00:00
/* ---> radix conversion <--- */
int mp_count_bits(const mp_int *a);
2003-02-28 16:02:06 +00:00
2017-09-20 14:59:43 +00:00
int mp_unsigned_bin_size(const mp_int *a);
2005-08-01 16:37:28 +00:00
int mp_read_unsigned_bin(mp_int *a, const unsigned char *b, int c);
2017-09-20 14:59:43 +00:00
int mp_to_unsigned_bin(const mp_int *a, unsigned char *b);
int mp_to_unsigned_bin_n(const mp_int *a, unsigned char *b, unsigned long *outlen);
2003-02-28 16:02:06 +00:00
2017-09-20 14:59:43 +00:00
int mp_signed_bin_size(const mp_int *a);
2005-08-01 16:37:28 +00:00
int mp_read_signed_bin(mp_int *a, const unsigned char *b, int c);
2017-09-20 14:59:43 +00:00
int mp_to_signed_bin(const mp_int *a, unsigned char *b);
int mp_to_signed_bin_n(const mp_int *a, unsigned char *b, unsigned long *outlen);
2003-02-28 16:02:06 +00:00
2005-02-12 08:40:15 +00:00
int mp_read_radix(mp_int *a, const char *str, int radix);
2017-09-20 14:59:43 +00:00
int mp_toradix(const mp_int *a, char *str, int radix);
int mp_toradix_n(const mp_int *a, char *str, int radix, int maxlen);
int mp_radix_size(const mp_int *a, int radix, int *size);
2003-02-28 16:03:08 +00:00
2019-04-26 10:35:39 +00:00
#ifndef MP_NO_FILE
2003-05-17 12:33:54 +00:00
int mp_fread(mp_int *a, int radix, FILE *stream);
2017-09-20 14:59:43 +00:00
int mp_fwrite(const mp_int *a, int radix, FILE *stream);
#endif
2003-05-17 12:33:54 +00:00
#define mp_read_raw(mp, str, len) (MP_DEPRECATED_PRAGMA("replaced by mp_read_signed_bin") mp_read_signed_bin((mp), (str), (len)))
#define mp_raw_size(mp) (MP_DEPRECATED_PRAGMA("replaced by mp_signed_bin_size") mp_signed_bin_size(mp))
#define mp_toraw(mp, str) (MP_DEPRECATED_PRAGMA("replaced by mp_to_signed_bin") mp_to_signed_bin((mp), (str)))
#define mp_read_mag(mp, str, len) (MP_DEPRECATED_PRAGMA("replaced by mp_read_unsigned_bin") mp_read_unsigned_bin((mp), (str), (len))
#define mp_mag_size(mp) (MP_DEPRECATED_PRAGMA("replaced by mp_unsigned_bin_size") mp_unsigned_bin_size(mp))
#define mp_tomag(mp, str) (MP_DEPRECATED_PRAGMA("replaced by mp_to_unsigned_bin") mp_to_unsigned_bin((mp), (str)))
2003-02-28 16:02:06 +00:00
#define mp_tobinary(M, S) mp_toradix((M), (S), 2)
#define mp_tooctal(M, S) mp_toradix((M), (S), 8)
#define mp_todecimal(M, S) mp_toradix((M), (S), 10)
#define mp_tohex(M, S) mp_toradix((M), (S), 16)
2003-02-28 16:06:56 +00:00
#ifdef __cplusplus
2017-08-30 17:15:27 +00:00
}
2003-02-28 16:06:56 +00:00
#endif
2003-02-28 16:02:06 +00:00
#endif