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