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