]> git.ipfire.org Git - thirdparty/openssl.git/blob - apps/dgst.c
APPS: Add check for multiple 'unknown' options
[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_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"},
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
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 sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
328 (unsigned char *)hmac_key,
329 strlen(hmac_key));
330 if (sigkey == NULL)
331 goto end;
332 }
333
334 if (sigkey != NULL) {
335 EVP_MD_CTX *mctx = NULL;
336 EVP_PKEY_CTX *pctx = NULL;
337 int res;
338
339 if (BIO_get_md_ctx(bmd, &mctx) <= 0) {
340 BIO_printf(bio_err, "Error getting context\n");
341 goto end;
342 }
343 if (do_verify)
344 res = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
345 else
346 res = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
347 if (res == 0) {
348 BIO_printf(bio_err, "Error setting context\n");
349 goto end;
350 }
351 if (sigopts != NULL) {
352 for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
353 char *sigopt = sk_OPENSSL_STRING_value(sigopts, i);
354
355 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
356 BIO_printf(bio_err, "Signature parameter error \"%s\"\n",
357 sigopt);
358 goto end;
359 }
360 }
361 }
362 }
363 /* we use md as a filter, reading from 'in' */
364 else {
365 EVP_MD_CTX *mctx = NULL;
366 if (BIO_get_md_ctx(bmd, &mctx) <= 0) {
367 BIO_printf(bio_err, "Error getting context\n");
368 goto end;
369 }
370 if (md == NULL)
371 md = (EVP_MD *)EVP_sha256();
372 if (!EVP_DigestInit_ex(mctx, md, impl)) {
373 BIO_printf(bio_err, "Error setting digest\n");
374 goto end;
375 }
376 }
377
378 if (sigfile != NULL && sigkey != NULL) {
379 BIO *sigbio = BIO_new_file(sigfile, "rb");
380
381 if (sigbio == NULL) {
382 BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
383 goto end;
384 }
385 siglen = EVP_PKEY_get_size(sigkey);
386 sigbuf = app_malloc(siglen, "signature buffer");
387 siglen = BIO_read(sigbio, sigbuf, siglen);
388 BIO_free(sigbio);
389 if (siglen <= 0) {
390 BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
391 goto end;
392 }
393 }
394 inp = BIO_push(bmd, in);
395
396 if (md == NULL) {
397 EVP_MD_CTX *tctx;
398
399 BIO_get_md_ctx(bmd, &tctx);
400 md = EVP_MD_CTX_get1_md(tctx);
401 }
402 if (md != NULL)
403 md_name = EVP_MD_get0_name(md);
404
405 if (xoflen > 0) {
406 if (!(EVP_MD_get_flags(md) & EVP_MD_FLAG_XOF)) {
407 BIO_printf(bio_err, "Length can only be specified for XOF\n");
408 goto end;
409 }
410 if (sigkey != NULL) {
411 BIO_printf(bio_err, "Signing key cannot be specified for XOF\n");
412 goto end;
413 }
414 }
415
416 if (argc == 0) {
417 BIO_set_fp(in, stdin, BIO_NOCLOSE);
418 ret = do_fp(out, buf, inp, separator, out_bin, xoflen, sigkey, sigbuf,
419 siglen, NULL, md_name, "stdin");
420 } else {
421 const char *sig_name = NULL;
422
423 if (out_bin == 0) {
424 if (sigkey != NULL)
425 sig_name = EVP_PKEY_get0_type_name(sigkey);
426 }
427 ret = EXIT_SUCCESS;
428 for (i = 0; i < argc; i++) {
429 if (BIO_read_filename(in, argv[i]) <= 0) {
430 perror(argv[i]);
431 ret = EXIT_FAILURE;
432 continue;
433 } else {
434 if (do_fp(out, buf, inp, separator, out_bin, xoflen,
435 sigkey, sigbuf, siglen, sig_name, md_name, argv[i]))
436 ret = EXIT_FAILURE;
437 }
438 (void)BIO_reset(bmd);
439 }
440 }
441 end:
442 if (ret != EXIT_SUCCESS)
443 ERR_print_errors(bio_err);
444 OPENSSL_clear_free(buf, BUFSIZE);
445 BIO_free(in);
446 OPENSSL_free(passin);
447 BIO_free_all(out);
448 EVP_MD_free(md);
449 EVP_PKEY_free(sigkey);
450 sk_OPENSSL_STRING_free(sigopts);
451 sk_OPENSSL_STRING_free(macopts);
452 OPENSSL_free(sigbuf);
453 BIO_free(bmd);
454 release_engine(e);
455 return ret;
456 }
457
458 static void show_digests(const OBJ_NAME *name, void *arg)
459 {
460 struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
461 const EVP_MD *md = NULL;
462
463 /* Filter out signed digests (a.k.a signature algorithms) */
464 if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
465 return;
466
467 if (!islower((unsigned char)*name->name))
468 return;
469
470 /* Filter out message digests that we cannot use */
471 md = EVP_get_digestbyname(name->name);
472 if (md == NULL)
473 return;
474
475 BIO_printf(dec->bio, "-%-25s", name->name);
476 if (++dec->n == 3) {
477 BIO_printf(dec->bio, "\n");
478 dec->n = 0;
479 } else {
480 BIO_printf(dec->bio, " ");
481 }
482 }
483
484 /*
485 * The newline_escape_filename function performs newline escaping for any
486 * filename that contains a newline. This function also takes a pointer
487 * to backslash. The backslash pointer is a flag to indicating whether a newline
488 * is present in the filename. If a newline is present, the backslash flag is
489 * set and the output format will contain a backslash at the beginning of the
490 * digest output. This output format is to replicate the output format found
491 * in the '*sum' checksum programs. This aims to preserve backward
492 * compatibility.
493 */
494 static const char *newline_escape_filename(const char *file, int * backslash)
495 {
496 size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
497 char *file_cpy = NULL;
498
499 for (i = 0; i < length; i++)
500 if (file[i] == '\n')
501 newline_count++;
502
503 mem_len = length + newline_count + 1;
504 file_cpy = app_malloc(mem_len, file);
505 i = 0;
506
507 while (e < length) {
508 const char c = file[e];
509 if (c == '\n') {
510 file_cpy[i++] = '\\';
511 file_cpy[i++] = 'n';
512 *backslash = 1;
513 } else {
514 file_cpy[i++] = c;
515 }
516 e++;
517 }
518 file_cpy[i] = '\0';
519 return (const char*)file_cpy;
520 }
521
522
523 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout, int xoflen,
524 EVP_PKEY *key, unsigned char *sigin, int siglen,
525 const char *sig_name, const char *md_name,
526 const char *file)
527 {
528 size_t len = BUFSIZE;
529 int i, backslash = 0, ret = EXIT_FAILURE;
530 unsigned char *allocated_buf = NULL;
531
532 while (BIO_pending(bp) || !BIO_eof(bp)) {
533 i = BIO_read(bp, (char *)buf, BUFSIZE);
534 if (i < 0) {
535 BIO_printf(bio_err, "Read error in %s\n", file);
536 goto end;
537 }
538 if (i == 0)
539 break;
540 }
541 if (sigin != NULL) {
542 EVP_MD_CTX *ctx;
543 BIO_get_md_ctx(bp, &ctx);
544 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
545 if (i > 0) {
546 BIO_printf(out, "Verified OK\n");
547 } else if (i == 0) {
548 BIO_printf(out, "Verification failure\n");
549 goto end;
550 } else {
551 BIO_printf(bio_err, "Error verifying data\n");
552 goto end;
553 }
554 ret = EXIT_SUCCESS;
555 goto end;
556 }
557 if (key != NULL) {
558 EVP_MD_CTX *ctx;
559 size_t tmplen;
560
561 BIO_get_md_ctx(bp, &ctx);
562 if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
563 BIO_printf(bio_err, "Error getting maximum length of signed data\n");
564 goto end;
565 }
566 if (tmplen > BUFSIZE) {
567 len = tmplen;
568 allocated_buf = app_malloc(len, "Signature buffer");
569 buf = allocated_buf;
570 }
571 if (!EVP_DigestSignFinal(ctx, buf, &len)) {
572 BIO_printf(bio_err, "Error signing data\n");
573 goto end;
574 }
575 } else if (xoflen > 0) {
576 EVP_MD_CTX *ctx;
577
578 len = xoflen;
579 if (len > BUFSIZE) {
580 allocated_buf = app_malloc(len, "Digest buffer");
581 buf = allocated_buf;
582 }
583
584 BIO_get_md_ctx(bp, &ctx);
585
586 if (!EVP_DigestFinalXOF(ctx, buf, len)) {
587 BIO_printf(bio_err, "Error Digesting Data\n");
588 goto end;
589 }
590 } else {
591 len = BIO_gets(bp, (char *)buf, BUFSIZE);
592 if ((int)len < 0)
593 goto end;
594 }
595
596 if (binout) {
597 BIO_write(out, buf, len);
598 } else if (sep == 2) {
599 file = newline_escape_filename(file, &backslash);
600
601 if (backslash == 1)
602 BIO_puts(out, "\\");
603
604 for (i = 0; i < (int)len; i++)
605 BIO_printf(out, "%02x", buf[i]);
606
607 BIO_printf(out, " *%s\n", file);
608 OPENSSL_free((char *)file);
609 } else {
610 if (sig_name != NULL) {
611 BIO_puts(out, sig_name);
612 if (md_name != NULL)
613 BIO_printf(out, "-%s", md_name);
614 BIO_printf(out, "(%s)= ", file);
615 } else if (md_name != NULL) {
616 BIO_printf(out, "%s(%s)= ", md_name, file);
617 } else {
618 BIO_printf(out, "(%s)= ", file);
619 }
620 for (i = 0; i < (int)len; i++) {
621 if (sep && (i != 0))
622 BIO_printf(out, ":");
623 BIO_printf(out, "%02x", buf[i]);
624 }
625 BIO_printf(out, "\n");
626 }
627
628 ret = EXIT_SUCCESS;
629 end:
630 if (allocated_buf != NULL)
631 OPENSSL_clear_free(allocated_buf, len);
632
633 return ret;
634 }