annotate lib/md5.h @ 742:cddc2692eef4

Define and use macro, PARAMS, not __P.
author Jim Meyering <jim@meyering.net>
date Thu, 17 Oct 1996 02:59:09 +0000
parents b4be735c843c
children 7ee3d04f9624
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
464
Jim Meyering <jim@meyering.net>
parents:
diff changeset
1 /* md5.h - Declaration of functions and data types used for MD5 sum
Jim Meyering <jim@meyering.net>
parents:
diff changeset
2 computing library functions.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
3 Copyright (C) 1995 Free Software Foundation, Inc.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
4
Jim Meyering <jim@meyering.net>
parents:
diff changeset
5 This program is free software; you can redistribute it and/or modify
Jim Meyering <jim@meyering.net>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
Jim Meyering <jim@meyering.net>
parents:
diff changeset
7 the Free Software Foundation; either version 2, or (at your option)
Jim Meyering <jim@meyering.net>
parents:
diff changeset
8 any later version.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
9
Jim Meyering <jim@meyering.net>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
Jim Meyering <jim@meyering.net>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
Jim Meyering <jim@meyering.net>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Jim Meyering <jim@meyering.net>
parents:
diff changeset
13 GNU General Public License for more details.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
14
Jim Meyering <jim@meyering.net>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
Jim Meyering <jim@meyering.net>
parents:
diff changeset
16 along with this program; if not, write to the Free Software
Jim Meyering <jim@meyering.net>
parents:
diff changeset
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
Jim Meyering <jim@meyering.net>
parents:
diff changeset
18
Jim Meyering <jim@meyering.net>
parents:
diff changeset
19 #ifndef _MD5_H
Jim Meyering <jim@meyering.net>
parents:
diff changeset
20 #define _MD5_H
Jim Meyering <jim@meyering.net>
parents:
diff changeset
21
Jim Meyering <jim@meyering.net>
parents:
diff changeset
22 #include <stdio.h>
Jim Meyering <jim@meyering.net>
parents:
diff changeset
23
Jim Meyering <jim@meyering.net>
parents:
diff changeset
24 #if defined HAVE_LIMITS_H || _LIBC
Jim Meyering <jim@meyering.net>
parents:
diff changeset
25 # include <limits.h>
Jim Meyering <jim@meyering.net>
parents:
diff changeset
26 #endif
Jim Meyering <jim@meyering.net>
parents:
diff changeset
27
Jim Meyering <jim@meyering.net>
parents:
diff changeset
28 /* The following contortions are an attempt to use the C preprocessor
Jim Meyering <jim@meyering.net>
parents:
diff changeset
29 to determine an unsigned integral type that is 32 bits wide. An
Jim Meyering <jim@meyering.net>
parents:
diff changeset
30 alternative approach is to use autoconf's AC_CHECK_SIZEOF macro, but
Jim Meyering <jim@meyering.net>
parents:
diff changeset
31 doing that would require that the configure script compile and *run*
Jim Meyering <jim@meyering.net>
parents:
diff changeset
32 the resulting executable. Locally running cross-compiled executables
Jim Meyering <jim@meyering.net>
parents:
diff changeset
33 is usually not possible. */
Jim Meyering <jim@meyering.net>
parents:
diff changeset
34
Jim Meyering <jim@meyering.net>
parents:
diff changeset
35 #if defined __STDC__ && __STDC__
Jim Meyering <jim@meyering.net>
parents:
diff changeset
36 # define UINT_MAX_32_BITS 4294967295U
Jim Meyering <jim@meyering.net>
parents:
diff changeset
37 #else
Jim Meyering <jim@meyering.net>
parents:
diff changeset
38 # define UINT_MAX_32_BITS 0xFFFFFFFF
Jim Meyering <jim@meyering.net>
parents:
diff changeset
39 #endif
Jim Meyering <jim@meyering.net>
parents:
diff changeset
40
Jim Meyering <jim@meyering.net>
parents:
diff changeset
41 /* If UINT_MAX isn't defined, assume it's a 32-bit type.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
42 This should be valid for all systems GNU cares about because
Jim Meyering <jim@meyering.net>
parents:
diff changeset
43 that doesn't include 16-bit systems, and only modern systems
Jim Meyering <jim@meyering.net>
parents:
diff changeset
44 (that certainly have <limits.h>) have 64+-bit integral types. */
Jim Meyering <jim@meyering.net>
parents:
diff changeset
45
Jim Meyering <jim@meyering.net>
parents:
diff changeset
46 #ifndef UINT_MAX
Jim Meyering <jim@meyering.net>
parents:
diff changeset
47 # define UINT_MAX UINT_MAX_32_BITS
Jim Meyering <jim@meyering.net>
parents:
diff changeset
48 #endif
Jim Meyering <jim@meyering.net>
parents:
diff changeset
49
Jim Meyering <jim@meyering.net>
parents:
diff changeset
50 #if UINT_MAX == UINT_MAX_32_BITS
Jim Meyering <jim@meyering.net>
parents:
diff changeset
51 typedef unsigned int md5_uint32;
Jim Meyering <jim@meyering.net>
parents:
diff changeset
52 #else
Jim Meyering <jim@meyering.net>
parents:
diff changeset
53 # if USHRT_MAX == UINT_MAX_32_BITS
Jim Meyering <jim@meyering.net>
parents:
diff changeset
54 typedef unsigned short md5_uint32;
Jim Meyering <jim@meyering.net>
parents:
diff changeset
55 # else
Jim Meyering <jim@meyering.net>
parents:
diff changeset
56 # if ULONG_MAX == UINT_MAX_32_BITS
Jim Meyering <jim@meyering.net>
parents:
diff changeset
57 typedef unsigned long md5_uint32;
Jim Meyering <jim@meyering.net>
parents:
diff changeset
58 # else
Jim Meyering <jim@meyering.net>
parents:
diff changeset
59 /* The following line is intended to evoke an error.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
60 Using #error is not portable enough. */
Jim Meyering <jim@meyering.net>
parents:
diff changeset
61 "Cannot determine unsigned 32-bit data type."
Jim Meyering <jim@meyering.net>
parents:
diff changeset
62 # endif
Jim Meyering <jim@meyering.net>
parents:
diff changeset
63 # endif
Jim Meyering <jim@meyering.net>
parents:
diff changeset
64 #endif
Jim Meyering <jim@meyering.net>
parents:
diff changeset
65
742
cddc2692eef4 Define and use macro, PARAMS, not __P.
Jim Meyering <jim@meyering.net>
parents: 466
diff changeset
66 #undef PARAMS
466
b4be735c843c (md5_stream): Update prototype.
Jim Meyering <jim@meyering.net>
parents: 464
diff changeset
67 #if defined (__STDC__) && __STDC__
742
cddc2692eef4 Define and use macro, PARAMS, not __P.
Jim Meyering <jim@meyering.net>
parents: 466
diff changeset
68 # define PARAMS(x) x
466
b4be735c843c (md5_stream): Update prototype.
Jim Meyering <jim@meyering.net>
parents: 464
diff changeset
69 #else
742
cddc2692eef4 Define and use macro, PARAMS, not __P.
Jim Meyering <jim@meyering.net>
parents: 466
diff changeset
70 # define PARAMS(x) ()
466
b4be735c843c (md5_stream): Update prototype.
Jim Meyering <jim@meyering.net>
parents: 464
diff changeset
71 #endif
b4be735c843c (md5_stream): Update prototype.
Jim Meyering <jim@meyering.net>
parents: 464
diff changeset
72
464
Jim Meyering <jim@meyering.net>
parents:
diff changeset
73 /* Structure to save state of computation between the single steps. */
Jim Meyering <jim@meyering.net>
parents:
diff changeset
74 struct md5_ctx
Jim Meyering <jim@meyering.net>
parents:
diff changeset
75 {
Jim Meyering <jim@meyering.net>
parents:
diff changeset
76 md5_uint32 A;
Jim Meyering <jim@meyering.net>
parents:
diff changeset
77 md5_uint32 B;
Jim Meyering <jim@meyering.net>
parents:
diff changeset
78 md5_uint32 C;
Jim Meyering <jim@meyering.net>
parents:
diff changeset
79 md5_uint32 D;
Jim Meyering <jim@meyering.net>
parents:
diff changeset
80 };
Jim Meyering <jim@meyering.net>
parents:
diff changeset
81
Jim Meyering <jim@meyering.net>
parents:
diff changeset
82 /*
Jim Meyering <jim@meyering.net>
parents:
diff changeset
83 * The following three functions are build up the low level used in
Jim Meyering <jim@meyering.net>
parents:
diff changeset
84 * the functions `md5_stream' and `md5_buffer'.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
85 */
Jim Meyering <jim@meyering.net>
parents:
diff changeset
86
Jim Meyering <jim@meyering.net>
parents:
diff changeset
87 /* Initialize structure containing state of computation.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
88 (RFC 1321, 3.3: Step 3) */
742
cddc2692eef4 Define and use macro, PARAMS, not __P.
Jim Meyering <jim@meyering.net>
parents: 466
diff changeset
89 void md5_init_ctx PARAMS ((struct md5_ctx *ctx));
464
Jim Meyering <jim@meyering.net>
parents:
diff changeset
90
Jim Meyering <jim@meyering.net>
parents:
diff changeset
91 /* Starting with the result of former calls of this function (or the
Jim Meyering <jim@meyering.net>
parents:
diff changeset
92 initialzation function update the context for the next LEN bytes
Jim Meyering <jim@meyering.net>
parents:
diff changeset
93 starting at BUFFER.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
94 It is necessary that LEN is a multiple of 64!!! */
742
cddc2692eef4 Define and use macro, PARAMS, not __P.
Jim Meyering <jim@meyering.net>
parents: 466
diff changeset
95 void md5_process_block PARAMS ((const void *buffer, size_t len,
cddc2692eef4 Define and use macro, PARAMS, not __P.
Jim Meyering <jim@meyering.net>
parents: 466
diff changeset
96 struct md5_ctx *ctx));
464
Jim Meyering <jim@meyering.net>
parents:
diff changeset
97
Jim Meyering <jim@meyering.net>
parents:
diff changeset
98 /* Put result from CTX in first 16 bytes following RESBUF. The result is
Jim Meyering <jim@meyering.net>
parents:
diff changeset
99 always in little endian byte order, so that a byte-wise output yields
Jim Meyering <jim@meyering.net>
parents:
diff changeset
100 to the wanted ASCII representation of the message digest. */
742
cddc2692eef4 Define and use macro, PARAMS, not __P.
Jim Meyering <jim@meyering.net>
parents: 466
diff changeset
101 void *md5_read_ctx PARAMS ((const struct md5_ctx *ctx, void *resbuf));
464
Jim Meyering <jim@meyering.net>
parents:
diff changeset
102
Jim Meyering <jim@meyering.net>
parents:
diff changeset
103
Jim Meyering <jim@meyering.net>
parents:
diff changeset
104 /* Compute MD5 message digest for bytes read from STREAM. The
Jim Meyering <jim@meyering.net>
parents:
diff changeset
105 resulting message digest number will be written into the 16 bytes
Jim Meyering <jim@meyering.net>
parents:
diff changeset
106 beginning at RESBLOCK. */
742
cddc2692eef4 Define and use macro, PARAMS, not __P.
Jim Meyering <jim@meyering.net>
parents: 466
diff changeset
107 int md5_stream PARAMS ((FILE *stream, void *resblock));
464
Jim Meyering <jim@meyering.net>
parents:
diff changeset
108
Jim Meyering <jim@meyering.net>
parents:
diff changeset
109 /* Compute MD5 message digest for LEN bytes beginning at BUFFER. The
Jim Meyering <jim@meyering.net>
parents:
diff changeset
110 result is always in little endian byte order, so that a byte-wise
Jim Meyering <jim@meyering.net>
parents:
diff changeset
111 output yields to the wanted ASCII representation of the message
Jim Meyering <jim@meyering.net>
parents:
diff changeset
112 digest. */
742
cddc2692eef4 Define and use macro, PARAMS, not __P.
Jim Meyering <jim@meyering.net>
parents: 466
diff changeset
113 void *md5_buffer PARAMS ((const char *buffer, size_t len, void *resblock));
464
Jim Meyering <jim@meyering.net>
parents:
diff changeset
114
Jim Meyering <jim@meyering.net>
parents:
diff changeset
115 #endif