3 * $Id: sha.h,v 1.1 1999/09/03 08:41:12 mdw Exp $
5 * Implementation of the SHA-1 hash function
7 * (c) 1999 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 SHA-1 hash function ----------------------------------*
40 * SHA (Secure Hash Algorithm) was designed by the NSA, for use with the
41 * Digital Signature Algorithm. It has gained wide acceptance since then,
42 * and is probably now most people's collision-resistant function of choice.
43 * The author prefers RIPEMD-160, for no particularly good reasons.
53 /*----- Header files ------------------------------------------------------*/
55 #include <mLib/bits.h>
57 /*----- Magic numbers -----------------------------------------------------*/
62 /*----- Data structures ---------------------------------------------------*/
64 typedef struct sha_ctx
{
65 uint32 a
, b
, c
, d
, e
; /* Chaining variables */
66 unsigned long count
; /* Byte count so far */
67 int off
; /* Offset into buffer */
68 octet buf
[SHA_BUFSZ
]; /* Accumulation buffer */
71 /*----- Functions provided ------------------------------------------------*/
73 /* --- @sha_compress@ --- *
75 * Arguments: @sha_ctx *ctx@ = pointer to context block
76 * @const void *sbuf@ = pointer to buffer of appropriate size
80 * Use: SHA compression function.
83 extern void sha_compress(sha_ctx */
*ctx*/
, const void */
*sbuf*/
);
85 /* --- @sha_init@ --- *
87 * Arguments: @sha_ctx *ctx@ = pointer to context block to initialize
91 * Use: Initializes a context block ready for hashing.
94 extern void sha_init(sha_ctx */
*ctx*/
);
96 /* --- @sha_set@ --- *
98 * Arguments: @sha_ctx *ctx@ = pointer to context block
99 * @const void *buf@ = pointer to state buffer
100 * @unsigned long count@ = current count of bytes processed
104 * Use: Initializes a context block from a given state. This is
105 * useful in cases where the initial hash state is meant to be
106 * secret, e.g., for NMAC and HMAC support.
109 extern void sha_set(sha_ctx */
*ctx*/
, const void */
*buf*/
,
110 unsigned long /*count*/);
112 /* --- @sha_hash@ --- *
114 * Arguments: @sha_ctx *ctx@ = pointer to context block
115 * @const void *buf@ = buffer of data to hash
116 * @size_t sz@ = size of buffer to hash
120 * Use: Hashes a buffer of data. The buffer may be of any size and
124 extern void sha_hash(sha_ctx */
*ctx*/
, const void */
*buf*/
, size_t /*sz*/);
126 /* --- @sha_done@ --- *
128 * Arguments: @sha_ctx *ctx@ = pointer to context block
129 * @void *hash@ = pointer to output buffer
133 * Use: Returns the hash of the data read so far.
136 extern void sha_done(sha_ctx */
*ctx*/
, void */
*hash*/
);
138 /* --- @sha_state@ --- *
140 * Arguments: @sha_ctx *ctx@ = pointer to context
141 * @void *state@ = pointer to buffer for current state
143 * Returns: Number of bytes written to the hash function so far.
145 * Use: Returns the current state of the hash function such that
146 * it can be passed to @sha_set@.
149 extern unsigned long sha_state(sha_ctx */
*ctx*/
, void */
*state*/
);
151 /*----- That's all, folks -------------------------------------------------*/