annotate src/md5.h @ 77734:da987210f778

(ORDINARY_LINK): No longer define on OpenBSD.
author Glenn Morris <rgm@gnu.org>
date Thu, 17 May 2007 07:44:49 +0000
parents e90d04cd455a
children 95d0cdf160ea e16f43875a48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1 /* Declaration of functions and data types used for MD5 sum computing
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
2 library functions.
75227
e90d04cd455a Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 72951
diff changeset
3 Copyright (C) 1995, 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
e90d04cd455a Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 72951
diff changeset
4 2005, 2006, 2007 Free Software Foundation, Inc.
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
5 This file is part of GNU Emacs.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
6
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
7 The GNU C Library is free software; you can redistribute it and/or
72951
751c24f0ec88 Replace "GNU Library General Public License" by "GNU General Public
Jay Belanger <jay.p.belanger@gmail.com>
parents: 68651
diff changeset
8 modify it under the terms of the GNU General Public License as
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
9 published by the Free Software Foundation; either version 2 of the
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
10 License, or (at your option) any later version.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
11
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
12 The GNU C Library is distributed in the hope that it will be useful,
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
72951
751c24f0ec88 Replace "GNU Library General Public License" by "GNU General Public
Jay Belanger <jay.p.belanger@gmail.com>
parents: 68651
diff changeset
15 General Public License for more details.
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
16
72951
751c24f0ec88 Replace "GNU Library General Public License" by "GNU General Public
Jay Belanger <jay.p.belanger@gmail.com>
parents: 68651
diff changeset
17 You should have received a copy of the GNU General Public
751c24f0ec88 Replace "GNU Library General Public License" by "GNU General Public
Jay Belanger <jay.p.belanger@gmail.com>
parents: 68651
diff changeset
18 License along with the GNU C Library; see the file COPYING. If not,
64084
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
19 write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
20 Boston, MA 02110-1301, USA. */
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
21
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
22 #ifndef _MD5_H
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
23 #define _MD5_H 1
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
24
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
25 #include <stdio.h>
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
26
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
27 #if defined HAVE_LIMITS_H || _LIBC
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
28 # include <limits.h>
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
29 #endif
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
30
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
31 /* The following contortions are an attempt to use the C preprocessor
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
32 to determine an unsigned integral type that is 32 bits wide. An
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
33 alternative approach is to use autoconf's AC_CHECK_SIZEOF macro, but
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
34 doing that would require that the configure script compile and *run*
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
35 the resulting executable. Locally running cross-compiled executables
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
36 is usually not possible. */
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
37
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
38 #ifdef _LIBC
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
39 # include <sys/types.h>
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
40 typedef u_int32_t md5_uint32;
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
41 #else
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
42 # if defined __STDC__ && __STDC__
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
43 # define UINT_MAX_32_BITS 4294967295U
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
44 # else
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
45 # define UINT_MAX_32_BITS 0xFFFFFFFF
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
46 # endif
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
47
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
48 /* If UINT_MAX isn't defined, assume it's a 32-bit type.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
49 This should be valid for all systems GNU cares about because
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
50 that doesn't include 16-bit systems, and only modern systems
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
51 (that certainly have <limits.h>) have 64+-bit integral types. */
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
52
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
53 # ifndef UINT_MAX
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
54 # define UINT_MAX UINT_MAX_32_BITS
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
55 # endif
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
56
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
57 # if UINT_MAX == UINT_MAX_32_BITS
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
58 typedef unsigned int md5_uint32;
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
59 # else
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
60 # if USHRT_MAX == UINT_MAX_32_BITS
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
61 typedef unsigned short md5_uint32;
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
62 # else
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
63 # if ULONG_MAX == UINT_MAX_32_BITS
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
64 typedef unsigned long md5_uint32;
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
65 # else
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
66 /* The following line is intended to evoke an error.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
67 Using #error is not portable enough. */
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
68 "Cannot determine unsigned 32-bit data type."
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
69 # endif
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
70 # endif
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
71 # endif
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
72 #endif
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
73
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
74
34231
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
75 #ifndef __GNUC__
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
76 #define __attribute__(X)
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
77 #define __alignof__(X) 1
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
78 #endif
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
79
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
80 /* Structure to save state of computation between the single steps. */
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
81 struct md5_ctx
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
82 {
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
83 md5_uint32 A;
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
84 md5_uint32 B;
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
85 md5_uint32 C;
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
86 md5_uint32 D;
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
87
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
88 md5_uint32 total[2];
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
89 md5_uint32 buflen;
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
90 char buffer[128] __attribute__ ((__aligned__ (__alignof__ (md5_uint32))));
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
91 };
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
92
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
93 /*
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
94 * The following three functions are build up the low level used in
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
95 * the functions `md5_stream' and `md5_buffer'.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
96 */
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
97
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
98 /* Initialize structure containing state of computation.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
99 (RFC 1321, 3.3: Step 3) */
34231
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
100 extern void md5_init_ctx __P ((struct md5_ctx *ctx));
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
101
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
102 /* Starting with the result of former calls of this function (or the
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
103 initialization function update the context for the next LEN bytes
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
104 starting at BUFFER.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
105 It is necessary that LEN is a multiple of 64!!! */
34231
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
106 extern void md5_process_block __P ((const void *buffer, size_t len,
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
107 struct md5_ctx *ctx));
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
108
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
109 /* Starting with the result of former calls of this function (or the
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
110 initialization function update the context for the next LEN bytes
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
111 starting at BUFFER.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
112 It is NOT required that LEN is a multiple of 64. */
34231
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
113 extern void md5_process_bytes __P ((const void *buffer, size_t len,
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
114 struct md5_ctx *ctx));
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
115
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
116 /* Process the remaining bytes in the buffer and put result from CTX
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
117 in first 16 bytes following RESBUF. The result is always in little
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
118 endian byte order, so that a byte-wise output yields to the wanted
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
119 ASCII representation of the message digest.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
120
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
121 IMPORTANT: On some systems it is required that RESBUF is correctly
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
122 aligned for a 32 bits value. */
34231
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
123 extern void *md5_finish_ctx __P ((struct md5_ctx *ctx, void *resbuf));
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
124
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
125
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
126 /* Put result from CTX in first 16 bytes following RESBUF. The result is
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
127 always in little endian byte order, so that a byte-wise output yields
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
128 to the wanted ASCII representation of the message digest.
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
129
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
130 IMPORTANT: On some systems it is required that RESBUF is correctly
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
131 aligned for a 32 bits value. */
34231
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
132 extern void *md5_read_ctx __P ((const struct md5_ctx *ctx, void *resbuf));
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
133
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
134
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
135 /* Compute MD5 message digest for bytes read from STREAM. The
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
136 resulting message digest number will be written into the 16 bytes
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
137 beginning at RESBLOCK. */
34231
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
138 extern int md5_stream __P ((FILE *stream, void *resblock));
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
139
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
140 /* Compute MD5 message digest for LEN bytes beginning at BUFFER. The
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
141 result is always in little endian byte order, so that a byte-wise
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
142 output yields to the wanted ASCII representation of the message
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
143 digest. */
34231
afdc28d28aaa Remove underscores from function declarations.
Jason Rumney <jasonr@gnu.org>
parents: 34054
diff changeset
144 extern void *md5_buffer __P ((const char *buffer, size_t len,
34054
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
145 void *resblock));
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
146
da7a782777bc *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
147 #endif /* md5.h */
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 34310
diff changeset
148
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 34310
diff changeset
149 /* arch-tag: 7cd389f3-6c40-4950-999d-0b2ebd1d20d7
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 34310
diff changeset
150 (do not change this comment) */