Update lintian overrides
[alioth/cvs.git] / 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 typedef uint32_t md5_uint32;
68
69 /* Structure to save state of computation between the single steps.  */
70 struct md5_ctx
71 {
72   md5_uint32 A;
73   md5_uint32 B;
74   md5_uint32 C;
75   md5_uint32 D;
76
77   md5_uint32 total[2];
78   md5_uint32 buflen;
79   char buffer[128] __attribute__ ((__aligned__ (__alignof__ (md5_uint32))));
80 };
81
82 /*
83  * The following three functions are build up the low level used in
84  * the functions `md5_stream' and `md5_buffer'.
85  */
86
87 /* Initialize structure containing state of computation.
88    (RFC 1321, 3.3: Step 3)  */
89 extern void __md5_init_ctx (struct md5_ctx *ctx) __THROW;
90
91 /* Starting with the result of former calls of this function (or the
92    initialization function update the context for the next LEN bytes
93    starting at BUFFER.
94    It is necessary that LEN is a multiple of 64!!! */
95 extern void __md5_process_block (const void *buffer, size_t len,
96                                  struct md5_ctx *ctx) __THROW;
97
98 /* Starting with the result of former calls of this function (or the
99    initialization function update the context for the next LEN bytes
100    starting at BUFFER.
101    It is NOT required that LEN is a multiple of 64.  */
102 extern void __md5_process_bytes (const void *buffer, size_t len,
103                                  struct md5_ctx *ctx) __THROW;
104
105 /* Process the remaining bytes in the buffer and put result from CTX
106    in first 16 bytes following RESBUF.  The result is always in little
107    endian byte order, so that a byte-wise output yields to the wanted
108    ASCII representation of the message digest.
109
110    IMPORTANT: On some systems it is required that RESBUF be correctly
111    aligned for a 32 bits value.  */
112 extern void *__md5_finish_ctx (struct md5_ctx *ctx, void *resbuf) __THROW;
113
114
115 /* Put result from CTX in first 16 bytes following RESBUF.  The result is
116    always in little endian byte order, so that a byte-wise output yields
117    to the wanted ASCII representation of the message digest.
118
119    IMPORTANT: On some systems it is required that RESBUF is correctly
120    aligned for a 32 bits value.  */
121 extern void *__md5_read_ctx (const struct md5_ctx *ctx, void *resbuf) __THROW;
122
123
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) __THROW;
128
129 /* Compute MD5 message digest for LEN bytes beginning at BUFFER.  The
130    result is always in little endian byte order, so that a byte-wise
131    output yields to the wanted ASCII representation of the message
132    digest.  */
133 extern void *__md5_buffer (const char *buffer, size_t len,
134                            void *resblock) __THROW;
135
136 #endif /* md5.h */