1 /* Compute MD5, SHA1, SHA224, SHA256, SHA384 or SHA512 checksum of files or strings
2 Copyright (C) 1995-2007 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 3 of the License, or
7 (at your option) any later version.
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, see <http://www.gnu.org/licenses/>. */
17 /* Written by Ulrich Drepper <drepper@gnu.ai.mit.edu>. */
22 #include <sys/types.h>
32 #if HASH_ALGO_SHA256 || HASH_ALGO_SHA224
35 #if HASH_ALGO_SHA512 || HASH_ALGO_SHA384
41 /* The official name of this program (e.g., no `g' prefix). */
43 # define PROGRAM_NAME "md5sum"
44 # define DIGEST_TYPE_STRING "MD5"
45 # define DIGEST_STREAM md5_stream
46 # define DIGEST_BITS 128
47 # define DIGEST_REFERENCE "RFC 1321"
48 # define DIGEST_ALIGN 4
50 # define PROGRAM_NAME "sha1sum"
51 # define DIGEST_TYPE_STRING "SHA1"
52 # define DIGEST_STREAM sha1_stream
53 # define DIGEST_BITS 160
54 # define DIGEST_REFERENCE "FIPS-180-1"
55 # define DIGEST_ALIGN 4
56 #elif HASH_ALGO_SHA256
57 # define PROGRAM_NAME "sha256sum"
58 # define DIGEST_TYPE_STRING "SHA256"
59 # define DIGEST_STREAM sha256_stream
60 # define DIGEST_BITS 256
61 # define DIGEST_REFERENCE "FIPS-180-2"
62 # define DIGEST_ALIGN 4
63 #elif HASH_ALGO_SHA224
64 # define PROGRAM_NAME "sha224sum"
65 # define DIGEST_TYPE_STRING "SHA224"
66 # define DIGEST_STREAM sha224_stream
67 # define DIGEST_BITS 224
68 # define DIGEST_REFERENCE "RFC 3874"
69 # define DIGEST_ALIGN 4
70 #elif HASH_ALGO_SHA512
71 # define PROGRAM_NAME "sha512sum"
72 # define DIGEST_TYPE_STRING "SHA512"
73 # define DIGEST_STREAM sha512_stream
74 # define DIGEST_BITS 512
75 # define DIGEST_REFERENCE "FIPS-180-2"
76 # define DIGEST_ALIGN 8
77 #elif HASH_ALGO_SHA384
78 # define PROGRAM_NAME "sha384sum"
79 # define DIGEST_TYPE_STRING "SHA384"
80 # define DIGEST_STREAM sha384_stream
81 # define DIGEST_BITS 384
82 # define DIGEST_REFERENCE "FIPS-180-2"
83 # define DIGEST_ALIGN 8
85 # error "Can't decide which hash algorithm to compile."
88 #define DIGEST_HEX_BYTES (DIGEST_BITS / 4)
89 #define DIGEST_BIN_BYTES (DIGEST_BITS / 8)
91 #define AUTHORS "Ulrich Drepper", "Scott Miller", "David Madore"
93 /* The minimum length of a valid digest line. This length does
94 not include any newline character at the end of a line. */
95 #define MIN_DIGEST_LINE_LENGTH \
96 (DIGEST_HEX_BYTES /* length of hexadecimal message digest */ \
97 + 2 /* blank and binary indicator */ \
98 + 1 /* minimum filename length */ )
100 /* True if any of the files read were the standard input. */
101 static bool have_read_stdin
;
103 /* The minimum length of a valid checksum line for the selected algorithm. */
104 static size_t min_digest_line_length
;
106 /* Set to the length of a digest hex string for the selected algorithm. */
107 static size_t digest_hex_bytes
;
109 /* With --check, don't generate any output.
110 The exit code indicates success or failure. */
111 static bool status_only
= false;
113 /* With --check, print a message to standard error warning about each
114 improperly formatted checksum line. */
115 static bool warn
= false;
117 /* The name this program was run with. */
120 /* For long options that have no equivalent short option, use a
121 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
124 STATUS_OPTION
= CHAR_MAX
+ 1
127 static const struct option long_options
[] =
129 { "binary", no_argument
, NULL
, 'b' },
130 { "check", no_argument
, NULL
, 'c' },
131 { "status", no_argument
, NULL
, STATUS_OPTION
},
132 { "text", no_argument
, NULL
, 't' },
133 { "warn", no_argument
, NULL
, 'w' },
134 { GETOPT_HELP_OPTION_DECL
},
135 { GETOPT_VERSION_OPTION_DECL
},
142 if (status
!= EXIT_SUCCESS
)
143 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
148 Usage: %s [OPTION] [FILE]...\n\
149 Print or check %s (%d-bit) checksums.\n\
150 With no FILE, or when FILE is -, read standard input.\n\
158 -b, --binary read in binary mode (default unless reading tty stdin)\n\
162 -b, --binary read in binary mode\n\
165 -c, --check read %s sums from the FILEs and check them\n"),
169 -t, --text read in text mode (default if reading tty stdin)\n\
173 -t, --text read in text mode (default)\n\
177 The following two options are useful only when verifying checksums:\n\
178 --status don't output anything, status code shows success\n\
179 -w, --warn warn about improperly formatted checksum lines\n\
182 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
183 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
186 The sums are computed as described in %s. When checking, the input\n\
187 should be a former output of this program. The default mode is to print\n\
188 a line with checksum, a character indicating type (`*' for binary, ` ' for\n\
189 text), and name for each FILE.\n"),
191 emit_bug_reporting_address ();
197 #define ISWHITE(c) ((c) == ' ' || (c) == '\t')
199 /* Split the checksum string S (of length S_LEN) from a BSD 'md5' or
200 'sha1' command into two parts: a hexadecimal digest, and the file
201 name. S is modified. Return true if successful. */
204 bsd_split_3 (char *s
, size_t s_len
, unsigned char **hex_digest
, char **file_name
)
210 /* Find end of filename. The BSD 'md5' and 'sha1' commands do not escape
211 filenames, so search backwards for the last ')'. */
213 while (i
&& s
[i
] != ')')
221 while (ISWHITE (s
[i
]))
229 while (ISWHITE (s
[i
]))
232 *hex_digest
= (unsigned char *) &s
[i
];
236 /* Split the string S (of length S_LEN) into three parts:
237 a hexadecimal digest, binary flag, and the file name.
238 S is modified. Return true if successful. */
241 split_3 (char *s
, size_t s_len
,
242 unsigned char **hex_digest
, int *binary
, char **file_name
)
245 bool escaped_filename
= false;
246 size_t algo_name_len
;
249 while (ISWHITE (s
[i
]))
252 /* Check for BSD-style checksum line. */
253 algo_name_len
= strlen (DIGEST_TYPE_STRING
);
254 if (strncmp (s
+ i
, DIGEST_TYPE_STRING
, algo_name_len
) == 0)
256 if (strncmp (s
+ i
+ algo_name_len
, " (", 2) == 0)
259 return bsd_split_3 (s
+ i
+ algo_name_len
+ 2,
260 s_len
- (i
+ algo_name_len
+ 2),
261 hex_digest
, file_name
);
265 /* Ignore this line if it is too short.
266 Each line must have at least `min_digest_line_length - 1' (or one more, if
267 the first is a backslash) more characters to contain correct message digest
269 if (s_len
- i
< min_digest_line_length
+ (s
[i
] == '\\'))
275 escaped_filename
= true;
277 *hex_digest
= (unsigned char *) &s
[i
];
279 /* The first field has to be the n-character hexadecimal
280 representation of the message digest. If it is not followed
281 immediately by a white space it's an error. */
282 i
+= digest_hex_bytes
;
288 if (s
[i
] != ' ' && s
[i
] != '*')
290 *binary
= (s
[i
++] == '*');
292 /* All characters between the type indicator and end of line are
293 significant -- that includes leading and trailing white space. */
296 if (escaped_filename
)
298 /* Translate each `\n' string in the file name to a NEWLINE,
299 and each `\\' string to a backslash. */
310 /* A valid line does not end with a backslash. */
323 /* Only `\' or `n' may follow a backslash. */
329 /* The file name may not contain a NUL. */
344 hex_digits (unsigned char const *s
)
355 /* An interface to the function, DIGEST_STREAM.
356 Operate on FILENAME (it may be "-").
358 *BINARY indicates whether the file is binary. BINARY < 0 means it
359 depends on whether binary mode makes any difference and the file is
360 a terminal; in that case, clear *BINARY if the file was treated as
361 text because it was a terminal.
363 Put the checksum in *BIN_RESULT, which must be properly aligned.
364 Return true if successful. */
367 digest_file (const char *filename
, int *binary
, unsigned char *bin_result
)
371 bool is_stdin
= STREQ (filename
, "-");
375 have_read_stdin
= true;
377 if (O_BINARY
&& *binary
)
380 *binary
= ! isatty (STDIN_FILENO
);
382 freopen (NULL
, "rb", stdin
);
387 fp
= fopen (filename
, (O_BINARY
&& *binary
? "rb" : "r"));
390 error (0, errno
, "%s", filename
);
395 err
= DIGEST_STREAM (fp
, bin_result
);
398 error (0, errno
, "%s", filename
);
404 if (!is_stdin
&& fclose (fp
) != 0)
406 error (0, errno
, "%s", filename
);
414 digest_check (const char *checkfile_name
)
416 FILE *checkfile_stream
;
417 uintmax_t n_properly_formatted_lines
= 0;
418 uintmax_t n_mismatched_checksums
= 0;
419 uintmax_t n_open_or_read_failures
= 0;
420 unsigned char bin_buffer_unaligned
[DIGEST_BIN_BYTES
+ DIGEST_ALIGN
];
421 /* Make sure bin_buffer is properly aligned. */
422 unsigned char *bin_buffer
= ptr_align (bin_buffer_unaligned
, DIGEST_ALIGN
);
423 uintmax_t line_number
;
425 size_t line_chars_allocated
;
426 bool is_stdin
= STREQ (checkfile_name
, "-");
430 have_read_stdin
= true;
431 checkfile_name
= _("standard input");
432 checkfile_stream
= stdin
;
436 checkfile_stream
= fopen (checkfile_name
, "r");
437 if (checkfile_stream
== NULL
)
439 error (0, errno
, "%s", checkfile_name
);
446 line_chars_allocated
= 0;
451 unsigned char *hex_digest
IF_LINT (= NULL
);
455 if (line_number
== 0)
456 error (EXIT_FAILURE
, 0, _("%s: too many checksum lines"),
459 line_length
= getline (&line
, &line_chars_allocated
, checkfile_stream
);
460 if (line_length
<= 0)
463 /* Ignore comment lines, which begin with a '#' character. */
467 /* Remove any trailing newline. */
468 if (line
[line_length
- 1] == '\n')
469 line
[--line_length
] = '\0';
471 if (! (split_3 (line
, line_length
, &hex_digest
, &binary
, &filename
)
472 && ! (is_stdin
&& STREQ (filename
, "-"))
473 && hex_digits (hex_digest
)))
479 ": improperly formatted %s checksum line"),
480 checkfile_name
, line_number
,
486 static const char bin2hex
[] = { '0', '1', '2', '3',
489 'c', 'd', 'e', 'f' };
492 ++n_properly_formatted_lines
;
494 ok
= digest_file (filename
, &binary
, bin_buffer
);
498 ++n_open_or_read_failures
;
501 printf (_("%s: FAILED open or read\n"), filename
);
507 size_t digest_bin_bytes
= digest_hex_bytes
/ 2;
509 /* Compare generated binary number with text representation
510 in check file. Ignore case of hex digits. */
511 for (cnt
= 0; cnt
< digest_bin_bytes
; ++cnt
)
513 if (tolower (hex_digest
[2 * cnt
])
514 != bin2hex
[bin_buffer
[cnt
] >> 4]
515 || (tolower (hex_digest
[2 * cnt
+ 1])
516 != (bin2hex
[bin_buffer
[cnt
] & 0xf])))
519 if (cnt
!= digest_bin_bytes
)
520 ++n_mismatched_checksums
;
524 printf ("%s: %s\n", filename
,
525 (cnt
!= digest_bin_bytes
? _("FAILED") : _("OK")));
531 while (!feof (checkfile_stream
) && !ferror (checkfile_stream
));
535 if (ferror (checkfile_stream
))
537 error (0, 0, _("%s: read error"), checkfile_name
);
541 if (!is_stdin
&& fclose (checkfile_stream
) != 0)
543 error (0, errno
, "%s", checkfile_name
);
547 if (n_properly_formatted_lines
== 0)
549 /* Warn if no tests are found. */
550 error (0, 0, _("%s: no properly formatted %s checksum lines found"),
551 checkfile_name
, DIGEST_TYPE_STRING
);
557 if (n_open_or_read_failures
!= 0)
559 ngettext ("WARNING: %" PRIuMAX
" of %" PRIuMAX
560 " listed file could not be read",
561 "WARNING: %" PRIuMAX
" of %" PRIuMAX
562 " listed files could not be read",
563 select_plural (n_properly_formatted_lines
)),
564 n_open_or_read_failures
, n_properly_formatted_lines
);
566 if (n_mismatched_checksums
!= 0)
568 uintmax_t n_computed_checksums
=
569 (n_properly_formatted_lines
- n_open_or_read_failures
);
571 ngettext ("WARNING: %" PRIuMAX
" of %" PRIuMAX
572 " computed checksum did NOT match",
573 "WARNING: %" PRIuMAX
" of %" PRIuMAX
574 " computed checksums did NOT match",
575 select_plural (n_computed_checksums
)),
576 n_mismatched_checksums
, n_computed_checksums
);
581 return (n_properly_formatted_lines
!= 0
582 && n_mismatched_checksums
== 0
583 && n_open_or_read_failures
== 0);
587 main (int argc
, char **argv
)
589 unsigned char bin_buffer_unaligned
[DIGEST_BIN_BYTES
+ DIGEST_ALIGN
];
590 /* Make sure bin_buffer is properly aligned. */
591 unsigned char *bin_buffer
= ptr_align (bin_buffer_unaligned
, DIGEST_ALIGN
);
592 bool do_check
= false;
597 /* Setting values of global variables. */
598 initialize_main (&argc
, &argv
);
599 program_name
= argv
[0];
600 setlocale (LC_ALL
, "");
601 bindtextdomain (PACKAGE
, LOCALEDIR
);
602 textdomain (PACKAGE
);
604 atexit (close_stdout
);
606 while ((opt
= getopt_long (argc
, argv
, "bctw", long_options
, NULL
)) != -1)
626 case_GETOPT_HELP_CHAR
;
627 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
629 usage (EXIT_FAILURE
);
632 min_digest_line_length
= MIN_DIGEST_LINE_LENGTH
;
633 digest_hex_bytes
= DIGEST_HEX_BYTES
;
635 if (0 <= binary
&& do_check
)
637 error (0, 0, _("the --binary and --text options are meaningless when "
638 "verifying checksums"));
639 usage (EXIT_FAILURE
);
642 if (status_only
& !do_check
)
645 _("the --status option is meaningful only when verifying checksums"));
646 usage (EXIT_FAILURE
);
649 if (warn
& !do_check
)
652 _("the --warn option is meaningful only when verifying checksums"));
653 usage (EXIT_FAILURE
);
656 if (!O_BINARY
&& binary
< 0)
662 for (; optind
< argc
; ++optind
)
664 char *file
= argv
[optind
];
667 ok
&= digest_check (file
);
670 int file_is_binary
= binary
;
672 if (! digest_file (file
, &file_is_binary
, bin_buffer
))
678 /* Output a leading backslash if the file name contains
679 a newline or backslash. */
680 if (strchr (file
, '\n') || strchr (file
, '\\'))
683 for (i
= 0; i
< (digest_hex_bytes
/ 2); ++i
)
684 printf ("%02x", bin_buffer
[i
]);
692 /* Translate each NEWLINE byte to the string, "\\n",
693 and each backslash to "\\\\". */
694 for (i
= 0; i
< strlen (file
); ++i
)
699 fputs ("\\n", stdout
);
703 fputs ("\\\\", stdout
);
716 if (have_read_stdin
&& fclose (stdin
) == EOF
)
717 error (EXIT_FAILURE
, errno
, _("standard input"));
719 exit (ok
? EXIT_SUCCESS
: EXIT_FAILURE
);