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

   1 /* -*-c-*-
   2  *
   3  * $Id: rmd320.h,v 1.1 2000/07/09 21:30:31 mdw Exp $
   4  *
   5  * The RIPEMD-320 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: rmd320.h,v $
  33  * Revision 1.1  2000/07/09 21:30:31  mdw
  34  * New RIPEMD variants.
  35  *
  36  */
  37
  38 /*----- Notes on the RIPEMD-320 hash function -----------------------------*
  39  *
  40  * RIPEMD-320 was invented by Hans Dobbertin, Antoon Bosselaers and Bart
  41  * Preneel.  It's a double-width version of RIPEMD-160, constructed simply by
  42  * not gluing together the two parallel computations which RIPEMD-160 usually
  43  * does in its compression function.  The authors warn that, while its output
  44  * is twice as wide as that of RIPEMD-160, they don't expect it to offer any
  45  * more security.
  46  */
  47
  48 #ifndef CATACOMB_RMD320_H
  49 #define CATACOMB_RMD320_H
  50
  51 #ifdef __cplusplus
  52   extern "C" {
  53 #endif
  54
  55 /*----- Header files ------------------------------------------------------*/
  56
  57 #include <mLib/bits.h>
  58
  59 #ifndef CATACOMB_GHASH_H
  60 #  include "ghash.h"
  61 #endif
  62
  63 /*----- Magic numbers -----------------------------------------------------*/
  64
  65 #define RMD320_BUFSZ 64
  66 #define RMD320_HASHSZ 40
  67
  68 /*----- Data structures ---------------------------------------------------*/
  69
  70 typedef struct rmd320_ctx {
  71   uint32 a, b, c, d, e;                 /* Chaining variables */
  72   uint32 A, B, C, D, E;                 /* More chaining variables */
  73   uint32 nl, nh;                        /* Byte count so far */
  74   unsigned off;                         /* Offset into buffer */
  75   octet buf[RMD320_BUFSZ];              /* Accumulation buffer */
  76 } rmd320_ctx;
  77
  78 /*----- Functions provided ------------------------------------------------*/
  79
  80 /* --- @rmd320_compress@ --- *
  81  *
  82  * Arguments:   @rmd320_ctx *ctx@ = pointer to context block
  83  *              @const void *sbuf@ = pointer to buffer of appropriate size
  84  *
  85  * Returns:     ---
  86  *
  87  * Use:         RIPEMD-320 compression function.
  88  */
  89
  90 extern void rmd320_compress(rmd320_ctx */*ctx*/, const void */*sbuf*/);
  91
  92 /* --- @rmd320_init@ --- *
  93  *
  94  * Arguments:   @rmd320_ctx *ctx@ = pointer to context block to initialize
  95  *
  96  * Returns:     ---
  97  *
  98  * Use:         Initializes a context block ready for hashing.
  99  */
 100
 101 extern void rmd320_init(rmd320_ctx */*ctx*/);
 102
 103 /* --- @rmd320_set@ --- *
 104  *
 105  * Arguments:   @rmd320_ctx *ctx@ = pointer to context block
 106  *              @const void *buf@ = pointer to state buffer
 107  *              @unsigned long count@ = current count of bytes processed
 108  *
 109  * Returns:     ---
 110  *
 111  * Use:         Initializes a context block from a given state.  This is
 112  *              useful in cases where the initial hash state is meant to be
 113  *              secret, e.g., for NMAC and HMAC support.
 114  */
 115
 116 extern void rmd320_set(rmd320_ctx */*ctx*/,
 117                        const void */*buf*/, unsigned long /*count*/);
 118
 119 /* --- @rmd320_hash@ --- *
 120  *
 121  * Arguments:   @rmd320_ctx *ctx@ = pointer to context block
 122  *              @const void *buf@ = buffer of data to hash
 123  *              @size_t sz@ = size of buffer to hash
 124  *
 125  * Returns:     ---
 126  *
 127  * Use:         Hashes a buffer of data.  The buffer may be of any size and
 128  *              alignment.
 129  */
 130
 131 extern void rmd320_hash(rmd320_ctx */*ctx*/,
 132                         const void */*buf*/, size_t /*sz*/);
 133
 134 /* --- @rmd320_done@ --- *
 135  *
 136  * Arguments:   @rmd320_ctx *ctx@ = pointer to context block
 137  *              @void *hash@ = pointer to output buffer
 138  *
 139  * Returns:     ---
 140  *
 141  * Use:         Returns the hash of the data read so far.
 142  */
 143
 144 extern void rmd320_done(rmd320_ctx */*ctx*/, void */*hash*/);
 145
 146 /* --- @rmd320_state@ --- *
 147  *
 148  * Arguments:   @rmd320_ctx *ctx@ = pointer to context
 149  *              @void *state@ = pointer to buffer for current state
 150  *
 151  * Returns:     Number of bytes written to the hash function so far.
 152  *
 153  * Use:         Returns the current state of the hash function such that
 154  *              it can be passed to @rmd320_set@.
 155  */
 156
 157 extern unsigned long rmd320_state(rmd320_ctx */*ctx*/, void */*state*/);
 158
 159 /*----- Generic hash interface --------------------------------------------*/
 160
 161 extern const gchash rmd320;
 162
 163 /*----- That's all, folks -------------------------------------------------*/
 164
 165 #ifdef __cplusplus
 166   }
 167 #endif
 168
 169 #endif