lib/md5.h

   1 /* Declaration of functions and data types used for MD5 sum computing
   2    library functions.
   3    Copyright (C) 1995-1997,1999-2005 Free Software Foundation, Inc.
   4
   5    NOTE: The canonical source of this file is maintained with the GNU C
   6    Library.  Bugs can be reported to bug-glibc@prep.ai.mit.edu.
   7
   8    This program is free software; you can redistribute it and/or modify it
   9    under the terms of the GNU General Public License as published by the
  10    Free Software Foundation; either version 2, or (at your option) any
  11    later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software Foundation,
  20    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  21
  22 #ifndef _MD5_H
  23 #define _MD5_H 1
  24
  25 #include <stdio.h>
  26
  27 #if HAVE_INTTYPES_H
  28 # include <inttypes.h>
  29 #endif
  30 #if HAVE_STDINT_H || _LIBC
  31 # include <stdint.h>
  32 #endif
  33
  34 #ifndef __GNUC_PREREQ
  35 # if defined __GNUC__ && defined __GNUC_MINOR__
  36 #  define __GNUC_PREREQ(maj, min) \
  37         ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  38 # else
  39 #  define __GNUC_PREREQ(maj, min) 0
  40 # endif
  41 #endif
  42
  43 #ifndef __THROW
  44 # if defined __cplusplus && __GNUC_PREREQ (2,8)
  45 #  define __THROW       throw ()
  46 # else
  47 #  define __THROW
  48 # endif
  49 #endif
  50
  51 #ifndef __attribute__
  52 # if ! __GNUC_PREREQ (2,8) || __STRICT_ANSI__
  53 #  define __attribute__(x)
  54 # endif
  55 #endif
  56
  57 #ifndef _LIBC
  58 # define __md5_buffer md5_buffer
  59 # define __md5_finish_ctx md5_finish_ctx
  60 # define __md5_init_ctx md5_init_ctx
  61 # define __md5_process_block md5_process_block
  62 # define __md5_process_bytes md5_process_bytes
  63 # define __md5_read_ctx md5_read_ctx
  64 # define __md5_stream md5_stream
  65 #endif
  66
  67 #define MD5_DIGEST_SIZE 16
  68 #define MD5_BLOCK_SIZE 64
  69
  70 typedef uint32_t md5_uint32;
  71
  72 /* Structure to save state of computation between the single steps.  */
  73 struct md5_ctx
  74 {
  75   md5_uint32 A;
  76   md5_uint32 B;
  77   md5_uint32 C;
  78   md5_uint32 D;
  79
  80   md5_uint32 total[2];
  81   md5_uint32 buflen;
  82   char buffer[128] __attribute__ ((__aligned__ (__alignof__ (md5_uint32))));
  83 };
  84
  85 /*
  86  * The following three functions are build up the low level used in
  87  * the functions `md5_stream' and `md5_buffer'.
  88  */
  89
  90 /* Initialize structure containing state of computation.
  91    (RFC 1321, 3.3: Step 3)  */
  92 extern void __md5_init_ctx (struct md5_ctx *ctx) __THROW;
  93
  94 /* Starting with the result of former calls of this function (or the
  95    initialization function update the context for the next LEN bytes
  96    starting at BUFFER.
  97    It is necessary that LEN is a multiple of 64!!! */
  98 extern void __md5_process_block (const void *buffer, size_t len,
  99                                  struct md5_ctx *ctx) __THROW;
 100
 101 /* Starting with the result of former calls of this function (or the
 102    initialization function update the context for the next LEN bytes
 103    starting at BUFFER.
 104    It is NOT required that LEN is a multiple of 64.  */
 105 extern void __md5_process_bytes (const void *buffer, size_t len,
 106                                  struct md5_ctx *ctx) __THROW;
 107
 108 /* Process the remaining bytes in the buffer and put result from CTX
 109    in first 16 bytes following RESBUF.  The result is always in little
 110    endian byte order, so that a byte-wise output yields to the wanted
 111    ASCII representation of the message digest.
 112
 113    IMPORTANT: On some systems it is required that RESBUF be correctly
 114    aligned for a 32 bits value.  */
 115 extern void *__md5_finish_ctx (struct md5_ctx *ctx, void *resbuf) __THROW;
 116
 117
 118 /* Put result from CTX in first 16 bytes following RESBUF.  The result is
 119    always in little endian byte order, so that a byte-wise output yields
 120    to the wanted ASCII representation of the message digest.
 121
 122    IMPORTANT: On some systems it is required that RESBUF is correctly
 123    aligned for a 32 bits value.  */
 124 extern void *__md5_read_ctx (const struct md5_ctx *ctx, void *resbuf) __THROW;
 125
 126
 127 /* Compute MD5 message digest for bytes read from STREAM.  The
 128    resulting message digest number will be written into the 16 bytes
 129    beginning at RESBLOCK.  */
 130 extern int __md5_stream (FILE *stream, void *resblock) __THROW;
 131
 132 /* Compute MD5 message digest for LEN bytes beginning at BUFFER.  The
 133    result is always in little endian byte order, so that a byte-wise
 134    output yields to the wanted ASCII representation of the message
 135    digest.  */
 136 extern void *__md5_buffer (const char *buffer, size_t len,
 137                            void *resblock) __THROW;
 138
 139 #endif /* md5.h */