util/src/TclTk/tcl8.6.12/generic/tclTomMath.h

   1 /* LibTomMath, multiple-precision integer library -- Tom St Denis */
   2 /* SPDX-License-Identifier: Unlicense */
   3
   4 #ifndef BN_H_
   5 #define BN_H_
   6
   7 #ifndef MODULE_SCOPE
   8 #define MODULE_SCOPE extern
   9 #endif
  10
  11
  12
  13 #ifdef __cplusplus
  14 extern "C" {
  15 #endif
  16
  17 /* MS Visual C++ doesn't have a 128bit type for words, so fall back to 32bit MPI's (where words are 64bit) */
  18 #if (defined(_WIN32) || defined(__LLP64__) || defined(__e2k__) || defined(__LCC__)) && !defined(MP_64BIT)
  19 #   define MP_32BIT
  20 #endif
  21
  22 /* detect 64-bit mode if possible */
  23 #if defined(NEVER)
  24 #   if !(defined(MP_32BIT) || defined(MP_16BIT) || defined(MP_8BIT))
  25 #      if defined(__GNUC__)
  26 /* we support 128bit integers only via: __attribute__((mode(TI))) */
  27 #         define MP_64BIT
  28 #      else
  29 /* otherwise we fall back to MP_32BIT even on 64bit platforms */
  30 #         define MP_32BIT
  31 #      endif
  32 #   endif
  33 #endif
  34
  35 #ifdef MP_DIGIT_BIT
  36 #   error Defining MP_DIGIT_BIT is disallowed, use MP_8/16/31/32/64BIT
  37 #endif
  38
  39 /* some default configurations.
  40  *
  41  * A "mp_digit" must be able to hold MP_DIGIT_BIT + 1 bits
  42  * A "mp_word" must be able to hold 2*MP_DIGIT_BIT + 1 bits
  43  *
  44  * At the very least a mp_digit must be able to hold 7 bits
  45  * [any size beyond that is ok provided it doesn't overflow the data type]
  46  */
  47
  48 #ifdef MP_8BIT
  49 #ifndef MP_DIGIT_DECLARED
  50 typedef unsigned char        mp_digit;
  51 #define MP_DIGIT_DECLARED
  52 #endif
  53 #ifndef MP_WORD_DECLARED
  54 typedef unsigned short       private_mp_word;
  55 #define MP_WORD_DECLARED
  56 #endif
  57 #   define MP_SIZEOF_MP_DIGIT 1
  58 #   ifdef MP_DIGIT_BIT
  59 #      error You must not define MP_DIGIT_BIT when using MP_8BIT
  60 #   endif
  61 #elif defined(MP_16BIT)
  62 #ifndef MP_DIGIT_DECLARED
  63 typedef unsigned short       mp_digit;
  64 #define MP_DIGIT_DECLARED
  65 #endif
  66 #ifndef MP_WORD_DECLARED
  67 typedef unsigned int         private_mp_word;
  68 #define MP_WORD_DECLARED
  69 #endif
  70 #   define MP_SIZEOF_MP_DIGIT 2
  71 #   ifdef MP_DIGIT_BIT
  72 #      error You must not define MP_DIGIT_BIT when using MP_16BIT
  73 #   endif
  74 #elif defined(MP_64BIT)
  75 /* for GCC only on supported platforms */
  76 #ifndef MP_DIGIT_DECLARED
  77 typedef unsigned long long   mp_digit;
  78 #define MP_DIGIT_DECLARED
  79 #endif
  80 typedef unsigned long        private_mp_word __attribute__((mode(TI)));
  81 #   define MP_DIGIT_BIT 60
  82 #else
  83 /* this is the default case, 28-bit digits */
  84
  85 /* this is to make porting into LibTomCrypt easier :-) */
  86 #ifndef MP_DIGIT_DECLARED
  87 typedef unsigned int         mp_digit;
  88 #define MP_DIGIT_DECLARED
  89 #endif
  90 #ifndef MP_WORD_DECLARED
  91 #ifdef _WIN32
  92 typedef unsigned __int64   private_mp_word;
  93 #else
  94 typedef unsigned long long   private_mp_word;
  95 #endif
  96 #define MP_WORD_DECLARED
  97 #endif
  98
  99 #   ifdef MP_31BIT
 100 /*
 101  * This is an extension that uses 31-bit digits.
 102  * Please be aware that not all functions support this size, especially s_mp_mul_digs_fast
 103  * will be reduced to work on small numbers only:
 104  * Up to 8 limbs, 248 bits instead of up to 512 limbs, 15872 bits with MP_28BIT.
 105  */
 106 #      define MP_DIGIT_BIT 31
 107 #   else
 108 /* default case is 28-bit digits, defines MP_28BIT as a handy macro to test */
 109 #      define MP_DIGIT_BIT 28
 110 #      define MP_28BIT
 111 #   endif
 112 #endif
 113
 114 /* otherwise the bits per digit is calculated automatically from the size of a mp_digit */
 115 #ifndef MP_DIGIT_BIT
 116 #   define MP_DIGIT_BIT (((CHAR_BIT * MP_SIZEOF_MP_DIGIT) - 1))  /* bits per digit */
 117 #endif
 118
 119 #define MP_MASK          ((((mp_digit)1)<<((mp_digit)MP_DIGIT_BIT))-((mp_digit)1))
 120 #define MP_DIGIT_MAX     MP_MASK
 121
 122 /* Primality generation flags */
 123 #define MP_PRIME_BBS      0x0001 /* BBS style prime */
 124 #define MP_PRIME_SAFE     0x0002 /* Safe prime (p-1)/2 == prime */
 125 #define MP_PRIME_2MSB_ON  0x0008 /* force 2nd MSB to 1 */
 126
 127 #define LTM_PRIME_BBS      (MP_DEPRECATED_PRAGMA("LTM_PRIME_BBS has been deprecated, use MP_PRIME_BBS") MP_PRIME_BBS)
 128 #define LTM_PRIME_SAFE     (MP_DEPRECATED_PRAGMA("LTM_PRIME_SAFE has been deprecated, use MP_PRIME_SAFE") MP_PRIME_SAFE)
 129 #define LTM_PRIME_2MSB_ON  (MP_DEPRECATED_PRAGMA("LTM_PRIME_2MSB_ON has been deprecated, use MP_PRIME_2MSB_ON") MP_PRIME_2MSB_ON)
 130
 131 #ifdef MP_USE_ENUMS
 132 typedef enum {
 133    MP_ZPOS = 0,   /* positive */
 134    MP_NEG = 1     /* negative */
 135 } mp_sign;
 136 typedef enum {
 137    MP_LT = -1,    /* less than */
 138    MP_EQ = 0,     /* equal */
 139    MP_GT = 1      /* greater than */
 140 } mp_ord;
 141 typedef enum {
 142    MP_NO = 0,
 143    MP_YES = 1
 144 } mp_bool;
 145 typedef enum {
 146    MP_OKAY  = 0,   /* no error */
 147    MP_ERR   = -1,  /* unknown error */
 148    MP_MEM   = -2,  /* out of mem */
 149    MP_VAL   = -3,  /* invalid input */
 150    MP_ITER  = -4,  /* maximum iterations reached */
 151    MP_BUF   = -5   /* buffer overflow, supplied buffer too small */
 152 } mp_err;
 153 typedef enum {
 154    MP_LSB_FIRST = -1,
 155    MP_MSB_FIRST =  1
 156 } mp_order;
 157 typedef enum {
 158    MP_LITTLE_ENDIAN  = -1,
 159    MP_NATIVE_ENDIAN  =  0,
 160    MP_BIG_ENDIAN     =  1
 161 } mp_endian;
 162 #else
 163 typedef int mp_sign;
 164 #define MP_ZPOS       0   /* positive integer */
 165 #define MP_NEG        1   /* negative */
 166 typedef int mp_ord;
 167 #define MP_LT        -1   /* less than */
 168 #define MP_EQ         0   /* equal to */
 169 #define MP_GT         1   /* greater than */
 170 typedef int mp_bool;
 171 #define MP_YES        1
 172 #define MP_NO         0
 173 typedef int mp_err;
 174 #define MP_OKAY       0   /* no error */
 175 #define MP_ERR        -1  /* unknown error */
 176 #define MP_MEM        -2  /* out of mem */
 177 #define MP_VAL        -3  /* invalid input */
 178 #define MP_RANGE      (MP_DEPRECATED_PRAGMA("MP_RANGE has been deprecated in favor of MP_VAL") MP_VAL)
 179 #define MP_ITER       -4  /* maximum iterations reached */
 180 #define MP_BUF        -5  /* buffer overflow, supplied buffer too small */
 181 typedef int mp_order;
 182 #define MP_LSB_FIRST -1
 183 #define MP_MSB_FIRST  1
 184 typedef int mp_endian;
 185 #define MP_LITTLE_ENDIAN  -1
 186 #define MP_NATIVE_ENDIAN  0
 187 #define MP_BIG_ENDIAN     1
 188 #endif
 189
 190 /* tunable cutoffs */
 191
 192 #ifndef MP_FIXED_CUTOFFS
 193 extern int
 194 KARATSUBA_MUL_CUTOFF,
 195 KARATSUBA_SQR_CUTOFF,
 196 TOOM_MUL_CUTOFF,
 197 TOOM_SQR_CUTOFF;
 198 #endif
 199
 200 /* define this to use lower memory usage routines (exptmods mostly) */
 201 /* #define MP_LOW_MEM */
 202
 203 /* default precision */
 204 #ifndef MP_PREC
 205 #   ifndef MP_LOW_MEM
 206 #      define MP_PREC 32        /* default digits of precision */
 207 #   elif defined(MP_8BIT)
 208 #      define MP_PREC 16        /* default digits of precision */
 209 #   else
 210 #      define MP_PREC 8         /* default digits of precision */
 211 #   endif
 212 #endif
 213
 214 /* size of comba arrays, should be at least 2 * 2**(BITS_PER_WORD - BITS_PER_DIGIT*2) */
 215 #define PRIVATE_MP_WARRAY (int)(1 << (((CHAR_BIT * sizeof(private_mp_word)) - (2 * MP_DIGIT_BIT)) + 1))
 216
 217 #if defined(__GNUC__) && __GNUC__ >= 4
 218 #   define MP_NULL_TERMINATED __attribute__((sentinel))
 219 #else
 220 #   define MP_NULL_TERMINATED
 221 #endif
 222
 223 /*
 224  * MP_WUR - warn unused result
 225  * ---------------------------
 226  *
 227  * The result of functions annotated with MP_WUR must be
 228  * checked and cannot be ignored.
 229  *
 230  * Most functions in libtommath return an error code.
 231  * This error code must be checked in order to prevent crashes or invalid
 232  * results.
 233  *
 234  * If you still want to avoid the error checks for quick and dirty programs
 235  * without robustness guarantees, you can `#define MP_WUR` before including
 236  * tommath.h, disabling the warnings.
 237  */
 238 #ifndef MP_WUR
 239 #  if defined(__GNUC__) && __GNUC__ >= 4
 240 #     define MP_WUR __attribute__((warn_unused_result))
 241 #  else
 242 #     define MP_WUR
 243 #  endif
 244 #endif
 245
 246 #if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 405)
 247 #  define MP_DEPRECATED(x) __attribute__((deprecated("replaced by " #x)))
 248 #  define PRIVATE_MP_DEPRECATED_PRAGMA(s) _Pragma(#s)
 249 #  define MP_DEPRECATED_PRAGMA(s) PRIVATE_MP_DEPRECATED_PRAGMA(GCC warning s)
 250 #elif defined(_MSC_VER) && _MSC_VER >= 1500
 251 #  define MP_DEPRECATED(x) __declspec(deprecated("replaced by " #x))
 252 #  define MP_DEPRECATED_PRAGMA(s) __pragma(message(s))
 253 #else
 254 #  define MP_DEPRECATED(s)
 255 #  define MP_DEPRECATED_PRAGMA(s)
 256 #endif
 257
 258 #define DIGIT_BIT   MP_DIGIT_BIT
 259 #define USED(m)    ((m)->used)
 260 #define DIGIT(m,k) ((m)->dp[(k)])
 261 #define SIGN(m)    ((m)->sign)
 262
 263 /* the infamous mp_int structure */
 264 #ifndef MP_INT_DECLARED
 265 #define MP_INT_DECLARED
 266 typedef struct mp_int mp_int;
 267 #endif
 268 struct mp_int {
 269    int used, alloc;
 270    mp_sign sign;
 271    mp_digit *dp;
 272 };
 273
 274 /* callback for mp_prime_random, should fill dst with random bytes and return how many read [upto len] */
 275 typedef int private_mp_prime_callback(unsigned char *dst, int len, void *dat);
 276 typedef private_mp_prime_callback MP_DEPRECATED(mp_rand_source) ltm_prime_callback;
 277
 278 /* error code to char* string */
 279 /*
 280 const char *mp_error_to_string(mp_err code) MP_WUR;
 281 */
 282
 283 /* ---> init and deinit bignum functions <--- */
 284 /* init a bignum */
 285 /*
 286 mp_err mp_init(mp_int *a) MP_WUR;
 287 */
 288
 289 /* free a bignum */
 290 /*
 291 void mp_clear(mp_int *a);
 292 */
 293
 294 /* init a null terminated series of arguments */
 295 /*
 296 mp_err mp_init_multi(mp_int *mp, ...) MP_NULL_TERMINATED MP_WUR;
 297 */
 298
 299 /* clear a null terminated series of arguments */
 300 /*
 301 void mp_clear_multi(mp_int *mp, ...) MP_NULL_TERMINATED;
 302 */
 303
 304 /* exchange two ints */
 305 /*
 306 void mp_exch(mp_int *a, mp_int *b);
 307 */
 308
 309 /* shrink ram required for a bignum */
 310 /*
 311 mp_err mp_shrink(mp_int *a) MP_WUR;
 312 */
 313
 314 /* grow an int to a given size */
 315 /*
 316 mp_err mp_grow(mp_int *a, int size) MP_WUR;
 317 */
 318
 319 /* init to a given number of digits */
 320 /*
 321 mp_err mp_init_size(mp_int *a, int size) MP_WUR;
 322 */
 323
 324 /* ---> Basic Manipulations <--- */
 325 #define mp_iszero(a) (((a)->used == 0) ? MP_YES : MP_NO)
 326 #define mp_isodd(a)  (((a)->used != 0 && (((a)->dp[0] & 1) == 1)) ? MP_YES : MP_NO)
 327 #define mp_iseven(a) (((a)->used == 0 || (((a)->dp[0] & 1) == 0)) ? MP_YES : MP_NO)
 328 #define mp_isneg(a)  (((a)->sign != MP_ZPOS) ? MP_YES : MP_NO)
 329
 330 /* set to zero */
 331 /*
 332 void mp_zero(mp_int *a);
 333 */
 334
 335 /* get and set doubles */
 336 /*
 337 double mp_get_double(const mp_int *a) MP_WUR;
 338 */
 339 /*
 340 mp_err mp_set_double(mp_int *a, double b) MP_WUR;
 341 */
 342
 343 /* get integer, set integer and init with integer (int32_t) */
 344 #ifndef MP_NO_STDINT
 345 /*
 346 int32_t mp_get_i32(const mp_int *a) MP_WUR;
 347 */
 348 /*
 349 void mp_set_i32(mp_int *a, int32_t b);
 350 */
 351 /*
 352 mp_err mp_init_i32(mp_int *a, int32_t b) MP_WUR;
 353 */
 354
 355 /* get integer, set integer and init with integer, behaves like two complement for negative numbers (uint32_t) */
 356 #define mp_get_u32(a) ((uint32_t)mp_get_i32(a))
 357 /*
 358 void mp_set_u32(mp_int *a, uint32_t b);
 359 */
 360 /*
 361 mp_err mp_init_u32(mp_int *a, uint32_t b) MP_WUR;
 362 */
 363
 364 /* get integer, set integer and init with integer (int64_t) */
 365 /*
 366 int64_t mp_get_i64(const mp_int *a) MP_WUR;
 367 */
 368 /*
 369 void mp_set_i64(mp_int *a, int64_t b);
 370 */
 371 /*
 372 mp_err mp_init_i64(mp_int *a, int64_t b) MP_WUR;
 373 */
 374
 375 /* get integer, set integer and init with integer, behaves like two complement for negative numbers (uint64_t) */
 376 #define mp_get_u64(a) ((uint64_t)mp_get_i64(a))
 377 /*
 378 void mp_set_u64(mp_int *a, uint64_t b);
 379 */
 380 /*
 381 mp_err mp_init_u64(mp_int *a, uint64_t b) MP_WUR;
 382 */
 383
 384 /* get magnitude */
 385 /*
 386 uint32_t mp_get_mag_u32(const mp_int *a) MP_WUR;
 387 */
 388 /*
 389 uint64_t mp_get_mag_u64(const mp_int *a) MP_WUR;
 390 */
 391 #endif
 392 /*
 393 unsigned long mp_get_mag_ul(const mp_int *a) MP_WUR;
 394 */
 395 /*
 396 Tcl_WideUInt mp_get_mag_ull(const mp_int *a) MP_WUR;
 397 */
 398
 399 /* get integer, set integer (long) */
 400 /*
 401 long mp_get_l(const mp_int *a) MP_WUR;
 402 */
 403 /*
 404 void mp_set_l(mp_int *a, long b);
 405 */
 406 /*
 407 mp_err mp_init_l(mp_int *a, long b) MP_WUR;
 408 */
 409
 410 /* get integer, set integer (unsigned long) */
 411 #define mp_get_ul(a) ((unsigned long)mp_get_l(a))
 412 /*
 413 void mp_set_ul(mp_int *a, unsigned long b);
 414 */
 415 /*
 416 mp_err mp_init_ul(mp_int *a, unsigned long b) MP_WUR;
 417 */
 418
 419 /* get integer, set integer (Tcl_WideInt) */
 420 /*
 421 Tcl_WideInt mp_get_ll(const mp_int *a) MP_WUR;
 422 */
 423 /*
 424 void mp_set_ll(mp_int *a, Tcl_WideInt b);
 425 */
 426 /*
 427 mp_err mp_init_ll(mp_int *a, Tcl_WideInt b) MP_WUR;
 428 */
 429
 430 /* get integer, set integer (Tcl_WideUInt) */
 431 #define mp_get_ull(a) ((Tcl_WideUInt)mp_get_ll(a))
 432 /*
 433 void mp_set_ull(mp_int *a, Tcl_WideUInt b);
 434 */
 435 /*
 436 mp_err mp_init_ull(mp_int *a, Tcl_WideUInt b) MP_WUR;
 437 */
 438
 439 /* set to single unsigned digit, up to MP_DIGIT_MAX */
 440 /*
 441 void mp_set(mp_int *a, mp_digit b);
 442 */
 443 /*
 444 mp_err mp_init_set(mp_int *a, mp_digit b) MP_WUR;
 445 */
 446
 447 /* get integer, set integer and init with integer (deprecated) */
 448 /*
 449 MP_DEPRECATED(mp_get_mag_u32/mp_get_u32) unsigned long mp_get_int(const mp_int *a) MP_WUR;
 450 */
 451 /*
 452 MP_DEPRECATED(mp_get_mag_ul/mp_get_ul) unsigned long mp_get_long(const mp_int *a) MP_WUR;
 453 */
 454 /*
 455 MP_DEPRECATED(mp_get_mag_ull/mp_get_ull) Tcl_WideUInt mp_get_long_long(const mp_int *a) MP_WUR;
 456 */
 457 /*
 458 MP_DEPRECATED(mp_set_ul) mp_err mp_set_int(mp_int *a, unsigned long b);
 459 */
 460 /*
 461 MP_DEPRECATED(mp_set_ul) mp_err mp_set_long(mp_int *a, unsigned long b);
 462 */
 463 /*
 464 MP_DEPRECATED(mp_set_ull) mp_err mp_set_long_long(mp_int *a, Tcl_WideUInt b);
 465 */
 466 /*
 467 MP_DEPRECATED(mp_init_ul) mp_err mp_init_set_int(mp_int *a, unsigned long b) MP_WUR;
 468 */
 469
 470 /* copy, b = a */
 471 /*
 472 mp_err mp_copy(const mp_int *a, mp_int *b) MP_WUR;
 473 */
 474
 475 /* inits and copies, a = b */
 476 /*
 477 mp_err mp_init_copy(mp_int *a, const mp_int *b) MP_WUR;
 478 */
 479
 480 /* trim unused digits */
 481 /*
 482 void mp_clamp(mp_int *a);
 483 */
 484
 485 /* export binary data */
 486 /*
 487 MP_DEPRECATED(mp_pack) mp_err mp_export(void *rop, size_t *countp, int order, size_t size,
 488                                         int endian, size_t nails, const mp_int *op) MP_WUR;
 489 */
 490
 491 /* import binary data */
 492 /*
 493 MP_DEPRECATED(mp_unpack) mp_err mp_import(mp_int *rop, size_t count, int order,
 494       size_t size, int endian, size_t nails,
 495       const void *op) MP_WUR;
 496 */
 497
 498 /* unpack binary data */
 499 /*
 500 mp_err mp_unpack(mp_int *rop, size_t count, mp_order order, size_t size, mp_endian endian,
 501                  size_t nails, const void *op) MP_WUR;
 502 */
 503
 504 /* pack binary data */
 505 /*
 506 size_t mp_pack_count(const mp_int *a, size_t nails, size_t size) MP_WUR;
 507 */
 508 /*
 509 mp_err mp_pack(void *rop, size_t maxcount, size_t *written, mp_order order, size_t size,
 510                mp_endian endian, size_t nails, const mp_int *op) MP_WUR;
 511 */
 512
 513 /* ---> digit manipulation <--- */
 514
 515 /* right shift by "b" digits */
 516 /*
 517 void mp_rshd(mp_int *a, int b);
 518 */
 519
 520 /* left shift by "b" digits */
 521 /*
 522 mp_err mp_lshd(mp_int *a, int b) MP_WUR;
 523 */
 524
 525 /* c = a / 2**b, implemented as c = a >> b */
 526 /*
 527 mp_err mp_div_2d(const mp_int *a, int b, mp_int *c, mp_int *d) MP_WUR;
 528 */
 529
 530 /* b = a/2 */
 531 /*
 532 mp_err mp_div_2(const mp_int *a, mp_int *b) MP_WUR;
 533 */
 534
 535 /* a/3 => 3c + d == a */
 536 /*
 537 mp_err mp_div_3(const mp_int *a, mp_int *c, mp_digit *d) MP_WUR;
 538 */
 539
 540 /* c = a * 2**b, implemented as c = a << b */
 541 /*
 542 mp_err mp_mul_2d(const mp_int *a, int b, mp_int *c) MP_WUR;
 543 */
 544
 545 /* b = a*2 */
 546 /*
 547 mp_err mp_mul_2(const mp_int *a, mp_int *b) MP_WUR;
 548 */
 549
 550 /* c = a mod 2**b */
 551 /*
 552 mp_err mp_mod_2d(const mp_int *a, int b, mp_int *c) MP_WUR;
 553 */
 554
 555 /* computes a = 2**b */
 556 /*
 557 mp_err mp_2expt(mp_int *a, int b) MP_WUR;
 558 */
 559
 560 /* Counts the number of lsbs which are zero before the first zero bit */
 561 /*
 562 int mp_cnt_lsb(const mp_int *a) MP_WUR;
 563 */
 564
 565 /* I Love Earth! */
 566
 567 /* makes a pseudo-random mp_int of a given size */
 568 /*
 569 mp_err mp_rand(mp_int *a, int digits) MP_WUR;
 570 */
 571 /* makes a pseudo-random small int of a given size */
 572 /*
 573 MP_DEPRECATED(mp_rand) mp_err mp_rand_digit(mp_digit *r) MP_WUR;
 574 */
 575 /* use custom random data source instead of source provided the platform */
 576 /*
 577 void mp_rand_source(mp_err(*source)(void *out, size_t size));
 578 */
 579
 580 #ifdef MP_PRNG_ENABLE_LTM_RNG
 581 /* A last resort to provide random data on systems without any of the other
 582  * implemented ways to gather entropy.
 583  * It is compatible with `rng_get_bytes()` from libtomcrypt so you could
 584  * provide that one and then set `ltm_rng = rng_get_bytes;` */
 585 extern unsigned long (*ltm_rng)(unsigned char *out, unsigned long outlen, void (*callback)(void));
 586 extern void (*ltm_rng_callback)(void);
 587 #endif
 588
 589 /* ---> binary operations <--- */
 590
 591 /* Checks the bit at position b and returns MP_YES
 592  * if the bit is 1, MP_NO if it is 0 and MP_VAL
 593  * in case of error
 594  */
 595 /*
 596 MP_DEPRECATED(s_mp_get_bit) int mp_get_bit(const mp_int *a, int b) MP_WUR;
 597 */
 598
 599 /* c = a XOR b (two complement) */
 600 /*
 601 MP_DEPRECATED(mp_xor) mp_err mp_tc_xor(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 602 */
 603 /*
 604 mp_err mp_xor(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 605 */
 606
 607 /* c = a OR b (two complement) */
 608 /*
 609 MP_DEPRECATED(mp_or) mp_err mp_tc_or(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 610 */
 611 /*
 612 mp_err mp_or(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 613 */
 614
 615 /* c = a AND b (two complement) */
 616 /*
 617 MP_DEPRECATED(mp_and) mp_err mp_tc_and(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 618 */
 619 /*
 620 mp_err mp_and(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 621 */
 622
 623 /* b = ~a (bitwise not, two complement) */
 624 /*
 625 mp_err mp_complement(const mp_int *a, mp_int *b) MP_WUR;
 626 */
 627
 628 /* right shift with sign extension */
 629 /*
 630 MP_DEPRECATED(mp_signed_rsh) mp_err mp_tc_div_2d(const mp_int *a, int b, mp_int *c) MP_WUR;
 631 */
 632 /*
 633 mp_err mp_signed_rsh(const mp_int *a, int b, mp_int *c) MP_WUR;
 634 */
 635
 636 /* ---> Basic arithmetic <--- */
 637
 638 /* b = -a */
 639 /*
 640 mp_err mp_neg(const mp_int *a, mp_int *b) MP_WUR;
 641 */
 642
 643 /* b = |a| */
 644 /*
 645 mp_err mp_abs(const mp_int *a, mp_int *b) MP_WUR;
 646 */
 647
 648 /* compare a to b */
 649 /*
 650 mp_ord mp_cmp(const mp_int *a, const mp_int *b) MP_WUR;
 651 */
 652
 653 /* compare |a| to |b| */
 654 /*
 655 mp_ord mp_cmp_mag(const mp_int *a, const mp_int *b) MP_WUR;
 656 */
 657
 658 /* c = a + b */
 659 /*
 660 mp_err mp_add(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 661 */
 662
 663 /* c = a - b */
 664 /*
 665 mp_err mp_sub(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 666 */
 667
 668 /* c = a * b */
 669 /*
 670 mp_err mp_mul(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 671 */
 672
 673 /* b = a*a  */
 674 /*
 675 mp_err mp_sqr(const mp_int *a, mp_int *b) MP_WUR;
 676 */
 677
 678 /* a/b => cb + d == a */
 679 /*
 680 mp_err mp_div(const mp_int *a, const mp_int *b, mp_int *c, mp_int *d) MP_WUR;
 681 */
 682
 683 /* c = a mod b, 0 <= c < b  */
 684 /*
 685 mp_err mp_mod(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 686 */
 687
 688 /* Increment "a" by one like "a++". Changes input! */
 689 /*
 690 mp_err mp_incr(mp_int *a) MP_WUR;
 691 */
 692
 693 /* Decrement "a" by one like "a--". Changes input! */
 694 /*
 695 mp_err mp_decr(mp_int *a) MP_WUR;
 696 */
 697
 698 /* ---> single digit functions <--- */
 699
 700 /* compare against a single digit */
 701 /*
 702 mp_ord mp_cmp_d(const mp_int *a, mp_digit b) MP_WUR;
 703 */
 704
 705 /* c = a + b */
 706 /*
 707 mp_err mp_add_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
 708 */
 709
 710 /* c = a - b */
 711 /*
 712 mp_err mp_sub_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
 713 */
 714
 715 /* c = a * b */
 716 /*
 717 mp_err mp_mul_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
 718 */
 719
 720 /* a/b => cb + d == a */
 721 /*
 722 mp_err mp_div_d(const mp_int *a, mp_digit b, mp_int *c, mp_digit *d) MP_WUR;
 723 */
 724
 725 /* c = a mod b, 0 <= c < b  */
 726 /*
 727 mp_err mp_mod_d(const mp_int *a, mp_digit b, mp_digit *c) MP_WUR;
 728 */
 729
 730 /* ---> number theory <--- */
 731
 732 /* d = a + b (mod c) */
 733 /*
 734 mp_err mp_addmod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d) MP_WUR;
 735 */
 736
 737 /* d = a - b (mod c) */
 738 /*
 739 mp_err mp_submod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d) MP_WUR;
 740 */
 741
 742 /* d = a * b (mod c) */
 743 /*
 744 mp_err mp_mulmod(const mp_int *a, const mp_int *b, const mp_int *c, mp_int *d) MP_WUR;
 745 */
 746
 747 /* c = a * a (mod b) */
 748 /*
 749 mp_err mp_sqrmod(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 750 */
 751
 752 /* c = 1/a (mod b) */
 753 /*
 754 mp_err mp_invmod(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 755 */
 756
 757 /* c = (a, b) */
 758 /*
 759 mp_err mp_gcd(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 760 */
 761
 762 /* produces value such that U1*a + U2*b = U3 */
 763 /*
 764 mp_err mp_exteuclid(const mp_int *a, const mp_int *b, mp_int *U1, mp_int *U2, mp_int *U3) MP_WUR;
 765 */
 766
 767 /* c = [a, b] or (a*b)/(a, b) */
 768 /*
 769 mp_err mp_lcm(const mp_int *a, const mp_int *b, mp_int *c) MP_WUR;
 770 */
 771
 772 /* finds one of the b'th root of a, such that |c|**b <= |a|
 773  *
 774  * returns error if a < 0 and b is even
 775  */
 776 /*
 777 mp_err mp_root_u32(const mp_int *a, unsigned int b, mp_int *c) MP_WUR;
 778 */
 779 /*
 780 MP_DEPRECATED(mp_root_u32) mp_err mp_n_root(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
 781 */
 782 /*
 783 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;
 784 */
 785
 786 /* special sqrt algo */
 787 /*
 788 mp_err mp_sqrt(const mp_int *arg, mp_int *ret) MP_WUR;
 789 */
 790
 791 /* special sqrt (mod prime) */
 792 /*
 793 mp_err mp_sqrtmod_prime(const mp_int *n, const mp_int *prime, mp_int *ret) MP_WUR;
 794 */
 795
 796 /* is number a square? */
 797 /*
 798 mp_err mp_is_square(const mp_int *arg, mp_bool *ret) MP_WUR;
 799 */
 800
 801 /* computes the jacobi c = (a | n) (or Legendre if b is prime)  */
 802 /*
 803 MP_DEPRECATED(mp_kronecker) mp_err mp_jacobi(const mp_int *a, const mp_int *n, int *c) MP_WUR;
 804 */
 805
 806 /* computes the Kronecker symbol c = (a | p) (like jacobi() but with {a,p} in Z */
 807 /*
 808 mp_err mp_kronecker(const mp_int *a, const mp_int *p, int *c) MP_WUR;
 809 */
 810
 811 /* used to setup the Barrett reduction for a given modulus b */
 812 /*
 813 mp_err mp_reduce_setup(mp_int *a, const mp_int *b) MP_WUR;
 814 */
 815
 816 /* Barrett Reduction, computes a (mod b) with a precomputed value c
 817  *
 818  * Assumes that 0 < x <= m*m, note if 0 > x > -(m*m) then you can merely
 819  * compute the reduction as -1 * mp_reduce(mp_abs(x)) [pseudo code].
 820  */
 821 /*
 822 mp_err mp_reduce(mp_int *x, const mp_int *m, const mp_int *mu) MP_WUR;
 823 */
 824
 825 /* setups the montgomery reduction */
 826 /*
 827 mp_err mp_montgomery_setup(const mp_int *n, mp_digit *rho) MP_WUR;
 828 */
 829
 830 /* computes a = B**n mod b without division or multiplication useful for
 831  * normalizing numbers in a Montgomery system.
 832  */
 833 /*
 834 mp_err mp_montgomery_calc_normalization(mp_int *a, const mp_int *b) MP_WUR;
 835 */
 836
 837 /* computes x/R == x (mod N) via Montgomery Reduction */
 838 /*
 839 mp_err mp_montgomery_reduce(mp_int *x, const mp_int *n, mp_digit rho) MP_WUR;
 840 */
 841
 842 /* returns 1 if a is a valid DR modulus */
 843 /*
 844 mp_bool mp_dr_is_modulus(const mp_int *a) MP_WUR;
 845 */
 846
 847 /* sets the value of "d" required for mp_dr_reduce */
 848 /*
 849 void mp_dr_setup(const mp_int *a, mp_digit *d);
 850 */
 851
 852 /* reduces a modulo n using the Diminished Radix method */
 853 /*
 854 mp_err mp_dr_reduce(mp_int *x, const mp_int *n, mp_digit k) MP_WUR;
 855 */
 856
 857 /* returns true if a can be reduced with mp_reduce_2k */
 858 /*
 859 mp_bool mp_reduce_is_2k(const mp_int *a) MP_WUR;
 860 */
 861
 862 /* determines k value for 2k reduction */
 863 /*
 864 mp_err mp_reduce_2k_setup(const mp_int *a, mp_digit *d) MP_WUR;
 865 */
 866
 867 /* reduces a modulo b where b is of the form 2**p - k [0 <= a] */
 868 /*
 869 mp_err mp_reduce_2k(mp_int *a, const mp_int *n, mp_digit d) MP_WUR;
 870 */
 871
 872 /* returns true if a can be reduced with mp_reduce_2k_l */
 873 /*
 874 mp_bool mp_reduce_is_2k_l(const mp_int *a) MP_WUR;
 875 */
 876
 877 /* determines k value for 2k reduction */
 878 /*
 879 mp_err mp_reduce_2k_setup_l(const mp_int *a, mp_int *d) MP_WUR;
 880 */
 881
 882 /* reduces a modulo b where b is of the form 2**p - k [0 <= a] */
 883 /*
 884 mp_err mp_reduce_2k_l(mp_int *a, const mp_int *n, const mp_int *d) MP_WUR;
 885 */
 886
 887 /* Y = G**X (mod P) */
 888 /*
 889 mp_err mp_exptmod(const mp_int *G, const mp_int *X, const mp_int *P, mp_int *Y) MP_WUR;
 890 */
 891
 892 /* ---> Primes <--- */
 893
 894 /* number of primes */
 895 #ifdef MP_8BIT
 896 #  define PRIVATE_MP_PRIME_TAB_SIZE 31
 897 #else
 898 #  define PRIVATE_MP_PRIME_TAB_SIZE 256
 899 #endif
 900 #define PRIME_SIZE (MP_DEPRECATED_PRAGMA("PRIME_SIZE has been made internal") PRIVATE_MP_PRIME_TAB_SIZE)
 901
 902 /* table of first PRIME_SIZE primes */
 903 #if defined(BUILD_tcl) || !defined(_WIN32)
 904 MODULE_SCOPE const mp_digit ltm_prime_tab[PRIVATE_MP_PRIME_TAB_SIZE];
 905 #endif
 906
 907 /* result=1 if a is divisible by one of the first PRIME_SIZE primes */
 908 /*
 909 MP_DEPRECATED(mp_prime_is_prime) mp_err mp_prime_is_divisible(const mp_int *a, mp_bool *result) MP_WUR;
 910 */
 911
 912 /* performs one Fermat test of "a" using base "b".
 913  * Sets result to 0 if composite or 1 if probable prime
 914  */
 915 /*
 916 mp_err mp_prime_fermat(const mp_int *a, const mp_int *b, mp_bool *result) MP_WUR;
 917 */
 918
 919 /* performs one Miller-Rabin test of "a" using base "b".
 920  * Sets result to 0 if composite or 1 if probable prime
 921  */
 922 /*
 923 mp_err mp_prime_miller_rabin(const mp_int *a, const mp_int *b, mp_bool *result) MP_WUR;
 924 */
 925
 926 /* This gives [for a given bit size] the number of trials required
 927  * such that Miller-Rabin gives a prob of failure lower than 2^-96
 928  */
 929 /*
 930 int mp_prime_rabin_miller_trials(int size) MP_WUR;
 931 */
 932
 933 /* performs one strong Lucas-Selfridge test of "a".
 934  * Sets result to 0 if composite or 1 if probable prime
 935  */
 936 /*
 937 mp_err mp_prime_strong_lucas_selfridge(const mp_int *a, mp_bool *result) MP_WUR;
 938 */
 939
 940 /* performs one Frobenius test of "a" as described by Paul Underwood.
 941  * Sets result to 0 if composite or 1 if probable prime
 942  */
 943 /*
 944 mp_err mp_prime_frobenius_underwood(const mp_int *N, mp_bool *result) MP_WUR;
 945 */
 946
 947 /* performs t random rounds of Miller-Rabin on "a" additional to
 948  * bases 2 and 3.  Also performs an initial sieve of trial
 949  * division.  Determines if "a" is prime with probability
 950  * of error no more than (1/4)**t.
 951  * Both a strong Lucas-Selfridge to complete the BPSW test
 952  * and a separate Frobenius test are available at compile time.
 953  * With t<0 a deterministic test is run for primes up to
 954  * 318665857834031151167461. With t<13 (abs(t)-13) additional
 955  * tests with sequential small primes are run starting at 43.
 956  * Is Fips 186.4 compliant if called with t as computed by
 957  * mp_prime_rabin_miller_trials();
 958  *
 959  * Sets result to 1 if probably prime, 0 otherwise
 960  */
 961 /*
 962 mp_err mp_prime_is_prime(const mp_int *a, int t, mp_bool *result) MP_WUR;
 963 */
 964
 965 /* finds the next prime after the number "a" using "t" trials
 966  * of Miller-Rabin.
 967  *
 968  * bbs_style = 1 means the prime must be congruent to 3 mod 4
 969  */
 970 /*
 971 mp_err mp_prime_next_prime(mp_int *a, int t, int bbs_style) MP_WUR;
 972 */
 973
 974 /* makes a truly random prime of a given size (bytes),
 975  * call with bbs = 1 if you want it to be congruent to 3 mod 4
 976  *
 977  * You have to supply a callback which fills in a buffer with random bytes.  "dat" is a parameter you can
 978  * have passed to the callback (e.g. a state or something).  This function doesn't use "dat" itself
 979  * so it can be NULL
 980  *
 981  * The prime generated will be larger than 2^(8*size).
 982  */
 983 #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))
 984
 985 /* makes a truly random prime of a given size (bits),
 986  *
 987  * Flags are as follows:
 988  *
 989  *   MP_PRIME_BBS      - make prime congruent to 3 mod 4
 990  *   MP_PRIME_SAFE     - make sure (p-1)/2 is prime as well (implies MP_PRIME_BBS)
 991  *   MP_PRIME_2MSB_ON  - make the 2nd highest bit one
 992  *
 993  * You have to supply a callback which fills in a buffer with random bytes.  "dat" is a parameter you can
 994  * have passed to the callback (e.g. a state or something).  This function doesn't use "dat" itself
 995  * so it can be NULL
 996  *
 997  */
 998 /*
 999 MP_DEPRECATED(mp_prime_rand) mp_err mp_prime_random_ex(mp_int *a, int t, int size, int flags,
1000       private_mp_prime_callback cb, void *dat) MP_WUR;
1001 */
1002 /*
1003 mp_err mp_prime_rand(mp_int *a, int t, int size, int flags) MP_WUR;
1004 */
1005
1006 /* Integer logarithm to integer base */
1007 /*
1008 mp_err mp_log_u32(const mp_int *a, unsigned int base, unsigned int *c) MP_WUR;
1009 */
1010
1011 /* c = a**b */
1012 /*
1013 mp_err mp_expt_u32(const mp_int *a, unsigned int b, mp_int *c) MP_WUR;
1014 */
1015 /*
1016 MP_DEPRECATED(mp_expt_u32) mp_err mp_expt_d(const mp_int *a, mp_digit b, mp_int *c) MP_WUR;
1017 */
1018 /*
1019 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;
1020 */
1021
1022 /* ---> radix conversion <--- */
1023 /*
1024 int mp_count_bits(const mp_int *a) MP_WUR;
1025 */
1026
1027
1028 /*
1029 MP_DEPRECATED(mp_ubin_size) int mp_unsigned_bin_size(const mp_int *a) MP_WUR;
1030 */
1031 /*
1032 MP_DEPRECATED(mp_from_ubin) mp_err mp_read_unsigned_bin(mp_int *a, const unsigned char *b, int c) MP_WUR;
1033 */
1034 /*
1035 MP_DEPRECATED(mp_to_ubin) mp_err mp_to_unsigned_bin(const mp_int *a, unsigned char *b) MP_WUR;
1036 */
1037 /*
1038 MP_DEPRECATED(mp_to_ubin) mp_err mp_to_unsigned_bin_n(const mp_int *a, unsigned char *b, unsigned long *outlen) MP_WUR;
1039 */
1040
1041 /*
1042 MP_DEPRECATED(mp_sbin_size) int mp_signed_bin_size(const mp_int *a) MP_WUR;
1043 */
1044 /*
1045 MP_DEPRECATED(mp_from_sbin) mp_err mp_read_signed_bin(mp_int *a, const unsigned char *b, int c) MP_WUR;
1046 */
1047 /*
1048 MP_DEPRECATED(mp_to_sbin) mp_err mp_to_signed_bin(const mp_int *a,  unsigned char *b) MP_WUR;
1049 */
1050 /*
1051 MP_DEPRECATED(mp_to_sbin) mp_err mp_to_signed_bin_n(const mp_int *a, unsigned char *b, unsigned long *outlen) MP_WUR;
1052 */
1053
1054 /*
1055 size_t mp_ubin_size(const mp_int *a) MP_WUR;
1056 */
1057 /*
1058 mp_err mp_from_ubin(mp_int *a, const unsigned char *buf, size_t size) MP_WUR;
1059 */
1060 /*
1061 mp_err mp_to_ubin(const mp_int *a, unsigned char *buf, size_t maxlen, size_t *written) MP_WUR;
1062 */
1063
1064 /*
1065 size_t mp_sbin_size(const mp_int *a) MP_WUR;
1066 */
1067 /*
1068 mp_err mp_from_sbin(mp_int *a, const unsigned char *buf, size_t size) MP_WUR;
1069 */
1070 /*
1071 mp_err mp_to_sbin(const mp_int *a, unsigned char *buf, size_t maxlen, size_t *written) MP_WUR;
1072 */
1073
1074 /*
1075 mp_err mp_read_radix(mp_int *a, const char *str, int radix) MP_WUR;
1076 */
1077 /*
1078 MP_DEPRECATED(mp_to_radix) mp_err mp_toradix(const mp_int *a, char *str, int radix) MP_WUR;
1079 */
1080 /*
1081 MP_DEPRECATED(mp_to_radix) mp_err mp_toradix_n(const mp_int *a, char *str, int radix, int maxlen) MP_WUR;
1082 */
1083 /*
1084 mp_err mp_to_radix(const mp_int *a, char *str, size_t maxlen, size_t *written, int radix) MP_WUR;
1085 */
1086 /*
1087 mp_err mp_radix_size(const mp_int *a, int radix, int *size) MP_WUR;
1088 */
1089
1090 #ifndef MP_NO_FILE
1091 /*
1092 mp_err mp_fread(mp_int *a, int radix, FILE *stream) MP_WUR;
1093 */
1094 /*
1095 mp_err mp_fwrite(const mp_int *a, int radix, FILE *stream) MP_WUR;
1096 */
1097 #endif
1098
1099 #define mp_read_raw(mp, str, len) (MP_DEPRECATED_PRAGMA("replaced by mp_read_signed_bin") mp_read_signed_bin((mp), (str), (len)))
1100 #define mp_raw_size(mp)           (MP_DEPRECATED_PRAGMA("replaced by mp_signed_bin_size") mp_signed_bin_size(mp))
1101 #define mp_toraw(mp, str)         (MP_DEPRECATED_PRAGMA("replaced by mp_to_signed_bin") mp_to_signed_bin((mp), (str)))
1102 #define mp_read_mag(mp, str, len) (MP_DEPRECATED_PRAGMA("replaced by mp_read_unsigned_bin") mp_read_unsigned_bin((mp), (str), (len))
1103 #define mp_mag_size(mp)           (MP_DEPRECATED_PRAGMA("replaced by mp_unsigned_bin_size") mp_unsigned_bin_size(mp))
1104 #define mp_tomag(mp, str)         (MP_DEPRECATED_PRAGMA("replaced by mp_to_unsigned_bin") mp_to_unsigned_bin((mp), (str)))
1105
1106 #define mp_tobinary(M, S)  (MP_DEPRECATED_PRAGMA("replaced by mp_to_binary")  mp_toradix((M), (S), 2))
1107 #define mp_tooctal(M, S)   (MP_DEPRECATED_PRAGMA("replaced by mp_to_octal")   mp_toradix((M), (S), 8))
1108 #define mp_todecimal(M, S) (MP_DEPRECATED_PRAGMA("replaced by mp_to_decimal") mp_toradix((M), (S), 10))
1109 #define mp_tohex(M, S)     (MP_DEPRECATED_PRAGMA("replaced by mp_to_hex")     mp_toradix((M), (S), 16))
1110
1111 #define mp_to_binary(M, S, N)  mp_to_radix((M), (S), (N), NULL, 2)
1112 #define mp_to_octal(M, S, N)   mp_to_radix((M), (S), (N), NULL, 8)
1113 #define mp_to_decimal(M, S, N) mp_to_radix((M), (S), (N), NULL, 10)
1114 #define mp_to_hex(M, S, N)     mp_to_radix((M), (S), (N), NULL, 16)
1115
1116 #ifdef __cplusplus
1117 }
1118 #endif
1119
1120 #include "tclTomMathDecls.h"
1121
1122 #endif