lib/md5.h

   1 /* Declaration of functions and data types used for MD5 sum computing
   2    library functions.
   3    Copyright (C) 1995-1997,1999,2000,2001,2004,2005
   4       Free Software Foundation, Inc.
   5    This file is part of the GNU C Library.
   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 2, 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, write to the Free Software Foundation,
  19    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  20
  21 #ifndef _MD5_H
  22 #define _MD5_H 1
  23
  24 #include <stdio.h>
  25 #include <stdint.h>
  26
  27 #define MD5_DIGEST_SIZE 16
  28 #define MD5_BLOCK_SIZE 64
  29
  30 #ifndef __GNUC_PREREQ
  31 # if defined __GNUC__ && defined __GNUC_MINOR__
  32 #  define __GNUC_PREREQ(maj, min)                                       \
  33   ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  34 # else
  35 #  define __GNUC_PREREQ(maj, min) 0
  36 # endif
  37 #endif
  38
  39 #ifndef __THROW
  40 # if defined __cplusplus && __GNUC_PREREQ (2,8)
  41 #  define __THROW       throw ()
  42 # else
  43 #  define __THROW
  44 # endif
  45 #endif
  46
  47 #ifndef __attribute__
  48 # if ! __GNUC_PREREQ (2,8) || __STRICT_ANSI__
  49 #  define __attribute__(x)
  50 # endif
  51 #endif
  52
  53 #ifndef _LIBC
  54 # define __md5_buffer md5_buffer
  55 # define __md5_finish_ctx md5_finish_ctx
  56 # define __md5_init_ctx md5_init_ctx
  57 # define __md5_process_block md5_process_block
  58 # define __md5_process_bytes md5_process_bytes
  59 # define __md5_read_ctx md5_read_ctx
  60 # define __md5_stream md5_stream
  61 #endif
  62
  63 /* Structure to save state of computation between the single steps.  */
  64 struct md5_ctx
  65 {
  66   uint32_t A;
  67   uint32_t B;
  68   uint32_t C;
  69   uint32_t D;
  70
  71   uint32_t total[2];
  72   uint32_t buflen;
  73   char buffer[128] __attribute__ ((__aligned__ (__alignof__ (uint32_t))));
  74 };
  75
  76 /*
  77  * The following three functions are build up the low level used in
  78  * the functions `md5_stream' and `md5_buffer'.
  79  */
  80
  81 /* Initialize structure containing state of computation.
  82    (RFC 1321, 3.3: Step 3)  */
  83 extern void __md5_init_ctx (struct md5_ctx *ctx) __THROW;
  84
  85 /* Starting with the result of former calls of this function (or the
  86    initialization function update the context for the next LEN bytes
  87    starting at BUFFER.
  88    It is necessary that LEN is a multiple of 64!!! */
  89 extern void __md5_process_block (const void *buffer, size_t len,
  90                                  struct md5_ctx *ctx) __THROW;
  91
  92 /* Starting with the result of former calls of this function (or the
  93    initialization function update the context for the next LEN bytes
  94    starting at BUFFER.
  95    It is NOT required that LEN is a multiple of 64.  */
  96 extern void __md5_process_bytes (const void *buffer, size_t len,
  97                                  struct md5_ctx *ctx) __THROW;
  98
  99 /* Process the remaining bytes in the buffer and put result from CTX
 100    in first 16 bytes following RESBUF.  The result is always in little
 101    endian byte order, so that a byte-wise output yields to the wanted
 102    ASCII representation of the message digest.
 103
 104    IMPORTANT: On some systems, RESBUF must be aligned to a 32-bit
 105    boundary. */
 106 extern void *__md5_finish_ctx (struct md5_ctx *ctx, void *resbuf) __THROW;
 107
 108
 109 /* Put result from CTX in first 16 bytes following RESBUF.  The result is
 110    always in little endian byte order, so that a byte-wise output yields
 111    to the wanted ASCII representation of the message digest.
 112
 113    IMPORTANT: On some systems, RESBUF must be aligned to a 32-bit
 114    boundary. */
 115 extern void *__md5_read_ctx (const struct md5_ctx *ctx, void *resbuf) __THROW;
 116
 117
 118 /* Compute MD5 message digest for bytes read from STREAM.  The
 119    resulting message digest number will be written into the 16 bytes
 120    beginning at RESBLOCK.  */
 121 extern int __md5_stream (FILE *stream, void *resblock) __THROW;
 122
 123 /* Compute MD5 message digest for LEN bytes beginning at BUFFER.  The
 124    result is always in little endian byte order, so that a byte-wise
 125    output yields to the wanted ASCII representation of the message
 126    digest.  */
 127 extern void *__md5_buffer (const char *buffer, size_t len,
 128                            void *resblock) __THROW;
 129
 130 #endif /* md5.h */