845c2eabc99b80157a3c59098e73219944ade53e
[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     buf = app_malloc(BUFSIZE, "I/O buffer");
115     md = EVP_get_digestbyname(argv[0]);
116
117     prog = opt_init(argc, argv, dgst_options);
118     while ((o = opt_next()) != OPT_EOF) {
119         switch (o) {
120         case OPT_EOF:
121         case OPT_ERR:
122  opthelp:
123             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
124             goto end;
125         case OPT_HELP:
126             opt_help(dgst_options);
127             ret = 0;
128             goto end;
129         case OPT_LIST:
130             BIO_printf(bio_out, "Supported digests:\n");
131             dec.bio = bio_out;
132             dec.n = 0;
133             OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
134                                    show_digests, &dec);
135             BIO_printf(bio_out, "\n");
136             ret = 0;
137             goto end;
138         case OPT_C:
139             separator = 1;
140             break;
141         case OPT_R:
142             separator = 2;
143             break;
144         case OPT_R_CASES:
145             if (!opt_rand(o))
146                 goto end;
147             break;
148         case OPT_OUT:
149             outfile = opt_arg();
150             break;
151         case OPT_SIGN:
152             keyfile = opt_arg();
153             break;
154         case OPT_PASSIN:
155             passinarg = opt_arg();
156             break;
157         case OPT_VERIFY:
158             keyfile = opt_arg();
159             want_pub = do_verify = 1;
160             break;
161         case OPT_PRVERIFY:
162             keyfile = opt_arg();
163             do_verify = 1;
164             break;
165         case OPT_SIGNATURE:
166             sigfile = opt_arg();
167             break;
168         case OPT_KEYFORM:
169             if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
170                 goto opthelp;
171             break;
172         case OPT_ENGINE:
173             e = setup_engine(opt_arg(), 0);
174             break;
175         case OPT_ENGINE_IMPL:
176             engine_impl = 1;
177             break;
178         case OPT_HEX:
179             out_bin = 0;
180             break;
181         case OPT_BINARY:
182             out_bin = 1;
183             break;
184         case OPT_XOFLEN:
185             xoflen = atoi(opt_arg());
186             break;
187         case OPT_DEBUG:
188             debug = 1;
189             break;
190         case OPT_FIPS_FINGERPRINT:
191             hmac_key = "etaonrishdlcupfm";
192             break;
193         case OPT_HMAC:
194             hmac_key = opt_arg();
195             break;
196         case OPT_MAC:
197             mac_name = opt_arg();
198             break;
199         case OPT_SIGOPT:
200             if (!sigopts)
201                 sigopts = sk_OPENSSL_STRING_new_null();
202             if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
203                 goto opthelp;
204             break;
205         case OPT_MACOPT:
206             if (!macopts)
207                 macopts = sk_OPENSSL_STRING_new_null();
208             if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
209                 goto opthelp;
210             break;
211         case OPT_DIGEST:
212             if (!opt_md(opt_unknown(), &m))
213                 goto opthelp;
214             md = m;
215             break;
216         case OPT_PROV_CASES:
217             if (!opt_provider(o))
218                 goto end;
219             break;
220         }
221     }
222
223     /* Remaining args are files to digest. */
224     argc = opt_num_rest();
225     argv = opt_rest();
226     if (keyfile != NULL && argc > 1) {
227         BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
228         goto end;
229     }
230
231     if (do_verify && sigfile == NULL) {
232         BIO_printf(bio_err,
233                    "No signature to verify: use the -signature option\n");
234         goto end;
235     }
236     if (engine_impl)
237         impl = e;
238
239     in = BIO_new(BIO_s_file());
240     bmd = BIO_new(BIO_f_md());
241     if ((in == NULL) || (bmd == NULL)) {
242         ERR_print_errors(bio_err);
243         goto end;
244     }
245
246     if (debug) {
247         BIO_set_callback(in, BIO_debug_callback);
248         /* needed for windows 3.1 */
249         BIO_set_callback_arg(in, (char *)bio_err);
250     }
251
252     if (!app_passwd(passinarg, NULL, &passin, NULL)) {
253         BIO_printf(bio_err, "Error getting password\n");
254         goto end;
255     }
256
257     if (out_bin == -1) {
258         if (keyfile != NULL)
259             out_bin = 1;
260         else
261             out_bin = 0;
262     }
263
264     out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
265     if (out == NULL)
266         goto end;
267
268     if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
269         BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
270         goto end;
271     }
272
273     if (keyfile != NULL) {
274         int type;
275
276         if (want_pub)
277             sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "public key");
278         else
279             sigkey = load_key(keyfile, keyform, 0, passin, e, "private key");
280         if (sigkey == NULL) {
281             /*
282              * load_[pub]key() has already printed an appropriate message
283              */
284             goto end;
285         }
286         type = EVP_PKEY_id(sigkey);
287         if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
288             /*
289              * We implement PureEdDSA for these which doesn't have a separate
290              * digest, and only supports one shot.
291              */
292             BIO_printf(bio_err, "Key type not supported for this operation\n");
293             goto end;
294         }
295     }
296
297     if (mac_name != NULL) {
298         EVP_PKEY_CTX *mac_ctx = NULL;
299         int r = 0;
300         if (!init_gen_str(&mac_ctx, mac_name, impl, 0, NULL, NULL))
301             goto mac_end;
302         if (macopts != NULL) {
303             char *macopt;
304             for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
305                 macopt = sk_OPENSSL_STRING_value(macopts, i);
306                 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
307                     BIO_printf(bio_err,
308                                "MAC parameter error \"%s\"\n", macopt);
309                     ERR_print_errors(bio_err);
310                     goto mac_end;
311                 }
312             }
313         }
314         if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
315             BIO_puts(bio_err, "Error generating key\n");
316             ERR_print_errors(bio_err);
317             goto mac_end;
318         }
319         r = 1;
320  mac_end:
321         EVP_PKEY_CTX_free(mac_ctx);
322         if (r == 0)
323             goto end;
324     }
325
326     if (hmac_key != NULL) {
327         sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
328                                               (unsigned char *)hmac_key,
329                                               strlen(hmac_key));
330         if (sigkey == NULL)
331             goto end;
332     }
333
334     if (sigkey != NULL) {
335         EVP_MD_CTX *mctx = NULL;
336         EVP_PKEY_CTX *pctx = NULL;
337         int r;
338         if (!BIO_get_md_ctx(bmd, &mctx)) {
339             BIO_printf(bio_err, "Error getting context\n");
340             ERR_print_errors(bio_err);
341             goto end;
342         }
343         if (do_verify)
344             r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
345         else
346             r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
347         if (!r) {
348             BIO_printf(bio_err, "Error setting context\n");
349             ERR_print_errors(bio_err);
350             goto end;
351         }
352         if (sigopts != NULL) {
353             char *sigopt;
354             for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
355                 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
356                 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
357                     BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
358                     ERR_print_errors(bio_err);
359                     goto end;
360                 }
361             }
362         }
363     }
364     /* we use md as a filter, reading from 'in' */
365     else {
366         EVP_MD_CTX *mctx = NULL;
367         if (!BIO_get_md_ctx(bmd, &mctx)) {
368             BIO_printf(bio_err, "Error getting context\n");
369             ERR_print_errors(bio_err);
370             goto end;
371         }
372         if (md == NULL)
373             md = EVP_sha256();
374         if (!EVP_DigestInit_ex(mctx, md, impl)) {
375             BIO_printf(bio_err, "Error setting digest\n");
376             ERR_print_errors(bio_err);
377             goto end;
378         }
379     }
380
381     if (sigfile != NULL && sigkey != NULL) {
382         BIO *sigbio = BIO_new_file(sigfile, "rb");
383         if (sigbio == NULL) {
384             BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
385             ERR_print_errors(bio_err);
386             goto end;
387         }
388         siglen = EVP_PKEY_size(sigkey);
389         sigbuf = app_malloc(siglen, "signature buffer");
390         siglen = BIO_read(sigbio, sigbuf, siglen);
391         BIO_free(sigbio);
392         if (siglen <= 0) {
393             BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
394             ERR_print_errors(bio_err);
395             goto end;
396         }
397     }
398     inp = BIO_push(bmd, in);
399
400     if (md == NULL) {
401         EVP_MD_CTX *tctx;
402         BIO_get_md_ctx(bmd, &tctx);
403         md = EVP_MD_CTX_md(tctx);
404     }
405     if (md != NULL)
406         md_name = EVP_MD_name(md);
407
408     if (xoflen > 0) {
409         if (!(EVP_MD_flags(md) & EVP_MD_FLAG_XOF)) {
410             BIO_printf(bio_err, "Length can only be specified for XOF\n");
411             goto end;
412         }
413         if (sigkey != NULL) {
414             BIO_printf(bio_err, "Signing key cannot be specified for XOF\n");
415             goto end;
416         }
417     }
418
419     if (argc == 0) {
420         BIO_set_fp(in, stdin, BIO_NOCLOSE);
421         ret = do_fp(out, buf, inp, separator, out_bin, xoflen, sigkey, sigbuf,
422                     siglen, NULL, md_name, "stdin");
423     } else {
424         const char *sig_name = NULL;
425         if (!out_bin) {
426             if (sigkey != NULL)
427                 sig_name = EVP_PKEY_get0_first_alg_name(sigkey);
428         }
429         ret = 0;
430         for (i = 0; i < argc; i++) {
431             int r;
432             if (BIO_read_filename(in, argv[i]) <= 0) {
433                 perror(argv[i]);
434                 ret++;
435                 continue;
436             } else {
437                 r = do_fp(out, buf, inp, separator, out_bin, xoflen,
438                           sigkey, sigbuf, siglen, sig_name, md_name, argv[i]);
439             }
440             if (r)
441                 ret = r;
442             (void)BIO_reset(bmd);
443         }
444     }
445  end:
446     OPENSSL_clear_free(buf, BUFSIZE);
447     BIO_free(in);
448     OPENSSL_free(passin);
449     BIO_free_all(out);
450     EVP_PKEY_free(sigkey);
451     sk_OPENSSL_STRING_free(sigopts);
452     sk_OPENSSL_STRING_free(macopts);
453     OPENSSL_free(sigbuf);
454     BIO_free(bmd);
455     release_engine(e);
456     return ret;
457 }
458
459 static void show_digests(const OBJ_NAME *name, void *arg)
460 {
461     struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
462     const EVP_MD *md = NULL;
463
464     /* Filter out signed digests (a.k.a signature algorithms) */
465     if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
466         return;
467
468     if (!islower((unsigned char)*name->name))
469         return;
470
471     /* Filter out message digests that we cannot use */
472     md = EVP_get_digestbyname(name->name);
473     if (md == NULL)
474         return;
475
476     BIO_printf(dec->bio, "-%-25s", name->name);
477     if (++dec->n == 3) {
478         BIO_printf(dec->bio, "\n");
479         dec->n = 0;
480     } else {
481         BIO_printf(dec->bio, " ");
482     }
483 }
484
485 /*
486  * The newline_escape_filename function performs newline escaping for any
487  * filename that contains a newline.  This function also takes a pointer
488  * to backslash. The backslash pointer is a flag to indicating whether a newline
489  * is present in the filename.  If a newline is present, the backslash flag is
490  * set and the output format will contain a backslash at the beginning of the
491  * digest output. This output format is to replicate the output format found
492  * in the '*sum' checksum programs. This aims to preserve backward
493  * compatibility.
494  */
495 static const char *newline_escape_filename(const char *file, int * backslash)
496 {
497     size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
498     char *file_cpy = NULL;
499
500     for (i = 0; i < length; i++)
501         if (file[i] == '\n')
502             newline_count++;
503
504     mem_len = length + newline_count + 1;
505     file_cpy = app_malloc(mem_len, file);
506     i = 0;
507
508     while(e < length) {
509         const char c = file[e];
510         if (c == '\n') {
511             file_cpy[i++] = '\\';
512             file_cpy[i++] = 'n';
513             *backslash = 1;
514         } else {
515             file_cpy[i++] = c;
516         }
517         e++;
518     }
519     file_cpy[i] = '\0';
520     return (const char*)file_cpy;
521 }
522
523
524 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout, int xoflen,
525           EVP_PKEY *key, unsigned char *sigin, int siglen,
526           const char *sig_name, const char *md_name,
527           const char *file)
528 {
529     size_t len = BUFSIZE;
530     int i, backslash = 0, ret = 1;
531     unsigned char *allocated_buf = NULL;
532
533     while (BIO_pending(bp) || !BIO_eof(bp)) {
534         i = BIO_read(bp, (char *)buf, BUFSIZE);
535         if (i < 0) {
536             BIO_printf(bio_err, "Read Error in %s\n", file);
537             ERR_print_errors(bio_err);
538             goto end;
539         }
540         if (i == 0)
541             break;
542     }
543     if (sigin != NULL) {
544         EVP_MD_CTX *ctx;
545         BIO_get_md_ctx(bp, &ctx);
546         i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
547         if (i > 0) {
548             BIO_printf(out, "Verified OK\n");
549         } else if (i == 0) {
550             BIO_printf(out, "Verification Failure\n");
551             goto end;
552         } else {
553             BIO_printf(bio_err, "Error Verifying Data\n");
554             ERR_print_errors(bio_err);
555             goto end;
556         }
557         ret = 0;
558         goto end;
559     }
560     if (key != NULL) {
561         EVP_MD_CTX *ctx;
562         size_t tmplen;
563
564         BIO_get_md_ctx(bp, &ctx);
565         if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
566             BIO_printf(bio_err, "Error Signing Data\n");
567             ERR_print_errors(bio_err);
568             goto end;
569         }
570         if (tmplen > BUFSIZE) {
571             len = tmplen;
572             allocated_buf = app_malloc(len, "Signature buffer");
573             buf = allocated_buf;
574         }
575         if (!EVP_DigestSignFinal(ctx, buf, &len)) {
576             BIO_printf(bio_err, "Error Signing Data\n");
577             ERR_print_errors(bio_err);
578             goto end;
579         }
580     } else if (xoflen > 0) {
581         EVP_MD_CTX *ctx;
582
583         len = xoflen;
584         if (len > BUFSIZE) {
585             allocated_buf = app_malloc(len, "Digest buffer");
586             buf = allocated_buf;
587         }
588
589         BIO_get_md_ctx(bp, &ctx);
590
591         if (!EVP_DigestFinalXOF(ctx, buf, len)) {
592             BIO_printf(bio_err, "Error Digesting Data\n");
593             ERR_print_errors(bio_err);
594             goto end;
595         }
596     } else {
597         len = BIO_gets(bp, (char *)buf, BUFSIZE);
598         if ((int)len < 0) {
599             ERR_print_errors(bio_err);
600             goto end;
601         }
602     }
603
604     if (binout) {
605         BIO_write(out, buf, len);
606     } else if (sep == 2) {
607         file = newline_escape_filename(file, &backslash);
608
609         if (backslash == 1)
610             BIO_puts(out, "\\");
611
612         for (i = 0; i < (int)len; i++)
613             BIO_printf(out, "%02x", buf[i]);
614
615         BIO_printf(out, " *%s\n", file);
616         OPENSSL_free((char *)file);
617     } else {
618         if (sig_name != NULL) {
619             BIO_puts(out, sig_name);
620             if (md_name != NULL)
621                 BIO_printf(out, "-%s", md_name);
622             BIO_printf(out, "(%s)= ", file);
623         } else if (md_name != NULL) {
624             BIO_printf(out, "%s(%s)= ", md_name, file);
625         } else {
626             BIO_printf(out, "(%s)= ", file);
627         }
628         for (i = 0; i < (int)len; i++) {
629             if (sep && (i != 0))
630                 BIO_printf(out, ":");
631             BIO_printf(out, "%02x", buf[i]);
632         }
633         BIO_printf(out, "\n");
634     }
635
636     ret = 0;
637  end:
638     if (allocated_buf != NULL)
639         OPENSSL_clear_free(allocated_buf, len);
640
641     return ret;
642 }