]>
git.ipfire.org Git - thirdparty/openssl.git/blob - apps/dgst.c
2 * Copyright 1995-2021 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
, int xoflen
,
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
, OPT_XOFLEN
,
45 OPT_R_ENUM
, OPT_PROV_ENUM
48 const OPTIONS dgst_options
[] = {
49 {OPT_HELP_STR
, 1, '-', "Usage: %s [options] [file...]\n"},
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"},
59 {"passin", OPT_PASSIN
, 's', "Input file pass phrase source"},
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"},
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 {"file", 0, 0, "Files to digest (optional; default is stdin)"},
93 int dgst_main(int argc
, char **argv
)
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
;
101 char *passinarg
= NULL
, *passin
= NULL
;
102 const EVP_MD
*md
= NULL
, *m
;
103 const char *outfile
= NULL
, *keyfile
= NULL
, *prog
= NULL
;
104 const char *sigfile
= NULL
;
105 const char *md_name
= NULL
;
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;
110 unsigned char *buf
= NULL
, *sigbuf
= NULL
;
112 struct doall_dgst_digests dec
;
114 buf
= app_malloc(BUFSIZE
, "I/O buffer");
115 md
= EVP_get_digestbyname(argv
[0]);
117 prog
= opt_init(argc
, argv
, dgst_options
);
118 while ((o
= opt_next()) != OPT_EOF
) {
123 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
126 opt_help(dgst_options
);
130 BIO_printf(bio_out
, "Supported digests:\n");
133 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH
,
135 BIO_printf(bio_out
, "\n");
155 passinarg
= opt_arg();
159 want_pub
= do_verify
= 1;
169 if (!opt_format(opt_arg(), OPT_FMT_ANY
, &keyform
))
173 e
= setup_engine(opt_arg(), 0);
175 case OPT_ENGINE_IMPL
:
185 xoflen
= atoi(opt_arg());
190 case OPT_FIPS_FINGERPRINT
:
191 hmac_key
= "etaonrishdlcupfm";
194 hmac_key
= opt_arg();
197 mac_name
= opt_arg();
201 sigopts
= sk_OPENSSL_STRING_new_null();
202 if (!sigopts
|| !sk_OPENSSL_STRING_push(sigopts
, opt_arg()))
207 macopts
= sk_OPENSSL_STRING_new_null();
208 if (!macopts
|| !sk_OPENSSL_STRING_push(macopts
, opt_arg()))
212 if (!opt_md(opt_unknown(), &m
))
217 if (!opt_provider(o
))
223 /* Remaining args are files to digest. */
224 argc
= opt_num_rest();
226 if (keyfile
!= NULL
&& argc
> 1) {
227 BIO_printf(bio_err
, "%s: Can only sign or verify one file.\n", prog
);
232 if (do_verify
&& sigfile
== NULL
) {
234 "No signature to verify: use the -signature option\n");
240 in
= BIO_new(BIO_s_file());
241 bmd
= BIO_new(BIO_f_md());
242 if ((in
== NULL
) || (bmd
== NULL
)) {
243 ERR_print_errors(bio_err
);
248 BIO_set_callback(in
, BIO_debug_callback
);
249 /* needed for windows 3.1 */
250 BIO_set_callback_arg(in
, (char *)bio_err
);
253 if (!app_passwd(passinarg
, NULL
, &passin
, NULL
)) {
254 BIO_printf(bio_err
, "Error getting password\n");
265 out
= bio_open_default(outfile
, 'w', out_bin
? FORMAT_BINARY
: FORMAT_TEXT
);
269 if ((!(mac_name
== NULL
) + !(keyfile
== NULL
) + !(hmac_key
== NULL
)) > 1) {
270 BIO_printf(bio_err
, "MAC and Signing key cannot both be specified\n");
274 if (keyfile
!= NULL
) {
278 sigkey
= load_pubkey(keyfile
, keyform
, 0, NULL
, e
, "public key");
280 sigkey
= load_key(keyfile
, keyform
, 0, passin
, e
, "private key");
281 if (sigkey
== NULL
) {
283 * load_[pub]key() has already printed an appropriate message
287 type
= EVP_PKEY_id(sigkey
);
288 if (type
== EVP_PKEY_ED25519
|| type
== EVP_PKEY_ED448
) {
290 * We implement PureEdDSA for these which doesn't have a separate
291 * digest, and only supports one shot.
293 BIO_printf(bio_err
, "Key type not supported for this operation\n");
298 if (mac_name
!= NULL
) {
299 EVP_PKEY_CTX
*mac_ctx
= NULL
;
301 if (!init_gen_str(&mac_ctx
, mac_name
, impl
, 0, NULL
, NULL
))
303 if (macopts
!= NULL
) {
305 for (i
= 0; i
< sk_OPENSSL_STRING_num(macopts
); i
++) {
306 macopt
= sk_OPENSSL_STRING_value(macopts
, i
);
307 if (pkey_ctrl_string(mac_ctx
, macopt
) <= 0) {
309 "MAC parameter error \"%s\"\n", macopt
);
310 ERR_print_errors(bio_err
);
315 if (EVP_PKEY_keygen(mac_ctx
, &sigkey
) <= 0) {
316 BIO_puts(bio_err
, "Error generating key\n");
317 ERR_print_errors(bio_err
);
322 EVP_PKEY_CTX_free(mac_ctx
);
327 if (hmac_key
!= NULL
) {
328 sigkey
= EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC
, impl
,
329 (unsigned char *)hmac_key
,
335 if (sigkey
!= NULL
) {
336 EVP_MD_CTX
*mctx
= NULL
;
337 EVP_PKEY_CTX
*pctx
= NULL
;
339 if (!BIO_get_md_ctx(bmd
, &mctx
)) {
340 BIO_printf(bio_err
, "Error getting context\n");
341 ERR_print_errors(bio_err
);
345 r
= EVP_DigestVerifyInit(mctx
, &pctx
, md
, impl
, sigkey
);
347 r
= EVP_DigestSignInit(mctx
, &pctx
, md
, impl
, sigkey
);
349 BIO_printf(bio_err
, "Error setting context\n");
350 ERR_print_errors(bio_err
);
353 if (sigopts
!= NULL
) {
355 for (i
= 0; i
< sk_OPENSSL_STRING_num(sigopts
); i
++) {
356 sigopt
= sk_OPENSSL_STRING_value(sigopts
, i
);
357 if (pkey_ctrl_string(pctx
, sigopt
) <= 0) {
358 BIO_printf(bio_err
, "parameter error \"%s\"\n", sigopt
);
359 ERR_print_errors(bio_err
);
365 /* we use md as a filter, reading from 'in' */
367 EVP_MD_CTX
*mctx
= NULL
;
368 if (!BIO_get_md_ctx(bmd
, &mctx
)) {
369 BIO_printf(bio_err
, "Error getting context\n");
370 ERR_print_errors(bio_err
);
375 if (!EVP_DigestInit_ex(mctx
, md
, impl
)) {
376 BIO_printf(bio_err
, "Error setting digest\n");
377 ERR_print_errors(bio_err
);
382 if (sigfile
!= NULL
&& sigkey
!= NULL
) {
383 BIO
*sigbio
= BIO_new_file(sigfile
, "rb");
384 if (sigbio
== NULL
) {
385 BIO_printf(bio_err
, "Error opening signature file %s\n", sigfile
);
386 ERR_print_errors(bio_err
);
389 siglen
= EVP_PKEY_size(sigkey
);
390 sigbuf
= app_malloc(siglen
, "signature buffer");
391 siglen
= BIO_read(sigbio
, sigbuf
, siglen
);
394 BIO_printf(bio_err
, "Error reading signature file %s\n", sigfile
);
395 ERR_print_errors(bio_err
);
399 inp
= BIO_push(bmd
, in
);
403 BIO_get_md_ctx(bmd
, &tctx
);
404 md
= EVP_MD_CTX_md(tctx
);
407 md_name
= EVP_MD_name(md
);
410 if (!(EVP_MD_flags(md
) & EVP_MD_FLAG_XOF
)) {
411 BIO_printf(bio_err
, "Length can only be specified for XOF\n");
414 if (sigkey
!= NULL
) {
415 BIO_printf(bio_err
, "Signing key cannot be specified for XOF\n");
421 BIO_set_fp(in
, stdin
, BIO_NOCLOSE
);
422 ret
= do_fp(out
, buf
, inp
, separator
, out_bin
, xoflen
, sigkey
, sigbuf
,
423 siglen
, NULL
, md_name
, "stdin");
425 const char *sig_name
= NULL
;
428 sig_name
= EVP_PKEY_get0_first_alg_name(sigkey
);
431 for (i
= 0; i
< argc
; i
++) {
433 if (BIO_read_filename(in
, argv
[i
]) <= 0) {
438 r
= do_fp(out
, buf
, inp
, separator
, out_bin
, xoflen
,
439 sigkey
, sigbuf
, siglen
, sig_name
, md_name
, argv
[i
]);
443 (void)BIO_reset(bmd
);
447 OPENSSL_clear_free(buf
, BUFSIZE
);
449 OPENSSL_free(passin
);
451 EVP_PKEY_free(sigkey
);
452 sk_OPENSSL_STRING_free(sigopts
);
453 sk_OPENSSL_STRING_free(macopts
);
454 OPENSSL_free(sigbuf
);
460 static void show_digests(const OBJ_NAME
*name
, void *arg
)
462 struct doall_dgst_digests
*dec
= (struct doall_dgst_digests
*)arg
;
463 const EVP_MD
*md
= NULL
;
465 /* Filter out signed digests (a.k.a signature algorithms) */
466 if (strstr(name
->name
, "rsa") != NULL
|| strstr(name
->name
, "RSA") != NULL
)
469 if (!islower((unsigned char)*name
->name
))
472 /* Filter out message digests that we cannot use */
473 md
= EVP_get_digestbyname(name
->name
);
477 BIO_printf(dec
->bio
, "-%-25s", name
->name
);
479 BIO_printf(dec
->bio
, "\n");
482 BIO_printf(dec
->bio
, " ");
487 * The newline_escape_filename function performs newline escaping for any
488 * filename that contains a newline. This function also takes a pointer
489 * to backslash. The backslash pointer is a flag to indicating whether a newline
490 * is present in the filename. If a newline is present, the backslash flag is
491 * set and the output format will contain a backslash at the beginning of the
492 * digest output. This output format is to replicate the output format found
493 * in the '*sum' checksum programs. This aims to preserve backward
496 static const char *newline_escape_filename(const char *file
, int * backslash
)
498 size_t i
, e
= 0, length
= strlen(file
), newline_count
= 0, mem_len
= 0;
499 char *file_cpy
= NULL
;
501 for (i
= 0; i
< length
; i
++)
505 mem_len
= length
+ newline_count
+ 1;
506 file_cpy
= app_malloc(mem_len
, file
);
510 const char c
= file
[e
];
512 file_cpy
[i
++] = '\\';
521 return (const char*)file_cpy
;
525 int do_fp(BIO
*out
, unsigned char *buf
, BIO
*bp
, int sep
, int binout
, int xoflen
,
526 EVP_PKEY
*key
, unsigned char *sigin
, int siglen
,
527 const char *sig_name
, const char *md_name
,
530 size_t len
= BUFSIZE
;
531 int i
, backslash
= 0, ret
= 1;
532 unsigned char *allocated_buf
= NULL
;
534 while (BIO_pending(bp
) || !BIO_eof(bp
)) {
535 i
= BIO_read(bp
, (char *)buf
, BUFSIZE
);
537 BIO_printf(bio_err
, "Read Error in %s\n", file
);
538 ERR_print_errors(bio_err
);
546 BIO_get_md_ctx(bp
, &ctx
);
547 i
= EVP_DigestVerifyFinal(ctx
, sigin
, (unsigned int)siglen
);
549 BIO_printf(out
, "Verified OK\n");
551 BIO_printf(out
, "Verification Failure\n");
554 BIO_printf(bio_err
, "Error Verifying Data\n");
555 ERR_print_errors(bio_err
);
565 BIO_get_md_ctx(bp
, &ctx
);
566 if (!EVP_DigestSignFinal(ctx
, NULL
, &tmplen
)) {
567 BIO_printf(bio_err
, "Error Signing Data\n");
568 ERR_print_errors(bio_err
);
571 if (tmplen
> BUFSIZE
) {
573 allocated_buf
= app_malloc(len
, "Signature buffer");
576 if (!EVP_DigestSignFinal(ctx
, buf
, &len
)) {
577 BIO_printf(bio_err
, "Error Signing Data\n");
578 ERR_print_errors(bio_err
);
581 } else if (xoflen
> 0) {
586 allocated_buf
= app_malloc(len
, "Digest buffer");
590 BIO_get_md_ctx(bp
, &ctx
);
592 if (!EVP_DigestFinalXOF(ctx
, buf
, len
)) {
593 BIO_printf(bio_err
, "Error Digesting Data\n");
594 ERR_print_errors(bio_err
);
598 len
= BIO_gets(bp
, (char *)buf
, BUFSIZE
);
600 ERR_print_errors(bio_err
);
606 BIO_write(out
, buf
, len
);
607 } else if (sep
== 2) {
608 file
= newline_escape_filename(file
, &backslash
);
613 for (i
= 0; i
< (int)len
; i
++)
614 BIO_printf(out
, "%02x", buf
[i
]);
616 BIO_printf(out
, " *%s\n", file
);
617 OPENSSL_free((char *)file
);
619 if (sig_name
!= NULL
) {
620 BIO_puts(out
, sig_name
);
622 BIO_printf(out
, "-%s", md_name
);
623 BIO_printf(out
, "(%s)= ", file
);
624 } else if (md_name
!= NULL
) {
625 BIO_printf(out
, "%s(%s)= ", md_name
, file
);
627 BIO_printf(out
, "(%s)= ", file
);
629 for (i
= 0; i
< (int)len
; i
++) {
631 BIO_printf(out
, ":");
632 BIO_printf(out
, "%02x", buf
[i
]);
634 BIO_printf(out
, "\n");
639 if (allocated_buf
!= NULL
)
640 OPENSSL_clear_free(allocated_buf
, len
);