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

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