7b433385861625595529080fe40c4dec7c1219d3
[openssl.git] / apps / dgst.c
1 /*
2  * Copyright 1995-2018 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
23 #undef BUFSIZE
24 #define BUFSIZE 1024*8
25
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,
29           const char *file);
30
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,
37     OPT_DIGEST,
38     OPT_R_ENUM
39 } OPTION_CHOICE;
40
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"},
68     OPT_R_OPTIONS,
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"},
73 #endif
74     {NULL}
75 };
76
77 int dgst_main(int argc, char **argv)
78 {
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;
90     OPTION_CHOICE o;
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;
94     int engine_impl = 0;
95
96     prog = opt_progname(argv[0]);
97     buf = app_malloc(BUFSIZE, "I/O buffer");
98     md = EVP_get_digestbyname(prog);
99
100     prog = opt_init(argc, argv, dgst_options);
101     while ((o = opt_next()) != OPT_EOF) {
102         switch (o) {
103         case OPT_EOF:
104         case OPT_ERR:
105  opthelp:
106             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
107             goto end;
108         case OPT_HELP:
109             opt_help(dgst_options);
110             ret = 0;
111             goto end;
112         case OPT_C:
113             separator = 1;
114             break;
115         case OPT_R:
116             separator = 2;
117             break;
118         case OPT_R_CASES:
119             if (!opt_rand(o))
120                 goto end;
121             break;
122         case OPT_OUT:
123             outfile = opt_arg();
124             break;
125         case OPT_SIGN:
126             keyfile = opt_arg();
127             break;
128         case OPT_PASSIN:
129             passinarg = opt_arg();
130             break;
131         case OPT_VERIFY:
132             keyfile = opt_arg();
133             want_pub = do_verify = 1;
134             break;
135         case OPT_PRVERIFY:
136             keyfile = opt_arg();
137             do_verify = 1;
138             break;
139         case OPT_SIGNATURE:
140             sigfile = opt_arg();
141             break;
142         case OPT_KEYFORM:
143             if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
144                 goto opthelp;
145             break;
146         case OPT_ENGINE:
147             e = setup_engine(opt_arg(), 0);
148             break;
149         case OPT_ENGINE_IMPL:
150             engine_impl = 1;
151             break;
152         case OPT_HEX:
153             out_bin = 0;
154             break;
155         case OPT_BINARY:
156             out_bin = 1;
157             break;
158         case OPT_DEBUG:
159             debug = 1;
160             break;
161         case OPT_FIPS_FINGERPRINT:
162             hmac_key = "etaonrishdlcupfm";
163             break;
164         case OPT_HMAC:
165             hmac_key = opt_arg();
166             break;
167         case OPT_MAC:
168             mac_name = opt_arg();
169             break;
170         case OPT_SIGOPT:
171             if (!sigopts)
172                 sigopts = sk_OPENSSL_STRING_new_null();
173             if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
174                 goto opthelp;
175             break;
176         case OPT_MACOPT:
177             if (!macopts)
178                 macopts = sk_OPENSSL_STRING_new_null();
179             if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
180                 goto opthelp;
181             break;
182         case OPT_DIGEST:
183             if (!opt_md(opt_unknown(), &m))
184                 goto opthelp;
185             md = m;
186             break;
187         }
188     }
189     argc = opt_num_rest();
190     argv = opt_rest();
191     if (keyfile != NULL && argc > 1) {
192         BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
193         goto end;
194     }
195
196     if (do_verify && sigfile == NULL) {
197         BIO_printf(bio_err,
198                    "No signature to verify: use the -signature option\n");
199         goto end;
200     }
201     if (engine_impl)
202         impl = e;
203
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);
208         goto end;
209     }
210
211     if (debug) {
212         BIO_set_callback(in, BIO_debug_callback);
213         /* needed for windows 3.1 */
214         BIO_set_callback_arg(in, (char *)bio_err);
215     }
216
217     if (!app_passwd(passinarg, NULL, &passin, NULL)) {
218         BIO_printf(bio_err, "Error getting password\n");
219         goto end;
220     }
221
222     if (out_bin == -1) {
223         if (keyfile != NULL)
224             out_bin = 1;
225         else
226             out_bin = 0;
227     }
228
229     out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
230     if (out == NULL)
231         goto end;
232
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");
235         goto end;
236     }
237
238     if (keyfile != NULL) {
239         int type;
240
241         if (want_pub)
242             sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
243         else
244             sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
245         if (sigkey == NULL) {
246             /*
247              * load_[pub]key() has already printed an appropriate message
248              */
249             goto end;
250         }
251         type = EVP_PKEY_id(sigkey);
252         if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
253             /*
254              * We implement PureEdDSA for these which doesn't have a separate
255              * digest, and only supports one shot.
256              */
257             BIO_printf(bio_err, "Key type not supported for this operation\n");
258             goto end;
259         }
260     }
261
262     if (mac_name != NULL) {
263         EVP_PKEY_CTX *mac_ctx = NULL;
264         int r = 0;
265         if (!init_gen_str(&mac_ctx, mac_name, impl, 0))
266             goto mac_end;
267         if (macopts != NULL) {
268             char *macopt;
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) {
272                     BIO_printf(bio_err,
273                                "MAC parameter error \"%s\"\n", macopt);
274                     ERR_print_errors(bio_err);
275                     goto mac_end;
276                 }
277             }
278         }
279         if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
280             BIO_puts(bio_err, "Error generating key\n");
281             ERR_print_errors(bio_err);
282             goto mac_end;
283         }
284         r = 1;
285  mac_end:
286         EVP_PKEY_CTX_free(mac_ctx);
287         if (r == 0)
288             goto end;
289     }
290
291     if (hmac_key != NULL) {
292         sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
293                                               (unsigned char *)hmac_key, -1);
294         if (sigkey == NULL)
295             goto end;
296     }
297
298     if (sigkey != NULL) {
299         EVP_MD_CTX *mctx = NULL;
300         EVP_PKEY_CTX *pctx = NULL;
301         int r;
302         if (!BIO_get_md_ctx(bmd, &mctx)) {
303             BIO_printf(bio_err, "Error getting context\n");
304             ERR_print_errors(bio_err);
305             goto end;
306         }
307         if (do_verify)
308             r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
309         else
310             r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
311         if (!r) {
312             BIO_printf(bio_err, "Error setting context\n");
313             ERR_print_errors(bio_err);
314             goto end;
315         }
316         if (sigopts != NULL) {
317             char *sigopt;
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);
323                     goto end;
324                 }
325             }
326         }
327     }
328     /* we use md as a filter, reading from 'in' */
329     else {
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);
334             goto end;
335         }
336         if (md == NULL)
337             md = EVP_sha256();
338         if (!EVP_DigestInit_ex(mctx, md, impl)) {
339             BIO_printf(bio_err, "Error setting digest\n");
340             ERR_print_errors(bio_err);
341             goto end;
342         }
343     }
344
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);
350             goto end;
351         }
352         siglen = EVP_PKEY_size(sigkey);
353         sigbuf = app_malloc(siglen, "signature buffer");
354         siglen = BIO_read(sigbio, sigbuf, siglen);
355         BIO_free(sigbio);
356         if (siglen <= 0) {
357             BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
358             ERR_print_errors(bio_err);
359             goto end;
360         }
361     }
362     inp = BIO_push(bmd, in);
363
364     if (md == NULL) {
365         EVP_MD_CTX *tctx;
366         BIO_get_md_ctx(bmd, &tctx);
367         md = EVP_MD_CTX_md(tctx);
368     }
369     if (md != NULL)
370         md_name = EVP_MD_name(md);
371
372     if (argc == 0) {
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");
376     } else {
377         const char *sig_name = NULL;
378         if (!out_bin) {
379             if (sigkey != NULL) {
380                 const EVP_PKEY_ASN1_METHOD *ameth;
381                 ameth = EVP_PKEY_get0_asn1(sigkey);
382                 if (ameth)
383                     EVP_PKEY_asn1_get0_info(NULL, NULL,
384                                             NULL, NULL, &sig_name, ameth);
385             }
386         }
387         ret = 0;
388         for (i = 0; i < argc; i++) {
389             int r;
390             if (BIO_read_filename(in, argv[i]) <= 0) {
391                 perror(argv[i]);
392                 ret++;
393                 continue;
394             } else {
395                 r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
396                           siglen, sig_name, md_name, argv[i]);
397             }
398             if (r)
399                 ret = r;
400             (void)BIO_reset(bmd);
401         }
402     }
403  end:
404     OPENSSL_clear_free(buf, BUFSIZE);
405     BIO_free(in);
406     OPENSSL_free(passin);
407     BIO_free_all(out);
408     EVP_PKEY_free(sigkey);
409     sk_OPENSSL_STRING_free(sigopts);
410     sk_OPENSSL_STRING_free(macopts);
411     OPENSSL_free(sigbuf);
412     BIO_free(bmd);
413     release_engine(e);
414     return ret;
415 }
416
417 /*
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
425  * compatibility.
426  */
427 static const char *newline_escape_filename(const char *file, int * backslash)
428 {
429     size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
430     char *file_cpy = NULL;
431
432     for (i = 0; i < length; i++)
433         if (file[i] == '\n')
434             newline_count++;
435
436     mem_len = length + newline_count + 1;
437     file_cpy = app_malloc(mem_len, file);
438     i = 0;
439
440     while(e < length) {
441         const char c = file[e];
442         if (c == '\n') {
443             file_cpy[i++] = '\\';
444             file_cpy[i++] = 'n';
445             *backslash = 1;
446         } else {
447             file_cpy[i++] = c;
448         }
449         e++;
450     }
451     file_cpy[i] = '\0';
452     return (const char*)file_cpy;
453 }
454
455
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,
459           const char *file)
460 {
461     size_t len;
462     int i, backslash = 0;
463
464     for (;;) {
465         i = BIO_read(bp, (char *)buf, BUFSIZE);
466         if (i < 0) {
467             BIO_printf(bio_err, "Read Error in %s\n", file);
468             ERR_print_errors(bio_err);
469             return 1;
470         }
471         if (i == 0)
472             break;
473     }
474     if (sigin != NULL) {
475         EVP_MD_CTX *ctx;
476         BIO_get_md_ctx(bp, &ctx);
477         i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
478         if (i > 0) {
479             BIO_printf(out, "Verified OK\n");
480         } else if (i == 0) {
481             BIO_printf(out, "Verification Failure\n");
482             return 1;
483         } else {
484             BIO_printf(bio_err, "Error Verifying Data\n");
485             ERR_print_errors(bio_err);
486             return 1;
487         }
488         return 0;
489     }
490     if (key != NULL) {
491         EVP_MD_CTX *ctx;
492         BIO_get_md_ctx(bp, &ctx);
493         len = BUFSIZE;
494         if (!EVP_DigestSignFinal(ctx, buf, &len)) {
495             BIO_printf(bio_err, "Error Signing Data\n");
496             ERR_print_errors(bio_err);
497             return 1;
498         }
499     } else {
500         len = BIO_gets(bp, (char *)buf, BUFSIZE);
501         if ((int)len < 0) {
502             ERR_print_errors(bio_err);
503             return 1;
504         }
505     }
506
507     if (binout) {
508         BIO_write(out, buf, len);
509     } else if (sep == 2) {
510         file = newline_escape_filename(file, &backslash);
511
512         if (backslash == 1)
513             BIO_puts(out, "\\");
514
515         for (i = 0; i < (int)len; i++)
516             BIO_printf(out, "%02x", buf[i]);
517
518         BIO_printf(out, " *%s\n", file);
519         OPENSSL_free((char *)file);
520     } else {
521         if (sig_name != NULL) {
522             BIO_puts(out, sig_name);
523             if (md_name != NULL)
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);
528         } else {
529             BIO_printf(out, "(%s)= ", file);
530         }
531         for (i = 0; i < (int)len; i++) {
532             if (sep && (i != 0))
533                 BIO_printf(out, ":");
534             BIO_printf(out, "%02x", buf[i]);
535         }
536         BIO_printf(out, "\n");
537     }
538     return 0;
539 }