3 * The MD5 message digest function
5 * (c) 1998 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Catacomb.
12 * Catacomb is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Library General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
17 * Catacomb is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
22 * You should have received a copy of the GNU Library General Public
23 * License along with Catacomb; if not, write to the Free
24 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
28 /*----- Notes on the MD5 hash function ------------------------------------*
30 * MD5 was designed by Ron Rivest. It was intended to be a more conservative
31 * design than the slightly earlier MD4, and indeed while MD4 has been pretty
32 * much demolished by subsequent cryptanalysis, MD5 is still standing
33 * shakily. It's provided here not because the author recommends its use but
34 * because it's a common standard, and is often handy in non-cryptographic
35 * applications. It's also still useful in constructions such as HMAC.
38 #ifndef CATACOMB_MD5_H
39 #define CATACOMB_MD5_H
45 /*----- Header files ------------------------------------------------------*/
47 #include <mLib/bits.h>
49 #ifndef CATACOMB_GHASH_H
53 /*----- Magic numbers -----------------------------------------------------*/
57 #define MD5_STATESZ 16
59 /*----- Data structures ---------------------------------------------------*/
61 typedef struct md5_ctx {
62 uint32 a, b, c, d; /* Chaining variables */
63 uint32 nl, nh; /* Byte count so far */
64 unsigned off; /* Offset into buffer */
65 octet buf[MD5_BUFSZ]; /* Accumulation buffer */
68 /*----- Functions provided ------------------------------------------------*/
70 /* --- @md5_compress@ --- *
72 * Arguments: @md5_ctx *ctx@ = pointer to context block
73 * @const void *sbuf@ = pointer to buffer of appropriate size
77 * Use: MD5 compression function.
80 extern void md5_compress(md5_ctx */*ctx*/, const void */*sbuf*/);
82 /* --- @md5_init@ --- *
84 * Arguments: @md5_ctx *ctx@ = pointer to context block to initialize
88 * Use: Initializes a context block ready for hashing.
91 extern void md5_init(md5_ctx */*ctx*/);
93 /* --- @md5_set@ --- *
95 * Arguments: @md5_ctx *ctx@ = pointer to context block
96 * @const void *buf@ = pointer to state buffer
97 * @unsigned long count@ = current count of bytes processed
101 * Use: Initializes a context block from a given state. This is
102 * useful in cases where the initial hash state is meant to be
103 * secret, e.g., for NMAC and HMAC support.
106 extern void md5_set(md5_ctx */*ctx*/, const void */*buf*/,
107 unsigned long /*count*/);
109 /* --- @md5_hash@ --- *
111 * Arguments: @md5_ctx *ctx@ = pointer to context block
112 * @const void *buf@ = buffer of data to hash
113 * @size_t sz@ = size of buffer to hash
117 * Use: Hashes a buffer of data. The buffer may be of any size and
121 extern void md5_hash(md5_ctx */*ctx*/, const void */*buf*/, size_t /*sz*/);
123 /* --- @md5_done@ --- *
125 * Arguments: @md5_ctx *ctx@ = pointer to context block
126 * @void *hash@ = pointer to output buffer
130 * Use: Returns the hash of the data read so far.
133 extern void md5_done(md5_ctx */*ctx*/, void */*hash*/);
135 /* --- @md5_state@ --- *
137 * Arguments: @md5_ctx *ctx@ = pointer to context
138 * @void *state@ = pointer to buffer for current state
140 * Returns: Number of bytes written to the hash function so far.
142 * Use: Returns the current state of the hash function such that
143 * it can be passed to @md5_set@.
146 extern unsigned long md5_state(md5_ctx */*ctx*/, void */*state*/);
148 /*----- Generic hash interface --------------------------------------------*/
150 extern const gchash md5;
152 /*----- That's all, folks -------------------------------------------------*/