chiark - git - mdw - catacomb/blob - rmd160.h

   1 /* -*-c-*-
   2  *
   3  * $Id: rmd160.h,v 1.5 2004/04/08 01:36:15 mdw Exp $
   4  *
   5  * The RIPEMD-160 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 /*----- Notes on the RIPEMD-160 hash function -----------------------------*
  31  *
  32  * RIPEMD-160 was invented by Hans Dobbertin, Antoon Bosselaers and Bart
  33  * Preneel.  It's a strengthened version of the original RIPEMD hash
  34  * function, fixing a vulnerability discovered by Hans Dobbertin.  The
  35  * RIPEMD-160 design team appears well respected in the cryptographic
  36  * community.  The author finds them more plausible than SHA-1, which is the
  37  * best alternative hash function.
  38  */
  39
  40 #ifndef CATACOMB_RMD160_H
  41 #define CATACOMB_RMD160_H
  42
  43 #ifdef __cplusplus
  44   extern "C" {
  45 #endif
  46
  47 /*----- Header files ------------------------------------------------------*/
  48
  49 #include <mLib/bits.h>
  50
  51 #ifndef CATACOMB_GHASH_H
  52 #  include "ghash.h"
  53 #endif
  54
  55 /*----- Magic numbers -----------------------------------------------------*/
  56
  57 #define RMD160_BUFSZ 64
  58 #define RMD160_HASHSZ 20
  59 #define RMD160_STATESZ 20
  60
  61 /*----- Data structures ---------------------------------------------------*/
  62
  63 typedef struct rmd160_ctx {
  64   uint32 a, b, c, d, e;                 /* Chaining variables */
  65   uint32 nl, nh;                        /* Byte count so far */
  66   unsigned off;                         /* Offset into buffer */
  67   octet buf[RMD160_BUFSZ];              /* Accumulation buffer */
  68 } rmd160_ctx;
  69
  70 /*----- Functions provided ------------------------------------------------*/
  71
  72 /* --- @rmd160_compress@ --- *
  73  *
  74  * Arguments:   @rmd160_ctx *ctx@ = pointer to context block
  75  *              @const void *sbuf@ = pointer to buffer of appropriate size
  76  *
  77  * Returns:     ---
  78  *
  79  * Use:         RIPEMD-160 compression function.
  80  */
  81
  82 extern void rmd160_compress(rmd160_ctx */*ctx*/, const void */*sbuf*/);
  83
  84 /* --- @rmd160_init@ --- *
  85  *
  86  * Arguments:   @rmd160_ctx *ctx@ = pointer to context block to initialize
  87  *
  88  * Returns:     ---
  89  *
  90  * Use:         Initializes a context block ready for hashing.
  91  */
  92
  93 extern void rmd160_init(rmd160_ctx */*ctx*/);
  94
  95 /* --- @rmd160_set@ --- *
  96  *
  97  * Arguments:   @rmd160_ctx *ctx@ = pointer to context block
  98  *              @const void *buf@ = pointer to state buffer
  99  *              @unsigned long count@ = current count of bytes processed
 100  *
 101  * Returns:     ---
 102  *
 103  * Use:         Initializes a context block from a given state.  This is
 104  *              useful in cases where the initial hash state is meant to be
 105  *              secret, e.g., for NMAC and HMAC support.
 106  */
 107
 108 extern void rmd160_set(rmd160_ctx */*ctx*/,
 109                        const void */*buf*/, unsigned long /*count*/);
 110
 111 /* --- @rmd160_hash@ --- *
 112  *
 113  * Arguments:   @rmd160_ctx *ctx@ = pointer to context block
 114  *              @const void *buf@ = buffer of data to hash
 115  *              @size_t sz@ = size of buffer to hash
 116  *
 117  * Returns:     ---
 118  *
 119  * Use:         Hashes a buffer of data.  The buffer may be of any size and
 120  *              alignment.
 121  */
 122
 123 extern void rmd160_hash(rmd160_ctx */*ctx*/,
 124                         const void */*buf*/, size_t /*sz*/);
 125
 126 /* --- @rmd160_done@ --- *
 127  *
 128  * Arguments:   @rmd160_ctx *ctx@ = pointer to context block
 129  *              @void *hash@ = pointer to output buffer
 130  *
 131  * Returns:     ---
 132  *
 133  * Use:         Returns the hash of the data read so far.
 134  */
 135
 136 extern void rmd160_done(rmd160_ctx */*ctx*/, void */*hash*/);
 137
 138 /* --- @rmd160_state@ --- *
 139  *
 140  * Arguments:   @rmd160_ctx *ctx@ = pointer to context
 141  *              @void *state@ = pointer to buffer for current state
 142  *
 143  * Returns:     Number of bytes written to the hash function so far.
 144  *
 145  * Use:         Returns the current state of the hash function such that
 146  *              it can be passed to @rmd160_set@.
 147  */
 148
 149 extern unsigned long rmd160_state(rmd160_ctx */*ctx*/, void */*state*/);
 150
 151 /*----- Generic hash interface --------------------------------------------*/
 152
 153 extern const gchash rmd160;
 154
 155 /*----- That's all, folks -------------------------------------------------*/
 156
 157 #ifdef __cplusplus
 158   }
 159 #endif
 160
 161 #endif