2 * Copyright 1995-2019 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,
48 const OPTIONS dgst_options[] = {
49 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
50 {OPT_HELP_STR, 1, '-',
51 " file... files to digest (default is stdin)\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 (PEM or ENGINE)"},
67 {"hex", OPT_HEX, '-', "Print as hex dump"},
68 {"binary", OPT_BINARY, '-', "Print in binary form"},
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 int dgst_main(int argc, char **argv)
91 BIO *in = NULL, *inp, *bmd = NULL, *out = NULL;
92 ENGINE *e = NULL, *impl = NULL;
93 EVP_PKEY *sigkey = NULL;
94 STACK_OF(OPENSSL_STRING) *sigopts = NULL, *macopts = NULL;
95 char *hmac_key = NULL;
96 char *mac_name = NULL;
97 char *passinarg = NULL, *passin = NULL;
98 const EVP_MD *md = NULL, *m;
99 const char *outfile = NULL, *keyfile = NULL, *prog = NULL;
100 const char *sigfile = NULL;
101 const char *md_name = NULL;
103 int separator = 0, debug = 0, keyform = FORMAT_PEM, siglen = 0;
104 int i, ret = 1, out_bin = -1, want_pub = 0, do_verify = 0;
105 unsigned char *buf = NULL, *sigbuf = NULL;
107 struct doall_dgst_digests dec;
109 prog = opt_progname(argv[0]);
110 buf = app_malloc(BUFSIZE, "I/O buffer");
111 md = EVP_get_digestbyname(prog);
113 prog = opt_init(argc, argv, dgst_options);
114 while ((o = opt_next()) != OPT_EOF) {
119 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
122 opt_help(dgst_options);
126 BIO_printf(bio_out, "Supported digests:\n");
129 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
131 BIO_printf(bio_out, "\n");
151 passinarg = opt_arg();
155 want_pub = do_verify = 1;
165 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
169 e = setup_engine(opt_arg(), 0);
171 case OPT_ENGINE_IMPL:
183 case OPT_FIPS_FINGERPRINT:
184 hmac_key = "etaonrishdlcupfm";
187 hmac_key = opt_arg();
190 mac_name = opt_arg();
194 sigopts = sk_OPENSSL_STRING_new_null();
195 if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
200 macopts = sk_OPENSSL_STRING_new_null();
201 if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
205 if (!opt_md(opt_unknown(), &m))
211 argc = opt_num_rest();
213 if (keyfile != NULL && argc > 1) {
214 BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
218 if (do_verify && sigfile == NULL) {
220 "No signature to verify: use the -signature option\n");
226 in = BIO_new(BIO_s_file());
227 bmd = BIO_new(BIO_f_md());
228 if ((in == NULL) || (bmd == NULL)) {
229 ERR_print_errors(bio_err);
234 BIO_set_callback(in, BIO_debug_callback);
235 /* needed for windows 3.1 */
236 BIO_set_callback_arg(in, (char *)bio_err);
239 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
240 BIO_printf(bio_err, "Error getting password\n");
251 out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
255 if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
256 BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
260 if (keyfile != NULL) {
264 sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
266 sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
267 if (sigkey == NULL) {
269 * load_[pub]key() has already printed an appropriate message
273 type = EVP_PKEY_id(sigkey);
274 if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
276 * We implement PureEdDSA for these which doesn't have a separate
277 * digest, and only supports one shot.
279 BIO_printf(bio_err, "Key type not supported for this operation\n");
284 if (mac_name != NULL) {
285 EVP_PKEY_CTX *mac_ctx = NULL;
287 if (!init_gen_str(&mac_ctx, mac_name, impl, 0))
289 if (macopts != NULL) {
291 for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
292 macopt = sk_OPENSSL_STRING_value(macopts, i);
293 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
295 "MAC parameter error \"%s\"\n", macopt);
296 ERR_print_errors(bio_err);
301 if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
302 BIO_puts(bio_err, "Error generating key\n");
303 ERR_print_errors(bio_err);
308 EVP_PKEY_CTX_free(mac_ctx);
313 if (hmac_key != NULL) {
314 sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
315 (unsigned char *)hmac_key, -1);
320 if (sigkey != NULL) {
321 EVP_MD_CTX *mctx = NULL;
322 EVP_PKEY_CTX *pctx = NULL;
324 if (!BIO_get_md_ctx(bmd, &mctx)) {
325 BIO_printf(bio_err, "Error getting context\n");
326 ERR_print_errors(bio_err);
330 r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
332 r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
334 BIO_printf(bio_err, "Error setting context\n");
335 ERR_print_errors(bio_err);
338 if (sigopts != NULL) {
340 for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
341 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
342 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
343 BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
344 ERR_print_errors(bio_err);
350 /* we use md as a filter, reading from 'in' */
352 EVP_MD_CTX *mctx = NULL;
353 if (!BIO_get_md_ctx(bmd, &mctx)) {
354 BIO_printf(bio_err, "Error getting context\n");
355 ERR_print_errors(bio_err);
360 if (!EVP_DigestInit_ex(mctx, md, impl)) {
361 BIO_printf(bio_err, "Error setting digest\n");
362 ERR_print_errors(bio_err);
367 if (sigfile != NULL && sigkey != NULL) {
368 BIO *sigbio = BIO_new_file(sigfile, "rb");
369 if (sigbio == NULL) {
370 BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
371 ERR_print_errors(bio_err);
374 siglen = EVP_PKEY_size(sigkey);
375 sigbuf = app_malloc(siglen, "signature buffer");
376 siglen = BIO_read(sigbio, sigbuf, siglen);
379 BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
380 ERR_print_errors(bio_err);
384 inp = BIO_push(bmd, in);
388 BIO_get_md_ctx(bmd, &tctx);
389 md = EVP_MD_CTX_md(tctx);
392 md_name = EVP_MD_name(md);
395 BIO_set_fp(in, stdin, BIO_NOCLOSE);
396 ret = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
397 siglen, NULL, md_name, "stdin");
399 const char *sig_name = NULL;
401 if (sigkey != NULL) {
402 const EVP_PKEY_ASN1_METHOD *ameth;
403 ameth = EVP_PKEY_get0_asn1(sigkey);
405 EVP_PKEY_asn1_get0_info(NULL, NULL,
406 NULL, NULL, &sig_name, ameth);
410 for (i = 0; i < argc; i++) {
412 if (BIO_read_filename(in, argv[i]) <= 0) {
417 r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
418 siglen, sig_name, md_name, argv[i]);
422 (void)BIO_reset(bmd);
426 OPENSSL_clear_free(buf, BUFSIZE);
428 OPENSSL_free(passin);
430 EVP_PKEY_free(sigkey);
431 sk_OPENSSL_STRING_free(sigopts);
432 sk_OPENSSL_STRING_free(macopts);
433 OPENSSL_free(sigbuf);
439 static void show_digests(const OBJ_NAME *name, void *arg)
441 struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
442 const EVP_MD *md = NULL;
444 /* Filter out signed digests (a.k.a signature algorithms) */
445 if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
448 if (!islower((unsigned char)*name->name))
451 /* Filter out message digests that we cannot use */
452 md = EVP_get_digestbyname(name->name);
456 BIO_printf(dec->bio, "-%-25s", name->name);
458 BIO_printf(dec->bio, "\n");
461 BIO_printf(dec->bio, " ");
466 * The newline_escape_filename function performs newline escaping for any
467 * filename that contains a newline. This function also takes a pointer
468 * to backslash. The backslash pointer is a flag to indicating whether a newline
469 * is present in the filename. If a newline is present, the backslash flag is
470 * set and the output format will contain a backslash at the beginning of the
471 * digest output. This output format is to replicate the output format found
472 * in the '*sum' checksum programs. This aims to preserve backward
475 static const char *newline_escape_filename(const char *file, int * backslash)
477 size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
478 char *file_cpy = NULL;
480 for (i = 0; i < length; i++)
484 mem_len = length + newline_count + 1;
485 file_cpy = app_malloc(mem_len, file);
489 const char c = file[e];
491 file_cpy[i++] = '\\';
500 return (const char*)file_cpy;
504 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
505 EVP_PKEY *key, unsigned char *sigin, int siglen,
506 const char *sig_name, const char *md_name,
509 size_t len = BUFSIZE;
510 int i, backslash = 0, ret = 1;
511 unsigned char *sigbuf = NULL;
513 while (BIO_pending(bp) || !BIO_eof(bp)) {
514 i = BIO_read(bp, (char *)buf, BUFSIZE);
516 BIO_printf(bio_err, "Read Error in %s\n", file);
517 ERR_print_errors(bio_err);
525 BIO_get_md_ctx(bp, &ctx);
526 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
528 BIO_printf(out, "Verified OK\n");
530 BIO_printf(out, "Verification Failure\n");
533 BIO_printf(bio_err, "Error Verifying Data\n");
534 ERR_print_errors(bio_err);
543 BIO_get_md_ctx(bp, &ctx);
544 pkey_len = EVP_PKEY_size(key);
545 if (pkey_len > BUFSIZE) {
547 sigbuf = app_malloc(len, "Signature buffer");
550 if (!EVP_DigestSignFinal(ctx, buf, &len)) {
551 BIO_printf(bio_err, "Error Signing Data\n");
552 ERR_print_errors(bio_err);
556 len = BIO_gets(bp, (char *)buf, BUFSIZE);
558 ERR_print_errors(bio_err);
564 BIO_write(out, buf, len);
565 } else if (sep == 2) {
566 file = newline_escape_filename(file, &backslash);
571 for (i = 0; i < (int)len; i++)
572 BIO_printf(out, "%02x", buf[i]);
574 BIO_printf(out, " *%s\n", file);
575 OPENSSL_free((char *)file);
577 if (sig_name != NULL) {
578 BIO_puts(out, sig_name);
580 BIO_printf(out, "-%s", md_name);
581 BIO_printf(out, "(%s)= ", file);
582 } else if (md_name != NULL) {
583 BIO_printf(out, "%s(%s)= ", md_name, file);
585 BIO_printf(out, "(%s)= ", file);
587 for (i = 0; i < (int)len; i++) {
589 BIO_printf(out, ":");
590 BIO_printf(out, "%02x", buf[i]);
592 BIO_printf(out, "\n");
598 OPENSSL_clear_free(sigbuf, len);