lib/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-2018 Free Software
   4    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, see <https://www.gnu.org/licenses/>.  */
  18
  19 #ifndef SHA1_H
  20 # define SHA1_H 1
  21
  22 # include <stdio.h>
  23 # include <stdint.h>
  24
  25 # if HAVE_OPENSSL_SHA1
  26 #  include <openssl/sha.h>
  27 # endif
  28
  29 # ifdef __cplusplus
  30 extern "C" {
  31 # endif
  32
  33 #define SHA1_DIGEST_SIZE 20
  34
  35 # if HAVE_OPENSSL_SHA1
  36 #  define GL_OPENSSL_NAME 1
  37 #  include "gl_openssl.h"
  38 # else
  39 /* Structure to save state of computation between the single steps.  */
  40 struct sha1_ctx
  41 {
  42   uint32_t A;
  43   uint32_t B;
  44   uint32_t C;
  45   uint32_t D;
  46   uint32_t E;
  47
  48   uint32_t total[2];
  49   uint32_t buflen;     /* ≥ 0, ≤ 128 */
  50   uint32_t buffer[32]; /* 128 bytes; the first buflen bytes are in use */
  51 };
  52
  53 /* Initialize structure containing state of computation. */
  54 extern void sha1_init_ctx (struct sha1_ctx *ctx);
  55
  56 /* Starting with the result of former calls of this function (or the
  57    initialization function update the context for the next LEN bytes
  58    starting at BUFFER.
  59    It is necessary that LEN is a multiple of 64!!! */
  60 extern void sha1_process_block (const void *buffer, size_t len,
  61                                 struct sha1_ctx *ctx);
  62
  63 /* Starting with the result of former calls of this function (or the
  64    initialization function update the context for the next LEN bytes
  65    starting at BUFFER.
  66    It is NOT required that LEN is a multiple of 64.  */
  67 extern void sha1_process_bytes (const void *buffer, size_t len,
  68                                 struct sha1_ctx *ctx);
  69
  70 /* Process the remaining bytes in the buffer and put result from CTX
  71    in first 20 bytes following RESBUF.  The result is always in little
  72    endian byte order, so that a byte-wise output yields to the wanted
  73    ASCII representation of the message digest.  */
  74 extern void *sha1_finish_ctx (struct sha1_ctx *ctx, void *resbuf);
  75
  76
  77 /* Put result from CTX in first 20 bytes following RESBUF.  The result is
  78    always in little endian byte order, so that a byte-wise output yields
  79    to the wanted ASCII representation of the message digest.  */
  80 extern void *sha1_read_ctx (const struct sha1_ctx *ctx, void *resbuf);
  81
  82
  83 /* Compute SHA1 message digest for LEN bytes beginning at BUFFER.  The
  84    result is always in little endian byte order, so that a byte-wise
  85    output yields to the wanted ASCII representation of the message
  86    digest.  */
  87 extern void *sha1_buffer (const char *buffer, size_t len, void *resblock);
  88
  89 # endif
  90 /* Compute SHA1 message digest for bytes read from STREAM.
  91    STREAM is an open file stream.  Regular files are handled more efficiently.
  92    The contents of STREAM from its current position to its end will be read.
  93    The case that the last operation on STREAM was an 'ungetc' is not supported.
  94    The resulting message digest number will be written into the 20 bytes
  95    beginning at RESBLOCK.  */
  96 extern int sha1_stream (FILE *stream, void *resblock);
  97
  98
  99 # ifdef __cplusplus
 100 }
 101 # endif
 102
 103 #endif
 104
 105 /*
 106  * Hey Emacs!
 107  * Local Variables:
 108  * coding: utf-8
 109  * End:
 110  */