1/* crypto/bn/bn.h */ 2/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com) 3 * All rights reserved. 4 * 5 * This package is an SSL implementation written 6 * by Eric Young (eay@cryptsoft.com). 7 * The implementation was written so as to conform with Netscapes SSL. 8 * 9 * This library is free for commercial and non-commercial use as long as 10 * the following conditions are aheared to. The following conditions 11 * apply to all code found in this distribution, be it the RC4, RSA, 12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 13 * included with this distribution is covered by the same copyright terms 14 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 15 * 16 * Copyright remains Eric Young's, and as such any Copyright notices in 17 * the code are not to be removed. 18 * If this package is used in a product, Eric Young should be given attribution 19 * as the author of the parts of the library used. 20 * This can be in the form of a textual message at program startup or 21 * in documentation (online or textual) provided with the package. 22 * 23 * Redistribution and use in source and binary forms, with or without 24 * modification, are permitted provided that the following conditions 25 * are met: 26 * 1. Redistributions of source code must retain the copyright 27 * notice, this list of conditions and the following disclaimer. 28 * 2. Redistributions in binary form must reproduce the above copyright 29 * notice, this list of conditions and the following disclaimer in the 30 * documentation and/or other materials provided with the distribution. 31 * 3. All advertising materials mentioning features or use of this software 32 * must display the following acknowledgement: 33 * "This product includes cryptographic software written by 34 * Eric Young (eay@cryptsoft.com)" 35 * The word 'cryptographic' can be left out if the rouines from the library 36 * being used are not cryptographic related :-). 37 * 4. If you include any Windows specific code (or a derivative thereof) from 38 * the apps directory (application code) you must include an acknowledgement: 39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 40 * 41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 51 * SUCH DAMAGE. 52 * 53 * The licence and distribution terms for any publically available version or 54 * derivative of this code cannot be changed. i.e. this code cannot simply be 55 * copied and put under another distribution licence 56 * [including the GNU Public Licence.] 57 */ 58/* ==================================================================== 59 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. 60 * 61 * Portions of the attached software ("Contribution") are developed by 62 * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project. 63 * 64 * The Contribution is licensed pursuant to the Eric Young open source 65 * license provided above. 66 * 67 * The binary polynomial arithmetic software is originally written by 68 * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories. 69 * 70 */ 71 72#ifndef HEADER_BN_H 73#define HEADER_BN_H 74 75#include "e_os2.h" 76#ifndef OPENSSL_NO_FP_API 77#include <stdio.h> /* FILE */ 78#endif 79#include "ossl_typ.h" 80 81#ifdef __cplusplus 82extern "C" { 83#endif 84 85/* These preprocessor symbols control various aspects of the bignum headers and 86 * library code. They're not defined by any "normal" configuration, as they are 87 * intended for development and testing purposes. NB: defining all three can be 88 * useful for debugging application code as well as openssl itself. 89 * 90 * BN_DEBUG - turn on various debugging alterations to the bignum code 91 * BN_DEBUG_RAND - uses random poisoning of unused words to trip up 92 * mismanagement of bignum internals. You must also define BN_DEBUG. 93 */ 94/* #define BN_DEBUG */ 95/* #define BN_DEBUG_RAND */ 96 97#define BN_MUL_COMBA 98#define BN_SQR_COMBA 99#define BN_RECURSION 100 101/* This next option uses the C libraries (2 word)/(1 word) function. 102 * If it is not defined, I use my C version (which is slower). 103 * The reason for this flag is that when the particular C compiler 104 * library routine is used, and the library is linked with a different 105 * compiler, the library is missing. This mostly happens when the 106 * library is built with gcc and then linked using normal cc. This would 107 * be a common occurrence because gcc normally produces code that is 108 * 2 times faster than system compilers for the big number stuff. 109 * For machines with only one compiler (or shared libraries), this should 110 * be on. Again this in only really a problem on machines 111 * using "long long's", are 32bit, and are not using my assembler code. */ 112#if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || \ 113 defined(OPENSSL_SYS_WIN32) || defined(linux) 114# ifndef BN_DIV2W 115# define BN_DIV2W 116# endif 117#endif 118 119/* assuming long is 64bit - this is the DEC Alpha 120 * unsigned long long is only 64 bits :-(, don't define 121 * BN_LLONG for the DEC Alpha */ 122#ifdef SIXTY_FOUR_BIT_LONG 123#define BN_ULLONG unsigned long long 124#define BN_ULONG unsigned long 125#define BN_LONG long 126#define BN_BITS 128 127#define BN_BYTES 8 128#define BN_BITS2 64 129#define BN_BITS4 32 130#define BN_MASK (0xffffffffffffffffffffffffffffffffLL) 131#define BN_MASK2 (0xffffffffffffffffL) 132#define BN_MASK2l (0xffffffffL) 133#define BN_MASK2h (0xffffffff00000000L) 134#define BN_MASK2h1 (0xffffffff80000000L) 135#define BN_TBIT (0x8000000000000000L) 136#define BN_DEC_CONV (10000000000000000000UL) 137#define BN_DEC_FMT1 "%lu" 138#define BN_DEC_FMT2 "%019lu" 139#define BN_DEC_NUM 19 140#endif 141 142/* This is where the long long data type is 64 bits, but long is 32. 143 * For machines where there are 64bit registers, this is the mode to use. 144 * IRIX, on R4000 and above should use this mode, along with the relevant 145 * assembler code :-). Do NOT define BN_LLONG. 146 */ 147#ifdef SIXTY_FOUR_BIT 148#undef BN_LLONG 149#undef BN_ULLONG 150#define BN_ULONG unsigned long long 151#define BN_LONG long long 152#define BN_BITS 128 153#define BN_BYTES 8 154#define BN_BITS2 64 155#define BN_BITS4 32 156#define BN_MASK2 (0xffffffffffffffffLL) 157#define BN_MASK2l (0xffffffffL) 158#define BN_MASK2h (0xffffffff00000000LL) 159#define BN_MASK2h1 (0xffffffff80000000LL) 160#define BN_TBIT (0x8000000000000000LL) 161#define BN_DEC_CONV (10000000000000000000ULL) 162#define BN_DEC_FMT1 "%llu" 163#define BN_DEC_FMT2 "%019llu" 164#define BN_DEC_NUM 19 165#endif 166 167#ifdef THIRTY_TWO_BIT 168#ifdef BN_LLONG 169# if defined(OPENSSL_SYS_WIN32) && !defined(__GNUC__) 170# define BN_ULLONG unsigned __int64 171# else 172# define BN_ULLONG unsigned long long 173# endif 174#endif 175#define BN_ULONG unsigned long 176#define BN_LONG long 177#define BN_BITS 64 178#define BN_BYTES 4 179#define BN_BITS2 32 180#define BN_BITS4 16 181#ifdef OPENSSL_SYS_WIN32 182/* VC++ doesn't like the LL suffix */ 183#define BN_MASK (0xffffffffffffffffL) 184#else 185#define BN_MASK (0xffffffffffffffffLL) 186#endif 187#define BN_MASK2 (0xffffffffL) 188#define BN_MASK2l (0xffff) 189#define BN_MASK2h1 (0xffff8000L) 190#define BN_MASK2h (0xffff0000L) 191#define BN_TBIT (0x80000000L) 192#define BN_DEC_CONV (1000000000L) 193#define BN_DEC_FMT1 "%lu" 194#define BN_DEC_FMT2 "%09lu" 195#define BN_DEC_NUM 9 196#endif 197 198#ifdef SIXTEEN_BIT 199#ifndef BN_DIV2W 200#define BN_DIV2W 201#endif 202#define BN_ULLONG unsigned long 203#define BN_ULONG unsigned short 204#define BN_LONG short 205#define BN_BITS 32 206#define BN_BYTES 2 207#define BN_BITS2 16 208#define BN_BITS4 8 209#define BN_MASK (0xffffffff) 210#define BN_MASK2 (0xffff) 211#define BN_MASK2l (0xff) 212#define BN_MASK2h1 (0xff80) 213#define BN_MASK2h (0xff00) 214#define BN_TBIT (0x8000) 215#define BN_DEC_CONV (100000) 216#define BN_DEC_FMT1 "%u" 217#define BN_DEC_FMT2 "%05u" 218#define BN_DEC_NUM 5 219#endif 220 221#ifdef EIGHT_BIT 222#ifndef BN_DIV2W 223#define BN_DIV2W 224#endif 225#define BN_ULLONG unsigned short 226#define BN_ULONG unsigned char 227#define BN_LONG char 228#define BN_BITS 16 229#define BN_BYTES 1 230#define BN_BITS2 8 231#define BN_BITS4 4 232#define BN_MASK (0xffff) 233#define BN_MASK2 (0xff) 234#define BN_MASK2l (0xf) 235#define BN_MASK2h1 (0xf8) 236#define BN_MASK2h (0xf0) 237#define BN_TBIT (0x80) 238#define BN_DEC_CONV (100) 239#define BN_DEC_FMT1 "%u" 240#define BN_DEC_FMT2 "%02u" 241#define BN_DEC_NUM 2 242#endif 243 244#define BN_DEFAULT_BITS 1280 245 246#define BN_FLG_MALLOCED 0x01 247#define BN_FLG_STATIC_DATA 0x02 248#define BN_FLG_EXP_CONSTTIME 0x04 /* avoid leaking exponent information through timings 249 * (BN_mod_exp_mont2() will call BN_mod_exp_mont2_consttime) */ 250#ifndef OPENSSL_NO_DEPRECATED 251#define BN_FLG_FREE 0x8000 /* used for debuging */ 252#endif 253#define BN_set_flags(b,n) ((b)->flags|=(n)) 254#define BN_get_flags(b,n) ((b)->flags&(n)) 255 256/* get a clone of a BIGNUM with changed flags, for *temporary* use only 257 * (the two BIGNUMs cannot not be used in parallel!) */ 258#define BN_with_flags(dest,b,n) ((dest)->d=(b)->d, \ 259 (dest)->top=(b)->top, \ 260 (dest)->dmax=(b)->dmax, \ 261 (dest)->neg=(b)->neg, \ 262 (dest)->flags=(((dest)->flags & BN_FLG_MALLOCED) \ 263 | ((b)->flags & ~BN_FLG_MALLOCED) \ 264 | BN_FLG_STATIC_DATA \ 265 | (n))) 266 267/* Already declared in ossl_typ.h */ 268 269struct bignum_st 270 { 271 BN_ULONG *d; /* Pointer to an array of 'BN_BITS2' bit chunks. */ 272 int top; /* Index of last used d +1. */ 273 /* The next are internal book keeping for bn_expand. */ 274 int dmax; /* Size of the d array. */ 275 int neg; /* one if the number is negative */ 276 int flags; 277 }; 278 279/* Used for montgomery multiplication */ 280struct bn_mont_ctx_st 281 { 282 int ri; /* number of bits in R */ 283 BIGNUM RR; /* used to convert to montgomery form */ 284 BIGNUM N; /* The modulus */ 285 BIGNUM Ni; /* R*(1/R mod N) - N*Ni = 1 286 * (Ni is only stored for bignum algorithm) */ 287 BN_ULONG n0; /* least significant word of Ni */ 288 int flags; 289 }; 290 291/* Used for reciprocal division/mod functions 292 * It cannot be shared between threads 293 */ 294struct bn_recp_ctx_st 295 { 296 BIGNUM N; /* the divisor */ 297 BIGNUM Nr; /* the reciprocal */ 298 int num_bits; 299 int shift; 300 int flags; 301 }; 302 303/* Used for slow "generation" functions. */ 304struct bn_gencb_st 305 { 306 unsigned int ver; /* To handle binary (in)compatibility */ 307 void *arg; /* callback-specific data */ 308 union 309 { 310 /* if(ver==1) - handles old style callbacks */ 311 void (*cb_1)(int, int, void *); 312 /* if(ver==2) - new callback style */ 313 int (*cb_2)(int, int, BN_GENCB *); 314 } cb; 315 }; 316/* Wrapper function to make using BN_GENCB easier, */ 317int BN_GENCB_call(BN_GENCB *cb, int a, int b); 318/* Macro to populate a BN_GENCB structure with an "old"-style callback */ 319#define BN_GENCB_set_old(gencb, callback, cb_arg) { \ 320 BN_GENCB *tmp_gencb = (gencb); \ 321 tmp_gencb->ver = 1; \ 322 tmp_gencb->arg = (cb_arg); \ 323 tmp_gencb->cb.cb_1 = (callback); } 324/* Macro to populate a BN_GENCB structure with a "new"-style callback */ 325#define BN_GENCB_set(gencb, callback, cb_arg) { \ 326 BN_GENCB *tmp_gencb = (gencb); \ 327 tmp_gencb->ver = 2; \ 328 tmp_gencb->arg = (cb_arg); \ 329 tmp_gencb->cb.cb_2 = (callback); } 330 331#define BN_prime_checks 0 /* default: select number of iterations 332 based on the size of the number */ 333 334/* number of Miller-Rabin iterations for an error rate of less than 2^-80 335 * for random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook 336 * of Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996]; 337 * original paper: Damgaard, Landrock, Pomerance: Average case error estimates 338 * for the strong probable prime test. -- Math. Comp. 61 (1993) 177-194) */ 339#define BN_prime_checks_for_size(b) ((b) >= 1300 ? 2 : \ 340 (b) >= 850 ? 3 : \ 341 (b) >= 650 ? 4 : \ 342 (b) >= 550 ? 5 : \ 343 (b) >= 450 ? 6 : \ 344 (b) >= 400 ? 7 : \ 345 (b) >= 350 ? 8 : \ 346 (b) >= 300 ? 9 : \ 347 (b) >= 250 ? 12 : \ 348 (b) >= 200 ? 15 : \ 349 (b) >= 150 ? 18 : \ 350 /* b >= 100 */ 27) 351 352#define BN_num_bytes(a) ((BN_num_bits2(a)+7)/8) 353 354/* Note that BN_abs_is_word didn't work reliably for w == 0 until 0.9.8 */ 355#define BN_abs_is_word(a,w) ((((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w))) || \ 356 (((w) == 0) && ((a)->top == 0))) 357#define BN_is_zero(a) ((a)->top == 0) 358#define BN_is_one(a) (BN_abs_is_word((a),1) && !(a)->neg) 359#define BN_is_word(a,w) (BN_abs_is_word((a),(w)) && (!(w) || !(a)->neg)) 360#define BN_is_odd(a) (((a)->top > 0) && ((a)->d[0] & 1)) 361 362#define BN_one(a) (BN_set_word2((a),1)) 363#define BN_zero_ex(a) \ 364 do { \ 365 BIGNUM *_tmp_bn = (a); \ 366 _tmp_bn->top = 0; \ 367 _tmp_bn->neg = 0; \ 368 } while(0) 369#ifdef OPENSSL_NO_DEPRECATED 370#define BN_zero(a) BN_zero_ex(a) 371#else 372#define BN_zero(a) (BN_set_word2((a),0)) 373#endif 374 375const BIGNUM *BN_value_one2(void); 376char * BN_options(void); 377BN_CTX *BN_CTX_new2(void); 378#ifndef OPENSSL_NO_DEPRECATED 379void BN_CTX_init2(BN_CTX *c); 380#endif 381void BN_CTX_free2(BN_CTX *c); 382void BN_CTX_start2(BN_CTX *ctx); 383BIGNUM *BN_CTX_get2(BN_CTX *ctx); 384void BN_CTX_end2(BN_CTX *ctx); 385int BN_rand2(BIGNUM *rnd, int bits, int top,int bottom); 386int BN_pseudo_rand(BIGNUM *rnd, int bits, int top,int bottom); 387int BN_rand_range(BIGNUM *rnd, BIGNUM *range); 388int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range); 389int BN_num_bits2(const BIGNUM *a); 390int BN_num_bits2_word2(BN_ULONG); 391BIGNUM *BN_new2(void); 392void BN_init2(BIGNUM *); 393void BN_clear_free2(BIGNUM *a); 394BIGNUM *BN_copy2(BIGNUM *a, const BIGNUM *b); 395void BN_swap(BIGNUM *a, BIGNUM *b); 396BIGNUM *BN_bin2bn_b(const unsigned char *s,int len,BIGNUM *ret); 397int BN_bn2bin_b(const BIGNUM *a, unsigned char *to); 398BIGNUM *BN_mpi2bn(const unsigned char *s,int len,BIGNUM *ret); 399int BN_bn2mpi(const BIGNUM *a, unsigned char *to); 400int BN_sub2(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 401int BN_usub2(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 402int BN_uadd2(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 403int BN_add2(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 404int BN_mul2(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); 405int BN_sqr2(BIGNUM *r, const BIGNUM *a,BN_CTX *ctx); 406/* BN_set_negative(): sets sign of a bignum */ 407void BN_set_negative(BIGNUM *b, int n); 408/* BN_get_negative(): returns 1 if the bignum is < 0 and 0 otherwise */ 409#define BN_is_negative(a) ((a)->neg != 0) 410 411int BN_div2(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d, 412 BN_CTX *ctx); 413#define BN_mod(rem,m,d,ctx) BN_div2(NULL,(rem),(m),(d),(ctx)) 414int BN_nnmod2(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx); 415int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx); 416int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m); 417int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx); 418int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m); 419int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 420 const BIGNUM *m, BN_CTX *ctx); 421int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx); 422int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx); 423int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m); 424int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m, BN_CTX *ctx); 425int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m); 426 427BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w); 428BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w); 429int BN_mul_word2(BIGNUM *a, BN_ULONG w); 430int BN_add_word2(BIGNUM *a, BN_ULONG w); 431int BN_sub_word2(BIGNUM *a, BN_ULONG w); 432int BN_set_word2(BIGNUM *a, BN_ULONG w); 433BN_ULONG BN_get_word(const BIGNUM *a); 434 435int BN_cmp(const BIGNUM *a, const BIGNUM *b); 436void BN_free2(BIGNUM *a); 437int BN_is_bit_set2(const BIGNUM *a, int n); 438int BN_lshift_b(BIGNUM *r, const BIGNUM *a, int n); 439int BN_lshift_b1_b(BIGNUM *r, const BIGNUM *a); 440int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,BN_CTX *ctx); 441 442int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 443 const BIGNUM *m,BN_CTX *ctx); 444int BN_mod_exp_mont2(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 445 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); 446int BN_mod_exp_mont2_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p, 447 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont); 448int BN_mod_exp_mont2_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p, 449 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); 450int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1, 451 const BIGNUM *a2, const BIGNUM *p2,const BIGNUM *m, 452 BN_CTX *ctx,BN_MONT_CTX *m_ctx); 453int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 454 const BIGNUM *m,BN_CTX *ctx); 455 456int BN_mask_bits(BIGNUM *a,int n); 457#ifndef OPENSSL_NO_FP_API 458int BN_print_fp(FILE *fp, const BIGNUM *a); 459#endif 460#ifdef HEADER_BIO_H 461int BN_print(BIO *fp, const BIGNUM *a); 462#else 463int BN_print(void *fp, const BIGNUM *a); 464#endif 465int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx); 466int BN_rshift_b(BIGNUM *r, const BIGNUM *a, int n); 467int BN_rshift_b1_b(BIGNUM *r, const BIGNUM *a); 468void BN_clear(BIGNUM *a); 469BIGNUM *BN_dup(const BIGNUM *a); 470int BN_ucmp2(const BIGNUM *a, const BIGNUM *b); 471int BN_set_bit2(BIGNUM *a, int n); 472int BN_clear_bit(BIGNUM *a, int n); 473char * BN_bn2hex(const BIGNUM *a); 474char * BN_bn2dec(const BIGNUM *a); 475int BN_hex2bn(BIGNUM **a, const char *str); 476int BN_dec2bn(BIGNUM **a, const char *str); 477int BN_gcd(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); 478int BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */ 479BIGNUM *BN_mod_inverse2(BIGNUM *ret, 480 const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx); 481BIGNUM *BN_mod_sqrt(BIGNUM *ret, 482 const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx); 483 484/* Deprecated versions */ 485#ifndef OPENSSL_NO_DEPRECATED 486BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe, 487 const BIGNUM *add, const BIGNUM *rem, 488 void (*callback)(int,int,void *),void *cb_arg); 489int BN_is_prime(const BIGNUM *p,int nchecks, 490 void (*callback)(int,int,void *), 491 BN_CTX *ctx,void *cb_arg); 492int BN_is_prime_fasttest(const BIGNUM *p,int nchecks, 493 void (*callback)(int,int,void *),BN_CTX *ctx,void *cb_arg, 494 int do_trial_division); 495#endif /* !defined(OPENSSL_NO_DEPRECATED) */ 496 497/* Newer versions */ 498int BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add, 499 const BIGNUM *rem, BN_GENCB *cb); 500int BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb); 501int BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, 502 int do_trial_division, BN_GENCB *cb); 503 504BN_MONT_CTX *BN_MONT_CTX_new2(void ); 505void BN_MONT_CTX_init2(BN_MONT_CTX *ctx); 506int BN_mod_mul_montgomery2(BIGNUM *r,const BIGNUM *a,const BIGNUM *b, 507 BN_MONT_CTX *mont, BN_CTX *ctx); 508#define BN_to_montgomery(r,a,mont,ctx) BN_mod_mul_montgomery2(\ 509 (r),(a),&((mont)->RR),(mont),(ctx)) 510int BN_from_montgomery2(BIGNUM *r,const BIGNUM *a, 511 BN_MONT_CTX *mont, BN_CTX *ctx); 512void BN_MONT_CTX_free2(BN_MONT_CTX *mont); 513int BN_MONT_CTX_set2(BN_MONT_CTX *mont,const BIGNUM *mod,BN_CTX *ctx); 514BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from); 515BN_MONT_CTX *BN_MONT_CTX_set2_locked(BN_MONT_CTX **pmont, int lock, 516 const BIGNUM *mod, BN_CTX *ctx); 517 518/* BN_BLINDING flags */ 519#define BN_BLINDING_NO_UPDATE 0x00000001 520#define BN_BLINDING_NO_RECREATE 0x00000002 521 522BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod); 523void BN_BLINDING_free(BN_BLINDING *b); 524int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx); 525int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx); 526int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx); 527int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *); 528int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *); 529unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *); 530void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long); 531unsigned long BN_BLINDING_get_flags(const BN_BLINDING *); 532void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long); 533BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b, 534 const BIGNUM *e, BIGNUM *m, BN_CTX *ctx, 535 int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 536 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx), 537 BN_MONT_CTX *m_ctx); 538 539#ifndef OPENSSL_NO_DEPRECATED 540void BN_set_params(int mul,int high,int low,int mont); 541int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */ 542#endif 543 544void BN_RECP_CTX_init(BN_RECP_CTX *recp); 545BN_RECP_CTX *BN_RECP_CTX_new(void); 546void BN_RECP_CTX_free(BN_RECP_CTX *recp); 547int BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx); 548int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y, 549 BN_RECP_CTX *recp,BN_CTX *ctx); 550int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 551 const BIGNUM *m, BN_CTX *ctx); 552int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, 553 BN_RECP_CTX *recp, BN_CTX *ctx); 554 555/* Functions for arithmetic over binary polynomials represented by BIGNUMs. 556 * 557 * The BIGNUM::neg property of BIGNUMs representing binary polynomials is 558 * ignored. 559 * 560 * Note that input arguments are not const so that their bit arrays can 561 * be expanded to the appropriate size if needed. 562 */ 563 564int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); /*r = a + b*/ 565#define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b) 566int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p); /*r=a mod p*/ 567int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 568 const BIGNUM *p, BN_CTX *ctx); /* r = (a * b) mod p */ 569int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 570 BN_CTX *ctx); /* r = (a * a) mod p */ 571int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, 572 BN_CTX *ctx); /* r = (1 / b) mod p */ 573int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 574 const BIGNUM *p, BN_CTX *ctx); /* r = (a / b) mod p */ 575int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 576 const BIGNUM *p, BN_CTX *ctx); /* r = (a ^ b) mod p */ 577int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 578 BN_CTX *ctx); /* r = sqrt(a) mod p */ 579int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 580 BN_CTX *ctx); /* r^2 + r = a mod p */ 581#define BN_GF2m_cmp(a, b) BN_ucmp2((a), (b)) 582/* Some functions allow for representation of the irreducible polynomials 583 * as an unsigned int[], say p. The irreducible f(t) is then of the form: 584 * t^p[0] + t^p[1] + ... + t^p[k] 585 * where m = p[0] > p[1] > ... > p[k] = 0. 586 */ 587int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[]); 588 /* r = a mod p */ 589int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 590 const unsigned int p[], BN_CTX *ctx); /* r = (a * b) mod p */ 591int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[], 592 BN_CTX *ctx); /* r = (a * a) mod p */ 593int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const unsigned int p[], 594 BN_CTX *ctx); /* r = (1 / b) mod p */ 595int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 596 const unsigned int p[], BN_CTX *ctx); /* r = (a / b) mod p */ 597int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 598 const unsigned int p[], BN_CTX *ctx); /* r = (a ^ b) mod p */ 599int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a, 600 const unsigned int p[], BN_CTX *ctx); /* r = sqrt(a) mod p */ 601int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a, 602 const unsigned int p[], BN_CTX *ctx); /* r^2 + r = a mod p */ 603int BN_GF2m_poly2arr(const BIGNUM *a, unsigned int p[], int max); 604int BN_GF2m_arr2poly(const unsigned int p[], BIGNUM *a); 605 606/* faster mod functions for the 'NIST primes' 607 * 0 <= a < p^2 */ 608int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 609int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 610int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 611int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 612int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 613 614const BIGNUM *BN_get0_nist_prime_192(void); 615const BIGNUM *BN_get0_nist_prime_224(void); 616const BIGNUM *BN_get0_nist_prime_256(void); 617const BIGNUM *BN_get0_nist_prime_384(void); 618const BIGNUM *BN_get0_nist_prime_521(void); 619 620/* library internal functions */ 621 622#define bn_expand(a,bits) ((((((bits+BN_BITS2-1))/BN_BITS2)) <= (a)->dmax)?\ 623 (a):bn_expand22((a),(bits+BN_BITS2-1)/BN_BITS2)) 624#define bn_wexpand(a,words) (((words) <= (a)->dmax)?(a):bn_expand22((a),(words))) 625BIGNUM *bn_expand22(BIGNUM *a, int words); 626#ifndef OPENSSL_NO_DEPRECATED 627BIGNUM *bn_dup_expand(const BIGNUM *a, int words); /* unused */ 628#endif 629 630/* Bignum consistency macros 631 * There is one "API" macro, bn_fix_top(), for stripping leading zeroes from 632 * bignum data after direct manipulations on the data. There is also an 633 * "internal" macro, bn_check_top(), for verifying that there are no leading 634 * zeroes. Unfortunately, some auditing is required due to the fact that 635 * bn_fix_top() has become an overabused duct-tape because bignum data is 636 * occasionally passed around in an inconsistent state. So the following 637 * changes have been made to sort this out; 638 * - bn_fix_top()s implementation has been moved to bn_correct_top() 639 * - if BN_DEBUG isn't defined, bn_fix_top() maps to bn_correct_top(), and 640 * bn_check_top() is as before. 641 * - if BN_DEBUG *is* defined; 642 * - bn_check_top() tries to pollute unused words even if the bignum 'top' is 643 * consistent. (ed: only if BN_DEBUG_RAND is defined) 644 * - bn_fix_top() maps to bn_check_top() rather than "fixing" anything. 645 * The idea is to have debug builds flag up inconsistent bignums when they 646 * occur. If that occurs in a bn_fix_top(), we examine the code in question; if 647 * the use of bn_fix_top() was appropriate (ie. it follows directly after code 648 * that manipulates the bignum) it is converted to bn_correct_top(), and if it 649 * was not appropriate, we convert it permanently to bn_check_top() and track 650 * down the cause of the bug. Eventually, no internal code should be using the 651 * bn_fix_top() macro. External applications and libraries should try this with 652 * their own code too, both in terms of building against the openssl headers 653 * with BN_DEBUG defined *and* linking with a version of OpenSSL built with it 654 * defined. This not only improves external code, it provides more test 655 * coverage for openssl's own code. 656 */ 657 658#ifdef BN_DEBUG 659 660/* We only need assert() when debugging */ 661#include <assert.h> 662 663#ifdef BN_DEBUG_RAND 664/* To avoid "make update" cvs wars due to BN_DEBUG, use some tricks */ 665#ifndef RAND_pseudo_bytes 666int RAND_pseudo_bytes(unsigned char *buf,int num); 667#define BN_DEBUG_TRIX 668#endif 669#define bn_pollute(a) \ 670 do { \ 671 const BIGNUM *_bnum1 = (a); \ 672 if(_bnum1->top < _bnum1->dmax) { \ 673 unsigned char _tmp_char; \ 674 /* We cast away const without the compiler knowing, any \ 675 * *genuinely* constant variables that aren't mutable \ 676 * wouldn't be constructed with top!=dmax. */ \ 677 BN_ULONG *_not_const; \ 678 memcpy(&_not_const, &_bnum1->d, sizeof(BN_ULONG*)); \ 679 RAND_pseudo_bytes(&_tmp_char, 1); \ 680 memset((unsigned char *)(_not_const + _bnum1->top), _tmp_char, \ 681 (_bnum1->dmax - _bnum1->top) * sizeof(BN_ULONG)); \ 682 } \ 683 } while(0) 684#ifdef BN_DEBUG_TRIX 685#undef RAND_pseudo_bytes 686#endif 687#else 688#define bn_pollute(a) 689#endif 690#define bn_check_top(a) \ 691 do { \ 692 const BIGNUM *_bnum2 = (a); \ 693 if (_bnum2 != NULL) { \ 694 assert((_bnum2->top == 0) || \ 695 (_bnum2->d[_bnum2->top - 1] != 0)); \ 696 bn_pollute(_bnum2); \ 697 } \ 698 } while(0) 699 700#define bn_fix_top(a) bn_check_top(a) 701 702#else /* !BN_DEBUG */ 703 704#define bn_pollute(a) 705#define bn_check_top(a) 706#define bn_fix_top(a) bn_correct_top(a) 707 708#endif 709 710#define bn_correct_top(a) \ 711 { \ 712 BN_ULONG *ftl; \ 713 if ((a)->top > 0) \ 714 { \ 715 for (ftl= &((a)->d[(a)->top-1]); (a)->top > 0; (a)->top--) \ 716 if (*(ftl--)) break; \ 717 } \ 718 bn_pollute(a); \ 719 } 720 721BN_ULONG bn_mul_add_words2(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w); 722BN_ULONG bn_mul_words2(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w); 723void bn_sqr_words2(BN_ULONG *rp, const BN_ULONG *ap, int num); 724BN_ULONG bn_div_words2(BN_ULONG h, BN_ULONG l, BN_ULONG d); 725BN_ULONG bn_add_words2(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num); 726BN_ULONG bn_sub_words2(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num); 727 728/* Primes from RFC 2409 */ 729BIGNUM *get_rfc2409_prime_768(BIGNUM *bn); 730BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn); 731 732/* Primes from RFC 3526 */ 733BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn); 734BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn); 735BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn); 736BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn); 737BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn); 738BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn); 739 740int BN_bntest_rand(BIGNUM *rnd, int bits, int top,int bottom); 741 742/* BEGIN ERROR CODES */ 743/* The following lines are auto generated by the script mkerr.pl. Any changes 744 * made after this point may be overwritten when the script is next run. 745 */ 746void ERR_load_BN_strings(void); 747 748/* Error codes for the BN functions. */ 749 750/* Function codes. */ 751#define BN_F_BNRAND 127 752#define BN_F_BN_BLINDING_CONVERT_EX 100 753#define BN_F_BN_BLINDING_CREATE_PARAM 128 754#define BN_F_BN_BLINDING_INVERT_EX 101 755#define BN_F_BN_BLINDING_NEW 102 756#define BN_F_BN_BLINDING_UPDATE 103 757#define BN_F_BN_BN2DEC 104 758#define BN_F_BN_BN2HEX 105 759#define BN_F_BN_CTX_GET 116 760#define BN_F_BN_CTX_NEW 106 761#define BN_F_BN_CTX_START 129 762#define BN_F_BN_DIV 107 763#define BN_F_BN_DIV_RECP 130 764#define BN_F_BN_EXP 123 765#define BN_F_BN_EXPAND2 108 766#define BN_F_BN_EXPAND_INTERNAL 120 767#define BN_F_BN_GF2M_MOD 131 768#define BN_F_BN_GF2M_MOD_EXP 132 769#define BN_F_BN_GF2M_MOD_MUL 133 770#define BN_F_BN_GF2M_MOD_SOLVE_QUAD 134 771#define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR 135 772#define BN_F_BN_GF2M_MOD_SQR 136 773#define BN_F_BN_GF2M_MOD_SQRT 137 774#define BN_F_BN_MOD_EXP2_MONT 118 775#define BN_F_BN_MOD_EXP_MONT 109 776#define BN_F_BN_MOD_EXP_MONT_CONSTTIME 124 777#define BN_F_BN_MOD_EXP_MONT_WORD 117 778#define BN_F_BN_MOD_EXP_RECP 125 779#define BN_F_BN_MOD_EXP_SIMPLE 126 780#define BN_F_BN_MOD_INVERSE 110 781#define BN_F_BN_MOD_LSHIFT_QUICK 119 782#define BN_F_BN_MOD_MUL_RECIPROCAL 111 783#define BN_F_BN_MOD_SQRT 121 784#define BN_F_BN_MPI2BN 112 785#define BN_F_BN_NEW 113 786#define BN_F_BN_RAND 114 787#define BN_F_BN_RAND_RANGE 122 788#define BN_F_BN_USUB 115 789 790/* Reason codes. */ 791#define BN_R_ARG2_LT_ARG3 100 792#define BN_R_BAD_RECIPROCAL 101 793#define BN_R_BIGNUM_TOO_LONG 114 794#define BN_R_CALLED_WITH_EVEN_MODULUS 102 795#define BN_R_DIV_BY_ZERO 103 796#define BN_R_ENCODING_ERROR 104 797#define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA 105 798#define BN_R_INPUT_NOT_REDUCED 110 799#define BN_R_INVALID_LENGTH 106 800#define BN_R_INVALID_RANGE 115 801#define BN_R_NOT_A_SQUARE 111 802#define BN_R_NOT_INITIALIZED 107 803#define BN_R_NO_INVERSE 108 804#define BN_R_NO_SOLUTION 116 805#define BN_R_P_IS_NOT_PRIME 112 806#define BN_R_TOO_MANY_ITERATIONS 113 807#define BN_R_TOO_MANY_TEMPORARY_VARIABLES 109 808 809#ifdef __cplusplus 810} 811#endif 812#endif 813