md5/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,2006,2008,2009
   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 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, 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 _LIBC
  48 # define __md5_buffer md5_buffer
  49 # define __md5_finish_ctx md5_finish_ctx
  50 # define __md5_init_ctx md5_init_ctx
  51 # define __md5_process_block md5_process_block
  52 # define __md5_process_bytes md5_process_bytes
  53 # define __md5_read_ctx md5_read_ctx
  54 # define __md5_stream md5_stream
  55 #endif
  56
  57 # ifdef __cplusplus
  58 extern "C" {
  59 # endif
  60
  61 /* Structure to save state of computation between the single steps.  */
  62 struct md5_ctx
  63 {
  64   uint32_t A;
  65   uint32_t B;
  66   uint32_t C;
  67   uint32_t D;
  68
  69   uint32_t total[2];
  70   uint32_t buflen;
  71   uint32_t buffer[32];
  72 };
  73
  74 /*
  75  * The following three functions are build up the low level used in
  76  * the functions `md5_stream' and `md5_buffer'.
  77  */
  78
  79 /* Initialize structure containing state of computation.
  80    (RFC 1321, 3.3: Step 3)  */
  81 extern void __md5_init_ctx (struct md5_ctx *ctx) __THROW;
  82
  83 /* Starting with the result of former calls of this function (or the
  84    initialization function update the context for the next LEN bytes
  85    starting at BUFFER.
  86    It is necessary that LEN is a multiple of 64!!! */
  87 extern void __md5_process_block (const void *buffer, size_t len,
  88                                  struct md5_ctx *ctx) __THROW;
  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 NOT required that LEN is a multiple of 64.  */
  94 extern void __md5_process_bytes (const void *buffer, size_t len,
  95                                  struct md5_ctx *ctx) __THROW;
  96
  97 /* Process the remaining bytes in the buffer and put result from CTX
  98    in first 16 bytes following RESBUF.  The result is always in little
  99    endian byte order, so that a byte-wise output yields to the wanted
 100    ASCII representation of the message digest.  */
 101 extern void *__md5_finish_ctx (struct md5_ctx *ctx, void *resbuf) __THROW;
 102
 103
 104 /* Put result from CTX in first 16 bytes following RESBUF.  The result is
 105    always in little endian byte order, so that a byte-wise output yields
 106    to the wanted ASCII representation of the message digest.  */
 107 extern void *__md5_read_ctx (const struct md5_ctx *ctx, void *resbuf) __THROW;
 108
 109
 110 /* Compute MD5 message digest for bytes read from STREAM.  The
 111    resulting message digest number will be written into the 16 bytes
 112    beginning at RESBLOCK.  */
 113 extern int __md5_stream (FILE *stream, void *resblock) __THROW;
 114
 115 /* Compute MD5 message digest for LEN bytes beginning at BUFFER.  The
 116    result is always in little endian byte order, so that a byte-wise
 117    output yields to the wanted ASCII representation of the message
 118    digest.  */
 119 extern void *__md5_buffer (const char *buffer, size_t len,
 120                            void *resblock) __THROW;
 121
 122 # ifdef __cplusplus
 123 }
 124 # endif
 125
 126 #endif /* md5.h */