apps/dgst.c

   1 /*
   2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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 <openssl/bio.h>
  15 #include <openssl/err.h>
  16 #include <openssl/evp.h>
  17 #include <openssl/objects.h>
  18 #include <openssl/x509.h>
  19 #include <openssl/pem.h>
  20 #include <openssl/hmac.h>
  21
  22 #undef BUFSIZE
  23 #define BUFSIZE 1024*8
  24
  25 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
  26           EVP_PKEY *key, unsigned char *sigin, int siglen,
  27           const char *sig_name, const char *md_name,
  28           const char *file);
  29
  30 typedef enum OPTION_choice {
  31     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
  32     OPT_C, OPT_R, OPT_OUT, OPT_SIGN, OPT_PASSIN, OPT_VERIFY,
  33     OPT_PRVERIFY, OPT_SIGNATURE, OPT_KEYFORM, OPT_ENGINE, OPT_ENGINE_IMPL,
  34     OPT_HEX, OPT_BINARY, OPT_DEBUG, OPT_FIPS_FINGERPRINT,
  35     OPT_HMAC, OPT_MAC, OPT_SIGOPT, OPT_MACOPT,
  36     OPT_DIGEST,
  37     OPT_R_ENUM
  38 } OPTION_CHOICE;
  39
  40 const OPTIONS dgst_options[] = {
  41     {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
  42     {OPT_HELP_STR, 1, '-',
  43         "  file... files to digest (default is stdin)\n"},
  44     {"help", OPT_HELP, '-', "Display this summary"},
  45     {"c", OPT_C, '-', "Print the digest with separating colons"},
  46     {"r", OPT_R, '-', "Print the digest in coreutils format"},
  47     {"out", OPT_OUT, '>', "Output to filename rather than stdout"},
  48     {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
  49     {"sign", OPT_SIGN, 's', "Sign digest using private key"},
  50     {"verify", OPT_VERIFY, 's',
  51      "Verify a signature using public key"},
  52     {"prverify", OPT_PRVERIFY, 's',
  53      "Verify a signature using private key"},
  54     {"signature", OPT_SIGNATURE, '<', "File with signature to verify"},
  55     {"keyform", OPT_KEYFORM, 'f', "Key file format (PEM or ENGINE)"},
  56     {"hex", OPT_HEX, '-', "Print as hex dump"},
  57     {"binary", OPT_BINARY, '-', "Print in binary form"},
  58     {"d", OPT_DEBUG, '-', "Print debug info"},
  59     {"debug", OPT_DEBUG, '-', "Print debug info"},
  60     {"fips-fingerprint", OPT_FIPS_FINGERPRINT, '-',
  61      "Compute HMAC with the key used in OpenSSL-FIPS fingerprint"},
  62     {"hmac", OPT_HMAC, 's', "Create hashed MAC with key"},
  63     {"mac", OPT_MAC, 's', "Create MAC (not necessarily HMAC)"},
  64     {"sigopt", OPT_SIGOPT, 's', "Signature parameter in n:v form"},
  65     {"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form or key"},
  66     {"", OPT_DIGEST, '-', "Any supported digest"},
  67     OPT_R_OPTIONS,
  68 #ifndef OPENSSL_NO_ENGINE
  69     {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
  70     {"engine_impl", OPT_ENGINE_IMPL, '-',
  71      "Also use engine given by -engine for digest operations"},
  72 #endif
  73     {NULL}
  74 };
  75
  76 int dgst_main(int argc, char **argv)
  77 {
  78     BIO *in = NULL, *inp, *bmd = NULL, *out = NULL;
  79     ENGINE *e = NULL, *impl = NULL;
  80     EVP_PKEY *sigkey = NULL;
  81     STACK_OF(OPENSSL_STRING) *sigopts = NULL, *macopts = NULL;
  82     char *hmac_key = NULL;
  83     char *mac_name = NULL;
  84     char *passinarg = NULL, *passin = NULL;
  85     const EVP_MD *md = NULL, *m;
  86     const char *outfile = NULL, *keyfile = NULL, *prog = NULL;
  87     const char *sigfile = NULL;
  88     OPTION_CHOICE o;
  89     int separator = 0, debug = 0, keyform = FORMAT_PEM, siglen = 0;
  90     int i, ret = 1, out_bin = -1, want_pub = 0, do_verify = 0;
  91     unsigned char *buf = NULL, *sigbuf = NULL;
  92     int engine_impl = 0;
  93
  94     prog = opt_progname(argv[0]);
  95     buf = app_malloc(BUFSIZE, "I/O buffer");
  96     md = EVP_get_digestbyname(prog);
  97
  98     prog = opt_init(argc, argv, dgst_options);
  99     while ((o = opt_next()) != OPT_EOF) {
 100         switch (o) {
 101         case OPT_EOF:
 102         case OPT_ERR:
 103  opthelp:
 104             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 105             goto end;
 106         case OPT_HELP:
 107             opt_help(dgst_options);
 108             ret = 0;
 109             goto end;
 110         case OPT_C:
 111             separator = 1;
 112             break;
 113         case OPT_R:
 114             separator = 2;
 115             break;
 116         case OPT_R_CASES:
 117             if (!opt_rand(o))
 118                 goto end;
 119             break;
 120         case OPT_OUT:
 121             outfile = opt_arg();
 122             break;
 123         case OPT_SIGN:
 124             keyfile = opt_arg();
 125             break;
 126         case OPT_PASSIN:
 127             passinarg = opt_arg();
 128             break;
 129         case OPT_VERIFY:
 130             keyfile = opt_arg();
 131             want_pub = do_verify = 1;
 132             break;
 133         case OPT_PRVERIFY:
 134             keyfile = opt_arg();
 135             do_verify = 1;
 136             break;
 137         case OPT_SIGNATURE:
 138             sigfile = opt_arg();
 139             break;
 140         case OPT_KEYFORM:
 141             if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
 142                 goto opthelp;
 143             break;
 144         case OPT_ENGINE:
 145             e = setup_engine(opt_arg(), 0);
 146             break;
 147         case OPT_ENGINE_IMPL:
 148             engine_impl = 1;
 149             break;
 150         case OPT_HEX:
 151             out_bin = 0;
 152             break;
 153         case OPT_BINARY:
 154             out_bin = 1;
 155             break;
 156         case OPT_DEBUG:
 157             debug = 1;
 158             break;
 159         case OPT_FIPS_FINGERPRINT:
 160             hmac_key = "etaonrishdlcupfm";
 161             break;
 162         case OPT_HMAC:
 163             hmac_key = opt_arg();
 164             break;
 165         case OPT_MAC:
 166             mac_name = opt_arg();
 167             break;
 168         case OPT_SIGOPT:
 169             if (!sigopts)
 170                 sigopts = sk_OPENSSL_STRING_new_null();
 171             if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
 172                 goto opthelp;
 173             break;
 174         case OPT_MACOPT:
 175             if (!macopts)
 176                 macopts = sk_OPENSSL_STRING_new_null();
 177             if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
 178                 goto opthelp;
 179             break;
 180         case OPT_DIGEST:
 181             if (!opt_md(opt_unknown(), &m))
 182                 goto opthelp;
 183             md = m;
 184             break;
 185         }
 186     }
 187     argc = opt_num_rest();
 188     argv = opt_rest();
 189     if (keyfile != NULL && argc > 1) {
 190         BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
 191         goto end;
 192     }
 193
 194     if (do_verify && sigfile == NULL) {
 195         BIO_printf(bio_err,
 196                    "No signature to verify: use the -signature option\n");
 197         goto end;
 198     }
 199     if (engine_impl)
 200         impl = e;
 201
 202     in = BIO_new(BIO_s_file());
 203     bmd = BIO_new(BIO_f_md());
 204     if ((in == NULL) || (bmd == NULL)) {
 205         ERR_print_errors(bio_err);
 206         goto end;
 207     }
 208
 209     if (debug) {
 210         BIO_set_callback(in, BIO_debug_callback);
 211         /* needed for windows 3.1 */
 212         BIO_set_callback_arg(in, (char *)bio_err);
 213     }
 214
 215     if (!app_passwd(passinarg, NULL, &passin, NULL)) {
 216         BIO_printf(bio_err, "Error getting password\n");
 217         goto end;
 218     }
 219
 220     if (out_bin == -1) {
 221         if (keyfile != NULL)
 222             out_bin = 1;
 223         else
 224             out_bin = 0;
 225     }
 226
 227     out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
 228     if (out == NULL)
 229         goto end;
 230
 231     if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
 232         BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
 233         goto end;
 234     }
 235
 236     if (keyfile != NULL) {
 237         if (want_pub)
 238             sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
 239         else
 240             sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
 241         if (sigkey == NULL) {
 242             /*
 243              * load_[pub]key() has already printed an appropriate message
 244              */
 245             goto end;
 246         }
 247     }
 248
 249     if (mac_name != NULL) {
 250         EVP_PKEY_CTX *mac_ctx = NULL;
 251         int r = 0;
 252         if (!init_gen_str(&mac_ctx, mac_name, impl, 0))
 253             goto mac_end;
 254         if (macopts != NULL) {
 255             char *macopt;
 256             for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
 257                 macopt = sk_OPENSSL_STRING_value(macopts, i);
 258                 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
 259                     BIO_printf(bio_err,
 260                                "MAC parameter error \"%s\"\n", macopt);
 261                     ERR_print_errors(bio_err);
 262                     goto mac_end;
 263                 }
 264             }
 265         }
 266         if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
 267             BIO_puts(bio_err, "Error generating key\n");
 268             ERR_print_errors(bio_err);
 269             goto mac_end;
 270         }
 271         r = 1;
 272  mac_end:
 273         EVP_PKEY_CTX_free(mac_ctx);
 274         if (r == 0)
 275             goto end;
 276     }
 277
 278     if (hmac_key != NULL) {
 279         sigkey = EVP_PKEY_new_mac_key(EVP_PKEY_HMAC, impl,
 280                                       (unsigned char *)hmac_key, -1);
 281         if (sigkey == NULL)
 282             goto end;
 283     }
 284
 285     if (sigkey != NULL) {
 286         EVP_MD_CTX *mctx = NULL;
 287         EVP_PKEY_CTX *pctx = NULL;
 288         int r;
 289         if (!BIO_get_md_ctx(bmd, &mctx)) {
 290             BIO_printf(bio_err, "Error getting context\n");
 291             ERR_print_errors(bio_err);
 292             goto end;
 293         }
 294         if (do_verify)
 295             r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
 296         else
 297             r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
 298         if (!r) {
 299             BIO_printf(bio_err, "Error setting context\n");
 300             ERR_print_errors(bio_err);
 301             goto end;
 302         }
 303         if (sigopts != NULL) {
 304             char *sigopt;
 305             for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
 306                 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
 307                 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
 308                     BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
 309                     ERR_print_errors(bio_err);
 310                     goto end;
 311                 }
 312             }
 313         }
 314     }
 315     /* we use md as a filter, reading from 'in' */
 316     else {
 317         EVP_MD_CTX *mctx = NULL;
 318         if (!BIO_get_md_ctx(bmd, &mctx)) {
 319             BIO_printf(bio_err, "Error getting context\n");
 320             ERR_print_errors(bio_err);
 321             goto end;
 322         }
 323         if (md == NULL)
 324             md = EVP_sha256();
 325         if (!EVP_DigestInit_ex(mctx, md, impl)) {
 326             BIO_printf(bio_err, "Error setting digest\n");
 327             ERR_print_errors(bio_err);
 328             goto end;
 329         }
 330     }
 331
 332     if (sigfile != NULL && sigkey != NULL) {
 333         BIO *sigbio = BIO_new_file(sigfile, "rb");
 334         if (sigbio == NULL) {
 335             BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
 336             ERR_print_errors(bio_err);
 337             goto end;
 338         }
 339         siglen = EVP_PKEY_size(sigkey);
 340         sigbuf = app_malloc(siglen, "signature buffer");
 341         siglen = BIO_read(sigbio, sigbuf, siglen);
 342         BIO_free(sigbio);
 343         if (siglen <= 0) {
 344             BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
 345             ERR_print_errors(bio_err);
 346             goto end;
 347         }
 348     }
 349     inp = BIO_push(bmd, in);
 350
 351     if (md == NULL) {
 352         EVP_MD_CTX *tctx;
 353         BIO_get_md_ctx(bmd, &tctx);
 354         md = EVP_MD_CTX_md(tctx);
 355     }
 356
 357     if (argc == 0) {
 358         BIO_set_fp(in, stdin, BIO_NOCLOSE);
 359         ret = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
 360                     siglen, NULL, NULL, "stdin");
 361     } else {
 362         const char *md_name = NULL, *sig_name = NULL;
 363         if (!out_bin) {
 364             if (sigkey != NULL) {
 365                 const EVP_PKEY_ASN1_METHOD *ameth;
 366                 ameth = EVP_PKEY_get0_asn1(sigkey);
 367                 if (ameth)
 368                     EVP_PKEY_asn1_get0_info(NULL, NULL,
 369                                             NULL, NULL, &sig_name, ameth);
 370             }
 371             if (md != NULL)
 372                 md_name = EVP_MD_name(md);
 373         }
 374         ret = 0;
 375         for (i = 0; i < argc; i++) {
 376             int r;
 377             if (BIO_read_filename(in, argv[i]) <= 0) {
 378                 perror(argv[i]);
 379                 ret++;
 380                 continue;
 381             } else {
 382                 r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
 383                           siglen, sig_name, md_name, argv[i]);
 384             }
 385             if (r)
 386                 ret = r;
 387             (void)BIO_reset(bmd);
 388         }
 389     }
 390  end:
 391     OPENSSL_clear_free(buf, BUFSIZE);
 392     BIO_free(in);
 393     OPENSSL_free(passin);
 394     BIO_free_all(out);
 395     EVP_PKEY_free(sigkey);
 396     sk_OPENSSL_STRING_free(sigopts);
 397     sk_OPENSSL_STRING_free(macopts);
 398     OPENSSL_free(sigbuf);
 399     BIO_free(bmd);
 400     release_engine(e);
 401     return (ret);
 402 }
 403
 404 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
 405           EVP_PKEY *key, unsigned char *sigin, int siglen,
 406           const char *sig_name, const char *md_name,
 407           const char *file)
 408 {
 409     size_t len;
 410     int i;
 411
 412     for (;;) {
 413         i = BIO_read(bp, (char *)buf, BUFSIZE);
 414         if (i < 0) {
 415             BIO_printf(bio_err, "Read Error in %s\n", file);
 416             ERR_print_errors(bio_err);
 417             return 1;
 418         }
 419         if (i == 0)
 420             break;
 421     }
 422     if (sigin != NULL) {
 423         EVP_MD_CTX *ctx;
 424         BIO_get_md_ctx(bp, &ctx);
 425         i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
 426         if (i > 0) {
 427             BIO_printf(out, "Verified OK\n");
 428         } else if (i == 0) {
 429             BIO_printf(out, "Verification Failure\n");
 430             return 1;
 431         } else {
 432             BIO_printf(bio_err, "Error Verifying Data\n");
 433             ERR_print_errors(bio_err);
 434             return 1;
 435         }
 436         return 0;
 437     }
 438     if (key != NULL) {
 439         EVP_MD_CTX *ctx;
 440         BIO_get_md_ctx(bp, &ctx);
 441         len = BUFSIZE;
 442         if (!EVP_DigestSignFinal(ctx, buf, &len)) {
 443             BIO_printf(bio_err, "Error Signing Data\n");
 444             ERR_print_errors(bio_err);
 445             return 1;
 446         }
 447     } else {
 448         len = BIO_gets(bp, (char *)buf, BUFSIZE);
 449         if ((int)len < 0) {
 450             ERR_print_errors(bio_err);
 451             return 1;
 452         }
 453     }
 454
 455     if (binout) {
 456         BIO_write(out, buf, len);
 457     } else if (sep == 2) {
 458         for (i = 0; i < (int)len; i++)
 459             BIO_printf(out, "%02x", buf[i]);
 460         BIO_printf(out, " *%s\n", file);
 461     } else {
 462         if (sig_name != NULL) {
 463             BIO_puts(out, sig_name);
 464             if (md_name != NULL)
 465                 BIO_printf(out, "-%s", md_name);
 466             BIO_printf(out, "(%s)= ", file);
 467         } else if (md_name != NULL) {
 468             BIO_printf(out, "%s(%s)= ", md_name, file);
 469         } else {
 470             BIO_printf(out, "(%s)= ", file);
 471         }
 472         for (i = 0; i < (int)len; i++) {
 473             if (sep && (i != 0))
 474                 BIO_printf(out, ":");
 475             BIO_printf(out, "%02x", buf[i]);
 476         }
 477         BIO_printf(out, "\n");
 478     }
 479     return 0;
 480 }