X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcmath%2Fsilcmp.h;h=662de1720c0072cbfa3f64ff6f623a1c004081d3;hb=e7b6c157b80152bf9fb9266e6bdd93f9fb0db776;hp=2fb53dec6ef09b23edb0a5a1a05d5802e65f1e90;hpb=e8f38158d84bf0d6edc0c59e5fb936bda6f54a2b;p=silc.git diff --git a/lib/silcmath/silcmp.h b/lib/silcmath/silcmp.h index 2fb53dec..662de172 100644 --- a/lib/silcmath/silcmp.h +++ b/lib/silcmath/silcmp.h @@ -1,43 +1,46 @@ /* silcmp.h - + Author: Pekka Riikonen - - Copyright (C) 1997 - 2001 Pekka Riikonen - + + Copyright (C) 1997 - 2007 Pekka Riikonen + This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - + the Free Software Foundation; version 2 of the License. + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - + */ -/****h* silcmath/SilcMPAPI +/****h* silcmath/SILC MP Interface * * DESCRIPTION * * SILC MP Library Interface. This interface defines the arbitrary - * precision arithmetic routines for SILC. Currently the actual routines - * are implemented separately, usually by some other MP library. The - * interface is generic but is mainly intended for crypto usage. This - * interface is used by SILC routines that needs big numbers, such as - * RSA implementation, Diffie-Hellman implementation etc. + * precision arithmetic routines for SILC. The interface is generic but + * is mainly intended for crypto usage. This interface is used by SILC + * routines that needs big numbers, such as RSA implementation, + * Diffie-Hellman implementation etc. * ***/ #ifndef SILCMP_H #define SILCMP_H -#ifdef SILC_MP_GMP +#if defined(SILC_MP_GMP) #include "mp_gmp.h" /* SILC_MP_GMP */ #else -#include "mp_mpi.h" /* SILC_MP_NSS_MPI */ +#ifdef SILC_DIST_TMA +#include "mp_tma.h" +#endif /* SILC_DIST_TMA */ +#ifdef SILC_DIST_TFM +#include "mp_tfm.h" +#endif /* SILC_DIST_TFM */ #endif /****d* silcmath/SilcMPAPI/SilcMPInt @@ -65,13 +68,30 @@ typedef SILC_MP_INT SilcMPInt; * * DESCRIPTION * - * Initializes the SilcMPInt *that is the actual MP Integer. + * Initializes the SilcMPInt that is the actual MP Integer. * This must be called before any of the silc_mp_ routines can be * used. The integer is uninitialized with the silc_mp_uninit function. * ***/ void silc_mp_init(SilcMPInt *mp); +/****f* silcmath/SilcMPAPI/silc_mp_sinit + * + * SYNOPSIS + * + * SilcBool silc_mp_sinit(SilcStack stack, SilcMPInt *mp); + * + * DESCRIPTION + * + * Initializes the SilcMPInt that is the actual MP Integer. + * This must be called before any of the silc_mp_ routines can be + * used. The integer is uninitialized with the silc_mp_suninit function. + * If `stack' is non-NULL it will be used as the memory source. If it + * is NULL, this call is equivalent to silc_mp_init. + * + ***/ +SilcBool silc_mp_sinit(SilcStack stack, SilcMPInt *mp); + /****f* silcmath/SilcMPAPI/silc_mp_uninit * * SYNOPSIS @@ -85,6 +105,19 @@ void silc_mp_init(SilcMPInt *mp); ***/ void silc_mp_uninit(SilcMPInt *mp); +/****f* silcmath/SilcMPAPI/silc_mp_suninit + * + * SYNOPSIS + * + * void silc_mp_suninit(SilcStack stack, SilcMPInt *mp); + * + * DESCRIPTION + * + * Uninitializes the MP Integer. + * + ***/ +void silc_mp_suninit(SilcStack stack, SilcMPInt *mp); + /****f* silcmath/SilcMPAPI/silc_mp_size * * SYNOPSIS @@ -106,10 +139,16 @@ size_t silc_mp_size(SilcMPInt *mp); * * DESCRIPTION * - * Return the size of the integer in base `base'. Note that this size - * is probably only an approximation. However, it is guaranteed that - * the returned size is always at least the size of the integer, however, - * it may be larger. + * Return the size of the integer in base `base'. + * + * NOTES + * + * For any other base but 2 this function usually returns only an + * approximated size in the base. It is however guaranteed that the + * the returned size is always at least the size of the integer or + * larger. + * + * For base 2 this returns the exact bit-size of the integer. * ***/ size_t silc_mp_sizeinbase(SilcMPInt *mp, int base); @@ -132,7 +171,7 @@ void silc_mp_set(SilcMPInt *dst, SilcMPInt *src); * * SYNOPSIS * - * void silc_mp_set_ui(SilcMPInt *dst, uint32 ui); + * void silc_mp_set_ui(SilcMPInt *dst, SilcUInt32 ui); * * DESCRIPTION * @@ -140,13 +179,13 @@ void silc_mp_set(SilcMPInt *dst, SilcMPInt *src); * initialized. * ***/ -void silc_mp_set_ui(SilcMPInt *dst, uint32 ui); +void silc_mp_set_ui(SilcMPInt *dst, SilcUInt32 ui); /****f* silcmath/SilcMPAPI/silc_mp_set_si * * SYNOPSIS * - * void silc_mp_set_si(SilcMPInt *dst, int32 si); + * void silc_mp_set_si(SilcMPInt *dst, SilcInt32 si); * * DESCRIPTION * @@ -154,7 +193,7 @@ void silc_mp_set_ui(SilcMPInt *dst, uint32 ui); * already be initialized. * ***/ -void silc_mp_set_si(SilcMPInt *dst, int32 si); +void silc_mp_set_si(SilcMPInt *dst, SilcInt32 si); /****f* silcmath/SilcMPAPI/silc_mp_set_str * @@ -167,6 +206,11 @@ void silc_mp_set_si(SilcMPInt *dst, int32 si); * Set `dst' integer from string `str' of base `base'. The `dst' must * already be initialized. * + * NOTES + * + * For base 2 the string must be in ASCII bit presentation, not in + * binary. Use the silc_mp_bin2mp to decode binary into integer. + * ***/ void silc_mp_set_str(SilcMPInt *dst, const char *str, int base); @@ -174,14 +218,14 @@ void silc_mp_set_str(SilcMPInt *dst, const char *str, int base); * * SYNOPSIS * - * uint32 silc_mp_get_ui(SilcMPInt *mp); + * SilcUInt32 silc_mp_get_ui(SilcMPInt *mp); * * DESCRIPTION * * Returns the least significant unsigned word from `mp'. * ***/ -uint32 silc_mp_get_ui(SilcMPInt *mp); +SilcUInt32 silc_mp_get_ui(SilcMPInt *mp); /****f* silcmath/SilcMPAPI/silc_mp_get_str * @@ -195,6 +239,11 @@ uint32 silc_mp_get_ui(SilcMPInt *mp); * must already have space allocated. The function returns the same * as `str' or NULL on error. * + * NOTES + * + * For base 2 the returned string is in ASCII bit presentation, not + * in binary. Use the silc_mp_mp2bin to encode integer into binary. + * ***/ char *silc_mp_get_str(char *str, SilcMPInt *mp, int base); @@ -215,7 +264,7 @@ void silc_mp_add(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * * SYNOPSIS * - * void silc_mp_add_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); + * void silc_mp_add_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); * * DESCRIPTION * @@ -223,7 +272,7 @@ void silc_mp_add(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * to `dst'. * ***/ -void silc_mp_add_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); +void silc_mp_add_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); /****f* silcmath/SilcMPAPI/silc_mp_sub * @@ -242,7 +291,7 @@ void silc_mp_sub(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * * SYNOPSIS * - * void silc_mp_sub_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); + * void silc_mp_sub_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); * * DESCRIPTION * @@ -250,7 +299,7 @@ void silc_mp_sub(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * to `dst'. * ***/ -void silc_mp_sub_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); +void silc_mp_sub_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); /****f* silcmath/SilcMPAPI/silc_mp_mul * @@ -269,7 +318,7 @@ void silc_mp_mul(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * * SYNOPSIS * - * void silc_mp_mul_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); + * void silc_mp_mul_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); * * DESCRIPTION * @@ -277,21 +326,21 @@ void silc_mp_mul(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * to `dst'. * ***/ -void silc_mp_mul_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); +void silc_mp_mul_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); /****f* silcmath/SilcMPAPI/silc_mp_mul_2exp * * SYNOPSIS * - * void silc_mp_mul_2exp(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp); + * void silc_mp_mul_2exp(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp); * * DESCRIPTION * - * Multiply integers `mp1' with 2 ** `exp' and save the result to + * Multiply integers `mp1' with 2 ** `exp' and save the result to * `dst'. This is equivalent to dst = mp1 * (2 ^ exp). * ***/ -void silc_mp_mul_2exp(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp); +void silc_mp_mul_2exp(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp); /****f* silcmath/SilcMPAPI/silc_mp_sqrt * @@ -324,7 +373,7 @@ void silc_mp_div(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * * SYNOPSIS * - * void silc_mp_div_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); + * void silc_mp_div_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); * * DESCRIPTION * @@ -332,24 +381,24 @@ void silc_mp_div(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * `dst'. This is equivalent to dst = mp1 / ui; * ***/ -void silc_mp_div_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); +void silc_mp_div_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); /****f* silcmath/SilcMPAPI/silc_mp_div_qr * * SYNOPSIS * - * void silc_mp_div_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1, + * void silc_mp_div_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1, * SilcMPInt *mp2); * * DESCRIPTION * * Divide the `mp1' and `mp2' and save the quotient to the `q' and - * the remainder to the `r'. This is equivalent to the q = mp1 / mp2, + * the remainder to the `r'. This is equivalent to the q = mp1 / mp2, * r = mp1 mod mp2 (or mp1 = mp2 * q + r). If the `q' or `r' is NULL * then the operation is omitted. * ***/ -void silc_mp_div_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1, +void silc_mp_div_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1, SilcMPInt *mp2); /****f* silcmath/SilcMPAPI/silc_mp_div_2exp @@ -364,14 +413,14 @@ void silc_mp_div_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1, * This is equivalent to dst = mp1 / (2 ^ exp). * ***/ -void silc_mp_div_2exp(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp); +void silc_mp_div_2exp(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp); /****f* silcmath/SilcMPAPI/silc_mp_div_2exp_qr * * SYNOPSIS * - * void silc_mp_div_2exp_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1, - * uint32 exp); + * void silc_mp_div_2exp_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1, + * SilcUInt32 exp); * * DESCRIPTION * @@ -381,8 +430,8 @@ void silc_mp_div_2exp(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp); * is omitted. * ***/ -void silc_mp_div_2exp_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1, - uint32 exp); +void silc_mp_div_2exp_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1, + SilcUInt32 exp); /****f* silcmath/SilcMPAPI/silc_mp_mod * @@ -404,16 +453,16 @@ void silc_mp_mod(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * * SYNOPSIS * - * void silc_mp_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); + * void silc_mp_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); * * DESCRIPTION * - * Mathematical MOD function. Produces the remainder of `mp1' and + * Mathematical MOD function. Produces the remainder of `mp1' and * unsigned word `ui' and saves the result to `dst'. This is equivalent * to dst = mp1 mod ui. * ***/ -void silc_mp_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); +void silc_mp_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); /****f* silcmath/SilcMPAPI/silc_mp_mod_2exp * @@ -429,7 +478,7 @@ void silc_mp_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); * function returns the remainder as well. * ***/ -void silc_mp_mod_2exp(SilcMPInt *dst, SilcMPInt *mp1, uint32 ui); +void silc_mp_mod_2exp(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui); /****f* silcmath/SilcMPAPI/silc_mp_pow * @@ -449,7 +498,7 @@ void silc_mp_pow(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *exp); * * SYNOPSIS * - * void silc_mp_pow_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp); + * void silc_mp_pow_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp); * * DESCRIPTION * @@ -457,13 +506,13 @@ void silc_mp_pow(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *exp); * equivalent to dst = mp1 ^ exp. * ***/ -void silc_mp_pow_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp); +void silc_mp_pow_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp); /****f* silcmath/SilcMPAPI/silc_mp_pow_mod * * SYNOPSIS * - * void silc_mp_pow_mod(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *exp, + * void silc_mp_pow_mod(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *exp, * SilcMPInt *mod); * * DESCRIPTION @@ -472,14 +521,14 @@ void silc_mp_pow_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp); * This is equivalent to dst = (mp1 ^ exp) mod mod. * ***/ -void silc_mp_pow_mod(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *exp, +void silc_mp_pow_mod(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *exp, SilcMPInt *mod); /****f* silcmath/SilcMPAPI/silc_mp_pow_mod_ui * * SYNOPSIS * - * void silc_mp_pow_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp, + * void silc_mp_pow_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp, * SilcMPInt *mod); * * DESCRIPTION @@ -488,7 +537,7 @@ void silc_mp_pow_mod(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *exp, * This is equivalent to dst = (mp1 ^ exp) mod mod. * ***/ -void silc_mp_pow_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp, +void silc_mp_pow_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp, SilcMPInt *mod); /****f* silcmath/SilcMPAPI/silc_mp_modinv @@ -499,21 +548,21 @@ void silc_mp_pow_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, uint32 exp, * * DESCRIPTION * - * Find multiplicative inverse using Euclid's extended algorithm. - * Computes inverse such that a * inv mod n = 1, where 0 < a < n. + * Find multiplicative inverse using Euclid's extended algorithm. + * Computes inverse such that a * inv mod n = 1, where 0 < a < n. * Algorithm goes like this: - * + * * g(0) = n v(0) = 0 * g(1) = a v(1) = 1 - * + * * y = g(i-1) / g(i) * g(i+1) = g(i-1) - y * g(i) = g(i)-1 mod g(i) * v(i+1) = v(i-1) - y * v(i) - * - * do until g(i) = 0, then inverse = v(i-1). If inverse is negative then n, - * is added to inverse making it positive again. (Sometimes the algorithm - * has a variable u defined too and it behaves just like v, except that - * initalize values are swapped (i.e. u(0) = 1, u(1) = 0). However, u is + * + * do until g(i) = 0, then inverse = v(i-1). If inverse is negative then n, + * is added to inverse making it positive again. (Sometimes the algorithm + * has a variable u defined too and it behaves just like v, except that + * initalize values are swapped (i.e. u(0) = 1, u(1) = 0). However, u is * not needed by the algorithm so it does not have to be included.) * ***/ @@ -537,7 +586,7 @@ void silc_mp_gcd(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2); * * SYNOPSIS * - * void silc_mp_gcdext(SilcMPInt *g, SilcMPInt *s, SilcMPInt *t, + * void silc_mp_gcdext(SilcMPInt *g, SilcMPInt *s, SilcMPInt *t, * SilcMPInt *mp1, SilcMPInt *mp2); * * DESCRIPTION @@ -567,7 +616,7 @@ int silc_mp_cmp(SilcMPInt *mp1, SilcMPInt *mp2); * * SYNOPSIS * - * int silc_mp_cmp_si(SilcMPInt *mp1, int32 si); + * int silc_mp_cmp_si(SilcMPInt *mp1, SilcInt32 si); * * DESCRIPTION * @@ -575,29 +624,29 @@ int silc_mp_cmp(SilcMPInt *mp1, SilcMPInt *mp2); * if `mp1' > `si', `mp1' == `si', or `mp1' < `si', respectively. * ***/ -int silc_mp_cmp_si(SilcMPInt *mp1, int32 si); +int silc_mp_cmp_si(SilcMPInt *mp1, SilcInt32 si); /****f* silcmath/SilcMPAPI/silc_mp_cmp_ui * * SYNOPSIS * - * int silc_mp_cmp_ui(SilcMPInt *mp1, uint32 ui); + * int silc_mp_cmp_ui(SilcMPInt *mp1, SilcUInt32 ui); * * DESCRIPTION * - * Compare `mp1' and unsigned word `ui'. Returns posivite, zero, or - * negative if `mp1' > `ui', `mp1' == `ui', or `mp1' < `ui', + * Compare `mp1' and unsigned word `ui'. Returns posivite, zero, or + * negative if `mp1' > `ui', `mp1' == `ui', or `mp1' < `ui', * respectively. * ***/ -int silc_mp_cmp_ui(SilcMPInt *mp1, uint32 ui); +int silc_mp_cmp_ui(SilcMPInt *mp1, SilcUInt32 ui); /****f* silcmath/SilcMPAPI/silc_mp_mp2bin * * SYNOPSIS * - * unsigned char *silc_mp_mp2bin(SilcMPInt *val, uint32 len, - * uint32 *ret_len); + * unsigned char *silc_mp_mp2bin(SilcMPInt *val, SilcUInt32 len, + * SilcUInt32 *ret_len); * * DESCRIPTION * @@ -606,30 +655,30 @@ int silc_mp_cmp_ui(SilcMPInt *mp1, uint32 ui); * buffer is allocated that large. If zero then the size is approximated. * ***/ -unsigned char *silc_mp_mp2bin(SilcMPInt *val, uint32 len, - uint32 *ret_len); +unsigned char *silc_mp_mp2bin(SilcMPInt *val, SilcUInt32 len, + SilcUInt32 *ret_len); /****f* silcmath/SilcMPAPI/silc_mp_mp2bin_noalloc * * SYNOPSIS * * void silc_mp_mp2bin_noalloc(SilcMPInt *val, unsigned char *dst, - * uint32 dst_len); + * SilcUInt32 dst_len); * * DESCRIPTION * * Same as silc_mp_mp2bin but does not allocate any memory. The - * encoded data is returned into `dst' and it's length to the `ret_len'. + * encoded data is returned into `dst' of size of `dst_len'. * ***/ void silc_mp_mp2bin_noalloc(SilcMPInt *val, unsigned char *dst, - uint32 dst_len); + SilcUInt32 dst_len); /****f* silcmath/SilcMPAPI/silc_mp_bin2mp * * SYNOPSIS * - * void silc_mp_bin2mp(unsigned char *data, uint32 len, + * void silc_mp_bin2mp(unsigned char *data, SilcUInt32 len, * SilcMPInt *ret); * * DESCRIPTION @@ -638,7 +687,7 @@ void silc_mp_mp2bin_noalloc(SilcMPInt *val, unsigned char *dst, * must be initialized. * ***/ -void silc_mp_bin2mp(unsigned char *data, uint32 len, SilcMPInt *ret); +void silc_mp_bin2mp(unsigned char *data, SilcUInt32 len, SilcMPInt *ret); /****f* silcmath/SilcMPAPI/silc_mp_abs *