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