git.distorted.org.uk Git - u/mdw/catacomb/blob - ghash.h

   1 /* -*-c-*-
   2  *
   3  * $Id: ghash.h,v 1.7 2004/04/08 01:36:15 mdw Exp $
   4  *
   5  * Generic hash 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 #ifndef CATACOMB_GHASH_H
  31 #define CATACOMB_GHASH_H
  32
  33 #ifdef __cplusplus
  34   extern "C" {
  35 #endif
  36
  37 /*----- Header files ------------------------------------------------------*/
  38
  39 #include <stddef.h>
  40
  41 #include <mLib/bits.h>
  42
  43 /*----- Generic hash function interface -----------------------------------*/
  44
  45 typedef struct ghash {
  46   const struct ghash_ops *ops;          /* Pointer to hash operations */
  47 } ghash;
  48
  49 typedef struct ghash_ops {
  50   const struct gchash *c;               /* Pointer to hash class */
  51   void (*hash)(ghash */*h*/, const void */*p*/, size_t /*sz*/); /* Hash */
  52   octet *(*done)(ghash */*h*/, void */*buf*/); /* Write result */
  53   void (*destroy)(ghash */*h*/);        /* Destroy hash block */
  54   ghash *(*copy)(ghash */*h*/);         /* Make a copy of the hash context */
  55 } ghash_ops;
  56
  57 #define GH_INIT(ch)             (ch)->init()
  58 #define GH_CLASS(h)             (h)->ops->c
  59 #define GH_HASH(h, p, sz)       (h)->ops->hash((h), (p), (sz))
  60 #define GH_DONE(h, buf)         (h)->ops->done((h), (buf))
  61 #define GH_DESTROY(h)           (h)->ops->destroy((h))
  62 #define GH_COPY(h)              (h)->ops->copy((h))
  63
  64 typedef struct gchash {
  65   const char *name;                     /* Name of the hash function */
  66   size_t hashsz;                        /* Size of output hash */
  67   ghash *(*init)(void);                 /* Create a new hash instance */
  68   size_t bufsz;                         /* Buffer size, or zero */
  69 } gchash;
  70
  71 /*----- Tables ------------------------------------------------------------*/
  72
  73 extern const gchash *const ghashtab[];
  74
  75 /* --- @ghash_byname@ --- *
  76  *
  77  * Arguments:   @const char *p@ = pointer to name string
  78  *
  79  * Returns:     The named cipher class, or null.
  80  */
  81
  82 extern const gchash *ghash_byname(const char */*p*/);
  83
  84 /*----- That's all, folks -------------------------------------------------*/
  85
  86 #ifdef __cplusplus
  87   }
  88 #endif
  89
  90 #endif