Provide information about "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 int MAIN(int, char **);
83
84 int MAIN(int argc, char **argv)
85         {
86         ENGINE *e = NULL;
87         unsigned char *buf=NULL;
88         int i,err=1;
89         const EVP_MD *md=NULL,*m;
90         BIO *in=NULL,*inp;
91         BIO *bmd=NULL;
92         BIO *out = NULL;
93 #define PROG_NAME_SIZE  39
94         char pname[PROG_NAME_SIZE+1];
95         int separator=0;
96         int debug=0;
97         int keyform=FORMAT_PEM;
98         const char *outfile = NULL, *keyfile = NULL;
99         const char *sigfile = NULL, *randfile = NULL;
100         int out_bin = -1, want_pub = 0, do_verify = 0;
101         EVP_PKEY *sigkey = NULL;
102         unsigned char *sigbuf = NULL;
103         int siglen = 0;
104         char *passargin = NULL, *passin = NULL;
105 #ifndef OPENSSL_NO_ENGINE
106         char *engine=NULL;
107 #endif
108         char *hmac_key=NULL;
109         char *mac_name=NULL;
110         STACK *sigopts = NULL, *macopts = NULL;
111
112         apps_startup();
113
114         if ((buf=(unsigned char *)OPENSSL_malloc(BUFSIZE)) == NULL)
115                 {
116                 BIO_printf(bio_err,"out of memory\n");
117                 goto end;
118                 }
119         if (bio_err == NULL)
120                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
121                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
122
123         if (!load_config(bio_err, NULL))
124                 goto end;
125
126         /* first check the program name */
127         program_name(argv[0],pname,sizeof pname);
128
129         md=EVP_get_digestbyname(pname);
130
131         argc--;
132         argv++;
133         while (argc > 0)
134                 {
135                 if ((*argv)[0] != '-') break;
136                 if (strcmp(*argv,"-c") == 0)
137                         separator=1;
138                 else if (strcmp(*argv,"-rand") == 0)
139                         {
140                         if (--argc < 1) break;
141                         randfile=*(++argv);
142                         }
143                 else if (strcmp(*argv,"-out") == 0)
144                         {
145                         if (--argc < 1) break;
146                         outfile=*(++argv);
147                         }
148                 else if (strcmp(*argv,"-sign") == 0)
149                         {
150                         if (--argc < 1) break;
151                         keyfile=*(++argv);
152                         }
153                 else if (!strcmp(*argv,"-passin"))
154                         {
155                         if (--argc < 1)
156                                 break;
157                         passargin=*++argv;
158                         }
159                 else if (strcmp(*argv,"-verify") == 0)
160                         {
161                         if (--argc < 1) break;
162                         keyfile=*(++argv);
163                         want_pub = 1;
164                         do_verify = 1;
165                         }
166                 else if (strcmp(*argv,"-prverify") == 0)
167                         {
168                         if (--argc < 1) break;
169                         keyfile=*(++argv);
170                         do_verify = 1;
171                         }
172                 else if (strcmp(*argv,"-signature") == 0)
173                         {
174                         if (--argc < 1) break;
175                         sigfile=*(++argv);
176                         }
177                 else if (strcmp(*argv,"-keyform") == 0)
178                         {
179                         if (--argc < 1) break;
180                         keyform=str2fmt(*(++argv));
181                         }
182 #ifndef OPENSSL_NO_ENGINE
183                 else if (strcmp(*argv,"-engine") == 0)
184                         {
185                         if (--argc < 1) break;
186                         engine= *(++argv);
187                         e = setup_engine(bio_err, engine, 0);
188                         }
189 #endif
190                 else if (strcmp(*argv,"-hex") == 0)
191                         out_bin = 0;
192                 else if (strcmp(*argv,"-binary") == 0)
193                         out_bin = 1;
194                 else if (strcmp(*argv,"-d") == 0)
195                         debug=1;
196                 else if (!strcmp(*argv,"-hmac"))
197                         {
198                         if (--argc < 1)
199                                 break;
200                         hmac_key=*++argv;
201                         }
202                 else if (!strcmp(*argv,"-mac"))
203                         {
204                         if (--argc < 1)
205                                 break;
206                         mac_name=*++argv;
207                         }
208                 else if (strcmp(*argv,"-sigopt") == 0)
209                         {
210                         if (--argc < 1)
211                                 break;
212                         if (!sigopts)
213                                 sigopts = sk_new_null();
214                         if (!sigopts || !sk_push(sigopts, *(++argv)))
215                                 break;
216                         }
217                 else if (strcmp(*argv,"-macopt") == 0)
218                         {
219                         if (--argc < 1)
220                                 break;
221                         if (!macopts)
222                                 macopts = sk_new_null();
223                         if (!macopts || !sk_push(macopts, *(++argv)))
224                                 break;
225                         }
226                 else if ((m=EVP_get_digestbyname(&((*argv)[1]))) != NULL)
227                         md=m;
228                 else
229                         break;
230                 argc--;
231                 argv++;
232                 }
233
234
235         if(do_verify && !sigfile) {
236                 BIO_printf(bio_err, "No signature to verify: use the -signature option\n");
237                 goto end;
238         }
239
240         if ((argc > 0) && (argv[0][0] == '-')) /* bad option */
241                 {
242                 BIO_printf(bio_err,"unknown option '%s'\n",*argv);
243                 BIO_printf(bio_err,"options are\n");
244                 BIO_printf(bio_err,"-c              to output the digest with separating colons\n");
245                 BIO_printf(bio_err,"-d              to output debug info\n");
246                 BIO_printf(bio_err,"-hex            output as hex dump\n");
247                 BIO_printf(bio_err,"-binary         output in binary form\n");
248                 BIO_printf(bio_err,"-sign   file    sign digest using private key in file\n");
249                 BIO_printf(bio_err,"-verify file    verify a signature using public key in file\n");
250                 BIO_printf(bio_err,"-prverify file  verify a signature using private key in file\n");
251                 BIO_printf(bio_err,"-keyform arg    key file format (PEM or ENGINE)\n");
252                 BIO_printf(bio_err,"-signature file signature to verify\n");
253                 BIO_printf(bio_err,"-sigopt nm:v    signature parameter\n");
254                 BIO_printf(bio_err,"-binary         output in binary form\n");
255                 BIO_printf(bio_err,"-hmac key       create hashed MAC with key\n");
256 #ifndef OPENSSL_NO_ENGINE
257                 BIO_printf(bio_err,"-engine e       use engine e, possibly a hardware device.\n");
258 #endif
259
260                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm (default)\n",
261                         LN_md5,LN_md5);
262                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
263                         LN_md4,LN_md4);
264                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
265                         LN_md2,LN_md2);
266 #ifndef OPENSSL_NO_SHA
267                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
268                         LN_sha1,LN_sha1);
269 #ifndef OPENSSL_NO_SHA256
270                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
271                         LN_sha224,LN_sha224);
272                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
273                         LN_sha256,LN_sha256);
274 #endif
275 #ifndef OPENSSL_NO_SHA512
276                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
277                         LN_sha384,LN_sha384);
278                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
279                         LN_sha512,LN_sha512);
280 #endif
281 #endif
282                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
283                         LN_mdc2,LN_mdc2);
284                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
285                         LN_ripemd160,LN_ripemd160);
286 #ifndef OPENSSL_NO_WHIRLPOOL
287                 BIO_printf(bio_err,"-%-14s to use the %s message digest algorithm\n",
288                         SN_whirlpool,SN_whirlpool);
289 #endif
290                 goto end;
291                 }
292
293         in=BIO_new(BIO_s_file());
294         bmd=BIO_new(BIO_f_md());
295         if (debug)
296                 {
297                 BIO_set_callback(in,BIO_debug_callback);
298                 /* needed for windows 3.1 */
299                 BIO_set_callback_arg(in,(char *)bio_err);
300                 }
301
302         if(!app_passwd(bio_err, passargin, NULL, &passin, NULL))
303                 {
304                 BIO_printf(bio_err, "Error getting password\n");
305                 goto end;
306                 }
307
308         if ((in == NULL) || (bmd == NULL))
309                 {
310                 ERR_print_errors(bio_err);
311                 goto end;
312                 }
313
314         if(out_bin == -1) {
315                 if(keyfile)
316                         out_bin = 1;
317                 else
318                         out_bin = 0;
319         }
320
321         if(randfile)
322                 app_RAND_load_file(randfile, bio_err, 0);
323
324         if(outfile) {
325                 if(out_bin)
326                         out = BIO_new_file(outfile, "wb");
327                 else    out = BIO_new_file(outfile, "w");
328         } else {
329                 out = BIO_new_fp(stdout, BIO_NOCLOSE);
330 #ifdef OPENSSL_SYS_VMS
331                 {
332                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
333                 out = BIO_push(tmpbio, out);
334                 }
335 #endif
336         }
337
338         if(!out) {
339                 BIO_printf(bio_err, "Error opening output file %s\n", 
340                                         outfile ? outfile : "(stdout)");
341                 ERR_print_errors(bio_err);
342                 goto end;
343         }
344         if ((!!mac_name + !!keyfile + !!hmac_key) > 1)
345                 {
346                 BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
347                 goto end;
348                 }
349
350         if(keyfile)
351                 {
352                 if (want_pub)
353                         sigkey = load_pubkey(bio_err, keyfile, keyform, 0, NULL,
354                                 e, "key file");
355                 else
356                         sigkey = load_key(bio_err, keyfile, keyform, 0, passin,
357                                 e, "key file");
358                 if (!sigkey)
359                         {
360                         /* load_[pub]key() has already printed an appropriate
361                            message */
362                         goto end;
363                         }
364                 }
365
366         if (mac_name)
367                 {
368                 EVP_PKEY_CTX *mac_ctx = NULL;
369                 int r = 0;
370                 if (!init_gen_str(bio_err, &mac_ctx, mac_name,e, 0))
371                         goto mac_end;
372                 if (macopts)
373                         {
374                         char *macopt;
375                         for (i = 0; i < sk_num(macopts); i++)
376                                 {
377                                 macopt = sk_value(macopts, i);
378                                 if (pkey_ctrl_string(mac_ctx, macopt) <= 0)
379                                         {
380                                         BIO_printf(bio_err,
381                                                 "MAC parameter error \"%s\"\n",
382                                                 macopt);
383                                         ERR_print_errors(bio_err);
384                                         goto mac_end;
385                                         }
386                                 }
387                         }
388                 if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0)
389                         {
390                         BIO_puts(bio_err, "Error generating key\n");
391                         ERR_print_errors(bio_err);
392                         goto mac_end;
393                         }
394                 r = 1;
395                 mac_end:
396                 if (mac_ctx)
397                         EVP_PKEY_CTX_free(mac_ctx);
398                 if (r == 0)
399                         goto end;
400                 }
401
402         if (hmac_key)
403                 {
404                 sigkey = EVP_PKEY_new_mac_key(EVP_PKEY_HMAC, e,
405                                         (unsigned char *)hmac_key, -1);
406                 if (!sigkey)
407                         goto end;
408                 }
409
410         if (sigkey)
411                 {
412                 EVP_MD_CTX *mctx = NULL;
413                 EVP_PKEY_CTX *pctx = NULL;
414                 int r;
415                 if (!BIO_get_md_ctx(bmd, &mctx))
416                         {
417                         BIO_printf(bio_err, "Error getting context\n");
418                         ERR_print_errors(bio_err);
419                         goto end;
420                         }
421                 if (do_verify)
422                         r = EVP_DigestVerifyInit(mctx, &pctx, md, e, sigkey);
423                 else
424                         r = EVP_DigestSignInit(mctx, &pctx, md, e, sigkey);
425                 if (!r)
426                         {
427                         BIO_printf(bio_err, "Error setting context\n");
428                         ERR_print_errors(bio_err);
429                         goto end;
430                         }
431                 if (sigopts)
432                         {
433                         char *sigopt;
434                         for (i = 0; i < sk_num(sigopts); i++)
435                                 {
436                                 sigopt = sk_value(sigopts, i);
437                                 if (pkey_ctrl_string(pctx, sigopt) <= 0)
438                                         {
439                                         BIO_printf(bio_err,
440                                                 "parameter error \"%s\"\n",
441                                                 sigopt);
442                                         ERR_print_errors(bio_err);
443                                         goto end;
444                                         }
445                                 }
446                         }
447                 }
448         /* we use md as a filter, reading from 'in' */
449         else
450                 {
451                 if (md == NULL)
452                         md = EVP_md5(); 
453                 if (!BIO_set_md(bmd,md))
454                         {
455                         BIO_printf(bio_err, "Error setting digest %s\n", pname);
456                         ERR_print_errors(bio_err);
457                         goto end;
458                         }
459                 }
460
461         if(sigfile && sigkey) {
462                 BIO *sigbio;
463                 sigbio = BIO_new_file(sigfile, "rb");
464                 siglen = EVP_PKEY_size(sigkey);
465                 sigbuf = OPENSSL_malloc(siglen);
466                 if(!sigbio) {
467                         BIO_printf(bio_err, "Error opening signature file %s\n",
468                                                                 sigfile);
469                         ERR_print_errors(bio_err);
470                         goto end;
471                 }
472                 siglen = BIO_read(sigbio, sigbuf, siglen);
473                 BIO_free(sigbio);
474                 if(siglen <= 0) {
475                         BIO_printf(bio_err, "Error reading signature file %s\n",
476                                                                 sigfile);
477                         ERR_print_errors(bio_err);
478                         goto end;
479                 }
480         }
481         inp=BIO_push(bmd,in);
482
483         if (md == NULL)
484                 {
485                 EVP_MD_CTX *tctx;
486                 BIO_get_md_ctx(bmd, &tctx);
487                 md = EVP_MD_CTX_md(tctx);
488                 }
489
490         if (argc == 0)
491                 {
492                 BIO_set_fp(in,stdin,BIO_NOCLOSE);
493                 err=do_fp(out, buf,inp,separator, out_bin, sigkey, sigbuf,
494                           siglen,NULL,NULL,"stdin",bmd);
495                 }
496         else
497                 {
498                 const char *md_name = NULL, *sig_name = NULL;
499                 if(!out_bin)
500                         {
501                         if (sigkey)
502                                 {
503                                 const EVP_PKEY_ASN1_METHOD *ameth;
504                                 ameth = EVP_PKEY_get0_asn1(sigkey);
505                                 if (ameth)
506                                         EVP_PKEY_asn1_get0_info(NULL, NULL,
507                                                 NULL, NULL, &sig_name, ameth);
508                                 }
509                         md_name = EVP_MD_name(md);
510                         }
511                 err = 0;
512                 for (i=0; i<argc; i++)
513                         {
514                         int r;
515                         if (BIO_read_filename(in,argv[i]) <= 0)
516                                 {
517                                 perror(argv[i]);
518                                 err++;
519                                 continue;
520                                 }
521                         else
522                         r=do_fp(out,buf,inp,separator,out_bin,sigkey,sigbuf,
523                                 siglen,sig_name,md_name, argv[i],bmd);
524                         if(r)
525                             err=r;
526                         (void)BIO_reset(bmd);
527                         }
528                 }
529 end:
530         if (buf != NULL)
531                 {
532                 OPENSSL_cleanse(buf,BUFSIZE);
533                 OPENSSL_free(buf);
534                 }
535         if (in != NULL) BIO_free(in);
536         if (passin)
537                 OPENSSL_free(passin);
538         BIO_free_all(out);
539         EVP_PKEY_free(sigkey);
540         if (sigopts)
541                 sk_free(sigopts);
542         if (macopts)
543                 sk_free(macopts);
544         if(sigbuf) OPENSSL_free(sigbuf);
545         if (bmd != NULL) BIO_free(bmd);
546         apps_shutdown();
547         OPENSSL_EXIT(err);
548         }
549
550 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
551           EVP_PKEY *key, unsigned char *sigin, int siglen,
552           const char *sig_name, const char *md_name,
553           const char *file,BIO *bmd)
554         {
555         size_t len;
556         int i;
557
558         for (;;)
559                 {
560                 i=BIO_read(bp,(char *)buf,BUFSIZE);
561                 if(i < 0)
562                         {
563                         BIO_printf(bio_err, "Read Error in %s\n",file);
564                         ERR_print_errors(bio_err);
565                         return 1;
566                         }
567                 if (i == 0) break;
568                 }
569         if(sigin)
570                 {
571                 EVP_MD_CTX *ctx;
572                 BIO_get_md_ctx(bp, &ctx);
573                 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen); 
574                 if(i > 0)
575                         BIO_printf(out, "Verified OK\n");
576                 else if(i == 0)
577                         {
578                         BIO_printf(out, "Verification Failure\n");
579                         return 1;
580                         }
581                 else
582                         {
583                         BIO_printf(bio_err, "Error Verifying Data\n");
584                         ERR_print_errors(bio_err);
585                         return 1;
586                         }
587                 return 0;
588                 }
589         if(key)
590                 {
591                 EVP_MD_CTX *ctx;
592                 BIO_get_md_ctx(bp, &ctx);
593                 len = BUFSIZE;
594                 if(!EVP_DigestSignFinal(ctx, buf, &len)) 
595                         {
596                         BIO_printf(bio_err, "Error Signing Data\n");
597                         ERR_print_errors(bio_err);
598                         return 1;
599                         }
600                 }
601         else
602                 len=BIO_gets(bp,(char *)buf,BUFSIZE);
603
604         if(binout) BIO_write(out, buf, len);
605         else 
606                 {
607                 if (sig_name)
608                         BIO_printf(out, "%s-%s(%s)= ", sig_name, md_name, file);
609                 else if (md_name)
610                         BIO_printf(out, "%s(%s)= ", md_name, file);
611                 else
612                         BIO_printf(out, "(%s)= ", file);
613                 for (i=0; i<(int)len; i++)
614                         {
615                         if (sep && (i != 0))
616                                 BIO_printf(out, ":");
617                         BIO_printf(out, "%02x",buf[i]);
618                         }
619                 BIO_printf(out, "\n");
620                 }
621         return 0;
622         }
623