daily update
[binutils.git] / include / md5.h
blobb3ff4e14538dc67c3a07d16db7ff057c6359553e
1 /* md5.h - Declaration of functions and data types used for MD5 sum
2 computing library functions.
3 Copyright 1995, 1996, 2000 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.
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.
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.
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. */
21 #ifndef _MD5_H
22 #define _MD5_H 1
24 #include <stdio.h>
26 #if defined HAVE_LIMITS_H || _LIBC
27 # include <limits.h>
28 #endif
30 #include "ansidecl.h"
32 /* The following contortions are an attempt to use the C preprocessor
33 to determine an unsigned integral type that is 32 bits wide. An
34 alternative approach is to use autoconf's AC_CHECK_SIZEOF macro, but
35 doing that would require that the configure script compile and *run*
36 the resulting executable. Locally running cross-compiled executables
37 is usually not possible. */
39 #ifdef _LIBC
40 # include <sys/types.h>
41 typedef u_int32_t md5_uint32;
42 typedef uintptr_t md5_uintptr;
43 #else
44 # define INT_MAX_32_BITS 2147483647
46 /* If UINT_MAX isn't defined, assume it's a 32-bit type.
47 This should be valid for all systems GNU cares about because
48 that doesn't include 16-bit systems, and only modern systems
49 (that certainly have <limits.h>) have 64+-bit integral types. */
51 # ifndef INT_MAX
52 # define INT_MAX INT_MAX_32_BITS
53 # endif
55 # if INT_MAX == INT_MAX_32_BITS
56 typedef unsigned int md5_uint32;
57 # else
58 # if SHRT_MAX == INT_MAX_32_BITS
59 typedef unsigned short md5_uint32;
60 # else
61 # if LONG_MAX == INT_MAX_32_BITS
62 typedef unsigned long md5_uint32;
63 # else
64 /* The following line is intended to evoke an error.
65 Using #error is not portable enough. */
66 "Cannot determine unsigned 32-bit data type."
67 # endif
68 # endif
69 # endif
70 /* We have to make a guess about the integer type equivalent in size
71 to pointers which should always be correct. */
72 typedef unsigned long int md5_uintptr;
73 #endif
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
79 /* Structure to save state of computation between the single steps. */
80 struct md5_ctx
82 md5_uint32 A;
83 md5_uint32 B;
84 md5_uint32 C;
85 md5_uint32 D;
87 md5_uint32 total[2];
88 md5_uint32 buflen;
89 char buffer[128] ATTRIBUTE_ALIGNED_ALIGNOF(md5_uint32);
93 * The following three functions are build up the low level used in
94 * the functions `md5_stream' and `md5_buffer'.
97 /* Initialize structure containing state of computation.
98 (RFC 1321, 3.3: Step 3) */
99 extern void md5_init_ctx (struct md5_ctx *ctx);
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 necessary that LEN is a multiple of 64!!! */
105 extern void md5_process_block (const void *buffer, size_t len,
106 struct md5_ctx *ctx);
108 /* Starting with the result of former calls of this function (or the
109 initialization function update the context for the next LEN bytes
110 starting at BUFFER.
111 It is NOT required that LEN is a multiple of 64. */
112 extern void md5_process_bytes (const void *buffer, size_t len,
113 struct md5_ctx *ctx);
115 /* Process the remaining bytes in the buffer and put result from CTX
116 in first 16 bytes following RESBUF. The result is always in little
117 endian byte order, so that a byte-wise output yields to the wanted
118 ASCII representation of the message digest.
120 IMPORTANT: On some systems it is required that RESBUF is correctly
121 aligned for a 32 bits value. */
122 extern void *md5_finish_ctx (struct md5_ctx *ctx, void *resbuf);
125 /* Put result from CTX in first 16 bytes following RESBUF. The result is
126 always in little endian byte order, so that a byte-wise output yields
127 to the wanted ASCII representation of the message digest.
129 IMPORTANT: On some systems it is required that RESBUF is correctly
130 aligned for a 32 bits value. */
131 extern void *md5_read_ctx (const struct md5_ctx *ctx, void *resbuf);
134 /* Compute MD5 message digest for bytes read from STREAM. The
135 resulting message digest number will be written into the 16 bytes
136 beginning at RESBLOCK. */
137 extern int md5_stream (FILE *stream, void *resblock);
139 /* Compute MD5 message digest for LEN bytes beginning at BUFFER. The
140 result is always in little endian byte order, so that a byte-wise
141 output yields to the wanted ASCII representation of the message
142 digest. */
143 extern void *md5_buffer (const char *buffer, size_t len, void *resblock);
145 #ifdef __cplusplus
147 #endif
149 #endif