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