apps/dgst.c

   1 /*
   2  * Copyright 1995-2019 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <stdio.h>
  11 #include <string.h>
  12 #include <stdlib.h>
  13 #include "apps.h"
  14 #include "progs.h"
  15 #include <openssl/bio.h>
  16 #include <openssl/err.h>
  17 #include <openssl/evp.h>
  18 #include <openssl/objects.h>
  19 #include <openssl/x509.h>
  20 #include <openssl/pem.h>
  21 #include <openssl/hmac.h>
  22 #include <ctype.h>
  23
  24 #undef BUFSIZE
  25 #define BUFSIZE 1024*8
  26
  27 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
  28           EVP_PKEY *key, unsigned char *sigin, int siglen,
  29           const char *sig_name, const char *md_name,
  30           const char *file);
  31 static void show_digests(const OBJ_NAME *name, void *bio_);
  32
  33 struct doall_dgst_digests {
  34     BIO *bio;
  35     int n;
  36 };
  37
  38 typedef enum OPTION_choice {
  39     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP, OPT_LIST,
  40     OPT_C, OPT_R, OPT_OUT, OPT_SIGN, OPT_PASSIN, OPT_VERIFY,
  41     OPT_PRVERIFY, OPT_SIGNATURE, OPT_KEYFORM, OPT_ENGINE, OPT_ENGINE_IMPL,
  42     OPT_HEX, OPT_BINARY, OPT_DEBUG, OPT_FIPS_FINGERPRINT,
  43     OPT_HMAC, OPT_MAC, OPT_SIGOPT, OPT_MACOPT,
  44     OPT_DIGEST,
  45     OPT_R_ENUM
  46 } OPTION_CHOICE;
  47
  48 const OPTIONS dgst_options[] = {
  49     {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
  50     {OPT_HELP_STR, 1, '-',
  51         "  file... files to digest (default is stdin)\n"},
  52     OPT_SECTION("General"),
  53     {"help", OPT_HELP, '-', "Display this summary"},
  54     {"list", OPT_LIST, '-', "List digests"},
  55 #ifndef OPENSSL_NO_ENGINE
  56     {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
  57     {"engine_impl", OPT_ENGINE_IMPL, '-',
  58      "Also use engine given by -engine for digest operations"},
  59 #endif
  60     {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
  61
  62     OPT_SECTION("Output"),
  63     {"c", OPT_C, '-', "Print the digest with separating colons"},
  64     {"r", OPT_R, '-', "Print the digest in coreutils format"},
  65     {"out", OPT_OUT, '>', "Output to filename rather than stdout"},
  66     {"keyform", OPT_KEYFORM, 'f', "Key file format (PEM or ENGINE)"},
  67     {"hex", OPT_HEX, '-', "Print as hex dump"},
  68     {"binary", OPT_BINARY, '-', "Print in binary form"},
  69     {"d", OPT_DEBUG, '-', "Print debug info"},
  70     {"debug", OPT_DEBUG, '-', "Print debug info"},
  71
  72     OPT_SECTION("Signing"),
  73     {"sign", OPT_SIGN, 's', "Sign digest using private key"},
  74     {"verify", OPT_VERIFY, 's', "Verify a signature using public key"},
  75     {"prverify", OPT_PRVERIFY, 's', "Verify a signature using private key"},
  76     {"sigopt", OPT_SIGOPT, 's', "Signature parameter in n:v form"},
  77     {"signature", OPT_SIGNATURE, '<', "File with signature to verify"},
  78     {"hmac", OPT_HMAC, 's', "Create hashed MAC with key"},
  79     {"mac", OPT_MAC, 's', "Create MAC (not necessarily HMAC)"},
  80     {"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form or key"},
  81     {"", OPT_DIGEST, '-', "Any supported digest"},
  82     {"fips-fingerprint", OPT_FIPS_FINGERPRINT, '-',
  83      "Compute HMAC with the key used in OpenSSL-FIPS fingerprint"},
  84
  85     OPT_R_OPTIONS,
  86     {NULL}
  87 };
  88
  89 int dgst_main(int argc, char **argv)
  90 {
  91     BIO *in = NULL, *inp, *bmd = NULL, *out = NULL;
  92     ENGINE *e = NULL, *impl = NULL;
  93     EVP_PKEY *sigkey = NULL;
  94     STACK_OF(OPENSSL_STRING) *sigopts = NULL, *macopts = NULL;
  95     char *hmac_key = NULL;
  96     char *mac_name = NULL;
  97     char *passinarg = NULL, *passin = NULL;
  98     const EVP_MD *md = NULL, *m;
  99     const char *outfile = NULL, *keyfile = NULL, *prog = NULL;
 100     const char *sigfile = NULL;
 101     const char *md_name = NULL;
 102     OPTION_CHOICE o;
 103     int separator = 0, debug = 0, keyform = FORMAT_PEM, siglen = 0;
 104     int i, ret = 1, out_bin = -1, want_pub = 0, do_verify = 0;
 105     unsigned char *buf = NULL, *sigbuf = NULL;
 106     int engine_impl = 0;
 107     struct doall_dgst_digests dec;
 108
 109     prog = opt_progname(argv[0]);
 110     buf = app_malloc(BUFSIZE, "I/O buffer");
 111     md = EVP_get_digestbyname(prog);
 112
 113     prog = opt_init(argc, argv, dgst_options);
 114     while ((o = opt_next()) != OPT_EOF) {
 115         switch (o) {
 116         case OPT_EOF:
 117         case OPT_ERR:
 118  opthelp:
 119             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 120             goto end;
 121         case OPT_HELP:
 122             opt_help(dgst_options);
 123             ret = 0;
 124             goto end;
 125         case OPT_LIST:
 126             BIO_printf(bio_out, "Supported digests:\n");
 127             dec.bio = bio_out;
 128             dec.n = 0;
 129             OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
 130                                    show_digests, &dec);
 131             BIO_printf(bio_out, "\n");
 132             ret = 0;
 133             goto end;
 134         case OPT_C:
 135             separator = 1;
 136             break;
 137         case OPT_R:
 138             separator = 2;
 139             break;
 140         case OPT_R_CASES:
 141             if (!opt_rand(o))
 142                 goto end;
 143             break;
 144         case OPT_OUT:
 145             outfile = opt_arg();
 146             break;
 147         case OPT_SIGN:
 148             keyfile = opt_arg();
 149             break;
 150         case OPT_PASSIN:
 151             passinarg = opt_arg();
 152             break;
 153         case OPT_VERIFY:
 154             keyfile = opt_arg();
 155             want_pub = do_verify = 1;
 156             break;
 157         case OPT_PRVERIFY:
 158             keyfile = opt_arg();
 159             do_verify = 1;
 160             break;
 161         case OPT_SIGNATURE:
 162             sigfile = opt_arg();
 163             break;
 164         case OPT_KEYFORM:
 165             if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
 166                 goto opthelp;
 167             break;
 168         case OPT_ENGINE:
 169             e = setup_engine(opt_arg(), 0);
 170             break;
 171         case OPT_ENGINE_IMPL:
 172             engine_impl = 1;
 173             break;
 174         case OPT_HEX:
 175             out_bin = 0;
 176             break;
 177         case OPT_BINARY:
 178             out_bin = 1;
 179             break;
 180         case OPT_DEBUG:
 181             debug = 1;
 182             break;
 183         case OPT_FIPS_FINGERPRINT:
 184             hmac_key = "etaonrishdlcupfm";
 185             break;
 186         case OPT_HMAC:
 187             hmac_key = opt_arg();
 188             break;
 189         case OPT_MAC:
 190             mac_name = opt_arg();
 191             break;
 192         case OPT_SIGOPT:
 193             if (!sigopts)
 194                 sigopts = sk_OPENSSL_STRING_new_null();
 195             if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
 196                 goto opthelp;
 197             break;
 198         case OPT_MACOPT:
 199             if (!macopts)
 200                 macopts = sk_OPENSSL_STRING_new_null();
 201             if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
 202                 goto opthelp;
 203             break;
 204         case OPT_DIGEST:
 205             if (!opt_md(opt_unknown(), &m))
 206                 goto opthelp;
 207             md = m;
 208             break;
 209         }
 210     }
 211     argc = opt_num_rest();
 212     argv = opt_rest();
 213     if (keyfile != NULL && argc > 1) {
 214         BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
 215         goto end;
 216     }
 217
 218     if (do_verify && sigfile == NULL) {
 219         BIO_printf(bio_err,
 220                    "No signature to verify: use the -signature option\n");
 221         goto end;
 222     }
 223     if (engine_impl)
 224         impl = e;
 225
 226     in = BIO_new(BIO_s_file());
 227     bmd = BIO_new(BIO_f_md());
 228     if ((in == NULL) || (bmd == NULL)) {
 229         ERR_print_errors(bio_err);
 230         goto end;
 231     }
 232
 233     if (debug) {
 234         BIO_set_callback(in, BIO_debug_callback);
 235         /* needed for windows 3.1 */
 236         BIO_set_callback_arg(in, (char *)bio_err);
 237     }
 238
 239     if (!app_passwd(passinarg, NULL, &passin, NULL)) {
 240         BIO_printf(bio_err, "Error getting password\n");
 241         goto end;
 242     }
 243
 244     if (out_bin == -1) {
 245         if (keyfile != NULL)
 246             out_bin = 1;
 247         else
 248             out_bin = 0;
 249     }
 250
 251     out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
 252     if (out == NULL)
 253         goto end;
 254
 255     if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
 256         BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
 257         goto end;
 258     }
 259
 260     if (keyfile != NULL) {
 261         int type;
 262
 263         if (want_pub)
 264             sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
 265         else
 266             sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
 267         if (sigkey == NULL) {
 268             /*
 269              * load_[pub]key() has already printed an appropriate message
 270              */
 271             goto end;
 272         }
 273         type = EVP_PKEY_id(sigkey);
 274         if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
 275             /*
 276              * We implement PureEdDSA for these which doesn't have a separate
 277              * digest, and only supports one shot.
 278              */
 279             BIO_printf(bio_err, "Key type not supported for this operation\n");
 280             goto end;
 281         }
 282     }
 283
 284     if (mac_name != NULL) {
 285         EVP_PKEY_CTX *mac_ctx = NULL;
 286         int r = 0;
 287         if (!init_gen_str(&mac_ctx, mac_name, impl, 0))
 288             goto mac_end;
 289         if (macopts != NULL) {
 290             char *macopt;
 291             for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
 292                 macopt = sk_OPENSSL_STRING_value(macopts, i);
 293                 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
 294                     BIO_printf(bio_err,
 295                                "MAC parameter error \"%s\"\n", macopt);
 296                     ERR_print_errors(bio_err);
 297                     goto mac_end;
 298                 }
 299             }
 300         }
 301         if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
 302             BIO_puts(bio_err, "Error generating key\n");
 303             ERR_print_errors(bio_err);
 304             goto mac_end;
 305         }
 306         r = 1;
 307  mac_end:
 308         EVP_PKEY_CTX_free(mac_ctx);
 309         if (r == 0)
 310             goto end;
 311     }
 312
 313     if (hmac_key != NULL) {
 314         sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
 315                                               (unsigned char *)hmac_key, -1);
 316         if (sigkey == NULL)
 317             goto end;
 318     }
 319
 320     if (sigkey != NULL) {
 321         EVP_MD_CTX *mctx = NULL;
 322         EVP_PKEY_CTX *pctx = NULL;
 323         int r;
 324         if (!BIO_get_md_ctx(bmd, &mctx)) {
 325             BIO_printf(bio_err, "Error getting context\n");
 326             ERR_print_errors(bio_err);
 327             goto end;
 328         }
 329         if (do_verify)
 330             r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
 331         else
 332             r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
 333         if (!r) {
 334             BIO_printf(bio_err, "Error setting context\n");
 335             ERR_print_errors(bio_err);
 336             goto end;
 337         }
 338         if (sigopts != NULL) {
 339             char *sigopt;
 340             for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
 341                 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
 342                 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
 343                     BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
 344                     ERR_print_errors(bio_err);
 345                     goto end;
 346                 }
 347             }
 348         }
 349     }
 350     /* we use md as a filter, reading from 'in' */
 351     else {
 352         EVP_MD_CTX *mctx = NULL;
 353         if (!BIO_get_md_ctx(bmd, &mctx)) {
 354             BIO_printf(bio_err, "Error getting context\n");
 355             ERR_print_errors(bio_err);
 356             goto end;
 357         }
 358         if (md == NULL)
 359             md = EVP_sha256();
 360         if (!EVP_DigestInit_ex(mctx, md, impl)) {
 361             BIO_printf(bio_err, "Error setting digest\n");
 362             ERR_print_errors(bio_err);
 363             goto end;
 364         }
 365     }
 366
 367     if (sigfile != NULL && sigkey != NULL) {
 368         BIO *sigbio = BIO_new_file(sigfile, "rb");
 369         if (sigbio == NULL) {
 370             BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
 371             ERR_print_errors(bio_err);
 372             goto end;
 373         }
 374         siglen = EVP_PKEY_size(sigkey);
 375         sigbuf = app_malloc(siglen, "signature buffer");
 376         siglen = BIO_read(sigbio, sigbuf, siglen);
 377         BIO_free(sigbio);
 378         if (siglen <= 0) {
 379             BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
 380             ERR_print_errors(bio_err);
 381             goto end;
 382         }
 383     }
 384     inp = BIO_push(bmd, in);
 385
 386     if (md == NULL) {
 387         EVP_MD_CTX *tctx;
 388         BIO_get_md_ctx(bmd, &tctx);
 389         md = EVP_MD_CTX_md(tctx);
 390     }
 391     if (md != NULL)
 392         md_name = EVP_MD_name(md);
 393
 394     if (argc == 0) {
 395         BIO_set_fp(in, stdin, BIO_NOCLOSE);
 396         ret = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
 397                     siglen, NULL, md_name, "stdin");
 398     } else {
 399         const char *sig_name = NULL;
 400         if (!out_bin) {
 401             if (sigkey != NULL) {
 402                 const EVP_PKEY_ASN1_METHOD *ameth;
 403                 ameth = EVP_PKEY_get0_asn1(sigkey);
 404                 if (ameth)
 405                     EVP_PKEY_asn1_get0_info(NULL, NULL,
 406                                             NULL, NULL, &sig_name, ameth);
 407             }
 408         }
 409         ret = 0;
 410         for (i = 0; i < argc; i++) {
 411             int r;
 412             if (BIO_read_filename(in, argv[i]) <= 0) {
 413                 perror(argv[i]);
 414                 ret++;
 415                 continue;
 416             } else {
 417                 r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
 418                           siglen, sig_name, md_name, argv[i]);
 419             }
 420             if (r)
 421                 ret = r;
 422             (void)BIO_reset(bmd);
 423         }
 424     }
 425  end:
 426     OPENSSL_clear_free(buf, BUFSIZE);
 427     BIO_free(in);
 428     OPENSSL_free(passin);
 429     BIO_free_all(out);
 430     EVP_PKEY_free(sigkey);
 431     sk_OPENSSL_STRING_free(sigopts);
 432     sk_OPENSSL_STRING_free(macopts);
 433     OPENSSL_free(sigbuf);
 434     BIO_free(bmd);
 435     release_engine(e);
 436     return ret;
 437 }
 438
 439 static void show_digests(const OBJ_NAME *name, void *arg)
 440 {
 441     struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
 442     const EVP_MD *md = NULL;
 443
 444     /* Filter out signed digests (a.k.a signature algorithms) */
 445     if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
 446         return;
 447
 448     if (!islower((unsigned char)*name->name))
 449         return;
 450
 451     /* Filter out message digests that we cannot use */
 452     md = EVP_get_digestbyname(name->name);
 453     if (md == NULL)
 454         return;
 455
 456     BIO_printf(dec->bio, "-%-25s", name->name);
 457     if (++dec->n == 3) {
 458         BIO_printf(dec->bio, "\n");
 459         dec->n = 0;
 460     } else {
 461         BIO_printf(dec->bio, " ");
 462     }
 463 }
 464
 465 /*
 466  * The newline_escape_filename function performs newline escaping for any
 467  * filename that contains a newline.  This function also takes a pointer
 468  * to backslash. The backslash pointer is a flag to indicating whether a newline
 469  * is present in the filename.  If a newline is present, the backslash flag is
 470  * set and the output format will contain a backslash at the beginning of the
 471  * digest output. This output format is to replicate the output format found
 472  * in the '*sum' checksum programs. This aims to preserve backward
 473  * compatibility.
 474  */
 475 static const char *newline_escape_filename(const char *file, int * backslash)
 476 {
 477     size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
 478     char *file_cpy = NULL;
 479
 480     for (i = 0; i < length; i++)
 481         if (file[i] == '\n')
 482             newline_count++;
 483
 484     mem_len = length + newline_count + 1;
 485     file_cpy = app_malloc(mem_len, file);
 486     i = 0;
 487
 488     while(e < length) {
 489         const char c = file[e];
 490         if (c == '\n') {
 491             file_cpy[i++] = '\\';
 492             file_cpy[i++] = 'n';
 493             *backslash = 1;
 494         } else {
 495             file_cpy[i++] = c;
 496         }
 497         e++;
 498     }
 499     file_cpy[i] = '\0';
 500     return (const char*)file_cpy;
 501 }
 502
 503
 504 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
 505           EVP_PKEY *key, unsigned char *sigin, int siglen,
 506           const char *sig_name, const char *md_name,
 507           const char *file)
 508 {
 509     size_t len = BUFSIZE;
 510     int i, backslash = 0, ret = 1;
 511     unsigned char *sigbuf = NULL;
 512
 513     while (BIO_pending(bp) || !BIO_eof(bp)) {
 514         i = BIO_read(bp, (char *)buf, BUFSIZE);
 515         if (i < 0) {
 516             BIO_printf(bio_err, "Read Error in %s\n", file);
 517             ERR_print_errors(bio_err);
 518             goto end;
 519         }
 520         if (i == 0)
 521             break;
 522     }
 523     if (sigin != NULL) {
 524         EVP_MD_CTX *ctx;
 525         BIO_get_md_ctx(bp, &ctx);
 526         i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
 527         if (i > 0) {
 528             BIO_printf(out, "Verified OK\n");
 529         } else if (i == 0) {
 530             BIO_printf(out, "Verification Failure\n");
 531             goto end;
 532         } else {
 533             BIO_printf(bio_err, "Error Verifying Data\n");
 534             ERR_print_errors(bio_err);
 535             goto end;
 536         }
 537         ret = 0;
 538         goto end;
 539     }
 540     if (key != NULL) {
 541         EVP_MD_CTX *ctx;
 542         int pkey_len;
 543         BIO_get_md_ctx(bp, &ctx);
 544         pkey_len = EVP_PKEY_size(key);
 545         if (pkey_len > BUFSIZE) {
 546             len = pkey_len;
 547             sigbuf = app_malloc(len, "Signature buffer");
 548             buf = sigbuf;
 549         }
 550         if (!EVP_DigestSignFinal(ctx, buf, &len)) {
 551             BIO_printf(bio_err, "Error Signing Data\n");
 552             ERR_print_errors(bio_err);
 553             goto end;
 554         }
 555     } else {
 556         len = BIO_gets(bp, (char *)buf, BUFSIZE);
 557         if ((int)len < 0) {
 558             ERR_print_errors(bio_err);
 559             goto end;
 560         }
 561     }
 562
 563     if (binout) {
 564         BIO_write(out, buf, len);
 565     } else if (sep == 2) {
 566         file = newline_escape_filename(file, &backslash);
 567
 568         if (backslash == 1)
 569             BIO_puts(out, "\\");
 570
 571         for (i = 0; i < (int)len; i++)
 572             BIO_printf(out, "%02x", buf[i]);
 573
 574         BIO_printf(out, " *%s\n", file);
 575         OPENSSL_free((char *)file);
 576     } else {
 577         if (sig_name != NULL) {
 578             BIO_puts(out, sig_name);
 579             if (md_name != NULL)
 580                 BIO_printf(out, "-%s", md_name);
 581             BIO_printf(out, "(%s)= ", file);
 582         } else if (md_name != NULL) {
 583             BIO_printf(out, "%s(%s)= ", md_name, file);
 584         } else {
 585             BIO_printf(out, "(%s)= ", file);
 586         }
 587         for (i = 0; i < (int)len; i++) {
 588             if (sep && (i != 0))
 589                 BIO_printf(out, ":");
 590             BIO_printf(out, "%02x", buf[i]);
 591         }
 592         BIO_printf(out, "\n");
 593     }
 594
 595     ret = 0;
 596  end:
 597     if (sigbuf != NULL)
 598         OPENSSL_clear_free(sigbuf, len);
 599
 600     return ret;
 601 }