bn.h revision 160815
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 <openssl/e_os2.h> 76#ifndef OPENSSL_NO_FP_API 77#include <stdio.h> /* FILE */ 78#endif 79#include <openssl/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_mont() will call BN_mod_exp_mont_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#if 0 269typedef struct bignum_st BIGNUM; 270/* Used for temp variables (declaration hidden in bn_lcl.h) */ 271typedef struct bignum_ctx BN_CTX; 272typedef struct bn_blinding_st BN_BLINDING; 273typedef struct bn_mont_ctx_st BN_MONT_CTX; 274typedef struct bn_recp_ctx_st BN_RECP_CTX; 275typedef struct bn_gencb_st BN_GENCB; 276#endif 277 278struct bignum_st 279 { 280 BN_ULONG *d; /* Pointer to an array of 'BN_BITS2' bit chunks. */ 281 int top; /* Index of last used d +1. */ 282 /* The next are internal book keeping for bn_expand. */ 283 int dmax; /* Size of the d array. */ 284 int neg; /* one if the number is negative */ 285 int flags; 286 }; 287 288/* Used for montgomery multiplication */ 289struct bn_mont_ctx_st 290 { 291 int ri; /* number of bits in R */ 292 BIGNUM RR; /* used to convert to montgomery form */ 293 BIGNUM N; /* The modulus */ 294 BIGNUM Ni; /* R*(1/R mod N) - N*Ni = 1 295 * (Ni is only stored for bignum algorithm) */ 296 BN_ULONG n0; /* least significant word of Ni */ 297 int flags; 298 }; 299 300/* Used for reciprocal division/mod functions 301 * It cannot be shared between threads 302 */ 303struct bn_recp_ctx_st 304 { 305 BIGNUM N; /* the divisor */ 306 BIGNUM Nr; /* the reciprocal */ 307 int num_bits; 308 int shift; 309 int flags; 310 }; 311 312/* Used for slow "generation" functions. */ 313struct bn_gencb_st 314 { 315 unsigned int ver; /* To handle binary (in)compatibility */ 316 void *arg; /* callback-specific data */ 317 union 318 { 319 /* if(ver==1) - handles old style callbacks */ 320 void (*cb_1)(int, int, void *); 321 /* if(ver==2) - new callback style */ 322 int (*cb_2)(int, int, BN_GENCB *); 323 } cb; 324 }; 325/* Wrapper function to make using BN_GENCB easier, */ 326int BN_GENCB_call(BN_GENCB *cb, int a, int b); 327/* Macro to populate a BN_GENCB structure with an "old"-style callback */ 328#define BN_GENCB_set_old(gencb, callback, cb_arg) { \ 329 BN_GENCB *tmp_gencb = (gencb); \ 330 tmp_gencb->ver = 1; \ 331 tmp_gencb->arg = (cb_arg); \ 332 tmp_gencb->cb.cb_1 = (callback); } 333/* Macro to populate a BN_GENCB structure with a "new"-style callback */ 334#define BN_GENCB_set(gencb, callback, cb_arg) { \ 335 BN_GENCB *tmp_gencb = (gencb); \ 336 tmp_gencb->ver = 2; \ 337 tmp_gencb->arg = (cb_arg); \ 338 tmp_gencb->cb.cb_2 = (callback); } 339 340#define BN_prime_checks 0 /* default: select number of iterations 341 based on the size of the number */ 342 343/* number of Miller-Rabin iterations for an error rate of less than 2^-80 344 * for random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook 345 * of Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996]; 346 * original paper: Damgaard, Landrock, Pomerance: Average case error estimates 347 * for the strong probable prime test. -- Math. Comp. 61 (1993) 177-194) */ 348#define BN_prime_checks_for_size(b) ((b) >= 1300 ? 2 : \ 349 (b) >= 850 ? 3 : \ 350 (b) >= 650 ? 4 : \ 351 (b) >= 550 ? 5 : \ 352 (b) >= 450 ? 6 : \ 353 (b) >= 400 ? 7 : \ 354 (b) >= 350 ? 8 : \ 355 (b) >= 300 ? 9 : \ 356 (b) >= 250 ? 12 : \ 357 (b) >= 200 ? 15 : \ 358 (b) >= 150 ? 18 : \ 359 /* b >= 100 */ 27) 360 361#define BN_num_bytes(a) ((BN_num_bits(a)+7)/8) 362 363/* Note that BN_abs_is_word didn't work reliably for w == 0 until 0.9.8 */ 364#define BN_abs_is_word(a,w) ((((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w))) || \ 365 (((w) == 0) && ((a)->top == 0))) 366#define BN_is_zero(a) ((a)->top == 0) 367#define BN_is_one(a) (BN_abs_is_word((a),1) && !(a)->neg) 368#define BN_is_word(a,w) (BN_abs_is_word((a),(w)) && (!(w) || !(a)->neg)) 369#define BN_is_odd(a) (((a)->top > 0) && ((a)->d[0] & 1)) 370 371#define BN_one(a) (BN_set_word((a),1)) 372#define BN_zero_ex(a) \ 373 do { \ 374 BIGNUM *_tmp_bn = (a); \ 375 _tmp_bn->top = 0; \ 376 _tmp_bn->neg = 0; \ 377 } while(0) 378#ifdef OPENSSL_NO_DEPRECATED 379#define BN_zero(a) BN_zero_ex(a) 380#else 381#define BN_zero(a) (BN_set_word((a),0)) 382#endif 383 384const BIGNUM *BN_value_one(void); 385char * BN_options(void); 386BN_CTX *BN_CTX_new(void); 387#ifndef OPENSSL_NO_DEPRECATED 388void BN_CTX_init(BN_CTX *c); 389#endif 390void BN_CTX_free(BN_CTX *c); 391void BN_CTX_start(BN_CTX *ctx); 392BIGNUM *BN_CTX_get(BN_CTX *ctx); 393void BN_CTX_end(BN_CTX *ctx); 394int BN_rand(BIGNUM *rnd, int bits, int top,int bottom); 395int BN_pseudo_rand(BIGNUM *rnd, int bits, int top,int bottom); 396int BN_rand_range(BIGNUM *rnd, BIGNUM *range); 397int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range); 398int BN_num_bits(const BIGNUM *a); 399int BN_num_bits_word(BN_ULONG); 400BIGNUM *BN_new(void); 401void BN_init(BIGNUM *); 402void BN_clear_free(BIGNUM *a); 403BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b); 404void BN_swap(BIGNUM *a, BIGNUM *b); 405BIGNUM *BN_bin2bn(const unsigned char *s,int len,BIGNUM *ret); 406int BN_bn2bin(const BIGNUM *a, unsigned char *to); 407BIGNUM *BN_mpi2bn(const unsigned char *s,int len,BIGNUM *ret); 408int BN_bn2mpi(const BIGNUM *a, unsigned char *to); 409int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 410int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 411int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 412int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 413int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); 414int BN_sqr(BIGNUM *r, const BIGNUM *a,BN_CTX *ctx); 415/** BN_set_negative sets sign of a BIGNUM 416 * \param b pointer to the BIGNUM object 417 * \param n 0 if the BIGNUM b should be positive and a value != 0 otherwise 418 */ 419void BN_set_negative(BIGNUM *b, int n); 420/** BN_is_negative returns 1 if the BIGNUM is negative 421 * \param a pointer to the BIGNUM object 422 * \return 1 if a < 0 and 0 otherwise 423 */ 424#define BN_is_negative(a) ((a)->neg != 0) 425 426int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d, 427 BN_CTX *ctx); 428#define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx)) 429int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx); 430int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx); 431int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m); 432int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx); 433int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m); 434int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 435 const BIGNUM *m, BN_CTX *ctx); 436int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx); 437int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx); 438int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m); 439int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m, BN_CTX *ctx); 440int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m); 441 442BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w); 443BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w); 444int BN_mul_word(BIGNUM *a, BN_ULONG w); 445int BN_add_word(BIGNUM *a, BN_ULONG w); 446int BN_sub_word(BIGNUM *a, BN_ULONG w); 447int BN_set_word(BIGNUM *a, BN_ULONG w); 448BN_ULONG BN_get_word(const BIGNUM *a); 449 450int BN_cmp(const BIGNUM *a, const BIGNUM *b); 451void BN_free(BIGNUM *a); 452int BN_is_bit_set(const BIGNUM *a, int n); 453int BN_lshift(BIGNUM *r, const BIGNUM *a, int n); 454int BN_lshift1(BIGNUM *r, const BIGNUM *a); 455int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,BN_CTX *ctx); 456 457int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 458 const BIGNUM *m,BN_CTX *ctx); 459int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 460 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); 461int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p, 462 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont); 463int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p, 464 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); 465int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1, 466 const BIGNUM *a2, const BIGNUM *p2,const BIGNUM *m, 467 BN_CTX *ctx,BN_MONT_CTX *m_ctx); 468int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 469 const BIGNUM *m,BN_CTX *ctx); 470 471int BN_mask_bits(BIGNUM *a,int n); 472#ifndef OPENSSL_NO_FP_API 473int BN_print_fp(FILE *fp, const BIGNUM *a); 474#endif 475#ifdef HEADER_BIO_H 476int BN_print(BIO *fp, const BIGNUM *a); 477#else 478int BN_print(void *fp, const BIGNUM *a); 479#endif 480int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx); 481int BN_rshift(BIGNUM *r, const BIGNUM *a, int n); 482int BN_rshift1(BIGNUM *r, const BIGNUM *a); 483void BN_clear(BIGNUM *a); 484BIGNUM *BN_dup(const BIGNUM *a); 485int BN_ucmp(const BIGNUM *a, const BIGNUM *b); 486int BN_set_bit(BIGNUM *a, int n); 487int BN_clear_bit(BIGNUM *a, int n); 488char * BN_bn2hex(const BIGNUM *a); 489char * BN_bn2dec(const BIGNUM *a); 490int BN_hex2bn(BIGNUM **a, const char *str); 491int BN_dec2bn(BIGNUM **a, const char *str); 492int BN_gcd(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); 493int BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */ 494BIGNUM *BN_mod_inverse(BIGNUM *ret, 495 const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx); 496BIGNUM *BN_mod_sqrt(BIGNUM *ret, 497 const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx); 498 499/* Deprecated versions */ 500#ifndef OPENSSL_NO_DEPRECATED 501BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe, 502 const BIGNUM *add, const BIGNUM *rem, 503 void (*callback)(int,int,void *),void *cb_arg); 504int BN_is_prime(const BIGNUM *p,int nchecks, 505 void (*callback)(int,int,void *), 506 BN_CTX *ctx,void *cb_arg); 507int BN_is_prime_fasttest(const BIGNUM *p,int nchecks, 508 void (*callback)(int,int,void *),BN_CTX *ctx,void *cb_arg, 509 int do_trial_division); 510#endif /* !defined(OPENSSL_NO_DEPRECATED) */ 511 512/* Newer versions */ 513int BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add, 514 const BIGNUM *rem, BN_GENCB *cb); 515int BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb); 516int BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, 517 int do_trial_division, BN_GENCB *cb); 518 519BN_MONT_CTX *BN_MONT_CTX_new(void ); 520void BN_MONT_CTX_init(BN_MONT_CTX *ctx); 521int BN_mod_mul_montgomery(BIGNUM *r,const BIGNUM *a,const BIGNUM *b, 522 BN_MONT_CTX *mont, BN_CTX *ctx); 523#define BN_to_montgomery(r,a,mont,ctx) BN_mod_mul_montgomery(\ 524 (r),(a),&((mont)->RR),(mont),(ctx)) 525int BN_from_montgomery(BIGNUM *r,const BIGNUM *a, 526 BN_MONT_CTX *mont, BN_CTX *ctx); 527void BN_MONT_CTX_free(BN_MONT_CTX *mont); 528int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *mod,BN_CTX *ctx); 529BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from); 530BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock, 531 const BIGNUM *mod, BN_CTX *ctx); 532 533/* BN_BLINDING flags */ 534#define BN_BLINDING_NO_UPDATE 0x00000001 535#define BN_BLINDING_NO_RECREATE 0x00000002 536 537BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod); 538void BN_BLINDING_free(BN_BLINDING *b); 539int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx); 540int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx); 541int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx); 542int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *); 543int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *); 544unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *); 545void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long); 546unsigned long BN_BLINDING_get_flags(const BN_BLINDING *); 547void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long); 548BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b, 549 const BIGNUM *e, BIGNUM *m, BN_CTX *ctx, 550 int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 551 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx), 552 BN_MONT_CTX *m_ctx); 553 554#ifndef OPENSSL_NO_DEPRECATED 555void BN_set_params(int mul,int high,int low,int mont); 556int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */ 557#endif 558 559void BN_RECP_CTX_init(BN_RECP_CTX *recp); 560BN_RECP_CTX *BN_RECP_CTX_new(void); 561void BN_RECP_CTX_free(BN_RECP_CTX *recp); 562int BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx); 563int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y, 564 BN_RECP_CTX *recp,BN_CTX *ctx); 565int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 566 const BIGNUM *m, BN_CTX *ctx); 567int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, 568 BN_RECP_CTX *recp, BN_CTX *ctx); 569 570/* Functions for arithmetic over binary polynomials represented by BIGNUMs. 571 * 572 * The BIGNUM::neg property of BIGNUMs representing binary polynomials is 573 * ignored. 574 * 575 * Note that input arguments are not const so that their bit arrays can 576 * be expanded to the appropriate size if needed. 577 */ 578 579int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); /*r = a + b*/ 580#define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b) 581int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p); /*r=a mod p*/ 582int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 583 const BIGNUM *p, BN_CTX *ctx); /* r = (a * b) mod p */ 584int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 585 BN_CTX *ctx); /* r = (a * a) mod p */ 586int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, 587 BN_CTX *ctx); /* r = (1 / b) mod p */ 588int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 589 const BIGNUM *p, BN_CTX *ctx); /* r = (a / b) mod p */ 590int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 591 const BIGNUM *p, BN_CTX *ctx); /* r = (a ^ b) mod p */ 592int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 593 BN_CTX *ctx); /* r = sqrt(a) mod p */ 594int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 595 BN_CTX *ctx); /* r^2 + r = a mod p */ 596#define BN_GF2m_cmp(a, b) BN_ucmp((a), (b)) 597/* Some functions allow for representation of the irreducible polynomials 598 * as an unsigned int[], say p. The irreducible f(t) is then of the form: 599 * t^p[0] + t^p[1] + ... + t^p[k] 600 * where m = p[0] > p[1] > ... > p[k] = 0. 601 */ 602int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[]); 603 /* r = a mod p */ 604int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 605 const unsigned int p[], BN_CTX *ctx); /* r = (a * b) mod p */ 606int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[], 607 BN_CTX *ctx); /* r = (a * a) mod p */ 608int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const unsigned int p[], 609 BN_CTX *ctx); /* r = (1 / b) mod p */ 610int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 611 const unsigned int p[], BN_CTX *ctx); /* r = (a / b) mod p */ 612int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, 613 const unsigned int p[], BN_CTX *ctx); /* r = (a ^ b) mod p */ 614int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a, 615 const unsigned int p[], BN_CTX *ctx); /* r = sqrt(a) mod p */ 616int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a, 617 const unsigned int p[], BN_CTX *ctx); /* r^2 + r = a mod p */ 618int BN_GF2m_poly2arr(const BIGNUM *a, unsigned int p[], int max); 619int BN_GF2m_arr2poly(const unsigned int p[], BIGNUM *a); 620 621/* faster mod functions for the 'NIST primes' 622 * 0 <= a < p^2 */ 623int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 624int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 625int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 626int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 627int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); 628 629const BIGNUM *BN_get0_nist_prime_192(void); 630const BIGNUM *BN_get0_nist_prime_224(void); 631const BIGNUM *BN_get0_nist_prime_256(void); 632const BIGNUM *BN_get0_nist_prime_384(void); 633const BIGNUM *BN_get0_nist_prime_521(void); 634 635/* library internal functions */ 636 637#define bn_expand(a,bits) ((((((bits+BN_BITS2-1))/BN_BITS2)) <= (a)->dmax)?\ 638 (a):bn_expand2((a),(bits+BN_BITS2-1)/BN_BITS2)) 639#define bn_wexpand(a,words) (((words) <= (a)->dmax)?(a):bn_expand2((a),(words))) 640BIGNUM *bn_expand2(BIGNUM *a, int words); 641#ifndef OPENSSL_NO_DEPRECATED 642BIGNUM *bn_dup_expand(const BIGNUM *a, int words); /* unused */ 643#endif 644 645/* Bignum consistency macros 646 * There is one "API" macro, bn_fix_top(), for stripping leading zeroes from 647 * bignum data after direct manipulations on the data. There is also an 648 * "internal" macro, bn_check_top(), for verifying that there are no leading 649 * zeroes. Unfortunately, some auditing is required due to the fact that 650 * bn_fix_top() has become an overabused duct-tape because bignum data is 651 * occasionally passed around in an inconsistent state. So the following 652 * changes have been made to sort this out; 653 * - bn_fix_top()s implementation has been moved to bn_correct_top() 654 * - if BN_DEBUG isn't defined, bn_fix_top() maps to bn_correct_top(), and 655 * bn_check_top() is as before. 656 * - if BN_DEBUG *is* defined; 657 * - bn_check_top() tries to pollute unused words even if the bignum 'top' is 658 * consistent. (ed: only if BN_DEBUG_RAND is defined) 659 * - bn_fix_top() maps to bn_check_top() rather than "fixing" anything. 660 * The idea is to have debug builds flag up inconsistent bignums when they 661 * occur. If that occurs in a bn_fix_top(), we examine the code in question; if 662 * the use of bn_fix_top() was appropriate (ie. it follows directly after code 663 * that manipulates the bignum) it is converted to bn_correct_top(), and if it 664 * was not appropriate, we convert it permanently to bn_check_top() and track 665 * down the cause of the bug. Eventually, no internal code should be using the 666 * bn_fix_top() macro. External applications and libraries should try this with 667 * their own code too, both in terms of building against the openssl headers 668 * with BN_DEBUG defined *and* linking with a version of OpenSSL built with it 669 * defined. This not only improves external code, it provides more test 670 * coverage for openssl's own code. 671 */ 672 673#ifdef BN_DEBUG 674 675/* We only need assert() when debugging */ 676#include <assert.h> 677 678#ifdef BN_DEBUG_RAND 679/* To avoid "make update" cvs wars due to BN_DEBUG, use some tricks */ 680#ifndef RAND_pseudo_bytes 681int RAND_pseudo_bytes(unsigned char *buf,int num); 682#define BN_DEBUG_TRIX 683#endif 684#define bn_pollute(a) \ 685 do { \ 686 const BIGNUM *_bnum1 = (a); \ 687 if(_bnum1->top < _bnum1->dmax) { \ 688 unsigned char _tmp_char; \ 689 /* We cast away const without the compiler knowing, any \ 690 * *genuinely* constant variables that aren't mutable \ 691 * wouldn't be constructed with top!=dmax. */ \ 692 BN_ULONG *_not_const; \ 693 memcpy(&_not_const, &_bnum1->d, sizeof(BN_ULONG*)); \ 694 RAND_pseudo_bytes(&_tmp_char, 1); \ 695 memset((unsigned char *)(_not_const + _bnum1->top), _tmp_char, \ 696 (_bnum1->dmax - _bnum1->top) * sizeof(BN_ULONG)); \ 697 } \ 698 } while(0) 699#ifdef BN_DEBUG_TRIX 700#undef RAND_pseudo_bytes 701#endif 702#else 703#define bn_pollute(a) 704#endif 705#define bn_check_top(a) \ 706 do { \ 707 const BIGNUM *_bnum2 = (a); \ 708 if (_bnum2 != NULL) { \ 709 assert((_bnum2->top == 0) || \ 710 (_bnum2->d[_bnum2->top - 1] != 0)); \ 711 bn_pollute(_bnum2); \ 712 } \ 713 } while(0) 714 715#define bn_fix_top(a) bn_check_top(a) 716 717#else /* !BN_DEBUG */ 718 719#define bn_pollute(a) 720#define bn_check_top(a) 721#define bn_fix_top(a) bn_correct_top(a) 722 723#endif 724 725#define bn_correct_top(a) \ 726 { \ 727 BN_ULONG *ftl; \ 728 if ((a)->top > 0) \ 729 { \ 730 for (ftl= &((a)->d[(a)->top-1]); (a)->top > 0; (a)->top--) \ 731 if (*(ftl--)) break; \ 732 } \ 733 bn_pollute(a); \ 734 } 735 736BN_ULONG bn_mul_add_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w); 737BN_ULONG bn_mul_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w); 738void bn_sqr_words(BN_ULONG *rp, const BN_ULONG *ap, int num); 739BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d); 740BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num); 741BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num); 742 743/* Primes from RFC 2409 */ 744BIGNUM *get_rfc2409_prime_768(BIGNUM *bn); 745BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn); 746 747/* Primes from RFC 3526 */ 748BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn); 749BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn); 750BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn); 751BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn); 752BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn); 753BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn); 754 755int BN_bntest_rand(BIGNUM *rnd, int bits, int top,int bottom); 756 757/* BEGIN ERROR CODES */ 758/* The following lines are auto generated by the script mkerr.pl. Any changes 759 * made after this point may be overwritten when the script is next run. 760 */ 761void ERR_load_BN_strings(void); 762 763/* Error codes for the BN functions. */ 764 765/* Function codes. */ 766#define BN_F_BNRAND 127 767#define BN_F_BN_BLINDING_CONVERT_EX 100 768#define BN_F_BN_BLINDING_CREATE_PARAM 128 769#define BN_F_BN_BLINDING_INVERT_EX 101 770#define BN_F_BN_BLINDING_NEW 102 771#define BN_F_BN_BLINDING_UPDATE 103 772#define BN_F_BN_BN2DEC 104 773#define BN_F_BN_BN2HEX 105 774#define BN_F_BN_CTX_GET 116 775#define BN_F_BN_CTX_NEW 106 776#define BN_F_BN_CTX_START 129 777#define BN_F_BN_DIV 107 778#define BN_F_BN_DIV_RECP 130 779#define BN_F_BN_EXP 123 780#define BN_F_BN_EXPAND2 108 781#define BN_F_BN_EXPAND_INTERNAL 120 782#define BN_F_BN_GF2M_MOD 131 783#define BN_F_BN_GF2M_MOD_EXP 132 784#define BN_F_BN_GF2M_MOD_MUL 133 785#define BN_F_BN_GF2M_MOD_SOLVE_QUAD 134 786#define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR 135 787#define BN_F_BN_GF2M_MOD_SQR 136 788#define BN_F_BN_GF2M_MOD_SQRT 137 789#define BN_F_BN_MOD_EXP2_MONT 118 790#define BN_F_BN_MOD_EXP_MONT 109 791#define BN_F_BN_MOD_EXP_MONT_CONSTTIME 124 792#define BN_F_BN_MOD_EXP_MONT_WORD 117 793#define BN_F_BN_MOD_EXP_RECP 125 794#define BN_F_BN_MOD_EXP_SIMPLE 126 795#define BN_F_BN_MOD_INVERSE 110 796#define BN_F_BN_MOD_LSHIFT_QUICK 119 797#define BN_F_BN_MOD_MUL_RECIPROCAL 111 798#define BN_F_BN_MOD_SQRT 121 799#define BN_F_BN_MPI2BN 112 800#define BN_F_BN_NEW 113 801#define BN_F_BN_RAND 114 802#define BN_F_BN_RAND_RANGE 122 803#define BN_F_BN_USUB 115 804 805/* Reason codes. */ 806#define BN_R_ARG2_LT_ARG3 100 807#define BN_R_BAD_RECIPROCAL 101 808#define BN_R_BIGNUM_TOO_LONG 114 809#define BN_R_CALLED_WITH_EVEN_MODULUS 102 810#define BN_R_DIV_BY_ZERO 103 811#define BN_R_ENCODING_ERROR 104 812#define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA 105 813#define BN_R_INPUT_NOT_REDUCED 110 814#define BN_R_INVALID_LENGTH 106 815#define BN_R_INVALID_RANGE 115 816#define BN_R_NOT_A_SQUARE 111 817#define BN_R_NOT_INITIALIZED 107 818#define BN_R_NO_INVERSE 108 819#define BN_R_NO_SOLUTION 116 820#define BN_R_P_IS_NOT_PRIME 112 821#define BN_R_TOO_MANY_ITERATIONS 113 822#define BN_R_TOO_MANY_TEMPORARY_VARIABLES 109 823 824#ifdef __cplusplus 825} 826#endif 827#endif 828