5 * Common definitions for block ciphers
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
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.
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.
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,
30 #ifndef CATACOMB_BLKC_H
31 #define CATACOMB_BLKC_H
37 /*----- Header files ------------------------------------------------------*/
41 #include <mLib/bits.h>
43 /*----- Theory of operation -----------------------------------------------*
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.
52 /*----- Data movement macros ----------------------------------------------*/
55 * `The C preprocessor. You will never find a more wretched hive of bogus
56 * hackery. We must be cautious.'
59 /* --- General dispatch macros --- */
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
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)
71 #define BLKC_STORE_E(PRE) BLKC_GLUE(STORE32_, BLKC_ENDIAN(PRE))
72 #define BLKC_LOAD_E(PRE) BLKC_GLUE(LOAD32_, BLKC_ENDIAN(PRE))
74 /* --- Interface macros --- */
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))
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))
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))
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))
92 #define BLKC_MOVE(PRE, w, wx) \
93 BLKC_GLUE(BLKC_MOVE_, BLKC_TYPE(PRE)) \
94 (PRE, w, wx, BLKC_BITS(PRE))
96 #define BLKC_XMOVE(PRE, w, wx) \
97 BLKC_GLUE(BLKC_XMOVE_, BLKC_TYPE(PRE)) \
98 (PRE, w, wx, BLKC_BITS(PRE))
100 #define BLKC_STEP(PRE, w) \
101 BLKC_GLUE(BLKC_STEP_X_, BLKC_ENDIAN(PRE)) \
104 #define BLKC_ZERO(PRE, w) \
105 BLKC_GLUE(BLKC_ZERO_, BLKC_TYPE(PRE)) \
106 (PRE, w, BLKC_BITS(PRE))
108 #define BLKC_SET(PRE, w, x) \
109 BLKC_GLUE(BLKC_SET_X_, BLKC_ENDIAN(PRE)) \
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); \
118 /* --- General implementation skeleton --- */
120 #define BLKC_SKEL(PRE, decl, guts) do { \
125 #define BLKC_P(p) register octet *_p = (octet *)(p)
126 #define BLKC_W(w) register uint32 *_w = (w)
127 #define BLKC_WX(wx) register uint32 *_wx = (wx)
129 /* --- Implementation for unusual block sizes --- */
131 #define BLKC_SKEL_X(PRE, decl, guts) \
132 BLKC_SKEL(PRE, unsigned _i; decl, \
133 for (_i = 0; _i < PRE##_BLKSZ / 4; _i++) { \
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++; )
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++; )
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++; )
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++; )
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++; ) \
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++; ) \
161 #define BLKC_ZERO_X(PRE, w, n) \
162 BLKC_SKEL_X(PRE, BLKC_W(w);, *_w++ = 0;)
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); } \
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++; } \
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++) { \
179 _x = ((_x & ~MASK32) >> 16) >> 16; \
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++) { \
187 _x = ((_x & ~MASK32) >> 16) >> 16; \
191 /* --- Implementation for known block sizes --- */
193 #define BLKC_SKEL_64(PRE, decl, op, guts) \
194 BLKC_SKEL(PRE, decl, guts(op, 0); guts(op, 1);)
196 #define BLKC_SKEL_96(PRE, decl, op, guts) \
197 BLKC_SKEL(PRE, decl, guts(op, 0); guts(op, 1); guts(op, 2);)
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);)
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);)
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);)
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]
218 #define BLKC_ZERO_GUTS(op, i) _w[i] = 0
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)
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)
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)
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)
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)
241 #define BLKC_ZERO_N(PRE, w, n) \
242 BLKC_GLUE(BLKC_SKEL_, n) \
243 (PRE, BLKC_W(w); , op, BLKC_ZERO_GUTS)
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)
249 /*----- Test rig for block ciphers ----------------------------------------*/
251 /* --- @BLKC_TEST@ --- *
253 * Arguments: @PRE@, @pre@ = prefixes for cipher-specific definitions
255 * Use: Standard test rig for block ciphers.
262 #include <mLib/quis.h>
263 #include <mLib/testrig.h>
265 #define BLKC_VERIFY(PRE, pre) \
267 static int pre##_verify(dstr *v) \
270 uint32 p[PRE##_BLKSZ / 4]; \
271 uint32 c[PRE##_BLKSZ / 4]; \
272 uint32 d[PRE##_BLKSZ / 4]; \
273 dstr b = DSTR_INIT; \
276 /* --- Initialize the key buffer --- */ \
278 dstr_ensure(&b, PRE##_BLKSZ); \
279 b.len = PRE##_BLKSZ; \
280 pre##_init(&k, v[0].buf, v[0].len); \
281 BLKC_LOAD(PRE, p, v[1].buf); \
282 BLKC_LOAD(PRE, c, v[2].buf); \
284 /* --- Test encryption --- */ \
286 BLKC_MOVE(PRE, d, p); \
287 pre##_eblk(&k, d, d); \
288 BLKC_STORE(PRE, b.buf, d); \
289 if (memcmp(b.buf, v[2].buf, PRE##_BLKSZ)) { \
291 printf("\nfail encryption:" \
293 type_hex.dump(&v[0], stdout); \
294 printf("\n\tplaintext = "); type_hex.dump(&v[1], stdout); \
295 printf("\n\texpected = "); type_hex.dump(&v[2], stdout); \
296 printf("\n\tcalculated = "); type_hex.dump(&b, stdout); \
300 /* --- Test decryption --- */ \
302 BLKC_MOVE(PRE, d, c); \
303 pre##_dblk(&k, d, d); \
304 BLKC_STORE(PRE, b.buf, d); \
305 if (memcmp(b.buf, v[1].buf, PRE##_BLKSZ)) { \
307 printf("\nfail decryption:" \
309 type_hex.dump(&v[0], stdout); \
310 printf("\n\tciphertext = "); type_hex.dump(&v[2], stdout); \
311 printf("\n\texpected = "); type_hex.dump(&v[1], stdout); \
312 printf("\n\tcalculated = "); type_hex.dump(&b, stdout); \
316 /* --- Return --- */ \
321 #define BLKC_TEST(PRE, pre) \
323 BLKC_VERIFY(PRE, pre) \
325 static const test_chunk defs[] = { \
326 { #pre, pre##_verify, { &type_hex, &type_hex, &type_hex, 0 } }, \
330 int main(int argc, char *argv[]) \
332 test_run(argc, argv, defs, SRCDIR"/tests/" #pre); \
337 # define BLKC_VERIFY(PRE, pre)
338 # define BLKC_TEST(PRE, pre)
341 /*----- That's all, folks -------------------------------------------------*/