86f6a31e |
1 | % \begin{meta-comment} |
2 | % |
e653827a |
3 | % $Id: crypto.dtx,v 1.2 2003/09/05 16:13:14 mdw Exp $ |
86f6a31e |
4 | % |
5 | % Typesetting crypto papers |
6 | % |
7 | % (c) 2001 Mark Wooding |
8 | % |
86f6a31e |
9 | % \end{meta-comment} |
10 | % |
11 | % \begin{meta-comment} <general public licence> |
12 | %% |
13 | %% crypto package -- useful macros for typesetting crypto papers |
14 | %% Copyright (c) 2001 Mark Wooding |
15 | %% |
16 | %% This program is free software; you can redistribute it and/or modify |
17 | %% it under the terms of the GNU General Public License as published by |
18 | %% the Free Software Foundation; either version 2 of the License, or |
19 | %% (at your option) any later version. |
20 | %% |
21 | %% This program is distributed in the hope that it will be useful, |
22 | %% but WITHOUT ANY WARRANTY; without even the implied warranty of |
23 | %% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
24 | %% GNU General Public License for more details. |
25 | %% |
26 | %% You should have received a copy of the GNU General Public License |
27 | %% along with this program; if not, write to the Free Software Foundation, |
28 | %% Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
29 | % \end{meta-comment} |
30 | % |
31 | % \begin{meta-comment} <Package preambles> |
32 | %<+package>\NeedsTeXFormat{LaTeX2e} |
33 | %<+package>\ProvidesPackage{crypto} |
34 | %<+package> [2001/09/16 1.0 Crypto typesetting] |
35 | % \end{meta-comment} |
36 | % |
e653827a |
37 | % \CheckSum{245} |
86f6a31e |
38 | %% \CharacterTable |
39 | %% {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 |
40 | %% 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 |
41 | %% Digits \0\1\2\3\4\5\6\7\8\9 |
42 | %% Exclamation \! Double quote \" Hash (number) \# |
43 | %% Dollar \$ Percent \% Ampersand \& |
44 | %% Acute accent \' Left paren \( Right paren \) |
45 | %% Asterisk \* Plus \+ Comma \, |
46 | %% Minus \- Point \. Solidus \/ |
47 | %% Colon \: Semicolon \; Less than \< |
48 | %% Equals \= Greater than \> Question mark \? |
49 | %% Commercial at \@ Left bracket \[ Backslash \\ |
50 | %% Right bracket \] Circumflex \^ Underscore \_ |
51 | %% Grave accent \` Left brace \{ Vertical bar \| |
52 | %% Right brace \} Tilde \~} |
53 | %% |
54 | % |
55 | % \begin{meta-comment} |
56 | % |
57 | %<*driver> |
58 | \input{mdwtools} |
59 | \describespackage{crypto} |
60 | \mdwdoc |
61 | %</driver> |
62 | % |
63 | % \end{meta-comment} |
64 | % |
65 | %^^A------------------------------------------------------------------------- |
66 | % \section{User guide} |
67 | % |
68 | % \subsection{Algorithm typesetting} |
69 | % |
70 | % A lot of provable-security papers need to be able to typeset algorithms |
71 | % describing adversaries, schemes, oracle behaviour, etc. There is a |
72 | % (relatively) standard format for doing this which we support. |
73 | % |
74 | % \DescribeEnv{program} |
75 | % The \env{program} environment provides handy notation for describing |
76 | % algorithms formally. It gives a \env{tabbing} environment, so that things |
77 | % can be laid out nicely, and allows fragments of algorithms to be laid out |
78 | % in columns or rows, with separating rules. |
79 | % |
80 | % \DescribeMacro\next |
81 | % Within the \env{program} environment, the |\next| command stops typesetting |
82 | % the current column, typesets a vertical separator rule, and starts a new |
83 | % column. Adjacent columns are spaced out evenly across the page, with equal |
84 | % space around the rules rules and at the current margins. This means that |
85 | % the rules don't line up, but it still seems to provide a pleasing effect. |
86 | % |
87 | % \DescribeMacro\newline |
88 | % The |\newline| macro begins a new row of algorithm typesetting. A page |
89 | % break is possible at a |\newline|. |
90 | % |
91 | % \DescribeMacro\kw |
92 | % A number of standard keywords are available, as shown in |
93 | % table~\ref{tab:kw}. The typsetting of these is done by the |\kw| command, |
94 | % which usually sets its argument in text bold face, but can be redefined. |
95 | % The standard definition uses |\xspace| so that you don't need to remember |
e653827a |
96 | % to say \verb*+\ + after a keyword command. |
86f6a31e |
97 | % \begin{table} |
98 | % \centering |
99 | % \def\row#1{\texttt{\string#1} & #1 \\} |
100 | % \begin{tabular}{ll} |
101 | % \textbf{Command} & \textbf{Keyword} \\ |
102 | % \row\RETURN |
103 | % \row\IF |
104 | % \row\THEN |
105 | % \row\ELSE |
106 | % \row\REPEAT |
107 | % \row\WHILE |
108 | % \row\UNTIL |
109 | % \row\FOREVER |
110 | % \row\DO |
111 | % \row\FOR |
112 | % \row\FOREACH |
113 | % \row\FROM |
114 | % \row\IN |
115 | % \row\TO |
116 | % \row\ABORT |
117 | % \row\PARSE |
e653827a |
118 | % \row\NEW |
86f6a31e |
119 | % \row\AS |
120 | % \end{tabular} |
121 | % \caption{Keywords available for algorithm typesetting} |
122 | % \label{tab:kw} |
123 | % \end{table} |
124 | % |
e653827a |
125 | % \DescribeMacro\ind |
126 | % Within a \env{program} environment, the |\ind| command shunts the indent |
127 | % level 1\,em to the right. |
128 | % |
86f6a31e |
129 | % \DescribeMacro\gets |
130 | % \DescribeMacro\getsr |
131 | % \DescribeMacro\inr |
132 | % Assignment can be represented using the standard command |\gets|, which |
133 | % typesets a left-pointing arrow `$\gets$'. Random sampling -- the selection |
134 | % of a random element from a set or probability distribution -- can be |
135 | % represented using the new command |\getsr|, which typesets an arrow with a |
136 | % little `R' above it `$\getsr$'. Random membership -- showing that |
137 | % something is a random variable with some distribution -- can be represented |
138 | % using the |\inr| command, which just typesets an $\in$ sign with a |
139 | % subscript `R': `$\inr$'. |
140 | % |
141 | % \DescribeMacro\id |
142 | % Long identifiers can be typeset using the |\id| command. giving the |
143 | % identifier name as an argument. The |\id| command is only valid in maths |
144 | % mode. As currently set up, |\id| sets its argument in \emph{text} italics; |
145 | % this seems to look better in documents which use a PostScript body face and |
146 | % Computer Modern for maths. |
147 | % |
148 | % \DescribeMacro\Xid |
149 | % It's handy to be able to glue a bit of (possibly fancy) maths typesetting |
150 | % to an identifier, e.g., to construct $\Xid{H'}{list}$, or |
151 | % $\Xid{\mathcal{E}}{CTR$\$$}^F$. This is done using |
152 | % \syntax{"\\Xid{"<maths>"}{"<text>"}"}. The two bits are joined by a text |
153 | % hyphen `-'. |
154 | % |
155 | % \DescribeMacro\cookie |
156 | % Sometimes textual names are used for special `symbols', which have meaning |
157 | % to algorithms, e.g., the symbols $\cookie{find}$ and $\cookie{guess}$ in |
158 | % the standard indistinguishability game. These can be typeset using the |
159 | % |\cookie| command. |
160 | % |
161 | % \subsection{Other stuff} |
162 | % |
163 | % \DescribeMacro\Thing |
164 | % In the quantifiable-security world, there are standard symbols for |
165 | % advantage, success probability, insecurity, etc. The generic `style hook' |
166 | % for these is \syntax{"\\Thing{"<name>"}{"<notion>"}{"scheme"}"}, which |
167 | % typesets $\Thing{name}{notion}{scheme}$. It helps a lot if you have the |
168 | % \package{amstext} package loaded. |
169 | % |
170 | % \DescribeMacro\Succ |
171 | % \DescribeMacro\Adv |
172 | % \DescribeMacro\InSec |
173 | % \DescribeMacro\Expt |
e653827a |
174 | % \DescribeMacro\Game |
86f6a31e |
175 | % \begin{synshorts} |
176 | % Some standard `things' are provided: "\\Succ{"<notion>"}{"<scheme>"}", |
e653827a |
177 | % "\\Adv{"<notion>"}{"<scheme>"}", "\\InSec{"<notion>"}", |
178 | % "\\Expt{"<notion>"}{"<scheme>"}", and "\\Game{"<notion>"}{"<scheme>"}". |
86f6a31e |
179 | % \end{synshorts} |
180 | % |
181 | % \DescribeMacro\G |
182 | % In proofs which proceed by varying the rules of the game played by the |
183 | % adversary and bounding the probability of it noticing at each step, game |
184 | % names are usually typeset as $\G n$ for small numbers $n$. The command |
185 | % \syntax{"\\G{"<n>"}"} command does this typesetting. There's an optional |
186 | % argument, which is a symbol to write instead of `G'. |
187 | % |
188 | % \DescribeMacro\Func |
189 | % \DescribeMacro\Perm |
190 | % When dealing with finite PRFs and PRPs, we need to talk about the set of |
191 | % \emph{all} functions (or permutations) over particular sets, usually |
192 | % $n$-vectors of bits. The macros \syntax{"\\Func{"<l>"}{"<L>"}"} and |
193 | % \syntax{"\\Perm{"<L>"}"} typeset $\Func{l}{L}$ and $\Perm{L}$ respectively, |
194 | % and are intended to denote the sets of all functions $F\colon \{0, 1\}^l |
195 | % \to \{0, 1\}^L$ and all permutations $\Pi\colon \{0, 1\}^L \to \{0, 1\}^L$ |
196 | % respectively. |
197 | % |
198 | % \DescribeMacro\PKCS |
199 | % Finally, the |\PKCS| macro typesets `\PKCS{$n$}', allowing you to name RSA |
200 | % Security Inc.'s Public Key Cryptography Standards in a relatively nice way. |
201 | % |
202 | % \implementation |
203 | % |
204 | % |
205 | %^^A------------------------------------------------------------------------- |
206 | % \section{Implementation} |
207 | % |
208 | % We need David Carlisle's handy \package{xspace} package and the AMS |\text| |
209 | % command. |
210 | % |
211 | % \begin{macrocode} |
212 | %<*package> |
213 | \RequirePackage{amstext} |
214 | \RequirePackage{xspace} |
215 | % \end{macrocode} |
216 | |
217 | % \subsection{Algorithm typsetting} |
218 | % |
219 | % \begin{macro}{\cookie} |
220 | % \begin{macro}{\kw} |
221 | % \begin{macro}{\id} |
222 | % |
223 | % First, some style issues. Note the |\xspace| at the end of |\kw|. |
224 | % |
225 | % \begin{macrocode} |
226 | \def\cookie#1{\text{\normalfont\sffamily\/#1\/}} |
227 | \def\kw#1{\text{\normalfont\bfseries\/#1\/}\xspace} |
228 | \def\id#1{\text{\normalfont\itshape\/#1\/}} |
229 | % \end{macrocode} |
230 | % |
231 | % \end{macro} |
232 | % \end{macro} |
233 | % \end{macro} |
234 | % |
235 | % \begin{macro}{\getsr} |
236 | % \begin{macro}{\inr} |
237 | % |
238 | % The symbols for random selection and membership are fairly easy. The `R' |
239 | % over $\getsr$ is actually in scriptscript style, because that seems to look |
240 | % nicer. |
241 | % |
242 | % \begin{macrocode} |
243 | \def\inr{\mathrel{\in_R}} |
244 | \def\getsr{\mathrel{\mathop{\gets}\limits^{\scriptscriptstyle R}}} |
245 | % \end{macrocode} |
246 | % |
247 | % \end{macro} |
248 | % \end{macro} |
249 | % |
250 | % \begin{macro}{\Xid} |
251 | % |
252 | % The compound identifiers set by |\Xid| are easy. |
253 | % |
254 | % \begin{macrocode} |
255 | \def\Xid#1#2{\id{$#1$-#2}} |
256 | % \end{macrocode} |
257 | % |
258 | % \end{macro} |
259 | % |
260 | % Now for the various keywords. These are trivial, but useful. |
261 | % |
262 | % \begin{macrocode} |
263 | \def\RETURN{\kw{return}} |
264 | \def\IF{\kw{if}} |
265 | \def\THEN{\kw{then}} |
266 | \def\ELSE{\kw{else}} |
267 | \def\REPEAT{\kw{repeat}} |
268 | \def\WHILE{\kw{while}} |
269 | \def\UNTIL{\kw{until}} |
270 | \def\FOREVER{\kw{forever}} |
271 | \def\DO{\kw{do}} |
272 | \def\FOR{\kw{for}} |
273 | \def\FOREACH{\kw{for\,each}} |
274 | \def\FROM{\kw{from}} |
275 | \def\IN{\kw{in}} |
e653827a |
276 | \def\TO{\kw{to}} |
86f6a31e |
277 | \def\ABORT{\kw{abort}} |
278 | \def\PARSE{\kw{parse}} |
279 | \def\AS{\kw{as}} |
e653827a |
280 | \def\NEW{\ifmmode\mathop{\kw{new}}\else\kw{new}\fi} |
86f6a31e |
281 | % \end{macrocode} |
282 | % |
283 | % \begin{environment}{program} |
284 | % \begin{macro}{\next} |
285 | % \begin{macro}{\newline} |
e653827a |
286 | % \begin{macro}{\ind} |
86f6a31e |
287 | % |
288 | % Now for the \env{program} environment and its associated twiddling. This |
289 | % is actually a little fiddly. |
290 | % |
291 | % At the beginning, if we're in vertical mode -- i.e., there was a paragraph |
292 | % break before the start of the environment -- then remember this, because it |
293 | % affects the typesetting at the end. Set up |\next| and |\newline| in terms |
294 | % of the underlying machinery, and start a row of algorithm. |
295 | % |
296 | % \begin{macrocode} |
297 | \def\program{% |
298 | \normalfont% |
299 | \@tempswatrue\ifvmode\@tempswafalse\fi% |
300 | \def\next{\program@end\vrule\program@begin}% |
301 | \def\newline{\program@endline\medskip\program@startline}% |
e653827a |
302 | \def\ind{\quad\=\+\kill}% |
303 | \ifdim\topsep<\parskip\topsep\parskip\fi% |
304 | \ifdim\@topsepadd<\z@\@topsepadd\z@\fi% |
86f6a31e |
305 | \begingroup\trivlist% |
306 | \advance\@topsep-\parskip\advance\@topsepadd-\parskip\item% |
307 | \program@startline% |
308 | } |
309 | % \end{macrocode} |
310 | % |
311 | % Ending the environment is easy-ish. We stop the current row and leave a |
312 | % gap, matching the one that |\poem@startline| adds automatically. If we |
313 | % were initially in horizontal mode, then don't indent the next paragraph, |
314 | % and ignore spaces after the |\end{program}| command. |
315 | % |
316 | % \begin{macrocode} |
317 | \def\endprogram{% |
318 | \program@endline\endtrivlist\endgroup% |
e653827a |
319 | \if@tempswa\@endparenv\fi\@ignoretrue% |
86f6a31e |
320 | } |
321 | % \end{macrocode} |
322 | % |
323 | % Now for the guts of all of this. First of all, we turn to the typesetting |
324 | % of a column, which is just hfil glue, a \env{minipage} with zero width and |
325 | % a \env{tabbing} environment. The first tab is already set 1\,em in from |
326 | % the margin. We use \env{minipage} to set up the list parameters correctly |
327 | % and manage the initial and final spacing. The zero width is OK because |
328 | % \env{tabbing} sets a list of hboxes rather than using outer horizontal |
329 | % mode, so the |\hsize| is irrelevant. |
330 | % |
331 | % \begin{macrocode} |
332 | \def\program@begin{% |
333 | \begingroup% |
334 | \hfil% |
335 | \minipage[t]\z@% |
336 | \topsep\z@% |
337 | \itemsep\z@% |
338 | \parskip\z@\parsep\z@% |
339 | \partopsep\z@% |
340 | \tabbing% |
341 | % \end{macrocode} |
342 | % |
343 | % This is rather messy. The |\item| from the \env{trivlist} messes up the |
344 | % spacing. We remove the box, and fix |\prevdepth| to ensure that there's no |
345 | % glue at the top. |
346 | % |
347 | % \begin{macrocode} |
348 | \quad\=dummy\\% |
349 | \@stopfield% |
350 | \begingroup% |
351 | \setbox\z@\lastbox\unskip\unskip\unskip\setbox\z@\lastbox\unskip% |
352 | \endgroup% |
353 | \prevdepth-\@m\p@% |
e653827a |
354 | \@startfield\strut\ignorespaces% |
86f6a31e |
355 | } |
356 | % \end{macrocode} |
357 | % |
358 | % Ending a program has no discernable subtlety. |
359 | % |
360 | % \begin{macrocode} |
361 | \def\program@end{% |
362 | \endtabbing% |
363 | \endminipage% |
364 | \hfil% |
365 | \endgroup% |
366 | } |
367 | % \end{macrocode} |
368 | % |
369 | % Finally, the row setting is fairly easy. We have to ensure that we obey |
370 | % the prevailing list parameters. |
371 | % |
372 | % \begin{macrocode} |
373 | \def\program@startline{% |
374 | \moveright\@totalleftmargin% |
375 | \hb@xt@\linewidth\bgroup% |
376 | \program@begin% |
377 | } |
378 | \def\program@endline{% |
379 | \program@end% |
380 | \egroup% |
381 | } |
382 | % \end{macrocode} |
383 | % |
384 | % \end{macro} |
385 | % \end{macro} |
e653827a |
386 | % \end{macro} |
86f6a31e |
387 | % \end{environment} |
388 | % |
389 | % \subsection{Other stuff} |
390 | % |
391 | % \begin{macro}{\Thing} |
392 | % \begin{macro}{\Succ} |
393 | % \begin{macro}{\Adv} |
394 | % \begin{macro}{\InSec} |
395 | % \begin{macro}{\Expt} |
e653827a |
396 | % \begin{macro}{\Game} |
86f6a31e |
397 | % |
398 | % Typesetting |\Thing| is easy. This acts as a style hook for the rest of |
e653827a |
399 | % these things. |
86f6a31e |
400 | % |
401 | % \begin{macrocode} |
402 | \def\Thing#1#2#3{\text{\normalfont\bfseries#1}^{\text{\normalfont#2}}_{#3}} |
403 | % \end{macrocode} |
404 | % |
405 | % And now here they are. |
406 | % |
407 | % \begin{macrocode} |
408 | \def\Succ{\Thing{Succ}} |
409 | \def\Adv{\Thing{Adv}} |
410 | \def\InSec#1{\Thing{InSec}{#1}{}} |
411 | \def\Expt{\Thing{Expt}} |
e653827a |
412 | \def\Game{\Thing{Game}} |
86f6a31e |
413 | % \end{macrocode} |
414 | % |
415 | % \end{macro} |
e653827a |
416 | % \end{macro} |
86f6a31e |
417 | % \end{macro} |
418 | % \end{macro} |
419 | % \end{macro} |
420 | % \end{macro} |
421 | % |
422 | % \begin{macro}{\G} |
423 | % |
424 | % The name of a game is typeset simply as |
425 | % |
426 | % \begin{macrocode} |
427 | \newcommand\G[2][G]{\mathbf{#1}_{#2}} |
428 | % \end{macrocode} |
429 | % |
430 | % \end{macro} |
431 | % |
432 | % \begin{macro}{\Func} |
433 | % \begin{macro}{\Perm} |
434 | % |
435 | % The finite sets of functions and permutations are just a style choice. We |
436 | % choose to buck the standard trends and use caligraphic letters. |
437 | % |
438 | % \begin{macrocode} |
439 | \def\Func#1#2{\mathcal{F}^{#1,#2}} |
440 | \def\Perm#1{\mathcal{P}^{#1}} |
441 | % \end{macrocode} |
442 | % |
443 | % \end{macro} |
444 | % \end{macro} |
445 | % |
446 | % \begin{macro}{\PKCS} |
447 | % |
448 | % Finally, I find that \PKCS{$n$} looks best typeset like this: |
449 | % |
450 | % \begin{macrocode} |
451 | \def\PKCS#1{PKCS\,\##1} |
452 | % \end{macrocode} |
453 | % |
454 | % \end{macro} |
455 | % |
456 | % \vskip\parskip\vbox{ ^^A The best way I could find of keeping this lot |
457 | % ^^A together, I'm afraid. |
458 | % That's all there is. Byebye. |
459 | % |
460 | % \begin{macrocode} |
461 | %</package> |
462 | % \end{macrocode} |
463 | % \nopagebreak |
464 | % |
465 | % \hfill Mark Wooding, \today |
466 | % } |
467 | % \Finale |
468 | % |
469 | \endinput |