Document openssl dgst -hmac option
[openssl.git] / apps / dgst.c
1 /* apps/dgst.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include <string.h>
61 #include <stdlib.h>
62 #include "apps.h"
63 #include <openssl/bio.h>
64 #include <openssl/err.h>
65 #include <openssl/evp.h>
66 #include <openssl/objects.h>
67 #include <openssl/x509.h>
68 #include <openssl/pem.h>
69 #include <openssl/hmac.h>
70
71 #undef BUFSIZE
72 #define BUFSIZE 1024*8
73
74 #undef PROG
75 #define PROG    dgst_main
76
77 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
78           EVP_PKEY *key, unsigned char *sigin, int siglen,
79           const char *sig_name, const char *md_name,
80           const char *file,BIO *bmd);
81
82 static void list_md_fn(const EVP_MD *m,
83                         const char *from, const char *to, void *arg)
84         {
85         const char *mname;
86         /* Skip aliases */
87         if (!m)
88                 return;
89         mname = OBJ_nid2ln(EVP_MD_type(m));
90         /* Skip shortnames */
91         if (strcmp(from, mname))
92                 return;
93         /* Skip clones */
94         if (EVP_MD_flags(m) & EVP_MD_FLAG_PKEY_DIGEST)
95                 return;
96         if (strchr(mname, ' '))
97                 mname= EVP_MD_name(m);
98         BIO_printf(arg, "-%-14s to use the %s message digest algorithm\n",
99                         mname, mname);
100         }
101
102 int MAIN(int, char **);
103
104 int MAIN(int argc, char **argv)
105         {
106         ENGINE *e = NULL;
107         unsigned char *buf=NULL;
108         int i,err=1;
109         const EVP_MD *md=NULL,*m;
110         BIO *in=NULL,*inp;
111         BIO *bmd=NULL;
112         BIO *out = NULL;
113 #define PROG_NAME_SIZE  39
114         char pname[PROG_NAME_SIZE+1];
115         int separator=0;
116         int debug=0;
117         int keyform=FORMAT_PEM;
118         const char *outfile = NULL, *keyfile = NULL;
119         const char *sigfile = NULL, *randfile = NULL;
120         int out_bin = -1, want_pub = 0, do_verify = 0;
121         EVP_PKEY *sigkey = NULL;
122         unsigned char *sigbuf = NULL;
123         int siglen = 0;
124         char *passargin = NULL, *passin = NULL;
125 #ifndef OPENSSL_NO_ENGINE
126         char *engine=NULL;
127 #endif
128         char *hmac_key=NULL;
129         char *mac_name=NULL;
130         int non_fips_allow = 0;
131         STACK_OF(OPENSSL_STRING) *sigopts = NULL, *macopts = NULL;
132
133         apps_startup();
134
135         if ((buf=(unsigned char *)OPENSSL_malloc(BUFSIZE)) == NULL)
136                 {
137                 BIO_printf(bio_err,"out of memory\n");
138                 goto end;
139                 }
140         if (bio_err == NULL)
141                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
142                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
143
144         if (!load_config(bio_err, NULL))
145                 goto end;
146
147         /* first check the program name */
148         program_name(argv[0],pname,sizeof pname);
149
150         md=EVP_get_digestbyname(pname);
151
152         argc--;
153         argv++;
154         while (argc > 0)
155                 {
156                 if ((*argv)[0] != '-') break;
157                 if (strcmp(*argv,"-c") == 0)
158                         separator=1;
159                 else if (strcmp(*argv,"-r") == 0)
160                         separator=2;
161                 else if (strcmp(*argv,"-rand") == 0)
162                         {
163                         if (--argc < 1) break;
164                         randfile=*(++argv);
165                         }
166                 else if (strcmp(*argv,"-out") == 0)
167                         {
168                         if (--argc < 1) break;
169                         outfile=*(++argv);
170                         }
171                 else if (strcmp(*argv,"-sign") == 0)
172                         {
173                         if (--argc < 1) break;
174                         keyfile=*(++argv);
175                         }
176                 else if (!strcmp(*argv,"-passin"))
177                         {
178                         if (--argc < 1)
179                                 break;
180                         passargin=*++argv;
181                         }
182                 else if (strcmp(*argv,"-verify") == 0)
183                         {
184                         if (--argc < 1) break;
185                         keyfile=*(++argv);
186                         want_pub = 1;
187                         do_verify = 1;
188                         }
189                 else if (strcmp(*argv,"-prverify") == 0)
190                         {
191                         if (--argc < 1) break;
192                         keyfile=*(++argv);
193                         do_verify = 1;
194                         }
195                 else if (strcmp(*argv,"-signature") == 0)
196                         {
197                         if (--argc < 1) break;
198                         sigfile=*(++argv);
199                         }
200                 else if (strcmp(*argv,"-keyform") == 0)
201                         {
202                         if (--argc < 1) break;
203                         keyform=str2fmt(*(++argv));
204                         }
205 #ifndef OPENSSL_NO_ENGINE
206                 else if (strcmp(*argv,"-engine") == 0)
207                         {
208                         if (--argc < 1) break;
209                         engine= *(++argv);
210                         e = setup_engine(bio_err, engine, 0);
211                         }
212 #endif
213                 else if (strcmp(*argv,"-hex") == 0)
214                         out_bin = 0;
215                 else if (strcmp(*argv,"-binary") == 0)
216                         out_bin = 1;
217                 else if (strcmp(*argv,"-d") == 0)
218                         debug=1;
219                 else if (!strcmp(*argv,"-fips-fingerprint"))
220                         hmac_key = "etaonrishdlcupfm";
221                 else if (strcmp(*argv,"-non-fips-allow") == 0)
222                         non_fips_allow=1;
223                 else if (!strcmp(*argv,"-hmac"))
224                         {
225                         if (--argc < 1)
226                                 break;
227                         hmac_key=*++argv;
228                         }
229                 else if (!strcmp(*argv,"-mac"))
230                         {
231                         if (--argc < 1)
232                                 break;
233                         mac_name=*++argv;
234                         }
235                 else if (strcmp(*argv,"-sigopt") == 0)
236                         {
237                         if (--argc < 1)
238                                 break;
239                         if (!sigopts)
240                                 sigopts = sk_OPENSSL_STRING_new_null();
241                         if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, *(++argv)))
242                                 break;
243                         }
244                 else if (strcmp(*argv,"-macopt") == 0)
245                         {
246                         if (--argc < 1)
247                                 break;
248                         if (!macopts)
249                                 macopts = sk_OPENSSL_STRING_new_null();
250                         if (!macopts || !sk_OPENSSL_STRING_push(macopts, *(++argv)))
251                                 break;
252                         }
253                 else if ((m=EVP_get_digestbyname(&((*argv)[1]))) != NULL)
254                         md=m;
255                 else
256                         break;
257                 argc--;
258                 argv++;
259                 }
260
261
262         if(do_verify && !sigfile) {
263                 BIO_printf(bio_err, "No signature to verify: use the -signature option\n");
264                 goto end;
265         }
266
267         if ((argc > 0) && (argv[0][0] == '-')) /* bad option */
268                 {
269                 BIO_printf(bio_err,"unknown option '%s'\n",*argv);
270                 BIO_printf(bio_err,"options are\n");
271                 BIO_printf(bio_err,"-c              to output the digest with separating colons\n");
272                 BIO_printf(bio_err,"-r              to output the digest in coreutils format\n");
273                 BIO_printf(bio_err,"-d              to output debug info\n");
274                 BIO_printf(bio_err,"-hex            output as hex dump\n");
275                 BIO_printf(bio_err,"-binary         output in binary form\n");
276                 BIO_printf(bio_err,"-hmac arg       set the HMAC key to arg\n");
277                 BIO_printf(bio_err,"-non-fips-allow allow use of non FIPS digest\n");
278                 BIO_printf(bio_err,"-sign   file    sign digest using private key in file\n");
279                 BIO_printf(bio_err,"-verify file    verify a signature using public key in file\n");
280                 BIO_printf(bio_err,"-prverify file  verify a signature using private key in file\n");
281                 BIO_printf(bio_err,"-keyform arg    key file format (PEM or ENGINE)\n");
282                 BIO_printf(bio_err,"-out filename   output to filename rather than stdout\n");
283                 BIO_printf(bio_err,"-signature file signature to verify\n");
284                 BIO_printf(bio_err,"-sigopt nm:v    signature parameter\n");
285                 BIO_printf(bio_err,"-hmac key       create hashed MAC with key\n");
286                 BIO_printf(bio_err,"-mac algorithm  create MAC (not neccessarily HMAC)\n"); 
287                 BIO_printf(bio_err,"-macopt nm:v    MAC algorithm parameters or key\n");
288 #ifndef OPENSSL_NO_ENGINE
289                 BIO_printf(bio_err,"-engine e       use engine e, possibly a hardware device.\n");
290 #endif
291
292                 EVP_MD_do_all_sorted(list_md_fn, bio_err);
293                 goto end;
294                 }
295
296         in=BIO_new(BIO_s_file());
297         bmd=BIO_new(BIO_f_md());
298         if (debug)
299                 {
300                 BIO_set_callback(in,BIO_debug_callback);
301                 /* needed for windows 3.1 */
302                 BIO_set_callback_arg(in,(char *)bio_err);
303                 }
304
305         if(!app_passwd(bio_err, passargin, NULL, &passin, NULL))
306                 {
307                 BIO_printf(bio_err, "Error getting password\n");
308                 goto end;
309                 }
310
311         if ((in == NULL) || (bmd == NULL))
312                 {
313                 ERR_print_errors(bio_err);
314                 goto end;
315                 }
316
317         if(out_bin == -1) {
318                 if(keyfile)
319                         out_bin = 1;
320                 else
321                         out_bin = 0;
322         }
323
324         if(randfile)
325                 app_RAND_load_file(randfile, bio_err, 0);
326
327         if(outfile) {
328                 if(out_bin)
329                         out = BIO_new_file(outfile, "wb");
330                 else    out = BIO_new_file(outfile, "w");
331         } else {
332                 out = BIO_new_fp(stdout, BIO_NOCLOSE);
333 #ifdef OPENSSL_SYS_VMS
334                 {
335                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
336                 out = BIO_push(tmpbio, out);
337                 }
338 #endif
339         }
340
341         if(!out) {
342                 BIO_printf(bio_err, "Error opening output file %s\n", 
343                                         outfile ? outfile : "(stdout)");
344                 ERR_print_errors(bio_err);
345                 goto end;
346         }
347         if ((!!mac_name + !!keyfile + !!hmac_key) > 1)
348                 {
349                 BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
350                 goto end;
351                 }
352
353         if(keyfile)
354                 {
355                 if (want_pub)
356                         sigkey = load_pubkey(bio_err, keyfile, keyform, 0, NULL,
357                                 e, "key file");
358                 else
359                         sigkey = load_key(bio_err, keyfile, keyform, 0, passin,
360                                 e, "key file");
361                 if (!sigkey)
362                         {
363                         /* load_[pub]key() has already printed an appropriate
364                            message */
365                         goto end;
366                         }
367                 }
368
369         if (mac_name)
370                 {
371                 EVP_PKEY_CTX *mac_ctx = NULL;
372                 int r = 0;
373                 if (!init_gen_str(bio_err, &mac_ctx, mac_name,e, 0))
374                         goto mac_end;
375                 if (macopts)
376                         {
377                         char *macopt;
378                         for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++)
379                                 {
380                                 macopt = sk_OPENSSL_STRING_value(macopts, i);
381                                 if (pkey_ctrl_string(mac_ctx, macopt) <= 0)
382                                         {
383                                         BIO_printf(bio_err,
384                                                 "MAC parameter error \"%s\"\n",
385                                                 macopt);
386                                         ERR_print_errors(bio_err);
387                                         goto mac_end;
388                                         }
389                                 }
390                         }
391                 if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0)
392                         {
393                         BIO_puts(bio_err, "Error generating key\n");
394                         ERR_print_errors(bio_err);
395                         goto mac_end;
396                         }
397                 r = 1;
398                 mac_end:
399                 if (mac_ctx)
400                         EVP_PKEY_CTX_free(mac_ctx);
401                 if (r == 0)
402                         goto end;
403                 }
404
405         if (non_fips_allow)
406                 {
407                 EVP_MD_CTX *md_ctx;
408                 BIO_get_md_ctx(bmd,&md_ctx);
409                 EVP_MD_CTX_set_flags(md_ctx, EVP_MD_CTX_FLAG_NON_FIPS_ALLOW);
410                 }
411
412         if (hmac_key)
413                 {
414                 sigkey = EVP_PKEY_new_mac_key(EVP_PKEY_HMAC, e,
415                                         (unsigned char *)hmac_key, -1);
416                 if (!sigkey)
417                         goto end;
418                 }
419
420         if (sigkey)
421                 {
422                 EVP_MD_CTX *mctx = NULL;
423                 EVP_PKEY_CTX *pctx = NULL;
424                 int r;
425                 if (!BIO_get_md_ctx(bmd, &mctx))
426                         {
427                         BIO_printf(bio_err, "Error getting context\n");
428                         ERR_print_errors(bio_err);
429                         goto end;
430                         }
431                 if (do_verify)
432                         r = EVP_DigestVerifyInit(mctx, &pctx, md, NULL, sigkey);
433                 else
434                         r = EVP_DigestSignInit(mctx, &pctx, md, NULL, sigkey);
435                 if (!r)
436                         {
437                         BIO_printf(bio_err, "Error setting context\n");
438                         ERR_print_errors(bio_err);
439                         goto end;
440                         }
441                 if (sigopts)
442                         {
443                         char *sigopt;
444                         for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++)
445                                 {
446                                 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
447                                 if (pkey_ctrl_string(pctx, sigopt) <= 0)
448                                         {
449                                         BIO_printf(bio_err,
450                                                 "parameter error \"%s\"\n",
451                                                 sigopt);
452                                         ERR_print_errors(bio_err);
453                                         goto end;
454                                         }
455                                 }
456                         }
457                 }
458         /* we use md as a filter, reading from 'in' */
459         else
460                 {
461                 if (md == NULL)
462                         md = EVP_md5(); 
463                 if (!BIO_set_md(bmd,md))
464                         {
465                         BIO_printf(bio_err, "Error setting digest %s\n", pname);
466                         ERR_print_errors(bio_err);
467                         goto end;
468                         }
469                 }
470
471         if(sigfile && sigkey) {
472                 BIO *sigbio;
473                 sigbio = BIO_new_file(sigfile, "rb");
474                 siglen = EVP_PKEY_size(sigkey);
475                 sigbuf = OPENSSL_malloc(siglen);
476                 if(!sigbio) {
477                         BIO_printf(bio_err, "Error opening signature file %s\n",
478                                                                 sigfile);
479                         ERR_print_errors(bio_err);
480                         goto end;
481                 }
482                 siglen = BIO_read(sigbio, sigbuf, siglen);
483                 BIO_free(sigbio);
484                 if(siglen <= 0) {
485                         BIO_printf(bio_err, "Error reading signature file %s\n",
486                                                                 sigfile);
487                         ERR_print_errors(bio_err);
488                         goto end;
489                 }
490         }
491         inp=BIO_push(bmd,in);
492
493         if (md == NULL)
494                 {
495                 EVP_MD_CTX *tctx;
496                 BIO_get_md_ctx(bmd, &tctx);
497                 md = EVP_MD_CTX_md(tctx);
498                 }
499
500         if (argc == 0)
501                 {
502                 BIO_set_fp(in,stdin,BIO_NOCLOSE);
503                 err=do_fp(out, buf,inp,separator, out_bin, sigkey, sigbuf,
504                           siglen,NULL,NULL,"stdin",bmd);
505                 }
506         else
507                 {
508                 const char *md_name = NULL, *sig_name = NULL;
509                 if(!out_bin)
510                         {
511                         if (sigkey)
512                                 {
513                                 const EVP_PKEY_ASN1_METHOD *ameth;
514                                 ameth = EVP_PKEY_get0_asn1(sigkey);
515                                 if (ameth)
516                                         EVP_PKEY_asn1_get0_info(NULL, NULL,
517                                                 NULL, NULL, &sig_name, ameth);
518                                 }
519                         md_name = EVP_MD_name(md);
520                         }
521                 err = 0;
522                 for (i=0; i<argc; i++)
523                         {
524                         int r;
525                         if (BIO_read_filename(in,argv[i]) <= 0)
526                                 {
527                                 perror(argv[i]);
528                                 err++;
529                                 continue;
530                                 }
531                         else
532                         r=do_fp(out,buf,inp,separator,out_bin,sigkey,sigbuf,
533                                 siglen,sig_name,md_name, argv[i],bmd);
534                         if(r)
535                             err=r;
536                         (void)BIO_reset(bmd);
537                         }
538                 }
539 end:
540         if (buf != NULL)
541                 {
542                 OPENSSL_cleanse(buf,BUFSIZE);
543                 OPENSSL_free(buf);
544                 }
545         if (in != NULL) BIO_free(in);
546         if (passin)
547                 OPENSSL_free(passin);
548         BIO_free_all(out);
549         EVP_PKEY_free(sigkey);
550         if (sigopts)
551                 sk_OPENSSL_STRING_free(sigopts);
552         if (macopts)
553                 sk_OPENSSL_STRING_free(macopts);
554         if(sigbuf) OPENSSL_free(sigbuf);
555         if (bmd != NULL) BIO_free(bmd);
556         apps_shutdown();
557         OPENSSL_EXIT(err);
558         }
559
560 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
561           EVP_PKEY *key, unsigned char *sigin, int siglen,
562           const char *sig_name, const char *md_name,
563           const char *file,BIO *bmd)
564         {
565         size_t len;
566         int i;
567
568         for (;;)
569                 {
570                 i=BIO_read(bp,(char *)buf,BUFSIZE);
571                 if(i < 0)
572                         {
573                         BIO_printf(bio_err, "Read Error in %s\n",file);
574                         ERR_print_errors(bio_err);
575                         return 1;
576                         }
577                 if (i == 0) break;
578                 }
579         if(sigin)
580                 {
581                 EVP_MD_CTX *ctx;
582                 BIO_get_md_ctx(bp, &ctx);
583                 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen); 
584                 if(i > 0)
585                         BIO_printf(out, "Verified OK\n");
586                 else if(i == 0)
587                         {
588                         BIO_printf(out, "Verification Failure\n");
589                         return 1;
590                         }
591                 else
592                         {
593                         BIO_printf(bio_err, "Error Verifying Data\n");
594                         ERR_print_errors(bio_err);
595                         return 1;
596                         }
597                 return 0;
598                 }
599         if(key)
600                 {
601                 EVP_MD_CTX *ctx;
602                 BIO_get_md_ctx(bp, &ctx);
603                 len = BUFSIZE;
604                 if(!EVP_DigestSignFinal(ctx, buf, &len)) 
605                         {
606                         BIO_printf(bio_err, "Error Signing Data\n");
607                         ERR_print_errors(bio_err);
608                         return 1;
609                         }
610                 }
611         else
612                 {
613                 len=BIO_gets(bp,(char *)buf,BUFSIZE);
614                 if ((int)len <0)
615                         {
616                         ERR_print_errors(bio_err);
617                         return 1;
618                         }
619                 }
620
621         if(binout) BIO_write(out, buf, len);
622         else if (sep == 2)
623                 {
624                 for (i=0; i<(int)len; i++)
625                         BIO_printf(out, "%02x",buf[i]);
626                 BIO_printf(out, " *%s\n", file);
627                 }
628         else 
629                 {
630                 if (sig_name)
631                         BIO_printf(out, "%s-%s(%s)= ", sig_name, md_name, file);
632                 else if (md_name)
633                         BIO_printf(out, "%s(%s)= ", md_name, file);
634                 else
635                         BIO_printf(out, "(%s)= ", file);
636                 for (i=0; i<(int)len; i++)
637                         {
638                         if (sep && (i != 0))
639                                 BIO_printf(out, ":");
640                         BIO_printf(out, "%02x",buf[i]);
641                         }
642                 BIO_printf(out, "\n");
643                 }
644         return 0;
645         }
646