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

   1 /* -*-c-*-
   2  *
   3  * $Id$
   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 #define GH_HASHU_(h, n, w)  do {                                        \
  65   unsigned long n_ = (n); octet b_[SZ_##w];                             \
  66   STORE##w(b_, n_); GH_HASH((h), b_, SZ_##w);                           \
  67 } while (0)
  68 #define GH_HASHU8(h, n)  GH_HASHU_((h), (n), 8)
  69 #define GH_HASHU16(h, n) GH_HASHU_((h), (n), 16)
  70 #define GH_HASHU16_B(h, n) GH_HASHU_((h), (n), 16_B)
  71 #define GH_HASHU16_L(h, n) GH_HASHU_((h), (n), 16_L)
  72 #define GH_HASHU24(h, n) GH_HASHU_((h), (n), 24)
  73 #define GH_HASHU24_B(h, n) GH_HASHU_((h), (n), 24_B)
  74 #define GH_HASHU24_L(h, n) GH_HASHU_((h), (n), 24_L)
  75 #define GH_HASHU32(h, n) GH_HASHU_((h), (n), 32)
  76 #define GH_HASHU32_B(h, n) GH_HASHU_((h), (n), 32_B)
  77 #define GH_HASHU32_L(h, n) GH_HASHU_((h), (n), 32_L)
  78
  79 #define GH_HASHBUF_(h, p, sz, w) do {                                   \
  80   size_t sz_ = (sz); assert(sz_ <= MASK##w);                            \
  81   GH_HASHU_(h, sz_, w); GH_HASH(h, (p), sz_);                           \
  82 } while (0)
  83 #define GH_HASHBUF8(h, p, sz) GH_HASHBUF_((h), (p), (sz), 8)
  84 #define GH_HASHBUF16(h, p, sz) GH_HASHBUF_((h), (p), (sz), 16)
  85 #define GH_HASHBUF16_L(h, p, sz) GH_HASHBUF_((h), (p), (sz), 16_L)
  86 #define GH_HASHBUF16_B(h, p, sz) GH_HASHBUF_((h), (p), (sz), 16_B)
  87 #define GH_HASHBUF24(h, p, sz) GH_HASHBUF_((h), (p), (sz), 24)
  88 #define GH_HASHBUF24_L(h, p, sz) GH_HASHBUF_((h), (p), (sz), 24_L)
  89 #define GH_HASHBUF24_B(h, p, sz) GH_HASHBUF_((h), (p), (sz), 24_B)
  90 #define GH_HASHBUF32(h, p, sz) GH_HASHBUF_((h), (p), (sz), 32)
  91 #define GH_HASHBUF32_L(h, p, sz) GH_HASHBUF_((h), (p), (sz), 32_L)
  92 #define GH_HASHBUF32_B(h, p, sz) GH_HASHBUF_((h), (p), (sz), 32_B)
  93
  94 #define GH_HASHSTR_(h, p, w) do {                                       \
  95   const char *p_ = (p); GH_HASHBUF_((h), p_, strlen(p_), w);            \
  96 } while (0)
  97 #define GH_HASHSTR8(h, p) GH_HASHSTR_((h), (p), 8)
  98 #define GH_HASHSTR16(h, p) GH_HASHSTR_((h), (p), 16)
  99 #define GH_HASHSTR16_L(h, p) GH_HASHSTR_((h), (p), 16_L)
 100 #define GH_HASHSTR16_B(h, p) GH_HASHSTR_((h), (p), 16_B)
 101 #define GH_HASHSTR24(h, p) GH_HASHSTR_((h), (p), 24)
 102 #define GH_HASHSTR24_L(h, p) GH_HASHSTR_((h), (p), 24_L)
 103 #define GH_HASHSTR24_B(h, p) GH_HASHSTR_((h), (p), 24_B)
 104 #define GH_HASHSTR32(h, p) GH_HASHSTR_((h), (p), 32)
 105 #define GH_HASHSTR32_L(h, p) GH_HASHSTR_((h), (p), 32_L)
 106 #define GH_HASHSTR32_B(h, p) GH_HASHSTR_((h), (p), 32_B)
 107
 108 #define GH_HASHSTRZ(h, p) do {                                          \
 109   const char *p_ = (p); GH_HASH((h), p_, strlen(p_) + 1);               \
 110 } while (0)
 111 #define GH_HASHSTR(h, p) do {                                           \
 112   const char *p_ = (p); GH_HASH((h), p_, strlen(p_));                   \
 113 } while (0)
 114
 115 typedef struct gchash {
 116   const char *name;                     /* Name of the hash function */
 117   size_t hashsz;                        /* Size of output hash */
 118   ghash *(*init)(void);                 /* Create a new hash instance */
 119   size_t bufsz;                         /* Buffer size, or zero */
 120 } gchash;
 121
 122 /*----- Tables ------------------------------------------------------------*/
 123
 124 extern const gchash *const ghashtab[];
 125
 126 /* --- @ghash_byname@ --- *
 127  *
 128  * Arguments:   @const char *p@ = pointer to name string
 129  *
 130  * Returns:     The named cipher class, or null.
 131  */
 132
 133 extern const gchash *ghash_byname(const char */*p*/);
 134
 135 /*----- That's all, folks -------------------------------------------------*/
 136
 137 #ifdef __cplusplus
 138   }
 139 #endif
 140
 141 #endif