chiark - git - mdw - catacomb/blob - sha.h

   1 /* -*-c-*-
   2  *
   3  * $Id: sha.h,v 1.4 2000/06/17 11:32:52 mdw Exp $
   4  *
   5  * Implementation of the SHA-1 hash function
   6  *
   7  * (c) 1999 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Catacomb.
  13  *
  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.
  18  *
  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.
  23  *
  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,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: sha.h,v $
  33  * Revision 1.4  2000/06/17 11:32:52  mdw
  34  * Change buffer offset to be unsigned.
  35  *
  36  * Revision 1.3  1999/12/10 23:20:03  mdw
  37  * New hash interface requirements.
  38  *
  39  * Revision 1.2  1999/11/19 13:20:08  mdw
  40  * Modify notes section slightly.
  41  *
  42  * Revision 1.1  1999/09/03 08:41:12  mdw
  43  * Initial import.
  44  *
  45  */
  46
  47 /*----- Notes on the SHA-1 hash function ----------------------------------*
  48  *
  49  * SHA (Secure Hash Algorithm) was designed by the NSA, for use with the
  50  * Digital Signature Algorithm.  It is defined by FIPS 180-1.  It has gained
  51  * wide acceptance since its initial publication, and is probably now most
  52  * people's collision-resistant function of choice.  The author prefers
  53  * RIPEMD-160, for no particularly good reasons.
  54  */
  55
  56 #ifndef CATACOMB_SHA_H
  57 #define CATACOMB_SHA_H
  58
  59 #ifdef __cplusplus
  60   extern "C" {
  61 #endif
  62
  63 /*----- Header files ------------------------------------------------------*/
  64
  65 #include <mLib/bits.h>
  66
  67 #ifndef CATACOMB_GHASH_H
  68 #  include "ghash.h"
  69 #endif
  70
  71 /*----- Magic numbers -----------------------------------------------------*/
  72
  73 #define SHA_BUFSZ 64
  74 #define SHA_HASHSZ 20
  75
  76 /*----- Data structures ---------------------------------------------------*/
  77
  78 typedef struct sha_ctx {
  79   uint32 a, b, c, d, e;                 /* Chaining variables */
  80   uint32 nl, nh;                        /* Byte count so far */
  81   unsigned off;                         /* Offset into buffer */
  82   octet buf[SHA_BUFSZ];                 /* Accumulation buffer */
  83 } sha_ctx;
  84
  85 /*----- Functions provided ------------------------------------------------*/
  86
  87 /* --- @sha_compress@ --- *
  88  *
  89  * Arguments:   @sha_ctx *ctx@ = pointer to context block
  90  *              @const void *sbuf@ = pointer to buffer of appropriate size
  91  *
  92  * Returns:     ---
  93  *
  94  * Use:         SHA compression function.
  95  */
  96
  97 extern void sha_compress(sha_ctx */*ctx*/, const void */*sbuf*/);
  98
  99 /* --- @sha_init@ --- *
 100  *
 101  * Arguments:   @sha_ctx *ctx@ = pointer to context block to initialize
 102  *
 103  * Returns:     ---
 104  *
 105  * Use:         Initializes a context block ready for hashing.
 106  */
 107
 108 extern void sha_init(sha_ctx */*ctx*/);
 109
 110 /* --- @sha_set@ --- *
 111  *
 112  * Arguments:   @sha_ctx *ctx@ = pointer to context block
 113  *              @const void *buf@ = pointer to state buffer
 114  *              @unsigned long count@ = current count of bytes processed
 115  *
 116  * Returns:     ---
 117  *
 118  * Use:         Initializes a context block from a given state.  This is
 119  *              useful in cases where the initial hash state is meant to be
 120  *              secret, e.g., for NMAC and HMAC support.
 121  */
 122
 123 extern void sha_set(sha_ctx */*ctx*/, const void */*buf*/,
 124                     unsigned long /*count*/);
 125
 126 /* --- @sha_hash@ --- *
 127  *
 128  * Arguments:   @sha_ctx *ctx@ = pointer to context block
 129  *              @const void *buf@ = buffer of data to hash
 130  *              @size_t sz@ = size of buffer to hash
 131  *
 132  * Returns:     ---
 133  *
 134  * Use:         Hashes a buffer of data.  The buffer may be of any size and
 135  *              alignment.
 136  */
 137
 138 extern void sha_hash(sha_ctx */*ctx*/, const void */*buf*/, size_t /*sz*/);
 139
 140 /* --- @sha_done@ --- *
 141  *
 142  * Arguments:   @sha_ctx *ctx@ = pointer to context block
 143  *              @void *hash@ = pointer to output buffer
 144  *
 145  * Returns:     ---
 146  *
 147  * Use:         Returns the hash of the data read so far.
 148  */
 149
 150 extern void sha_done(sha_ctx */*ctx*/, void */*hash*/);
 151
 152 /* --- @sha_state@ --- *
 153  *
 154  * Arguments:   @sha_ctx *ctx@ = pointer to context
 155  *              @void *state@ = pointer to buffer for current state
 156  *
 157  * Returns:     Number of bytes written to the hash function so far.
 158  *
 159  * Use:         Returns the current state of the hash function such that
 160  *              it can be passed to @sha_set@.
 161  */
 162
 163 extern unsigned long sha_state(sha_ctx */*ctx*/, void */*state*/);
 164
 165 /*----- Generic hash interface --------------------------------------------*/
 166
 167 extern const gchash sha;
 168
 169 /*----- That's all, folks -------------------------------------------------*/
 170
 171 #ifdef __cplusplus
 172   }
 173 #endif
 174
 175 #endif