1 /* Compute MD5 or SHA1 checksum of files or strings
2 Copyright (C) 1995-2001 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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" : "shasum")
38 #define AUTHORS N_ ("Ulrich Drepper and Scott Miller")
40 /* Most systems do not distinguish between external and internal
41 text representations. */
42 /* FIXME: This begs for an autoconf test. */
44 # define OPENOPTS(BINARY) ((BINARY) != 0 ? TEXT1TO1 : TEXTCNVT)
45 # define TEXT1TO1 "rb"
49 # define OPENOPTS(BINARY) ((BINARY) != 0 ? TEXT1TO1 : TEXTCNVT)
50 # define TEXT1TO1 "rb", "ctx=stm"
51 # define TEXTCNVT "r", "ctx=stm"
53 # if UNIX || __UNIX__ || unix || __unix__ || _POSIX_VERSION
54 # define OPENOPTS(BINARY) "r"
56 /* The following line is intended to evoke an error.
57 Using #error is not portable enough. */
58 "Cannot determine system type."
64 #define DIGEST_TYPE_STRING(Alg) ((Alg) == ALG_MD5 ? "MD5" : "SHA1")
65 #define DIGEST_STREAM(Alg) ((Alg) == ALG_MD5 ? md5_stream : sha_stream)
67 #define DIGEST_BITS(Alg) ((Alg) == ALG_MD5 ? 128 : 160)
68 #define DIGEST_HEX_BYTES(Alg) (DIGEST_BITS (Alg) / 4)
69 #define DIGEST_BIN_BYTES(Alg) (DIGEST_BITS (Alg) / 8)
71 #define MAX_DIGEST_BIN_BYTES MAX (DIGEST_BIN_BYTES (ALG_MD5), \
72 DIGEST_BIN_BYTES (ALG_SHA1))
74 /* The minimum length of a valid digest line. This length does
75 not include any newline character at the end of a line. */
76 #define MIN_DIGEST_LINE_LENGTH(Alg) \
77 (DIGEST_HEX_BYTES (Alg) /* length of hexadecimal message digest */ \
78 + 2 /* blank and binary indicator */ \
79 + 1 /* minimum filename length */ )
81 /* Nonzero if any of the files read were the standard input. */
82 static int have_read_stdin;
84 /* The minimum length of a valid checksum line for the selected algorithm. */
85 static int min_digest_line_length;
87 /* Set to the length of a digest hex string for the selected algorithm. */
88 static size_t digest_hex_bytes;
90 /* With --check, don't generate any output.
91 The exit code indicates success or failure. */
92 static int status_only = 0;
94 /* With --check, print a message to standard error warning about each
95 improperly formatted checksum line. */
98 /* Declared and set via one of the wrapper .c files. */
99 /* int algorithm = ALG_UNSPECIFIED; */
101 /* The name this program was run with. */
104 static const struct option long_options[] =
106 { "binary", no_argument, 0, 'b' },
107 { "check", no_argument, 0, 'c' },
108 { "status", no_argument, 0, 2 },
109 { "string", required_argument, 0, 1 },
110 { "text", no_argument, 0, 't' },
111 { "warn", no_argument, 0, 'w' },
112 { GETOPT_HELP_OPTION_DECL },
113 { GETOPT_VERSION_OPTION_DECL },
121 fprintf (stderr, _("Try `%s --help' for more information.\n"),
126 Usage: %s [OPTION] [FILE]...\n\
127 or: %s [OPTION] --check [FILE]\n\
128 Print or check %s (%d-bit) checksums.\n\
129 With no FILE, or when FILE is -, read standard input.\n\
131 program_name, program_name,
132 DIGEST_TYPE_STRING (algorithm),
133 DIGEST_BITS (algorithm));
136 -b, --binary read files in binary mode (default on DOS/Windows)\n\
137 -c, --check check %s sums against given list\n\
138 -t, --text read files in text mode (default)\n\
141 DIGEST_TYPE_STRING (algorithm));
143 The following two options are useful only when verifying checksums:\n\
144 --status don't output anything, status code shows success\n\
145 -w, --warn warn about improperly formated checksum lines\n\
148 fputs (HELP_OPTION_DESCRIPTION, stdout);
149 fputs (VERSION_OPTION_DESCRIPTION, stdout);
152 The sums are computed as described in %s. When checking, the input\n\
153 should be a former output of this program. The default mode is to print\n\
154 a line with checksum, a character indicating type (`*' for binary, ` ' for\n\
155 text), and name for each FILE.\n"),
156 (algorithm == ALG_MD5 ? "RFC 1321" : "FIPS-180-1"));
157 puts (_("\nReport bugs to <bug-textutils@gnu.org>."));
160 exit (status == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
164 split_3 (char *s, size_t s_len, unsigned char **u, int *binary, char **w)
167 int escaped_filename = 0;
169 #define ISWHITE(c) ((c) == ' ' || (c) == '\t')
172 while (ISWHITE (s[i]))
175 /* The line must have at least `min_digest_line_length - 1' (or one more, if
176 the first is a backslash) more characters to contain correct message digest
177 information. Ignore this line if it is too short. */
178 if (!(s_len - i >= min_digest_line_length
179 || (s[i] == '\\' && s_len - i >= 1 + min_digest_line_length)))
185 escaped_filename = 1;
187 *u = (unsigned char *) &s[i];
189 /* The first field has to be the n-character hexadecimal
190 representation of the message digest. If it is not followed
191 immediately by a white space it's an error. */
192 i += digest_hex_bytes;
198 if (s[i] != ' ' && s[i] != '*')
200 *binary = (s[i++] == '*');
202 /* All characters between the type indicator and end of line are
203 significant -- that includes leading and trailing white space. */
206 if (escaped_filename)
208 /* Translate each `\n' string in the file name to a NEWLINE,
209 and each `\\' string to a backslash. */
220 /* A valid line does not end with a backslash. */
233 /* Only `\' or `n' may follow a backslash. */
239 /* The file name may not contain a NUL. */
254 hex_digits (unsigned char const *s)
265 /* An interface to the function, DIGEST_STREAM, (either md5_stream or sha_stream).
266 Operate on FILENAME (it may be "-") and put the result in *BIN_RESULT.
267 Return non-zero upon failure, zero to indicate success. */
270 digest_file (const char *filename, int binary, unsigned char *bin_result,
271 int (*digest_stream)(FILE *, void *))
276 if (STREQ (filename, "-"))
281 /* If we need binary reads from a pipe or redirected stdin, we need
282 to switch it to BINARY mode here, since stdin is already open. */
284 SET_BINARY (fileno (stdin));
289 /* OPENOPTS is a macro. It varies with the system.
290 Some systems distinguish between internal and
291 external text representations. */
293 fp = fopen (filename, OPENOPTS (binary));
296 error (0, errno, "%s", filename);
301 err = (*digest_stream) (fp, bin_result);
304 error (0, errno, "%s", filename);
310 if (fp != stdin && fclose (fp) == EOF)
312 error (0, errno, "%s", filename);
320 digest_check (const char *checkfile_name, int (*digest_stream)(FILE *, void *))
322 FILE *checkfile_stream;
323 int n_properly_formated_lines = 0;
324 int n_mismatched_checksums = 0;
325 int n_open_or_read_failures = 0;
326 unsigned char bin_buffer[MAX_DIGEST_BIN_BYTES];
329 size_t line_chars_allocated;
331 if (STREQ (checkfile_name, "-"))
334 checkfile_name = _("standard input");
335 checkfile_stream = stdin;
339 checkfile_stream = fopen (checkfile_name, "r");
340 if (checkfile_stream == NULL)
342 error (0, errno, "%s", checkfile_name);
347 SET_MODE (fileno (checkfile_stream), O_TEXT);
350 line_chars_allocated = 0;
355 unsigned char *hex_digest;
361 line_length = getline (&line, &line_chars_allocated, checkfile_stream);
362 if (line_length <= 0)
365 /* Ignore comment lines, which begin with a '#' character. */
369 /* Remove any trailing newline. */
370 if (line[line_length - 1] == '\n')
371 line[--line_length] = '\0';
373 err = split_3 (line, line_length, &hex_digest, &binary, &filename);
374 if (err || !hex_digits (hex_digest))
379 _("%s: %lu: improperly formatted %s checksum line"),
380 checkfile_name, (unsigned long) line_number,
381 DIGEST_TYPE_STRING (algorithm));
386 static const char bin2hex[] = { '0', '1', '2', '3',
389 'c', 'd', 'e', 'f' };
392 ++n_properly_formated_lines;
394 fail = digest_file (filename, binary, bin_buffer, digest_stream);
398 ++n_open_or_read_failures;
401 printf (_("%s: FAILED open or read\n"), filename);
407 size_t digest_bin_bytes = digest_hex_bytes / 2;
409 /* Compare generated binary number with text representation
410 in check file. Ignore case of hex digits. */
411 for (cnt = 0; cnt < digest_bin_bytes; ++cnt)
413 if (TOLOWER (hex_digest[2 * cnt]) != bin2hex[bin_buffer[cnt] >> 4]
414 || (TOLOWER (hex_digest[2 * cnt + 1])
415 != (bin2hex[bin_buffer[cnt] & 0xf])))
418 if (cnt != digest_bin_bytes)
419 ++n_mismatched_checksums;
423 printf ("%s: %s\n", filename,
424 (cnt != digest_bin_bytes ? _("FAILED") : _("OK")));
430 while (!feof (checkfile_stream) && !ferror (checkfile_stream));
435 if (ferror (checkfile_stream))
437 error (0, 0, _("%s: read error"), checkfile_name);
441 if (checkfile_stream != stdin && fclose (checkfile_stream) == EOF)
443 error (0, errno, "%s", checkfile_name);
447 if (n_properly_formated_lines == 0)
449 /* Warn if no tests are found. */
450 error (0, 0, _("%s: no properly formatted %s checksum lines found"),
451 checkfile_name, DIGEST_TYPE_STRING (algorithm));
457 int n_computed_checkums = (n_properly_formated_lines
458 - n_open_or_read_failures);
460 if (n_open_or_read_failures > 0)
463 _("WARNING: %d of %d listed %s could not be read"),
464 n_open_or_read_failures, n_properly_formated_lines,
465 (n_properly_formated_lines == 1
466 ? _("file") : _("files")));
469 if (n_mismatched_checksums > 0)
472 _("WARNING: %d of %d computed %s did NOT match"),
473 n_mismatched_checksums, n_computed_checkums,
474 (n_computed_checkums == 1
475 ? _("checksum") : _("checksums")));
480 return ((n_properly_formated_lines > 0 && n_mismatched_checksums == 0
481 && n_open_or_read_failures == 0) ? 0 : 1);
485 main (int argc, char **argv)
487 unsigned char bin_buffer[MAX_DIGEST_BIN_BYTES];
490 char **string = NULL;
491 size_t n_strings = 0;
493 int file_type_specified = 0;
496 /* Binary is default on MSDOS, so the actual file contents
497 are used in computation. */
500 /* Text is default of the Plumb/Lankester format. */
504 /* Setting values of global variables. */
505 program_name = argv[0];
506 setlocale (LC_ALL, "");
507 bindtextdomain (PACKAGE, LOCALEDIR);
508 textdomain (PACKAGE);
510 atexit (close_stdout);
512 while ((opt = getopt_long (argc, argv, "bctw", long_options, NULL)) != -1)
515 case 0: /* long option */
517 case 1: /* --string */
520 string = (char **) xmalloc ((argc - 1) * sizeof (char *));
524 string[n_strings++] = optarg;
528 file_type_specified = 1;
539 file_type_specified = 1;
546 case_GETOPT_HELP_CHAR;
547 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
549 usage (EXIT_FAILURE);
552 min_digest_line_length = MIN_DIGEST_LINE_LENGTH (algorithm);
553 digest_hex_bytes = DIGEST_HEX_BYTES (algorithm);
555 if (file_type_specified && do_check)
557 error (0, 0, _("the --binary and --text options are meaningless when \
558 verifying checksums"));
559 usage (EXIT_FAILURE);
562 if (n_strings > 0 && do_check)
565 _("the --string and --check options are mutually exclusive"));
566 usage (EXIT_FAILURE);
569 if (status_only && !do_check)
572 _("the --status option is meaningful only when verifying checksums"));
573 usage (EXIT_FAILURE);
576 if (warn && !do_check)
579 _("the --warn option is meaningful only when verifying checksums"));
580 usage (EXIT_FAILURE);
589 error (0, 0, _("no files may be specified when using --string"));
590 usage (EXIT_FAILURE);
592 for (i = 0; i < n_strings; ++i)
595 if (algorithm == ALG_MD5)
596 md5_buffer (string[i], strlen (string[i]), bin_buffer);
598 sha_buffer (string[i], strlen (string[i]), bin_buffer);
600 for (cnt = 0; cnt < (digest_hex_bytes / 2); ++cnt)
601 printf ("%02x", bin_buffer[cnt]);
603 printf (" \"%s\"\n", string[i]);
608 if (optind + 1 < argc)
611 _("only one argument may be specified when using --check"));
612 usage (EXIT_FAILURE);
615 err = digest_check ((optind == argc) ? "-" : argv[optind],
616 DIGEST_STREAM (algorithm));
623 for (; optind < argc; ++optind)
626 char *file = argv[optind];
628 fail = digest_file (file, binary, bin_buffer,
629 DIGEST_STREAM (algorithm));
635 /* Output a leading backslash if the file name contains
636 a newline or backslash. */
637 if (strchr (file, '\n') || strchr (file, '\\'))
640 for (i = 0; i < (digest_hex_bytes / 2); ++i)
641 printf ("%02x", bin_buffer[i]);
649 /* Translate each NEWLINE byte to the string, "\\n",
650 and each backslash to "\\\\". */
651 for (i = 0; i < strlen (file); ++i)
656 fputs ("\\n", stdout);
660 fputs ("\\\\", stdout);
673 if (have_read_stdin && fclose (stdin) == EOF)
674 error (EXIT_FAILURE, errno, _("standard input"));
676 exit (err == 0 ? EXIT_SUCCESS : EXIT_FAILURE);