2 * Copyright 1995-2020 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;
101 char *passinarg = NULL, *passin = NULL;
102 const EVP_MD *md = NULL, *m;
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 if (!opt_md(opt_unknown(), &m))
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);
231 if (do_verify && sigfile == NULL) {
233 "No signature to verify: use the -signature option\n");
239 in = BIO_new(BIO_s_file());
240 bmd = BIO_new(BIO_f_md());
241 if ((in == NULL) || (bmd == NULL)) {
242 ERR_print_errors(bio_err);
247 BIO_set_callback(in, BIO_debug_callback);
248 /* needed for windows 3.1 */
249 BIO_set_callback_arg(in, (char *)bio_err);
252 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
253 BIO_printf(bio_err, "Error getting password\n");
264 out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
268 if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
269 BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
273 if (keyfile != NULL) {
277 sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "public key");
279 sigkey = load_key(keyfile, keyform, 0, passin, e, "private key");
280 if (sigkey == NULL) {
282 * load_[pub]key() has already printed an appropriate message
286 type = EVP_PKEY_id(sigkey);
287 if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
289 * We implement PureEdDSA for these which doesn't have a separate
290 * digest, and only supports one shot.
292 BIO_printf(bio_err, "Key type not supported for this operation\n");
297 if (mac_name != NULL) {
298 EVP_PKEY_CTX *mac_ctx = NULL;
300 if (!init_gen_str(&mac_ctx, mac_name, impl, 0, NULL, NULL))
302 if (macopts != NULL) {
304 for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
305 macopt = sk_OPENSSL_STRING_value(macopts, i);
306 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
308 "MAC parameter error \"%s\"\n", macopt);
309 ERR_print_errors(bio_err);
314 if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
315 BIO_puts(bio_err, "Error generating key\n");
316 ERR_print_errors(bio_err);
321 EVP_PKEY_CTX_free(mac_ctx);
326 if (hmac_key != NULL) {
327 sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
328 (unsigned char *)hmac_key,
334 if (sigkey != NULL) {
335 EVP_MD_CTX *mctx = NULL;
336 EVP_PKEY_CTX *pctx = NULL;
338 if (!BIO_get_md_ctx(bmd, &mctx)) {
339 BIO_printf(bio_err, "Error getting context\n");
340 ERR_print_errors(bio_err);
344 r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
346 r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
348 BIO_printf(bio_err, "Error setting context\n");
349 ERR_print_errors(bio_err);
352 if (sigopts != NULL) {
354 for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
355 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
356 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
357 BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
358 ERR_print_errors(bio_err);
364 /* we use md as a filter, reading from 'in' */
366 EVP_MD_CTX *mctx = NULL;
367 if (!BIO_get_md_ctx(bmd, &mctx)) {
368 BIO_printf(bio_err, "Error getting context\n");
369 ERR_print_errors(bio_err);
374 if (!EVP_DigestInit_ex(mctx, md, impl)) {
375 BIO_printf(bio_err, "Error setting digest\n");
376 ERR_print_errors(bio_err);
381 if (sigfile != NULL && sigkey != NULL) {
382 BIO *sigbio = BIO_new_file(sigfile, "rb");
383 if (sigbio == NULL) {
384 BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
385 ERR_print_errors(bio_err);
388 siglen = EVP_PKEY_size(sigkey);
389 sigbuf = app_malloc(siglen, "signature buffer");
390 siglen = BIO_read(sigbio, sigbuf, siglen);
393 BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
394 ERR_print_errors(bio_err);
398 inp = BIO_push(bmd, in);
402 BIO_get_md_ctx(bmd, &tctx);
403 md = EVP_MD_CTX_md(tctx);
406 md_name = EVP_MD_name(md);
409 if (!(EVP_MD_flags(md) & EVP_MD_FLAG_XOF)) {
410 BIO_printf(bio_err, "Length can only be specified for XOF\n");
413 if (sigkey != NULL) {
414 BIO_printf(bio_err, "Signing key cannot be specified for XOF\n");
420 BIO_set_fp(in, stdin, BIO_NOCLOSE);
421 ret = do_fp(out, buf, inp, separator, out_bin, xoflen, sigkey, sigbuf,
422 siglen, NULL, md_name, "stdin");
424 const char *sig_name = NULL;
427 sig_name = EVP_PKEY_get0_first_alg_name(sigkey);
430 for (i = 0; i < argc; i++) {
432 if (BIO_read_filename(in, argv[i]) <= 0) {
437 r = do_fp(out, buf, inp, separator, out_bin, xoflen,
438 sigkey, sigbuf, siglen, sig_name, md_name, argv[i]);
442 (void)BIO_reset(bmd);
446 OPENSSL_clear_free(buf, BUFSIZE);
448 OPENSSL_free(passin);
450 EVP_PKEY_free(sigkey);
451 sk_OPENSSL_STRING_free(sigopts);
452 sk_OPENSSL_STRING_free(macopts);
453 OPENSSL_free(sigbuf);
459 static void show_digests(const OBJ_NAME *name, void *arg)
461 struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
462 const EVP_MD *md = NULL;
464 /* Filter out signed digests (a.k.a signature algorithms) */
465 if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
468 if (!islower((unsigned char)*name->name))
471 /* Filter out message digests that we cannot use */
472 md = EVP_get_digestbyname(name->name);
476 BIO_printf(dec->bio, "-%-25s", name->name);
478 BIO_printf(dec->bio, "\n");
481 BIO_printf(dec->bio, " ");
486 * The newline_escape_filename function performs newline escaping for any
487 * filename that contains a newline. This function also takes a pointer
488 * to backslash. The backslash pointer is a flag to indicating whether a newline
489 * is present in the filename. If a newline is present, the backslash flag is
490 * set and the output format will contain a backslash at the beginning of the
491 * digest output. This output format is to replicate the output format found
492 * in the '*sum' checksum programs. This aims to preserve backward
495 static const char *newline_escape_filename(const char *file, int * backslash)
497 size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
498 char *file_cpy = NULL;
500 for (i = 0; i < length; i++)
504 mem_len = length + newline_count + 1;
505 file_cpy = app_malloc(mem_len, file);
509 const char c = file[e];
511 file_cpy[i++] = '\\';
520 return (const char*)file_cpy;
524 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout, int xoflen,
525 EVP_PKEY *key, unsigned char *sigin, int siglen,
526 const char *sig_name, const char *md_name,
529 size_t len = BUFSIZE;
530 int i, backslash = 0, ret = 1;
531 unsigned char *allocated_buf = NULL;
533 while (BIO_pending(bp) || !BIO_eof(bp)) {
534 i = BIO_read(bp, (char *)buf, BUFSIZE);
536 BIO_printf(bio_err, "Read Error in %s\n", file);
537 ERR_print_errors(bio_err);
545 BIO_get_md_ctx(bp, &ctx);
546 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
548 BIO_printf(out, "Verified OK\n");
550 BIO_printf(out, "Verification Failure\n");
553 BIO_printf(bio_err, "Error Verifying Data\n");
554 ERR_print_errors(bio_err);
564 BIO_get_md_ctx(bp, &ctx);
565 if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
566 BIO_printf(bio_err, "Error Signing Data\n");
567 ERR_print_errors(bio_err);
570 if (tmplen > BUFSIZE) {
572 allocated_buf = app_malloc(len, "Signature buffer");
575 if (!EVP_DigestSignFinal(ctx, buf, &len)) {
576 BIO_printf(bio_err, "Error Signing Data\n");
577 ERR_print_errors(bio_err);
580 } else if (xoflen > 0) {
585 allocated_buf = app_malloc(len, "Digest buffer");
589 BIO_get_md_ctx(bp, &ctx);
591 if (!EVP_DigestFinalXOF(ctx, buf, len)) {
592 BIO_printf(bio_err, "Error Digesting Data\n");
593 ERR_print_errors(bio_err);
597 len = BIO_gets(bp, (char *)buf, BUFSIZE);
599 ERR_print_errors(bio_err);
605 BIO_write(out, buf, len);
606 } else if (sep == 2) {
607 file = newline_escape_filename(file, &backslash);
612 for (i = 0; i < (int)len; i++)
613 BIO_printf(out, "%02x", buf[i]);
615 BIO_printf(out, " *%s\n", file);
616 OPENSSL_free((char *)file);
618 if (sig_name != NULL) {
619 BIO_puts(out, sig_name);
621 BIO_printf(out, "-%s", md_name);
622 BIO_printf(out, "(%s)= ", file);
623 } else if (md_name != NULL) {
624 BIO_printf(out, "%s(%s)= ", md_name, file);
626 BIO_printf(out, "(%s)= ", file);
628 for (i = 0; i < (int)len; i++) {
630 BIO_printf(out, ":");
631 BIO_printf(out, "%02x", buf[i]);
633 BIO_printf(out, "\n");
638 if (allocated_buf != NULL)
639 OPENSSL_clear_free(allocated_buf, len);