2 * Copyright 1995-2021 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 {
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, OPT_XOFLEN,
45 OPT_R_ENUM, OPT_PROV_ENUM
48 const OPTIONS dgst_options[] = {
49 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
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"},
59 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
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 {"xoflen", OPT_XOFLEN, 'p', "Output length for XOF algorithms"},
69 {"d", OPT_DEBUG, '-', "Print debug info"},
70 {"debug", OPT_DEBUG, '-', "Print debug info"},
72 OPT_SECTION("Signing"),
73 {"sign", OPT_SIGN, 's', "Sign digest using private key"},
74 {"verify", OPT_VERIFY, 's', "Verify a signature using public key"},
75 {"prverify", OPT_PRVERIFY, 's', "Verify a signature using private key"},
76 {"sigopt", OPT_SIGOPT, 's', "Signature parameter in n:v form"},
77 {"signature", OPT_SIGNATURE, '<', "File with signature to verify"},
78 {"hmac", OPT_HMAC, 's', "Create hashed MAC with key"},
79 {"mac", OPT_MAC, 's', "Create MAC (not necessarily HMAC)"},
80 {"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form or key"},
81 {"", OPT_DIGEST, '-', "Any supported digest"},
82 {"fips-fingerprint", OPT_FIPS_FINGERPRINT, '-',
83 "Compute HMAC with the key used in OpenSSL-FIPS fingerprint"},
89 {"file", 0, 0, "Files to digest (optional; default is stdin)"},
93 int dgst_main(int argc, char **argv)
95 BIO *in = NULL, *inp, *bmd = NULL, *out = NULL;
96 ENGINE *e = NULL, *impl = NULL;
97 EVP_PKEY *sigkey = NULL;
98 STACK_OF(OPENSSL_STRING) *sigopts = NULL, *macopts = NULL;
99 char *hmac_key = NULL;
100 char *mac_name = NULL, *digestname = NULL;
101 char *passinarg = NULL, *passin = NULL;
102 const EVP_MD *md = NULL;
103 const char *outfile = NULL, *keyfile = NULL, *prog = NULL;
104 const char *sigfile = NULL;
105 const char *md_name = NULL;
107 int separator = 0, debug = 0, keyform = FORMAT_PEM, siglen = 0;
108 int i, ret = 1, out_bin = -1, want_pub = 0, do_verify = 0;
110 unsigned char *buf = NULL, *sigbuf = NULL;
112 struct doall_dgst_digests dec;
114 buf = app_malloc(BUFSIZE, "I/O buffer");
115 md = EVP_get_digestbyname(argv[0]);
117 prog = opt_init(argc, argv, dgst_options);
118 while ((o = opt_next()) != OPT_EOF) {
123 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
126 opt_help(dgst_options);
130 BIO_printf(bio_out, "Supported digests:\n");
133 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
135 BIO_printf(bio_out, "\n");
155 passinarg = opt_arg();
159 want_pub = do_verify = 1;
169 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
173 e = setup_engine(opt_arg(), 0);
175 case OPT_ENGINE_IMPL:
185 xoflen = atoi(opt_arg());
190 case OPT_FIPS_FINGERPRINT:
191 hmac_key = "etaonrishdlcupfm";
194 hmac_key = opt_arg();
197 mac_name = opt_arg();
201 sigopts = sk_OPENSSL_STRING_new_null();
202 if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
207 macopts = sk_OPENSSL_STRING_new_null();
208 if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
212 digestname = opt_unknown();
215 if (!opt_provider(o))
221 /* Remaining args are files to digest. */
222 argc = opt_num_rest();
224 if (keyfile != NULL && argc > 1) {
225 BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
228 if (!app_RAND_load())
231 if (digestname != NULL) {
232 if (!opt_md(digestname, &md))
236 if (do_verify && sigfile == NULL) {
238 "No signature to verify: use the -signature option\n");
244 in = BIO_new(BIO_s_file());
245 bmd = BIO_new(BIO_f_md());
246 if ((in == NULL) || (bmd == NULL)) {
247 ERR_print_errors(bio_err);
252 BIO_set_callback(in, BIO_debug_callback);
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_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) {
309 for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
310 macopt = sk_OPENSSL_STRING_value(macopts, i);
311 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
313 "MAC parameter error \"%s\"\n", macopt);
314 ERR_print_errors(bio_err);
319 if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
320 BIO_puts(bio_err, "Error generating key\n");
321 ERR_print_errors(bio_err);
326 EVP_PKEY_CTX_free(mac_ctx);
331 if (hmac_key != NULL) {
332 sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
333 (unsigned char *)hmac_key,
339 if (sigkey != NULL) {
340 EVP_MD_CTX *mctx = NULL;
341 EVP_PKEY_CTX *pctx = NULL;
343 if (!BIO_get_md_ctx(bmd, &mctx)) {
344 BIO_printf(bio_err, "Error getting context\n");
345 ERR_print_errors(bio_err);
349 r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
351 r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
353 BIO_printf(bio_err, "Error setting context\n");
354 ERR_print_errors(bio_err);
357 if (sigopts != NULL) {
359 for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
360 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
361 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
362 BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
363 ERR_print_errors(bio_err);
369 /* we use md as a filter, reading from 'in' */
371 EVP_MD_CTX *mctx = NULL;
372 if (!BIO_get_md_ctx(bmd, &mctx)) {
373 BIO_printf(bio_err, "Error getting context\n");
374 ERR_print_errors(bio_err);
379 if (!EVP_DigestInit_ex(mctx, md, impl)) {
380 BIO_printf(bio_err, "Error setting digest\n");
381 ERR_print_errors(bio_err);
386 if (sigfile != NULL && sigkey != NULL) {
387 BIO *sigbio = BIO_new_file(sigfile, "rb");
388 if (sigbio == NULL) {
389 BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
390 ERR_print_errors(bio_err);
393 siglen = EVP_PKEY_size(sigkey);
394 sigbuf = app_malloc(siglen, "signature buffer");
395 siglen = BIO_read(sigbio, sigbuf, siglen);
398 BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
399 ERR_print_errors(bio_err);
403 inp = BIO_push(bmd, in);
407 BIO_get_md_ctx(bmd, &tctx);
408 md = EVP_MD_CTX_get0_md(tctx);
411 md_name = EVP_MD_name(md);
414 if (!(EVP_MD_flags(md) & EVP_MD_FLAG_XOF)) {
415 BIO_printf(bio_err, "Length can only be specified for XOF\n");
418 if (sigkey != NULL) {
419 BIO_printf(bio_err, "Signing key cannot be specified for XOF\n");
425 BIO_set_fp(in, stdin, BIO_NOCLOSE);
426 ret = do_fp(out, buf, inp, separator, out_bin, xoflen, sigkey, sigbuf,
427 siglen, NULL, md_name, "stdin");
429 const char *sig_name = NULL;
432 sig_name = EVP_PKEY_get0_type_name(sigkey);
435 for (i = 0; i < argc; i++) {
437 if (BIO_read_filename(in, argv[i]) <= 0) {
442 r = do_fp(out, buf, inp, separator, out_bin, xoflen,
443 sigkey, sigbuf, siglen, sig_name, md_name, argv[i]);
447 (void)BIO_reset(bmd);
451 OPENSSL_clear_free(buf, BUFSIZE);
453 OPENSSL_free(passin);
455 EVP_PKEY_free(sigkey);
456 sk_OPENSSL_STRING_free(sigopts);
457 sk_OPENSSL_STRING_free(macopts);
458 OPENSSL_free(sigbuf);
464 static void show_digests(const OBJ_NAME *name, void *arg)
466 struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
467 const EVP_MD *md = NULL;
469 /* Filter out signed digests (a.k.a signature algorithms) */
470 if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
473 if (!islower((unsigned char)*name->name))
476 /* Filter out message digests that we cannot use */
477 md = EVP_get_digestbyname(name->name);
481 BIO_printf(dec->bio, "-%-25s", name->name);
483 BIO_printf(dec->bio, "\n");
486 BIO_printf(dec->bio, " ");
491 * The newline_escape_filename function performs newline escaping for any
492 * filename that contains a newline. This function also takes a pointer
493 * to backslash. The backslash pointer is a flag to indicating whether a newline
494 * is present in the filename. If a newline is present, the backslash flag is
495 * set and the output format will contain a backslash at the beginning of the
496 * digest output. This output format is to replicate the output format found
497 * in the '*sum' checksum programs. This aims to preserve backward
500 static const char *newline_escape_filename(const char *file, int * backslash)
502 size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
503 char *file_cpy = NULL;
505 for (i = 0; i < length; i++)
509 mem_len = length + newline_count + 1;
510 file_cpy = app_malloc(mem_len, file);
514 const char c = file[e];
516 file_cpy[i++] = '\\';
525 return (const char*)file_cpy;
529 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout, int xoflen,
530 EVP_PKEY *key, unsigned char *sigin, int siglen,
531 const char *sig_name, const char *md_name,
534 size_t len = BUFSIZE;
535 int i, backslash = 0, ret = 1;
536 unsigned char *allocated_buf = NULL;
538 while (BIO_pending(bp) || !BIO_eof(bp)) {
539 i = BIO_read(bp, (char *)buf, BUFSIZE);
541 BIO_printf(bio_err, "Read Error in %s\n", file);
542 ERR_print_errors(bio_err);
550 BIO_get_md_ctx(bp, &ctx);
551 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
553 BIO_printf(out, "Verified OK\n");
555 BIO_printf(out, "Verification Failure\n");
558 BIO_printf(bio_err, "Error Verifying Data\n");
559 ERR_print_errors(bio_err);
569 BIO_get_md_ctx(bp, &ctx);
570 if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
571 BIO_printf(bio_err, "Error Signing Data\n");
572 ERR_print_errors(bio_err);
575 if (tmplen > BUFSIZE) {
577 allocated_buf = app_malloc(len, "Signature buffer");
580 if (!EVP_DigestSignFinal(ctx, buf, &len)) {
581 BIO_printf(bio_err, "Error Signing Data\n");
582 ERR_print_errors(bio_err);
585 } else if (xoflen > 0) {
590 allocated_buf = app_malloc(len, "Digest buffer");
594 BIO_get_md_ctx(bp, &ctx);
596 if (!EVP_DigestFinalXOF(ctx, buf, len)) {
597 BIO_printf(bio_err, "Error Digesting Data\n");
598 ERR_print_errors(bio_err);
602 len = BIO_gets(bp, (char *)buf, BUFSIZE);
604 ERR_print_errors(bio_err);
610 BIO_write(out, buf, len);
611 } else if (sep == 2) {
612 file = newline_escape_filename(file, &backslash);
617 for (i = 0; i < (int)len; i++)
618 BIO_printf(out, "%02x", buf[i]);
620 BIO_printf(out, " *%s\n", file);
621 OPENSSL_free((char *)file);
623 if (sig_name != NULL) {
624 BIO_puts(out, sig_name);
626 BIO_printf(out, "-%s", md_name);
627 BIO_printf(out, "(%s)= ", file);
628 } else if (md_name != NULL) {
629 BIO_printf(out, "%s(%s)= ", md_name, file);
631 BIO_printf(out, "(%s)= ", file);
633 for (i = 0; i < (int)len; i++) {
635 BIO_printf(out, ":");
636 BIO_printf(out, "%02x", buf[i]);
638 BIO_printf(out, "\n");
643 if (allocated_buf != NULL)
644 OPENSSL_clear_free(allocated_buf, len);