3 * $Id: md5.h,v 1.3 2000/06/17 11:32:52 mdw Exp $
5 * The MD5 message digest function
7 * (c) 1998 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
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.
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.
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,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.3 2000/06/17 11:32:52 mdw
34 * Change buffer offset to be unsigned.
36 * Revision 1.2 1999/12/10 23:20:03 mdw
37 * New hash interface requirements.
39 * Revision 1.1 1999/09/03 08:41:12 mdw
44 /*----- Notes on the MD5 hash function ------------------------------------*
46 * MD5 was designed by Ron Rivest. It was intended to be a more conservative
47 * design than the slightly earlier MD4, and indeed while MD4 has been pretty
48 * much demolished by subsequent cryptanalysis, MD5 is still standing
49 * shakily. It's provided here not because the author recommends its use but
50 * because it's a common standard, and is often handy in non-cryptographic
51 * applications. It's also still useful in constructions such as HMAC.
54 #ifndef CATACOMB_MD5_H
55 #define CATACOMB_MD5_H
61 /*----- Header files ------------------------------------------------------*/
63 #include <mLib/bits.h>
65 #ifndef CATACOMB_GHASH_H
69 /*----- Magic numbers -----------------------------------------------------*/
74 /*----- Data structures ---------------------------------------------------*/
76 typedef struct md5_ctx
{
77 uint32 a
, b
, c
, d
; /* Chaining variables */
78 uint32 nl
, nh
; /* Byte count so far */
79 unsigned off
; /* Offset into buffer */
80 octet buf
[MD5_BUFSZ
]; /* Accumulation buffer */
83 /*----- Functions provided ------------------------------------------------*/
85 /* --- @md5_compress@ --- *
87 * Arguments: @md5_ctx *ctx@ = pointer to context block
88 * @const void *sbuf@ = pointer to buffer of appropriate size
92 * Use: MD5 compression function.
95 extern void md5_compress(md5_ctx */
*ctx*/
, const void */
*sbuf*/
);
97 /* --- @md5_init@ --- *
99 * Arguments: @md5_ctx *ctx@ = pointer to context block to initialize
103 * Use: Initializes a context block ready for hashing.
106 extern void md5_init(md5_ctx */
*ctx*/
);
108 /* --- @md5_set@ --- *
110 * Arguments: @md5_ctx *ctx@ = pointer to context block
111 * @const void *buf@ = pointer to state buffer
112 * @unsigned long count@ = current count of bytes processed
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.
121 extern void md5_set(md5_ctx */
*ctx*/
, const void */
*buf*/
,
122 unsigned long /*count*/);
124 /* --- @md5_hash@ --- *
126 * Arguments: @md5_ctx *ctx@ = pointer to context block
127 * @const void *buf@ = buffer of data to hash
128 * @size_t sz@ = size of buffer to hash
132 * Use: Hashes a buffer of data. The buffer may be of any size and
136 extern void md5_hash(md5_ctx */
*ctx*/
, const void */
*buf*/
, size_t /*sz*/);
138 /* --- @md5_done@ --- *
140 * Arguments: @md5_ctx *ctx@ = pointer to context block
141 * @void *hash@ = pointer to output buffer
145 * Use: Returns the hash of the data read so far.
148 extern void md5_done(md5_ctx */
*ctx*/
, void */
*hash*/
);
150 /* --- @md5_state@ --- *
152 * Arguments: @md5_ctx *ctx@ = pointer to context
153 * @void *state@ = pointer to buffer for current state
155 * Returns: Number of bytes written to the hash function so far.
157 * Use: Returns the current state of the hash function such that
158 * it can be passed to @md5_set@.
161 extern unsigned long md5_state(md5_ctx */
*ctx*/
, void */
*state*/
);
163 /*----- Generic hash interface --------------------------------------------*/
165 extern const gchash md5
;
167 /*----- That's all, folks -------------------------------------------------*/