HTTP client: Fix cleanup of TLS BIO via 'bio_update_fn' callback function
[openssl.git] / apps / dgst.c
1 /*
2  * Copyright 1995-2021 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_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
49 const 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"},
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
94 int 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         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 res;
337
338         if (BIO_get_md_ctx(bmd, &mctx) <= 0) {
339             BIO_printf(bio_err, "Error getting context\n");
340             goto end;
341         }
342         if (do_verify)
343             res = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
344         else
345             res = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
346         if (res == 0) {
347             BIO_printf(bio_err, "Error setting context\n");
348             goto end;
349         }
350         if (sigopts != NULL) {
351             for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
352                 char *sigopt = sk_OPENSSL_STRING_value(sigopts, i);
353
354                 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
355                     BIO_printf(bio_err, "Signature parameter error \"%s\"\n",
356                                sigopt);
357                     goto end;
358                 }
359             }
360         }
361     }
362     /* we use md as a filter, reading from 'in' */
363     else {
364         EVP_MD_CTX *mctx = NULL;
365         if (BIO_get_md_ctx(bmd, &mctx) <= 0) {
366             BIO_printf(bio_err, "Error getting context\n");
367             goto end;
368         }
369         if (md == NULL)
370             md = (EVP_MD *)EVP_sha256();
371         if (!EVP_DigestInit_ex(mctx, md, impl)) {
372             BIO_printf(bio_err, "Error setting digest\n");
373             goto end;
374         }
375     }
376
377     if (sigfile != NULL && sigkey != NULL) {
378         BIO *sigbio = BIO_new_file(sigfile, "rb");
379
380         if (sigbio == NULL) {
381             BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
382             goto end;
383         }
384         siglen = EVP_PKEY_get_size(sigkey);
385         sigbuf = app_malloc(siglen, "signature buffer");
386         siglen = BIO_read(sigbio, sigbuf, siglen);
387         BIO_free(sigbio);
388         if (siglen <= 0) {
389             BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
390             goto end;
391         }
392     }
393     inp = BIO_push(bmd, in);
394
395     if (md == NULL) {
396         EVP_MD_CTX *tctx;
397
398         BIO_get_md_ctx(bmd, &tctx);
399         md = EVP_MD_CTX_get1_md(tctx);
400     }
401     if (md != NULL)
402         md_name = EVP_MD_get0_name(md);
403
404     if (xoflen > 0) {
405         if (!(EVP_MD_get_flags(md) & EVP_MD_FLAG_XOF)) {
406             BIO_printf(bio_err, "Length can only be specified for XOF\n");
407             goto end;
408         }
409         if (sigkey != NULL) {
410             BIO_printf(bio_err, "Signing key cannot be specified for XOF\n");
411             goto end;
412         }
413     }
414
415     if (argc == 0) {
416         BIO_set_fp(in, stdin, BIO_NOCLOSE);
417         ret = do_fp(out, buf, inp, separator, out_bin, xoflen, sigkey, sigbuf,
418                     siglen, NULL, md_name, "stdin");
419     } else {
420         const char *sig_name = NULL;
421
422         if (out_bin == 0) {
423             if (sigkey != NULL)
424                 sig_name = EVP_PKEY_get0_type_name(sigkey);
425         }
426         ret = EXIT_SUCCESS;
427         for (i = 0; i < argc; i++) {
428             if (BIO_read_filename(in, argv[i]) <= 0) {
429                 perror(argv[i]);
430                 ret = EXIT_FAILURE;
431                 continue;
432             } else {
433                 if (do_fp(out, buf, inp, separator, out_bin, xoflen,
434                           sigkey, sigbuf, siglen, sig_name, md_name, argv[i]))
435                     ret = EXIT_FAILURE;
436             }
437             (void)BIO_reset(bmd);
438         }
439     }
440  end:
441     if (ret != EXIT_SUCCESS)
442         ERR_print_errors(bio_err);
443     OPENSSL_clear_free(buf, BUFSIZE);
444     BIO_free(in);
445     OPENSSL_free(passin);
446     BIO_free_all(out);
447     EVP_MD_free(md);
448     EVP_PKEY_free(sigkey);
449     sk_OPENSSL_STRING_free(sigopts);
450     sk_OPENSSL_STRING_free(macopts);
451     OPENSSL_free(sigbuf);
452     BIO_free(bmd);
453     release_engine(e);
454     return ret;
455 }
456
457 static void show_digests(const OBJ_NAME *name, void *arg)
458 {
459     struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
460     const EVP_MD *md = NULL;
461
462     /* Filter out signed digests (a.k.a signature algorithms) */
463     if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
464         return;
465
466     if (!islower((unsigned char)*name->name))
467         return;
468
469     /* Filter out message digests that we cannot use */
470     md = EVP_get_digestbyname(name->name);
471     if (md == NULL)
472         return;
473
474     BIO_printf(dec->bio, "-%-25s", name->name);
475     if (++dec->n == 3) {
476         BIO_printf(dec->bio, "\n");
477         dec->n = 0;
478     } else {
479         BIO_printf(dec->bio, " ");
480     }
481 }
482
483 /*
484  * The newline_escape_filename function performs newline escaping for any
485  * filename that contains a newline.  This function also takes a pointer
486  * to backslash. The backslash pointer is a flag to indicating whether a newline
487  * is present in the filename.  If a newline is present, the backslash flag is
488  * set and the output format will contain a backslash at the beginning of the
489  * digest output. This output format is to replicate the output format found
490  * in the '*sum' checksum programs. This aims to preserve backward
491  * compatibility.
492  */
493 static const char *newline_escape_filename(const char *file, int * backslash)
494 {
495     size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
496     char *file_cpy = NULL;
497
498     for (i = 0; i < length; i++)
499         if (file[i] == '\n')
500             newline_count++;
501
502     mem_len = length + newline_count + 1;
503     file_cpy = app_malloc(mem_len, file);
504     i = 0;
505
506     while (e < length) {
507         const char c = file[e];
508         if (c == '\n') {
509             file_cpy[i++] = '\\';
510             file_cpy[i++] = 'n';
511             *backslash = 1;
512         } else {
513             file_cpy[i++] = c;
514         }
515         e++;
516     }
517     file_cpy[i] = '\0';
518     return (const char*)file_cpy;
519 }
520
521
522 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout, int xoflen,
523           EVP_PKEY *key, unsigned char *sigin, int siglen,
524           const char *sig_name, const char *md_name,
525           const char *file)
526 {
527     size_t len = BUFSIZE;
528     int i, backslash = 0, ret = EXIT_FAILURE;
529     unsigned char *allocated_buf = NULL;
530
531     while (BIO_pending(bp) || !BIO_eof(bp)) {
532         i = BIO_read(bp, (char *)buf, BUFSIZE);
533         if (i < 0) {
534             BIO_printf(bio_err, "Read error in %s\n", file);
535             goto end;
536         }
537         if (i == 0)
538             break;
539     }
540     if (sigin != NULL) {
541         EVP_MD_CTX *ctx;
542         BIO_get_md_ctx(bp, &ctx);
543         i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
544         if (i > 0) {
545             BIO_printf(out, "Verified OK\n");
546         } else if (i == 0) {
547             BIO_printf(out, "Verification failure\n");
548             goto end;
549         } else {
550             BIO_printf(bio_err, "Error verifying data\n");
551             goto end;
552         }
553         ret = EXIT_SUCCESS;
554         goto end;
555     }
556     if (key != NULL) {
557         EVP_MD_CTX *ctx;
558         size_t tmplen;
559
560         BIO_get_md_ctx(bp, &ctx);
561         if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
562             BIO_printf(bio_err, "Error getting maximum length of signed data\n");
563             goto end;
564         }
565         if (tmplen > BUFSIZE) {
566             len = tmplen;
567             allocated_buf = app_malloc(len, "Signature buffer");
568             buf = allocated_buf;
569         }
570         if (!EVP_DigestSignFinal(ctx, buf, &len)) {
571             BIO_printf(bio_err, "Error signing data\n");
572             goto end;
573         }
574     } else if (xoflen > 0) {
575         EVP_MD_CTX *ctx;
576
577         len = xoflen;
578         if (len > BUFSIZE) {
579             allocated_buf = app_malloc(len, "Digest buffer");
580             buf = allocated_buf;
581         }
582
583         BIO_get_md_ctx(bp, &ctx);
584
585         if (!EVP_DigestFinalXOF(ctx, buf, len)) {
586             BIO_printf(bio_err, "Error Digesting Data\n");
587             goto end;
588         }
589     } else {
590         len = BIO_gets(bp, (char *)buf, BUFSIZE);
591         if ((int)len < 0)
592             goto end;
593     }
594
595     if (binout) {
596         BIO_write(out, buf, len);
597     } else if (sep == 2) {
598         file = newline_escape_filename(file, &backslash);
599
600         if (backslash == 1)
601             BIO_puts(out, "\\");
602
603         for (i = 0; i < (int)len; i++)
604             BIO_printf(out, "%02x", buf[i]);
605
606         BIO_printf(out, " *%s\n", file);
607         OPENSSL_free((char *)file);
608     } else {
609         if (sig_name != NULL) {
610             BIO_puts(out, sig_name);
611             if (md_name != NULL)
612                 BIO_printf(out, "-%s", md_name);
613             BIO_printf(out, "(%s)= ", file);
614         } else if (md_name != NULL) {
615             BIO_printf(out, "%s(%s)= ", md_name, file);
616         } else {
617             BIO_printf(out, "(%s)= ", file);
618         }
619         for (i = 0; i < (int)len; i++) {
620             if (sep && (i != 0))
621                 BIO_printf(out, ":");
622             BIO_printf(out, "%02x", buf[i]);
623         }
624         BIO_printf(out, "\n");
625     }
626
627     ret = EXIT_SUCCESS;
628  end:
629     if (allocated_buf != NULL)
630         OPENSSL_clear_free(allocated_buf, len);
631
632     return ret;
633 }