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

   1 /* -*-c-*-
   2  *
   3  * $Id: rmd256.h,v 1.3 2004/04/08 01:36:15 mdw Exp $
   4  *
   5  * The RIPEMD-256 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-256 hash function -----------------------------*
  31  *
  32  * RIPEMD-256 was invented by Hans Dobbertin, Antoon Bosselaers and Bart
  33  * Preneel.  It's a double-width version of RIPEMD-128, constructed simply by
  34  * not gluing together the two parallel computations which RIPEMD-128 usually
  35  * does in its compression function.  The authors warn that, while its output
  36  * is twice as wide as that of RIPEMD-128, they don't expect it to offer any
  37  * more security.
  38  */
  39
  40 #ifndef CATACOMB_RMD256_H
  41 #define CATACOMB_RMD256_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 RMD256_BUFSZ 64
  58 #define RMD256_HASHSZ 32
  59 #define RMD256_STATESZ 32
  60
  61 /*----- Data structures ---------------------------------------------------*/
  62
  63 typedef struct rmd256_ctx {
  64   uint32 a, b, c, d;                    /* Chaining variables */
  65   uint32 A, B, C, D;                    /* More chaining variables */
  66   uint32 nl, nh;                        /* Byte count so far */
  67   unsigned off;                         /* Offset into buffer */
  68   octet buf[RMD256_BUFSZ];              /* Accumulation buffer */
  69 } rmd256_ctx;
  70
  71 /*----- Functions provided ------------------------------------------------*/
  72
  73 /* --- @rmd256_compress@ --- *
  74  *
  75  * Arguments:   @rmd256_ctx *ctx@ = pointer to context block
  76  *              @const void *sbuf@ = pointer to buffer of appropriate size
  77  *
  78  * Returns:     ---
  79  *
  80  * Use:         RIPEMD-256 compression function.
  81  */
  82
  83 extern void rmd256_compress(rmd256_ctx */*ctx*/, const void */*sbuf*/);
  84
  85 /* --- @rmd256_init@ --- *
  86  *
  87  * Arguments:   @rmd256_ctx *ctx@ = pointer to context block to initialize
  88  *
  89  * Returns:     ---
  90  *
  91  * Use:         Initializes a context block ready for hashing.
  92  */
  93
  94 extern void rmd256_init(rmd256_ctx */*ctx*/);
  95
  96 /* --- @rmd256_set@ --- *
  97  *
  98  * Arguments:   @rmd256_ctx *ctx@ = pointer to context block
  99  *              @const void *buf@ = pointer to state buffer
 100  *              @unsigned long count@ = current count of bytes processed
 101  *
 102  * Returns:     ---
 103  *
 104  * Use:         Initializes a context block from a given state.  This is
 105  *              useful in cases where the initial hash state is meant to be
 106  *              secret, e.g., for NMAC and HMAC support.
 107  */
 108
 109 extern void rmd256_set(rmd256_ctx */*ctx*/,
 110                        const void */*buf*/, unsigned long /*count*/);
 111
 112 /* --- @rmd256_hash@ --- *
 113  *
 114  * Arguments:   @rmd256_ctx *ctx@ = pointer to context block
 115  *              @const void *buf@ = buffer of data to hash
 116  *              @size_t sz@ = size of buffer to hash
 117  *
 118  * Returns:     ---
 119  *
 120  * Use:         Hashes a buffer of data.  The buffer may be of any size and
 121  *              alignment.
 122  */
 123
 124 extern void rmd256_hash(rmd256_ctx */*ctx*/,
 125                         const void */*buf*/, size_t /*sz*/);
 126
 127 /* --- @rmd256_done@ --- *
 128  *
 129  * Arguments:   @rmd256_ctx *ctx@ = pointer to context block
 130  *              @void *hash@ = pointer to output buffer
 131  *
 132  * Returns:     ---
 133  *
 134  * Use:         Returns the hash of the data read so far.
 135  */
 136
 137 extern void rmd256_done(rmd256_ctx */*ctx*/, void */*hash*/);
 138
 139 /* --- @rmd256_state@ --- *
 140  *
 141  * Arguments:   @rmd256_ctx *ctx@ = pointer to context
 142  *              @void *state@ = pointer to buffer for current state
 143  *
 144  * Returns:     Number of bytes written to the hash function so far.
 145  *
 146  * Use:         Returns the current state of the hash function such that
 147  *              it can be passed to @rmd256_set@.
 148  */
 149
 150 extern unsigned long rmd256_state(rmd256_ctx */*ctx*/, void */*state*/);
 151
 152 /*----- Generic hash interface --------------------------------------------*/
 153
 154 extern const gchash rmd256;
 155
 156 /*----- That's all, folks -------------------------------------------------*/
 157
 158 #ifdef __cplusplus
 159   }
 160 #endif
 161
 162 #endif