doc/apps: formatting fixes.
[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, *impl = 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         int engine_impl = 0;
128 #endif
129         char *hmac_key=NULL;
130         char *mac_name=NULL;
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                 else if (strcmp(*argv,"-engine_impl") == 0)
213                         engine_impl = 1;
214 #endif
215                 else if (strcmp(*argv,"-hex") == 0)
216                         out_bin = 0;
217                 else if (strcmp(*argv,"-binary") == 0)
218                         out_bin = 1;
219                 else if (strcmp(*argv,"-d") == 0)
220                         debug=1;
221                 else if (!strcmp(*argv,"-fips-fingerprint"))
222                         hmac_key = "etaonrishdlcupfm";
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,"-sign   file    sign digest using private key in file\n");
277                 BIO_printf(bio_err,"-verify file    verify a signature using public key in file\n");
278                 BIO_printf(bio_err,"-prverify file  verify a signature using private key in file\n");
279                 BIO_printf(bio_err,"-keyform arg    key file format (PEM or ENGINE)\n");
280                 BIO_printf(bio_err,"-out filename   output to filename rather than stdout\n");
281                 BIO_printf(bio_err,"-signature file signature to verify\n");
282                 BIO_printf(bio_err,"-sigopt nm:v    signature parameter\n");
283                 BIO_printf(bio_err,"-hmac key       create hashed MAC with key\n");
284                 BIO_printf(bio_err,"-mac algorithm  create MAC (not neccessarily HMAC)\n"); 
285                 BIO_printf(bio_err,"-macopt nm:v    MAC algorithm parameters or key\n");
286 #ifndef OPENSSL_NO_ENGINE
287                 BIO_printf(bio_err,"-engine e       use engine e, possibly a hardware device.\n");
288 #endif
289
290                 EVP_MD_do_all_sorted(list_md_fn, bio_err);
291                 goto end;
292                 }
293
294 #ifndef OPENSSL_NO_ENGINE
295         if (engine_impl)
296                 impl = e;
297 #endif
298
299         in=BIO_new(BIO_s_file());
300         bmd=BIO_new(BIO_f_md());
301         if (debug)
302                 {
303                 BIO_set_callback(in,BIO_debug_callback);
304                 /* needed for windows 3.1 */
305                 BIO_set_callback_arg(in,(char *)bio_err);
306                 }
307
308         if(!app_passwd(bio_err, passargin, NULL, &passin, NULL))
309                 {
310                 BIO_printf(bio_err, "Error getting password\n");
311                 goto end;
312                 }
313
314         if ((in == NULL) || (bmd == NULL))
315                 {
316                 ERR_print_errors(bio_err);
317                 goto end;
318                 }
319
320         if(out_bin == -1) {
321                 if(keyfile)
322                         out_bin = 1;
323                 else
324                         out_bin = 0;
325         }
326
327         if(randfile)
328                 app_RAND_load_file(randfile, bio_err, 0);
329
330         if(outfile) {
331                 if(out_bin)
332                         out = BIO_new_file(outfile, "wb");
333                 else    out = BIO_new_file(outfile, "w");
334         } else {
335                 out = BIO_new_fp(stdout, BIO_NOCLOSE);
336 #ifdef OPENSSL_SYS_VMS
337                 {
338                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
339                 out = BIO_push(tmpbio, out);
340                 }
341 #endif
342         }
343
344         if(!out) {
345                 BIO_printf(bio_err, "Error opening output file %s\n", 
346                                         outfile ? outfile : "(stdout)");
347                 ERR_print_errors(bio_err);
348                 goto end;
349         }
350         if ((!!mac_name + !!keyfile + !!hmac_key) > 1)
351                 {
352                 BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
353                 goto end;
354                 }
355
356         if(keyfile)
357                 {
358                 if (want_pub)
359                         sigkey = load_pubkey(bio_err, keyfile, keyform, 0, NULL,
360                                 e, "key file");
361                 else
362                         sigkey = load_key(bio_err, keyfile, keyform, 0, passin,
363                                 e, "key file");
364                 if (!sigkey)
365                         {
366                         /* load_[pub]key() has already printed an appropriate
367                            message */
368                         goto end;
369                         }
370                 }
371
372         if (mac_name)
373                 {
374                 EVP_PKEY_CTX *mac_ctx = NULL;
375                 int r = 0;
376                 if (!init_gen_str(bio_err, &mac_ctx, mac_name, impl, 0))
377                         goto mac_end;
378                 if (macopts)
379                         {
380                         char *macopt;
381                         for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++)
382                                 {
383                                 macopt = sk_OPENSSL_STRING_value(macopts, i);
384                                 if (pkey_ctrl_string(mac_ctx, macopt) <= 0)
385                                         {
386                                         BIO_printf(bio_err,
387                                                 "MAC parameter error \"%s\"\n",
388                                                 macopt);
389                                         ERR_print_errors(bio_err);
390                                         goto mac_end;
391                                         }
392                                 }
393                         }
394                 if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0)
395                         {
396                         BIO_puts(bio_err, "Error generating key\n");
397                         ERR_print_errors(bio_err);
398                         goto mac_end;
399                         }
400                 r = 1;
401                 mac_end:
402                 if (mac_ctx)
403                         EVP_PKEY_CTX_free(mac_ctx);
404                 if (r == 0)
405                         goto end;
406                 }
407
408         if (hmac_key)
409                 {
410                 sigkey = EVP_PKEY_new_mac_key(EVP_PKEY_HMAC, impl,
411                                         (unsigned char *)hmac_key, -1);
412                 if (!sigkey)
413                         goto end;
414                 }
415
416         if (sigkey)
417                 {
418                 EVP_MD_CTX *mctx = NULL;
419                 EVP_PKEY_CTX *pctx = NULL;
420                 int r;
421                 if (!BIO_get_md_ctx(bmd, &mctx))
422                         {
423                         BIO_printf(bio_err, "Error getting context\n");
424                         ERR_print_errors(bio_err);
425                         goto end;
426                         }
427                 if (do_verify)
428                         r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
429                 else
430                         r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
431                 if (!r)
432                         {
433                         BIO_printf(bio_err, "Error setting context\n");
434                         ERR_print_errors(bio_err);
435                         goto end;
436                         }
437                 if (sigopts)
438                         {
439                         char *sigopt;
440                         for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++)
441                                 {
442                                 sigopt = sk_OPENSSL_STRING_value(sigopts, i);
443                                 if (pkey_ctrl_string(pctx, sigopt) <= 0)
444                                         {
445                                         BIO_printf(bio_err,
446                                                 "parameter error \"%s\"\n",
447                                                 sigopt);
448                                         ERR_print_errors(bio_err);
449                                         goto end;
450                                         }
451                                 }
452                         }
453                 }
454         /* we use md as a filter, reading from 'in' */
455         else
456                 {
457                 EVP_MD_CTX *mctx = NULL;
458                 if (!BIO_get_md_ctx(bmd, &mctx))
459                         {
460                         BIO_printf(bio_err, "Error getting context\n");
461                         ERR_print_errors(bio_err);
462                         goto end;
463                         }
464                 if (md == NULL)
465                         md = EVP_md5(); 
466                 if (!EVP_DigestInit_ex(mctx, md, impl))
467                         {
468                         BIO_printf(bio_err, "Error setting digest %s\n", pname);
469                         ERR_print_errors(bio_err);
470                         goto end;
471                         }
472                 }
473
474         if(sigfile && sigkey) {
475                 BIO *sigbio;
476                 sigbio = BIO_new_file(sigfile, "rb");
477                 siglen = EVP_PKEY_size(sigkey);
478                 sigbuf = OPENSSL_malloc(siglen);
479                 if(!sigbio) {
480                         BIO_printf(bio_err, "Error opening signature file %s\n",
481                                                                 sigfile);
482                         ERR_print_errors(bio_err);
483                         goto end;
484                 }
485                 siglen = BIO_read(sigbio, sigbuf, siglen);
486                 BIO_free(sigbio);
487                 if(siglen <= 0) {
488                         BIO_printf(bio_err, "Error reading signature file %s\n",
489                                                                 sigfile);
490                         ERR_print_errors(bio_err);
491                         goto end;
492                 }
493         }
494         inp=BIO_push(bmd,in);
495
496         if (md == NULL)
497                 {
498                 EVP_MD_CTX *tctx;
499                 BIO_get_md_ctx(bmd, &tctx);
500                 md = EVP_MD_CTX_md(tctx);
501                 }
502
503         if (argc == 0)
504                 {
505                 BIO_set_fp(in,stdin,BIO_NOCLOSE);
506                 err=do_fp(out, buf,inp,separator, out_bin, sigkey, sigbuf,
507                           siglen,NULL,NULL,"stdin",bmd);
508                 }
509         else
510                 {
511                 const char *md_name = NULL, *sig_name = NULL;
512                 if(!out_bin)
513                         {
514                         if (sigkey)
515                                 {
516                                 const EVP_PKEY_ASN1_METHOD *ameth;
517                                 ameth = EVP_PKEY_get0_asn1(sigkey);
518                                 if (ameth)
519                                         EVP_PKEY_asn1_get0_info(NULL, NULL,
520                                                 NULL, NULL, &sig_name, ameth);
521                                 }
522                         md_name = EVP_MD_name(md);
523                         }
524                 err = 0;
525                 for (i=0; i<argc; i++)
526                         {
527                         int r;
528                         if (BIO_read_filename(in,argv[i]) <= 0)
529                                 {
530                                 perror(argv[i]);
531                                 err++;
532                                 continue;
533                                 }
534                         else
535                         r=do_fp(out,buf,inp,separator,out_bin,sigkey,sigbuf,
536                                 siglen,sig_name,md_name, argv[i],bmd);
537                         if(r)
538                             err=r;
539                         (void)BIO_reset(bmd);
540                         }
541                 }
542 end:
543         if (buf != NULL)
544                 {
545                 OPENSSL_cleanse(buf,BUFSIZE);
546                 OPENSSL_free(buf);
547                 }
548         if (in != NULL) BIO_free(in);
549         if (passin)
550                 OPENSSL_free(passin);
551         BIO_free_all(out);
552         EVP_PKEY_free(sigkey);
553         if (sigopts)
554                 sk_OPENSSL_STRING_free(sigopts);
555         if (macopts)
556                 sk_OPENSSL_STRING_free(macopts);
557         if(sigbuf) OPENSSL_free(sigbuf);
558         if (bmd != NULL) BIO_free(bmd);
559         apps_shutdown();
560         OPENSSL_EXIT(err);
561         }
562
563 int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
564           EVP_PKEY *key, unsigned char *sigin, int siglen,
565           const char *sig_name, const char *md_name,
566           const char *file,BIO *bmd)
567         {
568         size_t len;
569         int i;
570
571         for (;;)
572                 {
573                 i=BIO_read(bp,(char *)buf,BUFSIZE);
574                 if(i < 0)
575                         {
576                         BIO_printf(bio_err, "Read Error in %s\n",file);
577                         ERR_print_errors(bio_err);
578                         return 1;
579                         }
580                 if (i == 0) break;
581                 }
582         if(sigin)
583                 {
584                 EVP_MD_CTX *ctx;
585                 BIO_get_md_ctx(bp, &ctx);
586                 i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen); 
587                 if(i > 0)
588                         BIO_printf(out, "Verified OK\n");
589                 else if(i == 0)
590                         {
591                         BIO_printf(out, "Verification Failure\n");
592                         return 1;
593                         }
594                 else
595                         {
596                         BIO_printf(bio_err, "Error Verifying Data\n");
597                         ERR_print_errors(bio_err);
598                         return 1;
599                         }
600                 return 0;
601                 }
602         if(key)
603                 {
604                 EVP_MD_CTX *ctx;
605                 BIO_get_md_ctx(bp, &ctx);
606                 len = BUFSIZE;
607                 if(!EVP_DigestSignFinal(ctx, buf, &len)) 
608                         {
609                         BIO_printf(bio_err, "Error Signing Data\n");
610                         ERR_print_errors(bio_err);
611                         return 1;
612                         }
613                 }
614         else
615                 {
616                 len=BIO_gets(bp,(char *)buf,BUFSIZE);
617                 if ((int)len <0)
618                         {
619                         ERR_print_errors(bio_err);
620                         return 1;
621                         }
622                 }
623
624         if(binout) BIO_write(out, buf, len);
625         else if (sep == 2)
626                 {
627                 for (i=0; i<(int)len; i++)
628                         BIO_printf(out, "%02x",buf[i]);
629                 BIO_printf(out, " *%s\n", file);
630                 }
631         else 
632                 {
633                 if (sig_name)
634                         BIO_printf(out, "%s-%s(%s)= ", sig_name, md_name, file);
635                 else if (md_name)
636                         BIO_printf(out, "%s(%s)= ", md_name, file);
637                 else
638                         BIO_printf(out, "(%s)= ", file);
639                 for (i=0; i<(int)len; i++)
640                         {
641                         if (sep && (i != 0))
642                                 BIO_printf(out, ":");
643                         BIO_printf(out, "%02x",buf[i]);
644                         }
645                 BIO_printf(out, "\n");
646                 }
647         return 0;
648         }
649