3 * $Id: sha256.h,v 1.1 2000/10/15 17:48:15 mdw Exp $
5 * Implementation of the SHA-256 hash function
7 * (c) 2000 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 2000/10/15 17:48:15 mdw
34 * New SHA variants with longer outputs.
38 /*----- Notes on the SHA-256 hash function ----------------------------------*
40 * SHA-1 (Secure Hash Algorithm) was designed by the NSA, for use with the
41 * Digital Signature Algorithm. This is an evolution with a larger output
42 * size, intended to provide security commensurate with 128-bit AES. At the
43 * time of writing, SHA-256 is very new, and can't be trusted too far.
46 #ifndef CATACOMB_SHA256_H
47 #define CATACOMB_SHA256_H
53 /*----- Header files ------------------------------------------------------*/
55 #include <mLib/bits.h>
57 #ifndef CATACOMB_GHASH_H
61 /*----- Magic numbers -----------------------------------------------------*/
63 #define SHA256_BUFSZ 64
64 #define SHA256_HASHSZ 32
66 /*----- Data structures ---------------------------------------------------*/
68 typedef struct sha256_ctx
{
69 uint32 a
, b
, c
, d
, e
, f
, g
, h
; /* Chaining variables */
70 uint32 nl
, nh
; /* Byte count so far */
71 unsigned off
; /* Offset into buffer */
72 octet buf
[SHA256_BUFSZ
]; /* Accumulation buffer */
75 /*----- Functions provided ------------------------------------------------*/
77 /* --- @sha256_compress@ --- *
79 * Arguments: @sha256_ctx *ctx@ = pointer to context block
80 * @const void *sbuf@ = pointer to buffer of appropriate size
84 * Use: SHA-256 compression function.
87 extern void sha256_compress(sha256_ctx */
*ctx*/
, const void */
*sbuf*/
);
89 /* --- @sha256_init@ --- *
91 * Arguments: @sha256_ctx *ctx@ = pointer to context block to initialize
95 * Use: Initializes a context block ready for hashing.
98 extern void sha256_init(sha256_ctx */
*ctx*/
);
100 /* --- @sha256_set@ --- *
102 * Arguments: @sha256_ctx *ctx@ = pointer to context block
103 * @const void *buf@ = pointer to state buffer
104 * @unsigned long count@ = current count of bytes processed
108 * Use: Initializes a context block from a given state. This is
109 * useful in cases where the initial hash state is meant to be
110 * secret, e.g., for NMAC and HMAC support.
113 extern void sha256_set(sha256_ctx */
*ctx*/
, const void */
*buf*/
,
114 unsigned long /*count*/);
116 /* --- @sha256_hash@ --- *
118 * Arguments: @sha256_ctx *ctx@ = pointer to context block
119 * @const void *buf@ = buffer of data to hash
120 * @size_t sz@ = size of buffer to hash
124 * Use: Hashes a buffer of data. The buffer may be of any size and
128 extern void sha256_hash(sha256_ctx */
*ctx*/
,
129 const void */
*buf*/
, size_t /*sz*/);
131 /* --- @sha256_done@ --- *
133 * Arguments: @sha256_ctx *ctx@ = pointer to context block
134 * @void *hash@ = pointer to output buffer
138 * Use: Returns the hash of the data read so far.
141 extern void sha256_done(sha256_ctx */
*ctx*/
, void */
*hash*/
);
143 /* --- @sha256_state@ --- *
145 * Arguments: @sha256_ctx *ctx@ = pointer to context
146 * @void *state@ = pointer to buffer for current state
148 * Returns: Number of bytes written to the hash function so far.
150 * Use: Returns the current state of the hash function such that
151 * it can be passed to @sha256_set@.
154 extern unsigned long sha256_state(sha256_ctx */
*ctx*/
, void */
*state*/
);
156 /*----- Generic hash interface --------------------------------------------*/
158 extern const gchash sha256
;
160 /*----- That's all, folks -------------------------------------------------*/