Skip to content

Commit 636edd0

Browse files
committed
Clarify MPI providers a bit further
This closes #354 Signed-off-by: Steffen Jaeckel <s@jaeckel.eu>
1 parent 5597fd8 commit 636edd0

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

doc/crypt.tex

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8726,6 +8726,7 @@ \subsection{Asymmetric Ciphers}
87268726

87278727
\chapter{Configuring and Building the Library}
87288728
\mysection{Introduction}
8729+
\index{math descriptor} \index{MPI provider}
87298730
The library is fairly flexible about how it can be built, used, and generally distributed. Additions are being made with
87308731
each new release that will make the library even more flexible. Each of the classes of functions can be disabled during
87318732
the build process to make a smaller library. This is particularly useful for shared libraries.
@@ -8738,6 +8739,13 @@ \chapter{Configuring and Building the Library}
87388739
build, or run time for the application. LibTomCrypt comes with three math descriptors that provide a standard interface to math
87398740
libraries.
87408741

8742+
Clarification regarding the wording in this area: 'MPI provider' and 'math descriptor' can be used synonymous.
8743+
Where the former usually means 'one of the entire set' and the latter means 'a specific'.
8744+
E.g. 'One can enable multiple MPI providers at build time, but has to select one of those MPI providers at run time.',
8745+
or 'The math descriptor for TomsFastMath is missing an implementation of \code{sqrtmod\_prime()}.'.
8746+
8747+
Please check Ch. \ref{mp-init} for details on the selection of an MPI provider at build, resp. run time.
8748+
87418749
\mysection{Makefile variables}
87428750

87438751
All GNU driven makefiles (including the makefile for ICC) use a set of common variables to control the build and install process. Most of the
@@ -9121,6 +9129,8 @@ \subsection{LTC\_RSA\_CRT\_HARDENING}
91219129
This is enabled by default and can be disabled by defining \textbf{LTC\_NO\_RSA\_CRT\_HARDENING}.
91229130

91239131
\subsection{Math Descriptors}
9132+
\index{math descriptor} \index{MPI provider}
9133+
\label{mp-init}
91249134
The library comes with three math descriptors that allow you to interface the public key cryptography API to freely available math
91259135
libraries. When \textbf{GMP\_DESC}, \textbf{LTM\_DESC}, or \textbf{TFM\_DESC} are defined
91269136
descriptors for the respective library are built and included in the library as \textit{gmp\_desc}, \textit{ltm\_desc}, or \textit{tfm\_desc} respectively.
@@ -10368,7 +10378,7 @@ \subsection{After v1.18.0}
1036810378
void init_GMP(void);
1036910379
\end{verbatim}
1037010380

10371-
These three MPI init functions have been introduced in version 1.18.0 and have been deprecated in the same version in favor of \textit{crypt\_mp\_init()}.
10381+
These three MPI init functions have been introduced in version 1.18.0 and have been deprecated in the same version in favor of \code{crypt\_mp\_init()}, c.f. Ch. \ref{mp-init}.
1037210382

1037310383
\clearpage
1037410384
\addcontentsline{toc}{chapter}{Index}

0 commit comments

Comments
 (0)