Mercurial > dropbear

comparison libtommath/tommath.h @ 1739:13d834efc376 fuzz

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merge from main
author Matt Johnston <matt@ucc.asn.au>
date Thu, 15 Oct 2020 19:55:15 +0800
parents 1051e4eea25a
children
comparison
equal deleted inserted replaced
1562:768ebf737aa0 1739:13d834efc376
1 /* LibTomMath, multiple-precision integer library -- Tom St Denis 1 /* LibTomMath, multiple-precision integer library -- Tom St Denis */
2 * 2 /* SPDX-License-Identifier: Unlicense */
3 * LibTomMath is a library that provides multiple-precision 3
4 * integer arithmetic as well as number theoretic functionality.
5 *
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.
9 *
10 * The library is free for all purposes without any express
11 * guarantee it works.
12 *
13 * Tom St Denis, [email protected], http://math.libtomcrypt.com
14 */
15 #ifndef BN_H_ 4 #ifndef BN_H_
16 #define BN_H_ 5 #define BN_H_
17 6
18 #include <stdio.h>
19 #include <stdlib.h>
20 #include <stdint.h> 7 #include <stdint.h>
8 #include <stddef.h>
21 #include <limits.h> 9 #include <limits.h>
22 10
23 #include "tommath_class.h" 11 #ifdef LTM_NO_FILE
12 # warning LTM_NO_FILE has been deprecated, use MP_NO_FILE.
13 # define MP_NO_FILE
14 #endif
15
16 #ifndef MP_NO_FILE
17 # include <stdio.h>
18 #endif
19
20 #ifdef MP_8BIT
21 # ifdef _MSC_VER
22 # pragma message("8-bit (MP_8BIT) support is deprecated and will be dropped completely in the next version.")
23 # else
24 # warning "8-bit (MP_8BIT) support is deprecated and will be dropped completely in the next version."
25 # endif
26 #endif
24 27
25 #ifdef __cplusplus 28 #ifdef __cplusplus
26 extern "C" { 29 extern "C" {
30 #endif
31
32 /* MS Visual C++ doesn't have a 128bit type for words, so fall back to 32bit MPI's (where words are 64bit) */
33 #if (defined(_MSC_VER) || defined(__LLP64__) || defined(__e2k__) || defined(__LCC__)) && !defined(MP_64BIT)
34 # define MP_32BIT
27 #endif 35 #endif
28 36
29 /* detect 64-bit mode if possible */ 37 /* detect 64-bit mode if possible */
30 #if defined(__x86_64__) || defined(_M_X64) || defined(_M_AMD64) || \ 38 #if defined(__x86_64__) || defined(_M_X64) || defined(_M_AMD64) || \
31 defined(__powerpc64__) || defined(__ppc64__) || defined(__PPC64__) || \ 39 defined(__powerpc64__) || defined(__ppc64__) || defined(__PPC64__) || \
32 defined(__s390x__) || defined(__arch64__) || defined(__aarch64__) || \ 40 defined(__s390x__) || defined(__arch64__) || defined(__aarch64__) || \
33 defined(__sparcv9) || defined(__sparc_v9__) || defined(__sparc64__) || \ 41 defined(__sparcv9) || defined(__sparc_v9__) || defined(__sparc64__) || \
34 defined(__ia64) || defined(__ia64__) || defined(__itanium__) || defined(_M_IA64) || \ 42 defined(__ia64) || defined(__ia64__) || defined(__itanium__) || defined(_M_IA64) || \
35 defined(__LP64__) || defined(_LP64) || defined(__64BIT__) 43 defined(__LP64__) || defined(_LP64) || defined(__64BIT__)
36 #if !(defined(MP_32BIT) || defined(MP_16BIT) || defined(MP_8BIT)) 44 # if !(defined(MP_64BIT) || defined(MP_32BIT) || defined(MP_16BIT) || defined(MP_8BIT))
37 #define MP_64BIT 45 # if defined(__GNUC__) && !defined(__hppa)
38 #endif 46 /* we support 128bit integers only via: __attribute__((mode(TI))) */
47 # define MP_64BIT
48 # else
49 /* otherwise we fall back to MP_32BIT even on 64bit platforms */
50 # define MP_32BIT
51 # endif
52 # endif
53 #endif
54
55 #ifdef MP_DIGIT_BIT
56 # error Defining MP_DIGIT_BIT is disallowed, use MP_8/16/31/32/64BIT
39 #endif 57 #endif
40 58
41 /* some default configurations. 59 /* some default configurations.
42 * 60 *
43 * A "mp_digit" must be able to hold DIGIT_BIT + 1 bits 61 * A "mp_digit" must be able to hold MP_DIGIT_BIT + 1 bits
44 * A "mp_word" must be able to hold 2*DIGIT_BIT + 1 bits 62 * A "mp_word" must be able to hold 2*MP_DIGIT_BIT + 1 bits
45 * 63 *
46 * At the very least a mp_digit must be able to hold 7 bits 64 * At the very least a mp_digit must be able to hold 7 bits
47 * [any size beyond that is ok provided it doesn't overflow the data type] 65 * [any size beyond that is ok provided it doesn't overflow the data type]
48 */ 66 */
67
49 #ifdef MP_8BIT 68 #ifdef MP_8BIT
50 typedef uint8_t mp_digit; 69 typedef uint8_t mp_digit;
51 typedef uint16_t mp_word; 70 typedef uint16_t private_mp_word;
52 #define MP_SIZEOF_MP_DIGIT 1 71 # define MP_DIGIT_BIT 7
53 #ifdef DIGIT_BIT
54 #error You must not define DIGIT_BIT when using MP_8BIT
55 #endif
56 #elif defined(MP_16BIT) 72 #elif defined(MP_16BIT)
57 typedef uint16_t mp_digit; 73 typedef uint16_t mp_digit;
58 typedef uint32_t mp_word; 74 typedef uint32_t private_mp_word;
59 #define MP_SIZEOF_MP_DIGIT 2 75 # define MP_DIGIT_BIT 15
60 #ifdef DIGIT_BIT
61 #error You must not define DIGIT_BIT when using MP_16BIT
62 #endif
63 #elif defined(MP_64BIT) 76 #elif defined(MP_64BIT)
64 /* for GCC only on supported platforms */ 77 /* for GCC only on supported platforms */
65 typedef uint64_t mp_digit; 78 typedef uint64_t mp_digit;
66 #if defined(_WIN32) 79 #if defined(__GNUC__)
67 typedef unsigned __int128 mp_word; 80 typedef unsigned long private_mp_word __attribute__((mode(TI)));
68 #elif defined(__GNUC__) 81 #endif
69 typedef unsigned long mp_word __attribute__ ((mode(TI))); 82 # define MP_DIGIT_BIT 60
70 #else 83 #else
71 /* it seems you have a problem 84 typedef uint32_t mp_digit;
72 * but we assume you can somewhere define your own uint128_t */ 85 typedef uint64_t private_mp_word;
73 typedef uint128_t mp_word; 86 # ifdef MP_31BIT
74 #endif 87 /*
75 88 * This is an extension that uses 31-bit digits.
76 #define DIGIT_BIT 60 89 * Please be aware that not all functions support this size, especially s_mp_mul_digs_fast
90 * will be reduced to work on small numbers only:
91 * Up to 8 limbs, 248 bits instead of up to 512 limbs, 15872 bits with MP_28BIT.
92 */
93 # define MP_DIGIT_BIT 31
94 # else
95 /* default case is 28-bit digits, defines MP_28BIT as a handy macro to test */
96 # define MP_DIGIT_BIT 28
97 # define MP_28BIT
98 # endif
99 #endif
100
101 /* mp_word is a private type */
102 #define mp_word MP_DEPRECATED_PRAGMA("mp_word has been made private") private_mp_word
103
104 #define MP_SIZEOF_MP_DIGIT (MP_DEPRECATED_PRAGMA("MP_SIZEOF_MP_DIGIT has been deprecated, use sizeof (mp_digit)") sizeof (mp_digit))
105
106 #define MP_MASK ((((mp_digit)1)<<((mp_digit)MP_DIGIT_BIT))-((mp_digit)1))
107 #define MP_DIGIT_MAX MP_MASK
108
109 /* Primality generation flags */
110 #define MP_PRIME_BBS 0x0001 /* BBS style prime */
111 #define MP_PRIME_SAFE 0x0002 /* Safe prime (p-1)/2 == prime */
112 #define MP_PRIME_2MSB_ON 0x0008 /* force 2nd MSB to 1 */
113
114 #define LTM_PRIME_BBS (MP_DEPRECATED_PRAGMA("LTM_PRIME_BBS has been deprecated, use MP_PRIME_BBS") MP_PRIME_BBS)
115 #define LTM_PRIME_SAFE (MP_DEPRECATED_PRAGMA("LTM_PRIME_SAFE has been deprecated, use MP_PRIME_SAFE") MP_PRIME_SAFE)
116 #define LTM_PRIME_2MSB_ON (MP_DEPRECATED_PRAGMA("LTM_PRIME_2MSB_ON has been deprecated, use MP_PRIME_2MSB_ON") MP_PRIME_2MSB_ON)
117
118 #ifdef MP_USE_ENUMS
119 typedef enum {
120 MP_ZPOS = 0, /* positive */
121 MP_NEG = 1 /* negative */
122 } mp_sign;
123 typedef enum {
124 MP_LT = -1, /* less than */
125 MP_EQ = 0, /* equal */
126 MP_GT = 1 /* greater than */
127 } mp_ord;
128 typedef enum {
129 MP_NO = 0,
130 MP_YES = 1
131 } mp_bool;
132 typedef enum {
133 MP_OKAY = 0, /* no error */
134 MP_ERR = -1, /* unknown error */
135 MP_MEM = -2, /* out of mem */
136 MP_VAL = -3, /* invalid input */
137 MP_ITER = -4, /* maximum iterations reached */
138 MP_BUF = -5 /* buffer overflow, supplied buffer too small */
139 } mp_err;
140 typedef enum {
141 MP_LSB_FIRST = -1,
142 MP_MSB_FIRST = 1
143 } mp_order;
144 typedef enum {
145 MP_LITTLE_ENDIAN = -1,
146 MP_NATIVE_ENDIAN = 0,
147 MP_BIG_ENDIAN = 1
148 } mp_endian;
77 #else 149 #else
78 /* this is the default case, 28-bit digits */ 150 typedef int mp_sign;
79 151 #define MP_ZPOS 0 /* positive integer */
80 /* this is to make porting into LibTomCrypt easier :-) */ 152 #define MP_NEG 1 /* negative */
81 typedef uint32_t mp_digit; 153 typedef int mp_ord;
82 typedef uint64_t mp_word;
83
84 #ifdef MP_31BIT
85 /* this is an extension that uses 31-bit digits */
86 #define DIGIT_BIT 31
87 #else
88 /* default case is 28-bit digits, defines MP_28BIT as a handy macro to test */
89 #define DIGIT_BIT 28
90 #define MP_28BIT
91 #endif
92 #endif
93
94 /* otherwise the bits per digit is calculated automatically from the size of a mp_digit */
95 #ifndef DIGIT_BIT
96 #define DIGIT_BIT (((CHAR_BIT * MP_SIZEOF_MP_DIGIT) - 1)) /* bits per digit */
97 typedef uint_least32_t mp_min_u32;
98 #else
99 typedef mp_digit mp_min_u32;
100 #endif
101
102 /* use arc4random on platforms that support it */
103 #if defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) || defined(__DragonFly__)
104 #define MP_GEN_RANDOM() arc4random()
105 #define MP_GEN_RANDOM_MAX 0xffffffff
106 #endif
107
108 /* use rand() as fall-back if there's no better rand function */
109 #ifndef MP_GEN_RANDOM
110 #define MP_GEN_RANDOM() rand()
111 #define MP_GEN_RANDOM_MAX RAND_MAX
112 #endif
113
114 #define MP_DIGIT_BIT DIGIT_BIT
115 #define MP_MASK ((((mp_digit)1)<<((mp_digit)DIGIT_BIT))-((mp_digit)1))
116 #define MP_DIGIT_MAX MP_MASK
117
118 /* equalities */
119 #define MP_LT -1 /* less than */ 154 #define MP_LT -1 /* less than */
120 #define MP_EQ 0 /* equal to */ 155 #define MP_EQ 0 /* equal to */
121 #define MP_GT 1 /* greater than */ 156 #define MP_GT 1 /* greater than */
122 157 typedef int mp_bool;
123 #define MP_ZPOS 0 /* positive integer */ 158 #define MP_YES 1
124 #define MP_NEG 1 /* negative */ 159 #define MP_NO 0
125 160 typedef int mp_err;
126 #define MP_OKAY 0 /* ok result */ 161 #define MP_OKAY 0 /* no error */
162 #define MP_ERR -1 /* unknown error */
127 #define MP_MEM -2 /* out of mem */ 163 #define MP_MEM -2 /* out of mem */
128 #define MP_VAL -3 /* invalid input */ 164 #define MP_VAL -3 /* invalid input */
129 #define MP_RANGE MP_VAL 165 #define MP_RANGE (MP_DEPRECATED_PRAGMA("MP_RANGE has been deprecated in favor of MP_VAL") MP_VAL)
130 166 #define MP_ITER -4 /* maximum iterations reached */
131 #define MP_YES 1 /* yes response */ 167 #define MP_BUF -5 /* buffer overflow, supplied buffer too small */
132 #define MP_NO 0 /* no response */ 168 typedef int mp_order;
133 169 #define MP_LSB_FIRST -1
134 /* Primality generation flags */ 170 #define MP_MSB_FIRST 1
135 #define LTM_PRIME_BBS 0x0001 /* BBS style prime */ 171 typedef int mp_endian;
136 #define LTM_PRIME_SAFE 0x0002 /* Safe prime (p-1)/2 == prime */ 172 #define MP_LITTLE_ENDIAN -1
137 #define LTM_PRIME_2MSB_ON 0x0008 /* force 2nd MSB to 1 */ 173 #define MP_NATIVE_ENDIAN 0
138 174 #define MP_BIG_ENDIAN 1
139 typedef int mp_err; 175 #endif
140 176
141 /* you'll have to tune these... */ 177 /* tunable cutoffs */
142 extern int KARATSUBA_MUL_CUTOFF, 178
143 KARATSUBA_SQR_CUTOFF, 179 #ifndef MP_FIXED_CUTOFFS
144 TOOM_MUL_CUTOFF, 180 extern int
145 TOOM_SQR_CUTOFF; 181 KARATSUBA_MUL_CUTOFF,
182 KARATSUBA_SQR_CUTOFF,
183 TOOM_MUL_CUTOFF,
184 TOOM_SQR_CUTOFF;
185 #endif
146 186
147 /* define this to use lower memory usage routines (exptmods mostly) */ 187 /* define this to use lower memory usage routines (exptmods mostly) */
148 /* #define MP_LOW_MEM */ 188 /* #define MP_LOW_MEM */
149 189
150 /* default precision */ 190 /* default precision */
151 #ifndef MP_PREC 191 #ifndef MP_PREC
152 #ifndef MP_LOW_MEM 192 # ifndef MP_LOW_MEM
153 #define MP_PREC 32 /* default digits of precision */ 193 # define PRIVATE_MP_PREC 32 /* default digits of precision */
154 #else 194 # elif defined(MP_8BIT)
155 #define MP_PREC 8 /* default digits of precision */ 195 # define PRIVATE_MP_PREC 16 /* default digits of precision */
156 #endif 196 # else
197 # define PRIVATE_MP_PREC 8 /* default digits of precision */
198 # endif
199 # define MP_PREC (MP_DEPRECATED_PRAGMA("MP_PREC is an internal macro") PRIVATE_MP_PREC)
157 #endif 200 #endif
158 201
159 /* size of comba arrays, should be at least 2 * 2**(BITS_PER_WORD - BITS_PER_DIGIT*2) */ 202 /* size of comba arrays, should be at least 2 * 2**(BITS_PER_WORD - BITS_PER_DIGIT*2) */
160 #define MP_WARRAY (1 << (((sizeof(mp_word) * CHAR_BIT) - (2 * DIGIT_BIT)) + 1)) 203 #define PRIVATE_MP_WARRAY (int)(1uLL << (((CHAR_BIT * sizeof(private_mp_word)) - (2 * MP_DIGIT_BIT)) + 1))
204 #define MP_WARRAY (MP_DEPRECATED_PRAGMA("MP_WARRAY is an internal macro") PRIVATE_MP_WARRAY)
205
206 #if defined(__GNUC__) && __GNUC__ >= 4
207 # define MP_NULL_TERMINATED __attribute__((sentinel))
208 #else
209 # define MP_NULL_TERMINATED
210 #endif
211
212 /*
213 * MP_WUR - warn unused result
214 * ---------------------------
215 *
216 * The result of functions annotated with MP_WUR must be
217 * checked and cannot be ignored.
218 *
219 * Most functions in libtommath return an error code.
220 * This error code must be checked in order to prevent crashes or invalid
221 * results.
222 *
223 * If you still want to avoid the error checks for quick and dirty programs
224 * without robustness guarantees, you can `#define MP_WUR` before including
225 * tommath.h, disabling the warnings.
226 */
227 #ifndef MP_WUR
228 # if defined(__GNUC__) && __GNUC__ >= 4
229 # define MP_WUR __attribute__((warn_unused_result))
230 # else
231 # define MP_WUR
232 # endif
233 #endif
234
235 #if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 405)
236 # define MP_DEPRECATED(x) __attribute__((deprecated("replaced by " #x)))
237 # define PRIVATE_MP_DEPRECATED_PRAGMA(s) _Pragma(#s)
238 # define MP_DEPRECATED_PRAGMA(s) PRIVATE_MP_DEPRECATED_PRAGMA(GCC warning s)
239 #elif defined(_MSC_VER) && _MSC_VER >= 1500
240 # define MP_DEPRECATED(x) __declspec(deprecated("replaced by " #x))
241 # define MP_DEPRECATED_PRAGMA(s) __pragma(message(s))
242 #else
243 # define MP_DEPRECATED(s)
244 # define MP_DEPRECATED_PRAGMA(s)
245 #endif
246
247 #define DIGIT_BIT (MP_DEPRECATED_PRAGMA("DIGIT_BIT macro is deprecated, MP_DIGIT_BIT instead") MP_DIGIT_BIT)
248 #define USED(m) (MP_DEPRECATED_PRAGMA("USED macro is deprecated, use z->used instead") (m)->used)
249 #define DIGIT(m, k) (MP_DEPRECATED_PRAGMA("DIGIT macro is deprecated, use z->dp instead") (m)->dp[(k)])
250 #define SIGN(m) (MP_DEPRECATED_PRAGMA("SIGN macro is deprecated, use z->sign instead") (m)->sign)
161 251
162 /* the infamous mp_int structure */ 252 /* the infamous mp_int structure */
163 typedef struct { 253 typedef struct {
164 int used, alloc, sign; 254 int used, alloc;
165 mp_digit *dp; 255 mp_sign sign;
256 mp_digit *dp;
166 } mp_int; 257 } mp_int;
167 258
168 /* callback for mp_prime_random, should fill dst with random bytes and return how many read [upto len] */ 259 /* callback for mp_prime_random, should fill dst with random bytes and return how many read [upto len] */
169 typedef int ltm_prime_callback(unsigned char *dst, int len, void *dat); 260 typedef int private_mp_prime_callback(unsigned char *dst, int len, void *dat);
170 261 typedef private_mp_prime_callback MP_DEPRECATED(mp_rand_source) ltm_prime_callback;
171
172 #define USED(m) ((m)->used)
173 #define DIGIT(m,k) ((m)->dp[(k)])
174 #define SIGN(m) ((m)->sign)
175 262
176 /* error code to char* string */ 263 /* error code to char* string */
177 const char *mp_error_to_string(int code); 264 const char *mp_error_to_string(mp_err code) MP_WUR;
178 265
179 /* ---> init and deinit bignum functions <--- */ 266 /* ---> init and deinit bignum functions <--- */
180 /* init a bignum */ 267 /* init a bignum */
181 int mp_init(mp_int *a); 268 mp_err mp_init(mp_int *a) MP_WUR;
182 269
183 /* free a bignum */ 270 /* free a bignum */
184 void mp_clear(mp_int *a); 271 void mp_clear(mp_int *a);
185 272
186 /* init a null terminated series of arguments */ 273 /* init a null terminated series of arguments */
187 int mp_init_multi(mp_int *mp, ...); 274 mp_err mp_init_multi(mp_int *mp, ...) MP_NULL_TERMINATED MP_WUR;
188 275
189 /* clear a null terminated series of arguments */ 276 /* clear a null terminated series of arguments */
190 void mp_clear_multi(mp_int *mp, ...); 277 void mp_clear_multi(mp_int *mp, ...) MP_NULL_TERMINATED;
191 278
192 /* exchange two ints */ 279 /* exchange two ints */
193 void mp_exch(mp_int *a, mp_int *b); 280 void mp_exch(mp_int *a, mp_int *b);
194 281
195 /* shrink ram required for a bignum */ 282 /* shrink ram required for a bignum */
196 int mp_shrink(mp_int *a); 283 mp_err mp_shrink(mp_int *a) MP_WUR;
197 284
198 /* grow an int to a given size */ 285 /* grow an int to a given size */
199 int mp_grow(mp_int *a, int size); 286 mp_err mp_grow(mp_int *a, int size) MP_WUR;
200 287
201 /* init to a given number of digits */ 288 /* init to a given number of digits */
202 int mp_init_size(mp_int *a, int size); 289 mp_err mp_init_size(mp_int *a, int size) MP_WUR;
203 290
204 /* ---> Basic Manipulations <--- */ 291 /* ---> Basic Manipulations <--- */
205 #define mp_iszero(a) (((a)->used == 0) ? MP_YES : MP_NO) 292 #define mp_iszero(a) (((a)->used == 0) ? MP_YES : MP_NO)
206 #define mp_iseven(a) ((((a)->used > 0) && (((a)->dp[0] & 1u) == 0u)) ? MP_YES : MP_NO) 293 mp_bool mp_iseven(const mp_int *a) MP_WUR;
207 #define mp_isodd(a) ((((a)->used > 0) && (((a)->dp[0] & 1u) == 1u)) ? MP_YES : MP_NO) 294 mp_bool mp_isodd(const mp_int *a) MP_WUR;
208 #define mp_isneg(a) (((a)->sign != MP_ZPOS) ? MP_YES : MP_NO) 295 #define mp_isneg(a) (((a)->sign != MP_ZPOS) ? MP_YES : MP_NO)
209 296
210 /* set to zero */ 297 /* set to zero */
211 void mp_zero(mp_int *a); 298 void mp_zero(mp_int *a);
212 299
213 /* set to a digit */ 300 /* get and set doubles */
301 double mp_get_double(const mp_int *a) MP_WUR;
302 mp_err mp_set_double(mp_int *a, double b) MP_WUR;
303
304 /* get integer, set integer and init with integer (int32_t) */
305 int32_t mp_get_i32(const mp_int *a) MP_WUR;
306 void mp_set_i32(mp_int *a, int32_t b);
307 mp_err mp_init_i32(mp_int *a, int32_t b) MP_WUR;
308
309 /* get integer, set integer and init with integer, behaves like two complement for negative numbers (uint32_t) */
310 #define mp_get_u32(a) ((uint32_t)mp_get_i32(a))
311 void mp_set_u32(mp_int *a, uint32_t b);
312 mp_err mp_init_u32(mp_int *a, uint32_t b) MP_WUR;
313
314 /* get integer, set integer and init with integer (int64_t) */
315 int64_t mp_get_i64(const mp_int *a) MP_WUR;
316 void mp_set_i64(mp_int *a, int64_t b);
317 mp_err mp_init_i64(mp_int *a, int64_t b) MP_WUR;
318
319 /* get integer, set integer and init with integer, behaves like two complement for negative numbers (uint64_t) */
320 #define mp_get_u64(a) ((uint64_t)mp_get_i64(a))
321 void mp_set_u64(mp_int *a, uint64_t b);
322 mp_err mp_init_u64(mp_int *a, uint64_t b) MP_WUR;
323
324 /* get magnitude */
325 uint32_t mp_get_mag_u32(const mp_int *a) MP_WUR;
326 uint64_t mp_get_mag_u64(const mp_int *a) MP_WUR;
327 unsigned long mp_get_mag_ul(const mp_int *a) MP_WUR;
328 unsigned long long mp_get_mag_ull(const mp_int *a) MP_WUR;
329
330 /* get integer, set integer (long) */
331 long mp_get_l(const mp_int *a) MP_WUR;
332 void mp_set_l(mp_int *a, long b);
333 mp_err mp_init_l(mp_int *a, long b) MP_WUR;
334
335 /* get integer, set integer (unsigned long) */
336 #define mp_get_ul(a) ((unsigned long)mp_get_l(a))
337 void mp_set_ul(mp_int *a, unsigned long b);
338 mp_err mp_init_ul(mp_int *a, unsigned long b) MP_WUR;
339
340 /* get integer, set integer (long long) */
341 long long mp_get_ll(const mp_int *a) MP_WUR;
342 void mp_set_ll(mp_int *a, long long b);
343 mp_err mp_init_ll(mp_int *a, long long b) MP_WUR;
344
345 /* get integer, set integer (unsigned long long) */
346 #define mp_get_ull(a) ((unsigned long long)mp_get_ll(a))
347 void mp_set_ull(mp_int *a, unsigned long long b);
348 mp_err mp_init_ull(mp_int *a, unsigned long long b) MP_WUR;
349
350 /* set to single unsigned digit, up to MP_DIGIT_MAX */
214 void mp_set(mp_int *a, mp_digit b); 351 void mp_set(mp_int *a, mp_digit b);
215 352 mp_err mp_init_set(mp_int *a, mp_digit b) MP_WUR;
216 /* set a 32-bit const */ 353
217 int mp_set_int(mp_int *a, unsigned long b); 354 /* get integer, set integer and init with integer (deprecated) */
218 355 MP_DEPRECATED(mp_get_mag_u32/mp_get_u32) unsigned long mp_get_int(const mp_int *a) MP_WUR;
219 /* set a platform dependent unsigned long value */ 356 MP_DEPRECATED(mp_get_mag_ul/mp_get_ul) unsigned long mp_get_long(const mp_int *a) MP_WUR;
220 int mp_set_long(mp_int *a, unsigned long b); 357 MP_DEPRECATED(mp_get_mag_ull/mp_get_ull) unsigned long long mp_get_long_long(const mp_int *a) MP_WUR;
221 358 MP_DEPRECATED(mp_set_ul) mp_err mp_set_int(mp_int *a, unsigned long b);
222 /* set a platform dependent unsigned long long value */ 359 MP_DEPRECATED(mp_set_ul) mp_err mp_set_long(mp_int *a, unsigned long b);
223 int mp_set_long_long(mp_int *a, unsigned long long b); 360 MP_DEPRECATED(mp_set_ull) mp_err mp_set_long_long(mp_int *a, unsigned long long b);
224 361 MP_DEPRECATED(mp_init_ul) mp_err mp_init_set_int(mp_int *a, unsigned long b) MP_WUR;
225 /* get a 32-bit value */
226 unsigned long mp_get_int(mp_int * a);
227
228 /* get a platform dependent unsigned long value */
229 unsigned long mp_get_long(mp_int * a);
230
231 /* get a platform dependent unsigned long long value */
232 unsigned long long mp_get_long_long(mp_int * a);
233
234 /* initialize and set a digit */
235 int mp_init_set (mp_int * a, mp_digit b);
236
237 /* initialize and set 32-bit value */
238 int mp_init_set_int (mp_int * a, unsigned long b);
239 362
240 /* copy, b = a */ 363 /* copy, b = a */
241 int mp_copy(mp_int *a, mp_int *b); 364 mp_err mp_copy(const mp_int *a, mp_int *b) MP_WUR;
242 365
243 /* inits and copies, a = b */ 366 /* inits and copies, a = b */
244 int mp_init_copy(mp_int *a, mp_int *b); 367 mp_err mp_init_copy(mp_int *a, const mp_int *b) MP_WUR;
245 368
246 /* trim unused digits */ 369 /* trim unused digits */
247 void mp_clamp(mp_int *a); 370 void mp_clamp(mp_int *a);
248 371
372
373 /* export binary data */
374 MP_DEPRECATED(mp_pack) mp_err mp_export(void *rop, size_t *countp, int order, size_t size,
375 int endian, size_t nails, const mp_int *op) MP_WUR;
376
249 /* import binary data */ 377 /* import binary data */
250 int mp_import(mp_int* rop, size_t count, int order, size_t size, int endian, size_t nails, const void* op); 378 MP_DEPRECATED(mp_unpack) mp_err mp_import(mp_int *rop, size_t count, int order,
251 379 size_t size, int endian, size_t nails,
252 /* export binary data */ 380 const void *op) MP_WUR;
253 int mp_export(void* rop, size_t* countp, int order, size_t size, int endian, size_t nails, mp_int* op); 381
382 /* unpack binary data */
383 mp_err mp_unpack(mp_int *rop, size_t count, mp_order order, size_t size, mp_endian endian,
384 size_t nails, const void *op) MP_WUR;
385
386 /* pack binary data */
387 size_t mp_pack_count(const mp_int *a, size_t nails, size_t size) MP_WUR;
388 mp_err mp_pack(void *rop, size_t maxcount, size_t *written, mp_order order, size_t size,
389 mp_endian endian, size_t nails, const mp_int *op) MP_WUR;
254 390
255 /* ---> digit manipulation <--- */ 391 /* ---> digit manipulation <--- */
256 392
257 /* right shift by "b" digits */ 393 /* right shift by "b" digits */
258 void mp_rshd(mp_int *a, int b); 394 void mp_rshd(mp_int *a, int b);
259 395
260 /* left shift by "b" digits */ 396 /* left shift by "b" digits */
261 int mp_lshd(mp_int *a, int b); 397 mp_err mp_lshd(mp_int *a, int b) MP_WUR;
262 398
263 /* c = a / 2**b, implemented as c = a >> b */ 399 /* c = a / 2**b, implemented as c = a >> b */
264 int mp_div_2d(mp_int *a, int b, mp_int *c, mp_int *d); 400 mp_err mp_div_2d(const mp_int *a, int b, mp_int *c, mp_int *d) MP_WUR;
265 401
266 /* b = a/2 */ 402 /* b = a/2 */
267 int mp_div_2(mp_int *a, mp_int *b); 403 mp_err mp_div_2(const mp_int *a, mp_int *b) MP_WUR;
404
405 /* a/3 => 3c + d == a */
406 mp_err mp_div_3(const mp_int *a, mp_int *c, mp_digit *d) MP_WUR;
268 407
269 /* c = a * 2**b, implemented as c = a << b */ 408 /* c = a * 2**b, implemented as c = a << b */
270 int mp_mul_2d(mp_int *a, int b, mp_int *c); 409 mp_err mp_mul_2d(const mp_int *a, int b, mp_int *c) MP_WUR;
271 410
272 /* b = a*2 */ 411 /* b = a*2 */
273 int mp_mul_2(mp_int *a, mp_int *b); 412 mp_err mp_mul_2(const mp_int *a, mp_int *b) MP_WUR;
274 413
275 /* c = a mod 2**b */ 414 /* c = a mod 2**b */
276 int mp_mod_2d(mp_int *a, int b, mp_int *c); 415 mp_err mp_mod_2d(const mp_int *a, int b, mp_int *c) MP_WUR;
277 416
278 /* computes a = 2**b */ 417 /* computes a = 2**b */
279 int mp_2expt(mp_int *a, int b); 418 mp_err mp_2expt(mp_int *a, int b) MP_WUR;
280 419
281 /* Counts the number of lsbs which are zero before the first zero bit */ 420 /* Counts the number of lsbs which are zero before the first zero bit */
282 int mp_cnt_lsb(mp_int *a); 421 int mp_cnt_lsb(const mp_int *a) MP_WUR;
283 422
284 /* I Love Earth! */ 423 /* I Love Earth! */
285 424
286 /* makes a pseudo-random int of a given size */ 425 /* makes a pseudo-random mp_int of a given size */
287 int mp_rand(mp_int *a, int digits); 426 mp_err mp_rand(mp_int *a, int digits) MP_WUR;
427 /* makes a pseudo-random small int of a given size */
428 MP_DEPRECATED(mp_rand) mp_err mp_rand_digit(mp_digit *r) MP_WUR;
429 /* use custom random data source instead of source provided the platform */
430 void mp_rand_source(mp_err(*source)(void *out, size_t size));
431
432 #ifdef MP_PRNG_ENABLE_LTM_RNG
433 # warning MP_PRNG_ENABLE_LTM_RNG has been deprecated, use mp_rand_source instead.
434 /* A last resort to provide random data on systems without any of the other
435 * implemented ways to gather entropy.
436 * It is compatible with `rng_get_bytes()` from libtomcrypt so you could
437 * provide that one and then set `ltm_rng = rng_get_bytes;` */
438 extern unsigned long (*ltm_rng)(unsigned char *out, unsigned long outlen, void (*callback)(void));
439 extern void (*ltm_rng_callback)(void);
440 #endif
288 441
289 /* ---> binary operations <--- */ 442 /* ---> binary operations <--- */
290 /* c = a XOR b */ 443
291 int mp_xor(mp_int *a, mp_int *b, mp_int *c); 444 /* Checks the bit at position b and returns MP_YES
292 445 * if the bit is 1, MP_NO if it is 0 and MP_VAL
293 /* c = a OR b */ 446 * in case of error
294 int mp_or(mp_int *a, mp_int *b, mp_int *c); 447 */
295 448 MP_DEPRECATED(s_mp_get_bit) int mp_get_bit(const mp_int *a, int b) MP_WUR;
296 /* c = a AND b */ 449
297 int mp_and(mp_int *a, mp_int *b, mp_int *c); 450 /* c = a XOR b (two complement) */
451 MP_DEPRECATED(mp_xor) mp_err mp_tc_xor(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
452 mp_err mp_xor(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
453
454 /* c = a OR b (two complement) */
455 MP_DEPRECATED(mp_or) mp_err mp_tc_or(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
456 mp_err mp_or(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
457
458 /* c = a AND b (two complement) */
459 MP_DEPRECATED(mp_and) mp_err mp_tc_and(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
460 mp_err mp_and(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
461
462 /* b = ~a (bitwise not, two complement) */
463 mp_err mp_complement(const mp_int *a, mp_int *b) MP_WUR;
464
465 /* right shift with sign extension */
466 MP_DEPRECATED(mp_signed_rsh) mp_err mp_tc_div_2d(const mp_int *a, int b, mp_int *c) MP_WUR;
467 mp_err mp_signed_rsh(const mp_int *a, int b, mp_int *c) MP_WUR;
298 468
299 /* ---> Basic arithmetic <--- */ 469 /* ---> Basic arithmetic <--- */
300 470
301 /* b = -a */ 471 /* b = -a */
302 int mp_neg(mp_int *a, mp_int *b); 472 mp_err mp_neg(const mp_int *a, mp_int *b) MP_WUR;
303 473
304 /* b = |a| */ 474 /* b = |a| */
305 int mp_abs(mp_int *a, mp_int *b); 475 mp_err mp_abs(const mp_int *a, mp_int *b) MP_WUR;
306 476
307 /* compare a to b */ 477 /* compare a to b */
308 int mp_cmp(mp_int *a, mp_int *b); 478 mp_ord mp_cmp(const mp_int *a, const mp_int *b) MP_WUR;
309 479
310 /* compare |a| to |b| */ 480 /* compare |a| to |b| */
311 int mp_cmp_mag(mp_int *a, mp_int *b); 481 mp_ord mp_cmp_mag(const mp_int *a, const mp_int *b) MP_WUR;
312 482
313 /* c = a + b */ 483 /* c = a + b */
314 int mp_add(mp_int *a, mp_int *b, mp_int *c); 484 mp_err mp_add(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
315 485
316 /* c = a - b */ 486 /* c = a - b */
317 int mp_sub(mp_int *a, mp_int *b, mp_int *c); 487 mp_err mp_sub(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
318 488
319 /* c = a * b */ 489 /* c = a * b */
320 int mp_mul(mp_int *a, mp_int *b, mp_int *c); 490 mp_err mp_mul(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
321 491
322 /* b = a*a */ 492 /* b = a*a */
323 int mp_sqr(mp_int *a, mp_int *b); 493 mp_err mp_sqr(const mp_int *a, mp_int *b) MP_WUR;
324 494
325 /* a/b => cb + d == a */ 495 /* a/b => cb + d == a */
326 int mp_div(mp_int *a, mp_int *b, mp_int *c, mp_int *d); 496 mp_err mp_div(const mp_int *a, const mp_int *b, mp_int *c, mp_int *d) MP_WUR;
327 497
328 /* c = a mod b, 0 <= c < b */ 498 /* c = a mod b, 0 <= c < b */
329 int mp_mod(mp_int *a, mp_int *b, mp_int *c); 499 mp_err mp_mod(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
500
501 /* Increment "a" by one like "a++". Changes input! */
502 mp_err mp_incr(mp_int *a) MP_WUR;
503
504 /* Decrement "a" by one like "a--". Changes input! */
505 mp_err mp_decr(mp_int *a) MP_WUR;
330 506
331 /* ---> single digit functions <--- */ 507 /* ---> single digit functions <--- */
332 508
333 /* compare against a single digit */ 509 /* compare against a single digit */
334 int mp_cmp_d(mp_int *a, mp_digit b); 510 mp_ord mp_cmp_d(const mp_int *a, mp_digit b) MP_WUR;
335 511
336 /* c = a + b */ 512 /* c = a + b */
337 int mp_add_d(mp_int *a, mp_digit b, mp_int *c); 513 mp_err mp_add_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
338 514
339 /* c = a - b */ 515 /* c = a - b */
340 int mp_sub_d(mp_int *a, mp_digit b, mp_int *c); 516 mp_err mp_sub_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
341 517
342 /* c = a * b */ 518 /* c = a * b */
343 int mp_mul_d(mp_int *a, mp_digit b, mp_int *c); 519 mp_err mp_mul_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
344 520
345 /* a/b => cb + d == a */ 521 /* a/b => cb + d == a */
346 int mp_div_d(mp_int *a, mp_digit b, mp_int *c, mp_digit *d); 522 mp_err mp_div_d(const mp_int *a, mp_digit b, mp_int *c, mp_digit *d) MP_WUR;
347
348 /* a/3 => 3c + d == a */
349 int mp_div_3(mp_int *a, mp_int *c, mp_digit *d);
350
351 /* c = a**b */
352 int mp_expt_d(mp_int *a, mp_digit b, mp_int *c);
353 int mp_expt_d_ex (mp_int * a, mp_digit b, mp_int * c, int fast);
354 523
355 /* c = a mod b, 0 <= c < b */ 524 /* c = a mod b, 0 <= c < b */
356 int mp_mod_d(mp_int *a, mp_digit b, mp_digit *c); 525 mp_err mp_mod_d(const mp_int *a, mp_digit b, mp_digit *c) MP_WUR;
357 526
358 /* ---> number theory <--- */ 527 /* ---> number theory <--- */
359 528
360 /* d = a + b (mod c) */ 529 /* d = a + b (mod c) */
361 int mp_addmod(mp_int *a, mp_int *b, mp_int *c, mp_int *d); 530 mp_err mp_addmod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d) MP_WUR;
362 531
363 /* d = a - b (mod c) */ 532 /* d = a - b (mod c) */
364 int mp_submod(mp_int *a, mp_int *b, mp_int *c, mp_int *d); 533 mp_err mp_submod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d) MP_WUR;
365 534
366 /* d = a * b (mod c) */ 535 /* d = a * b (mod c) */
367 int mp_mulmod(mp_int *a, mp_int *b, mp_int *c, mp_int *d); 536 mp_err mp_mulmod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d) MP_WUR;
368 537
369 /* c = a * a (mod b) */ 538 /* c = a * a (mod b) */
370 int mp_sqrmod(mp_int *a, mp_int *b, mp_int *c); 539 mp_err mp_sqrmod(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
371 540
372 /* c = 1/a (mod b) */ 541 /* c = 1/a (mod b) */
373 int mp_invmod(mp_int *a, mp_int *b, mp_int *c); 542 mp_err mp_invmod(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
374 543
375 /* c = (a, b) */ 544 /* c = (a, b) */
376 int mp_gcd(mp_int *a, mp_int *b, mp_int *c); 545 mp_err mp_gcd(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
377 546
378 /* produces value such that U1*a + U2*b = U3 */ 547 /* produces value such that U1*a + U2*b = U3 */
379 int mp_exteuclid(mp_int *a, mp_int *b, mp_int *U1, mp_int *U2, mp_int *U3); 548 mp_err mp_exteuclid(const mp_int *a, const mp_int *b, mp_int *U1, mp_int *U2, mp_int *U3) MP_WUR;
380 549
381 /* c = [a, b] or (a*b)/(a, b) */ 550 /* c = [a, b] or (a*b)/(a, b) */
382 int mp_lcm(mp_int *a, mp_int *b, mp_int *c); 551 mp_err mp_lcm(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
383 552
384 /* finds one of the b'th root of a, such that |c|**b <= |a| 553 /* finds one of the b'th root of a, such that |c|**b <= |a|
385 * 554 *
386 * returns error if a < 0 and b is even 555 * returns error if a < 0 and b is even
387 */ 556 */
388 int mp_n_root(mp_int *a, mp_digit b, mp_int *c); 557 mp_err mp_root_u32(const mp_int *a, uint32_t b, mp_int *c) MP_WUR;
389 int mp_n_root_ex (mp_int * a, mp_digit b, mp_int * c, int fast); 558 MP_DEPRECATED(mp_root_u32) mp_err mp_n_root(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
559 MP_DEPRECATED(mp_root_u32) mp_err mp_n_root_ex(const mp_int *a, mp_digit b, mp_int *c, int fast) MP_WUR;
390 560
391 /* special sqrt algo */ 561 /* special sqrt algo */
392 int mp_sqrt(mp_int *arg, mp_int *ret); 562 mp_err mp_sqrt(const mp_int *arg, mp_int *ret) MP_WUR;
393 563
394 /* special sqrt (mod prime) */ 564 /* special sqrt (mod prime) */
395 int mp_sqrtmod_prime(mp_int *arg, mp_int *prime, mp_int *ret); 565 mp_err mp_sqrtmod_prime(const mp_int *n, const mp_int *prime, mp_int *ret) MP_WUR;
396 566
397 /* is number a square? */ 567 /* is number a square? */
398 int mp_is_square(mp_int *arg, int *ret); 568 mp_err mp_is_square(const mp_int *arg, mp_bool *ret) MP_WUR;
399 569
400 /* computes the jacobi c = (a | n) (or Legendre if b is prime) */ 570 /* computes the jacobi c = (a | n) (or Legendre if b is prime) */
401 int mp_jacobi(mp_int *a, mp_int *n, int *c); 571 MP_DEPRECATED(mp_kronecker) mp_err mp_jacobi(const mp_int *a, const mp_int *n, int *c) MP_WUR;
572
573 /* computes the Kronecker symbol c = (a | p) (like jacobi() but with {a,p} in Z */
574 mp_err mp_kronecker(const mp_int *a, const mp_int *p, int *c) MP_WUR;
402 575
403 /* used to setup the Barrett reduction for a given modulus b */ 576 /* used to setup the Barrett reduction for a given modulus b */
404 int mp_reduce_setup(mp_int *a, mp_int *b); 577 mp_err mp_reduce_setup(mp_int *a, const mp_int *b) MP_WUR;
405 578
406 /* Barrett Reduction, computes a (mod b) with a precomputed value c 579 /* Barrett Reduction, computes a (mod b) with a precomputed value c
407 * 580 *
408 * Assumes that 0 < a <= b*b, note if 0 > a > -(b*b) then you can merely 581 * Assumes that 0 < x <= m*m, note if 0 > x > -(m*m) then you can merely
409 * compute the reduction as -1 * mp_reduce(mp_abs(a)) [pseudo code]. 582 * compute the reduction as -1 * mp_reduce(mp_abs(x)) [pseudo code].
410 */ 583 */
411 int mp_reduce(mp_int *a, mp_int *b, mp_int *c); 584 mp_err mp_reduce(mp_int *x, const mp_int *m, const mp_int *mu) MP_WUR;
412 585
413 /* setups the montgomery reduction */ 586 /* setups the montgomery reduction */
414 int mp_montgomery_setup(mp_int *a, mp_digit *mp); 587 mp_err mp_montgomery_setup(const mp_int *n, mp_digit *rho) MP_WUR;
415 588
416 /* computes a = B**n mod b without division or multiplication useful for 589 /* computes a = B**n mod b without division or multiplication useful for
417 * normalizing numbers in a Montgomery system. 590 * normalizing numbers in a Montgomery system.
418 */ 591 */
419 int mp_montgomery_calc_normalization(mp_int *a, mp_int *b); 592 mp_err mp_montgomery_calc_normalization(mp_int *a, const mp_int *b) MP_WUR;
420 593
421 /* computes x/R == x (mod N) via Montgomery Reduction */ 594 /* computes x/R == x (mod N) via Montgomery Reduction */
422 int mp_montgomery_reduce(mp_int *a, mp_int *m, mp_digit mp); 595 mp_err mp_montgomery_reduce(mp_int *x, const mp_int *n, mp_digit rho) MP_WUR;
423 596
424 /* returns 1 if a is a valid DR modulus */ 597 /* returns 1 if a is a valid DR modulus */
425 int mp_dr_is_modulus(mp_int *a); 598 mp_bool mp_dr_is_modulus(const mp_int *a) MP_WUR;
426 599
427 /* sets the value of "d" required for mp_dr_reduce */ 600 /* sets the value of "d" required for mp_dr_reduce */
428 void mp_dr_setup(mp_int *a, mp_digit *d); 601 void mp_dr_setup(const mp_int *a, mp_digit *d);
429 602
430 /* reduces a modulo b using the Diminished Radix method */ 603 /* reduces a modulo n using the Diminished Radix method */
431 int mp_dr_reduce(mp_int *a, mp_int *b, mp_digit mp); 604 mp_err mp_dr_reduce(mp_int *x, const mp_int *n, mp_digit k) MP_WUR;
432 605
433 /* returns true if a can be reduced with mp_reduce_2k */ 606 /* returns true if a can be reduced with mp_reduce_2k */
434 int mp_reduce_is_2k(mp_int *a); 607 mp_bool mp_reduce_is_2k(const mp_int *a) MP_WUR;
435 608
436 /* determines k value for 2k reduction */ 609 /* determines k value for 2k reduction */
437 int mp_reduce_2k_setup(mp_int *a, mp_digit *d); 610 mp_err mp_reduce_2k_setup(const mp_int *a, mp_digit *d) MP_WUR;
438 611
439 /* reduces a modulo b where b is of the form 2**p - k [0 <= a] */ 612 /* reduces a modulo b where b is of the form 2**p - k [0 <= a] */
440 int mp_reduce_2k(mp_int *a, mp_int *n, mp_digit d); 613 mp_err mp_reduce_2k(mp_int *a, const mp_int *n, mp_digit d) MP_WUR;
441 614
442 /* returns true if a can be reduced with mp_reduce_2k_l */ 615 /* returns true if a can be reduced with mp_reduce_2k_l */
443 int mp_reduce_is_2k_l(mp_int *a); 616 mp_bool mp_reduce_is_2k_l(const mp_int *a) MP_WUR;
444 617
445 /* determines k value for 2k reduction */ 618 /* determines k value for 2k reduction */
446 int mp_reduce_2k_setup_l(mp_int *a, mp_int *d); 619 mp_err mp_reduce_2k_setup_l(const mp_int *a, mp_int *d) MP_WUR;
447 620
448 /* reduces a modulo b where b is of the form 2**p - k [0 <= a] */ 621 /* reduces a modulo b where b is of the form 2**p - k [0 <= a] */
449 int mp_reduce_2k_l(mp_int *a, mp_int *n, mp_int *d); 622 mp_err mp_reduce_2k_l(mp_int *a, const mp_int *n, const mp_int *d) MP_WUR;
450 623
451 /* d = a**b (mod c) */ 624 /* Y = G**X (mod P) */
452 int mp_exptmod(mp_int *a, mp_int *b, mp_int *c, mp_int *d); 625 mp_err mp_exptmod(const mp_int *G, const mp_int *X, const mp_int *P, mp_int *Y) MP_WUR;
453 626
454 /* ---> Primes <--- */ 627 /* ---> Primes <--- */
455 628
456 /* number of primes */ 629 /* number of primes */
457 #ifdef MP_8BIT 630 #ifdef MP_8BIT
458 #define PRIME_SIZE 31 631 # define PRIVATE_MP_PRIME_TAB_SIZE 31
459 #else 632 #else
460 #define PRIME_SIZE 256 633 # define PRIVATE_MP_PRIME_TAB_SIZE 256
461 #endif 634 #endif
635 #define PRIME_SIZE (MP_DEPRECATED_PRAGMA("PRIME_SIZE has been made internal") PRIVATE_MP_PRIME_TAB_SIZE)
462 636
463 /* table of first PRIME_SIZE primes */ 637 /* table of first PRIME_SIZE primes */
464 extern const mp_digit ltm_prime_tab[PRIME_SIZE]; 638 MP_DEPRECATED(internal) extern const mp_digit ltm_prime_tab[PRIVATE_MP_PRIME_TAB_SIZE];
465 639
466 /* result=1 if a is divisible by one of the first PRIME_SIZE primes */ 640 /* result=1 if a is divisible by one of the first PRIME_SIZE primes */
467 int mp_prime_is_divisible(mp_int *a, int *result); 641 MP_DEPRECATED(mp_prime_is_prime) mp_err mp_prime_is_divisible(const mp_int *a, mp_bool *result) MP_WUR;
468 642
469 /* performs one Fermat test of "a" using base "b". 643 /* performs one Fermat test of "a" using base "b".
470 * Sets result to 0 if composite or 1 if probable prime 644 * Sets result to 0 if composite or 1 if probable prime
471 */ 645 */
472 int mp_prime_fermat(mp_int *a, mp_int *b, int *result); 646 mp_err mp_prime_fermat(const mp_int *a, const mp_int *b, mp_bool *result) MP_WUR;
473 647
474 /* performs one Miller-Rabin test of "a" using base "b". 648 /* performs one Miller-Rabin test of "a" using base "b".
475 * Sets result to 0 if composite or 1 if probable prime 649 * Sets result to 0 if composite or 1 if probable prime
476 */ 650 */
477 int mp_prime_miller_rabin(mp_int *a, mp_int *b, int *result); 651 mp_err mp_prime_miller_rabin(const mp_int *a, const mp_int *b, mp_bool *result) MP_WUR;
478 652
479 /* This gives [for a given bit size] the number of trials required 653 /* This gives [for a given bit size] the number of trials required
480 * such that Miller-Rabin gives a prob of failure lower than 2^-96 654 * such that Miller-Rabin gives a prob of failure lower than 2^-96
481 */ 655 */
482 int mp_prime_rabin_miller_trials(int size); 656 int mp_prime_rabin_miller_trials(int size) MP_WUR;
483 657
484 /* performs t rounds of Miller-Rabin on "a" using the first 658 /* performs one strong Lucas-Selfridge test of "a".
485 * t prime bases. Also performs an initial sieve of trial 659 * Sets result to 0 if composite or 1 if probable prime
660 */
661 mp_err mp_prime_strong_lucas_selfridge(const mp_int *a, mp_bool *result) MP_WUR;
662
663 /* performs one Frobenius test of "a" as described by Paul Underwood.
664 * Sets result to 0 if composite or 1 if probable prime
665 */
666 mp_err mp_prime_frobenius_underwood(const mp_int *N, mp_bool *result) MP_WUR;
667
668 /* performs t random rounds of Miller-Rabin on "a" additional to
669 * bases 2 and 3. Also performs an initial sieve of trial
486 * division. Determines if "a" is prime with probability 670 * division. Determines if "a" is prime with probability
487 * of error no more than (1/4)**t. 671 * of error no more than (1/4)**t.
672 * Both a strong Lucas-Selfridge to complete the BPSW test
673 * and a separate Frobenius test are available at compile time.
674 * With t<0 a deterministic test is run for primes up to
675 * 318665857834031151167461. With t<13 (abs(t)-13) additional
676 * tests with sequential small primes are run starting at 43.
677 * Is Fips 186.4 compliant if called with t as computed by
678 * mp_prime_rabin_miller_trials();
488 * 679 *
489 * Sets result to 1 if probably prime, 0 otherwise 680 * Sets result to 1 if probably prime, 0 otherwise
490 */ 681 */
491 int mp_prime_is_prime(mp_int *a, int t, int *result); 682 mp_err mp_prime_is_prime(const mp_int *a, int t, mp_bool *result) MP_WUR;
492 683
493 /* finds the next prime after the number "a" using "t" trials 684 /* finds the next prime after the number "a" using "t" trials
494 * of Miller-Rabin. 685 * of Miller-Rabin.
495 * 686 *
496 * bbs_style = 1 means the prime must be congruent to 3 mod 4 687 * bbs_style = 1 means the prime must be congruent to 3 mod 4
497 */ 688 */
498 int mp_prime_next_prime(mp_int *a, int t, int bbs_style); 689 mp_err mp_prime_next_prime(mp_int *a, int t, int bbs_style) MP_WUR;
499 690
500 /* makes a truly random prime of a given size (bytes), 691 /* makes a truly random prime of a given size (bytes),
501 * call with bbs = 1 if you want it to be congruent to 3 mod 4 692 * call with bbs = 1 if you want it to be congruent to 3 mod 4
502 * 693 *
503 * You have to supply a callback which fills in a buffer with random bytes. "dat" is a parameter you can 694 * You have to supply a callback which fills in a buffer with random bytes. "dat" is a parameter you can
504 * have passed to the callback (e.g. a state or something). This function doesn't use "dat" itself 695 * have passed to the callback (e.g. a state or something). This function doesn't use "dat" itself
505 * so it can be NULL 696 * so it can be NULL
506 * 697 *
507 * The prime generated will be larger than 2^(8*size). 698 * The prime generated will be larger than 2^(8*size).
508 */ 699 */
509 #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) 700 #define mp_prime_random(a, t, size, bbs, cb, dat) (MP_DEPRECATED_PRAGMA("mp_prime_random has been deprecated, use mp_prime_rand instead") mp_prime_random_ex(a, t, ((size) * 8) + 1, (bbs==1)?MP_PRIME_BBS:0, cb, dat))
510 701
511 /* makes a truly random prime of a given size (bits), 702 /* makes a truly random prime of a given size (bits),
512 * 703 *
513 * Flags are as follows: 704 * Flags are as follows:
514 * 705 *
515 * LTM_PRIME_BBS - make prime congruent to 3 mod 4 706 * MP_PRIME_BBS - make prime congruent to 3 mod 4
516 * LTM_PRIME_SAFE - make sure (p-1)/2 is prime as well (implies LTM_PRIME_BBS) 707 * MP_PRIME_SAFE - make sure (p-1)/2 is prime as well (implies MP_PRIME_BBS)
517 * LTM_PRIME_2MSB_ON - make the 2nd highest bit one 708 * MP_PRIME_2MSB_ON - make the 2nd highest bit one
518 * 709 *
519 * You have to supply a callback which fills in a buffer with random bytes. "dat" is a parameter you can 710 * You have to supply a callback which fills in a buffer with random bytes. "dat" is a parameter you can
520 * have passed to the callback (e.g. a state or something). This function doesn't use "dat" itself 711 * have passed to the callback (e.g. a state or something). This function doesn't use "dat" itself
521 * so it can be NULL 712 * so it can be NULL
522 * 713 *
523 */ 714 */
524 int mp_prime_random_ex(mp_int *a, int t, int size, int flags, ltm_prime_callback cb, void *dat); 715 MP_DEPRECATED(mp_prime_rand) mp_err mp_prime_random_ex(mp_int *a, int t, int size, int flags,
716 private_mp_prime_callback cb, void *dat) MP_WUR;
717 mp_err mp_prime_rand(mp_int *a, int t, int size, int flags) MP_WUR;
718
719 /* Integer logarithm to integer base */
720 mp_err mp_log_u32(const mp_int *a, uint32_t base, uint32_t *c) MP_WUR;
721
722 /* c = a**b */
723 mp_err mp_expt_u32(const mp_int *a, uint32_t b, mp_int *c) MP_WUR;
724 MP_DEPRECATED(mp_expt_u32) mp_err mp_expt_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
725 MP_DEPRECATED(mp_expt_u32) mp_err mp_expt_d_ex(const mp_int *a, mp_digit b, mp_int *c, int fast) MP_WUR;
525 726
526 /* ---> radix conversion <--- */ 727 /* ---> radix conversion <--- */
527 int mp_count_bits(mp_int *a); 728 int mp_count_bits(const mp_int *a) MP_WUR;
528 729
529 int mp_unsigned_bin_size(mp_int *a); 730
530 int mp_read_unsigned_bin(mp_int *a, const unsigned char *b, int c); 731 MP_DEPRECATED(mp_ubin_size) int mp_unsigned_bin_size(const mp_int *a) MP_WUR;
531 int mp_to_unsigned_bin(mp_int *a, unsigned char *b); 732 MP_DEPRECATED(mp_from_ubin) mp_err mp_read_unsigned_bin(mp_int *a, const unsigned char *b, int c) MP_WUR;
532 int mp_to_unsigned_bin_n (mp_int * a, unsigned char *b, unsigned long *outlen); 733 MP_DEPRECATED(mp_to_ubin) mp_err mp_to_unsigned_bin(const mp_int *a, unsigned char *b) MP_WUR;
533 734 MP_DEPRECATED(mp_to_ubin) mp_err mp_to_unsigned_bin_n(const mp_int *a, unsigned char *b, unsigned long *outlen) MP_WUR;
534 int mp_signed_bin_size(mp_int *a); 735
535 int mp_read_signed_bin(mp_int *a, const unsigned char *b, int c); 736 MP_DEPRECATED(mp_sbin_size) int mp_signed_bin_size(const mp_int *a) MP_WUR;
536 int mp_to_signed_bin(mp_int *a, unsigned char *b); 737 MP_DEPRECATED(mp_from_sbin) mp_err mp_read_signed_bin(mp_int *a, const unsigned char *b, int c) MP_WUR;
537 int mp_to_signed_bin_n (mp_int * a, unsigned char *b, unsigned long *outlen); 738 MP_DEPRECATED(mp_to_sbin) mp_err mp_to_signed_bin(const mp_int *a, unsigned char *b) MP_WUR;
538 739 MP_DEPRECATED(mp_to_sbin) mp_err mp_to_signed_bin_n(const mp_int *a, unsigned char *b, unsigned long *outlen) MP_WUR;
539 int mp_read_radix(mp_int *a, const char *str, int radix); 740
540 int mp_toradix(mp_int *a, char *str, int radix); 741 size_t mp_ubin_size(const mp_int *a) MP_WUR;
541 int mp_toradix_n(mp_int * a, char *str, int radix, int maxlen); 742 mp_err mp_from_ubin(mp_int *a, const unsigned char *buf, size_t size) MP_WUR;
542 int mp_radix_size(mp_int *a, int radix, int *size); 743 mp_err mp_to_ubin(const mp_int *a, unsigned char *buf, size_t maxlen, size_t *written) MP_WUR;
543 744
544 #ifndef LTM_NO_FILE 745 size_t mp_sbin_size(const mp_int *a) MP_WUR;
545 int mp_fread(mp_int *a, int radix, FILE *stream); 746 mp_err mp_from_sbin(mp_int *a, const unsigned char *buf, size_t size) MP_WUR;
546 int mp_fwrite(mp_int *a, int radix, FILE *stream); 747 mp_err mp_to_sbin(const mp_int *a, unsigned char *buf, size_t maxlen, size_t *written) MP_WUR;
547 #endif 748
548 749 mp_err mp_read_radix(mp_int *a, const char *str, int radix) MP_WUR;
549 #define mp_read_raw(mp, str, len) mp_read_signed_bin((mp), (str), (len)) 750 MP_DEPRECATED(mp_to_radix) mp_err mp_toradix(const mp_int *a, char *str, int radix) MP_WUR;
550 #define mp_raw_size(mp) mp_signed_bin_size(mp) 751 MP_DEPRECATED(mp_to_radix) mp_err mp_toradix_n(const mp_int *a, char *str, int radix, int maxlen) MP_WUR;
551 #define mp_toraw(mp, str) mp_to_signed_bin((mp), (str)) 752 mp_err mp_to_radix(const mp_int *a, char *str, size_t maxlen, size_t *written, int radix) MP_WUR;
552 #define mp_read_mag(mp, str, len) mp_read_unsigned_bin((mp), (str), (len)) 753 mp_err mp_radix_size(const mp_int *a, int radix, int *size) MP_WUR;
553 #define mp_mag_size(mp) mp_unsigned_bin_size(mp) 754
554 #define mp_tomag(mp, str) mp_to_unsigned_bin((mp), (str)) 755 #ifndef MP_NO_FILE
555 756 mp_err mp_fread(mp_int *a, int radix, FILE *stream) MP_WUR;
556 #define mp_tobinary(M, S) mp_toradix((M), (S), 2) 757 mp_err mp_fwrite(const mp_int *a, int radix, FILE *stream) MP_WUR;
557 #define mp_tooctal(M, S) mp_toradix((M), (S), 8) 758 #endif
558 #define mp_todecimal(M, S) mp_toradix((M), (S), 10) 759
559 #define mp_tohex(M, S) mp_toradix((M), (S), 16) 760 #define mp_read_raw(mp, str, len) (MP_DEPRECATED_PRAGMA("replaced by mp_read_signed_bin") mp_read_signed_bin((mp), (str), (len)))
761 #define mp_raw_size(mp) (MP_DEPRECATED_PRAGMA("replaced by mp_signed_bin_size") mp_signed_bin_size(mp))
762 #define mp_toraw(mp, str) (MP_DEPRECATED_PRAGMA("replaced by mp_to_signed_bin") mp_to_signed_bin((mp), (str)))
763 #define mp_read_mag(mp, str, len) (MP_DEPRECATED_PRAGMA("replaced by mp_read_unsigned_bin") mp_read_unsigned_bin((mp), (str), (len))
764 #define mp_mag_size(mp) (MP_DEPRECATED_PRAGMA("replaced by mp_unsigned_bin_size") mp_unsigned_bin_size(mp))
765 #define mp_tomag(mp, str) (MP_DEPRECATED_PRAGMA("replaced by mp_to_unsigned_bin") mp_to_unsigned_bin((mp), (str)))
766
767 #define mp_tobinary(M, S) (MP_DEPRECATED_PRAGMA("replaced by mp_to_binary") mp_toradix((M), (S), 2))
768 #define mp_tooctal(M, S) (MP_DEPRECATED_PRAGMA("replaced by mp_to_octal") mp_toradix((M), (S), 8))
769 #define mp_todecimal(M, S) (MP_DEPRECATED_PRAGMA("replaced by mp_to_decimal") mp_toradix((M), (S), 10))
770 #define mp_tohex(M, S) (MP_DEPRECATED_PRAGMA("replaced by mp_to_hex") mp_toradix((M), (S), 16))
771
772 #define mp_to_binary(M, S, N) mp_to_radix((M), (S), (N), NULL, 2)
773 #define mp_to_octal(M, S, N) mp_to_radix((M), (S), (N), NULL, 8)
774 #define mp_to_decimal(M, S, N) mp_to_radix((M), (S), (N), NULL, 10)
775 #define mp_to_hex(M, S, N) mp_to_radix((M), (S), (N), NULL, 16)
560 776
561 #ifdef __cplusplus 777 #ifdef __cplusplus
562 } 778 }
563 #endif 779 #endif
564 780
565 #endif 781 #endif
566
567
568 /* ref: $Format:%D$ */
569 /* git commit: $Format:%H$ */
570 /* commit time: $Format:%ai$ */