integer.h

00001 /* integer.h
00002  *
00003  * Copyright (C) 2006-2012 Sawtooth Consulting Ltd.
00004  *
00005  * This file is part of CyaSSL.
00006  *
00007  * CyaSSL is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 2 of the License, or
00010  * (at your option) any later version.
00011  *
00012  * CyaSSL is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with this program; if not, write to the Free Software
00019  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
00020  */
00021 
00022 /*
00023  * Based on public domain LibTomMath 0.38 by Tom St Denis, tomstdenis@iahu.ca,
00024  * http://math.libtomcrypt.com
00025  */
00026 
00027 
00028 #ifndef CTAO_CRYPT_INTEGER_H
00029 #define CTAO_CRYPT_INTEGER_H
00030 
00031 /* may optionally use fast math instead, not yet supported on all platforms and
00032    may not be faster on all
00033 */
00034 #include <cyassl/ctaocrypt/types.h>       /* will set MP_xxBIT if not default */
00035 #ifdef USE_FAST_MATH
00036     #include <cyassl/ctaocrypt/tfm.h>
00037 #else
00038 
00039 #ifndef CHAR_BIT
00040     #include <limits.h>
00041 #endif
00042 
00043 #include <cyassl/ctaocrypt/mpi_class.h>
00044 
00045 #ifndef MIN
00046    #define MIN(x,y) ((x)<(y)?(x):(y))
00047 #endif
00048 
00049 #ifndef MAX
00050    #define MAX(x,y) ((x)>(y)?(x):(y))
00051 #endif
00052 
00053 #ifdef __cplusplus
00054 extern "C" {
00055 
00056 /* C++ compilers don't like assigning void * to mp_digit * */
00057 #define  OPT_CAST(x)  (x *)
00058 
00059 #else
00060 
00061 /* C on the other hand doesn't care */
00062 #define  OPT_CAST(x)
00063 
00064 #endif
00065 
00066 
00067 /* detect 64-bit mode if possible */
00068 #if defined(__x86_64__) 
00069    #if !(defined(MP_64BIT) && defined(MP_16BIT) && defined(MP_8BIT))
00070       #define MP_64BIT
00071    #endif
00072 #endif
00073 
00074 /* some default configurations.
00075  *
00076  * A "mp_digit" must be able to hold DIGIT_BIT + 1 bits
00077  * A "mp_word" must be able to hold 2*DIGIT_BIT + 1 bits
00078  *
00079  * At the very least a mp_digit must be able to hold 7 bits
00080  * [any size beyond that is ok provided it doesn't overflow the data type]
00081  */
00082 #ifdef MP_8BIT
00083    typedef unsigned char      mp_digit;
00084    typedef unsigned short     mp_word;
00085 #elif defined(MP_16BIT)
00086    typedef unsigned short     mp_digit;
00087    typedef unsigned long      mp_word;
00088 #elif defined(MP_64BIT)
00089    /* for GCC only on supported platforms */
00090 #ifndef CRYPT
00091    typedef unsigned long long ulong64;
00092    typedef signed long long   long64;
00093 #endif
00094 
00095    typedef unsigned long      mp_digit;
00096    typedef unsigned long      mp_word __attribute__ ((mode(TI)));
00097 
00098    #define DIGIT_BIT          60
00099 #else
00100    /* this is the default case, 28-bit digits */
00101    
00102    /* this is to make porting into LibTomCrypt easier :-) */
00103 #ifndef CRYPT
00104    #if defined(_MSC_VER) || defined(__BORLANDC__) 
00105       typedef unsigned __int64   ulong64;
00106       typedef signed __int64     long64;
00107    #else
00108       typedef unsigned long long ulong64;
00109       typedef signed long long   long64;
00110    #endif
00111 #endif
00112 
00113    typedef unsigned int       mp_digit;  /* long could be 64 now, changed TAO */
00114    typedef ulong64            mp_word;
00115 
00116 #ifdef MP_31BIT   
00117    /* this is an extension that uses 31-bit digits */
00118    #define DIGIT_BIT          31
00119 #else
00120    /* default case is 28-bit digits, defines MP_28BIT as a handy test macro */
00121    #define DIGIT_BIT          28
00122    #define MP_28BIT
00123 #endif   
00124 #endif
00125 
00126 
00127 /* otherwise the bits per digit is calculated automatically from the size of
00128    a mp_digit */
00129 #ifndef DIGIT_BIT
00130    #define DIGIT_BIT ((int)((CHAR_BIT * sizeof(mp_digit) - 1)))
00131       /* bits per digit */
00132 #endif
00133 
00134 #define MP_DIGIT_BIT     DIGIT_BIT
00135 #define MP_MASK          ((((mp_digit)1)<<((mp_digit)DIGIT_BIT))-((mp_digit)1))
00136 #define MP_DIGIT_MAX     MP_MASK
00137 
00138 /* equalities */
00139 #define MP_LT        -1   /* less than */
00140 #define MP_EQ         0   /* equal to */
00141 #define MP_GT         1   /* greater than */
00142 
00143 #define MP_ZPOS       0   /* positive integer */
00144 #define MP_NEG        1   /* negative */
00145 
00146 #define MP_OKAY       0   /* ok result */
00147 #define MP_MEM        -2  /* out of mem */
00148 #define MP_VAL        -3  /* invalid input */
00149 #define MP_RANGE      MP_VAL
00150 
00151 #define MP_YES        1   /* yes response */
00152 #define MP_NO         0   /* no response */
00153 
00154 /* Primality generation flags */
00155 #define LTM_PRIME_BBS      0x0001 /* BBS style prime */
00156 #define LTM_PRIME_SAFE     0x0002 /* Safe prime (p-1)/2 == prime */
00157 #define LTM_PRIME_2MSB_ON  0x0008 /* force 2nd MSB to 1 */
00158 
00159 typedef int           mp_err;
00160 
00161 /* define this to use lower memory usage routines (exptmods mostly) */
00162 #define MP_LOW_MEM
00163 
00164 /* default precision */
00165 #ifndef MP_PREC
00166    #ifndef MP_LOW_MEM
00167       #define MP_PREC                 32     /* default digits of precision */
00168    #else
00169       #define MP_PREC                 1      /* default digits of precision */
00170    #endif   
00171 #endif
00172 
00173 /* size of comba arrays, should be at least 2 * 2**(BITS_PER_WORD - 
00174    BITS_PER_DIGIT*2) */
00175 #define MP_WARRAY  (1 << (sizeof(mp_word) * CHAR_BIT - 2 * DIGIT_BIT + 1))
00176 
00177 /* the infamous mp_int structure */
00178 typedef struct  {
00179     int used, alloc, sign;
00180     mp_digit *dp;
00181 } mp_int;
00182 
00183 /* callback for mp_prime_random, should fill dst with random bytes and return
00184    how many read [upto len] */
00185 typedef int ltm_prime_callback(unsigned char *dst, int len, void *dat);
00186 
00187 
00188 #define USED(m)    ((m)->used)
00189 #define DIGIT(m,k) ((m)->dp[(k)])
00190 #define SIGN(m)    ((m)->sign)
00191 
00192 
00193 /* ---> Basic Manipulations <--- */
00194 #define mp_iszero(a) (((a)->used == 0) ? MP_YES : MP_NO)
00195 #define mp_iseven(a) \
00196     (((a)->used > 0 && (((a)->dp[0] & 1) == 0)) ? MP_YES : MP_NO)
00197 #define mp_isodd(a) \
00198     (((a)->used > 0 && (((a)->dp[0] & 1) == 1)) ? MP_YES : MP_NO)
00199 
00200 
00201 /* number of primes */
00202 #ifdef MP_8BIT
00203    #define PRIME_SIZE      31
00204 #else
00205    #define PRIME_SIZE      256
00206 #endif
00207 
00208 #define mp_prime_random(a, t, size, bbs, cb, dat) \
00209    mp_prime_random_ex(a, t, ((size) * 8) + 1, (bbs==1)?LTM_PRIME_BBS:0, cb, dat)
00210 
00211 #define mp_read_raw(mp, str, len) mp_read_signed_bin((mp), (str), (len))
00212 #define mp_raw_size(mp)           mp_signed_bin_size(mp)
00213 #define mp_toraw(mp, str)         mp_to_signed_bin((mp), (str))
00214 #define mp_read_mag(mp, str, len) mp_read_unsigned_bin((mp), (str), (len))
00215 #define mp_mag_size(mp)           mp_unsigned_bin_size(mp)
00216 #define mp_tomag(mp, str)         mp_to_unsigned_bin((mp), (str))
00217 
00218 #define mp_tobinary(M, S)  mp_toradix((M), (S), 2)
00219 #define mp_tooctal(M, S)   mp_toradix((M), (S), 8)
00220 #define mp_todecimal(M, S) mp_toradix((M), (S), 10)
00221 #define mp_tohex(M, S)     mp_toradix((M), (S), 16)
00222 
00223 #define s_mp_mul(a, b, c) s_mp_mul_digs(a, b, c, (a)->used + (b)->used + 1)
00224 
00225 extern const char *mp_s_rmap;
00226 
00227 /* 6 functions needed by Rsa */
00228 int  mp_init (mp_int * a);
00229 void mp_clear (mp_int * a);
00230 int  mp_unsigned_bin_size(mp_int * a);
00231 int  mp_read_unsigned_bin (mp_int * a, const unsigned char *b, int c);
00232 int  mp_to_unsigned_bin (mp_int * a, unsigned char *b);
00233 int  mp_exptmod (mp_int * G, mp_int * X, mp_int * P, mp_int * Y);
00234 /* end functions needed by Rsa */
00235 
00236 /* functions added to support above needed, removed TOOM and KARATSUBA */
00237 int  mp_count_bits (mp_int * a);
00238 int  mp_init_copy (mp_int * a, mp_int * b);
00239 int  mp_copy (mp_int * a, mp_int * b);
00240 int  mp_grow (mp_int * a, int size);
00241 void bn_reverse (unsigned char *s, int len);
00242 int  mp_div_2d (mp_int * a, int b, mp_int * c, mp_int * d);
00243 void mp_zero (mp_int * a);
00244 void mp_clamp (mp_int * a);
00245 void mp_exch (mp_int * a, mp_int * b);
00246 void mp_rshd (mp_int * a, int b);
00247 int  mp_mod_2d (mp_int * a, int b, mp_int * c);
00248 int  mp_mul_2d (mp_int * a, int b, mp_int * c);
00249 int  mp_lshd (mp_int * a, int b);
00250 int  mp_abs (mp_int * a, mp_int * b);
00251 int  mp_invmod (mp_int * a, mp_int * b, mp_int * c);
00252 int  fast_mp_invmod (mp_int * a, mp_int * b, mp_int * c);
00253 int  mp_invmod_slow (mp_int * a, mp_int * b, mp_int * c);
00254 int  mp_cmp_mag (mp_int * a, mp_int * b);
00255 int  mp_cmp (mp_int * a, mp_int * b);
00256 int  mp_cmp_d(mp_int * a, mp_digit b);
00257 void mp_set (mp_int * a, mp_digit b);
00258 int  mp_mod (mp_int * a, mp_int * b, mp_int * c);
00259 int  mp_div(mp_int * a, mp_int * b, mp_int * c, mp_int * d);
00260 int  mp_div_2(mp_int * a, mp_int * b);
00261 int  mp_add (mp_int * a, mp_int * b, mp_int * c);
00262 int  s_mp_add (mp_int * a, mp_int * b, mp_int * c);
00263 int  s_mp_sub (mp_int * a, mp_int * b, mp_int * c);
00264 int  mp_sub (mp_int * a, mp_int * b, mp_int * c);
00265 int  mp_reduce_is_2k_l(mp_int *a);
00266 int  mp_reduce_is_2k(mp_int *a);
00267 int  mp_dr_is_modulus(mp_int *a);
00268 int  mp_exptmod_fast (mp_int * G, mp_int * X, mp_int * P, mp_int * Y, int);
00269 int  mp_montgomery_setup (mp_int * n, mp_digit * rho);
00270 int  fast_mp_montgomery_reduce (mp_int * x, mp_int * n, mp_digit rho);
00271 int  mp_montgomery_reduce (mp_int * x, mp_int * n, mp_digit rho);
00272 void mp_dr_setup(mp_int *a, mp_digit *d);
00273 int  mp_dr_reduce (mp_int * x, mp_int * n, mp_digit k);
00274 int  mp_reduce_2k(mp_int *a, mp_int *n, mp_digit d);
00275 int  fast_s_mp_mul_high_digs (mp_int * a, mp_int * b, mp_int * c, int digs);
00276 int  s_mp_mul_high_digs (mp_int * a, mp_int * b, mp_int * c, int digs);
00277 int  mp_reduce_2k_setup_l(mp_int *a, mp_int *d);
00278 int  mp_reduce_2k_l(mp_int *a, mp_int *n, mp_int *d);
00279 int  mp_reduce (mp_int * x, mp_int * m, mp_int * mu);
00280 int  mp_reduce_setup (mp_int * a, mp_int * b);
00281 int  s_mp_exptmod (mp_int * G, mp_int * X, mp_int * P, mp_int * Y, int redmode);
00282 int  mp_montgomery_calc_normalization (mp_int * a, mp_int * b);
00283 int  s_mp_mul_digs (mp_int * a, mp_int * b, mp_int * c, int digs);
00284 int  s_mp_sqr (mp_int * a, mp_int * b);
00285 int  fast_s_mp_mul_digs (mp_int * a, mp_int * b, mp_int * c, int digs);
00286 int  fast_s_mp_sqr (mp_int * a, mp_int * b);
00287 int  mp_init_size (mp_int * a, int size);
00288 int  mp_div_3 (mp_int * a, mp_int *c, mp_digit * d);
00289 int  mp_mul_2(mp_int * a, mp_int * b);
00290 int  mp_mul (mp_int * a, mp_int * b, mp_int * c);
00291 int  mp_sqr (mp_int * a, mp_int * b);
00292 int  mp_mulmod (mp_int * a, mp_int * b, mp_int * c, mp_int * d);
00293 int  mp_mul_d (mp_int * a, mp_digit b, mp_int * c);
00294 int  mp_2expt (mp_int * a, int b);
00295 int  mp_reduce_2k_setup(mp_int *a, mp_digit *d);
00296 int  mp_add_d (mp_int* a, mp_digit b, mp_int* c);
00297 int mp_set_int (mp_int * a, unsigned long b);
00298 /* end support added functions */
00299 
00300 /* added */
00301 int mp_init_multi(mp_int* a, mp_int* b, mp_int* c, mp_int* d, mp_int* e,
00302                   mp_int* f);
00303 
00304 #if defined(HAVE_ECC) || defined(CYASSL_KEY_GEN)
00305     int mp_sqrmod(mp_int* a, mp_int* b, mp_int* c);
00306 #endif
00307 #ifdef HAVE_ECC
00308     int mp_read_radix(mp_int* a, const char* str, int radix);
00309 #endif
00310 
00311 #ifdef CYASSL_KEY_GEN
00312     int mp_prime_is_prime (mp_int * a, int t, int *result);
00313     int mp_gcd (mp_int * a, mp_int * b, mp_int * c);
00314     int mp_lcm (mp_int * a, mp_int * b, mp_int * c);
00315 #endif
00316 
00317 #if defined(CYASSL_KEY_GEN) || defined(HAVE_ECC) || !defined(NO_PWDBASED)
00318     int mp_sub_d (mp_int * a, mp_digit b, mp_int * c);
00319 #endif
00320 
00321 #ifdef __cplusplus
00322    }
00323 #endif
00324 
00325 
00326 #endif /* USE_FAST_MATH */
00327 
00328 #endif  /* CTAO_CRYPT_INTEGER_H */
00329