]>
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
{
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
,
46 OPT_R_ENUM
, OPT_PROV_ENUM
49 const OPTIONS dgst_options
[] = {
50 {OPT_HELP_STR
, 1, '-', "Usage: %s [options] [file...]\n"},
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"},
60 {"passin", OPT_PASSIN
, 's', "Input file pass phrase source"},
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"},
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"},
90 {"file", 0, 0, "Files to digest (optional; default is stdin)"},
94 int dgst_main(int argc
, char **argv
)
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
;
104 const char *outfile
= NULL
, *keyfile
= NULL
, *prog
= NULL
;
105 const char *sigfile
= NULL
;
106 const char *md_name
= NULL
;
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;
111 unsigned char *buf
= NULL
, *sigbuf
= NULL
;
113 struct doall_dgst_digests dec
;
115 buf
= app_malloc(BUFSIZE
, "I/O buffer");
116 md
= (EVP_MD
*)EVP_get_digestbyname(argv
[0]);
118 opt_set_unknown_name("digest");
119 prog
= opt_init(argc
, argv
, dgst_options
);
120 while ((o
= opt_next()) != OPT_EOF
) {
125 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
128 opt_help(dgst_options
);
132 BIO_printf(bio_out
, "Supported digests:\n");
135 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH
,
137 BIO_printf(bio_out
, "\n");
157 passinarg
= opt_arg();
161 want_pub
= do_verify
= 1;
171 if (!opt_format(opt_arg(), OPT_FMT_ANY
, &keyform
))
175 e
= setup_engine(opt_arg(), 0);
177 case OPT_ENGINE_IMPL
:
187 xoflen
= atoi(opt_arg());
192 case OPT_FIPS_FINGERPRINT
:
193 hmac_key
= "etaonrishdlcupfm";
196 hmac_key
= opt_arg();
199 mac_name
= opt_arg();
203 sigopts
= sk_OPENSSL_STRING_new_null();
204 if (!sigopts
|| !sk_OPENSSL_STRING_push(sigopts
, opt_arg()))
209 macopts
= sk_OPENSSL_STRING_new_null();
210 if (!macopts
|| !sk_OPENSSL_STRING_push(macopts
, opt_arg()))
214 digestname
= opt_unknown();
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
);
230 if (!app_RAND_load())
233 if (digestname
!= NULL
) {
234 if (!opt_md(digestname
, &md
))
238 if (do_verify
&& sigfile
== NULL
) {
240 "No signature to verify: use the -signature option\n");
246 in
= BIO_new(BIO_s_file());
247 bmd
= BIO_new(BIO_f_md());
248 if (in
== NULL
|| bmd
== NULL
)
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
);
257 if (!app_passwd(passinarg
, NULL
, &passin
, NULL
)) {
258 BIO_printf(bio_err
, "Error getting password\n");
269 out
= bio_open_default(outfile
, 'w', out_bin
? FORMAT_BINARY
: FORMAT_TEXT
);
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");
278 if (keyfile
!= NULL
) {
282 sigkey
= load_pubkey(keyfile
, keyform
, 0, NULL
, e
, "public key");
284 sigkey
= load_key(keyfile
, keyform
, 0, passin
, e
, "private key");
285 if (sigkey
== NULL
) {
287 * load_[pub]key() has already printed an appropriate message
291 type
= EVP_PKEY_get_id(sigkey
);
292 if (type
== EVP_PKEY_ED25519
|| type
== EVP_PKEY_ED448
) {
294 * We implement PureEdDSA for these which doesn't have a separate
295 * digest, and only supports one shot.
297 BIO_printf(bio_err
, "Key type not supported for this operation\n");
302 if (mac_name
!= NULL
) {
303 EVP_PKEY_CTX
*mac_ctx
= NULL
;
305 if (!init_gen_str(&mac_ctx
, mac_name
, impl
, 0, NULL
, NULL
))
307 if (macopts
!= NULL
) {
308 for (i
= 0; i
< sk_OPENSSL_STRING_num(macopts
); i
++) {
309 char *macopt
= sk_OPENSSL_STRING_value(macopts
, i
);
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
);
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
);
324 if (hmac_key
!= NULL
) {
326 md
= (EVP_MD
*)EVP_sha256();
327 sigkey
= EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC
, impl
,
328 (unsigned char *)hmac_key
,
334 if (sigkey
!= NULL
) {
335 EVP_MD_CTX
*mctx
= NULL
;
336 EVP_PKEY_CTX
*pctx
= NULL
;
339 if (BIO_get_md_ctx(bmd
, &mctx
) <= 0) {
340 BIO_printf(bio_err
, "Error getting context\n");
344 res
= EVP_DigestVerifyInit(mctx
, &pctx
, md
, impl
, sigkey
);
346 res
= EVP_DigestSignInit(mctx
, &pctx
, md
, impl
, sigkey
);
348 BIO_printf(bio_err
, "Error setting context\n");
351 if (sigopts
!= NULL
) {
352 for (i
= 0; i
< sk_OPENSSL_STRING_num(sigopts
); i
++) {
353 char *sigopt
= sk_OPENSSL_STRING_value(sigopts
, i
);
355 if (pkey_ctrl_string(pctx
, sigopt
) <= 0) {
356 BIO_printf(bio_err
, "Signature parameter error \"%s\"\n",
363 /* we use md as a filter, reading from 'in' */
365 EVP_MD_CTX
*mctx
= NULL
;
366 if (BIO_get_md_ctx(bmd
, &mctx
) <= 0) {
367 BIO_printf(bio_err
, "Error getting context\n");
371 md
= (EVP_MD
*)EVP_sha256();
372 if (!EVP_DigestInit_ex(mctx
, md
, impl
)) {
373 BIO_printf(bio_err
, "Error setting digest\n");
378 if (sigfile
!= NULL
&& sigkey
!= NULL
) {
379 BIO
*sigbio
= BIO_new_file(sigfile
, "rb");
381 if (sigbio
== NULL
) {
382 BIO_printf(bio_err
, "Error opening signature file %s\n", sigfile
);
385 siglen
= EVP_PKEY_get_size(sigkey
);
386 sigbuf
= app_malloc(siglen
, "signature buffer");
387 siglen
= BIO_read(sigbio
, sigbuf
, siglen
);
390 BIO_printf(bio_err
, "Error reading signature file %s\n", sigfile
);
394 inp
= BIO_push(bmd
, in
);
399 BIO_get_md_ctx(bmd
, &tctx
);
400 md
= EVP_MD_CTX_get1_md(tctx
);
403 md_name
= EVP_MD_get0_name(md
);
406 if (!(EVP_MD_get_flags(md
) & EVP_MD_FLAG_XOF
)) {
407 BIO_printf(bio_err
, "Length can only be specified for XOF\n");
410 if (sigkey
!= NULL
) {
411 BIO_printf(bio_err
, "Signing key cannot be specified for XOF\n");
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");
421 const char *sig_name
= NULL
;
425 sig_name
= EVP_PKEY_get0_type_name(sigkey
);
428 for (i
= 0; i
< argc
; i
++) {
429 if (BIO_read_filename(in
, argv
[i
]) <= 0) {
434 if (do_fp(out
, buf
, inp
, separator
, out_bin
, xoflen
,
435 sigkey
, sigbuf
, siglen
, sig_name
, md_name
, argv
[i
]))
438 (void)BIO_reset(bmd
);
442 if (ret
!= EXIT_SUCCESS
)
443 ERR_print_errors(bio_err
);
444 OPENSSL_clear_free(buf
, BUFSIZE
);
446 OPENSSL_free(passin
);
449 EVP_PKEY_free(sigkey
);
450 sk_OPENSSL_STRING_free(sigopts
);
451 sk_OPENSSL_STRING_free(macopts
);
452 OPENSSL_free(sigbuf
);
458 static void show_digests(const OBJ_NAME
*name
, void *arg
)
460 struct doall_dgst_digests
*dec
= (struct doall_dgst_digests
*)arg
;
461 const EVP_MD
*md
= NULL
;
463 /* Filter out signed digests (a.k.a signature algorithms) */
464 if (strstr(name
->name
, "rsa") != NULL
|| strstr(name
->name
, "RSA") != NULL
)
467 if (!islower((unsigned char)*name
->name
))
470 /* Filter out message digests that we cannot use */
471 md
= EVP_get_digestbyname(name
->name
);
475 BIO_printf(dec
->bio
, "-%-25s", name
->name
);
477 BIO_printf(dec
->bio
, "\n");
480 BIO_printf(dec
->bio
, " ");
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
494 static const char *newline_escape_filename(const char *file
, int * backslash
)
496 size_t i
, e
= 0, length
= strlen(file
), newline_count
= 0, mem_len
= 0;
497 char *file_cpy
= NULL
;
499 for (i
= 0; i
< length
; i
++)
503 mem_len
= length
+ newline_count
+ 1;
504 file_cpy
= app_malloc(mem_len
, file
);
508 const char c
= file
[e
];
510 file_cpy
[i
++] = '\\';
519 return (const char*)file_cpy
;
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
,
528 size_t len
= BUFSIZE
;
529 int i
, backslash
= 0, ret
= EXIT_FAILURE
;
530 unsigned char *allocated_buf
= NULL
;
532 while (BIO_pending(bp
) || !BIO_eof(bp
)) {
533 i
= BIO_read(bp
, (char *)buf
, BUFSIZE
);
535 BIO_printf(bio_err
, "Read error in %s\n", file
);
543 BIO_get_md_ctx(bp
, &ctx
);
544 i
= EVP_DigestVerifyFinal(ctx
, sigin
, (unsigned int)siglen
);
546 BIO_printf(out
, "Verified OK\n");
548 BIO_printf(out
, "Verification failure\n");
551 BIO_printf(bio_err
, "Error verifying data\n");
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");
566 if (tmplen
> BUFSIZE
) {
568 allocated_buf
= app_malloc(len
, "Signature buffer");
571 if (!EVP_DigestSignFinal(ctx
, buf
, &len
)) {
572 BIO_printf(bio_err
, "Error signing data\n");
575 } else if (xoflen
> 0) {
580 allocated_buf
= app_malloc(len
, "Digest buffer");
584 BIO_get_md_ctx(bp
, &ctx
);
586 if (!EVP_DigestFinalXOF(ctx
, buf
, len
)) {
587 BIO_printf(bio_err
, "Error Digesting Data\n");
591 len
= BIO_gets(bp
, (char *)buf
, BUFSIZE
);
597 BIO_write(out
, buf
, len
);
598 } else if (sep
== 2) {
599 file
= newline_escape_filename(file
, &backslash
);
604 for (i
= 0; i
< (int)len
; i
++)
605 BIO_printf(out
, "%02x", buf
[i
]);
607 BIO_printf(out
, " *%s\n", file
);
608 OPENSSL_free((char *)file
);
610 if (sig_name
!= NULL
) {
611 BIO_puts(out
, sig_name
);
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
);
618 BIO_printf(out
, "(%s)= ", file
);
620 for (i
= 0; i
< (int)len
; i
++) {
622 BIO_printf(out
, ":");
623 BIO_printf(out
, "%02x", buf
[i
]);
625 BIO_printf(out
, "\n");
630 if (allocated_buf
!= NULL
)
631 OPENSSL_clear_free(allocated_buf
, len
);