chiark - git - mdw - catacomb/blob - symm/sha512.h

   1 /* -*-c-*-
   2  *
   3  * Implementation of the SHA-512 hash function
   4  *
   5  * (c) 2000 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of Catacomb.
  11  *
  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.
  16  *
  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.
  21  *
  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,
  25  * MA 02111-1307, USA.
  26  */
  27
  28 /*----- Notes on the SHA-512 hash function --------------------------------*
  29  *
  30  * SHA-1 (Secure Hash Algorithm) was designed by the NSA, for use with the
  31  * Digital Signature Algorithm.  This is an evolution with a larger output
  32  * size, intended to provide security commensurate with 256-bit AES.  At the
  33  * time of writing, SHA-512 is very new, and can't be trusted too far.  There
  34  * is also a truncated version, SHA-384, which provides security commensurate
  35  * with 192-bit AES.
  36  */
  37
  38 #ifndef CATACOMB_SHA512_H
  39 #define CATACOMB_SHA512_H
  40 #define CATACOMB_SHA384_H
  41
  42 #ifdef __cplusplus
  43   extern "C" {
  44 #endif
  45
  46 /*----- Header files ------------------------------------------------------*/
  47
  48 #include <mLib/bits.h>
  49
  50 #ifndef CATACOMB_GHASH_H
  51 #  include "ghash.h"
  52 #endif
  53
  54 /*----- Magic numbers -----------------------------------------------------*/
  55
  56 #define SHA512_BUFSZ 128
  57 #define SHA512_HASHSZ 64
  58 #define SHA512_STATESZ 64
  59
  60 #define SHA384_BUFSZ 128
  61 #define SHA384_HASHSZ 48
  62 #define SHA384_STATESZ 64
  63
  64 /*----- Data structures ---------------------------------------------------*/
  65
  66 typedef struct sha512_ctx {
  67   kludge64 a, b, c, d, e, f, g, h;      /* Chaining variables */
  68   uint32 nh, nl;                        /* Byte count so far */
  69   unsigned off;                         /* Offset into buffer */
  70   octet buf[SHA512_BUFSZ];              /* Accumulation buffer */
  71 } sha512_ctx, sha384_ctx;
  72
  73 /*----- Functions provided ------------------------------------------------*/
  74
  75 /* --- @sha512_compress@, @sha384_compress@ --- *
  76  *
  77  * Arguments:   @sha512_ctx *ctx@ = pointer to context block
  78  *              @const void *sbuf@ = pointer to buffer of appropriate size
  79  *
  80  * Returns:     ---
  81  *
  82  * Use:         SHA-512 compression function.
  83  */
  84
  85 extern void sha512_compress(sha512_ctx */*ctx*/, const void */*sbuf*/);
  86 #define sha384_compress sha512_compress
  87
  88 /* --- @sha512_init@, @sha384_init@ --- *
  89  *
  90  * Arguments:   @sha512_ctx *ctx@ = pointer to context block to initialize
  91  *
  92  * Returns:     ---
  93  *
  94  * Use:         Initializes a context block ready for hashing.
  95  */
  96
  97 extern void sha512_init(sha512_ctx */*ctx*/);
  98 extern void sha384_init(sha512_ctx */*ctx*/);
  99
 100 /* --- @sha512_set@, @sha384_set@ --- *
 101  *
 102  * Arguments:   @sha512_ctx *ctx@ = pointer to context block
 103  *              @const void *buf@ = pointer to state buffer
 104  *              @unsigned long count@ = current count of bytes processed
 105  *
 106  * Returns:     ---
 107  *
 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.
 111  */
 112
 113 extern void sha512_set(sha512_ctx */*ctx*/, const void */*buf*/,
 114                        unsigned long /*count*/);
 115 #define sha384_set sha512_set
 116
 117 /* --- @sha512_hash@, @sha384_hash@ --- *
 118  *
 119  * Arguments:   @sha512_ctx *ctx@ = pointer to context block
 120  *              @const void *buf@ = buffer of data to hash
 121  *              @size_t sz@ = size of buffer to hash
 122  *
 123  * Returns:     ---
 124  *
 125  * Use:         Hashes a buffer of data.  The buffer may be of any size and
 126  *              alignment.
 127  */
 128
 129 extern void sha512_hash(sha512_ctx */*ctx*/,
 130                         const void */*buf*/, size_t /*sz*/);
 131 #define sha384_hash sha512_hash
 132
 133 /* --- @sha512_done@, @sha384_done@ --- *
 134  *
 135  * Arguments:   @sha512_ctx *ctx@ = pointer to context block
 136  *              @void *hash@ = pointer to output buffer
 137  *
 138  * Returns:     ---
 139  *
 140  * Use:         Returns the hash of the data read so far.
 141  */
 142
 143 extern void sha512_done(sha512_ctx */*ctx*/, void */*hash*/);
 144 extern void sha384_done(sha512_ctx */*ctx*/, void */*hash*/);
 145
 146 /* --- @sha512_state@, @sha384_state@ --- *
 147  *
 148  * Arguments:   @sha512_ctx *ctx@ = pointer to context
 149  *              @void *state@ = pointer to buffer for current state
 150  *
 151  * Returns:     Number of bytes written to the hash function so far.
 152  *
 153  * Use:         Returns the current state of the hash function such that
 154  *              it can be passed to @sha512_set@.
 155  */
 156
 157 extern unsigned long sha512_state(sha512_ctx */*ctx*/, void */*state*/);
 158 #define sha384_state sha512_state
 159
 160 /*----- Generic hash interface --------------------------------------------*/
 161
 162 extern const gchash sha512;
 163 extern const gchash sha384;
 164
 165 /*----- That's all, folks -------------------------------------------------*/
 166
 167 #ifdef __cplusplus
 168   }
 169 #endif
 170
 171 #endif