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

   1 /* -*-c-*-
   2  *
   3  * $Id: md4.h,v 1.1 1999/09/03 08:41:12 mdw Exp $
   4  *
   5  * The MD4 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: md4.h,v $
  33  * Revision 1.1  1999/09/03 08:41:12  mdw
  34  * Initial import.
  35  *
  36  */
  37
  38 /*----- Notes on the MD4 hash function ------------------------------------*
  39  *
  40  * MD4 was designed by Ron Rivest.  It's now well and truly broken: not only
  41  * have collisions been discovered, a slightly cut-down version has been
  42  * shown to be non-preimage-resistant.  On the other hand, MD4 is fast and
  43  * makes a good heavy-duty checksum.  Just don't rely on it being
  44  * cryptographically strong, 'cos it ain't.
  45  */
  46
  47 #ifndef MD4_H
  48 #define MD4_H
  49
  50 #ifdef __cplusplus
  51   extern "C" {
  52 #endif
  53
  54 /*----- Header files ------------------------------------------------------*/
  55
  56 #include <mLib/bits.h>
  57
  58 /*----- Magic numbers -----------------------------------------------------*/
  59
  60 #define MD4_BUFSZ 64
  61 #define MD4_HASHSZ 16
  62
  63 /*----- Data structures ---------------------------------------------------*/
  64
  65 typedef struct md4_ctx {
  66   uint32 a, b, c, d;                    /* Chaining variables */
  67   unsigned long count;                  /* Byte count so far */
  68   int off;                              /* Offset into buffer */
  69   octet buf[MD4_BUFSZ];                 /* Accumulation buffer */
  70 } md4_ctx;
  71
  72 /*----- Functions provided ------------------------------------------------*/
  73
  74 /* --- @md4_compress@ --- *
  75  *
  76  * Arguments:   @md4_ctx *ctx@ = pointer to context block
  77  *              @const void *sbuf@ = pointer to buffer of appropriate size
  78  *
  79  * Returns:     ---
  80  *
  81  * Use:         MD4 compression function.
  82  */
  83
  84 extern void md4_compress(md4_ctx */*ctx*/, const void */*sbuf*/);
  85
  86 /* --- @md4_init@ --- *
  87  *
  88  * Arguments:   @md4_ctx *ctx@ = pointer to context block to initialize
  89  *
  90  * Returns:     ---
  91  *
  92  * Use:         Initializes a context block ready for hashing.
  93  */
  94
  95 extern void md4_init(md4_ctx */*ctx*/);
  96
  97 /* --- @md4_set@ --- *
  98  *
  99  * Arguments:   @md4_ctx *ctx@ = pointer to context block
 100  *              @const void *buf@ = pointer to state buffer
 101  *              @unsigned long count@ = current count of bytes processed
 102  *
 103  * Returns:     ---
 104  *
 105  * Use:         Initializes a context block from a given state.  This is
 106  *              useful in cases where the initial hash state is meant to be
 107  *              secret, e.g., for NMAC and HMAC support.
 108  */
 109
 110 extern void md4_set(md4_ctx */*ctx*/, const void */*buf*/,
 111                     unsigned long /*count*/);
 112
 113 /* --- @md4_hash@ --- *
 114  *
 115  * Arguments:   @md4_ctx *ctx@ = pointer to context block
 116  *              @const void *buf@ = buffer of data to hash
 117  *              @size_t sz@ = size of buffer to hash
 118  *
 119  * Returns:     ---
 120  *
 121  * Use:         Hashes a buffer of data.  The buffer may be of any size and
 122  *              alignment.
 123  */
 124
 125 extern void md4_hash(md4_ctx */*ctx*/, const void */*buf*/, size_t /*sz*/);
 126
 127 /* --- @md4_done@ --- *
 128  *
 129  * Arguments:   @md4_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 md4_done(md4_ctx */*ctx*/, void */*hash*/);
 138
 139 /* --- @md4_state@ --- *
 140  *
 141  * Arguments:   @md4_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 @md4_set@.
 148  */
 149
 150 extern unsigned long md4_state(md4_ctx */*ctx*/, void */*state*/);
 151
 152 /*----- That's all, folks -------------------------------------------------*/
 153
 154 #ifdef __cplusplus
 155   }
 156 #endif
 157
 158 #endif