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

   1 /* -*-c-*-
   2  *
   3  * $Id: md5.h,v 1.2 1999/12/10 23:20:03 mdw Exp $
   4  *
   5  * The MD5 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: md5.h,v $
  33  * Revision 1.2  1999/12/10 23:20:03  mdw
  34  * New hash interface requirements.
  35  *
  36  * Revision 1.1  1999/09/03 08:41:12  mdw
  37  * Initial import.
  38  *
  39  */
  40
  41 /*----- Notes on the MD5 hash function ------------------------------------*
  42  *
  43  * MD5 was designed by Ron Rivest.  It was intended to be a more conservative
  44  * design than the slightly earlier MD4, and indeed while MD4 has been pretty
  45  * much demolished by subsequent cryptanalysis, MD5 is still standing
  46  * shakily.  It's provided here not because the author recommends its use but
  47  * because it's a common standard, and is often handy in non-cryptographic
  48  * applications.  It's also still useful in constructions such as HMAC.
  49  */
  50
  51 #ifndef CATACOMB_MD5_H
  52 #define CATACOMB_MD5_H
  53
  54 #ifdef __cplusplus
  55   extern "C" {
  56 #endif
  57
  58 /*----- Header files ------------------------------------------------------*/
  59
  60 #include <mLib/bits.h>
  61
  62 #ifndef CATACOMB_GHASH_H
  63 #  include "ghash.h"
  64 #endif
  65
  66 /*----- Magic numbers -----------------------------------------------------*/
  67
  68 #define MD5_BUFSZ 64
  69 #define MD5_HASHSZ 16
  70
  71 /*----- Data structures ---------------------------------------------------*/
  72
  73 typedef struct md5_ctx {
  74   uint32 a, b, c, d;                    /* Chaining variables */
  75   uint32 nl, nh;                        /* Byte count so far */
  76   int off;                              /* Offset into buffer */
  77   octet buf[MD5_BUFSZ];                 /* Accumulation buffer */
  78 } md5_ctx;
  79
  80 /*----- Functions provided ------------------------------------------------*/
  81
  82 /* --- @md5_compress@ --- *
  83  *
  84  * Arguments:   @md5_ctx *ctx@ = pointer to context block
  85  *              @const void *sbuf@ = pointer to buffer of appropriate size
  86  *
  87  * Returns:     ---
  88  *
  89  * Use:         MD5 compression function.
  90  */
  91
  92 extern void md5_compress(md5_ctx */*ctx*/, const void */*sbuf*/);
  93
  94 /* --- @md5_init@ --- *
  95  *
  96  * Arguments:   @md5_ctx *ctx@ = pointer to context block to initialize
  97  *
  98  * Returns:     ---
  99  *
 100  * Use:         Initializes a context block ready for hashing.
 101  */
 102
 103 extern void md5_init(md5_ctx */*ctx*/);
 104
 105 /* --- @md5_set@ --- *
 106  *
 107  * Arguments:   @md5_ctx *ctx@ = pointer to context block
 108  *              @const void *buf@ = pointer to state buffer
 109  *              @unsigned long count@ = current count of bytes processed
 110  *
 111  * Returns:     ---
 112  *
 113  * Use:         Initializes a context block from a given state.  This is
 114  *              useful in cases where the initial hash state is meant to be
 115  *              secret, e.g., for NMAC and HMAC support.
 116  */
 117
 118 extern void md5_set(md5_ctx */*ctx*/, const void */*buf*/,
 119                     unsigned long /*count*/);
 120
 121 /* --- @md5_hash@ --- *
 122  *
 123  * Arguments:   @md5_ctx *ctx@ = pointer to context block
 124  *              @const void *buf@ = buffer of data to hash
 125  *              @size_t sz@ = size of buffer to hash
 126  *
 127  * Returns:     ---
 128  *
 129  * Use:         Hashes a buffer of data.  The buffer may be of any size and
 130  *              alignment.
 131  */
 132
 133 extern void md5_hash(md5_ctx */*ctx*/, const void */*buf*/, size_t /*sz*/);
 134
 135 /* --- @md5_done@ --- *
 136  *
 137  * Arguments:   @md5_ctx *ctx@ = pointer to context block
 138  *              @void *hash@ = pointer to output buffer
 139  *
 140  * Returns:     ---
 141  *
 142  * Use:         Returns the hash of the data read so far.
 143  */
 144
 145 extern void md5_done(md5_ctx */*ctx*/, void */*hash*/);
 146
 147 /* --- @md5_state@ --- *
 148  *
 149  * Arguments:   @md5_ctx *ctx@ = pointer to context
 150  *              @void *state@ = pointer to buffer for current state
 151  *
 152  * Returns:     Number of bytes written to the hash function so far.
 153  *
 154  * Use:         Returns the current state of the hash function such that
 155  *              it can be passed to @md5_set@.
 156  */
 157
 158 extern unsigned long md5_state(md5_ctx */*ctx*/, void */*state*/);
 159
 160 /*----- Generic hash interface --------------------------------------------*/
 161
 162 extern const gchash md5;
 163
 164 /*----- That's all, folks -------------------------------------------------*/
 165
 166 #ifdef __cplusplus
 167   }
 168 #endif
 169
 170 #endif