1 /* Compute MD5 checksum of files or strings according to the definition
2 of MD5 in RFC 1321 from April 1992.
3 Copyright (C) 1995-1999 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
19 /* Written by Ulrich Drepper <drepper@gnu.ai.mit.edu>. */
27 #include <sys/types.h>
29 #include "long-options.h"
35 /* Most systems do not distinguish between external and internal
36 text representations. */
37 /* FIXME: This begs for an autoconf test. */
39 # define OPENOPTS(BINARY) ((BINARY) != 0 ? TEXT1TO1 : TEXTCNVT)
40 # define TEXT1TO1 "rb"
44 # define OPENOPTS(BINARY) ((BINARY) != 0 ? TEXT1TO1 : TEXTCNVT)
45 # define TEXT1TO1 "rb", "ctx=stm"
46 # define TEXTCNVT "r", "ctx=stm"
48 # if UNIX || __UNIX__ || unix || __unix__ || _POSIX_VERSION
49 # define OPENOPTS(BINARY) "r"
51 /* The following line is intended to evoke an error.
52 Using #error is not portable enough. */
53 "Cannot determine system type."
58 #if _LIBC || STDC_HEADERS
59 # define TOLOWER(c) tolower (c)
61 # define TOLOWER(c) (ISUPPER (c) ? tolower (c) : (c))
64 /* The minimum length of a valid digest line in a file produced
65 by `md5sum FILE' and read by `md5sum --check'. This length does
66 not include any newline character at the end of a line. */
67 #define MIN_DIGEST_LINE_LENGTH (32 /* message digest length */ \
68 + 2 /* blank and binary indicator */ \
69 + 1 /* minimum filename length */ )
71 /* Nonzero if any of the files read were the standard input. */
72 static int have_read_stdin;
74 /* With --check, don't generate any output.
75 The exit code indicates success or failure. */
76 static int status_only = 0;
78 /* With --check, print a message to standard error warning about each
79 improperly formatted MD5 checksum line. */
82 /* The name this program was run with. */
85 static const struct option long_options[] =
87 { "binary", no_argument, 0, 'b' },
88 { "check", no_argument, 0, 'c' },
89 { "status", no_argument, 0, 2 },
90 { "string", required_argument, 0, 1 },
91 { "text", no_argument, 0, 't' },
92 { "warn", no_argument, 0, 'w' },
100 fprintf (stderr, _("Try `%s --help' for more information.\n"),
105 Usage: %s [OPTION] [FILE]...\n\
106 or: %s [OPTION] --check [FILE]\n\
107 Print or check MD5 checksums.\n\
108 With no FILE, or when FILE is -, read standard input.\n\
110 -b, --binary read files in binary mode (default on DOS/Windows)\n\
111 -c, --check check MD5 sums against given list\n\
112 -t, --text read files in text mode (default)\n\
114 The following two options are useful only when verifying checksums:\n\
115 --status don't output anything, status code shows success\n\
116 -w, --warn warn about improperly formated MD5 checksum lines\n\
118 --help display this help and exit\n\
119 --version output version information and exit\n\
121 The sums are computed as described in RFC 1321. When checking, the input\n\
122 should be a former output of this program. The default mode is to print\n\
123 a line with checksum, a character indicating type (`*' for binary, ` ' for\n\
124 text), and name for each FILE.\n"),
125 program_name, program_name);
126 puts (_("\nReport bugs to <bug-textutils@gnu.org>."));
129 exit (status == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
133 split_3 (char *s, size_t s_len, unsigned char **u, int *binary, char **w)
136 int escaped_filename = 0;
138 #define ISWHITE(c) ((c) == ' ' || (c) == '\t')
141 while (ISWHITE (s[i]))
144 /* The line must have at least 35 (36 if the first is a backslash)
145 more characters to contain correct message digest information.
146 Ignore this line if it is too short. */
147 if (!(s_len - i >= MIN_DIGEST_LINE_LENGTH
148 || (s[i] == '\\' && s_len - i >= 1 + MIN_DIGEST_LINE_LENGTH)))
154 escaped_filename = 1;
156 *u = (unsigned char *) &s[i];
158 /* The first field has to be the 32-character hexadecimal
159 representation of the message digest. If it is not followed
160 immediately by a white space it's an error. */
167 if (s[i] != ' ' && s[i] != '*')
169 *binary = (s[i++] == '*');
171 /* All characters between the type indicator and end of line are
172 significant -- that includes leading and trailing white space. */
175 if (escaped_filename)
177 /* Translate each `\n' string in the file name to a NEWLINE,
178 and each `\\' string to a backslash. */
189 /* A valid line does not end with a backslash. */
202 /* Only `\' or `n' may follow a backslash. */
208 /* The file name may not contain a NUL. */
223 hex_digits (unsigned char const *s)
234 /* An interface to md5_stream. Operate on FILENAME (it may be "-") and
235 put the result in *MD5_RESULT. Return non-zero upon failure, zero
236 to indicate success. */
239 md5_file (const char *filename, int binary, unsigned char *md5_result)
244 if (STREQ (filename, "-"))
249 /* If we need binary reads from a pipe or redirected stdin, we need
250 to switch it to BINARY mode here, since stdin is already open. */
252 SET_BINARY (fileno (stdin));
257 /* OPENOPTS is a macro. It varies with the system.
258 Some systems distinguish between internal and
259 external text representations. */
261 fp = fopen (filename, OPENOPTS (binary));
264 error (0, errno, "%s", filename);
269 err = md5_stream (fp, md5_result);
272 error (0, errno, "%s", filename);
278 if (fp != stdin && fclose (fp) == EOF)
280 error (0, errno, "%s", filename);
288 md5_check (const char *checkfile_name)
290 FILE *checkfile_stream;
291 int n_properly_formated_lines = 0;
292 int n_mismatched_checksums = 0;
293 int n_open_or_read_failures = 0;
294 unsigned char md5buffer[16];
297 size_t line_chars_allocated;
299 if (STREQ (checkfile_name, "-"))
302 checkfile_name = _("standard input");
303 checkfile_stream = stdin;
307 checkfile_stream = fopen (checkfile_name, "r");
308 if (checkfile_stream == NULL)
310 error (0, errno, "%s", checkfile_name);
317 line_chars_allocated = 0;
322 unsigned char *md5num;
328 line_length = getline (&line, &line_chars_allocated, checkfile_stream);
329 if (line_length <= 0)
332 /* Ignore comment lines, which begin with a '#' character. */
336 /* Remove any trailing newline. */
337 if (line[line_length - 1] == '\n')
338 line[--line_length] = '\0';
340 err = split_3 (line, line_length, &md5num, &binary, &filename);
341 if (err || !hex_digits (md5num))
346 _("%s: %lu: improperly formatted MD5 checksum line"),
347 checkfile_name, (unsigned long) line_number);
352 static const char bin2hex[] = { '0', '1', '2', '3',
355 'c', 'd', 'e', 'f' };
358 ++n_properly_formated_lines;
360 fail = md5_file (filename, binary, md5buffer);
364 ++n_open_or_read_failures;
367 printf (_("%s: FAILED open or read\n"), filename);
374 /* Compare generated binary number with text representation
375 in check file. Ignore case of hex digits. */
376 for (cnt = 0; cnt < 16; ++cnt)
378 if (TOLOWER (md5num[2 * cnt]) != bin2hex[md5buffer[cnt] >> 4]
379 || (TOLOWER (md5num[2 * cnt + 1])
380 != (bin2hex[md5buffer[cnt] & 0xf])))
384 ++n_mismatched_checksums;
388 printf ("%s: %s\n", filename,
389 (cnt != 16 ? _("FAILED") : _("OK")));
395 while (!feof (checkfile_stream) && !ferror (checkfile_stream));
400 if (ferror (checkfile_stream))
402 error (0, 0, _("%s: read error"), checkfile_name);
406 if (checkfile_stream != stdin && fclose (checkfile_stream) == EOF)
408 error (0, errno, "%s", checkfile_name);
412 if (n_properly_formated_lines == 0)
414 /* Warn if no tests are found. */
415 error (0, 0, _("%s: no properly formatted MD5 checksum lines found"),
422 int n_computed_checkums = (n_properly_formated_lines
423 - n_open_or_read_failures);
425 if (n_open_or_read_failures > 0)
428 _("WARNING: %d of %d listed %s could not be read\n"),
429 n_open_or_read_failures, n_properly_formated_lines,
430 (n_properly_formated_lines == 1
431 ? _("file") : _("files")));
434 if (n_mismatched_checksums > 0)
437 _("WARNING: %d of %d computed %s did NOT match"),
438 n_mismatched_checksums, n_computed_checkums,
439 (n_computed_checkums == 1
440 ? _("checksum") : _("checksums")));
445 return ((n_properly_formated_lines > 0 && n_mismatched_checksums == 0
446 && n_open_or_read_failures == 0) ? 0 : 1);
450 main (int argc, char **argv)
452 unsigned char md5buffer[16];
455 char **string = NULL;
456 size_t n_strings = 0;
458 int file_type_specified = 0;
461 /* Binary is default on MSDOS, so the actual file contents
462 are used in computation. */
465 /* Text is default of the Plumb/Lankester format. */
469 /* Setting values of global variables. */
470 program_name = argv[0];
471 setlocale (LC_ALL, "");
472 bindtextdomain (PACKAGE, LOCALEDIR);
473 textdomain (PACKAGE);
475 parse_long_options (argc, argv, "md5sum", GNU_PACKAGE, VERSION,
476 "Ulrich Drepper", usage);
478 while ((opt = getopt_long (argc, argv, "bctw", long_options, NULL)) != -1)
481 case 0: /* long option */
483 case 1: /* --string */
486 string = (char **) xmalloc ((argc - 1) * sizeof (char *));
490 string[n_strings++] = optarg;
494 file_type_specified = 1;
505 file_type_specified = 1;
513 usage (EXIT_FAILURE);
516 if (file_type_specified && do_check)
518 error (0, 0, _("the --binary and --text options are meaningless when \
519 verifying checksums"));
520 usage (EXIT_FAILURE);
523 if (n_strings > 0 && do_check)
526 _("the --string and --check options are mutually exclusive"));
527 usage (EXIT_FAILURE);
530 if (status_only && !do_check)
533 _("the --status option is meaningful only when verifying checksums"));
534 usage (EXIT_FAILURE);
537 if (warn && !do_check)
540 _("the --warn option is meaningful only when verifying checksums"));
541 usage (EXIT_FAILURE);
550 error (0, 0, _("no files may be specified when using --string"));
551 usage (EXIT_FAILURE);
553 for (i = 0; i < n_strings; ++i)
556 md5_buffer (string[i], strlen (string[i]), md5buffer);
558 for (cnt = 0; cnt < 16; ++cnt)
559 printf ("%02x", md5buffer[cnt]);
561 printf (" \"%s\"\n", string[i]);
566 if (optind + 1 < argc)
569 _("only one argument may be specified when using --check"));
570 usage (EXIT_FAILURE);
573 err = md5_check ((optind == argc) ? "-" : argv[optind]);
580 for (; optind < argc; ++optind)
583 char *file = argv[optind];
585 fail = md5_file (file, binary, md5buffer);
591 /* Output a leading backslash if the file name contains
592 a newline or backslash. */
593 if (strchr (file, '\n') || strchr (file, '\\'))
596 for (i = 0; i < 16; ++i)
597 printf ("%02x", md5buffer[i]);
605 /* Translate each NEWLINE byte to the string, "\\n",
606 and each backslash to "\\\\". */
607 for (i = 0; i < strlen (file); ++i)
612 fputs ("\\n", stdout);
616 fputs ("\\\\", stdout);
629 if (fclose (stdout) == EOF)
630 error (EXIT_FAILURE, errno, _("write error"));
632 if (have_read_stdin && fclose (stdin) == EOF)
633 error (EXIT_FAILURE, errno, _("standard input"));
635 exit (err == 0 ? EXIT_SUCCESS : EXIT_FAILURE);