Add support for setting raw private HMAC keys
[openssl.git] / apps / dgst.c
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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     OPTION_CHOICE o;
90     int separator = 0, debug = 0, keyform = FORMAT_PEM, siglen = 0;
91     int i, ret = 1, out_bin = -1, want_pub = 0, do_verify = 0;
92     unsigned char *buf = NULL, *sigbuf = NULL;
93     int engine_impl = 0;
94
95     prog = opt_progname(argv[0]);
96     buf = app_malloc(BUFSIZE, "I/O buffer");
97     md = EVP_get_digestbyname(prog);
98
99     prog = opt_init(argc, argv, dgst_options);
100     while ((o = opt_next()) != OPT_EOF) {
101         switch (o) {
102         case OPT_EOF:
103         case OPT_ERR:
104  opthelp:
105             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
106             goto end;
107         case OPT_HELP:
108             opt_help(dgst_options);
109             ret = 0;
110             goto end;
111         case OPT_C:
112             separator = 1;
113             break;
114         case OPT_R:
115             separator = 2;
116             break;
117         case OPT_R_CASES:
118             if (!opt_rand(o))
119                 goto end;
120             break;
121         case OPT_OUT:
122             outfile = opt_arg();
123             break;
124         case OPT_SIGN:
125             keyfile = opt_arg();
126             break;
127         case OPT_PASSIN:
128             passinarg = opt_arg();
129             break;
130         case OPT_VERIFY:
131             keyfile = opt_arg();
132             want_pub = do_verify = 1;
133             break;
134         case OPT_PRVERIFY:
135             keyfile = opt_arg();
136             do_verify = 1;
137             break;
138         case OPT_SIGNATURE:
139             sigfile = opt_arg();
140             break;
141         case OPT_KEYFORM:
142             if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
143                 goto opthelp;
144             break;
145         case OPT_ENGINE:
146             e = setup_engine(opt_arg(), 0);
147             break;
148         case OPT_ENGINE_IMPL:
149             engine_impl = 1;
150             break;
151         case OPT_HEX:
152             out_bin = 0;
153             break;
154         case OPT_BINARY:
155             out_bin = 1;
156             break;
157         case OPT_DEBUG:
158             debug = 1;
159             break;
160         case OPT_FIPS_FINGERPRINT:
161             hmac_key = "etaonrishdlcupfm";
162             break;
163         case OPT_HMAC:
164             hmac_key = opt_arg();
165             break;
166         case OPT_MAC:
167             mac_name = opt_arg();
168             break;
169         case OPT_SIGOPT:
170             if (!sigopts)
171                 sigopts = sk_OPENSSL_STRING_new_null();
172             if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
173                 goto opthelp;
174             break;
175         case OPT_MACOPT:
176             if (!macopts)
177                 macopts = sk_OPENSSL_STRING_new_null();
178             if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
179                 goto opthelp;
180             break;
181         case OPT_DIGEST:
182             if (!opt_md(opt_unknown(), &m))
183                 goto opthelp;
184             md = m;
185             break;
186         }
187     }
188     argc = opt_num_rest();
189     argv = opt_rest();
190     if (keyfile != NULL && argc > 1) {
191         BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
192         goto end;
193     }
194
195     if (do_verify && sigfile == NULL) {
196         BIO_printf(bio_err,
197                    "No signature to verify: use the -signature option\n");
198         goto end;
199     }
200     if (engine_impl)
201         impl = e;
202
203     in = BIO_new(BIO_s_file());
204     bmd = BIO_new(BIO_f_md());
205     if ((in == NULL) || (bmd == NULL)) {
206         ERR_print_errors(bio_err);
207         goto end;
208     }
209
210     if (debug) {
211         BIO_set_callback(in, BIO_debug_callback);
212         /* needed for windows 3.1 */
213         BIO_set_callback_arg(in, (char *)bio_err);
214     }
215
216     if (!app_passwd(passinarg, NULL, &passin, NULL)) {
217         BIO_printf(bio_err, "Error getting password\n");
218         goto end;
219     }
220
221     if (out_bin == -1) {
222         if (keyfile != NULL)
223             out_bin = 1;
224         else
225             out_bin = 0;
226     }
227
228     out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
229     if (out == NULL)
230         goto end;
231
232     if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
233         BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
234         goto end;
235     }
236
237     if (keyfile != NULL) {
238         if (want_pub)
239             sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
240         else
241             sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
242         if (sigkey == NULL) {
243             /*
244              * load_[pub]key() has already printed an appropriate message
245              */
246             goto end;
247         }
248     }
249
250     if (mac_name != NULL) {
251         EVP_PKEY_CTX *mac_ctx = NULL;
252         int r = 0;
253         if (!init_gen_str(&mac_ctx, mac_name, impl, 0))
254             goto mac_end;
255         if (macopts != NULL) {
256             char *macopt;
257             for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
258                 macopt = sk_OPENSSL_STRING_value(macopts, i);
259                 if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
260                     BIO_printf(bio_err,
261                                "MAC parameter error \"%s\"\n", macopt);
262                     ERR_print_errors(bio_err);
263                     goto mac_end;
264                 }
265             }
266         }
267         if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
268             BIO_puts(bio_err, "Error generating key\n");
269             ERR_print_errors(bio_err);
270             goto mac_end;
271         }
272         r = 1;
273  mac_end:
274         EVP_PKEY_CTX_free(mac_ctx);
275         if (r == 0)
276             goto end;
277     }
278
279     if (hmac_key != NULL) {
280         sigkey = EVP_PKEY_new_private_key(EVP_PKEY_HMAC, impl,
281                                           (unsigned char *)hmac_key, -1);
282         if (sigkey == NULL)
283             goto end;
284     }
285
286     if (sigkey != NULL) {
287         EVP_MD_CTX *mctx = NULL;
288         EVP_PKEY_CTX *pctx = NULL;
289         int r;
290         if (!BIO_get_md_ctx(bmd, &mctx)) {
291             BIO_printf(bio_err, "Error getting context\n");
292             ERR_print_errors(bio_err);
293             goto end;
294         }
295         if (do_verify)
296             r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
297         else
298             r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
299         if (!r) {
300             BIO_printf(bio_err, "Error setting context\n");
301             ERR_print_errors(bio_err);
302             goto end;
303         }
304         if (sigopts != NULL) {
305             char *sigopt;
306             for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
307                 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
308                 if (pkey_ctrl_string(pctx, sigopt) <= 0) {
309                     BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
310                     ERR_print_errors(bio_err);
311                     goto end;
312                 }
313             }
314         }
315     }
316     /* we use md as a filter, reading from 'in' */
317     else {
318         EVP_MD_CTX *mctx = NULL;
319         if (!BIO_get_md_ctx(bmd, &mctx)) {
320             BIO_printf(bio_err, "Error getting context\n");
321             ERR_print_errors(bio_err);
322             goto end;
323         }
324         if (md == NULL)
325             md = EVP_sha256();
326         if (!EVP_DigestInit_ex(mctx, md, impl)) {
327             BIO_printf(bio_err, "Error setting digest\n");
328             ERR_print_errors(bio_err);
329             goto end;
330         }
331     }
332
333     if (sigfile != NULL && sigkey != NULL) {
334         BIO *sigbio = BIO_new_file(sigfile, "rb");
335         if (sigbio == NULL) {
336             BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
337             ERR_print_errors(bio_err);
338             goto end;
339         }
340         siglen = EVP_PKEY_size(sigkey);
341         sigbuf = app_malloc(siglen, "signature buffer");
342         siglen = BIO_read(sigbio, sigbuf, siglen);
343         BIO_free(sigbio);
344         if (siglen <= 0) {
345             BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
346             ERR_print_errors(bio_err);
347             goto end;
348         }
349     }
350     inp = BIO_push(bmd, in);
351
352     if (md == NULL) {
353         EVP_MD_CTX *tctx;
354         BIO_get_md_ctx(bmd, &tctx);
355         md = EVP_MD_CTX_md(tctx);
356     }
357
358     if (argc == 0) {
359         BIO_set_fp(in, stdin, BIO_NOCLOSE);
360         ret = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
361                     siglen, NULL, NULL, "stdin");
362     } else {
363         const char *md_name = NULL, *sig_name = NULL;
364         if (!out_bin) {
365             if (sigkey != NULL) {
366                 const EVP_PKEY_ASN1_METHOD *ameth;
367                 ameth = EVP_PKEY_get0_asn1(sigkey);
368                 if (ameth)
369                     EVP_PKEY_asn1_get0_info(NULL, NULL,
370                                             NULL, NULL, &sig_name, ameth);
371             }
372             if (md != NULL)
373                 md_name = EVP_MD_name(md);
374         }
375         ret = 0;
376         for (i = 0; i < argc; i++) {
377             int r;
378             if (BIO_read_filename(in, argv[i]) <= 0) {
379                 perror(argv[i]);
380                 ret++;
381                 continue;
382             } else {
383                 r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
384                           siglen, sig_name, md_name, argv[i]);
385             }
386             if (r)
387                 ret = r;
388             (void)BIO_reset(bmd);
389         }
390     }
391  end:
392     OPENSSL_clear_free(buf, BUFSIZE);
393     BIO_free(in);
394     OPENSSL_free(passin);
395     BIO_free_all(out);
396     EVP_PKEY_free(sigkey);
397     sk_OPENSSL_STRING_free(sigopts);
398     sk_OPENSSL_STRING_free(macopts);
399     OPENSSL_free(sigbuf);
400     BIO_free(bmd);
401     release_engine(e);
402     return ret;
403 }
404
405 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
406           EVP_PKEY *key, unsigned char *sigin, int siglen,
407           const char *sig_name, const char *md_name,
408           const char *file)
409 {
410     size_t len;
411     int i;
412
413     for (;;) {
414         i = BIO_read(bp, (char *)buf, BUFSIZE);
415         if (i < 0) {
416             BIO_printf(bio_err, "Read Error in %s\n", file);
417             ERR_print_errors(bio_err);
418             return 1;
419         }
420         if (i == 0)
421             break;
422     }
423     if (sigin != NULL) {
424         EVP_MD_CTX *ctx;
425         BIO_get_md_ctx(bp, &ctx);
426         i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
427         if (i > 0) {
428             BIO_printf(out, "Verified OK\n");
429         } else if (i == 0) {
430             BIO_printf(out, "Verification Failure\n");
431             return 1;
432         } else {
433             BIO_printf(bio_err, "Error Verifying Data\n");
434             ERR_print_errors(bio_err);
435             return 1;
436         }
437         return 0;
438     }
439     if (key != NULL) {
440         EVP_MD_CTX *ctx;
441         BIO_get_md_ctx(bp, &ctx);
442         len = BUFSIZE;
443         if (!EVP_DigestSignFinal(ctx, buf, &len)) {
444             BIO_printf(bio_err, "Error Signing Data\n");
445             ERR_print_errors(bio_err);
446             return 1;
447         }
448     } else {
449         len = BIO_gets(bp, (char *)buf, BUFSIZE);
450         if ((int)len < 0) {
451             ERR_print_errors(bio_err);
452             return 1;
453         }
454     }
455
456     if (binout) {
457         BIO_write(out, buf, len);
458     } else if (sep == 2) {
459         for (i = 0; i < (int)len; i++)
460             BIO_printf(out, "%02x", buf[i]);
461         BIO_printf(out, " *%s\n", file);
462     } else {
463         if (sig_name != NULL) {
464             BIO_puts(out, sig_name);
465             if (md_name != NULL)
466                 BIO_printf(out, "-%s", md_name);
467             BIO_printf(out, "(%s)= ", file);
468         } else if (md_name != NULL) {
469             BIO_printf(out, "%s(%s)= ", md_name, file);
470         } else {
471             BIO_printf(out, "(%s)= ", file);
472         }
473         for (i = 0; i < (int)len; i++) {
474             if (sep && (i != 0))
475                 BIO_printf(out, ":");
476             BIO_printf(out, "%02x", buf[i]);
477         }
478         BIO_printf(out, "\n");
479     }
480     return 0;
481 }