1 /* Compute MD5 or SHA1 checksum of files or strings
2 Copyright (C) 1995-2005 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software Foundation,
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
18 /* Written by Ulrich Drepper <drepper@gnu.ai.mit.edu>. */
24 #include <sys/types.h>
35 /* The official name of this program (e.g., no `g' prefix). */
36 #define PROGRAM_NAME (algorithm == ALG_MD5 ? "md5sum" : "sha1sum")
38 #define AUTHORS "Ulrich Drepper", "Scott Miller"
41 #define DIGEST_TYPE_STRING(Alg) ((Alg) == ALG_MD5 ? "MD5" : "SHA1")
42 #define DIGEST_STREAM(Alg) ((Alg) == ALG_MD5 ? md5_stream : sha1_stream)
44 #define DIGEST_BITS(Alg) ((Alg) == ALG_MD5 ? 128 : 160)
45 #define DIGEST_HEX_BYTES(Alg) (DIGEST_BITS (Alg) / 4)
46 #define DIGEST_BIN_BYTES(Alg) (DIGEST_BITS (Alg) / 8)
48 #define MAX_DIGEST_BIN_BYTES MAX (DIGEST_BIN_BYTES (ALG_MD5), \
49 DIGEST_BIN_BYTES (ALG_SHA1))
51 /* The minimum length of a valid digest line. This length does
52 not include any newline character at the end of a line. */
53 #define MIN_DIGEST_LINE_LENGTH(Alg) \
54 (DIGEST_HEX_BYTES (Alg) /* length of hexadecimal message digest */ \
55 + 2 /* blank and binary indicator */ \
56 + 1 /* minimum filename length */ )
58 /* True if any of the files read were the standard input. */
59 static bool have_read_stdin;
61 /* The minimum length of a valid checksum line for the selected algorithm. */
62 static size_t min_digest_line_length;
64 /* Set to the length of a digest hex string for the selected algorithm. */
65 static size_t digest_hex_bytes;
67 /* With --check, don't generate any output.
68 The exit code indicates success or failure. */
69 static bool status_only = false;
71 /* With --check, print a message to standard error warning about each
72 improperly formatted checksum line. */
73 static bool warn = false;
75 /* Declared and set via one of the wrapper .c files. */
76 /* int algorithm = ALG_UNSPECIFIED; */
78 /* The name this program was run with. */
81 /* For long options that have no equivalent short option, use a
82 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
85 STATUS_OPTION = CHAR_MAX + 1
88 static const struct option long_options[] =
90 { "binary", no_argument, NULL, 'b' },
91 { "check", no_argument, NULL, 'c' },
92 { "status", no_argument, NULL, STATUS_OPTION },
93 { "text", no_argument, NULL, 't' },
94 { "warn", no_argument, NULL, 'w' },
95 { GETOPT_HELP_OPTION_DECL },
96 { GETOPT_VERSION_OPTION_DECL },
103 if (status != EXIT_SUCCESS)
104 fprintf (stderr, _("Try `%s --help' for more information.\n"),
109 Usage: %s [OPTION] [FILE]...\n\
110 or: %s [OPTION] --check [FILE]\n\
111 Print or check %s (%d-bit) checksums.\n\
112 With no FILE, or when FILE is -, read standard input.\n\
114 program_name, program_name,
115 DIGEST_TYPE_STRING (algorithm),
116 DIGEST_BITS (algorithm));
119 -b, --binary read files in binary mode (default on DOS/Windows)\n\
120 -c, --check check %s sums against given list\n\
121 -t, --text read files in text mode (default)\n\
124 DIGEST_TYPE_STRING (algorithm));
126 The following two options are useful only when verifying checksums:\n\
127 --status don't output anything, status code shows success\n\
128 -w, --warn warn about improperly formated checksum lines\n\
131 fputs (HELP_OPTION_DESCRIPTION, stdout);
132 fputs (VERSION_OPTION_DESCRIPTION, stdout);
135 The sums are computed as described in %s. When checking, the input\n\
136 should be a former output of this program. The default mode is to print\n\
137 a line with checksum, a character indicating type (`*' for binary, ` ' for\n\
138 text), and name for each FILE.\n"),
139 (algorithm == ALG_MD5 ? "RFC 1321" : "FIPS-180-1"));
140 printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
146 #define ISWHITE(c) ((c) == ' ' || (c) == '\t')
148 /* Split the checksum string S (of length S_LEN) from a BSD 'md5' or
149 'sha1' command into two parts: a hexadecimal digest, and the file
150 name. S is modified. Return true if successful. */
153 bsd_split_3 (char *s, size_t s_len, unsigned char **hex_digest, char **file_name)
159 /* Find end of filename. The BSD 'md5' and 'sha1' commands do not escape
160 filenames, so search backwards for the last ')'. */
162 while (i && s[i] != ')')
170 while (ISWHITE (s[i]))
178 while (ISWHITE (s[i]))
181 *hex_digest = (unsigned char *) &s[i];
185 /* Split the string S (of length S_LEN) into three parts:
186 a hexadecimal digest, binary flag, and the file name.
187 S is modified. Return true if successful. */
190 split_3 (char *s, size_t s_len,
191 unsigned char **hex_digest, bool *binary, char **file_name)
194 bool escaped_filename = false;
195 size_t algo_name_len;
198 while (ISWHITE (s[i]))
201 /* Check for BSD-style checksum line. */
202 algo_name_len = strlen (DIGEST_TYPE_STRING (algorithm));
203 if (strncmp (s + i, DIGEST_TYPE_STRING (algorithm), algo_name_len) == 0)
205 if (strncmp (s + i + algo_name_len, " (", 2) == 0)
208 return bsd_split_3 (s + i + algo_name_len + 2,
209 s_len - (i + algo_name_len + 2),
210 hex_digest, file_name);
214 /* Ignore this line if it is too short.
215 Each line must have at least `min_digest_line_length - 1' (or one more, if
216 the first is a backslash) more characters to contain correct message digest
218 if (s_len - i < min_digest_line_length + (s[i] == '\\'))
224 escaped_filename = true;
226 *hex_digest = (unsigned char *) &s[i];
228 /* The first field has to be the n-character hexadecimal
229 representation of the message digest. If it is not followed
230 immediately by a white space it's an error. */
231 i += digest_hex_bytes;
237 if (s[i] != ' ' && s[i] != '*')
239 *binary = (s[i++] == '*');
241 /* All characters between the type indicator and end of line are
242 significant -- that includes leading and trailing white space. */
245 if (escaped_filename)
247 /* Translate each `\n' string in the file name to a NEWLINE,
248 and each `\\' string to a backslash. */
259 /* A valid line does not end with a backslash. */
272 /* Only `\' or `n' may follow a backslash. */
278 /* The file name may not contain a NUL. */
293 hex_digits (unsigned char const *s)
304 /* An interface to the function, DIGEST_STREAM,
305 (either md5_stream or sha1_stream).
306 Operate on FILENAME (it may be "-") and put the result in *BIN_RESULT.
307 Return true if successful. */
310 digest_file (const char *filename, bool binary, unsigned char *bin_result,
311 int (*digest_stream) (FILE *, void *))
315 bool is_stdin = STREQ (filename, "-");
319 have_read_stdin = true;
322 /* If we need binary reads from a pipe or redirected stdin, we need
323 to switch it to BINARY mode here, since stdin is already open. */
325 SET_BINARY (fileno (stdin));
330 /* OPENOPTS is a macro. It varies with the system.
331 Some systems distinguish between internal and
332 external text representations. */
334 fp = fopen (filename, (O_BINARY && binary ? "rb" : "r"));
337 error (0, errno, "%s", filename);
342 err = (*digest_stream) (fp, bin_result);
345 error (0, errno, "%s", filename);
351 if (!is_stdin && fclose (fp) != 0)
353 error (0, errno, "%s", filename);
361 digest_check (const char *checkfile_name, int (*digest_stream) (FILE *, void *))
363 FILE *checkfile_stream;
364 uintmax_t n_properly_formatted_lines = 0;
365 uintmax_t n_mismatched_checksums = 0;
366 uintmax_t n_open_or_read_failures = 0;
367 unsigned char bin_buffer[MAX_DIGEST_BIN_BYTES];
368 uintmax_t line_number;
370 size_t line_chars_allocated;
371 bool is_stdin = STREQ (checkfile_name, "-");
375 have_read_stdin = true;
376 checkfile_name = _("standard input");
377 checkfile_stream = stdin;
381 checkfile_stream = fopen (checkfile_name, "r");
382 if (checkfile_stream == NULL)
384 error (0, errno, "%s", checkfile_name);
389 SET_MODE (fileno (checkfile_stream), O_TEXT);
392 line_chars_allocated = 0;
397 unsigned char *hex_digest IF_LINT (= NULL);
401 if (line_number == 0)
402 error (EXIT_FAILURE, 0, _("%s: too many checksum lines"),
405 line_length = getline (&line, &line_chars_allocated, checkfile_stream);
406 if (line_length <= 0)
409 /* Ignore comment lines, which begin with a '#' character. */
413 /* Remove any trailing newline. */
414 if (line[line_length - 1] == '\n')
415 line[--line_length] = '\0';
417 if (! (split_3 (line, line_length, &hex_digest, &binary, &filename)
418 && hex_digits (hex_digest)))
424 ": improperly formatted %s checksum line"),
425 checkfile_name, line_number,
426 DIGEST_TYPE_STRING (algorithm));
431 static const char bin2hex[] = { '0', '1', '2', '3',
434 'c', 'd', 'e', 'f' };
437 ++n_properly_formatted_lines;
439 ok = digest_file (filename, binary, bin_buffer, digest_stream);
443 ++n_open_or_read_failures;
446 printf (_("%s: FAILED open or read\n"), filename);
452 size_t digest_bin_bytes = digest_hex_bytes / 2;
454 /* Compare generated binary number with text representation
455 in check file. Ignore case of hex digits. */
456 for (cnt = 0; cnt < digest_bin_bytes; ++cnt)
458 if (TOLOWER (hex_digest[2 * cnt])
459 != bin2hex[bin_buffer[cnt] >> 4]
460 || (TOLOWER (hex_digest[2 * cnt + 1])
461 != (bin2hex[bin_buffer[cnt] & 0xf])))
464 if (cnt != digest_bin_bytes)
465 ++n_mismatched_checksums;
469 printf ("%s: %s\n", filename,
470 (cnt != digest_bin_bytes ? _("FAILED") : _("OK")));
476 while (!feof (checkfile_stream) && !ferror (checkfile_stream));
480 if (ferror (checkfile_stream))
482 error (0, 0, _("%s: read error"), checkfile_name);
486 if (!is_stdin && fclose (checkfile_stream) != 0)
488 error (0, errno, "%s", checkfile_name);
492 if (n_properly_formatted_lines == 0)
494 /* Warn if no tests are found. */
495 error (0, 0, _("%s: no properly formatted %s checksum lines found"),
496 checkfile_name, DIGEST_TYPE_STRING (algorithm));
502 if (n_open_or_read_failures != 0)
504 ngettext ("WARNING: %" PRIuMAX " of %" PRIuMAX
505 " listed file could not be read",
506 "WARNING: %" PRIuMAX " of %" PRIuMAX
507 " listed files could not be read",
508 n_properly_formatted_lines),
509 n_open_or_read_failures, n_properly_formatted_lines);
511 if (n_mismatched_checksums != 0)
513 uintmax_t n_computed_checksums =
514 (n_properly_formatted_lines - n_open_or_read_failures);
516 ngettext ("WARNING: %" PRIuMAX " of %" PRIuMAX
517 " computed checksum did NOT match",
518 "WARNING: %" PRIuMAX " of %" PRIuMAX
519 " computed checksums did NOT match",
520 n_computed_checksums),
521 n_mismatched_checksums, n_computed_checksums);
526 return (n_properly_formatted_lines != 0
527 && n_mismatched_checksums == 0
528 && n_open_or_read_failures == 0);
532 main (int argc, char **argv)
534 unsigned char bin_buffer[MAX_DIGEST_BIN_BYTES];
535 bool do_check = false;
538 bool file_type_specified = false;
541 /* Binary is default on MSDOS, so the actual file contents
542 are used in computation. */
545 /* Text is default of the Plumb/Lankester format. */
549 /* Setting values of global variables. */
550 initialize_main (&argc, &argv);
551 program_name = argv[0];
552 setlocale (LC_ALL, "");
553 bindtextdomain (PACKAGE, LOCALEDIR);
554 textdomain (PACKAGE);
556 atexit (close_stdout);
558 while ((opt = getopt_long (argc, argv, "bctw", long_options, NULL)) != -1)
562 file_type_specified = true;
573 file_type_specified = true;
580 case_GETOPT_HELP_CHAR;
581 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
583 usage (EXIT_FAILURE);
586 min_digest_line_length = MIN_DIGEST_LINE_LENGTH (algorithm);
587 digest_hex_bytes = DIGEST_HEX_BYTES (algorithm);
589 if (file_type_specified & do_check)
591 error (0, 0, _("the --binary and --text options are meaningless when "
592 "verifying checksums"));
593 usage (EXIT_FAILURE);
596 if (status_only & !do_check)
599 _("the --status option is meaningful only when verifying checksums"));
600 usage (EXIT_FAILURE);
603 if (warn & !do_check)
606 _("the --warn option is meaningful only when verifying checksums"));
607 usage (EXIT_FAILURE);
612 if (optind + 1 < argc)
614 error (0, 0, _("extra operand %s"), quote (argv[optind + 1]));
615 fprintf (stderr, "%s\n",
616 _("Only one operand may be specified when using --check."));
617 usage (EXIT_FAILURE);
620 ok = digest_check (optind == argc ? "-" : argv[optind],
621 DIGEST_STREAM (algorithm));
628 for (; optind < argc; ++optind)
630 char *file = argv[optind];
632 if (! digest_file (file, binary, bin_buffer,
633 DIGEST_STREAM (algorithm)))
639 /* Output a leading backslash if the file name contains
640 a newline or backslash. */
641 if (strchr (file, '\n') || strchr (file, '\\'))
644 for (i = 0; i < (digest_hex_bytes / 2); ++i)
645 printf ("%02x", bin_buffer[i]);
653 /* Translate each NEWLINE byte to the string, "\\n",
654 and each backslash to "\\\\". */
655 for (i = 0; i < strlen (file); ++i)
660 fputs ("\\n", stdout);
664 fputs ("\\\\", stdout);
677 if (have_read_stdin && fclose (stdin) == EOF)
678 error (EXIT_FAILURE, errno, _("standard input"));
680 exit (ok ? EXIT_SUCCESS : EXIT_FAILURE);