apps/dgst.c

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