Document recent changes.
[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-2000 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 <openssl/bio.h>
118 #include <openssl/crypto.h>
119 #include <openssl/lhash.h>
120 #include <openssl/conf.h>
121 #include <openssl/x509.h>
122 #include <openssl/pem.h>
123 #include <openssl/ssl.h>
124 #define USE_SOCKETS /* needed for the _O_BINARY defs in the MS world */
125 #include "apps.h"
126 #include "progs.h"
127 #include "s_apps.h"
128 #include <openssl/err.h>
129
130 /* The LHASH callbacks ("hash" & "cmp") have been replaced by functions with the
131  * base prototypes (we cast each variable inside the function to the required
132  * type of "FUNCTION*"). This removes the necessity for macro-generated wrapper
133  * functions. */
134
135 /* static unsigned long MS_CALLBACK hash(FUNCTION *a); */
136 static unsigned long MS_CALLBACK hash(const void *a_void);
137 /* static int MS_CALLBACK cmp(FUNCTION *a,FUNCTION *b); */
138 static int MS_CALLBACK cmp(const void *a_void,const void *b_void);
139 static LHASH *prog_init(void );
140 static int do_cmd(LHASH *prog,int argc,char *argv[]);
141 LHASH *config=NULL;
142 char *default_config_file=NULL;
143
144 /* Make sure there is only one when MONOLITH is defined */
145 #ifdef MONOLITH
146 BIO *bio_err=NULL;
147 #endif
148
149
150 static void lock_dbg_cb(int mode, int type, const char *file, int line)
151         {
152         static int modes[CRYPTO_NUM_LOCKS]; /* = {0, 0, ... } */
153         const char *errstr = NULL;
154         int rw;
155         
156         rw = mode & (CRYPTO_READ|CRYPTO_WRITE);
157         if (!((rw == CRYPTO_READ) || (rw == CRYPTO_WRITE)))
158                 {
159                 errstr = "invalid mode";
160                 goto err;
161                 }
162
163         if (type < 0 || type > CRYPTO_NUM_LOCKS)
164                 {
165                 errstr = "type out of bounds";
166                 goto err;
167                 }
168
169         if (mode & CRYPTO_LOCK)
170                 {
171                 if (modes[type])
172                         {
173                         errstr = "already locked";
174                         /* must not happen in a single-threaded program
175                          * (would deadlock) */
176                         goto err;
177                         }
178
179                 modes[type] = rw;
180                 }
181         else if (mode & CRYPTO_UNLOCK)
182                 {
183                 if (!modes[type])
184                         {
185                         errstr = "not locked";
186                         goto err;
187                         }
188                 
189                 if (modes[type] != rw)
190                         {
191                         errstr = (rw == CRYPTO_READ) ?
192                                 "CRYPTO_r_unlock on write lock" :
193                                 "CRYPTO_w_unlock on read lock";
194                         }
195
196                 modes[type] = 0;
197                 }
198         else
199                 {
200                 errstr = "invalid mode";
201                 goto err;
202                 }
203
204  err:
205         if (errstr)
206                 {
207                 /* we cannot use bio_err here */
208                 fprintf(stderr, "openssl (lock_dbg_cb): %s (mode=%d, type=%d) at %s:%d\n",
209                         errstr, mode, type, file, line);
210                 }
211         }
212
213
214 int main(int Argc, char *Argv[])
215         {
216         ARGS arg;
217 #define PROG_NAME_SIZE  16
218         char pname[PROG_NAME_SIZE];
219         FUNCTION f,*fp;
220         MS_STATIC char *prompt,buf[1024],config_name[256];
221         int n,i,ret=0;
222         int argc;
223         char **argv,*p;
224         LHASH *prog=NULL;
225         long errline;
226  
227         arg.data=NULL;
228         arg.count=0;
229
230         if (getenv("OPENSSL_DEBUG_MEMORY") != NULL)
231                 {
232                 if (!(0 == strcmp(getenv("OPENSSL_DEBUG_MEMORY"), "off")))
233                         {
234                         CRYPTO_malloc_debug_init();
235                         CRYPTO_dbg_set_options(V_CRYPTO_MDEBUG_ALL);
236                         }
237                 }
238         CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
239
240 #if 0
241         if (getenv("OPENSSL_DEBUG_LOCKING") != NULL)
242 #endif
243                 {
244                 CRYPTO_set_locking_callback(lock_dbg_cb);
245                 }
246
247         apps_startup();
248
249         if (bio_err == NULL)
250                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
251                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
252
253         ERR_load_crypto_strings();
254         ENGINE_load_builtin_engines();
255
256         /* Lets load up our environment a little */
257         p=getenv("OPENSSL_CONF");
258         if (p == NULL)
259                 p=getenv("SSLEAY_CONF");
260         if (p == NULL)
261                 {
262                 strcpy(config_name,X509_get_default_cert_area());
263 #ifndef OPENSSL_SYS_VMS
264                 strcat(config_name,"/");
265 #endif
266                 strcat(config_name,OPENSSL_CONF);
267                 p=config_name;
268                 }
269
270         default_config_file=p;
271
272         config=CONF_load(config,p,&errline);
273         if (config == NULL) ERR_clear_error();
274
275         prog=prog_init();
276
277         /* first check the program name */
278         program_name(Argv[0],pname,PROG_NAME_SIZE);
279
280         f.name=pname;
281         fp=(FUNCTION *)lh_retrieve(prog,&f);
282         if (fp != NULL)
283                 {
284                 Argv[0]=pname;
285                 ret=fp->func(Argc,Argv);
286                 goto end;
287                 }
288
289         /* ok, now check that there are not arguments, if there are,
290          * run with them, shifting the ssleay off the front */
291         if (Argc != 1)
292                 {
293                 Argc--;
294                 Argv++;
295                 ret=do_cmd(prog,Argc,Argv);
296                 if (ret < 0) ret=0;
297                 goto end;
298                 }
299
300         /* ok, lets enter the old 'OpenSSL>' mode */
301         
302         for (;;)
303                 {
304                 ret=0;
305                 p=buf;
306                 n=1024;
307                 i=0;
308                 for (;;)
309                         {
310                         p[0]='\0';
311                         if (i++)
312                                 prompt=">";
313                         else    prompt="OpenSSL> ";
314                         fputs(prompt,stdout);
315                         fflush(stdout);
316                         fgets(p,n,stdin);
317                         if (p[0] == '\0') goto end;
318                         i=strlen(p);
319                         if (i <= 1) break;
320                         if (p[i-2] != '\\') break;
321                         i-=2;
322                         p+=i;
323                         n-=i;
324                         }
325                 if (!chopup_args(&arg,buf,&argc,&argv)) break;
326
327                 ret=do_cmd(prog,argc,argv);
328                 if (ret < 0)
329                         {
330                         ret=0;
331                         goto end;
332                         }
333                 if (ret != 0)
334                         BIO_printf(bio_err,"error in %s\n",argv[0]);
335                 (void)BIO_flush(bio_err);
336                 }
337         BIO_printf(bio_err,"bad exit\n");
338         ret=1;
339 end:
340         if (config != NULL)
341                 {
342                 CONF_free(config);
343                 config=NULL;
344                 }
345         if (prog != NULL) lh_free(prog);
346         if (arg.data != NULL) OPENSSL_free(arg.data);
347         ERR_remove_state(0);
348
349         EVP_cleanup();
350         ERR_free_strings();
351         
352         ENGINE_cleanup();
353         destroy_ui_method();
354
355         CRYPTO_mem_leaks(bio_err);
356         if (bio_err != NULL)
357                 {
358                 BIO_free(bio_err);
359                 bio_err=NULL;
360                 }
361         EXIT(ret);
362         }
363
364 #define LIST_STANDARD_COMMANDS "list-standard-commands"
365 #define LIST_MESSAGE_DIGEST_COMMANDS "list-message-digest-commands"
366 #define LIST_CIPHER_COMMANDS "list-cipher-commands"
367
368 static int do_cmd(LHASH *prog, int argc, char *argv[])
369         {
370         FUNCTION f,*fp;
371         int i,ret=1,tp,nl;
372
373         if ((argc <= 0) || (argv[0] == NULL))
374                 { ret=0; goto end; }
375         f.name=argv[0];
376         fp=(FUNCTION *)lh_retrieve(prog,&f);
377         if (fp != NULL)
378                 {
379                 ret=fp->func(argc,argv);
380                 }
381         else if ((strncmp(argv[0],"no-",3)) == 0)
382                 {
383                 BIO *bio_stdout = BIO_new_fp(stdout,BIO_NOCLOSE);
384 #ifdef OPENSSL_SYS_VMS
385                 {
386                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
387                 bio_stdout = BIO_push(tmpbio, bio_stdout);
388                 }
389 #endif
390                 f.name=argv[0]+3;
391                 ret = (lh_retrieve(prog,&f) != NULL);
392                 if (!ret)
393                         BIO_printf(bio_stdout, "%s\n", argv[0]);
394                 else
395                         BIO_printf(bio_stdout, "%s\n", argv[0]+3);
396                 BIO_free_all(bio_stdout);
397                 goto end;
398                 }
399         else if ((strcmp(argv[0],"quit") == 0) ||
400                 (strcmp(argv[0],"q") == 0) ||
401                 (strcmp(argv[0],"exit") == 0) ||
402                 (strcmp(argv[0],"bye") == 0))
403                 {
404                 ret= -1;
405                 goto end;
406                 }
407         else if ((strcmp(argv[0],LIST_STANDARD_COMMANDS) == 0) ||
408                 (strcmp(argv[0],LIST_MESSAGE_DIGEST_COMMANDS) == 0) ||
409                 (strcmp(argv[0],LIST_CIPHER_COMMANDS) == 0))
410                 {
411                 int list_type;
412                 BIO *bio_stdout;
413
414                 if (strcmp(argv[0],LIST_STANDARD_COMMANDS) == 0)
415                         list_type = FUNC_TYPE_GENERAL;
416                 else if (strcmp(argv[0],LIST_MESSAGE_DIGEST_COMMANDS) == 0)
417                         list_type = FUNC_TYPE_MD;
418                 else /* strcmp(argv[0],LIST_CIPHER_COMMANDS) == 0 */
419                         list_type = FUNC_TYPE_CIPHER;
420                 bio_stdout = BIO_new_fp(stdout,BIO_NOCLOSE);
421 #ifdef OPENSSL_SYS_VMS
422                 {
423                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
424                 bio_stdout = BIO_push(tmpbio, bio_stdout);
425                 }
426 #endif
427                 
428                 for (fp=functions; fp->name != NULL; fp++)
429                         if (fp->type == list_type)
430                                 BIO_printf(bio_stdout, "%s\n", fp->name);
431                 BIO_free_all(bio_stdout);
432                 ret=0;
433                 goto end;
434                 }
435         else
436                 {
437                 BIO_printf(bio_err,"openssl:Error: '%s' is an invalid command.\n",
438                         argv[0]);
439                 BIO_printf(bio_err, "\nStandard commands");
440                 i=0;
441                 tp=0;
442                 for (fp=functions; fp->name != NULL; fp++)
443                         {
444                         nl=0;
445                         if (((i++) % 5) == 0)
446                                 {
447                                 BIO_printf(bio_err,"\n");
448                                 nl=1;
449                                 }
450                         if (fp->type != tp)
451                                 {
452                                 tp=fp->type;
453                                 if (!nl) BIO_printf(bio_err,"\n");
454                                 if (tp == FUNC_TYPE_MD)
455                                         {
456                                         i=1;
457                                         BIO_printf(bio_err,
458                                                 "\nMessage Digest commands (see the `dgst' command for more details)\n");
459                                         }
460                                 else if (tp == FUNC_TYPE_CIPHER)
461                                         {
462                                         i=1;
463                                         BIO_printf(bio_err,"\nCipher commands (see the `enc' command for more details)\n");
464                                         }
465                                 }
466                         BIO_printf(bio_err,"%-15s",fp->name);
467                         }
468                 BIO_printf(bio_err,"\n\n");
469                 ret=0;
470                 }
471 end:
472         return(ret);
473         }
474
475 static int SortFnByName(const void *_f1,const void *_f2)
476     {
477     const FUNCTION *f1=_f1;
478     const FUNCTION *f2=_f2;
479
480     if(f1->type != f2->type)
481         return f1->type-f2->type;
482     return strcmp(f1->name,f2->name);
483     }
484
485 static LHASH *prog_init(void)
486         {
487         LHASH *ret;
488         FUNCTION *f;
489         int i;
490
491         /* Purely so it looks nice when the user hits ? */
492         for(i=0,f=functions ; f->name != NULL ; ++f,++i)
493             ;
494         qsort(functions,i,sizeof *functions,SortFnByName);
495
496         if ((ret=lh_new(hash, cmp)) == NULL)
497                 return(NULL);
498
499         for (f=functions; f->name != NULL; f++)
500                 lh_insert(ret,f);
501         return(ret);
502         }
503
504 /* static int MS_CALLBACK cmp(FUNCTION *a, FUNCTION *b) */
505 static int MS_CALLBACK cmp(const void *a_void, const void *b_void)
506         {
507         return(strncmp(((FUNCTION *)a_void)->name,
508                         ((FUNCTION *)b_void)->name,8));
509         }
510
511 /* static unsigned long MS_CALLBACK hash(FUNCTION *a) */
512 static unsigned long MS_CALLBACK hash(const void *a_void)
513         {
514         return(lh_strhash(((FUNCTION *)a_void)->name));
515         }