2 * Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved.
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
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>
25 #define BUFSIZE 1024*8
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,
31 static void show_digests(const OBJ_NAME *name, void *bio_);
33 struct doall_dgst_digests {
38 typedef enum OPTION_choice {
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,
46 OPT_R_ENUM, OPT_PROV_ENUM
49 const OPTIONS dgst_options[] = {
50 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
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"},
60 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
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"},
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"},
90 {"file", 0, 0, "Files to digest (optional; default is stdin)"},
94 int dgst_main(int argc, char **argv)
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;
104 const char *outfile = NULL, *keyfile = NULL, *prog = NULL;
105 const char *sigfile = NULL;
106 const char *md_name = NULL;
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;
111 unsigned char *buf = NULL, *sigbuf = NULL;
113 struct doall_dgst_digests dec;
115 buf = app_malloc(BUFSIZE, "I/O buffer");
116 md = (EVP_MD *)EVP_get_digestbyname(argv[0]);
118 opt_set_unknown_name("digest");
119 prog = opt_init(argc, argv, dgst_options);
120 while ((o = opt_next()) != OPT_EOF) {
125 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
128 opt_help(dgst_options);
132 BIO_printf(bio_out, "Supported digests:\n");
135 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
137 BIO_printf(bio_out, "\n");
157 passinarg = opt_arg();
161 want_pub = do_verify = 1;
171 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
175 e = setup_engine(opt_arg(), 0);
177 case OPT_ENGINE_IMPL:
187 xoflen = atoi(opt_arg());
192 case OPT_FIPS_FINGERPRINT:
193 hmac_key = "etaonrishdlcupfm";
196 hmac_key = opt_arg();
199 mac_name = opt_arg();
203 sigopts = sk_OPENSSL_STRING_new_null();
204 if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
209 macopts = sk_OPENSSL_STRING_new_null();
210 if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
214 digestname = opt_unknown();
217 if (!opt_provider(o))
223 /* Remaining args are files to digest. */
224 argc = opt_num_rest();
226 if (keyfile != NULL && argc > 1) {
227 BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
230 if (!app_RAND_load())
233 if (digestname != NULL) {
234 if (!opt_md(digestname, &md))
238 if (do_verify && sigfile == NULL) {
240 "No signature to verify: use the -signature option\n");
246 in = BIO_new(BIO_s_file());
247 bmd = BIO_new(BIO_f_md());
248 if (in == NULL || bmd == NULL)
252 BIO_set_callback_ex(in, BIO_debug_callback_ex);
253 /* needed for windows 3.1 */
254 BIO_set_callback_arg(in, (char *)bio_err);
257 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
258 BIO_printf(bio_err, "Error getting password\n");
269 out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
273 if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
274 BIO_printf(bio_err, "MAC and signing key cannot both be specified\n");
278 if (keyfile != NULL) {
282 sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "public key");
284 sigkey = load_key(keyfile, keyform, 0, passin, e, "private key");
285 if (sigkey == NULL) {
287 * load_[pub]key() has already printed an appropriate message
291 type = EVP_PKEY_get_id(sigkey);
292 if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
294 * We implement PureEdDSA for these which doesn't have a separate
295 * digest, and only supports one shot.
297 BIO_printf(bio_err, "Key type not supported for this operation\n");
302 if (mac_name != NULL) {
303 EVP_PKEY_CTX *mac_ctx = NULL;
305 if (!init_gen_str(&mac_ctx, mac_name, impl, 0, NULL, NULL))
307 if (macopts != NULL) {
308 for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
309 char *macopt = sk_OPENSSL_STRING_value(macopts, i);
311 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
312 EVP_PKEY_CTX_free(mac_ctx);
313 BIO_printf(bio_err, "MAC parameter error \"%s\"\n", macopt);
319 sigkey = app_keygen(mac_ctx, mac_name, 0, 0 /* not verbose */);
320 /* Verbose output would make external-tests gost-engine fail */
321 EVP_PKEY_CTX_free(mac_ctx);
324 if (hmac_key != NULL) {
326 md = (EVP_MD *)EVP_sha256();
327 digestname = SN_sha256;
329 sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
330 (unsigned char *)hmac_key,
336 if (sigkey != NULL) {
337 EVP_MD_CTX *mctx = NULL;
338 EVP_PKEY_CTX *pctx = NULL;
341 if (BIO_get_md_ctx(bmd, &mctx) <= 0) {
342 BIO_printf(bio_err, "Error getting context\n");
347 res = EVP_DigestVerifyInit_ex(mctx, &pctx, digestname,
349 app_get0_propq(), sigkey, NULL);
351 res = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
354 res = EVP_DigestSignInit_ex(mctx, &pctx, digestname,
356 app_get0_propq(), sigkey, NULL);
358 res = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
360 BIO_printf(bio_err, "Error setting context\n");
363 if (sigopts != NULL) {
364 for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
365 char *sigopt = sk_OPENSSL_STRING_value(sigopts, i);
367 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
368 BIO_printf(bio_err, "Signature parameter error \"%s\"\n",
375 /* we use md as a filter, reading from 'in' */
377 EVP_MD_CTX *mctx = NULL;
378 if (BIO_get_md_ctx(bmd, &mctx) <= 0) {
379 BIO_printf(bio_err, "Error getting context\n");
383 md = (EVP_MD *)EVP_sha256();
384 if (!EVP_DigestInit_ex(mctx, md, impl)) {
385 BIO_printf(bio_err, "Error setting digest\n");
390 if (sigfile != NULL && sigkey != NULL) {
391 BIO *sigbio = BIO_new_file(sigfile, "rb");
393 if (sigbio == NULL) {
394 BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
397 siglen = EVP_PKEY_get_size(sigkey);
398 sigbuf = app_malloc(siglen, "signature buffer");
399 siglen = BIO_read(sigbio, sigbuf, siglen);
402 BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
406 inp = BIO_push(bmd, in);
411 BIO_get_md_ctx(bmd, &tctx);
412 md = EVP_MD_CTX_get1_md(tctx);
415 md_name = EVP_MD_get0_name(md);
418 if (!(EVP_MD_get_flags(md) & EVP_MD_FLAG_XOF)) {
419 BIO_printf(bio_err, "Length can only be specified for XOF\n");
423 * Signing using XOF is not supported by any algorithms currently since
424 * each algorithm only calls EVP_DigestFinal_ex() in their sign_final
425 * and verify_final methods.
427 if (sigkey != NULL) {
428 BIO_printf(bio_err, "Signing key cannot be specified for XOF\n");
434 BIO_set_fp(in, stdin, BIO_NOCLOSE);
435 ret = do_fp(out, buf, inp, separator, out_bin, xoflen, sigkey, sigbuf,
436 siglen, NULL, md_name, "stdin");
438 const char *sig_name = NULL;
442 sig_name = EVP_PKEY_get0_type_name(sigkey);
445 for (i = 0; i < argc; i++) {
446 if (BIO_read_filename(in, argv[i]) <= 0) {
451 if (do_fp(out, buf, inp, separator, out_bin, xoflen,
452 sigkey, sigbuf, siglen, sig_name, md_name, argv[i]))
455 (void)BIO_reset(bmd);
459 if (ret != EXIT_SUCCESS)
460 ERR_print_errors(bio_err);
461 OPENSSL_clear_free(buf, BUFSIZE);
463 OPENSSL_free(passin);
466 EVP_PKEY_free(sigkey);
467 sk_OPENSSL_STRING_free(sigopts);
468 sk_OPENSSL_STRING_free(macopts);
469 OPENSSL_free(sigbuf);
475 static void show_digests(const OBJ_NAME *name, void *arg)
477 struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
478 const EVP_MD *md = NULL;
480 /* Filter out signed digests (a.k.a signature algorithms) */
481 if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
484 if (!islower((unsigned char)*name->name))
487 /* Filter out message digests that we cannot use */
488 md = EVP_MD_fetch(app_get0_libctx(), name->name, app_get0_propq());
492 BIO_printf(dec->bio, "-%-25s", name->name);
494 BIO_printf(dec->bio, "\n");
497 BIO_printf(dec->bio, " ");
502 * The newline_escape_filename function performs newline escaping for any
503 * filename that contains a newline. This function also takes a pointer
504 * to backslash. The backslash pointer is a flag to indicating whether a newline
505 * is present in the filename. If a newline is present, the backslash flag is
506 * set and the output format will contain a backslash at the beginning of the
507 * digest output. This output format is to replicate the output format found
508 * in the '*sum' checksum programs. This aims to preserve backward
511 static const char *newline_escape_filename(const char *file, int * backslash)
513 size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
514 char *file_cpy = NULL;
516 for (i = 0; i < length; i++)
520 mem_len = length + newline_count + 1;
521 file_cpy = app_malloc(mem_len, file);
525 const char c = file[e];
527 file_cpy[i++] = '\\';
536 return (const char*)file_cpy;
540 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout, int xoflen,
541 EVP_PKEY *key, unsigned char *sigin, int siglen,
542 const char *sig_name, const char *md_name,
545 size_t len = BUFSIZE;
546 int i, backslash = 0, ret = EXIT_FAILURE;
547 unsigned char *allocated_buf = NULL;
549 while (BIO_pending(bp) || !BIO_eof(bp)) {
550 i = BIO_read(bp, (char *)buf, BUFSIZE);
552 BIO_printf(bio_err, "Read error in %s\n", file);
560 BIO_get_md_ctx(bp, &ctx);
561 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
563 BIO_printf(out, "Verified OK\n");
565 BIO_printf(out, "Verification failure\n");
568 BIO_printf(bio_err, "Error verifying data\n");
578 BIO_get_md_ctx(bp, &ctx);
579 if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
580 BIO_printf(bio_err, "Error getting maximum length of signed data\n");
583 if (tmplen > BUFSIZE) {
585 allocated_buf = app_malloc(len, "Signature buffer");
588 if (!EVP_DigestSignFinal(ctx, buf, &len)) {
589 BIO_printf(bio_err, "Error signing data\n");
592 } else if (xoflen > 0) {
597 allocated_buf = app_malloc(len, "Digest buffer");
601 BIO_get_md_ctx(bp, &ctx);
603 if (!EVP_DigestFinalXOF(ctx, buf, len)) {
604 BIO_printf(bio_err, "Error Digesting Data\n");
608 len = BIO_gets(bp, (char *)buf, BUFSIZE);
614 BIO_write(out, buf, len);
615 } else if (sep == 2) {
616 file = newline_escape_filename(file, &backslash);
621 for (i = 0; i < (int)len; i++)
622 BIO_printf(out, "%02x", buf[i]);
624 BIO_printf(out, " *%s\n", file);
625 OPENSSL_free((char *)file);
627 if (sig_name != NULL) {
628 BIO_puts(out, sig_name);
630 BIO_printf(out, "-%s", md_name);
631 BIO_printf(out, "(%s)= ", file);
632 } else if (md_name != NULL) {
633 BIO_printf(out, "%s(%s)= ", md_name, file);
635 BIO_printf(out, "(%s)= ", file);
637 for (i = 0; i < (int)len; i++) {
639 BIO_printf(out, ":");
640 BIO_printf(out, "%02x", buf[i]);
642 BIO_printf(out, "\n");
647 if (allocated_buf != NULL)
648 OPENSSL_clear_free(allocated_buf, len);