~mdw / catacomb / blob
? search:


e3f12ced6acc3100715452fd10ca972148a1e442
[catacomb] / symm / hmac-def.h
1 /* -*-c-*-
2 *
3 * Definitions for HMAC and NMAC
4 *
5 * (c) 1999 Straylight/Edgeware
6 */
7
8 /*----- Licensing notice --------------------------------------------------*
9 *
10 * This file is part of Catacomb.
11 *
12 * Catacomb is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Library General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
16 *
17 * Catacomb is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
21 *
22 * You should have received a copy of the GNU Library General Public
23 * License along with Catacomb; if not, write to the Free
24 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
25 * MA 02111-1307, USA.
26 */
27
28 #ifndef CATACOMB_HMAC_DEF_H
29 #define CATACOMB_HMAC_DEF_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 /*----- Header files ------------------------------------------------------*/
36
37 #include <assert.h>
38 #include <stdlib.h>
39 #include <string.h>
40
41 #include <mLib/bits.h>
42 #include <mLib/sub.h>
43
44 #ifndef CATACOMB_ARENA_H
45 # include "arena.h"
46 #endif
47
48 #ifndef CATACOMB_GMAC_H
49 # include "gmac.h"
50 #endif
51
52 #ifndef CATACOMB_PARANOIA_H
53 # include "paranoia.h"
54 #endif
55
56 /*----- Macros ------------------------------------------------------------*/
57
58 /* --- @HMAC_DEF@ --- *
59 *
60 * Arguments: @PRE@, @pre@ = prefixes for the underlying hash function
61 *
62 * Use: Creates implementations for the HMAC and NMAC functions.
63 */
64
65 #define HMAC_DEF(PRE, pre) HMAC_DEFX(PRE, pre, #pre, #pre)
66 #define HMAC_DEFX(PRE, pre, name, fname) \
67 \
68 /* --- Useful constants --- */ \
69 \
70 const octet pre##_hmackeysz[] = \
71 { KSZ_ANY | KSZ_16BIT, PRE##_STATESZ/256, PRE##_STATESZ%256 }; \
72 const octet pre##_sslmackeysz[] = \
73 { KSZ_ANY | KSZ_16BIT, PRE##_STATESZ/256, PRE##_STATESZ%256 }; \
74 const octet pre##_nmackeysz[] = \
75 { KSZ_SET | KSZ_16BIT, \
76 2*PRE##_STATESZ/256, 2*PRE##_STATESZ%256, 0, 0 }; \
77 \
78 /* --- @pre_nmacinit@ --- * \
79 * \
80 * Arguments: @pre_macctx *key@ = pointer to a MAC key object \
81 * @const void *ok@ = pointer to outer hash init vector \
82 * @const void *ik@ = pointer to inner hash init vector \
83 * \
84 * Returns: --- \
85 * \
86 * Use: Initializes a MAC key for doing NMAC hashing. \
87 */ \
88 \
89 void pre##_nmacinit(pre##_mackey *key, const void *ok, const void *ik) \
90 { \
91 memcpy(key->ochain, ok, PRE##_STATESZ); \
92 memcpy(key->ichain, ik, PRE##_STATESZ); \
93 key->ocount = key->icount = 0; \
94 } \
95 \
96 /* --- @pre_hmacinit@ --- * \
97 * \
98 * Arguments: @pre_mackey *key@ = pointer to MAC key object \
99 * @const void *k@ = pointer to key to use \
100 * @size_t sz@ = size of key data \
101 * \
102 * Returns: --- \
103 * \
104 * Use: Initializes a MAC key for doing HMAC hashing. Keys \
105 * longer than the hash function's output size aren't very \
106 * useful, but are accepted. Keys longer than the hash's \
107 * block size are also accepted; they are hashed before \
108 * use, as specified in RFC2104. \
109 */ \
110 \
111 void pre##_hmacinit(pre##_mackey *key, const void *k, size_t sz) \
112 { \
113 int i; \
114 const octet *kbuf = k; \
115 pre##_ctx ctx; \
116 octet hbuf[PRE##_HASHSZ], buf[PRE##_BUFSZ]; \
117 \
118 if (sz > PRE##_BUFSZ) { \
119 pre##_init(&ctx); \
120 pre##_hash(&ctx, k, sz); \
121 pre##_done(&ctx, hbuf); \
122 kbuf = hbuf; \
123 sz = PRE##_HASHSZ; \
124 } \
125 \
126 pre##_init(&ctx); \
127 memset(buf, 0x5c, PRE##_BUFSZ); \
128 for (i = 0; i < sz; i++) buf[i] ^= kbuf[i]; \
129 pre##_hash(&ctx, buf, PRE##_BUFSZ); \
130 key->ocount = pre##_state(&ctx, key->ochain); \
131 \
132 pre##_init(&ctx); \
133 memset(buf, 0x36, PRE##_BUFSZ); \
134 for (i = 0; i < sz; i++) buf[i] ^= kbuf[i]; \
135 pre##_hash(&ctx, buf, PRE##_BUFSZ); \
136 key->icount = pre##_state(&ctx, key->ichain); \
137 \
138 BURN(ctx); \
139 } \
140 \
141 /* --- @pre_sslmacinit@ --- * \
142 * \
143 * Arguments: @pre_mackey *key@ = pointer to MAC key object \
144 * @const void *k@ = pointer to key to use \
145 * @size_t sz@ = size of key data \
146 * \
147 * Returns: --- \
148 * \
149 * Use: Initializes a MAC key for doing hasing using the SSL3 \
150 * variant of HMAC. \
151 */ \
152 \
153 void pre##_sslmacinit(pre##_mackey *key, const void *k, size_t sz) \
154 { \
155 const octet *kbuf = k; \
156 pre##_ctx ctx; \
157 octet hbuf[PRE##_HASHSZ], buf[PRE##_BUFSZ]; \
158 \
159 if (sz > PRE##_BUFSZ) { \
160 pre##_init(&ctx); \
161 pre##_hash(&ctx, k, sz); \
162 pre##_done(&ctx, hbuf); \
163 kbuf = hbuf; \
164 sz = PRE##_HASHSZ; \
165 } \
166 \
167 pre##_init(&ctx); \
168 memcpy(buf, kbuf, sz); \
169 memset(buf + sz, 0x5c, PRE##_BUFSZ - sz); \
170 pre##_hash(&ctx, buf, PRE##_BUFSZ); \
171 key->ocount = pre##_state(&ctx, key->ochain); \
172 \
173 pre##_init(&ctx); \
174 memcpy(buf, kbuf, sz); \
175 memset(buf + sz, 0x36, PRE##_BUFSZ - sz); \
176 pre##_hash(&ctx, buf, PRE##_BUFSZ); \
177 key->icount = pre##_state(&ctx, key->ichain); \
178 \
179 BURN(ctx); \
180 } \
181 \
182 /* --- @pre_macinit@ --- * \
183 * \
184 * Arguments: @pre_macctx *ctx@ = pointer to MAC context block \
185 * @const pre_mackey *key@ = pointer to MAC key block \
186 * \
187 * Returns: --- \
188 * \
189 * Use: Instantiates a MAC context from a key block. \
190 */ \
191 \
192 void pre##_macinit(pre##_macctx *ctx, const pre##_mackey *key) \
193 { \
194 memcpy(ctx->chain, key->ochain, PRE##_STATESZ); \
195 ctx->count = key->ocount; \
196 pre##_set(&ctx->ctx, key->ichain, key->icount); \
197 } \
198 \
199 /* --- @pre_machash@ --- * \
200 * \
201 * Arguments: @pre_macctx *ctx@ = pointer to MAC context block \
202 * @const void *buf@ = pointer to buffer \
203 * @size_t sz@ = size of the buffer \
204 * \
205 * Returns: --- \
206 * \
207 * Use: Hashes a buffer. \
208 */ \
209 \
210 void pre##_machash(pre##_macctx *ctx, const void *buf, size_t sz) \
211 { pre##_hash(&ctx->ctx, buf, sz); } \
212 \
213 /* --- @pre_macdone@ --- * \
214 * \
215 * Arguments: @pre_macctx *ctx@ = pointer to MAC context block \
216 * @void *mac@ = pointer to buffer to receive MAC \
217 * \
218 * Returns: --- \
219 * \
220 * Use: Returns the result of a MAC computation. \
221 */ \
222 \
223 void pre##_macdone(pre##_macctx *ctx, void *mac) \
224 { \
225 pre##_done(&ctx->ctx, mac); \
226 pre##_set(&ctx->ctx, ctx->chain, ctx->count); \
227 pre##_hash(&ctx->ctx, mac, PRE##_HASHSZ); \
228 pre##_done(&ctx->ctx, mac); \
229 } \
230 \
231 /* --- Generic MAC interface --- */ \
232 \
233 static const gmac_ops gkops, gnkops, gsslkops; \
234 static const ghash_ops gops, gnops, gsslops; \
235 \
236 typedef struct gkctx { \
237 gmac m; \
238 const ghash_ops *gops; \
239 pre##_mackey k; \
240 } gkctx; \
241 \
242 typedef struct gctx { \
243 ghash h; \
244 pre##_macctx c; \
245 octet buf[PRE##_HASHSZ]; \
246 } gctx; \
247 \
248 static ghash *gkinit(gmac *m) \
249 { \
250 gkctx *gk = (gkctx *)m; \
251 gctx *g = S_CREATE(gctx); \
252 g->h.ops = gk->gops; \
253 pre##_macinit(&g->c, &gk->k); \
254 return (&g->h); \
255 } \
256 \
257 static gmac *gkey(const void *k, size_t sz) \
258 { \
259 gkctx *gk = S_CREATE(gkctx); \
260 gk->m.ops = &gkops; \
261 gk->gops = &gops; \
262 pre##_hmacinit(&gk->k, k, sz); \
263 return (&gk->m); \
264 } \
265 \
266 static gmac *gnkey(const void *k, size_t sz) \
267 { \
268 gkctx *gk = S_CREATE(gkctx); \
269 const octet *kk = k; \
270 assert(keysz(sz, pre##_nmackeysz) == sz); \
271 gk->m.ops = &gnkops; \
272 gk->gops = &gnops; \
273 pre##_nmacinit(&gk->k, kk, kk + PRE##_STATESZ); \
274 return (&gk->m); \
275 } \
276 \
277 static gmac *gsslkey(const void *k, size_t sz) \
278 { \
279 gkctx *gk = S_CREATE(gkctx); \
280 gk->m.ops = &gsslkops; \
281 gk->gops = &gsslops; \
282 pre##_sslmacinit(&gk->k, k, sz); \
283 return (&gk->m); \
284 } \
285 \
286 static void ghhash(ghash *h, const void *p, size_t sz) \
287 { \
288 gctx *g = (gctx *)h; \
289 pre##_machash(&g->c, p, sz); \
290 } \
291 \
292 static octet *ghdone(ghash *h, void *buf) \
293 { \
294 gctx *g = (gctx *)h; \
295 if (!buf) \
296 buf = g->buf; \
297 pre##_macdone(&g->c, buf); \
298 return (buf); \
299 } \
300 \
301 static ghash *ghcopy(ghash *h) \
302 { \
303 gctx *g = (gctx *)h; \
304 gctx *gg = S_CREATE(gctx); \
305 memcpy(gg, g, sizeof(gctx)); \
306 return (&gg->h); \
307 } \
308 \
309 static void ghdestroy(ghash *h) \
310 { \
311 gctx *g = (gctx *)h; \
312 BURN(*g); \
313 S_DESTROY(g); \
314 } \
315 \
316 static void gkdestroy(gmac *m) \
317 { \
318 gkctx *gk = (gkctx *)m; \
319 BURN(*gk); \
320 S_DESTROY(gk); \
321 } \
322 \
323 static ghash *ghinit(void) \
324 { \
325 assert(((void)"Attempt to instantiate an unkeyed MAC", 0)); \
326 return (0); \
327 } \
328 \
329 const gcmac pre##_nmac = \
330 { name "-nmac", PRE##_HASHSZ, pre##_nmackeysz, gnkey }; \
331 const gcmac pre##_hmac = \
332 { name "-hmac", PRE##_HASHSZ, pre##_hmackeysz, gkey }; \
333 const gcmac pre##_sslmac = \
334 { name "-sslmac", PRE##_HASHSZ, pre##_sslmackeysz, gsslkey }; \
335 static const gmac_ops gkops = { &pre##_hmac, gkinit, gkdestroy }; \
336 static const gmac_ops gnkops = { &pre##_nmac, gkinit, gkdestroy }; \
337 static const gmac_ops gsslkops = { &pre##_sslmac, gkinit, gkdestroy }; \
338 static const gchash gch = { name "-hmac", PRE##_HASHSZ, ghinit }; \
339 static const ghash_ops gops = \
340 { &gch, ghhash, ghdone, ghdestroy, ghcopy }; \
341 static const gchash gnch = { name "-nmac", PRE##_HASHSZ, ghinit }; \
342 static const ghash_ops gnops = \
343 { &gnch, ghhash, ghdone, ghdestroy, ghcopy }; \
344 static const gchash gsslch = { name "-sslmac", PRE##_HASHSZ, ghinit }; \
345 static const ghash_ops gsslops = \
346 { &gsslch, ghhash, ghdone, ghdestroy, ghcopy }; \
347 \
348 HMAC_TESTX(PRE, pre, name, fname)
349
350 #define HMAC_TEST(PRE, pre) HMAC_TESTX(PRE, pre, #pre, #pre)
351
352 /* --- @HMAC_TEST@ --- *
353 *
354 * Arguments: @PRE@, @pre@ = prefixes for hash-specfic definitions
355 *
356 * Use: Standard test rig for MAC functions.
357 */
358
359 #ifdef TEST_RIG
360
361 #include <stdio.h>
362
363 #include <mLib/dstr.h>
364 #include <mLib/quis.h>
365 #include <mLib/testrig.h>
366
367 #define HMAC_TESTX(PRE, pre, name, fname) \
368 \
369 static int macverify(dstr *v) \
370 { \
371 pre##_macctx cctx; \
372 pre##_mackey ckey; \
373 int ok = 1; \
374 int i; \
375 octet *p; \
376 int szs[] = { 1, 7, 192, -1, 0 }, *ip; \
377 size_t csz; \
378 dstr d; \
379 \
380 dstr_create(&d); \
381 dstr_ensure(&d, PRE##_HASHSZ); \
382 d.len = PRE##_HASHSZ; \
383 \
384 pre##_hmacinit(&ckey, v[1].buf, v[1].len); \
385 \
386 for (ip = szs; *ip; ip++) { \
387 i = *ip; \
388 csz = v[0].len; \
389 if (i == -1) \
390 i = csz; \
391 if (i > csz) \
392 continue; \
393 p = (octet *)v[0].buf; \
394 pre##_macinit(&cctx, &ckey); \
395 while (csz) { \
396 if (i > csz) \
397 i = csz; \
398 pre##_machash(&cctx, p, i); \
399 p += i; \
400 csz -= i; \
401 } \
402 pre##_macdone(&cctx, d.buf); \
403 if (memcmp(d.buf, v[2].buf, PRE##_HASHSZ) != 0) { \
404 printf("\nfail:\n\tstep = %i\n\tinput = `%s'\n\tkey = ", \
405 *ip, v[0].buf); \
406 type_hex.dump(&v[1], stdout); \
407 fputs("\n\texpected = ", stdout); \
408 type_hex.dump(&v[2], stdout); \
409 fputs("\n\tcomputed = ", stdout); \
410 type_hex.dump(&d, stdout); \
411 putchar('\n'); \
412 ok = 0; \
413 } \
414 } \
415 \
416 dstr_destroy(&d); \
417 return (ok); \
418 } \
419 \
420 static test_chunk macdefs[] = { \
421 { name "-hmac", macverify, \
422 { &type_string, &type_hex, &type_hex, 0 } }, \
423 { 0, 0, { 0 } } \
424 }; \
425 \
426 int main(int argc, char *argv[]) \
427 { \
428 ego(argv[0]); \
429 test_run(argc, argv, macdefs, SRCDIR"/t/" fname); \
430 return (0); \
431 }
432
433 #else
434 # define HMAC_TESTX(PRE, pre, name, fname)
435 #endif
436
437 /*----- That's all, folks -------------------------------------------------*/
438
439 #ifdef __cplusplus
440 }
441 #endif
442
443 #endif
Catacomb cryptographic library