libtommath/tommath.h

596 lines
19 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 */
#ifndef TOMMATH_H_
#define TOMMATH_H_
2003-02-28 16:02:06 +00:00
#include <stddef.h>
2019-10-26 17:33:36 +00:00
#include <stdint.h>
#include <stdbool.h>
2003-02-28 16:02:06 +00:00
2019-04-26 10:35:39 +00:00
#ifndef MP_NO_FILE
# include <stdio.h>
#endif
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) */
#if (defined(_MSC_VER) || defined(__LLP64__) || defined(__e2k__) || defined(__LCC__)) && !defined(MP_64BIT)
# 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__)
2019-09-09 00:58:18 +00:00
# if !(defined(MP_64BIT) || defined(MP_32BIT) || defined(MP_16BIT))
Fix building on HP-UX 11.11 / PA-RISC $ perl -v This is perl 5, version 28, subversion 2 (v5.28.2) built for PA-RISC2.0-thread-multi-LP64 $ perl Makefile.PL Checking if your kit is complete... Looks good Generating a Unix-style Makefile Writing Makefile for CryptX Writing MYMETA.yml and MYMETA.json $ make : : gcc64 -Iltm -Iltc/headers -DLTC_SOURCE -DLTC_NO_TEST -DLTC_NO_PROTOTYPES -DLTM_DESC -D_POSIX_C_SOURCE=199506L -D_REENTRANT -mpa-risc-2-0 -fPIC -D_HPUX_SOURCE -fwrapv -fno-strict-aliasing -pipe -I/usr/local/pa20_64/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -D_FORTIFY_SOURCE=2 -fPIC -g -O -DARGTYPE=4 -c ltc/math/ltm_desc.c -o ltc/math/ltm_desc.o In file included from ltc/math/ltm_desc.c:15:0: ltm/tommath.h:74:1: error: unable to emulate 'TI' make[1]: *** [ltc/math/ltm_desc.o] Error 1 make[1]: Leaving directory `/data/cpan-build/CryptX-0.063-0/src' make: *** [src/liballinone.a] Error 2 $ gcc64 --version gcc64 (GCC) 4.6.1 Copyright (C) 2011 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. $ perl -V:cppsymbols cppsymbols='_FILE_OFFSET_BITS=64 _HPUX_SOURCE=1 _LARGEFILE_SOURCE=1 _LFS64_LARGEFILE=1 _LFS_LARGEFILE=1 _LP64=1 _PA_RISC2_0=1 _POSIX_C_SOURCE=199506L _PROTOTYPES= _REENTRANT=1 _XOPEN_SOURCE_EXTENDED=1 _XPG4= _XPG4_EXTENDED= __BYTE_ORDER__=4321 __ELF__=1 __GNUC_MINOR__=6 __GNUC__=4 __LP64__=1 __PIC__=2 __STDC_EXT__=1 __STDC__=1 __hp9000s700=1 __hp9000s700__=1 __hp9000s800=1 __hp9000s800__=1 __hppa=1 __hppa__=1 __hpux=1 __hpux__=1 __pic__=2 __unix=1 __unix__=1';
2019-04-26 12:38:54 +00:00
# if defined(__GNUC__) && !defined(__hppa)
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
#ifdef MP_DIGIT_BIT
2019-09-09 00:58:18 +00:00
# error Defining MP_DIGIT_BIT is disallowed, use MP_16/31/32/64BIT
#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
*/
2019-09-09 00:58:18 +00:00
#if defined(MP_16BIT)
2017-08-30 17:15:27 +00:00
typedef uint16_t mp_digit;
# define MP_DIGIT_BIT 15
2003-05-17 12:33:54 +00:00
#elif defined(MP_64BIT)
2017-08-30 17:15:27 +00:00
typedef uint64_t mp_digit;
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
typedef uint32_t mp_digit;
# ifdef MP_31BIT
/*
* This is an extension that uses 31-bit digits.
* Please be aware that not all functions support this size, especially s_mp_mul_digs_fast
* will be reduced to work on small numbers only:
* Up to 8 limbs, 248 bits instead of up to 512 limbs, 15872 bits with MP_28BIT.
*/
2019-04-13 06:46:57 +00:00
# define MP_DIGIT_BIT 31
# else
2019-05-24 09:48: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
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
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 */
typedef enum {
2019-10-08 19:47:57 +00:00
MP_ZPOS = 0, /* positive */
MP_NEG = 1 /* negative */
} mp_sign;
2019-10-16 07:26:04 +00:00
typedef enum {
2019-10-08 19:47:57 +00:00
MP_LT = -1, /* less than */
MP_EQ = 0, /* equal */
MP_GT = 1 /* greater than */
} mp_ord;
2019-10-16 07:26:04 +00:00
typedef enum {
2019-10-08 19:47:57 +00:00
MP_OKAY = 0, /* no error */
MP_ERR = -1, /* unknown error */
MP_MEM = -2, /* out of mem */
MP_VAL = -3, /* invalid input */
MP_ITER = -4, /* maximum iterations reached */
2019-10-19 14:24:55 +00:00
MP_BUF = -5 /* buffer overflow, supplied buffer too small */
} mp_err;
2019-10-16 07:26:04 +00:00
typedef enum {
MP_LSB_FIRST = -1,
MP_MSB_FIRST = 1
} mp_order;
2019-10-16 07:26:04 +00:00
typedef enum {
MP_LITTLE_ENDIAN = -1,
MP_NATIVE_ENDIAN = 0,
MP_BIG_ENDIAN = 1
} mp_endian;
2003-02-28 16:04:58 +00:00
/* tunable cutoffs */
#ifndef MP_FIXED_CUTOFFS
extern int
2019-10-22 16:01:08 +00:00
MP_KARATSUBA_MUL_CUTOFF,
MP_KARATSUBA_SQR_CUTOFF,
MP_TOOM_MUL_CUTOFF,
MP_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 */
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
/*
* MP_WUR - warn unused result
* ---------------------------
*
* The result of functions annotated with MP_WUR must be
* checked and cannot be ignored.
*
* Most functions in libtommath return an error code.
* This error code must be checked in order to prevent crashes or invalid
* results.
*
* If you still want to avoid the error checks for quick and dirty programs
* without robustness guarantees, you can `#define MP_WUR` before including
* tommath.h, disabling the warnings.
*/
#ifndef MP_WUR
# if defined(__GNUC__) && __GNUC__ >= 4
# define MP_WUR __attribute__((warn_unused_result))
# else
# define MP_WUR
# endif
#endif
2019-05-31 09:31:53 +00:00
#if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 405)
# 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(s)
# define MP_DEPRECATED_PRAGMA(s)
#endif
2003-12-24 18:59:22 +00:00
2019-04-26 10:39:26 +00:00
/* the infamous mp_int structure */
typedef struct {
int used, alloc;
mp_sign sign;
2019-04-26 10:39:26 +00:00
mp_digit *dp;
} mp_int;
2003-08-05 01:24:44 +00:00
/* error code to char* string */
const char *mp_error_to_string(mp_err code) MP_WUR;
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 */
mp_err mp_init(mp_int *a) MP_WUR;
2003-02-28 16:02:06 +00:00
/* free a bignum */
void mp_clear(mp_int *a);
2003-05-17 12:33:54 +00:00
/* init a null terminated series of arguments */
mp_err mp_init_multi(mp_int *mp, ...) MP_NULL_TERMINATED MP_WUR;
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 */
mp_err mp_shrink(mp_int *a) MP_WUR;
2003-02-28 16:02:06 +00:00
2003-03-29 18:16:01 +00:00
/* grow an int to a given size */
mp_err mp_grow(mp_int *a, int size) MP_WUR;
2003-03-29 18:16:01 +00:00
/* init to a given number of digits */
mp_err mp_init_size(mp_int *a, int size) MP_WUR;
2003-03-29 18:16:01 +00:00
2003-02-28 16:02:06 +00:00
/* ---> Basic Manipulations <--- */
#define mp_iszero(a) ((a)->used == 0)
#define mp_isneg(a) ((a)->sign != MP_ZPOS)
#define mp_iseven(a) (((a)->used == 0) || (((a)->dp[0] & 1u) == 0u))
2019-10-27 07:54:09 +00:00
#define mp_isodd(a) (!mp_iseven(a))
2003-02-28 16:02:06 +00:00
/* set to zero */
void mp_zero(mp_int *a);
/* get and set doubles */
double mp_get_double(const mp_int *a) MP_WUR;
mp_err mp_set_double(mp_int *a, double b) MP_WUR;
2018-09-10 16:51:26 +00:00
/* get integer, set integer and init with integer (int32_t) */
2019-05-24 08:21:54 +00:00
int32_t mp_get_i32(const mp_int *a) MP_WUR;
void mp_set_i32(mp_int *a, int32_t b);
mp_err mp_init_i32(mp_int *a, int32_t b) MP_WUR;
2003-02-28 16:02:06 +00:00
/* get integer, set integer and init with integer, behaves like two complement for negative numbers (uint32_t) */
2019-05-24 08:21:54 +00:00
#define mp_get_u32(a) ((uint32_t)mp_get_i32(a))
void mp_set_u32(mp_int *a, uint32_t b);
mp_err mp_init_u32(mp_int *a, uint32_t b) MP_WUR;
/* get integer, set integer and init with integer (int64_t) */
2019-05-24 08:21:54 +00:00
int64_t mp_get_i64(const mp_int *a) MP_WUR;
void mp_set_i64(mp_int *a, int64_t b);
mp_err mp_init_i64(mp_int *a, int64_t b) MP_WUR;
/* get integer, set integer and init with integer, behaves like two complement for negative numbers (uint64_t) */
2019-05-24 08:21:54 +00:00
#define mp_get_u64(a) ((uint64_t)mp_get_i64(a))
void mp_set_u64(mp_int *a, uint64_t b);
mp_err mp_init_u64(mp_int *a, uint64_t b) MP_WUR;
2018-09-10 16:51:26 +00:00
/* get magnitude */
uint32_t mp_get_mag_u32(const mp_int *a) MP_WUR;
uint64_t mp_get_mag_u64(const mp_int *a) MP_WUR;
unsigned long mp_get_mag_ul(const mp_int *a) MP_WUR;
unsigned long long mp_get_mag_ull(const mp_int *a) MP_WUR;
2004-04-11 20:46:22 +00:00
/* get integer, set integer (long) */
long mp_get_l(const mp_int *a) MP_WUR;
void mp_set_l(mp_int *a, long b);
2019-06-13 14:58:06 +00:00
mp_err mp_init_l(mp_int *a, long b) MP_WUR;
/* get integer, set integer (unsigned long) */
#define mp_get_ul(a) ((unsigned long)mp_get_l(a))
void mp_set_ul(mp_int *a, unsigned long b);
2019-06-13 14:58:06 +00:00
mp_err mp_init_ul(mp_int *a, unsigned long b) MP_WUR;
/* get integer, set integer (long long) */
long long mp_get_ll(const mp_int *a) MP_WUR;
void mp_set_ll(mp_int *a, long long b);
2019-06-13 14:58:06 +00:00
mp_err mp_init_ll(mp_int *a, long long b) MP_WUR;
/* get integer, set integer (unsigned long long) */
#define mp_get_ull(a) ((unsigned long long)mp_get_ll(a))
void mp_set_ull(mp_int *a, unsigned long long b);
2019-06-13 14:58:06 +00:00
mp_err mp_init_ull(mp_int *a, unsigned long long b) MP_WUR;
/* set to single unsigned digit, up to MP_DIGIT_MAX */
void mp_set(mp_int *a, mp_digit b);
mp_err mp_init_set(mp_int *a, mp_digit b) MP_WUR;
2004-04-11 20:46:22 +00:00
2003-02-28 16:02:06 +00:00
/* copy, b = a */
mp_err mp_copy(const mp_int *a, mp_int *b) MP_WUR;
2003-02-28 16:02:06 +00:00
/* inits and copies, a = b */
mp_err mp_init_copy(mp_int *a, const mp_int *b) MP_WUR;
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);
/* unpack binary data */
mp_err mp_unpack(mp_int *rop, size_t count, mp_order order, size_t size, mp_endian endian,
size_t nails, const void *op) MP_WUR;
/* pack binary data */
size_t mp_pack_count(const mp_int *a, size_t nails, size_t size) MP_WUR;
mp_err mp_pack(void *rop, size_t maxcount, size_t *written, mp_order order, size_t size,
mp_endian endian, size_t nails, const mp_int *op) MP_WUR;
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 */
mp_err mp_lshd(mp_int *a, int b) MP_WUR;
2003-02-28 16:02:06 +00:00
/* c = a / 2**b, implemented as c = a >> b */
mp_err mp_div_2d(const mp_int *a, int b, mp_int *c, mp_int *d) MP_WUR;
2003-02-28 16:02:06 +00:00
/* b = a/2 */
mp_err mp_div_2(const mp_int *a, mp_int *b) MP_WUR;
2003-02-28 16:02:06 +00:00
/* a/3 => 3c + d == a */
mp_err mp_div_3(const mp_int *a, mp_int *c, mp_digit *d) MP_WUR;
/* c = a * 2**b, implemented as c = a << b */
mp_err mp_mul_2d(const mp_int *a, int b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* b = a*2 */
mp_err mp_mul_2(const mp_int *a, mp_int *b) MP_WUR;
2003-02-28 16:02:06 +00:00
2013-09-02 15:52:11 +00:00
/* c = a mod 2**b */
mp_err mp_mod_2d(const mp_int *a, int b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
2003-05-17 12:33:54 +00:00
/* computes a = 2**b */
mp_err mp_2expt(mp_int *a, int b) MP_WUR;
2003-02-28 16:07:58 +00:00
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) MP_WUR;
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 */
mp_err mp_rand(mp_int *a, int digits) MP_WUR;
/* use custom random data source instead of source provided the platform */
void mp_rand_source(mp_err(*source)(void *out, size_t size));
2003-02-28 16:08:34 +00:00
/* ---> binary operations <--- */
/* c = a XOR b (two complement) */
mp_err mp_xor(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
/* c = a OR b (two complement) */
mp_err mp_or(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
/* c = a AND b (two complement) */
mp_err mp_and(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
/* b = ~a (bitwise not, two complement) */
mp_err mp_complement(const mp_int *a, mp_int *b) MP_WUR;
/* right shift with sign extension */
mp_err mp_signed_rsh(const mp_int *a, int b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* ---> Basic arithmetic <--- */
2003-02-28 16:03:08 +00:00
/* b = -a */
mp_err mp_neg(const mp_int *a, mp_int *b) MP_WUR;
2003-02-28 16:03:08 +00:00
/* b = |a| */
mp_err mp_abs(const mp_int *a, mp_int *b) MP_WUR;
2003-02-28 16:03:08 +00:00
2003-02-28 16:02:06 +00:00
/* compare a to b */
mp_ord mp_cmp(const mp_int *a, const mp_int *b) MP_WUR;
2003-02-28 16:02:06 +00:00
2003-02-28 16:03:08 +00:00
/* compare |a| to |b| */
mp_ord mp_cmp_mag(const mp_int *a, const mp_int *b) MP_WUR;
2003-02-28 16:03:08 +00:00
2003-02-28 16:02:06 +00:00
/* c = a + b */
mp_err mp_add(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* c = a - b */
mp_err mp_sub(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* c = a * b */
mp_err mp_mul(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
2003-05-17 12:33:54 +00:00
/* b = a*a */
mp_err mp_sqr(const mp_int *a, mp_int *b) MP_WUR;
2003-02-28 16:02:06 +00:00
/* a/b => cb + d == a */
mp_err mp_div(const mp_int *a, const mp_int *b, mp_int *c, mp_int *d) MP_WUR;
2003-02-28 16:02:06 +00:00
2003-02-28 16:03:48 +00:00
/* c = a mod b, 0 <= c < b */
mp_err mp_mod(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* Increment "a" by one like "a++". Changes input! */
2019-10-23 18:06:08 +00:00
#define mp_incr(a) mp_add_d((a), 1, (a))
/* Decrement "a" by one like "a--". Changes input! */
2019-10-23 18:06:08 +00:00
#define mp_decr(a) mp_sub_d((a), 1, (a))
2003-02-28 16:02:06 +00:00
/* ---> single digit functions <--- */
/* compare against a single digit */
mp_ord mp_cmp_d(const mp_int *a, mp_digit b) MP_WUR;
2003-02-28 16:02:06 +00:00
/* c = a + b */
mp_err mp_add_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* c = a - b */
mp_err mp_sub_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* c = a * b */
mp_err mp_mul_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* a/b => cb + d == a */
mp_err mp_div_d(const mp_int *a, mp_digit b, mp_int *c, mp_digit *d) MP_WUR;
2003-02-28 16:02:06 +00:00
2003-02-28 16:03:48 +00:00
/* c = a mod b, 0 <= c < b */
mp_err mp_mod_d(const mp_int *a, mp_digit b, mp_digit *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* ---> number theory <--- */
/* d = a + b (mod c) */
mp_err mp_addmod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d) MP_WUR;
2003-02-28 16:02:06 +00:00
/* d = a - b (mod c) */
mp_err mp_submod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d) MP_WUR;
2003-02-28 16:02:06 +00:00
/* d = a * b (mod c) */
mp_err mp_mulmod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d) MP_WUR;
2003-02-28 16:02:06 +00:00
/* c = a * a (mod b) */
mp_err mp_sqrmod(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* c = 1/a (mod b) */
mp_err mp_invmod(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* c = (a, b) */
mp_err mp_gcd(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
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 */
mp_err mp_exteuclid(const mp_int *a, const mp_int *b, mp_int *U1, mp_int *U2, mp_int *U3) MP_WUR;
2004-01-25 17:40:21 +00:00
2003-02-28 16:02:06 +00:00
/* c = [a, b] or (a*b)/(a, b) */
mp_err mp_lcm(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
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
*/
2019-07-03 11:10:05 +00:00
mp_err mp_root_u32(const mp_int *a, uint32_t b, mp_int *c) MP_WUR;
2003-02-28 16:05:52 +00:00
2004-04-11 20:46:22 +00:00
/* special sqrt algo */
mp_err mp_sqrt(const mp_int *arg, mp_int *ret) MP_WUR;
2004-04-11 20:46:22 +00:00
2015-04-17 20:46:11 +00:00
/* special sqrt (mod prime) */
mp_err mp_sqrtmod_prime(const mp_int *n, const mp_int *prime, mp_int *ret) MP_WUR;
2015-04-17 20:46:11 +00:00
2004-04-11 20:46:22 +00:00
/* is number a square? */
mp_err mp_is_square(const mp_int *arg, bool *ret) MP_WUR;
2003-02-28 16:05:52 +00:00
/* computes the Kronecker symbol c = (a | p) (like jacobi() but with {a,p} in Z */
mp_err mp_kronecker(const mp_int *a, const mp_int *p, int *c) MP_WUR;
2003-02-28 16:02:06 +00:00
/* used to setup the Barrett reduction for a given modulus b */
mp_err mp_reduce_setup(mp_int *a, const mp_int *b) MP_WUR;
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
*/
mp_err mp_reduce(mp_int *x, const mp_int *m, const mp_int *mu) MP_WUR;
2003-02-28 16:07:32 +00:00
/* setups the montgomery reduction */
mp_err mp_montgomery_setup(const mp_int *n, mp_digit *rho) MP_WUR;
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.
*/
mp_err mp_montgomery_calc_normalization(mp_int *a, const mp_int *b) MP_WUR;
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 */
mp_err mp_montgomery_reduce(mp_int *x, const mp_int *n, mp_digit rho) MP_WUR;
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 */
bool mp_dr_is_modulus(const mp_int *a) MP_WUR;
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 */
mp_err mp_dr_reduce(mp_int *x, const mp_int *n, mp_digit k) MP_WUR;
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 */
bool mp_reduce_is_2k(const mp_int *a) MP_WUR;
2003-05-29 13:35:26 +00:00
/* determines k value for 2k reduction */
mp_err mp_reduce_2k_setup(const mp_int *a, mp_digit *d) MP_WUR;
2003-05-29 13:35:26 +00:00
/* reduces a modulo b where b is of the form 2**p - k [0 <= a] */
mp_err mp_reduce_2k(mp_int *a, const mp_int *n, mp_digit d) MP_WUR;
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 */
bool mp_reduce_is_2k_l(const mp_int *a) MP_WUR;
2005-02-12 08:40:15 +00:00
/* determines k value for 2k reduction */
mp_err mp_reduce_2k_setup_l(const mp_int *a, mp_int *d) MP_WUR;
2005-02-12 08:40:15 +00:00
/* reduces a modulo b where b is of the form 2**p - k [0 <= a] */
mp_err mp_reduce_2k_l(mp_int *a, const mp_int *n, const mp_int *d) MP_WUR;
2005-02-12 08:40:15 +00:00
/* Y = G**X (mod P) */
mp_err mp_exptmod(const mp_int *G, const mp_int *X, const mp_int *P, mp_int *Y) MP_WUR;
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
/* 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
*/
mp_err mp_prime_fermat(const mp_int *a, const mp_int *b, bool *result) MP_WUR;
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
*/
mp_err mp_prime_miller_rabin(const mp_int *a, const mp_int *b, bool *result) MP_WUR;
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) MP_WUR;
2003-12-24 18:59:22 +00:00
/* performs one strong Lucas-Selfridge test of "a".
* Sets result to 0 if composite or 1 if probable prime
*/
mp_err mp_prime_strong_lucas_selfridge(const mp_int *a, bool *result) MP_WUR;
/* performs one Frobenius test of "a" as described by Paul Underwood.
* Sets result to 0 if composite or 1 if probable prime
*/
mp_err mp_prime_frobenius_underwood(const mp_int *N, bool *result) MP_WUR;
/* 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
*/
mp_err mp_prime_is_prime(const mp_int *a, int t, bool *result) MP_WUR;
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 = true means the prime must be congruent to 3 mod 4
2003-03-22 15:10:20 +00:00
*/
mp_err mp_prime_next_prime(mp_int *a, int t, bool bbs_style) MP_WUR;
2003-03-22 15:10:20 +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
*
*/
mp_err mp_prime_rand(mp_int *a, int t, int size, int flags) MP_WUR;
2019-04-03 21:50:57 +00:00
/* Integer logarithm to integer base */
2019-10-15 12:04:32 +00:00
mp_err mp_log_u32(const mp_int *a, uint32_t base, uint32_t *c) MP_WUR;
/* c = a**b */
2019-07-03 11:10:05 +00:00
mp_err mp_expt_u32(const mp_int *a, uint32_t b, mp_int *c) MP_WUR;
2019-04-03 21:50:57 +00:00
2003-02-28 16:02:06 +00:00
/* ---> radix conversion <--- */
int mp_count_bits(const mp_int *a) MP_WUR;
2003-02-28 16:02:06 +00:00
size_t mp_ubin_size(const mp_int *a) MP_WUR;
mp_err mp_from_ubin(mp_int *a, const unsigned char *buf, size_t size) MP_WUR;
mp_err mp_to_ubin(const mp_int *a, unsigned char *buf, size_t maxlen, size_t *written) MP_WUR;
size_t mp_sbin_size(const mp_int *a) MP_WUR;
mp_err mp_from_sbin(mp_int *a, const unsigned char *buf, size_t size) MP_WUR;
mp_err mp_to_sbin(const mp_int *a, unsigned char *buf, size_t maxlen, size_t *written) MP_WUR;
2003-02-28 16:02:06 +00:00
mp_err mp_read_radix(mp_int *a, const char *str, int radix) MP_WUR;
mp_err mp_to_radix(const mp_int *a, char *str, size_t maxlen, size_t *written, int radix) MP_WUR;
2019-10-21 17:12:22 +00:00
mp_err mp_radix_size(const mp_int *a, int radix, size_t *size) MP_WUR;
2003-02-28 16:03:08 +00:00
2019-04-26 10:35:39 +00:00
#ifndef MP_NO_FILE
mp_err mp_fread(mp_int *a, int radix, FILE *stream) MP_WUR;
mp_err mp_fwrite(const mp_int *a, int radix, FILE *stream) MP_WUR;
#endif
2003-05-17 12:33:54 +00:00
#define mp_to_binary(M, S, N) mp_to_radix((M), (S), (N), NULL, 2)
#define mp_to_octal(M, S, N) mp_to_radix((M), (S), (N), NULL, 8)
#define mp_to_decimal(M, S, N) mp_to_radix((M), (S), (N), NULL, 10)
#define mp_to_hex(M, S, N) mp_to_radix((M), (S), (N), NULL, 16)
2003-02-28 16:02:06 +00:00
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