src/md5sum.c

   1 /* Compute MD5 or SHA1 checksum of files or strings
   2    Copyright (C) 1995-2001 Free Software Foundation, Inc.
   3
   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)
   7    any later version.
   8
   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.
  13
  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.  */
  17
  18 /* Written by Ulrich Drepper <drepper@gnu.ai.mit.edu>.  */
  19
  20 #include <config.h>
  21
  22 #include <getopt.h>
  23 #include <stdio.h>
  24 #include <sys/types.h>
  25
  26 #include "system.h"
  27
  28 #include "md5.h"
  29 #include "sha.h"
  30 #include "checksum.h"
  31 #include "getline.h"
  32 #include "closeout.h"
  33 #include "error.h"
  34
  35 /* The official name of this program (e.g., no `g' prefix).  */
  36 #define PROGRAM_NAME (algorithm == ALG_MD5 ? "md5sum" : "shasum")
  37
  38 #define AUTHORS N_ ("Ulrich Drepper and Scott Miller")
  39
  40 /* Most systems do not distinguish between external and internal
  41    text representations.  */
  42 /* FIXME: This begs for an autoconf test.  */
  43 #if O_BINARY
  44 # define OPENOPTS(BINARY) ((BINARY) != 0 ? TEXT1TO1 : TEXTCNVT)
  45 # define TEXT1TO1 "rb"
  46 # define TEXTCNVT "r"
  47 #else
  48 # if defined VMS
  49 #  define OPENOPTS(BINARY) ((BINARY) != 0 ? TEXT1TO1 : TEXTCNVT)
  50 #  define TEXT1TO1 "rb", "ctx=stm"
  51 #  define TEXTCNVT "r", "ctx=stm"
  52 # else
  53 #  if UNIX || __UNIX__ || unix || __unix__ || _POSIX_VERSION
  54 #   define OPENOPTS(BINARY) "r"
  55 #  else
  56     /* The following line is intended to evoke an error.
  57        Using #error is not portable enough.  */
  58     "Cannot determine system type."
  59 #  endif
  60 # endif
  61 #endif
  62
  63
  64 #define DIGEST_TYPE_STRING(Alg) ((Alg) == ALG_MD5 ? "MD5" : "SHA1")
  65 #define DIGEST_STREAM(Alg) ((Alg) == ALG_MD5 ? md5_stream : sha_stream)
  66
  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)
  70
  71 #define MAX_DIGEST_BIN_BYTES MAX (DIGEST_BIN_BYTES (ALG_MD5), \
  72                                   DIGEST_BIN_BYTES (ALG_SHA1))
  73
  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 */ )
  80
  81 /* Nonzero if any of the files read were the standard input. */
  82 static int have_read_stdin;
  83
  84 /* The minimum length of a valid checksum line for the selected algorithm.  */
  85 static int min_digest_line_length;
  86
  87 /* Set to the length of a digest hex string for the selected algorithm.  */
  88 static size_t digest_hex_bytes;
  89
  90 /* With --check, don't generate any output.
  91    The exit code indicates success or failure.  */
  92 static int status_only = 0;
  93
  94 /* With --check, print a message to standard error warning about each
  95    improperly formatted checksum line.  */
  96 static int warn = 0;
  97
  98 /* Declared and set via one of the wrapper .c files.  */
  99 /* int algorithm = ALG_UNSPECIFIED; */
 100
 101 /* The name this program was run with.  */
 102 char *program_name;
 103
 104 static const struct option long_options[] =
 105 {
 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 },
 114   { NULL, 0, NULL, 0 }
 115 };
 116
 117 void
 118 usage (int status)
 119 {
 120   if (status != 0)
 121     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 122              program_name);
 123   else
 124     {
 125       printf (_("\
 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\
 130 \n\
 131   -b, --binary            read files in binary mode (default on DOS/Windows)\n\
 132   -c, --check             check %s sums against given list\n\
 133   -t, --text              read files in text mode (default)\n\
 134 \n\
 135 The following two options are useful only when verifying checksums:\n\
 136       --status            don't output anything, status code shows success\n\
 137   -w, --warn              warn about improperly formated checksum lines\n\
 138 \n\
 139       --help              display this help and exit\n\
 140       --version           output version information and exit\n\
 141 \n\
 142 The sums are computed as described in %s.  When checking, the input\n\
 143 should be a former output of this program.  The default mode is to print\n\
 144 a line with checksum, a character indicating type (`*' for binary, ` ' for\n\
 145 text), and name for each FILE.\n"),
 146               program_name, program_name,
 147               DIGEST_TYPE_STRING (algorithm),
 148               DIGEST_BITS (algorithm),
 149               DIGEST_TYPE_STRING (algorithm),
 150               (algorithm == ALG_MD5 ? "RFC 1321" : "FIPS-180-1")
 151               );
 152       puts (_("\nReport bugs to <bug-textutils@gnu.org>."));
 153     }
 154
 155   exit (status == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
 156 }
 157
 158 static int
 159 split_3 (char *s, size_t s_len, unsigned char **u, int *binary, char **w)
 160 {
 161   size_t i;
 162   int escaped_filename = 0;
 163
 164 #define ISWHITE(c) ((c) == ' ' || (c) == '\t')
 165
 166   i = 0;
 167   while (ISWHITE (s[i]))
 168     ++i;
 169
 170   /* The line must have at least `min_digest_line_length - 1' (or one more, if
 171      the first is a backslash) more characters to contain correct message digest
 172      information.  Ignore this line if it is too short.  */
 173   if (!(s_len - i >= min_digest_line_length
 174         || (s[i] == '\\' && s_len - i >= 1 + min_digest_line_length)))
 175     return 1;
 176
 177   if (s[i] == '\\')
 178     {
 179       ++i;
 180       escaped_filename = 1;
 181     }
 182   *u = (unsigned char *) &s[i];
 183
 184   /* The first field has to be the n-character hexadecimal
 185      representation of the message digest.  If it is not followed
 186      immediately by a white space it's an error.  */
 187   i += digest_hex_bytes;
 188   if (!ISWHITE (s[i]))
 189     return 1;
 190
 191   s[i++] = '\0';
 192
 193   if (s[i] != ' ' && s[i] != '*')
 194     return 1;
 195   *binary = (s[i++] == '*');
 196
 197   /* All characters between the type indicator and end of line are
 198      significant -- that includes leading and trailing white space.  */
 199   *w = &s[i];
 200
 201   if (escaped_filename)
 202     {
 203       /* Translate each `\n' string in the file name to a NEWLINE,
 204          and each `\\' string to a backslash.  */
 205
 206       char *dst = &s[i];
 207
 208       while (i < s_len)
 209         {
 210           switch (s[i])
 211             {
 212             case '\\':
 213               if (i == s_len - 1)
 214                 {
 215                   /* A valid line does not end with a backslash.  */
 216                   return 1;
 217                 }
 218               ++i;
 219               switch (s[i++])
 220                 {
 221                 case 'n':
 222                   *dst++ = '\n';
 223                   break;
 224                 case '\\':
 225                   *dst++ = '\\';
 226                   break;
 227                 default:
 228                   /* Only `\' or `n' may follow a backslash.  */
 229                   return 1;
 230                 }
 231               break;
 232
 233             case '\0':
 234               /* The file name may not contain a NUL.  */
 235               return 1;
 236               break;
 237
 238             default:
 239               *dst++ = s[i++];
 240               break;
 241             }
 242         }
 243       *dst = '\0';
 244     }
 245   return 0;
 246 }
 247
 248 static int
 249 hex_digits (unsigned char const *s)
 250 {
 251   while (*s)
 252     {
 253       if (!ISXDIGIT (*s))
 254         return 0;
 255       ++s;
 256     }
 257   return 1;
 258 }
 259
 260 /* An interface to the function, DIGEST_STREAM, (either md5_stream or sha_stream).
 261    Operate on FILENAME (it may be "-") and put the result in *BIN_RESULT.
 262    Return non-zero upon failure, zero to indicate success.  */
 263
 264 static int
 265 digest_file (const char *filename, int binary, unsigned char *bin_result,
 266            int (*digest_stream)(FILE *, void *))
 267 {
 268   FILE *fp;
 269   int err;
 270
 271   if (STREQ (filename, "-"))
 272     {
 273       have_read_stdin = 1;
 274       fp = stdin;
 275 #if O_BINARY
 276       /* If we need binary reads from a pipe or redirected stdin, we need
 277          to switch it to BINARY mode here, since stdin is already open.  */
 278       if (binary)
 279         SET_BINARY (fileno (stdin));
 280 #endif
 281     }
 282   else
 283     {
 284       /* OPENOPTS is a macro.  It varies with the system.
 285          Some systems distinguish between internal and
 286          external text representations.  */
 287
 288       fp = fopen (filename, OPENOPTS (binary));
 289       if (fp == NULL)
 290         {
 291           error (0, errno, "%s", filename);
 292           return 1;
 293         }
 294     }
 295
 296   err = (*digest_stream) (fp, bin_result);
 297   if (err)
 298     {
 299       error (0, errno, "%s", filename);
 300       if (fp != stdin)
 301         fclose (fp);
 302       return 1;
 303     }
 304
 305   if (fp != stdin && fclose (fp) == EOF)
 306     {
 307       error (0, errno, "%s", filename);
 308       return 1;
 309     }
 310
 311   return 0;
 312 }
 313
 314 static int
 315 digest_check (const char *checkfile_name, int (*digest_stream)(FILE *, void *))
 316 {
 317   FILE *checkfile_stream;
 318   int n_properly_formated_lines = 0;
 319   int n_mismatched_checksums = 0;
 320   int n_open_or_read_failures = 0;
 321   unsigned char bin_buffer[MAX_DIGEST_BIN_BYTES];
 322   size_t line_number;
 323   char *line;
 324   size_t line_chars_allocated;
 325
 326   if (STREQ (checkfile_name, "-"))
 327     {
 328       have_read_stdin = 1;
 329       checkfile_name = _("standard input");
 330       checkfile_stream = stdin;
 331     }
 332   else
 333     {
 334       checkfile_stream = fopen (checkfile_name, "r");
 335       if (checkfile_stream == NULL)
 336         {
 337           error (0, errno, "%s", checkfile_name);
 338           return 1;
 339         }
 340     }
 341
 342   SET_MODE (fileno (checkfile_stream), O_TEXT);
 343   line_number = 0;
 344   line = NULL;
 345   line_chars_allocated = 0;
 346   do
 347     {
 348       char *filename;
 349       int binary;
 350       unsigned char *hex_digest;
 351       int err;
 352       int line_length;
 353
 354       ++line_number;
 355
 356       line_length = getline (&line, &line_chars_allocated, checkfile_stream);
 357       if (line_length <= 0)
 358         break;
 359
 360       /* Ignore comment lines, which begin with a '#' character.  */
 361       if (line[0] == '#')
 362         continue;
 363
 364       /* Remove any trailing newline.  */
 365       if (line[line_length - 1] == '\n')
 366         line[--line_length] = '\0';
 367
 368       err = split_3 (line, line_length, &hex_digest, &binary, &filename);
 369       if (err || !hex_digits (hex_digest))
 370         {
 371           if (warn)
 372             {
 373               error (0, 0,
 374                      _("%s: %lu: improperly formatted %s checksum line"),
 375                      checkfile_name, (unsigned long) line_number,
 376                      DIGEST_TYPE_STRING (algorithm));
 377             }
 378         }
 379       else
 380         {
 381           static const char bin2hex[] = { '0', '1', '2', '3',
 382                                           '4', '5', '6', '7',
 383                                           '8', '9', 'a', 'b',
 384                                           'c', 'd', 'e', 'f' };
 385           int fail;
 386
 387           ++n_properly_formated_lines;
 388
 389           fail = digest_file (filename, binary, bin_buffer, digest_stream);
 390
 391           if (fail)
 392             {
 393               ++n_open_or_read_failures;
 394               if (!status_only)
 395                 {
 396                   printf (_("%s: FAILED open or read\n"), filename);
 397                   fflush (stdout);
 398                 }
 399             }
 400           else
 401             {
 402               size_t digest_bin_bytes = digest_hex_bytes / 2;
 403               size_t cnt;
 404               /* Compare generated binary number with text representation
 405                  in check file.  Ignore case of hex digits.  */
 406               for (cnt = 0; cnt < digest_bin_bytes; ++cnt)
 407                 {
 408                   if (TOLOWER (hex_digest[2 * cnt]) != bin2hex[bin_buffer[cnt] >> 4]
 409                       || (TOLOWER (hex_digest[2 * cnt + 1])
 410                           != (bin2hex[bin_buffer[cnt] & 0xf])))
 411                     break;
 412                 }
 413               if (cnt != digest_bin_bytes)
 414                 ++n_mismatched_checksums;
 415
 416               if (!status_only)
 417                 {
 418                   printf ("%s: %s\n", filename,
 419                           (cnt != digest_bin_bytes ? _("FAILED") : _("OK")));
 420                   fflush (stdout);
 421                 }
 422             }
 423         }
 424     }
 425   while (!feof (checkfile_stream) && !ferror (checkfile_stream));
 426
 427   if (line)
 428     free (line);
 429
 430   if (ferror (checkfile_stream))
 431     {
 432       error (0, 0, _("%s: read error"), checkfile_name);
 433       return 1;
 434     }
 435
 436   if (checkfile_stream != stdin && fclose (checkfile_stream) == EOF)
 437     {
 438       error (0, errno, "%s", checkfile_name);
 439       return 1;
 440     }
 441
 442   if (n_properly_formated_lines == 0)
 443     {
 444       /* Warn if no tests are found.  */
 445       error (0, 0, _("%s: no properly formatted %s checksum lines found"),
 446              checkfile_name, DIGEST_TYPE_STRING (algorithm));
 447     }
 448   else
 449     {
 450       if (!status_only)
 451         {
 452           int n_computed_checkums = (n_properly_formated_lines
 453                                      - n_open_or_read_failures);
 454
 455           if (n_open_or_read_failures > 0)
 456             {
 457               error (0, 0,
 458                      _("WARNING: %d of %d listed %s could not be read"),
 459                      n_open_or_read_failures, n_properly_formated_lines,
 460                      (n_properly_formated_lines == 1
 461                       ? _("file") : _("files")));
 462             }
 463
 464           if (n_mismatched_checksums > 0)
 465             {
 466               error (0, 0,
 467                    _("WARNING: %d of %d computed %s did NOT match"),
 468                      n_mismatched_checksums, n_computed_checkums,
 469                      (n_computed_checkums == 1
 470                       ? _("checksum") : _("checksums")));
 471             }
 472         }
 473     }
 474
 475   return ((n_properly_formated_lines > 0 && n_mismatched_checksums == 0
 476            && n_open_or_read_failures == 0) ? 0 : 1);
 477 }
 478
 479 int
 480 main (int argc, char **argv)
 481 {
 482   unsigned char bin_buffer[MAX_DIGEST_BIN_BYTES];
 483   int do_check = 0;
 484   int opt;
 485   char **string = NULL;
 486   size_t n_strings = 0;
 487   size_t err = 0;
 488   int file_type_specified = 0;
 489
 490 #if O_BINARY
 491   /* Binary is default on MSDOS, so the actual file contents
 492      are used in computation.  */
 493   int binary = 1;
 494 #else
 495   /* Text is default of the Plumb/Lankester format.  */
 496   int binary = 0;
 497 #endif
 498
 499   /* Setting values of global variables.  */
 500   program_name = argv[0];
 501   setlocale (LC_ALL, "");
 502   bindtextdomain (PACKAGE, LOCALEDIR);
 503   textdomain (PACKAGE);
 504
 505   atexit (close_stdout);
 506
 507   while ((opt = getopt_long (argc, argv, "bctw", long_options, NULL)) != -1)
 508     switch (opt)
 509       {
 510       case 0:                   /* long option */
 511         break;
 512       case 1: /* --string */
 513         {
 514           if (string == NULL)
 515             string = (char **) xmalloc ((argc - 1) * sizeof (char *));
 516
 517           if (optarg == NULL)
 518             optarg = "";
 519           string[n_strings++] = optarg;
 520         }
 521         break;
 522       case 'b':
 523         file_type_specified = 1;
 524         binary = 1;
 525         break;
 526       case 'c':
 527         do_check = 1;
 528         break;
 529       case 2:
 530         status_only = 1;
 531         warn = 0;
 532         break;
 533       case 't':
 534         file_type_specified = 1;
 535         binary = 0;
 536         break;
 537       case 'w':
 538         status_only = 0;
 539         warn = 1;
 540         break;
 541       case_GETOPT_HELP_CHAR;
 542       case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 543       default:
 544         usage (EXIT_FAILURE);
 545       }
 546
 547   min_digest_line_length = MIN_DIGEST_LINE_LENGTH (algorithm);
 548   digest_hex_bytes = DIGEST_HEX_BYTES (algorithm);
 549
 550   if (file_type_specified && do_check)
 551     {
 552       error (0, 0, _("the --binary and --text options are meaningless when \
 553 verifying checksums"));
 554       usage (EXIT_FAILURE);
 555     }
 556
 557   if (n_strings > 0 && do_check)
 558     {
 559       error (0, 0,
 560              _("the --string and --check options are mutually exclusive"));
 561       usage (EXIT_FAILURE);
 562     }
 563
 564   if (status_only && !do_check)
 565     {
 566       error (0, 0,
 567        _("the --status option is meaningful only when verifying checksums"));
 568       usage (EXIT_FAILURE);
 569     }
 570
 571   if (warn && !do_check)
 572     {
 573       error (0, 0,
 574        _("the --warn option is meaningful only when verifying checksums"));
 575       usage (EXIT_FAILURE);
 576     }
 577
 578   if (n_strings > 0)
 579     {
 580       size_t i;
 581
 582       if (optind < argc)
 583         {
 584           error (0, 0, _("no files may be specified when using --string"));
 585           usage (EXIT_FAILURE);
 586         }
 587       for (i = 0; i < n_strings; ++i)
 588         {
 589           size_t cnt;
 590           if (algorithm == ALG_MD5)
 591             md5_buffer (string[i], strlen (string[i]), bin_buffer);
 592           else
 593             sha_buffer (string[i], strlen (string[i]), bin_buffer);
 594
 595           for (cnt = 0; cnt < (digest_hex_bytes / 2); ++cnt)
 596             printf ("%02x", bin_buffer[cnt]);
 597
 598           printf ("  \"%s\"\n", string[i]);
 599         }
 600     }
 601   else if (do_check)
 602     {
 603       if (optind + 1 < argc)
 604         {
 605           error (0, 0,
 606                  _("only one argument may be specified when using --check"));
 607           usage (EXIT_FAILURE);
 608         }
 609
 610       err = digest_check ((optind == argc) ? "-" : argv[optind],
 611                           DIGEST_STREAM (algorithm));
 612     }
 613   else
 614     {
 615       if (optind == argc)
 616         argv[argc++] = "-";
 617
 618       for (; optind < argc; ++optind)
 619         {
 620           int fail;
 621           char *file = argv[optind];
 622
 623           fail = digest_file (file, binary, bin_buffer,
 624                               DIGEST_STREAM (algorithm));
 625           err |= fail;
 626           if (!fail)
 627             {
 628               size_t i;
 629
 630               /* Output a leading backslash if the file name contains
 631                  a newline or backslash.  */
 632               if (strchr (file, '\n') || strchr (file, '\\'))
 633                 putchar ('\\');
 634
 635               for (i = 0; i < (digest_hex_bytes / 2); ++i)
 636                 printf ("%02x", bin_buffer[i]);
 637
 638               putchar (' ');
 639               if (binary)
 640                 putchar ('*');
 641               else
 642                 putchar (' ');
 643
 644               /* Translate each NEWLINE byte to the string, "\\n",
 645                  and each backslash to "\\\\".  */
 646               for (i = 0; i < strlen (file); ++i)
 647                 {
 648                   switch (file[i])
 649                     {
 650                     case '\n':
 651                       fputs ("\\n", stdout);
 652                       break;
 653
 654                     case '\\':
 655                       fputs ("\\\\", stdout);
 656                       break;
 657
 658                     default:
 659                       putchar (file[i]);
 660                       break;
 661                     }
 662                 }
 663               putchar ('\n');
 664             }
 665         }
 666     }
 667
 668   if (have_read_stdin && fclose (stdin) == EOF)
 669     error (EXIT_FAILURE, errno, _("standard input"));
 670
 671   exit (err == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
 672 }