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,
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,
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 {"d", OPT_DEBUG, '-', "Print debug info"},
69 {"debug", OPT_DEBUG, '-', "Print debug info"},
71 OPT_SECTION("Signing"),
72 {"sign", OPT_SIGN, 's', "Sign digest using private key"},
73 {"verify", OPT_VERIFY, 's', "Verify a signature using public key"},
74 {"prverify", OPT_PRVERIFY, 's', "Verify a signature using private key"},
75 {"sigopt", OPT_SIGOPT, 's', "Signature parameter in n:v form"},
76 {"signature", OPT_SIGNATURE, '<', "File with signature to verify"},
77 {"hmac", OPT_HMAC, 's', "Create hashed MAC with key"},
78 {"mac", OPT_MAC, 's', "Create MAC (not necessarily HMAC)"},
79 {"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form or key"},
80 {"", OPT_DIGEST, '-', "Any supported digest"},
81 {"fips-fingerprint", OPT_FIPS_FINGERPRINT, '-',
82 "Compute HMAC with the key used in OpenSSL-FIPS fingerprint"},
88 {"file", 0, 0, "Files to digest (optional; default is stdin)"},
92 int dgst_main(int argc, char **argv)
94 BIO *in = NULL, *inp, *bmd = NULL, *out = NULL;
95 ENGINE *e = NULL, *impl = NULL;
96 EVP_PKEY *sigkey = NULL;
97 STACK_OF(OPENSSL_STRING) *sigopts = NULL, *macopts = NULL;
98 char *hmac_key = NULL;
99 char *mac_name = NULL;
100 char *passinarg = NULL, *passin = NULL;
101 const EVP_MD *md = NULL, *m;
102 const char *outfile = NULL, *keyfile = NULL, *prog = NULL;
103 const char *sigfile = NULL;
104 const char *md_name = NULL;
106 int separator = 0, debug = 0, keyform = FORMAT_PEM, siglen = 0;
107 int i, ret = 1, out_bin = -1, want_pub = 0, do_verify = 0;
108 unsigned char *buf = NULL, *sigbuf = NULL;
110 struct doall_dgst_digests dec;
112 prog = opt_progname(argv[0]);
113 buf = app_malloc(BUFSIZE, "I/O buffer");
114 md = EVP_get_digestbyname(prog);
116 prog = opt_init(argc, argv, dgst_options);
117 while ((o = opt_next()) != OPT_EOF) {
122 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
125 opt_help(dgst_options);
129 BIO_printf(bio_out, "Supported digests:\n");
132 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
134 BIO_printf(bio_out, "\n");
154 passinarg = opt_arg();
158 want_pub = do_verify = 1;
168 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
172 e = setup_engine(opt_arg(), 0);
174 case OPT_ENGINE_IMPL:
186 case OPT_FIPS_FINGERPRINT:
187 hmac_key = "etaonrishdlcupfm";
190 hmac_key = opt_arg();
193 mac_name = opt_arg();
197 sigopts = sk_OPENSSL_STRING_new_null();
198 if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
203 macopts = sk_OPENSSL_STRING_new_null();
204 if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
208 if (!opt_md(opt_unknown(), &m))
213 if (!opt_provider(o))
218 argc = opt_num_rest();
220 if (keyfile != NULL && argc > 1) {
221 BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
225 if (do_verify && sigfile == NULL) {
227 "No signature to verify: use the -signature option\n");
233 in = BIO_new(BIO_s_file());
234 bmd = BIO_new(BIO_f_md());
235 if ((in == NULL) || (bmd == NULL)) {
236 ERR_print_errors(bio_err);
241 BIO_set_callback(in, BIO_debug_callback);
242 /* needed for windows 3.1 */
243 BIO_set_callback_arg(in, (char *)bio_err);
246 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
247 BIO_printf(bio_err, "Error getting password\n");
258 out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
262 if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
263 BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
267 if (keyfile != NULL) {
271 sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
273 sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
274 if (sigkey == NULL) {
276 * load_[pub]key() has already printed an appropriate message
280 type = EVP_PKEY_id(sigkey);
281 if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
283 * We implement PureEdDSA for these which doesn't have a separate
284 * digest, and only supports one shot.
286 BIO_printf(bio_err, "Key type not supported for this operation\n");
291 if (mac_name != NULL) {
292 EVP_PKEY_CTX *mac_ctx = NULL;
294 if (!init_gen_str(&mac_ctx, mac_name, impl, 0, NULL, NULL))
296 if (macopts != NULL) {
298 for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
299 macopt = sk_OPENSSL_STRING_value(macopts, i);
300 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
302 "MAC parameter error \"%s\"\n", macopt);
303 ERR_print_errors(bio_err);
308 if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
309 BIO_puts(bio_err, "Error generating key\n");
310 ERR_print_errors(bio_err);
315 EVP_PKEY_CTX_free(mac_ctx);
320 if (hmac_key != NULL) {
321 sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
322 (unsigned char *)hmac_key,
328 if (sigkey != NULL) {
329 EVP_MD_CTX *mctx = NULL;
330 EVP_PKEY_CTX *pctx = NULL;
332 if (!BIO_get_md_ctx(bmd, &mctx)) {
333 BIO_printf(bio_err, "Error getting context\n");
334 ERR_print_errors(bio_err);
338 r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
340 r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
342 BIO_printf(bio_err, "Error setting context\n");
343 ERR_print_errors(bio_err);
346 if (sigopts != NULL) {
348 for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
349 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
350 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
351 BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
352 ERR_print_errors(bio_err);
358 /* we use md as a filter, reading from 'in' */
360 EVP_MD_CTX *mctx = NULL;
361 if (!BIO_get_md_ctx(bmd, &mctx)) {
362 BIO_printf(bio_err, "Error getting context\n");
363 ERR_print_errors(bio_err);
368 if (!EVP_DigestInit_ex(mctx, md, impl)) {
369 BIO_printf(bio_err, "Error setting digest\n");
370 ERR_print_errors(bio_err);
375 if (sigfile != NULL && sigkey != NULL) {
376 BIO *sigbio = BIO_new_file(sigfile, "rb");
377 if (sigbio == NULL) {
378 BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
379 ERR_print_errors(bio_err);
382 siglen = EVP_PKEY_size(sigkey);
383 sigbuf = app_malloc(siglen, "signature buffer");
384 siglen = BIO_read(sigbio, sigbuf, siglen);
387 BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
388 ERR_print_errors(bio_err);
392 inp = BIO_push(bmd, in);
396 BIO_get_md_ctx(bmd, &tctx);
397 md = EVP_MD_CTX_md(tctx);
400 md_name = EVP_MD_name(md);
403 BIO_set_fp(in, stdin, BIO_NOCLOSE);
404 ret = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
405 siglen, NULL, md_name, "stdin");
407 const char *sig_name = NULL;
409 if (sigkey != NULL) {
410 const EVP_PKEY_ASN1_METHOD *ameth;
411 ameth = EVP_PKEY_get0_asn1(sigkey);
413 EVP_PKEY_asn1_get0_info(NULL, NULL,
414 NULL, NULL, &sig_name, ameth);
418 for (i = 0; i < argc; i++) {
420 if (BIO_read_filename(in, argv[i]) <= 0) {
425 r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
426 siglen, sig_name, md_name, argv[i]);
430 (void)BIO_reset(bmd);
434 OPENSSL_clear_free(buf, BUFSIZE);
436 OPENSSL_free(passin);
438 EVP_PKEY_free(sigkey);
439 sk_OPENSSL_STRING_free(sigopts);
440 sk_OPENSSL_STRING_free(macopts);
441 OPENSSL_free(sigbuf);
447 static void show_digests(const OBJ_NAME *name, void *arg)
449 struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
450 const EVP_MD *md = NULL;
452 /* Filter out signed digests (a.k.a signature algorithms) */
453 if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
456 if (!islower((unsigned char)*name->name))
459 /* Filter out message digests that we cannot use */
460 md = EVP_get_digestbyname(name->name);
464 BIO_printf(dec->bio, "-%-25s", name->name);
466 BIO_printf(dec->bio, "\n");
469 BIO_printf(dec->bio, " ");
474 * The newline_escape_filename function performs newline escaping for any
475 * filename that contains a newline. This function also takes a pointer
476 * to backslash. The backslash pointer is a flag to indicating whether a newline
477 * is present in the filename. If a newline is present, the backslash flag is
478 * set and the output format will contain a backslash at the beginning of the
479 * digest output. This output format is to replicate the output format found
480 * in the '*sum' checksum programs. This aims to preserve backward
483 static const char *newline_escape_filename(const char *file, int * backslash)
485 size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
486 char *file_cpy = NULL;
488 for (i = 0; i < length; i++)
492 mem_len = length + newline_count + 1;
493 file_cpy = app_malloc(mem_len, file);
497 const char c = file[e];
499 file_cpy[i++] = '\\';
508 return (const char*)file_cpy;
512 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
513 EVP_PKEY *key, unsigned char *sigin, int siglen,
514 const char *sig_name, const char *md_name,
517 size_t len = BUFSIZE;
518 int i, backslash = 0, ret = 1;
519 unsigned char *sigbuf = NULL;
521 while (BIO_pending(bp) || !BIO_eof(bp)) {
522 i = BIO_read(bp, (char *)buf, BUFSIZE);
524 BIO_printf(bio_err, "Read Error in %s\n", file);
525 ERR_print_errors(bio_err);
533 BIO_get_md_ctx(bp, &ctx);
534 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
536 BIO_printf(out, "Verified OK\n");
538 BIO_printf(out, "Verification Failure\n");
541 BIO_printf(bio_err, "Error Verifying Data\n");
542 ERR_print_errors(bio_err);
552 BIO_get_md_ctx(bp, &ctx);
553 if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
554 BIO_printf(bio_err, "Error Signing Data\n");
555 ERR_print_errors(bio_err);
558 if (tmplen > BUFSIZE) {
560 sigbuf = app_malloc(len, "Signature buffer");
563 if (!EVP_DigestSignFinal(ctx, buf, &len)) {
564 BIO_printf(bio_err, "Error Signing Data\n");
565 ERR_print_errors(bio_err);
569 len = BIO_gets(bp, (char *)buf, BUFSIZE);
571 ERR_print_errors(bio_err);
577 BIO_write(out, buf, len);
578 } else if (sep == 2) {
579 file = newline_escape_filename(file, &backslash);
584 for (i = 0; i < (int)len; i++)
585 BIO_printf(out, "%02x", buf[i]);
587 BIO_printf(out, " *%s\n", file);
588 OPENSSL_free((char *)file);
590 if (sig_name != NULL) {
591 BIO_puts(out, sig_name);
593 BIO_printf(out, "-%s", md_name);
594 BIO_printf(out, "(%s)= ", file);
595 } else if (md_name != NULL) {
596 BIO_printf(out, "%s(%s)= ", md_name, file);
598 BIO_printf(out, "(%s)= ", file);
600 for (i = 0; i < (int)len; i++) {
602 BIO_printf(out, ":");
603 BIO_printf(out, "%02x", buf[i]);
605 BIO_printf(out, "\n");
611 OPENSSL_clear_free(sigbuf, len);