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

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