1 /* Compute checksums of files or strings.
2 Copyright (C) 1995-2023 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 <https://www.gnu.org/licenses/>. */
17 /* Written by Ulrich Drepper <drepper@gnu.ai.mit.edu>. */
22 #include <sys/types.h>
27 #include "xdectoint.h"
30 #if HASH_ALGO_SUM || HASH_ALGO_CKSUM
37 #if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
38 # include "blake2/b2sum.h"
40 #if HASH_ALGO_MD5 || HASH_ALGO_CKSUM
43 #if HASH_ALGO_SHA1 || HASH_ALGO_CKSUM
46 #if HASH_ALGO_SHA256 || HASH_ALGO_SHA224 || HASH_ALGO_CKSUM
49 #if HASH_ALGO_SHA512 || HASH_ALGO_SHA384 || HASH_ALGO_CKSUM
57 #include "xbinary-io.h"
59 /* The official name of this program (e.g., no 'g' prefix). */
61 # define PROGRAM_NAME "sum"
62 # define DIGEST_TYPE_STRING "BSD"
63 # define DIGEST_STREAM sumfns[sum_algorithm]
64 # define DIGEST_OUT sum_output_fns[sum_algorithm]
65 # define DIGEST_BITS 16
66 # define DIGEST_ALIGN 4
68 # define MAX_DIGEST_BITS 512
69 # define MAX_DIGEST_ALIGN 8
70 # define PROGRAM_NAME "cksum"
71 # define DIGEST_TYPE_STRING algorithm_tags[cksum_algorithm]
72 # define DIGEST_STREAM cksumfns[cksum_algorithm]
73 # define DIGEST_OUT cksum_output_fns[cksum_algorithm]
74 # define DIGEST_BITS MAX_DIGEST_BITS
75 # define DIGEST_ALIGN MAX_DIGEST_ALIGN
77 # define PROGRAM_NAME "md5sum"
78 # define DIGEST_TYPE_STRING "MD5"
79 # define DIGEST_STREAM md5_stream
80 # define DIGEST_BITS 128
81 # define DIGEST_REFERENCE "RFC 1321"
82 # define DIGEST_ALIGN 4
83 #elif HASH_ALGO_BLAKE2
84 # define PROGRAM_NAME "b2sum"
85 # define DIGEST_TYPE_STRING "BLAKE2b"
86 # define DIGEST_STREAM blake2b_stream
87 # define DIGEST_BITS 512
88 # define DIGEST_REFERENCE "RFC 7693"
89 # define DIGEST_ALIGN 8
91 # define PROGRAM_NAME "sha1sum"
92 # define DIGEST_TYPE_STRING "SHA1"
93 # define DIGEST_STREAM sha1_stream
94 # define DIGEST_BITS 160
95 # define DIGEST_REFERENCE "FIPS-180-1"
96 # define DIGEST_ALIGN 4
97 #elif HASH_ALGO_SHA256
98 # define PROGRAM_NAME "sha256sum"
99 # define DIGEST_TYPE_STRING "SHA256"
100 # define DIGEST_STREAM sha256_stream
101 # define DIGEST_BITS 256
102 # define DIGEST_REFERENCE "FIPS-180-2"
103 # define DIGEST_ALIGN 4
104 #elif HASH_ALGO_SHA224
105 # define PROGRAM_NAME "sha224sum"
106 # define DIGEST_TYPE_STRING "SHA224"
107 # define DIGEST_STREAM sha224_stream
108 # define DIGEST_BITS 224
109 # define DIGEST_REFERENCE "RFC 3874"
110 # define DIGEST_ALIGN 4
111 #elif HASH_ALGO_SHA512
112 # define PROGRAM_NAME "sha512sum"
113 # define DIGEST_TYPE_STRING "SHA512"
114 # define DIGEST_STREAM sha512_stream
115 # define DIGEST_BITS 512
116 # define DIGEST_REFERENCE "FIPS-180-2"
117 # define DIGEST_ALIGN 8
118 #elif HASH_ALGO_SHA384
119 # define PROGRAM_NAME "sha384sum"
120 # define DIGEST_TYPE_STRING "SHA384"
121 # define DIGEST_STREAM sha384_stream
122 # define DIGEST_BITS 384
123 # define DIGEST_REFERENCE "FIPS-180-2"
124 # define DIGEST_ALIGN 8
126 # error "Can't decide which hash algorithm to compile."
128 #if !HASH_ALGO_SUM && !HASH_ALGO_CKSUM
129 # define DIGEST_OUT output_file
134 proper_name ("Kayvan Aghaiepour"), \
135 proper_name ("David MacKenzie")
136 #elif HASH_ALGO_CKSUM
138 proper_name_lite ("Padraig Brady", "P\303\241draig Brady"), \
139 proper_name ("Q. Frank Xia")
140 #elif HASH_ALGO_BLAKE2
142 proper_name_lite ("Padraig Brady", "P\303\241draig Brady"), \
143 proper_name ("Samuel Neves")
146 proper_name ("Ulrich Drepper"), \
147 proper_name ("Scott Miller"), \
148 proper_name ("David Madore")
150 #if !HASH_ALGO_BLAKE2 && !HASH_ALGO_CKSUM
151 # define DIGEST_HEX_BYTES (DIGEST_BITS / 4)
153 #define DIGEST_BIN_BYTES (DIGEST_BITS / 8)
155 /* The minimum length of a valid digest line. This length does
156 not include any newline character at the end of a line. */
157 #if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
158 # define MIN_DIGEST_LINE_LENGTH 3 /* With -l 8. */
160 # define MIN_DIGEST_LINE_LENGTH \
161 (DIGEST_HEX_BYTES /* length of hexadecimal message digest */ \
163 + 1 /* minimum filename length */ )
168 output_file (char const *file
, int binary_file
, void const *digest
,
169 bool raw
, bool tagged
, unsigned char delim
, bool args
,
173 /* True if any of the files read were the standard input. */
174 static bool have_read_stdin
;
176 /* The minimum length of a valid checksum line for the selected algorithm. */
177 static size_t min_digest_line_length
;
179 /* Set to the length of a digest hex string for the selected algorithm. */
180 static size_t digest_hex_bytes
;
182 /* With --check, don't generate any output.
183 The exit code indicates success or failure. */
184 static bool status_only
= false;
186 /* With --check, print a message to standard error warning about each
187 improperly formatted checksum line. */
188 static bool warn
= false;
190 /* With --check, ignore missing files. */
191 static bool ignore_missing
= false;
193 /* With --check, suppress the "OK" printed for each verified file. */
194 static bool quiet
= false;
196 /* With --check, exit with a non-zero return code if any line is
197 improperly formatted. */
198 static bool strict
= false;
200 /* Whether a BSD reversed format checksum is detected. */
201 static int bsd_reversed
= -1;
203 /* line delimiter. */
204 static unsigned char digest_delim
= '\n';
207 /* If true, print base64-encoded digests, not hex. */
208 static bool base64_digest
= false;
211 /* If true, print binary digests, not hex. */
212 static bool raw_digest
= false;
214 #if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
215 # define BLAKE2B_MAX_LEN BLAKE2B_OUTBYTES
216 static uintmax_t digest_length
;
217 #endif /* HASH_ALGO_BLAKE2 */
219 typedef void (*digest_output_fn
)(char const *, int, void const *, bool,
220 bool, unsigned char, bool, uintmax_t);
228 static enum Algorithm sum_algorithm
;
229 static sumfn sumfns
[]=
234 static digest_output_fn sum_output_fns
[]=
243 md5_sum_stream (FILE *stream
, void *resstream
, uintmax_t *length
)
245 return md5_stream (stream
, resstream
);
248 sha1_sum_stream (FILE *stream
, void *resstream
, uintmax_t *length
)
250 return sha1_stream (stream
, resstream
);
253 sha224_sum_stream (FILE *stream
, void *resstream
, uintmax_t *length
)
255 return sha224_stream (stream
, resstream
);
258 sha256_sum_stream (FILE *stream
, void *resstream
, uintmax_t *length
)
260 return sha256_stream (stream
, resstream
);
263 sha384_sum_stream (FILE *stream
, void *resstream
, uintmax_t *length
)
265 return sha384_stream (stream
, resstream
);
268 sha512_sum_stream (FILE *stream
, void *resstream
, uintmax_t *length
)
270 return sha512_stream (stream
, resstream
);
273 blake2b_sum_stream (FILE *stream
, void *resstream
, uintmax_t *length
)
275 return blake2b_stream (stream
, resstream
, *length
);
278 sm3_sum_stream (FILE *stream
, void *resstream
, uintmax_t *length
)
280 return sm3_stream (stream
, resstream
);
298 static char const *const algorithm_args
[] =
300 "bsd", "sysv", "crc", "md5", "sha1", "sha224",
301 "sha256", "sha384", "sha512", "blake2b", "sm3", nullptr
303 static enum Algorithm
const algorithm_types
[] =
305 bsd
, sysv
, crc
, md5
, sha1
, sha224
,
306 sha256
, sha384
, sha512
, blake2b
, sm3
,
308 ARGMATCH_VERIFY (algorithm_args
, algorithm_types
);
310 static char const *const algorithm_tags
[] =
312 "BSD", "SYSV", "CRC", "MD5", "SHA1", "SHA224",
313 "SHA256", "SHA384", "SHA512", "BLAKE2b", "SM3", nullptr
315 static int const algorithm_bits
[] =
317 16, 16, 32, 128, 160, 224,
318 256, 384, 512, 512, 256, 0
321 static_assert (ARRAY_CARDINALITY (algorithm_bits
)
322 == ARRAY_CARDINALITY (algorithm_args
));
324 static bool algorithm_specified
= false;
325 static enum Algorithm cksum_algorithm
= crc
;
326 static sumfn cksumfns
[]=
340 static digest_output_fn cksum_output_fns
[]=
357 /* For long options that have no equivalent short option, use a
358 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
362 IGNORE_MISSING_OPTION
= CHAR_MAX
+ 1,
368 DEBUG_PROGRAM_OPTION
,
373 static struct option
const long_options
[] =
375 #if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
376 { "length", required_argument
, nullptr, 'l'},
380 { "check", no_argument
, nullptr, 'c' },
381 { "ignore-missing", no_argument
, nullptr, IGNORE_MISSING_OPTION
},
382 { "quiet", no_argument
, nullptr, QUIET_OPTION
},
383 { "status", no_argument
, nullptr, STATUS_OPTION
},
384 { "warn", no_argument
, nullptr, 'w' },
385 { "strict", no_argument
, nullptr, STRICT_OPTION
},
386 { "tag", no_argument
, nullptr, TAG_OPTION
},
387 { "zero", no_argument
, nullptr, 'z' },
390 { "algorithm", required_argument
, nullptr, 'a'},
391 { "base64", no_argument
, nullptr, BASE64_OPTION
},
392 { "debug", no_argument
, nullptr, DEBUG_PROGRAM_OPTION
},
393 { "raw", no_argument
, nullptr, RAW_OPTION
},
394 { "untagged", no_argument
, nullptr, UNTAG_OPTION
},
396 { "binary", no_argument
, nullptr, 'b' },
397 { "text", no_argument
, nullptr, 't' },
400 {"sysv", no_argument
, nullptr, 's'},
403 { GETOPT_HELP_OPTION_DECL
},
404 { GETOPT_VERSION_OPTION_DECL
},
405 { nullptr, 0, nullptr, 0 }
411 if (status
!= EXIT_SUCCESS
)
416 Usage: %s [OPTION]... [FILE]...\n\
420 Print or verify checksums.\n\
421 By default use the 32 bit CRC algorithm.\n\
425 Print or check %s (%d-bit) checksums.\n\
435 -r use BSD sum algorithm (the default), use 1K blocks\n\
436 -s, --sysv use System V sum algorithm, use 512 bytes blocks\n\
439 #if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
440 emit_mandatory_arg_note ();
444 -a, --algorithm=TYPE select the digest type to use. See DIGEST below.\
448 --base64 emit base64-encoded digests, not hexadecimal\
453 # if !HASH_ALGO_CKSUM
456 -b, --binary read in binary mode (default unless reading tty stdin)\
461 -b, --binary read in binary mode\n\
465 -c, --check read checksums from the FILEs and check them\n\
467 # if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
469 -l, --length=BITS digest length in bits; must not exceed the max for\n\
470 the blake2 algorithm and must be a multiple of 8\n\
475 --raw emit a raw binary digest, not hexadecimal\
479 --tag create a BSD-style checksum (the default)\n\
482 --untagged create a reversed style checksum, without digest type\n\
486 --tag create a BSD-style checksum\n\
489 # if !HASH_ALGO_CKSUM
492 -t, --text read in text mode (default if reading tty stdin)\n\
496 -t, --text read in text mode (default)\n\
500 -z, --zero end each output line with NUL, not newline,\n\
501 and disable file name escaping\n\
505 The following five options are useful only when verifying checksums:\n\
506 --ignore-missing don't fail or report status for missing files\n\
507 --quiet don't print OK for each successfully verified file\n\
508 --status don't output anything, status code shows success\n\
509 --strict exit non-zero for improperly formatted checksum lines\n\
510 -w, --warn warn about improperly formatted checksum lines\n\
516 --debug indicate which implementation used\n\
519 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
520 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
524 DIGEST determines the digest algorithm and default output format:\n\
525 sysv (equivalent to sum -s)\n\
526 bsd (equivalent to sum -r)\n\
527 crc (equivalent to cksum)\n\
528 md5 (equivalent to md5sum)\n\
529 sha1 (equivalent to sha1sum)\n\
530 sha224 (equivalent to sha224sum)\n\
531 sha256 (equivalent to sha256sum)\n\
532 sha384 (equivalent to sha384sum)\n\
533 sha512 (equivalent to sha512sum)\n\
534 blake2b (equivalent to b2sum)\n\
535 sm3 (only available through cksum)\n\
538 #if !HASH_ALGO_SUM && !HASH_ALGO_CKSUM
541 The sums are computed as described in %s.\n"), DIGEST_REFERENCE
);
543 When checking, the input should be a former output of this program.\n\
544 The default mode is to print a line with: checksum, a space,\n\
545 a character indicating input mode ('*' for binary, ' ' for text\n\
546 or where binary is insignificant), and name for each FILE.\n\
548 Note: There is no difference between binary mode and text mode on GNU systems.\
553 When checking, the input should be a former output of this program,\n\
554 or equivalent standalone program.\
557 emit_ancillary_info (PROGRAM_NAME
);
563 /* Given a string S, return TRUE if it contains problematic characters
564 that need escaping. Note we escape '\' itself to provide some forward
565 compat to introduce escaping of other characters. */
569 problematic_chars (char const *s
)
571 size_t length
= strcspn (s
, "\\\n\r");
572 return s
[length
] != '\0';
575 #define ISWHITE(c) ((c) == ' ' || (c) == '\t')
577 /* Given a file name, S of length S_LEN, that is not NUL-terminated,
578 modify it in place, performing the equivalent of this sed substitution:
579 's/\\n/\n/g;s/\\r/\r/g;s/\\\\/\\/g' i.e., replacing each "\\n" string
580 with a newline, each "\\r" string with a carriage return,
581 and each "\\\\" with a single backslash, NUL-terminate it and return S.
582 If S is not a valid escaped file name, i.e., if it ends with an odd number
583 of backslashes or if it contains a backslash followed by anything other
584 than "n" or another backslash, return nullptr. */
587 filename_unescape (char *s
, size_t s_len
)
591 for (size_t i
= 0; i
< s_len
; i
++)
598 /* File name ends with an unescaped backslash: invalid. */
614 /* Only '\', 'n' or 'r' may follow a backslash. */
620 /* The file name may not contain a NUL. */
634 /* Return true if S is a LEN-byte NUL-terminated string of hex or base64
635 digits and has the expected length. Otherwise, return false. */
638 valid_digits (unsigned char const *s
, size_t len
)
641 if (len
== BASE64_LENGTH (digest_length
/ 8))
644 for (i
= 0; i
< len
- digest_length
% 3; i
++)
650 for ( ; i
< len
; i
++)
659 if (len
== digest_hex_bytes
)
661 for (idx_t i
= 0; i
< digest_hex_bytes
; i
++)
674 /* Split the checksum string S (of length S_LEN) from a BSD 'md5' or
675 'sha1' command into two parts: a hexadecimal digest, and the file
676 name. S is modified. Set *D_LEN to the length of the digest string.
677 Return true if successful. */
680 bsd_split_3 (char *s
, size_t s_len
,
681 unsigned char **digest
, size_t *d_len
,
682 char **file_name
, bool escaped_filename
)
687 /* Find end of filename. */
688 size_t i
= s_len
- 1;
689 while (i
&& s
[i
] != ')')
697 if (escaped_filename
&& filename_unescape (s
, i
) == nullptr)
702 while (ISWHITE (s
[i
]))
710 while (ISWHITE (s
[i
]))
713 *digest
= (unsigned char *) &s
[i
];
716 return valid_digits (*digest
, *d_len
);
720 /* Return the corresponding Algorithm for the string S,
721 or -1 for no match. */
724 algorithm_from_tag (char *s
)
726 /* Limit check size to this length for perf reasons. */
727 static size_t max_tag_len
;
730 char const * const * tag
= algorithm_tags
;
733 size_t tag_len
= strlen (*tag
++);
734 max_tag_len
= MAX (tag_len
, max_tag_len
);
740 /* Find end of tag */
741 while (i
<= max_tag_len
&& s
[i
] && ! ISWHITE (s
[i
])
742 && s
[i
] != '-' && s
[i
] != '(')
748 /* Terminate tag, and lookup. */
751 ptrdiff_t algo
= argmatch_exact (s
, algorithm_tags
);
758 /* Split the string S (of length S_LEN) into three parts:
759 a hexadecimal digest, binary flag, and the file name.
760 S is modified. Set *D_LEN to the length of the digest string.
761 Return true if successful. */
764 split_3 (char *s
, size_t s_len
,
765 unsigned char **digest
, size_t *d_len
, int *binary
, char **file_name
)
767 bool escaped_filename
= false;
768 size_t algo_name_len
;
771 while (ISWHITE (s
[i
]))
777 escaped_filename
= true;
780 /* Check for BSD-style checksum line. */
783 if (! algorithm_specified
)
785 ptrdiff_t algo_tag
= algorithm_from_tag (s
+ i
);
789 return false; /* We don't support checking these older formats. */
790 cksum_algorithm
= algo_tag
;
793 return false; /* We only support tagged format without -a. */
797 algo_name_len
= strlen (DIGEST_TYPE_STRING
);
798 if (STREQ_LEN (s
+ i
, DIGEST_TYPE_STRING
, algo_name_len
))
801 #if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
802 /* Terminate and match algorithm name. */
803 char const *algo_name
= &s
[i
- algo_name_len
];
804 bool length_specified
= s
[i
] == '-';
805 bool openssl_format
= s
[i
] == '('; /* and no length_specified */
807 if (!STREQ (algo_name
, DIGEST_TYPE_STRING
))
812 # if HASH_ALGO_BLAKE2
813 digest_length
= BLAKE2B_MAX_LEN
* 8;
815 digest_length
= algorithm_bits
[cksum_algorithm
];
817 if (length_specified
)
821 if (! (xstrtoumax (s
+ i
, &siend
, 0, &length
, nullptr) == LONGINT_OK
822 && 0 < length
&& length
<= digest_length
827 digest_length
= length
;
829 digest_hex_bytes
= digest_length
/ 4;
837 return bsd_split_3 (s
+ i
, s_len
- i
,
838 digest
, d_len
, file_name
, escaped_filename
);
843 /* Ignore this line if it is too short.
844 Each line must have at least 'min_digest_line_length - 1' (or one more, if
845 the first is a backslash) more characters to contain correct message digest
847 if (s_len
- i
< min_digest_line_length
+ (s
[i
] == '\\'))
850 *digest
= (unsigned char *) &s
[i
];
852 #if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
853 /* Auto determine length. */
855 if (cksum_algorithm
== blake2b
) {
857 unsigned char const *hp
= *digest
;
858 digest_hex_bytes
= 0;
859 while (isxdigit (*hp
++))
861 if (digest_hex_bytes
< 2 || digest_hex_bytes
% 2
862 || BLAKE2B_MAX_LEN
* 2 < digest_hex_bytes
)
864 digest_length
= digest_hex_bytes
* 4;
870 /* This field must be the hexadecimal or base64 representation
871 of the message digest. */
872 while (s
[i
] && !ISWHITE (s
[i
]))
875 /* The digest must be followed by at least one whitespace character. */
879 *d_len
= &s
[i
] - (char *) *digest
;
882 if (! valid_digits (*digest
, *d_len
))
885 /* If "bsd reversed" format detected. */
886 if ((s_len
- i
== 1) || (s
[i
] != ' ' && s
[i
] != '*'))
888 /* Don't allow mixing bsd and standard formats,
889 to minimize security issues with attackers
890 renaming files with leading spaces.
891 This assumes that with bsd format checksums
892 that the first file name does not have
893 a leading ' ' or '*'. */
894 if (bsd_reversed
== 0)
898 else if (bsd_reversed
!= 1)
901 *binary
= (s
[i
++] == '*');
904 /* All characters between the type indicator and end of line are
905 significant -- that includes leading and trailing white space. */
908 if (escaped_filename
)
909 return filename_unescape (&s
[i
], s_len
- i
) != nullptr;
914 /* If ESCAPE is true, then translate each:
915 NEWLINE byte to the string, "\\n",
916 CARRIAGE RETURN byte to the string, "\\r",
917 and each backslash to "\\\\". */
919 print_filename (char const *file
, bool escape
)
923 fputs (file
, stdout
);
932 fputs ("\\n", stdout
);
936 fputs ("\\r", stdout
);
940 fputs ("\\\\", stdout
);
951 /* An interface to the function, DIGEST_STREAM.
952 Operate on FILENAME (it may be "-").
954 *BINARY indicates whether the file is binary. BINARY < 0 means it
955 depends on whether binary mode makes any difference and the file is
956 a terminal; in that case, clear *BINARY if the file was treated as
957 text because it was a terminal.
959 Put the checksum in *BIN_RESULT, which must be properly aligned.
960 Put true in *MISSING if the file can't be opened due to ENOENT.
961 Return true if successful. */
964 digest_file (char const *filename
, int *binary
, unsigned char *bin_result
,
965 bool *missing
, MAYBE_UNUSED
uintmax_t *length
)
969 bool is_stdin
= STREQ (filename
, "-");
975 have_read_stdin
= true;
977 if (O_BINARY
&& *binary
)
980 *binary
= ! isatty (STDIN_FILENO
);
982 xset_binary_mode (STDIN_FILENO
, O_BINARY
);
987 fp
= fopen (filename
, (O_BINARY
&& *binary
? "rb" : "r"));
990 if (ignore_missing
&& errno
== ENOENT
)
995 error (0, errno
, "%s", quotef (filename
));
1000 fadvise (fp
, FADVISE_SEQUENTIAL
);
1003 if (cksum_algorithm
== blake2b
)
1004 *length
= digest_length
/ 8;
1005 err
= DIGEST_STREAM (fp
, bin_result
, length
);
1007 err
= DIGEST_STREAM (fp
, bin_result
, length
);
1008 #elif HASH_ALGO_BLAKE2
1009 err
= DIGEST_STREAM (fp
, bin_result
, digest_length
/ 8);
1011 err
= DIGEST_STREAM (fp
, bin_result
);
1013 err
= err
? errno
: 0;
1016 else if (fclose (fp
) != 0 && !err
)
1021 error (0, err
, "%s", quotef (filename
));
1030 output_file (char const *file
, int binary_file
, void const *digest
,
1031 bool raw
, bool tagged
, unsigned char delim
, MAYBE_UNUSED
bool args
,
1032 MAYBE_UNUSED
uintmax_t length
)
1034 # if HASH_ALGO_CKSUM
1037 fwrite (digest
, 1, digest_length
/ 8, stdout
);
1042 unsigned char const *bin_buffer
= digest
;
1044 /* Output a leading backslash if the file name contains problematic chars. */
1045 bool needs_escape
= delim
== '\n' && problematic_chars (file
);
1052 fputs (DIGEST_TYPE_STRING
, stdout
);
1053 # if HASH_ALGO_BLAKE2
1054 if (digest_length
< BLAKE2B_MAX_LEN
* 8)
1055 printf ("-%"PRIuMAX
, digest_length
);
1056 # elif HASH_ALGO_CKSUM
1057 if (cksum_algorithm
== blake2b
)
1059 if (digest_length
< BLAKE2B_MAX_LEN
* 8)
1060 printf ("-%"PRIuMAX
, digest_length
);
1063 fputs (" (", stdout
);
1064 print_filename (file
, needs_escape
);
1065 fputs (") = ", stdout
);
1068 # if HASH_ALGO_CKSUM
1071 char b64
[BASE64_LENGTH (DIGEST_BIN_BYTES
) + 1];
1072 base64_encode ((char const *) bin_buffer
, digest_length
/ 8,
1074 fputs (b64
, stdout
);
1079 for (size_t i
= 0; i
< (digest_hex_bytes
/ 2); ++i
)
1080 printf ("%02x", bin_buffer
[i
]);
1086 putchar (binary_file
? '*' : ' ');
1087 print_filename (file
, needs_escape
);
1095 /* Return true if B64_DIGEST is the same as the base64 digest of the
1096 DIGEST_LENGTH/8 bytes at BIN_BUFFER. */
1098 b64_equal (unsigned char const *b64_digest
, unsigned char const *bin_buffer
)
1100 size_t b64_n_bytes
= BASE64_LENGTH (digest_length
/ 8);
1101 char b64
[BASE64_LENGTH (DIGEST_BIN_BYTES
) + 1];
1102 base64_encode ((char const *) bin_buffer
, digest_length
/ 8, b64
, sizeof b64
);
1103 return memcmp (b64_digest
, b64
, b64_n_bytes
+ 1) == 0;
1107 /* Return true if HEX_DIGEST is the same as the hex-encoded digest of the
1108 DIGEST_LENGTH/8 bytes at BIN_BUFFER. */
1110 hex_equal (unsigned char const *hex_digest
, unsigned char const *bin_buffer
)
1112 static const char bin2hex
[] = { '0', '1', '2', '3',
1115 'c', 'd', 'e', 'f' };
1116 size_t digest_bin_bytes
= digest_hex_bytes
/ 2;
1118 /* Compare generated binary number with text representation
1119 in check file. Ignore case of hex digits. */
1121 for (cnt
= 0; cnt
< digest_bin_bytes
; ++cnt
)
1123 if (tolower (hex_digest
[2 * cnt
])
1124 != bin2hex
[bin_buffer
[cnt
] >> 4]
1125 || (tolower (hex_digest
[2 * cnt
+ 1])
1126 != (bin2hex
[bin_buffer
[cnt
] & 0xf])))
1129 return cnt
== digest_bin_bytes
;
1133 digest_check (char const *checkfile_name
)
1135 FILE *checkfile_stream
;
1136 uintmax_t n_misformatted_lines
= 0;
1137 uintmax_t n_mismatched_checksums
= 0;
1138 uintmax_t n_open_or_read_failures
= 0;
1139 bool properly_formatted_lines
= false;
1140 bool matched_checksums
= false;
1141 unsigned char bin_buffer_unaligned
[DIGEST_BIN_BYTES
+ DIGEST_ALIGN
];
1142 /* Make sure bin_buffer is properly aligned. */
1143 unsigned char *bin_buffer
= ptr_align (bin_buffer_unaligned
, DIGEST_ALIGN
);
1144 uintmax_t line_number
;
1146 size_t line_chars_allocated
;
1147 bool is_stdin
= STREQ (checkfile_name
, "-");
1151 have_read_stdin
= true;
1152 checkfile_name
= _("standard input");
1153 checkfile_stream
= stdin
;
1157 checkfile_stream
= fopen (checkfile_name
, "r");
1158 if (checkfile_stream
== nullptr)
1160 error (0, errno
, "%s", quotef (checkfile_name
));
1167 line_chars_allocated
= 0;
1172 unsigned char *digest
;
1173 ssize_t line_length
;
1176 if (line_number
== 0)
1177 error (EXIT_FAILURE
, 0, _("%s: too many checksum lines"),
1178 quotef (checkfile_name
));
1180 line_length
= getline (&line
, &line_chars_allocated
, checkfile_stream
);
1181 if (line_length
<= 0)
1184 /* Ignore comment lines, which begin with a '#' character. */
1188 /* Remove any trailing newline. */
1189 line_length
-= line
[line_length
- 1] == '\n';
1190 /* Remove any trailing carriage return. */
1191 line_length
-= line
[line_length
- (0 < line_length
)] == '\r';
1193 /* Ignore empty lines. */
1194 if (line_length
== 0)
1197 line
[line_length
] = '\0';
1200 if (! (split_3 (line
, line_length
, &digest
, &d_len
, &binary
, &filename
)
1201 && ! (is_stdin
&& STREQ (filename
, "-"))))
1203 ++n_misformatted_lines
;
1209 ": improperly formatted %s checksum line"),
1210 quotef (checkfile_name
), line_number
,
1211 DIGEST_TYPE_STRING
);
1218 bool needs_escape
= ! status_only
&& problematic_chars (filename
);
1220 properly_formatted_lines
= true;
1223 ok
= digest_file (filename
, &binary
, bin_buffer
, &missing
, &length
);
1227 ++n_open_or_read_failures
;
1232 print_filename (filename
, needs_escape
);
1233 printf (": %s\n", _("FAILED open or read"));
1236 else if (ignore_missing
&& missing
)
1238 /* Ignore missing files with --ignore-missing. */
1245 if (d_len
< digest_hex_bytes
)
1246 match
= b64_equal (digest
, bin_buffer
);
1249 if (d_len
== digest_hex_bytes
)
1250 match
= hex_equal (digest
, bin_buffer
);
1253 matched_checksums
= true;
1255 ++n_mismatched_checksums
;
1259 if (! match
|| ! quiet
)
1263 print_filename (filename
, needs_escape
);
1267 printf (": %s\n", _("FAILED"));
1269 printf (": %s\n", _("OK"));
1274 while (!feof (checkfile_stream
) && !ferror (checkfile_stream
));
1278 int err
= ferror (checkfile_stream
) ? 0 : -1;
1280 clearerr (checkfile_stream
);
1281 else if (fclose (checkfile_stream
) != 0 && err
< 0)
1286 error (0, err
, err
? "%s" : _("%s: read error"),
1287 quotef (checkfile_name
));
1291 if (! properly_formatted_lines
)
1293 /* Warn if no tests are found. */
1294 error (0, 0, _("%s: no properly formatted checksum lines found"),
1295 quotef (checkfile_name
));
1301 if (n_misformatted_lines
!= 0)
1304 ("WARNING: %" PRIuMAX
" line is improperly formatted",
1305 "WARNING: %" PRIuMAX
" lines are improperly formatted",
1306 select_plural (n_misformatted_lines
))),
1307 n_misformatted_lines
);
1309 if (n_open_or_read_failures
!= 0)
1312 ("WARNING: %" PRIuMAX
" listed file could not be read",
1313 "WARNING: %" PRIuMAX
" listed files could not be read",
1314 select_plural (n_open_or_read_failures
))),
1315 n_open_or_read_failures
);
1317 if (n_mismatched_checksums
!= 0)
1320 ("WARNING: %" PRIuMAX
" computed checksum did NOT match",
1321 "WARNING: %" PRIuMAX
" computed checksums did NOT match",
1322 select_plural (n_mismatched_checksums
))),
1323 n_mismatched_checksums
);
1325 if (ignore_missing
&& ! matched_checksums
)
1326 error (0, 0, _("%s: no file was verified"),
1327 quotef (checkfile_name
));
1331 return (properly_formatted_lines
1332 && matched_checksums
1333 && n_mismatched_checksums
== 0
1334 && n_open_or_read_failures
== 0
1335 && (!strict
|| n_misformatted_lines
== 0));
1339 main (int argc
, char **argv
)
1341 unsigned char bin_buffer_unaligned
[DIGEST_BIN_BYTES
+ DIGEST_ALIGN
];
1342 /* Make sure bin_buffer is properly aligned. */
1343 unsigned char *bin_buffer
= ptr_align (bin_buffer_unaligned
, DIGEST_ALIGN
);
1344 bool do_check
= false;
1349 bool prefix_tag
= true;
1351 bool prefix_tag
= false;
1354 /* Setting values of global variables. */
1355 initialize_main (&argc
, &argv
);
1356 set_program_name (argv
[0]);
1357 setlocale (LC_ALL
, "");
1358 bindtextdomain (PACKAGE
, LOCALEDIR
);
1359 textdomain (PACKAGE
);
1361 atexit (close_stdout
);
1363 /* Line buffer stdout to ensure lines are written atomically and immediately
1364 so that processes running in parallel do not intersperse their output. */
1365 setvbuf (stdout
, nullptr, _IOLBF
, 0);
1368 char const *short_opts
= "rs";
1369 #elif HASH_ALGO_CKSUM
1370 char const *short_opts
= "a:l:bctwz";
1371 char const *digest_length_str
= "";
1372 #elif HASH_ALGO_BLAKE2
1373 char const *short_opts
= "l:bctwz";
1374 char const *digest_length_str
= "";
1376 char const *short_opts
= "bctwz";
1379 while ((opt
= getopt_long (argc
, argv
, short_opts
, long_options
, nullptr))
1385 cksum_algorithm
= XARGMATCH_EXACT ("--algorithm", optarg
,
1386 algorithm_args
, algorithm_types
);
1387 algorithm_specified
= true;
1390 case DEBUG_PROGRAM_OPTION
:
1394 #if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
1396 digest_length
= xdectoumax (optarg
, 0, UINTMAX_MAX
, "",
1397 _("invalid length"), 0);
1398 digest_length_str
= optarg
;
1399 if (digest_length
% 8 != 0)
1401 error (0, 0, _("invalid length: %s"), quote (digest_length_str
));
1402 error (EXIT_FAILURE
, 0, _("length is not a multiple of 8"));
1422 status_only
= false;
1426 case IGNORE_MISSING_OPTION
:
1427 ignore_missing
= true;
1430 status_only
= false;
1437 # if HASH_ALGO_CKSUM
1439 base64_digest
= true;
1453 digest_delim
= '\0';
1457 case 'r': /* For SysV compatibility. */
1458 sum_algorithm
= bsd
;
1462 sum_algorithm
= sysv
;
1465 case_GETOPT_HELP_CHAR
;
1466 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
1468 usage (EXIT_FAILURE
);
1471 min_digest_line_length
= MIN_DIGEST_LINE_LENGTH
;
1472 #if HASH_ALGO_BLAKE2 || HASH_ALGO_CKSUM
1473 # if HASH_ALGO_CKSUM
1474 if (digest_length
&& cksum_algorithm
!= blake2b
)
1475 error (EXIT_FAILURE
, 0,
1476 _("--length is only supported with --algorithm=blake2b"));
1478 if (digest_length
> BLAKE2B_MAX_LEN
* 8)
1480 error (0, 0, _("invalid length: %s"), quote (digest_length_str
));
1481 error (EXIT_FAILURE
, 0,
1482 _("maximum digest length for %s is %d bits"),
1483 quote (DIGEST_TYPE_STRING
),
1484 BLAKE2B_MAX_LEN
* 8);
1486 if (digest_length
== 0)
1488 # if HASH_ALGO_BLAKE2
1489 digest_length
= BLAKE2B_MAX_LEN
* 8;
1491 digest_length
= algorithm_bits
[cksum_algorithm
];
1494 digest_hex_bytes
= digest_length
/ 4;
1496 digest_hex_bytes
= DIGEST_HEX_BYTES
;
1500 switch (cksum_algorithm
)
1505 if (do_check
&& algorithm_specified
)
1506 error (EXIT_FAILURE
, 0,
1507 _("--check is not supported with --algorithm={bsd,sysv,crc}"));
1513 if (base64_digest
&& raw_digest
)
1515 error (0, 0, _("--base64 and --raw are mutually exclusive"));
1516 usage (EXIT_FAILURE
);
1520 if (prefix_tag
&& !binary
)
1522 /* This could be supported in a backwards compatible way
1523 by prefixing the output line with a space in text mode.
1524 However that's invasive enough that it was agreed to
1525 not support this mode with --tag, as --text use cases
1526 are adequately supported by the default output format. */
1527 #if !HASH_ALGO_CKSUM
1528 error (0, 0, _("--tag does not support --text mode"));
1530 error (0, 0, _("--text mode is only supported with --untagged"));
1532 usage (EXIT_FAILURE
);
1535 if (digest_delim
!= '\n' && do_check
)
1537 error (0, 0, _("the --zero option is not supported when "
1538 "verifying checksums"));
1539 usage (EXIT_FAILURE
);
1541 #if !HASH_ALGO_CKSUM
1542 if (prefix_tag
&& do_check
)
1544 error (0, 0, _("the --tag option is meaningless when "
1545 "verifying checksums"));
1546 usage (EXIT_FAILURE
);
1550 if (0 <= binary
&& do_check
)
1552 error (0, 0, _("the --binary and --text options are meaningless when "
1553 "verifying checksums"));
1554 usage (EXIT_FAILURE
);
1557 if (ignore_missing
&& !do_check
)
1560 _("the --ignore-missing option is meaningful only when "
1561 "verifying checksums"));
1562 usage (EXIT_FAILURE
);
1565 if (status_only
&& !do_check
)
1568 _("the --status option is meaningful only when verifying checksums"));
1569 usage (EXIT_FAILURE
);
1572 if (warn
&& !do_check
)
1575 _("the --warn option is meaningful only when verifying checksums"));
1576 usage (EXIT_FAILURE
);
1579 if (quiet
&& !do_check
)
1582 _("the --quiet option is meaningful only when verifying checksums"));
1583 usage (EXIT_FAILURE
);
1586 if (strict
& !do_check
)
1589 _("the --strict option is meaningful only when verifying checksums"));
1590 usage (EXIT_FAILURE
);
1593 if (!O_BINARY
&& binary
< 0)
1596 char **operand_lim
= argv
+ argc
;
1598 *operand_lim
++ = bad_cast ("-");
1599 else if (1 < argc
- optind
&& raw_digest
)
1600 error (EXIT_FAILURE
, 0,
1601 _("the --raw option is not supported with multiple files"));
1603 for (char **operandp
= argv
+ optind
; operandp
< operand_lim
; operandp
++)
1605 char *file
= *operandp
;
1607 ok
&= digest_check (file
);
1610 int binary_file
= binary
;
1614 if (! digest_file (file
, &binary_file
, bin_buffer
, &missing
, &length
))
1618 DIGEST_OUT (file
, binary_file
, bin_buffer
, raw_digest
, prefix_tag
,
1619 digest_delim
, optind
!= argc
, length
);
1624 if (have_read_stdin
&& fclose (stdin
) == EOF
)
1625 error (EXIT_FAILURE
, errno
, _("standard input"));
1627 return ok
? EXIT_SUCCESS
: EXIT_FAILURE
;