1 /*
2 * Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved.
3 *
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
8 */
9
10 #include <stdio.h>
11 #include <string.h>
12 #include <stdlib.h>
13 #include "apps.h"
14 #include "progs.h"
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>
22 #include <ctype.h>
23
24 #undef BUFSIZE
25 #define BUFSIZE 1024*8
26
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,
30 const char *file);
31 static void show_digests(const OBJ_NAME *name, void *bio_);
32
33 struct doall_dgst_digests {
34 BIO *bio;
35 int n;
36 };
37
38 typedef enum OPTION_choice {
39 OPT_COMMON,
40 OPT_LIST,
41 OPT_C, OPT_R, OPT_OUT, OPT_SIGN, OPT_PASSIN, OPT_VERIFY,
42 OPT_PRVERIFY, OPT_SIGNATURE, OPT_KEYFORM, OPT_ENGINE, OPT_ENGINE_IMPL,
43 OPT_HEX, OPT_BINARY, OPT_DEBUG, OPT_FIPS_FINGERPRINT,
44 OPT_HMAC, OPT_MAC, OPT_SIGOPT, OPT_MACOPT, OPT_XOFLEN,
45 OPT_DIGEST,
46 OPT_R_ENUM, OPT_PROV_ENUM
47 } OPTION_CHOICE;
48
49 const OPTIONS dgst_options[] = {
50 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
51
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"},
59 #endif
60 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
61
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 (ENGINE, other values ignored)"},
67 {"hex", OPT_HEX, '-', "Print as hex dump"},
68 {"binary", OPT_BINARY, '-', "Print in binary form"},
69 {"xoflen", OPT_XOFLEN, 'p', "Output length for XOF algorithms. To obtain the maximum security strength set this to 32 (or greater) for SHAKE128, and 64 (or greater) for SHAKE256"},
70 {"d", OPT_DEBUG, '-', "Print debug info"},
71 {"debug", OPT_DEBUG, '-', "Print debug info"},
72
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"},
85
86 OPT_R_OPTIONS,
87 OPT_PROV_OPTIONS,
88
89 OPT_PARAMETERS(),
90 {"file", 0, 0, "Files to digest (optional; default is stdin)"},
91 {NULL}
92 };
93
dgst_main(int argc,char ** argv)94 int dgst_main(int argc, char **argv)
95 {
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, *digestname = NULL;
102 char *passinarg = NULL, *passin = NULL;
103 EVP_MD *md = NULL;
104 const char *outfile = NULL, *keyfile = NULL, *prog = NULL;
105 const char *sigfile = NULL;
106 const char *md_name = NULL;
107 OPTION_CHOICE o;
108 int separator = 0, debug = 0, keyform = FORMAT_UNDEF, siglen = 0;
109 int i, ret = EXIT_FAILURE, out_bin = -1, want_pub = 0, do_verify = 0;
110 int xoflen = 0;
111 unsigned char *buf = NULL, *sigbuf = NULL;
112 int engine_impl = 0;
113 struct doall_dgst_digests dec;
114
115 buf = app_malloc(BUFSIZE, "I/O buffer");
116 md = (EVP_MD *)EVP_get_digestbyname(argv[0]);
117
118 opt_set_unknown_name("digest");
119 prog = opt_init(argc, argv, dgst_options);
120 while ((o = opt_next()) != OPT_EOF) {
121 switch (o) {
122 case OPT_EOF:
123 case OPT_ERR:
124 opthelp:
125 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
126 goto end;
127 case OPT_HELP:
128 opt_help(dgst_options);
129 ret = EXIT_SUCCESS;
130 goto end;
131 case OPT_LIST:
132 BIO_printf(bio_out, "Supported digests:\n");
133 dec.bio = bio_out;
134 dec.n = 0;
135 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
136 show_digests, &dec);
137 BIO_printf(bio_out, "\n");
138 ret = EXIT_SUCCESS;
139 goto end;
140 case OPT_C:
141 separator = 1;
142 break;
143 case OPT_R:
144 separator = 2;
145 break;
146 case OPT_R_CASES:
147 if (!opt_rand(o))
148 goto end;
149 break;
150 case OPT_OUT:
151 outfile = opt_arg();
152 break;
153 case OPT_SIGN:
154 keyfile = opt_arg();
155 break;
156 case OPT_PASSIN:
157 passinarg = opt_arg();
158 break;
159 case OPT_VERIFY:
160 keyfile = opt_arg();
161 want_pub = do_verify = 1;
162 break;
163 case OPT_PRVERIFY:
164 keyfile = opt_arg();
165 do_verify = 1;
166 break;
167 case OPT_SIGNATURE:
168 sigfile = opt_arg();
169 break;
170 case OPT_KEYFORM:
171 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
172 goto opthelp;
173 break;
174 case OPT_ENGINE:
175 e = setup_engine(opt_arg(), 0);
176 break;
177 case OPT_ENGINE_IMPL:
178 engine_impl = 1;
179 break;
180 case OPT_HEX:
181 out_bin = 0;
182 break;
183 case OPT_BINARY:
184 out_bin = 1;
185 break;
186 case OPT_XOFLEN:
187 xoflen = atoi(opt_arg());
188 break;
189 case OPT_DEBUG:
190 debug = 1;
191 break;
192 case OPT_FIPS_FINGERPRINT:
193 hmac_key = "etaonrishdlcupfm";
194 break;
195 case OPT_HMAC:
196 hmac_key = opt_arg();
197 break;
198 case OPT_MAC:
199 mac_name = opt_arg();
200 break;
201 case OPT_SIGOPT:
202 if (!sigopts)
203 sigopts = sk_OPENSSL_STRING_new_null();
204 if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
205 goto opthelp;
206 break;
207 case OPT_MACOPT:
208 if (!macopts)
209 macopts = sk_OPENSSL_STRING_new_null();
210 if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
211 goto opthelp;
212 break;
213 case OPT_DIGEST:
214 digestname = opt_unknown();
215 break;
216 case OPT_PROV_CASES:
217 if (!opt_provider(o))
218 goto end;
219 break;
220 }
221 }
222
223 /* Remaining args are files to digest. */
224 argc = opt_num_rest();
225 argv = opt_rest();
226 if (keyfile != NULL && argc > 1) {
227 BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
228 goto end;
229 }
230 if (!app_RAND_load())
231 goto end;
232
233 if (digestname != NULL) {
234 if (!opt_md(digestname, &md))
235 goto opthelp;
236 }
237
238 if (do_verify && sigfile == NULL) {
239 BIO_printf(bio_err,
240 "No signature to verify: use the -signature option\n");
241 goto end;
242 }
243 if (engine_impl)
244 impl = e;
245
246 in = BIO_new(BIO_s_file());
247 bmd = BIO_new(BIO_f_md());
248 if (in == NULL || bmd == NULL)
249 goto end;
250
251 if (debug) {
252 BIO_set_callback_ex(in, BIO_debug_callback_ex);
253 /* needed for windows 3.1 */
254 BIO_set_callback_arg(in, (char *)bio_err);
255 }
256
257 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
258 BIO_printf(bio_err, "Error getting password\n");
259 goto end;
260 }
261
262 if (out_bin == -1) {
263 if (keyfile != NULL)
264 out_bin = 1;
265 else
266 out_bin = 0;
267 }
268
269 out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
270 if (out == NULL)
271 goto end;
272
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");
275 goto end;
276 }
277
278 if (keyfile != NULL) {
279 int type;
280
281 if (want_pub)
282 sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "public key");
283 else
284 sigkey = load_key(keyfile, keyform, 0, passin, e, "private key");
285 if (sigkey == NULL) {
286 /*
287 * load_[pub]key() has already printed an appropriate message
288 */
289 goto end;
290 }
291 type = EVP_PKEY_get_id(sigkey);
292 if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
293 /*
294 * We implement PureEdDSA for these which doesn't have a separate
295 * digest, and only supports one shot.
296 */
297 BIO_printf(bio_err, "Key type not supported for this operation\n");
298 goto end;
299 }
300 }
301
302 if (mac_name != NULL) {
303 EVP_PKEY_CTX *mac_ctx = NULL;
304
305 if (!init_gen_str(&mac_ctx, mac_name, impl, 0, NULL, NULL))
306 goto end;
307 if (macopts != NULL) {
308 for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
309 char *macopt = sk_OPENSSL_STRING_value(macopts, i);
310
311 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
312 EVP_PKEY_CTX_free(mac_ctx);
313 BIO_printf(bio_err, "MAC parameter error \"%s\"\n", macopt);
314 goto end;
315 }
316 }
317 }
318
319 sigkey = app_keygen(mac_ctx, mac_name, 0, 0 /* not verbose */);
320 /* Verbose output would make external-tests gost-engine fail */
321 EVP_PKEY_CTX_free(mac_ctx);
322 }
323
324 if (hmac_key != NULL) {
325 if (md == NULL) {
326 md = (EVP_MD *)EVP_sha256();
327 digestname = SN_sha256;
328 }
329 sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
330 (unsigned char *)hmac_key,
331 strlen(hmac_key));
332 if (sigkey == NULL)
333 goto end;
334 }
335
336 if (sigkey != NULL) {
337 EVP_MD_CTX *mctx = NULL;
338 EVP_PKEY_CTX *pctx = NULL;
339 int res;
340
341 if (BIO_get_md_ctx(bmd, &mctx) <= 0) {
342 BIO_printf(bio_err, "Error getting context\n");
343 goto end;
344 }
345 if (do_verify)
346 if (impl == NULL)
347 res = EVP_DigestVerifyInit_ex(mctx, &pctx, digestname,
348 app_get0_libctx(),
349 app_get0_propq(), sigkey, NULL);
350 else
351 res = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
352 else
353 if (impl == NULL)
354 res = EVP_DigestSignInit_ex(mctx, &pctx, digestname,
355 app_get0_libctx(),
356 app_get0_propq(), sigkey, NULL);
357 else
358 res = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
359 if (res == 0) {
360 BIO_printf(bio_err, "Error setting context\n");
361 goto end;
362 }
363 if (sigopts != NULL) {
364 for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
365 char *sigopt = sk_OPENSSL_STRING_value(sigopts, i);
366
367 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
368 BIO_printf(bio_err, "Signature parameter error \"%s\"\n",
369 sigopt);
370 goto end;
371 }
372 }
373 }
374 }
375 /* we use md as a filter, reading from 'in' */
376 else {
377 EVP_MD_CTX *mctx = NULL;
378 if (BIO_get_md_ctx(bmd, &mctx) <= 0) {
379 BIO_printf(bio_err, "Error getting context\n");
380 goto end;
381 }
382 if (md == NULL)
383 md = (EVP_MD *)EVP_sha256();
384 if (!EVP_DigestInit_ex(mctx, md, impl)) {
385 BIO_printf(bio_err, "Error setting digest\n");
386 goto end;
387 }
388 }
389
390 if (sigfile != NULL && sigkey != NULL) {
391 BIO *sigbio = BIO_new_file(sigfile, "rb");
392
393 if (sigbio == NULL) {
394 BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
395 goto end;
396 }
397 siglen = EVP_PKEY_get_size(sigkey);
398 sigbuf = app_malloc(siglen, "signature buffer");
399 siglen = BIO_read(sigbio, sigbuf, siglen);
400 BIO_free(sigbio);
401 if (siglen <= 0) {
402 BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
403 goto end;
404 }
405 }
406 inp = BIO_push(bmd, in);
407
408 if (md == NULL) {
409 EVP_MD_CTX *tctx;
410
411 BIO_get_md_ctx(bmd, &tctx);
412 md = EVP_MD_CTX_get1_md(tctx);
413 }
414 if (md != NULL)
415 md_name = EVP_MD_get0_name(md);
416
417 if (xoflen > 0) {
418 if (!(EVP_MD_get_flags(md) & EVP_MD_FLAG_XOF)) {
419 BIO_printf(bio_err, "Length can only be specified for XOF\n");
420 goto end;
421 }
422 /*
423 * Signing using XOF is not supported by any algorithms currently since
424 * each algorithm only calls EVP_DigestFinal_ex() in their sign_final
425 * and verify_final methods.
426 */
427 if (sigkey != NULL) {
428 BIO_printf(bio_err, "Signing key cannot be specified for XOF\n");
429 goto end;
430 }
431 }
432
433 if (argc == 0) {
434 BIO_set_fp(in, stdin, BIO_NOCLOSE);
435 ret = do_fp(out, buf, inp, separator, out_bin, xoflen, sigkey, sigbuf,
436 siglen, NULL, md_name, "stdin");
437 } else {
438 const char *sig_name = NULL;
439
440 if (out_bin == 0) {
441 if (sigkey != NULL)
442 sig_name = EVP_PKEY_get0_type_name(sigkey);
443 }
444 ret = EXIT_SUCCESS;
445 for (i = 0; i < argc; i++) {
446 if (BIO_read_filename(in, argv[i]) <= 0) {
447 perror(argv[i]);
448 ret = EXIT_FAILURE;
449 continue;
450 } else {
451 if (do_fp(out, buf, inp, separator, out_bin, xoflen,
452 sigkey, sigbuf, siglen, sig_name, md_name, argv[i]))
453 ret = EXIT_FAILURE;
454 }
455 (void)BIO_reset(bmd);
456 }
457 }
458 end:
459 if (ret != EXIT_SUCCESS)
460 ERR_print_errors(bio_err);
461 OPENSSL_clear_free(buf, BUFSIZE);
462 BIO_free(in);
463 OPENSSL_free(passin);
464 BIO_free_all(out);
465 EVP_MD_free(md);
466 EVP_PKEY_free(sigkey);
467 sk_OPENSSL_STRING_free(sigopts);
468 sk_OPENSSL_STRING_free(macopts);
469 OPENSSL_free(sigbuf);
470 BIO_free(bmd);
471 release_engine(e);
472 return ret;
473 }
474
show_digests(const OBJ_NAME * name,void * arg)475 static void show_digests(const OBJ_NAME *name, void *arg)
476 {
477 struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
478 const EVP_MD *md = NULL;
479
480 /* Filter out signed digests (a.k.a signature algorithms) */
481 if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
482 return;
483
484 if (!islower((unsigned char)*name->name))
485 return;
486
487 /* Filter out message digests that we cannot use */
488 md = EVP_MD_fetch(app_get0_libctx(), name->name, app_get0_propq());
489 if (md == NULL)
490 return;
491
492 BIO_printf(dec->bio, "-%-25s", name->name);
493 if (++dec->n == 3) {
494 BIO_printf(dec->bio, "\n");
495 dec->n = 0;
496 } else {
497 BIO_printf(dec->bio, " ");
498 }
499 }
500
501 /*
502 * The newline_escape_filename function performs newline escaping for any
503 * filename that contains a newline. This function also takes a pointer
504 * to backslash. The backslash pointer is a flag to indicating whether a newline
505 * is present in the filename. If a newline is present, the backslash flag is
506 * set and the output format will contain a backslash at the beginning of the
507 * digest output. This output format is to replicate the output format found
508 * in the '*sum' checksum programs. This aims to preserve backward
509 * compatibility.
510 */
newline_escape_filename(const char * file,int * backslash)511 static const char *newline_escape_filename(const char *file, int * backslash)
512 {
513 size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
514 char *file_cpy = NULL;
515
516 for (i = 0; i < length; i++)
517 if (file[i] == '\n')
518 newline_count++;
519
520 mem_len = length + newline_count + 1;
521 file_cpy = app_malloc(mem_len, file);
522 i = 0;
523
524 while (e < length) {
525 const char c = file[e];
526 if (c == '\n') {
527 file_cpy[i++] = '\\';
528 file_cpy[i++] = 'n';
529 *backslash = 1;
530 } else {
531 file_cpy[i++] = c;
532 }
533 e++;
534 }
535 file_cpy[i] = '\0';
536 return (const char*)file_cpy;
537 }
538
539
do_fp(BIO * out,unsigned char * buf,BIO * bp,int sep,int binout,int xoflen,EVP_PKEY * key,unsigned char * sigin,int siglen,const char * sig_name,const char * md_name,const char * file)540 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout, int xoflen,
541 EVP_PKEY *key, unsigned char *sigin, int siglen,
542 const char *sig_name, const char *md_name,
543 const char *file)
544 {
545 size_t len = BUFSIZE;
546 int i, backslash = 0, ret = EXIT_FAILURE;
547 unsigned char *allocated_buf = NULL;
548
549 while (BIO_pending(bp) || !BIO_eof(bp)) {
550 i = BIO_read(bp, (char *)buf, BUFSIZE);
551 if (i < 0) {
552 BIO_printf(bio_err, "Read error in %s\n", file);
553 goto end;
554 }
555 if (i == 0)
556 break;
557 }
558 if (sigin != NULL) {
559 EVP_MD_CTX *ctx;
560 BIO_get_md_ctx(bp, &ctx);
561 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
562 if (i > 0) {
563 BIO_printf(out, "Verified OK\n");
564 } else if (i == 0) {
565 BIO_printf(out, "Verification failure\n");
566 goto end;
567 } else {
568 BIO_printf(bio_err, "Error verifying data\n");
569 goto end;
570 }
571 ret = EXIT_SUCCESS;
572 goto end;
573 }
574 if (key != NULL) {
575 EVP_MD_CTX *ctx;
576 size_t tmplen;
577
578 BIO_get_md_ctx(bp, &ctx);
579 if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
580 BIO_printf(bio_err, "Error getting maximum length of signed data\n");
581 goto end;
582 }
583 if (tmplen > BUFSIZE) {
584 len = tmplen;
585 allocated_buf = app_malloc(len, "Signature buffer");
586 buf = allocated_buf;
587 }
588 if (!EVP_DigestSignFinal(ctx, buf, &len)) {
589 BIO_printf(bio_err, "Error signing data\n");
590 goto end;
591 }
592 } else if (xoflen > 0) {
593 EVP_MD_CTX *ctx;
594
595 len = xoflen;
596 if (len > BUFSIZE) {
597 allocated_buf = app_malloc(len, "Digest buffer");
598 buf = allocated_buf;
599 }
600
601 BIO_get_md_ctx(bp, &ctx);
602
603 if (!EVP_DigestFinalXOF(ctx, buf, len)) {
604 BIO_printf(bio_err, "Error Digesting Data\n");
605 goto end;
606 }
607 } else {
608 len = BIO_gets(bp, (char *)buf, BUFSIZE);
609 if ((int)len < 0)
610 goto end;
611 }
612
613 if (binout) {
614 BIO_write(out, buf, len);
615 } else if (sep == 2) {
616 file = newline_escape_filename(file, &backslash);
617
618 if (backslash == 1)
619 BIO_puts(out, "\\");
620
621 for (i = 0; i < (int)len; i++)
622 BIO_printf(out, "%02x", buf[i]);
623
624 BIO_printf(out, " *%s\n", file);
625 OPENSSL_free((char *)file);
626 } else {
627 if (sig_name != NULL) {
628 BIO_puts(out, sig_name);
629 if (md_name != NULL)
630 BIO_printf(out, "-%s", md_name);
631 BIO_printf(out, "(%s)= ", file);
632 } else if (md_name != NULL) {
633 BIO_printf(out, "%s(%s)= ", md_name, file);
634 } else {
635 BIO_printf(out, "(%s)= ", file);
636 }
637 for (i = 0; i < (int)len; i++) {
638 if (sep && (i != 0))
639 BIO_printf(out, ":");
640 BIO_printf(out, "%02x", buf[i]);
641 }
642 BIO_printf(out, "\n");
643 }
644
645 ret = EXIT_SUCCESS;
646 end:
647 if (allocated_buf != NULL)
648 OPENSSL_clear_free(allocated_buf, len);
649
650 return ret;
651 }
652
