Reorder inclusion of header files:
[openssl.git] / apps / openssl.c
1 /* apps/openssl.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  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111
112
113 #include <stdio.h>
114 #include <string.h>
115 #include <stdlib.h>
116 #define OPENSSL_C /* tells apps.h to use complete apps_startup() */
117 #include "apps.h"
118 #include <openssl/bio.h>
119 #include <openssl/crypto.h>
120 #include <openssl/lhash.h>
121 #include <openssl/conf.h>
122 #include <openssl/x509.h>
123 #include <openssl/pem.h>
124 #include <openssl/ssl.h>
125 #include <openssl/engine.h>
126 #define USE_SOCKETS /* needed for the _O_BINARY defs in the MS world */
127 #include "progs.h"
128 #include "s_apps.h"
129 #include <openssl/err.h>
130
131 /* The LHASH callbacks ("hash" & "cmp") have been replaced by functions with the
132  * base prototypes (we cast each variable inside the function to the required
133  * type of "FUNCTION*"). This removes the necessity for macro-generated wrapper
134  * functions. */
135
136 /* static unsigned long MS_CALLBACK hash(FUNCTION *a); */
137 static unsigned long MS_CALLBACK hash(const void *a_void);
138 /* static int MS_CALLBACK cmp(FUNCTION *a,FUNCTION *b); */
139 static int MS_CALLBACK cmp(const void *a_void,const void *b_void);
140 static LHASH *prog_init(void );
141 static int do_cmd(LHASH *prog,int argc,char *argv[]);
142 CONF *config=NULL;
143 char *default_config_file=NULL;
144
145 /* Make sure there is only one when MONOLITH is defined */
146 #ifdef MONOLITH
147 BIO *bio_err=NULL;
148 #endif
149
150
151 static void lock_dbg_cb(int mode, int type, const char *file, int line)
152         {
153         static int modes[CRYPTO_NUM_LOCKS]; /* = {0, 0, ... } */
154         const char *errstr = NULL;
155         int rw;
156         
157         rw = mode & (CRYPTO_READ|CRYPTO_WRITE);
158         if (!((rw == CRYPTO_READ) || (rw == CRYPTO_WRITE)))
159                 {
160                 errstr = "invalid mode";
161                 goto err;
162                 }
163
164         if (type < 0 || type > CRYPTO_NUM_LOCKS)
165                 {
166                 errstr = "type out of bounds";
167                 goto err;
168                 }
169
170         if (mode & CRYPTO_LOCK)
171                 {
172                 if (modes[type])
173                         {
174                         errstr = "already locked";
175                         /* must not happen in a single-threaded program
176                          * (would deadlock) */
177                         goto err;
178                         }
179
180                 modes[type] = rw;
181                 }
182         else if (mode & CRYPTO_UNLOCK)
183                 {
184                 if (!modes[type])
185                         {
186                         errstr = "not locked";
187                         goto err;
188                         }
189                 
190                 if (modes[type] != rw)
191                         {
192                         errstr = (rw == CRYPTO_READ) ?
193                                 "CRYPTO_r_unlock on write lock" :
194                                 "CRYPTO_w_unlock on read lock";
195                         }
196
197                 modes[type] = 0;
198                 }
199         else
200                 {
201                 errstr = "invalid mode";
202                 goto err;
203                 }
204
205  err:
206         if (errstr)
207                 {
208                 /* we cannot use bio_err here */
209                 fprintf(stderr, "openssl (lock_dbg_cb): %s (mode=%d, type=%d) at %s:%d\n",
210                         errstr, mode, type, file, line);
211                 }
212         }
213
214
215 int main(int Argc, char *Argv[])
216         {
217         ARGS arg;
218 #define PROG_NAME_SIZE  39
219         char pname[PROG_NAME_SIZE+1];
220         FUNCTION f,*fp;
221         MS_STATIC char *prompt,buf[1024],config_name[256];
222         int n,i,ret=0;
223         int argc;
224         char **argv,*p;
225         LHASH *prog=NULL;
226         long errline;
227  
228         arg.data=NULL;
229         arg.count=0;
230
231         if (getenv("OPENSSL_DEBUG_MEMORY") != NULL) /* if not defined, use compiled-in library defaults */
232                 {
233                 if (!(0 == strcmp(getenv("OPENSSL_DEBUG_MEMORY"), "off")))
234                         {
235                         CRYPTO_malloc_debug_init();
236                         CRYPTO_set_mem_debug_options(V_CRYPTO_MDEBUG_ALL);
237                         }
238                 else
239                         {
240                         /* OPENSSL_DEBUG_MEMORY=off */
241                         CRYPTO_set_mem_debug_functions(0, 0, 0, 0, 0);
242                         }
243                 }
244         CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
245
246 #if 0
247         if (getenv("OPENSSL_DEBUG_LOCKING") != NULL)
248 #endif
249                 {
250                 CRYPTO_set_locking_callback(lock_dbg_cb);
251                 }
252
253         apps_startup();
254
255         if (bio_err == NULL)
256                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
257                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
258
259         /* Lets load up our environment a little */
260         p=getenv("OPENSSL_CONF");
261         if (p == NULL)
262                 p=getenv("SSLEAY_CONF");
263         if (p == NULL)
264                 {
265                 strcpy(config_name,X509_get_default_cert_area());
266 #ifndef OPENSSL_SYS_VMS
267                 strcat(config_name,"/");
268 #endif
269                 strcat(config_name,OPENSSL_CONF);
270                 p=config_name;
271                 }
272
273         default_config_file=p;
274
275         config=NCONF_new(NULL);
276         i=NCONF_load(config,p,&errline);
277         if (i == 0)
278                 {
279                 NCONF_free(config);
280                 config = NULL;
281                 ERR_clear_error();
282                 }
283
284         prog=prog_init();
285
286         /* first check the program name */
287         program_name(Argv[0],pname,PROG_NAME_SIZE);
288
289         f.name=pname;
290         fp=(FUNCTION *)lh_retrieve(prog,&f);
291         if (fp != NULL)
292                 {
293                 Argv[0]=pname;
294                 ret=fp->func(Argc,Argv);
295                 goto end;
296                 }
297
298         /* ok, now check that there are not arguments, if there are,
299          * run with them, shifting the ssleay off the front */
300         if (Argc != 1)
301                 {
302                 Argc--;
303                 Argv++;
304                 ret=do_cmd(prog,Argc,Argv);
305                 if (ret < 0) ret=0;
306                 goto end;
307                 }
308
309         /* ok, lets enter the old 'OpenSSL>' mode */
310         
311         for (;;)
312                 {
313                 ret=0;
314                 p=buf;
315                 n=1024;
316                 i=0;
317                 for (;;)
318                         {
319                         p[0]='\0';
320                         if (i++)
321                                 prompt=">";
322                         else    prompt="OpenSSL> ";
323                         fputs(prompt,stdout);
324                         fflush(stdout);
325                         fgets(p,n,stdin);
326                         if (p[0] == '\0') goto end;
327                         i=strlen(p);
328                         if (i <= 1) break;
329                         if (p[i-2] != '\\') break;
330                         i-=2;
331                         p+=i;
332                         n-=i;
333                         }
334                 if (!chopup_args(&arg,buf,&argc,&argv)) break;
335
336                 ret=do_cmd(prog,argc,argv);
337                 if (ret < 0)
338                         {
339                         ret=0;
340                         goto end;
341                         }
342                 if (ret != 0)
343                         BIO_printf(bio_err,"error in %s\n",argv[0]);
344                 (void)BIO_flush(bio_err);
345                 }
346         BIO_printf(bio_err,"bad exit\n");
347         ret=1;
348 end:
349         if (config != NULL)
350                 {
351                 NCONF_free(config);
352                 config=NULL;
353                 }
354         if (prog != NULL) lh_free(prog);
355         if (arg.data != NULL) OPENSSL_free(arg.data);
356
357         apps_shutdown();
358
359         CRYPTO_mem_leaks(bio_err);
360         if (bio_err != NULL)
361                 {
362                 BIO_free(bio_err);
363                 bio_err=NULL;
364                 }
365         EXIT(ret);
366         }
367
368 #define LIST_STANDARD_COMMANDS "list-standard-commands"
369 #define LIST_MESSAGE_DIGEST_COMMANDS "list-message-digest-commands"
370 #define LIST_CIPHER_COMMANDS "list-cipher-commands"
371
372 static int do_cmd(LHASH *prog, int argc, char *argv[])
373         {
374         FUNCTION f,*fp;
375         int i,ret=1,tp,nl;
376
377         if ((argc <= 0) || (argv[0] == NULL))
378                 { ret=0; goto end; }
379         f.name=argv[0];
380         fp=(FUNCTION *)lh_retrieve(prog,&f);
381         if (fp != NULL)
382                 {
383                 ret=fp->func(argc,argv);
384                 }
385         else if ((strncmp(argv[0],"no-",3)) == 0)
386                 {
387                 BIO *bio_stdout = BIO_new_fp(stdout,BIO_NOCLOSE);
388 #ifdef OPENSSL_SYS_VMS
389                 {
390                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
391                 bio_stdout = BIO_push(tmpbio, bio_stdout);
392                 }
393 #endif
394                 f.name=argv[0]+3;
395                 ret = (lh_retrieve(prog,&f) != NULL);
396                 if (!ret)
397                         BIO_printf(bio_stdout, "%s\n", argv[0]);
398                 else
399                         BIO_printf(bio_stdout, "%s\n", argv[0]+3);
400                 BIO_free_all(bio_stdout);
401                 goto end;
402                 }
403         else if ((strcmp(argv[0],"quit") == 0) ||
404                 (strcmp(argv[0],"q") == 0) ||
405                 (strcmp(argv[0],"exit") == 0) ||
406                 (strcmp(argv[0],"bye") == 0))
407                 {
408                 ret= -1;
409                 goto end;
410                 }
411         else if ((strcmp(argv[0],LIST_STANDARD_COMMANDS) == 0) ||
412                 (strcmp(argv[0],LIST_MESSAGE_DIGEST_COMMANDS) == 0) ||
413                 (strcmp(argv[0],LIST_CIPHER_COMMANDS) == 0))
414                 {
415                 int list_type;
416                 BIO *bio_stdout;
417
418                 if (strcmp(argv[0],LIST_STANDARD_COMMANDS) == 0)
419                         list_type = FUNC_TYPE_GENERAL;
420                 else if (strcmp(argv[0],LIST_MESSAGE_DIGEST_COMMANDS) == 0)
421                         list_type = FUNC_TYPE_MD;
422                 else /* strcmp(argv[0],LIST_CIPHER_COMMANDS) == 0 */
423                         list_type = FUNC_TYPE_CIPHER;
424                 bio_stdout = BIO_new_fp(stdout,BIO_NOCLOSE);
425 #ifdef OPENSSL_SYS_VMS
426                 {
427                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
428                 bio_stdout = BIO_push(tmpbio, bio_stdout);
429                 }
430 #endif
431                 
432                 for (fp=functions; fp->name != NULL; fp++)
433                         if (fp->type == list_type)
434                                 BIO_printf(bio_stdout, "%s\n", fp->name);
435                 BIO_free_all(bio_stdout);
436                 ret=0;
437                 goto end;
438                 }
439         else
440                 {
441                 BIO_printf(bio_err,"openssl:Error: '%s' is an invalid command.\n",
442                         argv[0]);
443                 BIO_printf(bio_err, "\nStandard commands");
444                 i=0;
445                 tp=0;
446                 for (fp=functions; fp->name != NULL; fp++)
447                         {
448                         nl=0;
449                         if (((i++) % 5) == 0)
450                                 {
451                                 BIO_printf(bio_err,"\n");
452                                 nl=1;
453                                 }
454                         if (fp->type != tp)
455                                 {
456                                 tp=fp->type;
457                                 if (!nl) BIO_printf(bio_err,"\n");
458                                 if (tp == FUNC_TYPE_MD)
459                                         {
460                                         i=1;
461                                         BIO_printf(bio_err,
462                                                 "\nMessage Digest commands (see the `dgst' command for more details)\n");
463                                         }
464                                 else if (tp == FUNC_TYPE_CIPHER)
465                                         {
466                                         i=1;
467                                         BIO_printf(bio_err,"\nCipher commands (see the `enc' command for more details)\n");
468                                         }
469                                 }
470                         BIO_printf(bio_err,"%-15s",fp->name);
471                         }
472                 BIO_printf(bio_err,"\n\n");
473                 ret=0;
474                 }
475 end:
476         return(ret);
477         }
478
479 static int SortFnByName(const void *_f1,const void *_f2)
480     {
481     const FUNCTION *f1=_f1;
482     const FUNCTION *f2=_f2;
483
484     if(f1->type != f2->type)
485         return f1->type-f2->type;
486     return strcmp(f1->name,f2->name);
487     }
488
489 static LHASH *prog_init(void)
490         {
491         LHASH *ret;
492         FUNCTION *f;
493         int i;
494
495         /* Purely so it looks nice when the user hits ? */
496         for(i=0,f=functions ; f->name != NULL ; ++f,++i)
497             ;
498         qsort(functions,i,sizeof *functions,SortFnByName);
499
500         if ((ret=lh_new(hash, cmp)) == NULL)
501                 return(NULL);
502
503         for (f=functions; f->name != NULL; f++)
504                 lh_insert(ret,f);
505         return(ret);
506         }
507
508 /* static int MS_CALLBACK cmp(FUNCTION *a, FUNCTION *b) */
509 static int MS_CALLBACK cmp(const void *a_void, const void *b_void)
510         {
511         return(strncmp(((FUNCTION *)a_void)->name,
512                         ((FUNCTION *)b_void)->name,8));
513         }
514
515 /* static unsigned long MS_CALLBACK hash(FUNCTION *a) */
516 static unsigned long MS_CALLBACK hash(const void *a_void)
517         {
518         return(lh_strhash(((FUNCTION *)a_void)->name));
519         }