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