2 * Copyright 1995-2018 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>
24 #define BUFSIZE 1024*8
26 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
27 EVP_PKEY *key, unsigned char *sigin, int siglen,
28 const char *sig_name, const char *md_name,
31 typedef enum OPTION_choice {
32 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
33 OPT_C, OPT_R, OPT_OUT, OPT_SIGN, OPT_PASSIN, OPT_VERIFY,
34 OPT_PRVERIFY, OPT_SIGNATURE, OPT_KEYFORM, OPT_ENGINE, OPT_ENGINE_IMPL,
35 OPT_HEX, OPT_BINARY, OPT_DEBUG, OPT_FIPS_FINGERPRINT,
36 OPT_HMAC, OPT_MAC, OPT_SIGOPT, OPT_MACOPT,
41 const OPTIONS dgst_options[] = {
42 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
43 {OPT_HELP_STR, 1, '-',
44 " file... files to digest (default is stdin)\n"},
45 {"help", OPT_HELP, '-', "Display this summary"},
46 {"c", OPT_C, '-', "Print the digest with separating colons"},
47 {"r", OPT_R, '-', "Print the digest in coreutils format"},
48 {"out", OPT_OUT, '>', "Output to filename rather than stdout"},
49 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
50 {"sign", OPT_SIGN, 's', "Sign digest using private key"},
51 {"verify", OPT_VERIFY, 's',
52 "Verify a signature using public key"},
53 {"prverify", OPT_PRVERIFY, 's',
54 "Verify a signature using private key"},
55 {"signature", OPT_SIGNATURE, '<', "File with signature to verify"},
56 {"keyform", OPT_KEYFORM, 'f', "Key file format (PEM or ENGINE)"},
57 {"hex", OPT_HEX, '-', "Print as hex dump"},
58 {"binary", OPT_BINARY, '-', "Print in binary form"},
59 {"d", OPT_DEBUG, '-', "Print debug info"},
60 {"debug", OPT_DEBUG, '-', "Print debug info"},
61 {"fips-fingerprint", OPT_FIPS_FINGERPRINT, '-',
62 "Compute HMAC with the key used in OpenSSL-FIPS fingerprint"},
63 {"hmac", OPT_HMAC, 's', "Create hashed MAC with key"},
64 {"mac", OPT_MAC, 's', "Create MAC (not necessarily HMAC)"},
65 {"sigopt", OPT_SIGOPT, 's', "Signature parameter in n:v form"},
66 {"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form or key"},
67 {"", OPT_DIGEST, '-', "Any supported digest"},
69 #ifndef OPENSSL_NO_ENGINE
70 {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
71 {"engine_impl", OPT_ENGINE_IMPL, '-',
72 "Also use engine given by -engine for digest operations"},
77 int dgst_main(int argc, char **argv)
79 BIO *in = NULL, *inp, *bmd = NULL, *out = NULL;
80 ENGINE *e = NULL, *impl = NULL;
81 EVP_PKEY *sigkey = NULL;
82 STACK_OF(OPENSSL_STRING) *sigopts = NULL, *macopts = NULL;
83 char *hmac_key = NULL;
84 char *mac_name = NULL;
85 char *passinarg = NULL, *passin = NULL;
86 const EVP_MD *md = NULL, *m;
87 const char *outfile = NULL, *keyfile = NULL, *prog = NULL;
88 const char *sigfile = NULL;
89 const char *md_name = NULL;
91 int separator = 0, debug = 0, keyform = FORMAT_PEM, siglen = 0;
92 int i, ret = 1, out_bin = -1, want_pub = 0, do_verify = 0;
93 unsigned char *buf = NULL, *sigbuf = NULL;
96 prog = opt_progname(argv[0]);
97 buf = app_malloc(BUFSIZE, "I/O buffer");
98 md = EVP_get_digestbyname(prog);
100 prog = opt_init(argc, argv, dgst_options);
101 while ((o = opt_next()) != OPT_EOF) {
106 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
109 opt_help(dgst_options);
129 passinarg = opt_arg();
133 want_pub = do_verify = 1;
143 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
147 e = setup_engine(opt_arg(), 0);
149 case OPT_ENGINE_IMPL:
161 case OPT_FIPS_FINGERPRINT:
162 hmac_key = "etaonrishdlcupfm";
165 hmac_key = opt_arg();
168 mac_name = opt_arg();
172 sigopts = sk_OPENSSL_STRING_new_null();
173 if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
178 macopts = sk_OPENSSL_STRING_new_null();
179 if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
183 if (!opt_md(opt_unknown(), &m))
189 argc = opt_num_rest();
191 if (keyfile != NULL && argc > 1) {
192 BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
196 if (do_verify && sigfile == NULL) {
198 "No signature to verify: use the -signature option\n");
204 in = BIO_new(BIO_s_file());
205 bmd = BIO_new(BIO_f_md());
206 if ((in == NULL) || (bmd == NULL)) {
207 ERR_print_errors(bio_err);
212 BIO_set_callback(in, BIO_debug_callback);
213 /* needed for windows 3.1 */
214 BIO_set_callback_arg(in, (char *)bio_err);
217 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
218 BIO_printf(bio_err, "Error getting password\n");
229 out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
233 if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
234 BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
238 if (keyfile != NULL) {
242 sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
244 sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
245 if (sigkey == NULL) {
247 * load_[pub]key() has already printed an appropriate message
251 type = EVP_PKEY_id(sigkey);
252 if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
254 * We implement PureEdDSA for these which doesn't have a separate
255 * digest, and only supports one shot.
257 BIO_printf(bio_err, "Key type not supported for this operation\n");
262 if (mac_name != NULL) {
263 EVP_PKEY_CTX *mac_ctx = NULL;
265 if (!init_gen_str(&mac_ctx, mac_name, impl, 0))
267 if (macopts != NULL) {
269 for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
270 macopt = sk_OPENSSL_STRING_value(macopts, i);
271 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
273 "MAC parameter error \"%s\"\n", macopt);
274 ERR_print_errors(bio_err);
279 if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
280 BIO_puts(bio_err, "Error generating key\n");
281 ERR_print_errors(bio_err);
286 EVP_PKEY_CTX_free(mac_ctx);
291 if (hmac_key != NULL) {
292 sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
293 (unsigned char *)hmac_key, -1);
298 if (sigkey != NULL) {
299 EVP_MD_CTX *mctx = NULL;
300 EVP_PKEY_CTX *pctx = NULL;
302 if (!BIO_get_md_ctx(bmd, &mctx)) {
303 BIO_printf(bio_err, "Error getting context\n");
304 ERR_print_errors(bio_err);
308 r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
310 r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
312 BIO_printf(bio_err, "Error setting context\n");
313 ERR_print_errors(bio_err);
316 if (sigopts != NULL) {
318 for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
319 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
320 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
321 BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
322 ERR_print_errors(bio_err);
328 /* we use md as a filter, reading from 'in' */
330 EVP_MD_CTX *mctx = NULL;
331 if (!BIO_get_md_ctx(bmd, &mctx)) {
332 BIO_printf(bio_err, "Error getting context\n");
333 ERR_print_errors(bio_err);
338 if (!EVP_DigestInit_ex(mctx, md, impl)) {
339 BIO_printf(bio_err, "Error setting digest\n");
340 ERR_print_errors(bio_err);
345 if (sigfile != NULL && sigkey != NULL) {
346 BIO *sigbio = BIO_new_file(sigfile, "rb");
347 if (sigbio == NULL) {
348 BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
349 ERR_print_errors(bio_err);
352 siglen = EVP_PKEY_size(sigkey);
353 sigbuf = app_malloc(siglen, "signature buffer");
354 siglen = BIO_read(sigbio, sigbuf, siglen);
357 BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
358 ERR_print_errors(bio_err);
362 inp = BIO_push(bmd, in);
366 BIO_get_md_ctx(bmd, &tctx);
367 md = EVP_MD_CTX_md(tctx);
370 md_name = EVP_MD_name(md);
373 BIO_set_fp(in, stdin, BIO_NOCLOSE);
374 ret = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
375 siglen, NULL, md_name, "stdin");
377 const char *sig_name = NULL;
379 if (sigkey != NULL) {
380 const EVP_PKEY_ASN1_METHOD *ameth;
381 ameth = EVP_PKEY_get0_asn1(sigkey);
383 EVP_PKEY_asn1_get0_info(NULL, NULL,
384 NULL, NULL, &sig_name, ameth);
388 for (i = 0; i < argc; i++) {
390 if (BIO_read_filename(in, argv[i]) <= 0) {
395 r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
396 siglen, sig_name, md_name, argv[i]);
400 (void)BIO_reset(bmd);
404 OPENSSL_clear_free(buf, BUFSIZE);
406 OPENSSL_free(passin);
408 EVP_PKEY_free(sigkey);
409 sk_OPENSSL_STRING_free(sigopts);
410 sk_OPENSSL_STRING_free(macopts);
411 OPENSSL_free(sigbuf);
418 * The newline_escape_filename function performs newline escaping for any
419 * filename that contains a newline. This function also takes a pointer
420 * to backslash. The backslash pointer is a flag to indicating whether a newline
421 * is present in the filename. If a newline is present, the backslash flag is
422 * set and the output format will contain a backslash at the beginning of the
423 * digest output. This output format is to replicate the output format found
424 * in the '*sum' checksum programs. This aims to preserve backward
427 static const char *newline_escape_filename(const char *file, int * backslash)
429 size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
430 char *file_cpy = NULL;
432 for (i = 0; i < length; i++)
436 mem_len = length + newline_count + 1;
437 file_cpy = app_malloc(mem_len, file);
441 const char c = file[e];
443 file_cpy[i++] = '\\';
452 return (const char*)file_cpy;
456 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
457 EVP_PKEY *key, unsigned char *sigin, int siglen,
458 const char *sig_name, const char *md_name,
462 int i, backslash = 0;
464 while (BIO_pending(bp) || !BIO_eof(bp)) {
465 i = BIO_read(bp, (char *)buf, BUFSIZE);
467 BIO_printf(bio_err, "Read Error in %s\n", file);
468 ERR_print_errors(bio_err);
476 BIO_get_md_ctx(bp, &ctx);
477 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
479 BIO_printf(out, "Verified OK\n");
481 BIO_printf(out, "Verification Failure\n");
484 BIO_printf(bio_err, "Error Verifying Data\n");
485 ERR_print_errors(bio_err);
492 BIO_get_md_ctx(bp, &ctx);
494 if (!EVP_DigestSignFinal(ctx, buf, &len)) {
495 BIO_printf(bio_err, "Error Signing Data\n");
496 ERR_print_errors(bio_err);
500 len = BIO_gets(bp, (char *)buf, BUFSIZE);
502 ERR_print_errors(bio_err);
508 BIO_write(out, buf, len);
509 } else if (sep == 2) {
510 file = newline_escape_filename(file, &backslash);
515 for (i = 0; i < (int)len; i++)
516 BIO_printf(out, "%02x", buf[i]);
518 BIO_printf(out, " *%s\n", file);
519 OPENSSL_free((char *)file);
521 if (sig_name != NULL) {
522 BIO_puts(out, sig_name);
524 BIO_printf(out, "-%s", md_name);
525 BIO_printf(out, "(%s)= ", file);
526 } else if (md_name != NULL) {
527 BIO_printf(out, "%s(%s)= ", md_name, file);
529 BIO_printf(out, "(%s)= ", file);
531 for (i = 0; i < (int)len; i++) {
533 BIO_printf(out, ":");
534 BIO_printf(out, "%02x", buf[i]);
536 BIO_printf(out, "\n");