bn.h revision 55714
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#ifndef HEADER_BN_H 60#define HEADER_BN_H 61 62#ifndef WIN16 63#include <stdio.h> /* FILE */ 64#endif 65#include <openssl/opensslconf.h> 66 67#ifdef __cplusplus 68extern "C" { 69#endif 70 71#ifdef VMS 72#undef BN_LLONG /* experimental, so far... */ 73#endif 74 75#define BN_MUL_COMBA 76#define BN_SQR_COMBA 77#define BN_RECURSION 78#define RECP_MUL_MOD 79#define MONT_MUL_MOD 80 81/* This next option uses the C libraries (2 word)/(1 word) function. 82 * If it is not defined, I use my C version (which is slower). 83 * The reason for this flag is that when the particular C compiler 84 * library routine is used, and the library is linked with a different 85 * compiler, the library is missing. This mostly happens when the 86 * library is built with gcc and then linked using nornal cc. This would 87 * be a common occurance because gcc normally produces code that is 88 * 2 times faster than system compilers for the big number stuff. 89 * For machines with only one compiler (or shared libraries), this should 90 * be on. Again this in only really a problem on machines 91 * using "long long's", are 32bit, and are not using my assember code. */ 92#if defined(MSDOS) || defined(WINDOWS) || defined(linux) 93#define BN_DIV2W 94#endif 95 96/* assuming long is 64bit - this is the DEC Alpha 97 * unsigned long long is only 64 bits :-(, don't define 98 * BN_LLONG for the DEC Alpha */ 99#ifdef SIXTY_FOUR_BIT_LONG 100#define BN_ULLONG unsigned long long 101#define BN_ULONG unsigned long 102#define BN_LONG long 103#define BN_BITS 128 104#define BN_BYTES 8 105#define BN_BITS2 64 106#define BN_BITS4 32 107#define BN_MASK (0xffffffffffffffffffffffffffffffffLL) 108#define BN_MASK2 (0xffffffffffffffffL) 109#define BN_MASK2l (0xffffffffL) 110#define BN_MASK2h (0xffffffff00000000L) 111#define BN_MASK2h1 (0xffffffff80000000L) 112#define BN_TBIT (0x8000000000000000L) 113#define BN_DEC_CONV (10000000000000000000UL) 114#define BN_DEC_FMT1 "%lu" 115#define BN_DEC_FMT2 "%019lu" 116#define BN_DEC_NUM 19 117#endif 118 119/* This is where the long long data type is 64 bits, but long is 32. 120 * For machines where there are 64bit registers, this is the mode to use. 121 * IRIX, on R4000 and above should use this mode, along with the relevent 122 * assember code :-). Do NOT define BN_LLONG. 123 */ 124#ifdef SIXTY_FOUR_BIT 125#undef BN_LLONG 126#undef BN_ULLONG 127#define BN_ULONG unsigned long long 128#define BN_LONG long long 129#define BN_BITS 128 130#define BN_BYTES 8 131#define BN_BITS2 64 132#define BN_BITS4 32 133#define BN_MASK2 (0xffffffffffffffffLL) 134#define BN_MASK2l (0xffffffffL) 135#define BN_MASK2h (0xffffffff00000000LL) 136#define BN_MASK2h1 (0xffffffff80000000LL) 137#define BN_TBIT (0x8000000000000000LL) 138#define BN_DEC_CONV (10000000000000000000LL) 139#define BN_DEC_FMT1 "%llu" 140#define BN_DEC_FMT2 "%019llu" 141#define BN_DEC_NUM 19 142#endif 143 144#ifdef THIRTY_TWO_BIT 145#if defined(WIN32) && !defined(__GNUC__) 146#define BN_ULLONG unsigned _int64 147#else 148#define BN_ULLONG unsigned long long 149#endif 150#define BN_ULONG unsigned long 151#define BN_LONG long 152#define BN_BITS 64 153#define BN_BYTES 4 154#define BN_BITS2 32 155#define BN_BITS4 16 156#ifdef WIN32 157/* VC++ doesn't like the LL suffix */ 158#define BN_MASK (0xffffffffffffffffL) 159#else 160#define BN_MASK (0xffffffffffffffffLL) 161#endif 162#define BN_MASK2 (0xffffffffL) 163#define BN_MASK2l (0xffff) 164#define BN_MASK2h1 (0xffff8000L) 165#define BN_MASK2h (0xffff0000L) 166#define BN_TBIT (0x80000000L) 167#define BN_DEC_CONV (1000000000L) 168#define BN_DEC_FMT1 "%lu" 169#define BN_DEC_FMT2 "%09lu" 170#define BN_DEC_NUM 9 171#endif 172 173#ifdef SIXTEEN_BIT 174#ifndef BN_DIV2W 175#define BN_DIV2W 176#endif 177#define BN_ULLONG unsigned long 178#define BN_ULONG unsigned short 179#define BN_LONG short 180#define BN_BITS 32 181#define BN_BYTES 2 182#define BN_BITS2 16 183#define BN_BITS4 8 184#define BN_MASK (0xffffffff) 185#define BN_MASK2 (0xffff) 186#define BN_MASK2l (0xff) 187#define BN_MASK2h1 (0xff80) 188#define BN_MASK2h (0xff00) 189#define BN_TBIT (0x8000) 190#define BN_DEC_CONV (100000) 191#define BN_DEC_FMT1 "%u" 192#define BN_DEC_FMT2 "%05u" 193#define BN_DEC_NUM 5 194#endif 195 196#ifdef EIGHT_BIT 197#ifndef BN_DIV2W 198#define BN_DIV2W 199#endif 200#define BN_ULLONG unsigned short 201#define BN_ULONG unsigned char 202#define BN_LONG char 203#define BN_BITS 16 204#define BN_BYTES 1 205#define BN_BITS2 8 206#define BN_BITS4 4 207#define BN_MASK (0xffff) 208#define BN_MASK2 (0xff) 209#define BN_MASK2l (0xf) 210#define BN_MASK2h1 (0xf8) 211#define BN_MASK2h (0xf0) 212#define BN_TBIT (0x80) 213#define BN_DEC_CONV (100) 214#define BN_DEC_FMT1 "%u" 215#define BN_DEC_FMT2 "%02u" 216#define BN_DEC_NUM 2 217#endif 218 219#define BN_DEFAULT_BITS 1280 220 221#ifdef BIGNUM 222#undef BIGNUM 223#endif 224 225#define BN_FLG_MALLOCED 0x01 226#define BN_FLG_STATIC_DATA 0x02 227#define BN_FLG_FREE 0x8000 /* used for debuging */ 228#define BN_set_flags(b,n) ((b)->flags|=(n)) 229#define BN_get_flags(b,n) ((b)->flags&(n)) 230 231typedef struct bignum_st 232 { 233 BN_ULONG *d; /* Pointer to an array of 'BN_BITS2' bit chunks. */ 234 int top; /* Index of last used d +1. */ 235 /* The next are internal book keeping for bn_expand. */ 236 int max; /* Size of the d array. */ 237 int neg; /* one if the number is negative */ 238 int flags; 239 } BIGNUM; 240 241/* Used for temp variables */ 242#define BN_CTX_NUM 12 243typedef struct bignum_ctx 244 { 245 int tos; 246 BIGNUM bn[BN_CTX_NUM+1]; 247 int flags; 248 } BN_CTX; 249 250typedef struct bn_blinding_st 251 { 252 int init; 253 BIGNUM *A; 254 BIGNUM *Ai; 255 BIGNUM *mod; /* just a reference */ 256 } BN_BLINDING; 257 258/* Used for montgomery multiplication */ 259typedef struct bn_mont_ctx_st 260 { 261 int use_word; /* 0 for word form, 1 for long form */ 262 int ri; /* number of bits in R */ 263 BIGNUM RR; /* used to convert to montgomery form */ 264 BIGNUM N; /* The modulus */ 265 BIGNUM Ni; /* The inverse of N */ 266 BN_ULONG n0; /* word form of inverse, normally only one of 267 * Ni or n0 is defined */ 268 int flags; 269 } BN_MONT_CTX; 270 271/* Used for reciprocal division/mod functions 272 * It cannot be shared between threads 273 */ 274typedef struct bn_recp_ctx_st 275 { 276 BIGNUM N; /* the divisor */ 277 BIGNUM Nr; /* the reciprocal */ 278 int num_bits; 279 int shift; 280 int flags; 281 } BN_RECP_CTX; 282 283#define BN_to_montgomery(r,a,mont,ctx) BN_mod_mul_montgomery(\ 284 r,a,&((mont)->RR),(mont),ctx) 285 286#define BN_prime_checks (5) 287 288#define BN_num_bytes(a) ((BN_num_bits(a)+7)/8) 289#define BN_is_word(a,w) (((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w))) 290#define BN_is_zero(a) (((a)->top == 0) || BN_is_word(a,0)) 291#define BN_is_one(a) (BN_is_word((a),1)) 292#define BN_is_odd(a) (((a)->top > 0) && ((a)->d[0] & 1)) 293#define BN_one(a) (BN_set_word((a),1)) 294#define BN_zero(a) (BN_set_word((a),0)) 295 296/*#define BN_ascii2bn(a) BN_hex2bn(a) */ 297/*#define BN_bn2ascii(a) BN_bn2hex(a) */ 298 299#define bn_expand(n,b) ((((((b+BN_BITS2-1))/BN_BITS2)) <= (n)->max)?\ 300 (n):bn_expand2((n),(b)/BN_BITS2+1)) 301#define bn_wexpand(n,b) (((b) <= (n)->max)?(n):bn_expand2((n),(b))) 302 303#define bn_fix_top(a) \ 304 { \ 305 BN_ULONG *ftl; \ 306 if ((a)->top > 0) \ 307 { \ 308 for (ftl= &((a)->d[(a)->top-1]); (a)->top > 0; (a)->top--) \ 309 if (*(ftl--)) break; \ 310 } \ 311 } 312 313BIGNUM *BN_value_one(void); 314char * BN_options(void); 315BN_CTX *BN_CTX_new(void); 316void BN_CTX_init(BN_CTX *c); 317void BN_CTX_free(BN_CTX *c); 318int BN_rand(BIGNUM *rnd, int bits, int top,int bottom); 319int BN_num_bits(const BIGNUM *a); 320int BN_num_bits_word(BN_ULONG); 321BIGNUM *BN_new(void); 322void BN_init(BIGNUM *); 323void BN_clear_free(BIGNUM *a); 324BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b); 325BIGNUM *BN_bin2bn(const unsigned char *s,int len,BIGNUM *ret); 326int BN_bn2bin(const BIGNUM *a, unsigned char *to); 327BIGNUM *BN_mpi2bn(unsigned char *s,int len,BIGNUM *ret); 328int BN_bn2mpi(const BIGNUM *a, unsigned char *to); 329int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 330int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 331int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); 332int BN_add(BIGNUM *r, BIGNUM *a, BIGNUM *b); 333int BN_mod(BIGNUM *rem, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx); 334int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d, 335 BN_CTX *ctx); 336int BN_mul(BIGNUM *r, BIGNUM *a, BIGNUM *b,BN_CTX *ctx); 337int BN_sqr(BIGNUM *r, BIGNUM *a,BN_CTX *ctx); 338BN_ULONG BN_mod_word(BIGNUM *a, BN_ULONG w); 339BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w); 340int BN_mul_word(BIGNUM *a, BN_ULONG w); 341int BN_add_word(BIGNUM *a, BN_ULONG w); 342int BN_sub_word(BIGNUM *a, BN_ULONG w); 343int BN_set_word(BIGNUM *a, BN_ULONG w); 344BN_ULONG BN_get_word(BIGNUM *a); 345int BN_cmp(const BIGNUM *a, const BIGNUM *b); 346void BN_free(BIGNUM *a); 347int BN_is_bit_set(const BIGNUM *a, int n); 348int BN_lshift(BIGNUM *r, const BIGNUM *a, int n); 349int BN_lshift1(BIGNUM *r, BIGNUM *a); 350int BN_exp(BIGNUM *r, BIGNUM *a, BIGNUM *p,BN_CTX *ctx); 351int BN_mod_exp(BIGNUM *r, BIGNUM *a, const BIGNUM *p, 352 const BIGNUM *m,BN_CTX *ctx); 353int BN_mod_exp_mont(BIGNUM *r, BIGNUM *a, const BIGNUM *p, 354 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); 355int BN_mod_exp2_mont(BIGNUM *r, BIGNUM *a1, BIGNUM *p1,BIGNUM *a2, 356 BIGNUM *p2,BIGNUM *m,BN_CTX *ctx,BN_MONT_CTX *m_ctx); 357int BN_mod_exp_simple(BIGNUM *r, BIGNUM *a, BIGNUM *p, 358 BIGNUM *m,BN_CTX *ctx); 359int BN_mask_bits(BIGNUM *a,int n); 360int BN_mod_mul(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m, BN_CTX *ctx); 361#ifndef WIN16 362int BN_print_fp(FILE *fp, BIGNUM *a); 363#endif 364#ifdef HEADER_BIO_H 365int BN_print(BIO *fp, const BIGNUM *a); 366#else 367int BN_print(char *fp, const BIGNUM *a); 368#endif 369int BN_reciprocal(BIGNUM *r, BIGNUM *m, int len, BN_CTX *ctx); 370int BN_rshift(BIGNUM *r, BIGNUM *a, int n); 371int BN_rshift1(BIGNUM *r, BIGNUM *a); 372void BN_clear(BIGNUM *a); 373BIGNUM *bn_expand2(BIGNUM *b, int bits); 374BIGNUM *BN_dup(const BIGNUM *a); 375int BN_ucmp(const BIGNUM *a, const BIGNUM *b); 376int BN_set_bit(BIGNUM *a, int n); 377int BN_clear_bit(BIGNUM *a, int n); 378char * BN_bn2hex(const BIGNUM *a); 379char * BN_bn2dec(const BIGNUM *a); 380int BN_hex2bn(BIGNUM **a, const char *str); 381int BN_dec2bn(BIGNUM **a, const char *str); 382int BN_gcd(BIGNUM *r,BIGNUM *in_a,BIGNUM *in_b,BN_CTX *ctx); 383BIGNUM *BN_mod_inverse(BIGNUM *ret,BIGNUM *a, const BIGNUM *n,BN_CTX *ctx); 384BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int strong,BIGNUM *add, 385 BIGNUM *rem,void (*callback)(int,int,void *),void *cb_arg); 386int BN_is_prime(BIGNUM *p,int nchecks,void (*callback)(int,int,void *), 387 BN_CTX *ctx,void *cb_arg); 388void ERR_load_BN_strings(void ); 389 390BN_ULONG bn_mul_add_words(BN_ULONG *rp, BN_ULONG *ap, int num, BN_ULONG w); 391BN_ULONG bn_mul_words(BN_ULONG *rp, BN_ULONG *ap, int num, BN_ULONG w); 392void bn_sqr_words(BN_ULONG *rp, BN_ULONG *ap, int num); 393BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d); 394BN_ULONG bn_add_words(BN_ULONG *rp, BN_ULONG *ap, BN_ULONG *bp,int num); 395BN_ULONG bn_sub_words(BN_ULONG *rp, BN_ULONG *ap, BN_ULONG *bp,int num); 396 397BN_MONT_CTX *BN_MONT_CTX_new(void ); 398void BN_MONT_CTX_init(BN_MONT_CTX *ctx); 399int BN_mod_mul_montgomery(BIGNUM *r,BIGNUM *a,BIGNUM *b,BN_MONT_CTX *mont, 400 BN_CTX *ctx); 401int BN_from_montgomery(BIGNUM *r,BIGNUM *a,BN_MONT_CTX *mont,BN_CTX *ctx); 402void BN_MONT_CTX_free(BN_MONT_CTX *mont); 403int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *modulus,BN_CTX *ctx); 404BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from); 405 406BN_BLINDING *BN_BLINDING_new(BIGNUM *A,BIGNUM *Ai,BIGNUM *mod); 407void BN_BLINDING_free(BN_BLINDING *b); 408int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx); 409int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *r, BN_CTX *ctx); 410int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx); 411 412void BN_set_params(int mul,int high,int low,int mont); 413int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */ 414 415void BN_RECP_CTX_init(BN_RECP_CTX *recp); 416BN_RECP_CTX *BN_RECP_CTX_new(void); 417void BN_RECP_CTX_free(BN_RECP_CTX *recp); 418int BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx); 419int BN_mod_mul_reciprocal(BIGNUM *r, BIGNUM *x, BIGNUM *y, 420 BN_RECP_CTX *recp,BN_CTX *ctx); 421int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, 422 const BIGNUM *m, BN_CTX *ctx); 423int BN_div_recp(BIGNUM *dv, BIGNUM *rem, BIGNUM *m, 424 BN_RECP_CTX *recp, BN_CTX *ctx); 425 426 427/* BEGIN ERROR CODES */ 428/* The following lines are auto generated by the script mkerr.pl. Any changes 429 * made after this point may be overwritten when the script is next run. 430 */ 431 432/* Error codes for the BN functions. */ 433 434/* Function codes. */ 435#define BN_F_BN_BLINDING_CONVERT 100 436#define BN_F_BN_BLINDING_INVERT 101 437#define BN_F_BN_BLINDING_NEW 102 438#define BN_F_BN_BLINDING_UPDATE 103 439#define BN_F_BN_BN2DEC 104 440#define BN_F_BN_BN2HEX 105 441#define BN_F_BN_CTX_NEW 106 442#define BN_F_BN_DIV 107 443#define BN_F_BN_EXPAND2 108 444#define BN_F_BN_MOD_EXP_MONT 109 445#define BN_F_BN_MOD_INVERSE 110 446#define BN_F_BN_MOD_MUL_RECIPROCAL 111 447#define BN_F_BN_MPI2BN 112 448#define BN_F_BN_NEW 113 449#define BN_F_BN_RAND 114 450#define BN_F_BN_USUB 115 451 452/* Reason codes. */ 453#define BN_R_ARG2_LT_ARG3 100 454#define BN_R_BAD_RECIPROCAL 101 455#define BN_R_CALLED_WITH_EVEN_MODULUS 102 456#define BN_R_DIV_BY_ZERO 103 457#define BN_R_ENCODING_ERROR 104 458#define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA 105 459#define BN_R_INVALID_LENGTH 106 460#define BN_R_NOT_INITIALIZED 107 461#define BN_R_NO_INVERSE 108 462 463#ifdef __cplusplus 464} 465#endif 466#endif 467 468