1 % \begin{meta-comment} <general public licence>
3 %% crypto package -- useful macros for typesetting crypto papers
4 %% Copyright (c) 2001--2003, 2006 Mark Wooding
6 %% This file is part of the `mdwtools' LaTeX package collection.
8 %% `mdwtools' is free software: you can redistribute it and/or modify it
9 %% under the terms of the GNU General Public License as published by the
10 %% Free Software Foundation; either version 2 of the License, or (at your
11 %% option) any later version.
13 %% `mdwtools' is distributed in the hope that it will be useful, but
14 %% WITHOUT ANY WARRANTY; without even the implied warranty of
15 %% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 %% General Public License for more details.
18 %% You should have received a copy of the GNU General Public License
19 %% along with `mdwtools'. If not, write to the Free Software Foundation,
20 %% Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 % \begin{meta-comment} <Package preambles>
25 %<+package>\NeedsTeXFormat{LaTeX2e}
26 %<+package>\ProvidesPackage{crypto}
27 %<+package> [2020/09/06 1.14.0 Crypto typesetting]
32 %% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
33 %% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
34 %% Digits \0\1\2\3\4\5\6\7\8\9
35 %% Exclamation \! Double quote \" Hash (number) \#
36 %% Dollar \$ Percent \% Ampersand \&
37 %% Acute accent \' Left paren \( Right paren \)
38 %% Asterisk \* Plus \+ Comma \,
39 %% Minus \- Point \. Solidus \/
40 %% Colon \: Semicolon \; Less than \<
41 %% Equals \= Greater than \> Question mark \?
42 %% Commercial at \@ Left bracket \[ Backslash \\
43 %% Right bracket \] Circumflex \^ Underscore \_
44 %% Grave accent \` Left brace \{ Vertical bar \|
45 %% Right brace \} Tilde \~}
48 % \begin{meta-comment}
52 \describespackage{crypto}
58 %^^A-------------------------------------------------------------------------
59 % \section{User guide}
61 % \subsection{Algorithm typesetting}
63 % A lot of provable-security papers need to be able to typeset algorithms
64 % describing adversaries, schemes, oracle behaviour, etc. There is a
65 % (relatively) standard format for doing this which we support.
67 % \DescribeEnv{program}
68 % The \env{program} environment provides handy notation for describing
69 % algorithms formally. It gives a \env{tabbing} environment, so that things
70 % can be laid out nicely, and allows fragments of algorithms to be laid out
71 % in columns or rows, with separating rules.
74 % Within the \env{program} environment, the |\next| command stops typesetting
75 % the current column, typesets a vertical separator rule, and starts a new
76 % column. Adjacent columns are spaced out evenly across the page, with equal
77 % space around the rules rules and at the current margins. This means that
78 % the rules don't line up, but it still seems to provide a pleasing effect.
80 % \DescribeMacro\newline
81 % The |\newline| macro begins a new row of algorithm typesetting. A page
82 % break is possible at a |\newline|.
85 % A number of standard keywords are available, as shown in
86 % table~\ref{tab:kw}. The typsetting of these is done by the |\kw| command,
87 % which usually sets its argument in text bold face, but can be redefined.
88 % The standard definition uses |\xspace| so that you don't need to remember
89 % to say \verb*+\ + after a keyword command.
92 % \def\row#1{\texttt{\string#1} & #1 \\}
94 % \textbf{Command} & \textbf{Keyword} \\
114 % \caption{Keywords available for algorithm typesetting}
119 % Within a \env{program} environment, the |\ind| command shunts the indent
120 % level 1\,em to the right.
122 % \DescribeMacro\gets
123 % \DescribeMacro\getsr
125 % Assignment can be represented using the standard command |\gets|, which
126 % typesets a left-pointing arrow `$\gets$'. Random sampling -- the selection
127 % of a random element from a set or probability distribution -- can be
128 % represented using the new command |\getsr|, which typesets an arrow with a
129 % little `R' above it `$\getsr$'. Random membership -- showing that
130 % something is a random variable with some distribution -- can be represented
131 % using the |\inr| command, which just typesets an $\in$ sign with a
132 % subscript `R': `$\inr$'.
134 % Should one wish, one can use a different character than `R' to denote
135 % randomness. Some authors use `\$', for example. I know of one
136 % (cheapskate?) author who has used `\rlap/c'. Redefining the |\random|
137 % command lets you do this. For example, you can say
138 % |\newcommand{\random}{\$}| should you so wish.
141 % Long identifiers can be typeset using the |\id| command. giving the
142 % identifier name as an argument. The |\id| command is only valid in maths
143 % mode. As currently set up, |\id| sets its argument in \emph{text} italics;
144 % this seems to look better in documents which use a PostScript body face and
145 % Computer Modern for maths.
148 % It's handy to be able to glue a bit of (possibly fancy) maths typesetting
149 % to an identifier, e.g., to construct $\Xid{H'}{list}$, or
150 % $\Xid{\mathcal{E}}{CTR$\$$}^F$. This is done using
151 % \syntax{"\\Xid{"<maths>"}{"<text>"}"}. The two bits are joined by a text
154 % \DescribeMacro\cookie
155 % Sometimes textual names are used for special `symbols', which have meaning
156 % to algorithms, e.g., the symbols $\cookie{find}$ and $\cookie{guess}$ in
157 % the standard indistinguishability game. These can be typeset using the
160 % \subsection{Other stuff}
162 % \DescribeMacro\Thing
163 % In the quantifiable-security world, there are standard symbols for
164 % advantage, success probability, insecurity, etc. The generic `style hook'
165 % for these is \syntax{"\\Thing{"<name>"}{"<notion>"}{"scheme"}"}, which
166 % typesets $\Thing{name}{notion}{scheme}$. It helps a lot if you have the
167 % \package{amstext} package loaded.
169 % \DescribeMacro\Succ
171 % \DescribeMacro\InSec
172 % \DescribeMacro\Expt
173 % \DescribeMacro\Game
175 % Some standard `things' are provided: "\\Succ{"<notion>"}{"<scheme>"}",
176 % "\\Adv{"<notion>"}{"<scheme>"}", "\\InSec{"<notion>"}",
177 % "\\Expt{"<notion>"}{"<scheme>"}", and "\\Game{"<notion>"}{"<scheme>"}".
181 % In proofs which proceed by varying the rules of the game played by the
182 % adversary and bounding the probability of it noticing at each step, game
183 % names are usually typeset as $\G n$ for small numbers $n$. The command
184 % \syntax{"\\G{"<n>"}"} command does this typesetting. There's an optional
185 % argument, which is a symbol to write instead of `G'.
187 % \DescribeMacro\Func
188 % \DescribeMacro\Perm
189 % When dealing with finite PRFs and PRPs, we need to talk about the set of
190 % \emph{all} functions (or permutations) over particular sets, usually
191 % $n$-vectors of bits. The macros \syntax{"\\Func{"<l>"}{"<L>"}"} and
192 % \syntax{"\\Perm{"<L>"}"} typeset $\Func{l}{L}$ and $\Perm{L}$ respectively,
193 % and are intended to denote the sets of all functions $F\colon \{0, 1\}^l
194 % \to \{0, 1\}^L$ and all permutations $\Pi\colon \{0, 1\}^L \to \{0, 1\}^L$
197 % \DescribeMacro\PKCS
198 % Finally, the |\PKCS| macro typesets `\PKCS{$n$}', allowing you to name RSA
199 % Security Inc.'s Public Key Cryptography Standards in a relatively nice way.
204 %^^A-------------------------------------------------------------------------
205 % \section{Implementation}
207 % We need David Carlisle's handy \package{xspace} package and the AMS |\text|
212 \RequirePackage{amstext}
213 \RequirePackage{xspace}
216 % \subsection{Algorithm typsetting}
218 % \begin{macro}{\cookie}
222 % First, some style issues. Note the |\xspace| at the end of |\kw|.
225 \def\cookie#1{\text{\normalfont\sffamily\/#1\/}}
226 \def\kw#1{\text{\normalfont\bfseries\/#1\/}\xspace}
227 \def\id#1{\text{\normalfont\itshape\/#1\/}}
234 % \begin{macro}{\getsr}
235 % \begin{macro}{\inr}
237 % The symbols for random selection and membership are fairly easy. The `R'
238 % over $\getsr$ is actually in scriptscript style, because that seems to look
242 \providecommand\random{R}
243 \def\inr{\mathrel{\in_{\random}}}
244 \def\getsr{\mathrel{\mathop{\gets}\limits^{\scriptscriptstyle\random}}}
250 % \begin{macro}{\Xid}
252 % The compound identifiers set by |\Xid| are easy.
255 \def\Xid#1#2{\id{$#1$-#2}}
260 % Now for the various keywords. These are trivial, but useful.
263 \def\RETURN{\kw{return}}
267 \def\REPEAT{\kw{repeat}}
268 \def\WHILE{\kw{while}}
269 \def\UNTIL{\kw{until}}
270 \def\FOREVER{\kw{forever}}
273 \def\FOREACH{\kw{for\,each}}
277 \def\ABORT{\kw{abort}}
278 \def\PARSE{\kw{parse}}
280 \def\NEW{\ifmmode\mathop{\kw{new}}\else\kw{new}\fi}
282 \def\OUTPUT{\kw{output}}
286 % \begin{environment}{program}
287 % \begin{macro}{\next}
288 % \begin{macro}{\newline}
289 % \begin{macro}{\ind}
291 % Now for the \env{program} environment and its associated twiddling. This
292 % is actually a little fiddly.
294 % At the beginning, if we're in vertical mode -- i.e., there was a paragraph
295 % break before the start of the environment -- then remember this, because it
296 % affects the typesetting at the end. Set up |\next| and |\newline| in terms
297 % of the underlying machinery, and start a row of algorithm.
302 \@tempswatrue\ifvmode\@tempswafalse\fi%
303 \def\next{\program@end\vrule\program@begin}%
304 \def\newline{\program@endline\medskip\program@startline}%
305 \def\ind{\quad\=\+\kill}%
306 \ifdim\topsep<\parskip\topsep\parskip\fi%
307 \ifdim\@topsepadd<\z@\@topsepadd\z@\fi%
308 \begingroup\trivlist%
309 \advance\@topsep-\parskip\advance\@topsepadd-\parskip\item%
314 % Ending the environment is easy-ish. We stop the current row and leave a
315 % gap, matching the one that |\poem@startline| adds automatically. If we
316 % were initially in horizontal mode, then don't indent the next paragraph,
317 % and ignore spaces after the |\end{program}| command.
321 \program@endline\endtrivlist\endgroup%
322 \if@tempswa\@endparenv\fi\@ignoretrue%
326 % Now for the guts of all of this. First of all, we turn to the typesetting
327 % of a column, which is just hfil glue, a \env{minipage} with zero width and
328 % a \env{tabbing} environment. The first tab is already set 1\,em in from
329 % the margin. We use \env{minipage} to set up the list parameters correctly
330 % and manage the initial and final spacing. The zero width is OK because
331 % \env{tabbing} sets a list of hboxes rather than using outer horizontal
332 % mode, so the |\hsize| is irrelevant.
341 \parskip\z@\parsep\z@%
346 % This is rather messy. The |\item| from the \env{trivlist} messes up the
347 % spacing. We remove the box, and fix |\prevdepth| to ensure that there's no
354 \setbox\z@\lastbox\unskip\unskip\unskip\setbox\z@\lastbox\unskip%
357 \@startfield\strut\ignorespaces%
361 % Ending a program has no discernable subtlety.
372 % Finally, the row setting is fairly easy. We have to ensure that we obey
373 % the prevailing list parameters.
376 \def\program@startline{%
377 \moveright\@totalleftmargin%
378 \hb@xt@\linewidth\bgroup%
381 \def\program@endline{%
392 % \subsection{Other stuff}
394 % \begin{macro}{\Thing}
395 % \begin{macro}{\Succ}
396 % \begin{macro}{\Adv}
397 % \begin{macro}{\InSec}
398 % \begin{macro}{\Expt}
399 % \begin{macro}{\Game}
401 % Typesetting |\Thing| is easy. This acts as a style hook for the rest of
405 \def\Thing#1#2#3{\text{\normalfont\bfseries#1}^{\text{\normalfont#2}}_{#3}}
408 % And now here they are.
411 \def\Succ{\Thing{Succ}}
412 \def\Adv{\Thing{Adv}}
413 \def\InSec#1{\Thing{InSec}{#1}{}}
414 \def\Expt{\Thing{Expt}}
415 \def\Game{\Thing{Game}}
427 % The name of a game is typeset simply as
430 \newcommand\G[2][G]{\mathbf{#1}_{#2}}
435 % \begin{macro}{\Func}
436 % \begin{macro}{\Perm}
438 % The finite sets of functions and permutations are just a style choice. We
439 % choose to buck the standard trends and use caligraphic letters.
442 \def\Func#1#2{\mathcal{F}^{#1,#2}}
443 \def\Perm#1{\mathcal{P}^{#1}}
449 % \begin{macro}{\PKCS}
451 % Finally, I find that \PKCS{$n$} looks best typeset like this:
454 \def\PKCS#1{PKCS\,\##1}
459 % \vskip\parskip\vbox{ ^^A The best way I could find of keeping this lot
460 % ^^A together, I'm afraid.
461 % That's all there is. Byebye.
468 % \hfill Mark Wooding, \today