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

   1 /* -*-c-*-
   2  *
   3  * $Id: rmd128.h,v 1.2 2000/10/15 19:09:20 mdw Exp $
   4  *
   5  * The RIPEMD-128 message digest function
   6  *
   7  * (c) 1998 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: rmd128.h,v $
  33  * Revision 1.2  2000/10/15 19:09:20  mdw
  34  * Support HMAC mode for hash functions which need to store more state than
  35  * the hash output size.
  36  *
  37  * Revision 1.1  2000/07/09 21:30:31  mdw
  38  * New RIPEMD variants.
  39  *
  40  */
  41
  42 /*----- Notes on the RIPEMD-128 hash function -----------------------------*
  43  *
  44  * RIPEMD-128 was invented by Hans Dobbertin, Antoon Bosselaers and Bart
  45  * Preneel, as a drop-in replacement for MD5 (with the same sized output).
  46  * It's a cut-down version of RIPEMD-160, which should be used in preference.
  47  */
  48
  49 #ifndef CATACOMB_RMD128_H
  50 #define CATACOMB_RMD128_H
  51
  52 #ifdef __cplusplus
  53   extern "C" {
  54 #endif
  55
  56 /*----- Header files ------------------------------------------------------*/
  57
  58 #include <mLib/bits.h>
  59
  60 #ifndef CATACOMB_GHASH_H
  61 #  include "ghash.h"
  62 #endif
  63
  64 /*----- Magic numbers -----------------------------------------------------*/
  65
  66 #define RMD128_BUFSZ 64
  67 #define RMD128_HASHSZ 16
  68 #define RMD128_STATESZ 16
  69
  70 /*----- Data structures ---------------------------------------------------*/
  71
  72 typedef struct rmd128_ctx {
  73   uint32 a, b, c, d;                    /* Chaining variables */
  74   uint32 nl, nh;                        /* Byte count so far */
  75   unsigned off;                         /* Offset into buffer */
  76   octet buf[RMD128_BUFSZ];              /* Accumulation buffer */
  77 } rmd128_ctx;
  78
  79 /*----- Functions provided ------------------------------------------------*/
  80
  81 /* --- @rmd128_compress@ --- *
  82  *
  83  * Arguments:   @rmd128_ctx *ctx@ = pointer to context block
  84  *              @const void *sbuf@ = pointer to buffer of appropriate size
  85  *
  86  * Returns:     ---
  87  *
  88  * Use:         RIPEMD-128 compression function.
  89  */
  90
  91 extern void rmd128_compress(rmd128_ctx */*ctx*/, const void */*sbuf*/);
  92
  93 /* --- @rmd128_init@ --- *
  94  *
  95  * Arguments:   @rmd128_ctx *ctx@ = pointer to context block to initialize
  96  *
  97  * Returns:     ---
  98  *
  99  * Use:         Initializes a context block ready for hashing.
 100  */
 101
 102 extern void rmd128_init(rmd128_ctx */*ctx*/);
 103
 104 /* --- @rmd128_set@ --- *
 105  *
 106  * Arguments:   @rmd128_ctx *ctx@ = pointer to context block
 107  *              @const void *buf@ = pointer to state buffer
 108  *              @unsigned long count@ = current count of bytes processed
 109  *
 110  * Returns:     ---
 111  *
 112  * Use:         Initializes a context block from a given state.  This is
 113  *              useful in cases where the initial hash state is meant to be
 114  *              secret, e.g., for NMAC and HMAC support.
 115  */
 116
 117 extern void rmd128_set(rmd128_ctx */*ctx*/,
 118                        const void */*buf*/, unsigned long /*count*/);
 119
 120 /* --- @rmd128_hash@ --- *
 121  *
 122  * Arguments:   @rmd128_ctx *ctx@ = pointer to context block
 123  *              @const void *buf@ = buffer of data to hash
 124  *              @size_t sz@ = size of buffer to hash
 125  *
 126  * Returns:     ---
 127  *
 128  * Use:         Hashes a buffer of data.  The buffer may be of any size and
 129  *              alignment.
 130  */
 131
 132 extern void rmd128_hash(rmd128_ctx */*ctx*/,
 133                         const void */*buf*/, size_t /*sz*/);
 134
 135 /* --- @rmd128_done@ --- *
 136  *
 137  * Arguments:   @rmd128_ctx *ctx@ = pointer to context block
 138  *              @void *hash@ = pointer to output buffer
 139  *
 140  * Returns:     ---
 141  *
 142  * Use:         Returns the hash of the data read so far.
 143  */
 144
 145 extern void rmd128_done(rmd128_ctx */*ctx*/, void */*hash*/);
 146
 147 /* --- @rmd128_state@ --- *
 148  *
 149  * Arguments:   @rmd128_ctx *ctx@ = pointer to context
 150  *              @void *state@ = pointer to buffer for current state
 151  *
 152  * Returns:     Number of bytes written to the hash function so far.
 153  *
 154  * Use:         Returns the current state of the hash function such that
 155  *              it can be passed to @rmd128_set@.
 156  */
 157
 158 extern unsigned long rmd128_state(rmd128_ctx */*ctx*/, void */*state*/);
 159
 160 /*----- Generic hash interface --------------------------------------------*/
 161
 162 extern const gchash rmd128;
 163
 164 /*----- That's all, folks -------------------------------------------------*/
 165
 166 #ifdef __cplusplus
 167   }
 168 #endif
 169
 170 #endif