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