3 * $Id: md5.h,v 1.1 1999/09/03 08:41:12 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.1 1999/09/03 08:41:12 mdw
38 /*----- Notes on the MD5 hash function ------------------------------------*
40 * MD5 was designed by Ron Rivest. It was intended to be a more conservative
41 * design than the slightly earlier MD4, and indeed while MD4 has been pretty
42 * much demolished by subsequent cryptanalysis, MD5 is still standing
43 * shakily. It's provided here not because the author recommends its use but
44 * because it's a common standard, and is often handy in non-cryptographic
45 * applications. It's also still useful in constructions such as HMAC.
55 /*----- Header files ------------------------------------------------------*/
57 #include <mLib/bits.h>
59 /*----- Magic numbers -----------------------------------------------------*/
64 /*----- Data structures ---------------------------------------------------*/
66 typedef struct md5_ctx
{
67 uint32 a
, b
, c
, d
; /* Chaining variables */
68 unsigned long count
; /* Byte count so far */
69 int off
; /* Offset into buffer */
70 octet buf
[MD5_BUFSZ
]; /* Accumulation buffer */
73 /*----- Functions provided ------------------------------------------------*/
75 /* --- @md5_compress@ --- *
77 * Arguments: @md5_ctx *ctx@ = pointer to context block
78 * @const void *sbuf@ = pointer to buffer of appropriate size
82 * Use: MD5 compression function.
85 extern void md5_compress(md5_ctx */
*ctx*/
, const void */
*sbuf*/
);
87 /* --- @md5_init@ --- *
89 * Arguments: @md5_ctx *ctx@ = pointer to context block to initialize
93 * Use: Initializes a context block ready for hashing.
96 extern void md5_init(md5_ctx */
*ctx*/
);
98 /* --- @md5_set@ --- *
100 * Arguments: @md5_ctx *ctx@ = pointer to context block
101 * @const void *buf@ = pointer to state buffer
102 * @unsigned long count@ = current count of bytes processed
106 * Use: Initializes a context block from a given state. This is
107 * useful in cases where the initial hash state is meant to be
108 * secret, e.g., for NMAC and HMAC support.
111 extern void md5_set(md5_ctx */
*ctx*/
, const void */
*buf*/
,
112 unsigned long /*count*/);
114 /* --- @md5_hash@ --- *
116 * Arguments: @md5_ctx *ctx@ = pointer to context block
117 * @const void *buf@ = buffer of data to hash
118 * @size_t sz@ = size of buffer to hash
122 * Use: Hashes a buffer of data. The buffer may be of any size and
126 extern void md5_hash(md5_ctx */
*ctx*/
, const void */
*buf*/
, size_t /*sz*/);
128 /* --- @md5_done@ --- *
130 * Arguments: @md5_ctx *ctx@ = pointer to context block
131 * @void *hash@ = pointer to output buffer
135 * Use: Returns the hash of the data read so far.
138 extern void md5_done(md5_ctx */
*ctx*/
, void */
*hash*/
);
140 /* --- @md5_state@ --- *
142 * Arguments: @md5_ctx *ctx@ = pointer to context
143 * @void *state@ = pointer to buffer for current state
145 * Returns: Number of bytes written to the hash function so far.
147 * Use: Returns the current state of the hash function such that
148 * it can be passed to @md5_set@.
151 extern unsigned long md5_state(md5_ctx */
*ctx*/
, void */
*state*/
);
153 /*----- That's all, folks -------------------------------------------------*/