2003-02-28 16:02:06 +00:00
|
|
|
\documentclass{article}
|
|
|
|
\begin{document}
|
|
|
|
|
2003-02-28 16:06:56 +00:00
|
|
|
\title{LibTomMath v0.09 \\ A Free Multiple Precision Integer Library}
|
2003-02-28 16:02:06 +00:00
|
|
|
\author{Tom St Denis \\ tomstdenis@iahu.ca}
|
|
|
|
\maketitle
|
|
|
|
\newpage
|
|
|
|
|
|
|
|
\section{Introduction}
|
|
|
|
``LibTomMath'' is a free and open source library that provides multiple-precision integer functions required to form a basis
|
|
|
|
of a public key cryptosystem. LibTomMath is written entire in portable ISO C source code and designed to have an application
|
|
|
|
interface much like that of MPI from Michael Fromberger.
|
|
|
|
|
|
|
|
LibTomMath was written from scratch by Tom St Denis but designed to be drop in replacement for the MPI package. The
|
|
|
|
algorithms within the library are derived from descriptions as provided in the Handbook of Applied Cryptography and Knuth's
|
|
|
|
``The Art of Computer Programming''. The library has been extensively optimized and should provide quite comparable
|
|
|
|
timings as compared to many free and commercial libraries.
|
|
|
|
|
|
|
|
LibTomMath was designed with the following goals in mind:
|
|
|
|
\begin{enumerate}
|
|
|
|
\item Be a drop in replacement for MPI.
|
|
|
|
\item Be much faster than MPI.
|
|
|
|
\item Be written entirely in portable C.
|
|
|
|
\end{enumerate}
|
|
|
|
|
2003-02-28 16:06:56 +00:00
|
|
|
All three goals have been achieved. Particularly the speed increase goal. For example, a 512-bit modular exponentiation
|
|
|
|
is eight times faster\footnote{On an Athlon XP with GCC 3.2} with LibTomMath compared to MPI.
|
2003-02-28 16:02:06 +00:00
|
|
|
|
|
|
|
Being compatible with MPI means that applications that already use it can be ported fairly quickly. Currently there are
|
|
|
|
a few differences but there are many similarities. In fact the average MPI based application can be ported in under 15
|
|
|
|
minutes.
|
|
|
|
|
|
|
|
Thanks goes to Michael Fromberger for answering a couple questions and Colin Percival for having the patience and courtesy to
|
|
|
|
help debug and suggest optimizations. They were both of great help!
|
|
|
|
|
|
|
|
\section{Building Against LibTomMath}
|
|
|
|
|
|
|
|
Building against LibTomMath is very simple because there is only one source file. Simply add ``bn.c'' to your project and
|
|
|
|
copy both ``bn.c'' and ``bn.h'' into your project directory. There is no configuration nor building required before hand.
|
|
|
|
|
|
|
|
If you are porting an MPI application to LibTomMath the first step will be to remove all references to MPI and replace them
|
|
|
|
with references to LibTomMath. For example, substitute
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
#include "mpi.h"
|
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
with
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
#include "bn.h"
|
|
|
|
\end{verbatim}
|
|
|
|
|
2003-02-28 16:06:56 +00:00
|
|
|
Remove ``mpi.c'' from your project and replace it with ``bn.c''.
|
2003-02-28 16:02:06 +00:00
|
|
|
|
|
|
|
\section{Programming with LibTomMath}
|
|
|
|
|
|
|
|
\subsection{The mp\_int Structure}
|
|
|
|
All multiple precision integers are stored in a structure called \textbf{mp\_int}. A multiple precision integer is
|
|
|
|
essentially an array of \textbf{mp\_digit}. mp\_digit is defined at the top of bn.h. Its type can be changed to suit
|
|
|
|
a particular platform.
|
|
|
|
|
|
|
|
For example, when \textbf{MP\_8BIT} is defined\footnote{When building bn.c.} a mp\_digit is a unsigned char and holds
|
|
|
|
seven bits. Similarly when \textbf{MP\_16BIT} is defined a mp\_digit is a unsigned short and holds 15 bits.
|
|
|
|
By default a mp\_digit is a unsigned long and holds 28 bits.
|
|
|
|
|
|
|
|
The choice of digit is particular to the platform at hand and what available multipliers are provided. For
|
|
|
|
MP\_8BIT either a $8 \times 8 \Rightarrow 16$ or $16 \times 16 \Rightarrow 16$ multiplier is optimal. When
|
|
|
|
MP\_16BIT is defined either a $16 \times 16 \Rightarrow 32$ or $32 \times 32 \Rightarrow 32$ multiplier is optimal. By
|
|
|
|
default a $32 \times 32 \Rightarrow 64$ or $64 \times 64 \Rightarrow 64$ multiplier is optimal.
|
|
|
|
|
|
|
|
This gives the library some flexibility. For example, a i8051 has a $8 \times 8 \Rightarrow 16$ multiplier. The
|
|
|
|
16-bit x86 instruction set has a $16 \times 16 \Rightarrow 32$ multiplier. In practice this library is not particularly
|
|
|
|
designed for small devices like an i8051 due to the size. It is possible to strip out functions which are not required
|
|
|
|
to drop the code size. More realistically the library is well suited to 32 and 64-bit processors that have decent
|
|
|
|
integer multipliers. The AMD Athlon XP and Intel Pentium 4 processors are examples of well suited processors.
|
|
|
|
|
|
|
|
Throughout the discussions there will be references to a \textbf{used} and \textbf{alloc} members of an integer. The
|
|
|
|
used member refers to how many digits are actually used in the representation of the integer. The alloc member refers
|
|
|
|
to how many digits have been allocated off the heap. There is also the $\beta$ quantity which is equal to $2^W$ where
|
|
|
|
$W$ is the number of bits in a digit (default is 28).
|
|
|
|
|
2003-02-28 16:03:48 +00:00
|
|
|
\subsection{Calling Functions}
|
|
|
|
Most functions expect pointers to mp\_int's as parameters. To save on memory usage it is possible to have source
|
|
|
|
variables as destinations. For example:
|
|
|
|
\begin{verbatim}
|
|
|
|
mp_add(&x, &y, &x); /* x = x + y */
|
|
|
|
mp_mul(&x, &z, &x); /* x = x * z */
|
|
|
|
mp_div_2(&x, &x); /* x = x / 2 */
|
|
|
|
\end{verbatim}
|
|
|
|
|
2003-02-28 16:04:58 +00:00
|
|
|
\section{Quick Overview}
|
|
|
|
|
2003-02-28 16:02:06 +00:00
|
|
|
\subsection{Basic Functionality}
|
|
|
|
Essentially all LibTomMath functions return one of three values to indicate if the function worked as desired. A
|
|
|
|
function will return \textbf{MP\_OKAY} if the function was successful. A function will return \textbf{MP\_MEM} if
|
|
|
|
it ran out of memory and \textbf{MP\_VAL} if the input was invalid.
|
|
|
|
|
|
|
|
Before an mp\_int can be used it must be initialized with
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
int mp_init(mp_int *a);
|
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
For example, consider the following.
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
#include "bn.h"
|
|
|
|
int main(void)
|
|
|
|
{
|
|
|
|
mp_int num;
|
|
|
|
if (mp_init(&num) != MP_OKAY) {
|
|
|
|
printf("Error initializing a mp_int.\n");
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
A mp\_int can be freed from memory with
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
void mp_clear(mp_int *a);
|
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
This will zero the memory and free the allocated data. There are a set of trivial functions to manipulate the
|
|
|
|
value of an mp\_int.
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
/* set to zero */
|
|
|
|
void mp_zero(mp_int *a);
|
|
|
|
|
|
|
|
/* set to a digit */
|
|
|
|
void mp_set(mp_int *a, mp_digit b);
|
|
|
|
|
|
|
|
/* set a 32-bit const */
|
|
|
|
int mp_set_int(mp_int *a, unsigned long b);
|
|
|
|
|
|
|
|
/* init to a given number of digits */
|
|
|
|
int mp_init_size(mp_int *a, int size);
|
|
|
|
|
|
|
|
/* copy, b = a */
|
|
|
|
int mp_copy(mp_int *a, mp_int *b);
|
|
|
|
|
|
|
|
/* inits and copies, a = b */
|
|
|
|
int mp_init_copy(mp_int *a, mp_int *b);
|
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
The \textbf{mp\_zero} function will clear the contents of a mp\_int and set it to positive. The \textbf{mp\_set} function
|
|
|
|
will zero the integer and set the first digit to a value specified. The \textbf{mp\_set\_int} function will zero the
|
|
|
|
integer and set the first 32-bits to a given value. It is important to note that using mp\_set can have unintended
|
|
|
|
side effects when either the MP\_8BIT or MP\_16BIT defines are enabled. By default the library will accept the
|
|
|
|
ranges of values MPI will (and more).
|
|
|
|
|
|
|
|
The \textbf{mp\_init\_size} function will initialize the integer and set the allocated size to a given value. The
|
|
|
|
allocated digits are zero'ed by default but not marked as used. The \textbf{mp\_copy} function will copy the digits
|
|
|
|
(and sign) of the first parameter into the integer specified by the second parameter. The \textbf{mp\_init\_copy} will
|
|
|
|
initialize the first integer specified and copy the second one into it. Note that the order is reversed from that of
|
|
|
|
mp\_copy. This odd ``bug'' was kept to maintain compatibility with MPI.
|
|
|
|
|
|
|
|
\subsection{Digit Manipulations}
|
|
|
|
|
|
|
|
There are a class of functions that provide simple digit manipulations such as shifting and modulo reduction of powers
|
|
|
|
of two.
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
/* right shift by "b" digits */
|
|
|
|
void mp_rshd(mp_int *a, int b);
|
|
|
|
|
|
|
|
/* left shift by "b" digits */
|
|
|
|
int mp_lshd(mp_int *a, int b);
|
|
|
|
|
|
|
|
/* c = a / 2^b */
|
|
|
|
int mp_div_2d(mp_int *a, int b, mp_int *c);
|
|
|
|
|
|
|
|
/* b = a/2 */
|
|
|
|
int mp_div_2(mp_int *a, mp_int *b);
|
|
|
|
|
|
|
|
/* c = a * 2^b */
|
|
|
|
int mp_mul_2d(mp_int *a, int b, mp_int *c);
|
|
|
|
|
|
|
|
/* b = a*2 */
|
|
|
|
int mp_mul_2(mp_int *a, mp_int *b);
|
|
|
|
|
|
|
|
/* c = a mod 2^d */
|
|
|
|
int mp_mod_2d(mp_int *a, int b, mp_int *c);
|
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
\subsection{Basic Arithmetic}
|
|
|
|
|
|
|
|
Next are the class of functions which provide basic arithmetic.
|
|
|
|
|
|
|
|
\begin{verbatim}
|
2003-02-28 16:03:08 +00:00
|
|
|
/* b = -a */
|
|
|
|
int mp_neg(mp_int *a, mp_int *b);
|
|
|
|
|
|
|
|
/* b = |a| */
|
|
|
|
int mp_abs(mp_int *a, mp_int *b);
|
|
|
|
|
2003-02-28 16:02:06 +00:00
|
|
|
/* compare a to b */
|
|
|
|
int mp_cmp(mp_int *a, mp_int *b);
|
|
|
|
|
2003-02-28 16:03:08 +00:00
|
|
|
/* compare |a| to |b| */
|
|
|
|
int mp_cmp_mag(mp_int *a, mp_int *b);
|
|
|
|
|
2003-02-28 16:02:06 +00:00
|
|
|
/* c = a + b */
|
|
|
|
int mp_add(mp_int *a, mp_int *b, mp_int *c);
|
|
|
|
|
|
|
|
/* c = a - b */
|
|
|
|
int mp_sub(mp_int *a, mp_int *b, mp_int *c);
|
|
|
|
|
|
|
|
/* c = a * b */
|
|
|
|
int mp_mul(mp_int *a, mp_int *b, mp_int *c);
|
|
|
|
|
|
|
|
/* b = a^2 */
|
|
|
|
int mp_sqr(mp_int *a, mp_int *b);
|
|
|
|
|
|
|
|
/* a/b => cb + d == a */
|
|
|
|
int mp_div(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
|
|
|
|
|
2003-02-28 16:03:48 +00:00
|
|
|
/* c = a mod b, 0 <= c < b */
|
|
|
|
int mp_mod(mp_int *a, mp_int *b, mp_int *c);
|
2003-02-28 16:02:06 +00:00
|
|
|
\end{verbatim}
|
|
|
|
|
2003-02-28 16:05:52 +00:00
|
|
|
\subsection{Single Digit Functions}
|
2003-02-28 16:02:06 +00:00
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
/* compare against a single digit */
|
|
|
|
int mp_cmp_d(mp_int *a, mp_digit b);
|
|
|
|
|
|
|
|
/* c = a + b */
|
|
|
|
int mp_add_d(mp_int *a, mp_digit b, mp_int *c);
|
|
|
|
|
|
|
|
/* c = a - b */
|
|
|
|
int mp_sub_d(mp_int *a, mp_digit b, mp_int *c);
|
|
|
|
|
|
|
|
/* c = a * b */
|
|
|
|
int mp_mul_d(mp_int *a, mp_digit b, mp_int *c);
|
|
|
|
|
|
|
|
/* a/b => cb + d == a */
|
|
|
|
int mp_div_d(mp_int *a, mp_digit b, mp_int *c, mp_digit *d);
|
|
|
|
|
2003-02-28 16:03:48 +00:00
|
|
|
/* c = a mod b, 0 <= c < b */
|
|
|
|
int mp_mod_d(mp_int *a, mp_digit b, mp_digit *c);
|
2003-02-28 16:02:06 +00:00
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
Note that care should be taken for the value of the digit passed. By default, any 28-bit integer is a valid digit that can
|
|
|
|
be passed into the function. However, if MP\_8BIT or MP\_16BIT is defined only 7 or 15-bit (respectively) integers
|
|
|
|
can be passed into it.
|
|
|
|
|
|
|
|
\subsection{Modular Arithmetic}
|
|
|
|
|
|
|
|
There are some trivial modular arithmetic functions.
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
/* d = a + b (mod c) */
|
|
|
|
int mp_addmod(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
|
|
|
|
|
|
|
|
/* d = a - b (mod c) */
|
|
|
|
int mp_submod(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
|
|
|
|
|
|
|
|
/* d = a * b (mod c) */
|
|
|
|
int mp_mulmod(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
|
|
|
|
|
|
|
|
/* c = a * a (mod b) */
|
|
|
|
int mp_sqrmod(mp_int *a, mp_int *b, mp_int *c);
|
|
|
|
|
|
|
|
/* c = 1/a (mod b) */
|
|
|
|
int mp_invmod(mp_int *a, mp_int *b, mp_int *c);
|
|
|
|
|
|
|
|
/* c = (a, b) */
|
|
|
|
int mp_gcd(mp_int *a, mp_int *b, mp_int *c);
|
|
|
|
|
|
|
|
/* c = [a, b] or (a*b)/(a, b) */
|
|
|
|
int mp_lcm(mp_int *a, mp_int *b, mp_int *c);
|
|
|
|
|
2003-02-28 16:05:52 +00:00
|
|
|
/* find the b'th root of a */
|
|
|
|
int mp_n_root(mp_int *a, mp_digit b, mp_int *c);
|
|
|
|
|
2003-02-28 16:06:56 +00:00
|
|
|
/* computes the jacobi c = (a | n) (or Legendre if b is prime) */
|
|
|
|
int mp_jacobi(mp_int *a, mp_int *n, int *c);
|
|
|
|
|
2003-02-28 16:02:06 +00:00
|
|
|
/* d = a^b (mod c) */
|
|
|
|
int mp_exptmod(mp_int *a, mp_int *b, mp_int *c, mp_int *d);
|
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
\subsection{Radix Conversions}
|
|
|
|
To read or store integers in other formats there are the following functions.
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
int mp_unsigned_bin_size(mp_int *a);
|
|
|
|
int mp_read_unsigned_bin(mp_int *a, unsigned char *b, int c);
|
|
|
|
int mp_to_unsigned_bin(mp_int *a, unsigned char *b);
|
|
|
|
|
|
|
|
int mp_signed_bin_size(mp_int *a);
|
|
|
|
int mp_read_signed_bin(mp_int *a, unsigned char *b, int c);
|
|
|
|
int mp_to_signed_bin(mp_int *a, unsigned char *b);
|
|
|
|
|
|
|
|
int mp_read_radix(mp_int *a, unsigned char *str, int radix);
|
|
|
|
int mp_toradix(mp_int *a, unsigned char *str, int radix);
|
2003-02-28 16:03:08 +00:00
|
|
|
int mp_radix_size(mp_int *a, int radix);
|
2003-02-28 16:02:06 +00:00
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
The integers are stored in big endian format as most libraries (and MPI) expect. The \textbf{mp\_read\_radix} and
|
|
|
|
\textbf{mp\_toradix} functions read and write (respectively) null terminated ASCII strings in a given radix. Valid values
|
|
|
|
for the radix are between 2 and 64 (inclusively).
|
|
|
|
|
2003-02-28 16:04:18 +00:00
|
|
|
\section{Function Analysis}
|
|
|
|
|
|
|
|
Throughout the function analysis the variable $N$ will denote the average size of an input to a function as measured
|
|
|
|
by the number of digits it has. The variable $W$ will denote the number of bits per word and $c$ will denote a small
|
|
|
|
constant amount of work. The big-oh notation will be abused slightly to consider numbers that do not grow to infinity.
|
|
|
|
That is we shall consider $O(N/2) \ne O(N)$ which is an abuse of the notation.
|
|
|
|
|
|
|
|
\subsection{Digit Manipulation Functions}
|
|
|
|
The class of digit manipulation functions such as \textbf{mp\_rshd}, \textbf{mp\_lshd} and \textbf{mp\_mul\_2} are all
|
|
|
|
very simple functions to analyze.
|
|
|
|
|
|
|
|
\subsubsection{mp\_rshd(mp\_int *a, int b)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Shifts $a$ by given number of digits to the right and is equivalent to dividing by $\beta^b$. The work is performed
|
|
|
|
in-place which means the input and output are the same. If the shift count $b$ is less than or equal to zero
|
|
|
|
the function returns without doing any work. If the the shift count is larger than the number of digits in $a$
|
|
|
|
then $a$ is simply zeroed without shifting digits.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
This function requires no additional memory and $O(N)$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_lshd(mp\_int *a, int b)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Shifts $a$ by a given number of digits to the left and is equivalent to multiplying by $\beta^b$. The work
|
|
|
|
is performed in-place which means the input and output are the same. If the shift count $b$ is less than or equal
|
|
|
|
to zero the function returns success without doing any work.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
This function requires $O(b)$ additional digits of memory and $O(N)$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_div\_2d(mp\_int *a, int b, mp\_int *c, mp\_int *d)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Shifts $a$ by a given number of \textbf{bits} to the right and is equivalent to dividing by $2^b$. The shifted number is stored
|
|
|
|
in the $c$ parameter. The remainder of $a/2^b$ is optionally stored in $d$ (if it is not passed as NULL).
|
|
|
|
If the shift count $b$ is less than or equal to zero the function places $a$ in $c$ and returns success.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
This function requires $O(2 \cdot N)$ additional digits of memory and $O(2 \cdot N)$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_mul\_2d(mp\_int *a, int b, mp\_int *c)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Shifts $a$ by a given number of bits to the left and is equivalent to multiplying by $2^b$. The shifted number
|
|
|
|
is placed in the $c$ parameter. If the shift count $b$ is less than or equal to zero the function places $a$
|
|
|
|
in $c$ and returns success.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
This function requires $O(N)$ additional digits of memory and $O(2 \cdot N)$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_mod\_2d(mp\_int *a, int b, mp\_int *c)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Performs the action of reducing $a$ modulo $2^b$ and stores the result in $c$. If the shift count $b$ is less than
|
|
|
|
or equal to zero the function places $a$ in $c$ and returns success.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
This function requires $O(N)$ additional digits of memory and $O(2 \cdot N)$ time.
|
|
|
|
|
|
|
|
\subsection{Basic Arithmetic}
|
|
|
|
|
|
|
|
\subsubsection{mp\_cmp(mp\_int *a, mp\_int *b)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Performs a \textbf{signed} comparison between $a$ and $b$ returning \textbf{MP\_GT} is $a$ is larger than $b$.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
This function requires no additional memory and $O(N)$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_cmp\_mag(mp\_int *a, mp\_int *b)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Performs a \textbf{unsigned} comparison between $a$ and $b$ returning \textbf{MP\_GT} is $a$ is larger than $b$. Note
|
|
|
|
that this comparison is unsigned which means it will report, for example, $-5 > 3$. By comparison mp\_cmp will
|
|
|
|
report $-5 < 3$.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
This function requires no additional memory and $O(N)$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_add(mp\_int *a, mp\_int *b, mp\_int *c)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Computes $c = a + b$ using signed arithmetic. Handles the sign of the numbers which means it will subtract as
|
|
|
|
required, e.g. $a + -b$ turns into $a - b$.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
This function requires no additional memory and $O(N)$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_sub(mp\_int *a, mp\_int *b, mp\_int *c)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Computes $c = a - b$ using signed arithmetic. Handles the sign of the numbers which means it will add as
|
|
|
|
required, e.g. $a - -b$ turns into $a + b$.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
This function requires no additional memory and $O(N)$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_mul(mp\_int *a, mp\_int *b, mp\_int *c)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Computes $c = a \cdot b$ using signed arithmetic. Handles the sign of the numbers correctly which means it will
|
|
|
|
correct the sign of the product as required, e.g. $a \cdot -b$ turns into $-ab$.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
For relatively small inputs, that is less than 80 digits a standard baseline or comba-baseline multiplier is used. It
|
|
|
|
requires no additional memory and $O(N^2)$ time. The comba-baseline multiplier is only used if it can safely be used
|
|
|
|
without losing carry digits. The comba method is faster than the baseline method but cannot always be used which is why
|
|
|
|
both are provided. The code will automatically determine when it can be used. If the digit count is higher
|
|
|
|
than 80 for the inputs than a Karatsuba multiplier is used which requires approximately $O(6 \cdot N)$ memory and
|
|
|
|
$O(N^{lg(3)})$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_sqr(mp\_int *a, mp\_int *b)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Computes $b = a^2$.
|
2003-02-28 16:04:18 +00:00
|
|
|
For relatively small inputs, that is less than 80 digits a modified squaring or comba-squaring algorithm is used. It
|
|
|
|
requires no additional memory and $O((N^2 + N)/2)$ time. The comba-squaring method is used only if it can be safely used
|
|
|
|
without losing carry digits. After 80 digits a Karatsuba squaring algorithm is used whcih requires approximately
|
|
|
|
$O(4 \cdot N)$ memory and $O(N^{lg(3)})$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_div(mp\_int *a, mp\_int *b, mp\_int *c, mp\_int *d)}
|
2003-02-28 16:04:58 +00:00
|
|
|
Computes $c = \lfloor a/b \rfloor$ and $d \equiv a \mbox{ (mod }b\mbox{)}$. The division is signed which means the sign
|
|
|
|
of the output is not always positive. The sign of the remainder equals the sign of $a$ while the sign of the
|
|
|
|
quotient equals the product of the ratios $(a/\vert a \vert) \cdot (b/\vert b \vert)$. Both $c$ and $d$ can be
|
|
|
|
optionally passed as NULL if the value is not desired. For example, if you want only the quotient of $x/y$ then
|
|
|
|
mp\_div(\&x, \&y, \&z, NULL) is acceptable.
|
|
|
|
|
|
|
|
This function requires $O(4 \cdot N)$ memory and $O(3 \cdot N^2)$ time.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
2003-02-28 16:04:58 +00:00
|
|
|
\subsubsection{mp\_mod(mp\_int *a, mp\_int *b, mp\_int *c)}
|
|
|
|
Computes $c \equiv a \mbox{ (mod }b\mbox{)}$ but with the added condition that $0 \le c < b$. That is a normal
|
|
|
|
division is performed and if the remainder is negative $b$ is added to it. Since adding $b$ modulo $b$ is equivalent
|
|
|
|
to adding zero ($0 \equiv b \mbox{ (mod }b\mbox{)}$) the result is accurate. The results are undefined
|
|
|
|
when $b \le 0$, in theory the routine will still give a properly congruent answer but it will not always be positive.
|
|
|
|
|
|
|
|
This function requires $O(4 \cdot N)$ memory and $O(3 \cdot N^2)$ time.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
2003-02-28 16:05:52 +00:00
|
|
|
\subsection{Number Theoretic Functions}
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
\subsubsection{mp\_addmod, mp\_submod, mp\_mulmod, mp\_sqrmod}
|
|
|
|
These functions take the time of their host function plus the time it takes to perform a division. For example,
|
2003-02-28 16:04:58 +00:00
|
|
|
mp\_addmod takes $O(N + 3 \cdot N^2)$ time. Note that if you are performing many modular operations in a row with
|
2003-02-28 16:04:18 +00:00
|
|
|
the same modulus you should consider Barrett reductions.
|
|
|
|
|
2003-02-28 16:04:58 +00:00
|
|
|
Also note that these functions use mp\_mod which means the result are guaranteed to be positive.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
|
|
|
\subsubsection{mp\_invmod(mp\_int *a, mp\_int *b, mp\_int *c)}
|
2003-02-28 16:04:58 +00:00
|
|
|
This function will find $c = 1/a \mbox{ (mod }b\mbox{)}$ for any value of $a$ such that $(a, b) = 1$ and $b > 0$. When
|
|
|
|
$b$ is odd a ``fast'' variant is used which finds the inverse twice as fast.
|
2003-02-28 16:04:18 +00:00
|
|
|
|
2003-02-28 16:05:52 +00:00
|
|
|
\subsubsection{mp\_gcd(mp\_int *a, mp\_int *b, mp\_int *c)}
|
|
|
|
Finds the greatest common divisor of both $a$ and $b$ and places the result in $c$. Will work with either positive
|
|
|
|
or negative inputs.
|
|
|
|
|
|
|
|
Functions requires no additional memory and approximately $O(N \cdot log(N))$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_lcm(mp\_int *a, mp\_int *b, mp\_int *c)}
|
|
|
|
Finds the least common multiple of both $a$ and $b$ and places the result in $c$. Will work with either positive
|
|
|
|
or negative inputs. This is calculated by dividing the product of $a$ and $b$ by the greatest common divisor of
|
|
|
|
both.
|
|
|
|
|
|
|
|
Functions requires no additional memory and approximately $O(4 \cdot N^2)$ time.
|
|
|
|
|
|
|
|
\subsubsection{mp\_n\_root(mp\_int *a, mp\_digit b, mp\_int c)}
|
|
|
|
Finds the $b$'th root of $a$ and stores it in $b$. The roots are found such that $\vert c \vert^b \le \vert a \vert$.
|
|
|
|
Uses the Newton approximation approach which means it converges in $O(log \beta^N)$ time to a final result. Each iteration
|
|
|
|
requires $b$ multiplications and one division for a total work of $O(6N^2 \cdot log \beta^N) = O(6N^3 \cdot log \beta)$.
|
|
|
|
|
|
|
|
If the input $a$ is negative and $b$ is even the function returns an error. Otherwise the function will return a root
|
|
|
|
that has a sign that agrees with the sign of $a$.
|
|
|
|
|
2003-02-28 16:06:56 +00:00
|
|
|
\subsubsection{mp\_jacobi(mp\_int *a, mp\_int *n, int *c)}
|
|
|
|
Computes $c = \left ( {a \over n} \right )$ or the Jacobi function of $(a, n)$ and stores the result in an integer addressed
|
|
|
|
by $c$. Since the result of the Jacobi function $\left ( {a \over n} \right ) \in \lbrace -1, 0, 1 \rbrace$ it seemed
|
|
|
|
natural to store the result in a simple C style \textbf{int}. If $n$ is prime then the Jacobi function produces
|
|
|
|
the same results as the Legendre function\footnote{Source: Handbook of Applied Cryptography, pp. 73}. This means if
|
|
|
|
$n$ is prime then $\left ( {a \over n} \right )$ is equal to $1$ if $a$ is a quadratic residue modulo $n$ or $-1$ if
|
|
|
|
it is not.
|
|
|
|
|
2003-02-28 16:05:52 +00:00
|
|
|
\subsubsection{mp\_exptmod(mp\_int *a, mp\_int *b, mp\_int *c, mp\_int *d)}
|
|
|
|
Computes $d = a^b \mbox{ (mod }c\mbox{)}$ using a sliding window $k$-ary exponentiation algorithm. For an $\alpha$-bit
|
|
|
|
exponent it performs $\alpha$ squarings and at most $\lfloor \alpha/k \rfloor + k$ multiplications. The value of $k$ is
|
|
|
|
chosen to minimize the number of multiplications required for a given value of $\alpha$. Barrett reductions are used
|
|
|
|
to reduce the squared or multiplied temporary results modulo $c$. A Barrett reduction requires one division that is
|
|
|
|
performed only and two half multipliers of $N$ digit numbers resulting in approximation $O((N^2)/2)$ work.
|
|
|
|
|
|
|
|
Let $\gamma = \lfloor \alpha/k \rfloor + k$ represent the total multiplications. The total work of a exponentiation is
|
|
|
|
therefore, $O(3 \cdot N^2 + (\alpha + \gamma) \cdot ((N^2)/2) + \alpha \cdot ((N^2 + N)/2) + \gamma \cdot N^2)$ which
|
|
|
|
simplies to $O(3 \cdot N^2 + \gamma N^2 + \alpha (N^2 + (N/2)))$. The bulk of the time is spent in the Barrett
|
|
|
|
reductions and the squaring algorithms. Since $\gamma < \alpha$ it makes sense to optimize first the Barrett and
|
|
|
|
squaring routines first. Significant improvements in the future will most likely stem from optimizing these instead
|
|
|
|
of optimizing the multipliers.
|
|
|
|
|
2003-02-28 16:02:06 +00:00
|
|
|
\section{Timing Analysis}
|
|
|
|
\subsection{Observed Timings}
|
|
|
|
A simple test program ``demo.c'' was developed which builds with either MPI or LibTomMath (without modification). The
|
|
|
|
test was conducted on an AMD Athlon XP processor with 266Mhz DDR memory and the GCC 3.2 compiler\footnote{With build
|
2003-02-28 16:04:18 +00:00
|
|
|
options ``-O3 -fomit-frame-pointer -funroll-loops''}. The multiplications and squarings were repeated 100,000 times
|
|
|
|
each while the modular exponentiation (exptmod) were performed 50 times each. The ``inversions'' refers to multiplicative
|
|
|
|
inversions modulo an odd number of a given size. The RDTSC (Read Time Stamp Counter) instruction was used to measure the
|
|
|
|
time the entire iterations took and was divided by the number of iterations to get an average. The following results
|
|
|
|
were observed.
|
2003-02-28 16:02:06 +00:00
|
|
|
|
|
|
|
\begin{small}
|
|
|
|
\begin{center}
|
|
|
|
\begin{tabular}{c|c|c|c}
|
|
|
|
\hline \textbf{Operation} & \textbf{Size (bits)} & \textbf{Time with MPI (cycles)} & \textbf{Time with LibTomMath (cycles)} \\
|
|
|
|
\hline
|
2003-02-28 16:05:26 +00:00
|
|
|
Inversion & 128 & 264,083 & 59,782 \\
|
|
|
|
Inversion & 256 & 549,370 & 146,915 \\
|
|
|
|
Inversion & 512 & 1,675,975 & 367,172 \\
|
|
|
|
Inversion & 1024 & 5,237,957 & 1,054,158 \\
|
|
|
|
Inversion & 2048 & 17,871,944 & 3,459,683 \\
|
|
|
|
Inversion & 4096 & 66,610,468 & 11,834,556 \\
|
2003-02-28 16:04:18 +00:00
|
|
|
\hline
|
2003-02-28 16:05:52 +00:00
|
|
|
Multiply & 128 & 1,426 & 451 \\
|
|
|
|
Multiply & 256 & 2,551 & 958 \\
|
|
|
|
Multiply & 512 & 7,913 & 2,476 \\
|
|
|
|
Multiply & 1024 & 28,496 & 7,927 \\
|
2003-02-28 16:06:22 +00:00
|
|
|
Multiply & 2048 & 109,897 & 28,224 \\
|
|
|
|
Multiply & 4096 & 469,970 & 101,171 \\
|
2003-02-28 16:02:06 +00:00
|
|
|
\hline
|
2003-02-28 16:05:52 +00:00
|
|
|
Square & 128 & 1,319 & 511 \\
|
|
|
|
Square & 256 & 1,776 & 947 \\
|
|
|
|
Square & 512 & 5,399 & 2,153 \\
|
|
|
|
Square & 1024 & 18,991 & 5,733 \\
|
|
|
|
Square & 2048 & 72,126 & 17,621 \\
|
2003-02-28 16:06:22 +00:00
|
|
|
Square & 4096 & 306,269 & 67,576 \\
|
2003-02-28 16:02:06 +00:00
|
|
|
\hline
|
2003-02-28 16:06:22 +00:00
|
|
|
Exptmod & 512 & 32,021,586 & 4,138,354 \\
|
|
|
|
Exptmod & 768 & 97,595,492 & 9,840,233 \\
|
|
|
|
Exptmod & 1024 & 223,302,532 & 20,624,553 \\
|
|
|
|
Exptmod & 2048 & 1,682,223,369 & 114,936,361 \\
|
|
|
|
Exptmod & 2560 & 3,268,615,571 & 229,402,426 \\
|
|
|
|
Exptmod & 3072 & 5,597,240,141 & 367,403,840 \\
|
|
|
|
Exptmod & 4096 & 13,347,270,891 & 779,058,433
|
2003-02-28 16:02:06 +00:00
|
|
|
|
|
|
|
\end{tabular}
|
|
|
|
\end{center}
|
|
|
|
\end{small}
|
|
|
|
|
2003-02-28 16:04:18 +00:00
|
|
|
Note that the figures do fluctuate but their magnitudes are relatively intact. The purpose of the chart is not to
|
|
|
|
get an exact timing but to compare the two libraries. For example, in all of the tests the exact time for a 512-bit
|
2003-02-28 16:04:58 +00:00
|
|
|
squaring operation was not the same. The observed times were all approximately 2,500 cycles, more importantly they
|
2003-02-28 16:04:18 +00:00
|
|
|
were always faster than the timings observed with MPI by about the same magnitude.
|
|
|
|
|
2003-02-28 16:02:06 +00:00
|
|
|
\subsection{Digit Size}
|
|
|
|
The first major constribution to the time savings is the fact that 28 bits are stored per digit instead of the MPI
|
|
|
|
defualt of 16. This means in many of the algorithms the savings can be considerable. Consider a baseline multiplier
|
|
|
|
with a 1024-bit input. With MPI the input would be 64 16-bit digits whereas in LibTomMath it would be 37 28-bit digits.
|
|
|
|
A savings of $64^2 - 37^2 = 2727$ single precision multiplications.
|
|
|
|
|
|
|
|
\subsection{Multiplication Algorithms}
|
|
|
|
For most inputs a typical baseline $O(n^2)$ multiplier is used which is similar to that of MPI. There are two variants
|
|
|
|
of the baseline multiplier. The normal and the fast variants. The normal baseline multiplier is the exact same as the
|
|
|
|
algorithm from MPI. The fast baseline multiplier is optimized for cases where the number of input digits $N$ is less
|
|
|
|
than or equal to $2^{w}/\beta^2$. Where $w$ is the number of bits in a \textbf{mp\_word}. By default a mp\_word is
|
|
|
|
64-bits which means $N \le 256$ is allowed which represents numbers upto $7168$ bits.
|
|
|
|
|
|
|
|
The fast baseline multiplier is optimized by removing the carry operations from the inner loop. This is often referred
|
|
|
|
to as the ``comba'' method since it computes the products a columns first then figures out the carries. This has the
|
|
|
|
effect of making a very simple and paralizable inner loop.
|
|
|
|
|
|
|
|
For large inputs, typically 80 digits\footnote{By default that is 2240-bits or more.} or more the Karatsuba method is
|
|
|
|
used. This method has significant overhead but an asymptotic running time of $O(n^{1.584})$ which means for fairly large
|
|
|
|
inputs this method is faster. The Karatsuba implementation is recursive which means for extremely large inputs they
|
|
|
|
will benefit from the algorithm.
|
|
|
|
|
|
|
|
MPI only implements the slower baseline multiplier where carries are dealt with in the inner loop. As a result even at
|
2003-02-28 16:03:08 +00:00
|
|
|
smaller numbers (below the Karatsuba cutoff) the LibTomMath multipliers are faster.
|
2003-02-28 16:02:06 +00:00
|
|
|
|
|
|
|
\subsection{Squaring Algorithms}
|
|
|
|
|
|
|
|
Similar to the multiplication algorithms there are two baseline squaring algorithms. Both have an asymptotic running
|
|
|
|
time of $O((t^2 + t)/2)$. The normal baseline squaring is the same from MPI and the fast is a ``comba'' squaring
|
|
|
|
algorithm. The comba method is used if the number of digits $N$ is less than $2^{w-1}/\beta^2$ which by default
|
|
|
|
covers numbers upto $3584$ bits.
|
|
|
|
|
|
|
|
There is also a Karatsuba squaring method which achieves a running time of $O(n^{1.584})$ after considerably large
|
|
|
|
inputs.
|
|
|
|
|
|
|
|
MPI only implements the slower baseline squaring algorithm. As a result LibTomMath is considerably faster at squaring
|
|
|
|
than MPI is.
|
|
|
|
|
|
|
|
\subsection{Exponentiation Algorithms}
|
|
|
|
|
|
|
|
LibTomMath implements a sliding window $k$-ary left to right exponentiation algorithm. For a given exponent size $L$ an
|
|
|
|
appropriate window size $k$ is chosen. There are always at most $L$ modular squarings and $\lfloor L/k \rfloor$ modular
|
|
|
|
multiplications. The $k$-ary method works by precomputing values $g(x) = b^x$ for $0 \le x < 2^k$ and a given base
|
|
|
|
$b$. Then the multiplications are grouped in windows of $k$ bits. The sliding window technique has the benefit
|
|
|
|
that it can skip multiplications if there are zero bits following or preceding a window. Consider the exponent
|
|
|
|
$e = 11110001_2$ if $k = 2$ then there will be a two squarings, a multiplication of $g(3)$, two squarings, a multiplication
|
|
|
|
of $g(3)$, four squarings and and a multiplication by $g(1)$. In total there are 8 squarings and 3 multiplications.
|
|
|
|
|
|
|
|
MPI uses a binary square-multiply method. For the same exponent $e$ it would have had 8 squarings and 5 multiplications.
|
2003-02-28 16:03:08 +00:00
|
|
|
There is a precomputation phase for the method LibTomMath uses but it generally cuts down considerably on the number
|
2003-02-28 16:02:06 +00:00
|
|
|
of multiplications. Consider a 512-bit exponent. The worst case for the LibTomMath method results in 512 squarings and
|
|
|
|
124 multiplications. The MPI method would have 512 squarings and 512 multiplications. Randomly every $2k$ bits another
|
|
|
|
multiplication is saved via the sliding-window technique on top of the savings the $k$-ary method provides.
|
|
|
|
|
|
|
|
Both LibTomMath and MPI use Barrett reduction instead of division to reduce the numbers modulo the modulus given.
|
|
|
|
However, LibTomMath can take advantage of the fact that the multiplications required within the Barrett reduction
|
2003-02-28 16:03:08 +00:00
|
|
|
do not have to give full precision. As a result the reduction step is much faster and just as accurate. The LibTomMath code
|
2003-02-28 16:02:06 +00:00
|
|
|
will automatically determine at run-time (e.g. when its called) whether the faster multiplier can be used. The
|
2003-02-28 16:03:08 +00:00
|
|
|
faster multipliers have also been optimized into the two variants (baseline and comba baseline).
|
2003-02-28 16:02:06 +00:00
|
|
|
|
|
|
|
As a result of all these changes exponentiation in LibTomMath is much faster than compared to MPI.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
\end{document}
|