d03ab969 |
1 | /* -*-c-*- |
2 | * |
5c3f75ec |
3 | * $Id: blkc.h,v 1.8 2004/04/17 09:58:36 mdw Exp $ |
d03ab969 |
4 | * |
5 | * Common definitions for block ciphers |
6 | * |
7 | * (c) 1999 Straylight/Edgeware |
8 | */ |
9 | |
10 | /*----- Licensing notice --------------------------------------------------* |
11 | * |
12 | * This file is part of Catacomb. |
13 | * |
14 | * Catacomb is free software; you can redistribute it and/or modify |
15 | * it under the terms of the GNU Library General Public License as |
16 | * published by the Free Software Foundation; either version 2 of the |
17 | * License, or (at your option) any later version. |
18 | * |
19 | * Catacomb is distributed in the hope that it will be useful, |
20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
22 | * GNU Library General Public License for more details. |
23 | * |
24 | * You should have received a copy of the GNU Library General Public |
25 | * License along with Catacomb; if not, write to the Free |
26 | * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
27 | * MA 02111-1307, USA. |
28 | */ |
29 | |
b3f05084 |
30 | #ifndef CATACOMB_BLKC_H |
31 | #define CATACOMB_BLKC_H |
d03ab969 |
32 | |
33 | #ifdef __cplusplus |
34 | extern "C" { |
35 | #endif |
36 | |
37 | /*----- Header files ------------------------------------------------------*/ |
38 | |
c5885da8 |
39 | #include <assert.h> |
40 | |
d03ab969 |
41 | #include <mLib/bits.h> |
42 | |
43 | /*----- Theory of operation -----------------------------------------------* |
44 | * |
45 | * A block cipher has associated with it a triple, called PRE_CLASS, of the |
46 | * form `(TYPE, ENDIAN, BITS)', where TYPE is either `N' (representing an |
47 | * implemented bit size) or `X' (representing an unimplemented bit size, |
48 | * causing loops to be compiled rather than unrolled code), ENDIAN is `B' |
49 | * (big) or `L' (little), and BITS is the block size of the cipher in bits. |
50 | */ |
51 | |
52 | /*----- Data movement macros ----------------------------------------------*/ |
53 | |
54 | /* |
55 | * `The C preprocessor. You will never find a more wretched hive of bogus |
56 | * hackery. We must be cautious.' |
57 | */ |
58 | |
59 | /* --- General dispatch macros --- */ |
60 | |
61 | #define BLKC_DOGLUE(x, y) x ## y |
62 | #define BLKC_GLUE(x, y) BLKC_DOGLUE(x, y) |
63 | #define BLKC_APPLY(f, x) f x |
64 | #define BLKC_FIRST(x, y, z) x |
65 | #define BLKC_SECOND(x, y, z) y |
66 | #define BLKC_THIRD(x, y, z) z |
b3f05084 |
67 | #define BLKC_TYPE(PRE) BLKC_APPLY(BLKC_FIRST, PRE##_CLASS) |
68 | #define BLKC_ENDIAN(PRE) BLKC_APPLY(BLKC_SECOND, PRE##_CLASS) |
69 | #define BLKC_BITS(PRE) BLKC_APPLY(BLKC_THIRD, PRE##_CLASS) |
d03ab969 |
70 | |
71 | #define BLKC_STORE_E(PRE) BLKC_GLUE(STORE32_, BLKC_ENDIAN(PRE)) |
72 | #define BLKC_LOAD_E(PRE) BLKC_GLUE(LOAD32_, BLKC_ENDIAN(PRE)) |
73 | |
74 | /* --- Interface macros --- */ |
75 | |
76 | #define BLKC_STORE(PRE, b, w) \ |
77 | BLKC_GLUE(BLKC_STORE_, BLKC_TYPE(PRE)) \ |
78 | (PRE, b, w, BLKC_STORE_E(PRE), BLKC_BITS(PRE)) |
79 | |
80 | #define BLKC_XSTORE(PRE, b, w, wx) \ |
81 | BLKC_GLUE(BLKC_XSTORE_, BLKC_TYPE(PRE)) \ |
82 | (PRE, b, w, wx, BLKC_STORE_E(PRE), BLKC_BITS(PRE)) |
83 | |
84 | #define BLKC_LOAD(PRE, w, b) \ |
85 | BLKC_GLUE(BLKC_LOAD_, BLKC_TYPE(PRE)) \ |
86 | (PRE, w, b, BLKC_LOAD_E(PRE), BLKC_BITS(PRE)) |
87 | |
88 | #define BLKC_XLOAD(PRE, w, b) \ |
89 | BLKC_GLUE(BLKC_XLOAD_, BLKC_TYPE(PRE)) \ |
90 | (PRE, w, b, BLKC_LOAD_E(PRE), BLKC_BITS(PRE)) |
91 | |
92 | #define BLKC_MOVE(PRE, w, wx) \ |
93 | BLKC_GLUE(BLKC_MOVE_, BLKC_TYPE(PRE)) \ |
94 | (PRE, w, wx, BLKC_BITS(PRE)) |
95 | |
96 | #define BLKC_XMOVE(PRE, w, wx) \ |
97 | BLKC_GLUE(BLKC_XMOVE_, BLKC_TYPE(PRE)) \ |
98 | (PRE, w, wx, BLKC_BITS(PRE)) |
99 | |
c5885da8 |
100 | #define BLKC_STEP(PRE, w) \ |
101 | BLKC_GLUE(BLKC_STEP_X_, BLKC_ENDIAN(PRE)) \ |
102 | (PRE, w) |
103 | |
5c3f75ec |
104 | #define BLKC_ZERO(PRE, w) \ |
105 | BLKC_GLUE(BLKC_ZERO_, BLKC_TYPE(PRE)) \ |
106 | (PRE, w, BLKC_BITS(PRE)) |
107 | |
c5885da8 |
108 | #define BLKC_SET(PRE, w, x) \ |
109 | BLKC_GLUE(BLKC_SET_X_, BLKC_ENDIAN(PRE)) \ |
110 | (PRE, w, x) |
111 | |
112 | #define BLKC_SHOW(PRE, tag, w) do { \ |
113 | fputs(tag ": ", stdout); \ |
114 | BLKC_SKEL_X(PRE, BLKC_W(w);, printf("%08x ", *_w++);); \ |
115 | fputc('\n', stdout); \ |
116 | } while (0) |
117 | |
d03ab969 |
118 | /* --- General implementation skeleton --- */ |
119 | |
120 | #define BLKC_SKEL(PRE, decl, guts) do { \ |
121 | decl \ |
122 | guts \ |
123 | } while (0) |
124 | |
125 | #define BLKC_P(p) register octet *_p = (octet *)(p) |
126 | #define BLKC_W(w) register uint32 *_w = (w) |
c5885da8 |
127 | #define BLKC_WX(wx) register uint32 *_wx = (wx) |
d03ab969 |
128 | |
129 | /* --- Implementation for unusual block sizes --- */ |
130 | |
131 | #define BLKC_SKEL_X(PRE, decl, guts) \ |
c5885da8 |
132 | BLKC_SKEL(PRE, unsigned _i; decl, \ |
b3f05084 |
133 | for (_i = 0; _i < PRE##_BLKSZ / 4; _i++) { \ |
d03ab969 |
134 | guts \ |
135 | }) |
136 | |
137 | #define BLKC_STORE_X(PRE, b, w, op, n) \ |
138 | BLKC_SKEL_X(PRE, BLKC_P(b); const BLKC_W(w);, \ |
139 | op(_p, *_w); _p += 4; _w++; ) |
140 | |
141 | #define BLKC_XSTORE_X(PRE, b, w, wx, op, n) \ |
142 | BLKC_SKEL_X(PRE, BLKC_P(b); const BLKC_W(w); const BLKC_WX(wx);, \ |
143 | op(_p, *_w ^ *_wx); _p += 4; _w++; _wx++; ) |
144 | |
145 | #define BLKC_LOAD_X(PRE, w, b, op, n) \ |
146 | BLKC_SKEL_X(PRE, const BLKC_P(b); BLKC_W(w);, \ |
147 | *_w = op(_p); _p += 4; _w++; ) |
148 | |
149 | #define BLKC_XLOAD_X(PRE, w, b, op, n) \ |
150 | BLKC_SKEL_X(PRE, const BLKC_P(b); BLKC_W(w);, \ |
151 | *_w ^= op(_p); _p += 4; _w++; ) |
152 | |
153 | #define BLKC_MOVE_X(PRE, w, wx, n) \ |
154 | BLKC_SKEL_X(PRE, BLKC_W(w); const BLKC_WX(wx);, \ |
155 | *_w = *_wx; _w++; _wx++; ) \ |
156 | |
157 | #define BLKC_XMOVE_X(PRE, w, wx, n) \ |
158 | BLKC_SKEL_X(PRE, BLKC_W(w); const BLKC_WX(wx);, \ |
159 | *_w ^= *_wx; _w++; _wx++; ) \ |
160 | |
5c3f75ec |
161 | #define BLKC_ZERO_X(PRE, w, n) \ |
162 | BLKC_SKEL_X(PRE, BLKC_W(w);, *_w++ = 0;) |
163 | |
c5885da8 |
164 | #define BLKC_STEP_X_B(PRE, w) do { \ |
165 | unsigned _i = PRE##_BLKSZ / 4; BLKC_W(w); uint32 _x = 0; \ |
166 | while (_i && !_x) { _i--; _w[_i] = _x = U32(_w[_i] + 1); } \ |
167 | } while (0) |
168 | |
169 | #define BLKC_STEP_X_L(PRE, w) do { \ |
170 | unsigned _i = 0; BLKC_W(w); uint32 _x = 0; \ |
171 | while (_i < PRE##_BLKSZ / 4 && !_x) \ |
172 | { _w[_i] = _x = U32(_w[_i] + 1); _i++; } \ |
173 | } while (0) |
174 | |
175 | #define BLKC_SET_X_B(PRE, w, x) do { \ |
176 | unsigned _i; BLKC_W(w); unsigned long _x = x; \ |
177 | for (_i = 0; _i < PRE##_BLKSZ / 4; _i++) { \ |
178 | *_w++ = U32(_x); \ |
179 | _x = ((_x & ~MASK32) >> 16) >> 16; \ |
180 | } \ |
181 | } while (0) |
182 | |
183 | #define BLKC_SET_X_L(PRE, w, x) do { \ |
184 | unsigned _i; BLKC_W(w); unsigned long _x = x; _w += PRE##_BLKSZ / 4; \ |
185 | for (_i = 0; _i < PRE##_BLKSZ / 4; _i++) { \ |
186 | *--_w = U32(_x); \ |
187 | _x = ((_x & ~MASK32) >> 16) >> 16; \ |
188 | } \ |
189 | } while (0) |
190 | |
d03ab969 |
191 | /* --- Implementation for known block sizes --- */ |
192 | |
193 | #define BLKC_SKEL_64(PRE, decl, op, guts) \ |
194 | BLKC_SKEL(PRE, decl, guts(op, 0); guts(op, 1);) |
195 | |
c5885da8 |
196 | #define BLKC_SKEL_96(PRE, decl, op, guts) \ |
197 | BLKC_SKEL(PRE, decl, guts(op, 0); guts(op, 1); guts(op, 2);) |
198 | |
d03ab969 |
199 | #define BLKC_SKEL_128(PRE, decl, op, guts) \ |
200 | BLKC_SKEL(PRE, decl, guts(op, 0); guts(op, 1); guts(op, 2); guts(op, 3);) |
201 | |
70f31709 |
202 | #define BLKC_SKEL_192(PRE, decl, op, guts) \ |
203 | BLKC_SKEL(PRE, decl, \ |
204 | guts(op, 0); guts(op, 1); guts(op, 2); guts(op, 3); \ |
205 | guts(op, 4); guts(op, 5);) |
206 | |
207 | #define BLKC_SKEL_256(PRE, decl, op, guts) \ |
208 | BLKC_SKEL(PRE, decl, \ |
209 | guts(op, 0); guts(op, 1); guts(op, 2); guts(op, 3); \ |
210 | guts(op, 4); guts(op, 5); guts(op, 6); guts(op, 7);) |
211 | |
d03ab969 |
212 | #define BLKC_STORE_GUTS(op, i) op(_p + 4 * i, _w[i]) |
213 | #define BLKC_XSTORE_GUTS(op, i) op(_p + 4 * i, _w[i] ^ _wx[i]) |
214 | #define BLKC_LOAD_GUTS(op, i) _w[i] = op(_p + 4 * i) |
215 | #define BLKC_XLOAD_GUTS(op, i) _w[i] ^= op(_p + 4 * i) |
216 | #define BLKC_MOVE_GUTS(op, i) _w[i] = _wx[i] |
217 | #define BLKC_XMOVE_GUTS(op, i) _w[i] ^= _wx[i] |
5c3f75ec |
218 | #define BLKC_ZERO_GUTS(op, i) _w[i] = 0 |
d03ab969 |
219 | |
220 | #define BLKC_STORE_N(PRE, b, w, op, n) \ |
221 | BLKC_GLUE(BLKC_SKEL_, n) \ |
222 | (PRE, BLKC_P(b); const BLKC_W(w);, op, BLKC_STORE_GUTS) |
223 | |
224 | #define BLKC_XSTORE_N(PRE, b, w, wx, op, n) \ |
225 | BLKC_GLUE(BLKC_SKEL_, n) \ |
226 | (PRE, BLKC_P(b); const BLKC_W(w); const BLKC_WX(wx);, \ |
227 | op, BLKC_XSTORE_GUTS) |
228 | |
229 | #define BLKC_LOAD_N(PRE, w, b, op, n) \ |
230 | BLKC_GLUE(BLKC_SKEL_, n) \ |
231 | (PRE, const BLKC_P(b); BLKC_W(w);, op, BLKC_LOAD_GUTS) |
232 | |
233 | #define BLKC_XLOAD_N(PRE, w, b, op, n) \ |
234 | BLKC_GLUE(BLKC_SKEL_, n) \ |
235 | (PRE, const BLKC_P(b); BLKC_W(w);, op, BLKC_XLOAD_GUTS) |
236 | |
237 | #define BLKC_MOVE_N(PRE, w, wx, n) \ |
238 | BLKC_GLUE(BLKC_SKEL_, n) \ |
239 | (PRE, BLKC_W(w); const BLKC_WX(wx);, op, BLKC_MOVE_GUTS) |
240 | |
5c3f75ec |
241 | #define BLKC_ZERO_N(PRE, w, n) \ |
242 | BLKC_GLUE(BLKC_SKEL_, n) \ |
243 | (PRE, BLKC_W(w); , op, BLKC_ZERO_GUTS) |
244 | |
d03ab969 |
245 | #define BLKC_XMOVE_N(PRE, w, wx, n) \ |
246 | BLKC_GLUE(BLKC_SKEL_, n) \ |
247 | (PRE, BLKC_W(w); const BLKC_WX(wx);, op, BLKC_XMOVE_GUTS) |
248 | |
249 | /*----- Test rig for block ciphers ----------------------------------------*/ |
250 | |
251 | /* --- @BLKC_TEST@ --- * |
252 | * |
253 | * Arguments: @PRE@, @pre@ = prefixes for cipher-specific definitions |
254 | * |
255 | * Use: Standard test rig for block ciphers. |
256 | */ |
257 | |
258 | #ifdef TEST_RIG |
259 | |
260 | #include <mLib/quis.h> |
261 | #include <mLib/testrig.h> |
262 | |
dcdc42e7 |
263 | #define BLKC_VERIFY(PRE, pre) \ |
d03ab969 |
264 | \ |
dcdc42e7 |
265 | static int pre##_verify(dstr *v) \ |
d03ab969 |
266 | { \ |
b3f05084 |
267 | pre##_ctx k; \ |
268 | uint32 p[PRE##_BLKSZ / 4]; \ |
269 | uint32 c[PRE##_BLKSZ / 4]; \ |
270 | uint32 d[PRE##_BLKSZ / 4]; \ |
d03ab969 |
271 | dstr b = DSTR_INIT; \ |
272 | int ok = 1; \ |
273 | \ |
274 | /* --- Initialize the key buffer --- */ \ |
275 | \ |
b3f05084 |
276 | dstr_ensure(&b, PRE##_BLKSZ); \ |
277 | b.len = PRE##_BLKSZ; \ |
278 | pre##_init(&k, v[0].buf, v[0].len); \ |
d03ab969 |
279 | BLKC_LOAD(PRE, p, v[1].buf); \ |
280 | BLKC_LOAD(PRE, c, v[2].buf); \ |
281 | \ |
282 | /* --- Test encryption --- */ \ |
283 | \ |
284 | BLKC_MOVE(PRE, d, p); \ |
b3f05084 |
285 | pre##_eblk(&k, d, d); \ |
d03ab969 |
286 | BLKC_STORE(PRE, b.buf, d); \ |
b3f05084 |
287 | if (memcmp(b.buf, v[2].buf, PRE##_BLKSZ)) { \ |
d03ab969 |
288 | ok = 0; \ |
289 | printf("\nfail encryption:" \ |
290 | "\n\tkey = "); \ |
291 | type_hex.dump(&v[0], stdout); \ |
292 | printf("\n\tplaintext = "); type_hex.dump(&v[1], stdout); \ |
293 | printf("\n\texpected = "); type_hex.dump(&v[2], stdout); \ |
294 | printf("\n\tcalculated = "); type_hex.dump(&b, stdout); \ |
295 | putchar('\n'); \ |
296 | } \ |
297 | \ |
298 | /* --- Test decryption --- */ \ |
299 | \ |
300 | BLKC_MOVE(PRE, d, c); \ |
b3f05084 |
301 | pre##_dblk(&k, d, d); \ |
d03ab969 |
302 | BLKC_STORE(PRE, b.buf, d); \ |
b3f05084 |
303 | if (memcmp(b.buf, v[1].buf, PRE##_BLKSZ)) { \ |
d03ab969 |
304 | ok = 0; \ |
305 | printf("\nfail decryption:" \ |
306 | "\n\tkey = "); \ |
307 | type_hex.dump(&v[0], stdout); \ |
308 | printf("\n\tciphertext = "); type_hex.dump(&v[2], stdout); \ |
309 | printf("\n\texpected = "); type_hex.dump(&v[1], stdout); \ |
310 | printf("\n\tcalculated = "); type_hex.dump(&b, stdout); \ |
311 | putchar('\n'); \ |
312 | } \ |
313 | \ |
314 | /* --- Return --- */ \ |
315 | \ |
316 | return (ok); \ |
dcdc42e7 |
317 | } |
318 | |
319 | #define BLKC_TEST(PRE, pre) \ |
320 | \ |
321 | BLKC_VERIFY(PRE, pre) \ |
d03ab969 |
322 | \ |
4e66da02 |
323 | static const test_chunk defs[] = { \ |
dcdc42e7 |
324 | { #pre, pre##_verify, { &type_hex, &type_hex, &type_hex, 0 } }, \ |
d03ab969 |
325 | { 0, 0, { 0 } } \ |
326 | }; \ |
327 | \ |
328 | int main(int argc, char *argv[]) \ |
329 | { \ |
330 | test_run(argc, argv, defs, SRCDIR"/tests/" #pre); \ |
331 | return (0); \ |
332 | } |
333 | |
334 | #else |
dcdc42e7 |
335 | # define BLKC_VERIFY(PRE, pre) |
d03ab969 |
336 | # define BLKC_TEST(PRE, pre) |
337 | #endif |
338 | |
339 | /*----- That's all, folks -------------------------------------------------*/ |
340 | |
341 | #ifdef __cplusplus |
342 | } |
343 | #endif |
344 | |
345 | #endif |