VirtualBox

source: vbox/trunk/src/libs/openssl-3.0.7/apps/dgst.c@ 100908

最後變更 在這個檔案從100908是 97372,由 vboxsync 提交於 2 年 前

libs: Switch to openssl-3.0.7, bugref:10317

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette