sha1.h

   1 /* Declarations of functions and data types used for SHA1 sum
   2    library functions.
   3    Copyright (C) 2000, 2001, 2003, 2005, 2006, 2008
   4    Free Software Foundation, Inc.
   5
   6    This program is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by the
   8    Free Software Foundation; either version 2, or (at your option) any
   9    later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software Foundation,
  18    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  19
  20 #ifndef SHA1_H
  21 # define SHA1_H 1
  22
  23 #include <stdio.h>
  24
  25 #if defined HAVE_LIMITS_H || _LIBC
  26 # include <limits.h>
  27 #endif
  28
  29 /* The following contortions are an attempt to use the C preprocessor
  30    to determine an unsigned integral type that is 32 bits wide.  An
  31    alternative approach is to use autoconf's AC_CHECK_SIZEOF macro, but
  32    doing that would require that the configure script compile and *run*
  33    the resulting executable.  Locally running cross-compiled executables
  34    is usually not possible.  */
  35
  36 #ifdef _LIBC
  37 # include <sys/types.h>
  38 typedef u_int32_t sha1_uint32;
  39 typedef uintptr_t sha1_uintptr;
  40 #else
  41 #  define INT_MAX_32_BITS 2147483647
  42
  43 /* If UINT_MAX isn't defined, assume it's a 32-bit type.
  44    This should be valid for all systems GNU cares about because
  45    that doesn't include 16-bit systems, and only modern systems
  46    (that certainly have <limits.h>) have 64+-bit integral types.  */
  47
  48 # ifndef INT_MAX
  49 #  define INT_MAX INT_MAX_32_BITS
  50 # endif
  51
  52 # if INT_MAX == INT_MAX_32_BITS
  53    typedef unsigned int sha1_uint32;
  54 # else
  55 #  if SHRT_MAX == INT_MAX_32_BITS
  56     typedef unsigned short sha1_uint32;
  57 #  else
  58 #   if LONG_MAX == INT_MAX_32_BITS
  59      typedef unsigned long sha1_uint32;
  60 #   else
  61      /* The following line is intended to evoke an error.
  62         Using #error is not portable enough.  */
  63      "Cannot determine unsigned 32-bit data type."
  64 #   endif
  65 #  endif
  66 # endif
  67 #endif
  68
  69 #ifdef __cplusplus
  70 extern "C" {
  71 #endif
  72
  73 /* Structure to save state of computation between the single steps.  */
  74 struct sha1_ctx
  75 {
  76   sha1_uint32 A;
  77   sha1_uint32 B;
  78   sha1_uint32 C;
  79   sha1_uint32 D;
  80   sha1_uint32 E;
  81
  82   sha1_uint32 total[2];
  83   sha1_uint32 buflen;
  84   sha1_uint32 buffer[32];
  85 };
  86
  87 /* Initialize structure containing state of computation. */
  88 extern void sha1_init_ctx (struct sha1_ctx *ctx);
  89
  90 /* Starting with the result of former calls of this function (or the
  91    initialization function update the context for the next LEN bytes
  92    starting at BUFFER.
  93    It is necessary that LEN is a multiple of 64!!! */
  94 extern void sha1_process_block (const void *buffer, size_t len,
  95                                 struct sha1_ctx *ctx);
  96
  97 /* Starting with the result of former calls of this function (or the
  98    initialization function update the context for the next LEN bytes
  99    starting at BUFFER.
 100    It is NOT required that LEN is a multiple of 64.  */
 101 extern void sha1_process_bytes (const void *buffer, size_t len,
 102                                 struct sha1_ctx *ctx);
 103
 104 /* Process the remaining bytes in the buffer and put result from CTX
 105    in first 20 bytes following RESBUF.  The result is always in little
 106    endian byte order, so that a byte-wise output yields to the wanted
 107    ASCII representation of the message digest.
 108
 109    IMPORTANT: On some systems it is required that RESBUF be correctly
 110    aligned for a 32 bits value.  */
 111 extern void *sha1_finish_ctx (struct sha1_ctx *ctx, void *resbuf);
 112
 113 /* Put result from CTX in first 20 bytes following RESBUF.  The result is
 114    always in little endian byte order, so that a byte-wise output yields
 115    to the wanted ASCII representation of the message digest.
 116
 117    IMPORTANT: On some systems it is required that RESBUF is correctly
 118    aligned for a 32 bits value.  */
 119 extern void *sha1_read_ctx (const struct sha1_ctx *ctx, void *resbuf);
 120
 121 /* Compute SHA1 message digest for bytes read from STREAM.  The
 122    resulting message digest number will be written into the 20 bytes
 123    beginning at RESBLOCK.  */
 124 extern int sha1_stream (FILE *stream, void *resblock);
 125
 126 /* Compute SHA1 message digest for LEN bytes beginning at BUFFER.  The
 127    result is always in little endian byte order, so that a byte-wise
 128    output yields to the wanted ASCII representation of the message
 129    digest.  */
 130 extern void *sha1_buffer (const char *buffer, size_t len, void *resblock);
 131
 132 #ifdef __cplusplus
 133 }
 134 #endif
 135
 136 #endif