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>
24 DEFINE_STACK_OF_STRING()
27 #define BUFSIZE 1024*8
29 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
30 EVP_PKEY *key, unsigned char *sigin, int siglen,
31 const char *sig_name, const char *md_name,
33 static void show_digests(const OBJ_NAME *name, void *bio_);
35 struct doall_dgst_digests {
40 typedef enum OPTION_choice {
41 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP, OPT_LIST,
42 OPT_C, OPT_R, OPT_OUT, OPT_SIGN, OPT_PASSIN, OPT_VERIFY,
43 OPT_PRVERIFY, OPT_SIGNATURE, OPT_KEYFORM, OPT_ENGINE, OPT_ENGINE_IMPL,
44 OPT_HEX, OPT_BINARY, OPT_DEBUG, OPT_FIPS_FINGERPRINT,
45 OPT_HMAC, OPT_MAC, OPT_SIGOPT, OPT_MACOPT,
47 OPT_R_ENUM, OPT_PROV_ENUM
50 const OPTIONS dgst_options[] = {
51 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
53 OPT_SECTION("General"),
54 {"help", OPT_HELP, '-', "Display this summary"},
55 {"list", OPT_LIST, '-', "List digests"},
56 #ifndef OPENSSL_NO_ENGINE
57 {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
58 {"engine_impl", OPT_ENGINE_IMPL, '-',
59 "Also use engine given by -engine for digest operations"},
61 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
63 OPT_SECTION("Output"),
64 {"c", OPT_C, '-', "Print the digest with separating colons"},
65 {"r", OPT_R, '-', "Print the digest in coreutils format"},
66 {"out", OPT_OUT, '>', "Output to filename rather than stdout"},
67 {"keyform", OPT_KEYFORM, 'f', "Key file format (ENGINE, other values ignored)"},
68 {"hex", OPT_HEX, '-', "Print as hex dump"},
69 {"binary", OPT_BINARY, '-', "Print in binary form"},
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;
102 char *passinarg = NULL, *passin = NULL;
103 const EVP_MD *md = NULL, *m;
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_PEM, siglen = 0;
109 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 prog = opt_progname(argv[0]);
115 buf = app_malloc(BUFSIZE, "I/O buffer");
116 md = EVP_get_digestbyname(prog);
118 prog = opt_init(argc, argv, dgst_options);
119 while ((o = opt_next()) != OPT_EOF) {
124 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
127 opt_help(dgst_options);
131 BIO_printf(bio_out, "Supported digests:\n");
134 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
136 BIO_printf(bio_out, "\n");
156 passinarg = opt_arg();
160 want_pub = do_verify = 1;
170 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
174 e = setup_engine(opt_arg(), 0);
176 case OPT_ENGINE_IMPL:
188 case OPT_FIPS_FINGERPRINT:
189 hmac_key = "etaonrishdlcupfm";
192 hmac_key = opt_arg();
195 mac_name = opt_arg();
199 sigopts = sk_OPENSSL_STRING_new_null();
200 if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
205 macopts = sk_OPENSSL_STRING_new_null();
206 if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
210 if (!opt_md(opt_unknown(), &m))
215 if (!opt_provider(o))
220 argc = opt_num_rest();
222 if (keyfile != NULL && argc > 1) {
223 BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
227 if (do_verify && sigfile == NULL) {
229 "No signature to verify: use the -signature option\n");
235 in = BIO_new(BIO_s_file());
236 bmd = BIO_new(BIO_f_md());
237 if ((in == NULL) || (bmd == NULL)) {
238 ERR_print_errors(bio_err);
243 BIO_set_callback(in, BIO_debug_callback);
244 /* needed for windows 3.1 */
245 BIO_set_callback_arg(in, (char *)bio_err);
248 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
249 BIO_printf(bio_err, "Error getting password\n");
260 out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
264 if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
265 BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
269 if (keyfile != NULL) {
273 sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
275 sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
276 if (sigkey == NULL) {
278 * load_[pub]key() has already printed an appropriate message
282 type = EVP_PKEY_id(sigkey);
283 if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
285 * We implement PureEdDSA for these which doesn't have a separate
286 * digest, and only supports one shot.
288 BIO_printf(bio_err, "Key type not supported for this operation\n");
293 if (mac_name != NULL) {
294 EVP_PKEY_CTX *mac_ctx = NULL;
296 if (!init_gen_str(&mac_ctx, mac_name, impl, 0))
298 if (macopts != NULL) {
300 for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
301 macopt = sk_OPENSSL_STRING_value(macopts, i);
302 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
304 "MAC parameter error \"%s\"\n", macopt);
305 ERR_print_errors(bio_err);
310 if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
311 BIO_puts(bio_err, "Error generating key\n");
312 ERR_print_errors(bio_err);
317 EVP_PKEY_CTX_free(mac_ctx);
322 if (hmac_key != NULL) {
323 sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
324 (unsigned char *)hmac_key, -1);
329 if (sigkey != NULL) {
330 EVP_MD_CTX *mctx = NULL;
331 EVP_PKEY_CTX *pctx = NULL;
333 if (!BIO_get_md_ctx(bmd, &mctx)) {
334 BIO_printf(bio_err, "Error getting context\n");
335 ERR_print_errors(bio_err);
339 r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
341 r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
343 BIO_printf(bio_err, "Error setting context\n");
344 ERR_print_errors(bio_err);
347 if (sigopts != NULL) {
349 for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
350 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
351 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
352 BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
353 ERR_print_errors(bio_err);
359 /* we use md as a filter, reading from 'in' */
361 EVP_MD_CTX *mctx = NULL;
362 if (!BIO_get_md_ctx(bmd, &mctx)) {
363 BIO_printf(bio_err, "Error getting context\n");
364 ERR_print_errors(bio_err);
369 if (!EVP_DigestInit_ex(mctx, md, impl)) {
370 BIO_printf(bio_err, "Error setting digest\n");
371 ERR_print_errors(bio_err);
376 if (sigfile != NULL && sigkey != NULL) {
377 BIO *sigbio = BIO_new_file(sigfile, "rb");
378 if (sigbio == NULL) {
379 BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
380 ERR_print_errors(bio_err);
383 siglen = EVP_PKEY_size(sigkey);
384 sigbuf = app_malloc(siglen, "signature buffer");
385 siglen = BIO_read(sigbio, sigbuf, siglen);
388 BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
389 ERR_print_errors(bio_err);
393 inp = BIO_push(bmd, in);
397 BIO_get_md_ctx(bmd, &tctx);
398 md = EVP_MD_CTX_md(tctx);
401 md_name = EVP_MD_name(md);
404 BIO_set_fp(in, stdin, BIO_NOCLOSE);
405 ret = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
406 siglen, NULL, md_name, "stdin");
408 const char *sig_name = NULL;
410 if (sigkey != NULL) {
411 const EVP_PKEY_ASN1_METHOD *ameth;
412 ameth = EVP_PKEY_get0_asn1(sigkey);
414 EVP_PKEY_asn1_get0_info(NULL, NULL,
415 NULL, NULL, &sig_name, ameth);
419 for (i = 0; i < argc; i++) {
421 if (BIO_read_filename(in, argv[i]) <= 0) {
426 r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
427 siglen, sig_name, md_name, argv[i]);
431 (void)BIO_reset(bmd);
435 OPENSSL_clear_free(buf, BUFSIZE);
437 OPENSSL_free(passin);
439 EVP_PKEY_free(sigkey);
440 sk_OPENSSL_STRING_free(sigopts);
441 sk_OPENSSL_STRING_free(macopts);
442 OPENSSL_free(sigbuf);
448 static void show_digests(const OBJ_NAME *name, void *arg)
450 struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
451 const EVP_MD *md = NULL;
453 /* Filter out signed digests (a.k.a signature algorithms) */
454 if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
457 if (!islower((unsigned char)*name->name))
460 /* Filter out message digests that we cannot use */
461 md = EVP_get_digestbyname(name->name);
465 BIO_printf(dec->bio, "-%-25s", name->name);
467 BIO_printf(dec->bio, "\n");
470 BIO_printf(dec->bio, " ");
475 * The newline_escape_filename function performs newline escaping for any
476 * filename that contains a newline. This function also takes a pointer
477 * to backslash. The backslash pointer is a flag to indicating whether a newline
478 * is present in the filename. If a newline is present, the backslash flag is
479 * set and the output format will contain a backslash at the beginning of the
480 * digest output. This output format is to replicate the output format found
481 * in the '*sum' checksum programs. This aims to preserve backward
484 static const char *newline_escape_filename(const char *file, int * backslash)
486 size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
487 char *file_cpy = NULL;
489 for (i = 0; i < length; i++)
493 mem_len = length + newline_count + 1;
494 file_cpy = app_malloc(mem_len, file);
498 const char c = file[e];
500 file_cpy[i++] = '\\';
509 return (const char*)file_cpy;
513 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
514 EVP_PKEY *key, unsigned char *sigin, int siglen,
515 const char *sig_name, const char *md_name,
518 size_t len = BUFSIZE;
519 int i, backslash = 0, ret = 1;
520 unsigned char *sigbuf = NULL;
522 while (BIO_pending(bp) || !BIO_eof(bp)) {
523 i = BIO_read(bp, (char *)buf, BUFSIZE);
525 BIO_printf(bio_err, "Read Error in %s\n", file);
526 ERR_print_errors(bio_err);
534 BIO_get_md_ctx(bp, &ctx);
535 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
537 BIO_printf(out, "Verified OK\n");
539 BIO_printf(out, "Verification Failure\n");
542 BIO_printf(bio_err, "Error Verifying Data\n");
543 ERR_print_errors(bio_err);
553 BIO_get_md_ctx(bp, &ctx);
554 if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
555 BIO_printf(bio_err, "Error Signing Data\n");
556 ERR_print_errors(bio_err);
559 if (tmplen > BUFSIZE) {
561 sigbuf = app_malloc(len, "Signature buffer");
564 if (!EVP_DigestSignFinal(ctx, buf, &len)) {
565 BIO_printf(bio_err, "Error Signing Data\n");
566 ERR_print_errors(bio_err);
570 len = BIO_gets(bp, (char *)buf, BUFSIZE);
572 ERR_print_errors(bio_err);
578 BIO_write(out, buf, len);
579 } else if (sep == 2) {
580 file = newline_escape_filename(file, &backslash);
585 for (i = 0; i < (int)len; i++)
586 BIO_printf(out, "%02x", buf[i]);
588 BIO_printf(out, " *%s\n", file);
589 OPENSSL_free((char *)file);
591 if (sig_name != NULL) {
592 BIO_puts(out, sig_name);
594 BIO_printf(out, "-%s", md_name);
595 BIO_printf(out, "(%s)= ", file);
596 } else if (md_name != NULL) {
597 BIO_printf(out, "%s(%s)= ", md_name, file);
599 BIO_printf(out, "(%s)= ", file);
601 for (i = 0; i < (int)len; i++) {
603 BIO_printf(out, ":");
604 BIO_printf(out, "%02x", buf[i]);
606 BIO_printf(out, "\n");
612 OPENSSL_clear_free(sigbuf, len);