Invoke tear_down when exiting test_encode_tls_sct() prematurely
[openssl.git] / apps / dgst.c
1 /*
2  * Copyright 1995-2020 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_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,
44     OPT_DIGEST,
45     OPT_R_ENUM, OPT_PROV_ENUM
46 } OPTION_CHOICE;
47
48 const OPTIONS dgst_options[] = {
49     {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
50
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"},
58 #endif
59     {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
60
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"},
71
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"},
84
85     OPT_R_OPTIONS,
86     OPT_PROV_OPTIONS,
87
88     OPT_PARAMETERS(),
89     {"file", 0, 0, "Files to digest (optional; default is stdin)"},
90     {NULL}
91 };
92
93 int dgst_main(int argc, char **argv)
94 {
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;
106     OPTION_CHOICE o;
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;
109     int xoflen = 0;
110     unsigned char *buf = NULL, *sigbuf = NULL;
111     int engine_impl = 0;
112     struct doall_dgst_digests dec;
113
114     prog = opt_progname(argv[0]);
115     buf = app_malloc(BUFSIZE, "I/O buffer");
116     md = EVP_get_digestbyname(prog);
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 = 0;
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 = 0;
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             if (!opt_md(opt_unknown(), &m))
214                 goto opthelp;
215             md = m;
216             break;
217         case OPT_PROV_CASES:
218             if (!opt_provider(o))
219                 goto end;
220             break;
221         }
222     }
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
230     if (do_verify && sigfile == NULL) {
231         BIO_printf(bio_err,
232                    "No signature to verify: use the -signature option\n");
233         goto end;
234     }
235     if (engine_impl)
236         impl = e;
237
238     in = BIO_new(BIO_s_file());
239     bmd = BIO_new(BIO_f_md());
240     if ((in == NULL) || (bmd == NULL)) {
241         ERR_print_errors(bio_err);
242         goto end;
243     }
244
245     if (debug) {
246         BIO_set_callback(in, BIO_debug_callback);
247         /* needed for windows 3.1 */
248         BIO_set_callback_arg(in, (char *)bio_err);
249     }
250
251     if (!app_passwd(passinarg, NULL, &passin, NULL)) {
252         BIO_printf(bio_err, "Error getting password\n");
253         goto end;
254     }
255
256     if (out_bin == -1) {
257         if (keyfile != NULL)
258             out_bin = 1;
259         else
260             out_bin = 0;
261     }
262
263     out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
264     if (out == NULL)
265         goto end;
266
267     if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
268         BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
269         goto end;
270     }
271
272     if (keyfile != NULL) {
273         int type;
274
275         if (want_pub)
276             sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "public key");
277         else
278             sigkey = load_key(keyfile, keyform, 0, passin, e, "private key");
279         if (sigkey == NULL) {
280             /*
281              * load_[pub]key() has already printed an appropriate message
282              */
283             goto end;
284         }
285         type = EVP_PKEY_id(sigkey);
286         if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
287             /*
288              * We implement PureEdDSA for these which doesn't have a separate
289              * digest, and only supports one shot.
290              */
291             BIO_printf(bio_err, "Key type not supported for this operation\n");
292             goto end;
293         }
294     }
295
296     if (mac_name != NULL) {
297         EVP_PKEY_CTX *mac_ctx = NULL;
298         int r = 0;
299         if (!init_gen_str(&mac_ctx, mac_name, impl, 0, NULL, NULL))
300             goto mac_end;
301         if (macopts != NULL) {
302             char *macopt;
303             for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
304                 macopt = sk_OPENSSL_STRING_value(macopts, i);
305                 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
306                     BIO_printf(bio_err,
307                                "MAC parameter error \"%s\"\n", macopt);
308                     ERR_print_errors(bio_err);
309                     goto mac_end;
310                 }
311             }
312         }
313         if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
314             BIO_puts(bio_err, "Error generating key\n");
315             ERR_print_errors(bio_err);
316             goto mac_end;
317         }
318         r = 1;
319  mac_end:
320         EVP_PKEY_CTX_free(mac_ctx);
321         if (r == 0)
322             goto end;
323     }
324
325     if (hmac_key != NULL) {
326         sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
327                                               (unsigned char *)hmac_key,
328                                               strlen(hmac_key));
329         if (sigkey == NULL)
330             goto end;
331     }
332
333     if (sigkey != NULL) {
334         EVP_MD_CTX *mctx = NULL;
335         EVP_PKEY_CTX *pctx = NULL;
336         int r;
337         if (!BIO_get_md_ctx(bmd, &mctx)) {
338             BIO_printf(bio_err, "Error getting context\n");
339             ERR_print_errors(bio_err);
340             goto end;
341         }
342         if (do_verify)
343             r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
344         else
345             r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
346         if (!r) {
347             BIO_printf(bio_err, "Error setting context\n");
348             ERR_print_errors(bio_err);
349             goto end;
350         }
351         if (sigopts != NULL) {
352             char *sigopt;
353             for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
354                 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
355                 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
356                     BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
357                     ERR_print_errors(bio_err);
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)) {
367             BIO_printf(bio_err, "Error getting context\n");
368             ERR_print_errors(bio_err);
369             goto end;
370         }
371         if (md == NULL)
372             md = EVP_sha256();
373         if (!EVP_DigestInit_ex(mctx, md, impl)) {
374             BIO_printf(bio_err, "Error setting digest\n");
375             ERR_print_errors(bio_err);
376             goto end;
377         }
378     }
379
380     if (sigfile != NULL && sigkey != NULL) {
381         BIO *sigbio = BIO_new_file(sigfile, "rb");
382         if (sigbio == NULL) {
383             BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
384             ERR_print_errors(bio_err);
385             goto end;
386         }
387         siglen = EVP_PKEY_size(sigkey);
388         sigbuf = app_malloc(siglen, "signature buffer");
389         siglen = BIO_read(sigbio, sigbuf, siglen);
390         BIO_free(sigbio);
391         if (siglen <= 0) {
392             BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
393             ERR_print_errors(bio_err);
394             goto end;
395         }
396     }
397     inp = BIO_push(bmd, in);
398
399     if (md == NULL) {
400         EVP_MD_CTX *tctx;
401         BIO_get_md_ctx(bmd, &tctx);
402         md = EVP_MD_CTX_md(tctx);
403     }
404     if (md != NULL)
405         md_name = EVP_MD_name(md);
406
407     if (xoflen > 0) {
408         if (!(EVP_MD_flags(md) & EVP_MD_FLAG_XOF)) {
409             BIO_printf(bio_err, "Length can only be specified for XOF\n");
410             goto end;
411         }
412         if (sigkey != NULL) {
413             BIO_printf(bio_err, "Signing key cannot be specified for XOF\n");
414             goto end;
415         }
416     }
417
418     if (argc == 0) {
419         BIO_set_fp(in, stdin, BIO_NOCLOSE);
420         ret = do_fp(out, buf, inp, separator, out_bin, xoflen, sigkey, sigbuf,
421                     siglen, NULL, md_name, "stdin");
422     } else {
423         const char *sig_name = NULL;
424         if (!out_bin) {
425             if (sigkey != NULL)
426                 sig_name = EVP_PKEY_get0_first_alg_name(sigkey);
427         }
428         ret = 0;
429         for (i = 0; i < argc; i++) {
430             int r;
431             if (BIO_read_filename(in, argv[i]) <= 0) {
432                 perror(argv[i]);
433                 ret++;
434                 continue;
435             } else {
436                 r = do_fp(out, buf, inp, separator, out_bin, xoflen,
437                           sigkey, sigbuf, siglen, sig_name, md_name, argv[i]);
438             }
439             if (r)
440                 ret = r;
441             (void)BIO_reset(bmd);
442         }
443     }
444  end:
445     OPENSSL_clear_free(buf, BUFSIZE);
446     BIO_free(in);
447     OPENSSL_free(passin);
448     BIO_free_all(out);
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 = 1;
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             ERR_print_errors(bio_err);
537             goto end;
538         }
539         if (i == 0)
540             break;
541     }
542     if (sigin != NULL) {
543         EVP_MD_CTX *ctx;
544         BIO_get_md_ctx(bp, &ctx);
545         i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
546         if (i > 0) {
547             BIO_printf(out, "Verified OK\n");
548         } else if (i == 0) {
549             BIO_printf(out, "Verification Failure\n");
550             goto end;
551         } else {
552             BIO_printf(bio_err, "Error Verifying Data\n");
553             ERR_print_errors(bio_err);
554             goto end;
555         }
556         ret = 0;
557         goto end;
558     }
559     if (key != NULL) {
560         EVP_MD_CTX *ctx;
561         size_t tmplen;
562
563         BIO_get_md_ctx(bp, &ctx);
564         if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
565             BIO_printf(bio_err, "Error Signing Data\n");
566             ERR_print_errors(bio_err);
567             goto end;
568         }
569         if (tmplen > BUFSIZE) {
570             len = tmplen;
571             allocated_buf = app_malloc(len, "Signature buffer");
572             buf = allocated_buf;
573         }
574         if (!EVP_DigestSignFinal(ctx, buf, &len)) {
575             BIO_printf(bio_err, "Error Signing Data\n");
576             ERR_print_errors(bio_err);
577             goto end;
578         }
579     } else if (xoflen > 0) {
580         EVP_MD_CTX *ctx;
581
582         len = xoflen;
583         if (len > BUFSIZE) {
584             allocated_buf = app_malloc(len, "Digest buffer");
585             buf = allocated_buf;
586         }
587
588         BIO_get_md_ctx(bp, &ctx);
589
590         if (!EVP_DigestFinalXOF(ctx, buf, len)) {
591             BIO_printf(bio_err, "Error Digesting Data\n");
592             ERR_print_errors(bio_err);
593             goto end;
594         }
595     } else {
596         len = BIO_gets(bp, (char *)buf, BUFSIZE);
597         if ((int)len < 0) {
598             ERR_print_errors(bio_err);
599             goto end;
600         }
601     }
602
603     if (binout) {
604         BIO_write(out, buf, len);
605     } else if (sep == 2) {
606         file = newline_escape_filename(file, &backslash);
607
608         if (backslash == 1)
609             BIO_puts(out, "\\");
610
611         for (i = 0; i < (int)len; i++)
612             BIO_printf(out, "%02x", buf[i]);
613
614         BIO_printf(out, " *%s\n", file);
615         OPENSSL_free((char *)file);
616     } else {
617         if (sig_name != NULL) {
618             BIO_puts(out, sig_name);
619             if (md_name != NULL)
620                 BIO_printf(out, "-%s", md_name);
621             BIO_printf(out, "(%s)= ", file);
622         } else if (md_name != NULL) {
623             BIO_printf(out, "%s(%s)= ", md_name, file);
624         } else {
625             BIO_printf(out, "(%s)= ", file);
626         }
627         for (i = 0; i < (int)len; i++) {
628             if (sep && (i != 0))
629                 BIO_printf(out, ":");
630             BIO_printf(out, "%02x", buf[i]);
631         }
632         BIO_printf(out, "\n");
633     }
634
635     ret = 0;
636  end:
637     if (allocated_buf != NULL)
638         OPENSSL_clear_free(allocated_buf, len);
639
640     return ret;
641 }