coreutils/md5_sha1_sum.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Copyright (C) 2003 Glenn L. McGrath
   4  * Copyright (C) 2003-2004 Erik Andersen
   5  *
   6  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   7  */
   8 //config:config MD5SUM
   9 //config:       bool "md5sum (6.7 kb)"
  10 //config:       default y
  11 //config:       help
  12 //config:       Compute and check MD5 message digest
  13 //config:
  14 //config:config SHA1SUM
  15 //config:       bool "sha1sum (6.7 kb)"
  16 //config:       default y
  17 //config:       help
  18 //config:       Compute and check SHA1 message digest
  19 //config:
  20 //config:config SHA256SUM
  21 //config:       bool "sha256sum (8.2 kb)"
  22 //config:       default y
  23 //config:       help
  24 //config:       Compute and check SHA256 message digest
  25 //config:
  26 //config:config SHA512SUM
  27 //config:       bool "sha512sum (7.3 kb)"
  28 //config:       default y
  29 //config:       help
  30 //config:       Compute and check SHA512 message digest
  31 //config:
  32 //config:config SHA3SUM
  33 //config:       bool "sha3sum (6.3 kb)"
  34 //config:       default y
  35 //config:       help
  36 //config:       Compute and check SHA3 message digest
  37 //config:
  38 //config:comment "Common options for md5sum, sha1sum, sha256sum, sha512sum, sha3sum"
  39 //config:       depends on MD5SUM || SHA1SUM || SHA256SUM || SHA512SUM || SHA3SUM
  40 //config:
  41 //config:config FEATURE_MD5_SHA1_SUM_CHECK
  42 //config:       bool "Enable -c, -s and -w options"
  43 //config:       default y
  44 //config:       depends on MD5SUM || SHA1SUM || SHA256SUM || SHA512SUM || SHA3SUM
  45 //config:       help
  46 //config:       Enabling the -c options allows files to be checked
  47 //config:       against pre-calculated hash values.
  48 //config:       -s and -w are useful options when verifying checksums.
  49
  50 //applet:IF_MD5SUM(APPLET_NOEXEC(md5sum, md5_sha1_sum, BB_DIR_USR_BIN, BB_SUID_DROP, md5sum))
  51 //applet:IF_SHA1SUM(APPLET_NOEXEC(sha1sum, md5_sha1_sum, BB_DIR_USR_BIN, BB_SUID_DROP, sha1sum))
  52 //applet:IF_SHA3SUM(APPLET_NOEXEC(sha3sum, md5_sha1_sum, BB_DIR_USR_BIN, BB_SUID_DROP, sha3sum))
  53 //applet:IF_SHA256SUM(APPLET_NOEXEC(sha256sum, md5_sha1_sum, BB_DIR_USR_BIN, BB_SUID_DROP, sha256sum))
  54 //applet:IF_SHA512SUM(APPLET_NOEXEC(sha512sum, md5_sha1_sum, BB_DIR_USR_BIN, BB_SUID_DROP, sha512sum))
  55
  56 //kbuild:lib-$(CONFIG_MD5SUM)    += md5_sha1_sum.o
  57 //kbuild:lib-$(CONFIG_SHA1SUM)   += md5_sha1_sum.o
  58 //kbuild:lib-$(CONFIG_SHA256SUM) += md5_sha1_sum.o
  59 //kbuild:lib-$(CONFIG_SHA512SUM) += md5_sha1_sum.o
  60 //kbuild:lib-$(CONFIG_SHA3SUM)   += md5_sha1_sum.o
  61
  62 //usage:#define md5sum_trivial_usage
  63 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK("[-c[sw]] ")"[FILE]..."
  64 //usage:#define md5sum_full_usage "\n\n"
  65 //usage:       "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums"
  66 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n"
  67 //usage:     "\n        -c      Check sums against list in FILEs"
  68 //usage:     "\n        -s      Don't output anything, status code shows success"
  69 //usage:     "\n        -w      Warn about improperly formatted checksum lines"
  70 //usage:        )
  71 //usage:
  72 //usage:#define md5sum_example_usage
  73 //usage:       "$ md5sum < busybox\n"
  74 //usage:       "6fd11e98b98a58f64ff3398d7b324003\n"
  75 //usage:       "$ md5sum busybox\n"
  76 //usage:       "6fd11e98b98a58f64ff3398d7b324003  busybox\n"
  77 //usage:       "$ md5sum -c -\n"
  78 //usage:       "6fd11e98b98a58f64ff3398d7b324003  busybox\n"
  79 //usage:       "busybox: OK\n"
  80 //usage:       "^D\n"
  81 //usage:
  82 //usage:#define sha1sum_trivial_usage
  83 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK("[-c[sw]] ")"[FILE]..."
  84 //usage:#define sha1sum_full_usage "\n\n"
  85 //usage:       "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums"
  86 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n"
  87 //usage:     "\n        -c      Check sums against list in FILEs"
  88 //usage:     "\n        -s      Don't output anything, status code shows success"
  89 //usage:     "\n        -w      Warn about improperly formatted checksum lines"
  90 //usage:        )
  91 //usage:
  92 //usage:#define sha256sum_trivial_usage
  93 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK("[-c[sw]] ")"[FILE]..."
  94 //usage:#define sha256sum_full_usage "\n\n"
  95 //usage:       "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA256 checksums"
  96 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n"
  97 //usage:     "\n        -c      Check sums against list in FILEs"
  98 //usage:     "\n        -s      Don't output anything, status code shows success"
  99 //usage:     "\n        -w      Warn about improperly formatted checksum lines"
 100 //usage:        )
 101 //usage:
 102 //usage:#define sha512sum_trivial_usage
 103 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK("[-c[sw]] ")"[FILE]..."
 104 //usage:#define sha512sum_full_usage "\n\n"
 105 //usage:       "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA512 checksums"
 106 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n"
 107 //usage:     "\n        -c      Check sums against list in FILEs"
 108 //usage:     "\n        -s      Don't output anything, status code shows success"
 109 //usage:     "\n        -w      Warn about improperly formatted checksum lines"
 110 //usage:        )
 111 //usage:
 112 //usage:#define sha3sum_trivial_usage
 113 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK("[-c[sw]] ")"[-a BITS] [FILE]..."
 114 //usage:#define sha3sum_full_usage "\n\n"
 115 //usage:       "Print" IF_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA3 checksums"
 116 //usage:        IF_FEATURE_MD5_SHA1_SUM_CHECK( "\n"
 117 //usage:     "\n        -c      Check sums against list in FILEs"
 118 //usage:     "\n        -s      Don't output anything, status code shows success"
 119 //usage:     "\n        -w      Warn about improperly formatted checksum lines"
 120 //usage:        )
 121 //usage:     "\n        -a BITS 224 (default), 256, 384, 512"
 122
 123 //FIXME: GNU coreutils 8.25 has no -s option, it has only these two long opts:
 124 // --quiet   don't print OK for each successfully verified file
 125 // --status  don't output anything, status code shows success
 126
 127 #include "libbb.h"
 128
 129 /* This is a NOEXEC applet. Be very careful! */
 130
 131 enum {
 132         /* 4th letter of applet_name is... */
 133         HASH_MD5 = 's', /* "md5>s<um" */
 134         HASH_SHA1 = '1',
 135         HASH_SHA256 = '2',
 136         HASH_SHA3 = '3',
 137         HASH_SHA512 = '5',
 138 };
 139
 140 #define FLAG_SILENT  1
 141 #define FLAG_CHECK   2
 142 #define FLAG_WARN    4
 143
 144 /* This might be useful elsewhere */
 145 static unsigned char *hash_bin_to_hex(unsigned char *hash_value,
 146                                 unsigned hash_length)
 147 {
 148         /* xzalloc zero-terminates */
 149         char *hex_value = xzalloc((hash_length * 2) + 1);
 150         bin2hex(hex_value, (char*)hash_value, hash_length);
 151         return (unsigned char *)hex_value;
 152 }
 153
 154 #define BUFSZ (CONFIG_FEATURE_COPYBUF_KB < 4 ? 4096 : CONFIG_FEATURE_COPYBUF_KB * 1024)
 155
 156 #if !ENABLE_SHA3SUM
 157 # define hash_file(b,f,w) hash_file(b,f)
 158 #endif
 159 static uint8_t *hash_file(unsigned char *in_buf, const char *filename, unsigned sha3_width)
 160 {
 161         int src_fd, hash_len, count;
 162         union _ctx_ {
 163                 sha3_ctx_t sha3;
 164                 sha512_ctx_t sha512;
 165                 sha256_ctx_t sha256;
 166                 sha1_ctx_t sha1;
 167                 md5_ctx_t md5;
 168         } context;
 169         uint8_t *hash_value;
 170         void FAST_FUNC (*update)(void*, const void*, size_t);
 171         unsigned FAST_FUNC (*final)(void*, void*);
 172         char hash_algo;
 173
 174         src_fd = open_or_warn_stdin(filename);
 175         if (src_fd < 0) {
 176                 return NULL;
 177         }
 178
 179         hash_algo = applet_name[3];
 180
 181         /* figure specific hash algorithms */
 182         if (ENABLE_MD5SUM && hash_algo == HASH_MD5) {
 183                 md5_begin(&context.md5);
 184                 update = (void*)md5_hash;
 185                 final = (void*)md5_end;
 186                 hash_len = 16;
 187         }
 188         else if (ENABLE_SHA1SUM && hash_algo == HASH_SHA1) {
 189                 sha1_begin(&context.sha1);
 190                 update = (void*)sha1_hash;
 191                 final = (void*)sha1_end;
 192                 hash_len = 20;
 193         }
 194         else if (ENABLE_SHA256SUM && hash_algo == HASH_SHA256) {
 195                 sha256_begin(&context.sha256);
 196                 update = (void*)sha256_hash;
 197                 final = (void*)sha256_end;
 198                 hash_len = 32;
 199         }
 200         else if (ENABLE_SHA512SUM && hash_algo == HASH_SHA512) {
 201                 sha512_begin(&context.sha512);
 202                 update = (void*)sha512_hash;
 203                 final = (void*)sha512_end;
 204                 hash_len = 64;
 205         }
 206 #if ENABLE_SHA3SUM
 207         else if (ENABLE_SHA3SUM && hash_algo == HASH_SHA3) {
 208                 sha3_begin(&context.sha3);
 209                 update = (void*)sha3_hash;
 210                 final = (void*)sha3_end;
 211                 /*
 212                  * Should support 224, 256, 384, 512.
 213                  * We allow any value which does not blow the algorithm up.
 214                  */
 215                 if (sha3_width >= 1600/2 /* input block can't be <= 0 */
 216                  || sha3_width == 0      /* hash len can't be 0 */
 217                  || (sha3_width & 0x1f)  /* should be multiple of 32 */
 218                 /* (because input uses up to 8 byte wide word XORs. 32/4=8) */
 219                 ) {
 220                         bb_error_msg_and_die("bad -a%u", sha3_width);
 221                 }
 222                 sha3_width /= 4;
 223                 context.sha3.input_block_bytes = 1600/8 - sha3_width;
 224                 hash_len = sha3_width/2;
 225         }
 226 #endif
 227         else {
 228                 xfunc_die(); /* can't reach this */
 229         }
 230
 231         {
 232                 while ((count = safe_read(src_fd, in_buf, BUFSZ)) > 0) {
 233                         update(&context, in_buf, count);
 234                 }
 235                 hash_value = NULL;
 236                 if (count < 0)
 237                         bb_perror_msg("can't read '%s'", filename);
 238                 else /* count == 0 */ {
 239                         final(&context, in_buf);
 240                         hash_value = hash_bin_to_hex(in_buf, hash_len);
 241                 }
 242         }
 243
 244         if (src_fd != STDIN_FILENO) {
 245                 close(src_fd);
 246         }
 247
 248         return hash_value;
 249 }
 250
 251 int md5_sha1_sum_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 252 int md5_sha1_sum_main(int argc UNUSED_PARAM, char **argv)
 253 {
 254         unsigned char *in_buf;
 255         int return_value = EXIT_SUCCESS;
 256         unsigned flags;
 257 #if ENABLE_SHA3SUM
 258         unsigned sha3_width = 224;
 259 #endif
 260
 261         if (ENABLE_FEATURE_MD5_SHA1_SUM_CHECK) {
 262                 /* -b "binary", -t "text" are ignored (shaNNNsum compat) */
 263                 /* -s and -w require -c */
 264 #if ENABLE_SHA3SUM
 265                 if (applet_name[3] == HASH_SHA3)
 266                         flags = getopt32(argv, "^" "scwbta:+" "\0" "s?c:w?c", &sha3_width);
 267                 else
 268 #endif
 269                         flags = getopt32(argv, "^" "scwbt" "\0" "s?c:w?c");
 270         } else {
 271 #if ENABLE_SHA3SUM
 272                 if (applet_name[3] == HASH_SHA3)
 273                         getopt32(argv, "a:+", &sha3_width);
 274                 else
 275 #endif
 276                         getopt32(argv, "");
 277         }
 278         argv += optind;
 279         //argc -= optind;
 280         if (!*argv)
 281                 *--argv = (char*)"-";
 282
 283         /* The buffer is not alloc/freed for each input file:
 284          * for big values of COPYBUF_KB, this helps to keep its pages
 285          * pre-faulted and possibly even fully cached on local CPU.
 286          */
 287         in_buf = xmalloc(BUFSZ);
 288
 289         do {
 290                 if (ENABLE_FEATURE_MD5_SHA1_SUM_CHECK && (flags & FLAG_CHECK)) {
 291                         FILE *pre_computed_stream;
 292                         char *line;
 293                         int count_total = 0;
 294                         int count_failed = 0;
 295
 296                         pre_computed_stream = xfopen_stdin(*argv);
 297
 298                         while ((line = xmalloc_fgetline(pre_computed_stream)) != NULL) {
 299                                 uint8_t *hash_value;
 300                                 char *filename_ptr;
 301
 302                                 count_total++;
 303                                 filename_ptr = strchr(line, ' ');
 304                                 if (!filename_ptr) {
 305                                         if (flags & FLAG_WARN) {
 306                                                 bb_simple_error_msg("invalid format");
 307                                         }
 308                                         count_failed++;
 309                                         return_value = EXIT_FAILURE;
 310                                         free(line);
 311                                         continue;
 312                                 }
 313                                 *filename_ptr++ = '\0';
 314                                 /* coreutils 9.1 allows "HASH FILENAME" format,
 315                                  * with only one space. Skip the 'correct'
 316                                  * "  " or " *" delimiter if it is there:
 317                                  */
 318                                 if (*filename_ptr == ' ' || *filename_ptr == '*')
 319                                         filename_ptr++;
 320
 321                                 hash_value = hash_file(in_buf, filename_ptr, sha3_width);
 322
 323                                 if (hash_value && (strcasecmp((char*)hash_value, line) == 0)) {
 324                                         if (!(flags & FLAG_SILENT))
 325                                                 printf("%s: OK\n", filename_ptr);
 326                                 } else {
 327                                         if (!(flags & FLAG_SILENT))
 328                                                 printf("%s: FAILED\n", filename_ptr);
 329                                         count_failed++;
 330                                         return_value = EXIT_FAILURE;
 331                                 }
 332                                 /* possible free(NULL) */
 333                                 free(hash_value);
 334                                 free(line);
 335                         }
 336                         if (count_failed && !(flags & FLAG_SILENT)) {
 337                                 bb_error_msg("WARNING: %d of %d computed checksums did NOT match",
 338                                                 count_failed, count_total);
 339                         }
 340                         if (count_total == 0) {
 341                                 return_value = EXIT_FAILURE;
 342                                 /*
 343                                  * md5sum from GNU coreutils 8.25 says:
 344                                  * md5sum: <FILE>: no properly formatted MD5 checksum lines found
 345                                  */
 346                                 bb_error_msg("%s: no checksum lines found", *argv);
 347                         }
 348                         fclose_if_not_stdin(pre_computed_stream);
 349                 } else {
 350                         uint8_t *hash_value = hash_file(in_buf, *argv, sha3_width);
 351                         if (hash_value == NULL) {
 352                                 return_value = EXIT_FAILURE;
 353                         } else {
 354                                 printf("%s  %s\n", hash_value, *argv);
 355                                 free(hash_value);
 356                         }
 357                 }
 358         } while (*++argv);
 359
 360         return return_value;
 361 }