sjero.net Git - wget/blob - src/gnu-md5.h

   1 /* md5.h - Declaration of functions and data types used for MD5 sum
   2    computing library functions.
   3    Copyright (C) 1995, 1996, 2007 Free Software Foundation, Inc.
   4    NOTE: The canonical source of this file is maintained with the GNU C
   5    Library.  Bugs can be reported to bug-glibc@prep.ai.mit.edu.
   6
   7    This program is free software; you can redistribute it and/or modify it
   8    under the terms of the GNU General Public License as published by the
   9    Free Software Foundation; either version 3, or (at your option) any
  10    later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef _MD5_H
  21 #define _MD5_H 1
  22
  23 #include <limits.h>
  24
  25 /* The following contortions are an attempt to use the C preprocessor
  26    to determine an unsigned integral type that is 32 bits wide.  An
  27    alternative approach is to use autoconf's AC_CHECK_SIZEOF macro, but
  28    doing that would require that the configure script compile and *run*
  29    the resulting executable.  Locally running cross-compiled executables
  30    is usually not possible.  */
  31
  32 #ifdef _LIBC
  33 # include <sys/types.h>
  34 typedef u_int32_t md5_uint32;
  35 #else
  36 # if defined __STDC__ && __STDC__
  37 #  define UINT_MAX_32_BITS 4294967295U
  38 # else
  39 #  define UINT_MAX_32_BITS 0xFFFFFFFF
  40 # endif
  41
  42 /* If UINT_MAX isn't defined, assume it's a 32-bit type.
  43    This should be valid for all systems GNU cares about because
  44    that doesn't include 16-bit systems, and only modern systems
  45    (that certainly have <limits.h>) have 64+-bit integral types.  */
  46
  47 # ifndef UINT_MAX
  48 #  define UINT_MAX UINT_MAX_32_BITS
  49 # endif
  50
  51 # if UINT_MAX == UINT_MAX_32_BITS
  52    typedef unsigned int md5_uint32;
  53 # else
  54 #  if USHRT_MAX == UINT_MAX_32_BITS
  55     typedef unsigned short md5_uint32;
  56 #  else
  57 #   if ULONG_MAX == UINT_MAX_32_BITS
  58      typedef unsigned long md5_uint32;
  59 #   else
  60      /* The following line is intended to evoke an error.
  61         Using #error is not portable enough.  */
  62      "Cannot determine unsigned 32-bit data type."
  63 #   endif
  64 #  endif
  65 # endif
  66 #endif
  67
  68 /* Structure to save state of computation between the single steps.  */
  69 struct md5_ctx
  70 {
  71   md5_uint32 A;
  72   md5_uint32 B;
  73   md5_uint32 C;
  74   md5_uint32 D;
  75
  76   md5_uint32 total[2];
  77   md5_uint32 buflen;
  78   char buffer[128];
  79 };
  80
  81 /*
  82  * The following three functions are build up the low level used in
  83  * the functions `md5_stream' and `md5_buffer'.
  84  */
  85
  86 /* Initialize structure containing state of computation.
  87    (RFC 1321, 3.3: Step 3)  */
  88 extern void md5_init_ctx (struct md5_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 md5_process_block (const void *buffer, size_t len,
  95                                struct md5_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 md5_process_bytes (const void *buffer, size_t len,
 102                                struct md5_ctx *ctx);
 103
 104 /* Process the remaining bytes in the buffer and put result from CTX
 105    in first 16 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 is correctly
 110    aligned for a 32 bits value.  */
 111 extern void *md5_finish_ctx (struct md5_ctx *ctx, void *resbuf);
 112
 113
 114 /* Put result from CTX in first 16 bytes following RESBUF.  The result is
 115    always in little endian byte order, so that a byte-wise output yields
 116    to the wanted ASCII representation of the message digest.
 117
 118    IMPORTANT: On some systems it is required that RESBUF is correctly
 119    aligned for a 32 bits value.  */
 120 extern void *md5_read_ctx (const struct md5_ctx *ctx, void *resbuf);
 121
 122
 123 #if 0 /* Unused in Wget */
 124 /* Compute MD5 message digest for bytes read from STREAM.  The
 125    resulting message digest number will be written into the 16 bytes
 126    beginning at RESBLOCK.  */
 127 extern int md5_stream (FILE *stream, void *resblock);
 128 #endif
 129
 130 /* Compute MD5 message digest for LEN bytes beginning at BUFFER.  The
 131    result is always in little endian byte order, so that a byte-wise
 132    output yields to the wanted ASCII representation of the message
 133    digest.  */
 134 extern void *md5_buffer (const char *buffer, size_t len, void *resblock);
 135
 136 #endif