Force subkeys to be sorted in structured keys.
[u/mdw/catacomb] / gmac.h
CommitLineData
aa1082f2 1/* -*-c-*-
2 *
59919ae4 3 * $Id: gmac.h,v 1.3 2004/04/04 19:42:30 mdw Exp $
aa1082f2 4 *
5 * Generic MAC function interface
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
30/*----- Revision history --------------------------------------------------*
31 *
32 * $Log: gmac.h,v $
59919ae4 33 * Revision 1.3 2004/04/04 19:42:30 mdw
34 * Make tables of standard encryption schemes etc.
35 *
05555229 36 * Revision 1.2 2000/06/17 11:22:46 mdw
37 * Minor changes in the generic hash and MAC interfaces.
38 *
aa1082f2 39 * Revision 1.1 1999/12/10 23:16:01 mdw
40 * Generic interface.
41 *
42 */
43
44#ifndef CATACOMB_GMAC_H
45#define CATACOMB_GMAC_H
46
47#ifdef __cplusplus
48 extern "C" {
49#endif
50
51/*----- Header files ------------------------------------------------------*/
52
53#include <stddef.h>
54
05555229 55#ifndef CATACOMB_GCIPHER_H
56# include "gcipher.h"
57#endif
58
aa1082f2 59#ifndef CATACOMB_GHASH_H
60# include "ghash.h"
61#endif
62
63/*----- Generic MAC function interface ------------------------------------*/
64
65typedef struct gmac {
66 const struct gmac_ops *ops; /* Pointer to MAC operations */
67} gmac;
68
69typedef struct gmac_ops {
05555229 70 const struct gcmac *c; /* Pointer to MAC class */
aa1082f2 71 ghash *(*init)(gmac */*m*/); /* Create keyed hash instance */
72 void (*destroy)(gmac */*m*/); /* Destroy MAC key block */
73} gmac_ops;
74
75typedef struct gcmac {
05555229 76 const char *name; /* Name of the MAC function */
77 size_t hashsz; /* Size of output hash */
78 const octet *keysz; /* Key size options */
aa1082f2 79 gmac *(*key)(const void */*k*/, size_t /*sz*/); /* Create key */
80} gcmac;
81
59919ae4 82#define GM_KEY(cm, k, ksz) (cm)->key((k), (ksz))
83#define GM_CLASS(km) (km)->ops->c
84#define GM_INIT(km) (km)->ops->init((km))
85#define GM_DESTROY(km) (km)->ops->destroy((km))
86
87/*----- Tables ------------------------------------------------------------*/
88
89extern const gcmac *const gmactab[];
90
91/* --- @gmac_byname@ --- *
92 *
93 * Arguments: @const char *p@ = pointer to name string
94 *
95 * Returns: The named cipher class, or null.
96 */
97
98extern const gcmac *gmac_byname(const char */*p*/);
99
aa1082f2 100/*----- That's all, folks -------------------------------------------------*/
101
102#ifdef __cplusplus
103 }
104#endif
105
106#endif