e_os.h does not belong with the exported headers. Do not put it there
[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                 CRYPTO_malloc_debug_init();
232         CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
233
234 #if 0
235         if (getenv("OPENSSL_DEBUG_LOCKING") != NULL)
236 #endif
237                 {
238                 CRYPTO_set_locking_callback(lock_dbg_cb);
239                 }
240
241         apps_startup();
242
243         if (bio_err == NULL)
244                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
245                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
246
247         ERR_load_crypto_strings();
248         ENGINE_load_builtin_engines();
249
250         /* Lets load up our environment a little */
251         p=getenv("OPENSSL_CONF");
252         if (p == NULL)
253                 p=getenv("SSLEAY_CONF");
254         if (p == NULL)
255                 {
256                 strcpy(config_name,X509_get_default_cert_area());
257 #ifndef OPENSSL_SYS_VMS
258                 strcat(config_name,"/");
259 #endif
260                 strcat(config_name,OPENSSL_CONF);
261                 p=config_name;
262                 }
263
264         default_config_file=p;
265
266         config=CONF_load(config,p,&errline);
267         if (config == NULL) ERR_clear_error();
268
269         prog=prog_init();
270
271         /* first check the program name */
272         program_name(Argv[0],pname,PROG_NAME_SIZE);
273
274         f.name=pname;
275         fp=(FUNCTION *)lh_retrieve(prog,&f);
276         if (fp != NULL)
277                 {
278                 Argv[0]=pname;
279                 ret=fp->func(Argc,Argv);
280                 goto end;
281                 }
282
283         /* ok, now check that there are not arguments, if there are,
284          * run with them, shifting the ssleay off the front */
285         if (Argc != 1)
286                 {
287                 Argc--;
288                 Argv++;
289                 ret=do_cmd(prog,Argc,Argv);
290                 if (ret < 0) ret=0;
291                 goto end;
292                 }
293
294         /* ok, lets enter the old 'OpenSSL>' mode */
295         
296         for (;;)
297                 {
298                 ret=0;
299                 p=buf;
300                 n=1024;
301                 i=0;
302                 for (;;)
303                         {
304                         p[0]='\0';
305                         if (i++)
306                                 prompt=">";
307                         else    prompt="OpenSSL> ";
308                         fputs(prompt,stdout);
309                         fflush(stdout);
310                         fgets(p,n,stdin);
311                         if (p[0] == '\0') goto end;
312                         i=strlen(p);
313                         if (i <= 1) break;
314                         if (p[i-2] != '\\') break;
315                         i-=2;
316                         p+=i;
317                         n-=i;
318                         }
319                 if (!chopup_args(&arg,buf,&argc,&argv)) break;
320
321                 ret=do_cmd(prog,argc,argv);
322                 if (ret < 0)
323                         {
324                         ret=0;
325                         goto end;
326                         }
327                 if (ret != 0)
328                         BIO_printf(bio_err,"error in %s\n",argv[0]);
329                 (void)BIO_flush(bio_err);
330                 }
331         BIO_printf(bio_err,"bad exit\n");
332         ret=1;
333 end:
334         if (config != NULL)
335                 {
336                 CONF_free(config);
337                 config=NULL;
338                 }
339         if (prog != NULL) lh_free(prog);
340         if (arg.data != NULL) OPENSSL_free(arg.data);
341         ERR_remove_state(0);
342
343         EVP_cleanup();
344         ERR_free_strings();
345         
346         CRYPTO_mem_leaks(bio_err);
347         if (bio_err != NULL)
348                 {
349                 BIO_free(bio_err);
350                 bio_err=NULL;
351                 }
352         EXIT(ret);
353         }
354
355 #define LIST_STANDARD_COMMANDS "list-standard-commands"
356 #define LIST_MESSAGE_DIGEST_COMMANDS "list-message-digest-commands"
357 #define LIST_CIPHER_COMMANDS "list-cipher-commands"
358
359 static int do_cmd(LHASH *prog, int argc, char *argv[])
360         {
361         FUNCTION f,*fp;
362         int i,ret=1,tp,nl;
363
364         if ((argc <= 0) || (argv[0] == NULL))
365                 { ret=0; goto end; }
366         f.name=argv[0];
367         fp=(FUNCTION *)lh_retrieve(prog,&f);
368         if (fp != NULL)
369                 {
370                 ret=fp->func(argc,argv);
371                 }
372         else if ((strncmp(argv[0],"no-",3)) == 0)
373                 {
374                 BIO *bio_stdout = BIO_new_fp(stdout,BIO_NOCLOSE);
375 #ifdef OPENSSL_SYS_VMS
376                 {
377                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
378                 bio_stdout = BIO_push(tmpbio, bio_stdout);
379                 }
380 #endif
381                 f.name=argv[0]+3;
382                 ret = (lh_retrieve(prog,&f) != NULL);
383                 if (!ret)
384                         BIO_printf(bio_stdout, "%s\n", argv[0]);
385                 else
386                         BIO_printf(bio_stdout, "%s\n", argv[0]+3);
387                 BIO_free_all(bio_stdout);
388                 goto end;
389                 }
390         else if ((strcmp(argv[0],"quit") == 0) ||
391                 (strcmp(argv[0],"q") == 0) ||
392                 (strcmp(argv[0],"exit") == 0) ||
393                 (strcmp(argv[0],"bye") == 0))
394                 {
395                 ret= -1;
396                 goto end;
397                 }
398         else if ((strcmp(argv[0],LIST_STANDARD_COMMANDS) == 0) ||
399                 (strcmp(argv[0],LIST_MESSAGE_DIGEST_COMMANDS) == 0) ||
400                 (strcmp(argv[0],LIST_CIPHER_COMMANDS) == 0))
401                 {
402                 int list_type;
403                 BIO *bio_stdout;
404
405                 if (strcmp(argv[0],LIST_STANDARD_COMMANDS) == 0)
406                         list_type = FUNC_TYPE_GENERAL;
407                 else if (strcmp(argv[0],LIST_MESSAGE_DIGEST_COMMANDS) == 0)
408                         list_type = FUNC_TYPE_MD;
409                 else /* strcmp(argv[0],LIST_CIPHER_COMMANDS) == 0 */
410                         list_type = FUNC_TYPE_CIPHER;
411                 bio_stdout = BIO_new_fp(stdout,BIO_NOCLOSE);
412 #ifdef OPENSSL_SYS_VMS
413                 {
414                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
415                 bio_stdout = BIO_push(tmpbio, bio_stdout);
416                 }
417 #endif
418                 
419                 for (fp=functions; fp->name != NULL; fp++)
420                         if (fp->type == list_type)
421                                 BIO_printf(bio_stdout, "%s\n", fp->name);
422                 BIO_free_all(bio_stdout);
423                 ret=0;
424                 goto end;
425                 }
426         else
427                 {
428                 BIO_printf(bio_err,"openssl:Error: '%s' is an invalid command.\n",
429                         argv[0]);
430                 BIO_printf(bio_err, "\nStandard commands");
431                 i=0;
432                 tp=0;
433                 for (fp=functions; fp->name != NULL; fp++)
434                         {
435                         nl=0;
436                         if (((i++) % 5) == 0)
437                                 {
438                                 BIO_printf(bio_err,"\n");
439                                 nl=1;
440                                 }
441                         if (fp->type != tp)
442                                 {
443                                 tp=fp->type;
444                                 if (!nl) BIO_printf(bio_err,"\n");
445                                 if (tp == FUNC_TYPE_MD)
446                                         {
447                                         i=1;
448                                         BIO_printf(bio_err,
449                                                 "\nMessage Digest commands (see the `dgst' command for more details)\n");
450                                         }
451                                 else if (tp == FUNC_TYPE_CIPHER)
452                                         {
453                                         i=1;
454                                         BIO_printf(bio_err,"\nCipher commands (see the `enc' command for more details)\n");
455                                         }
456                                 }
457                         BIO_printf(bio_err,"%-15s",fp->name);
458                         }
459                 BIO_printf(bio_err,"\n\n");
460                 ret=0;
461                 }
462 end:
463         return(ret);
464         }
465
466 static int SortFnByName(const void *_f1,const void *_f2)
467     {
468     const FUNCTION *f1=_f1;
469     const FUNCTION *f2=_f2;
470
471     if(f1->type != f2->type)
472         return f1->type-f2->type;
473     return strcmp(f1->name,f2->name);
474     }
475
476 static LHASH *prog_init(void)
477         {
478         LHASH *ret;
479         FUNCTION *f;
480         int i;
481
482         /* Purely so it looks nice when the user hits ? */
483         for(i=0,f=functions ; f->name != NULL ; ++f,++i)
484             ;
485         qsort(functions,i,sizeof *functions,SortFnByName);
486
487         if ((ret=lh_new(hash, cmp)) == NULL)
488                 return(NULL);
489
490         for (f=functions; f->name != NULL; f++)
491                 lh_insert(ret,f);
492         return(ret);
493         }
494
495 /* static int MS_CALLBACK cmp(FUNCTION *a, FUNCTION *b) */
496 static int MS_CALLBACK cmp(const void *a_void, const void *b_void)
497         {
498         return(strncmp(((FUNCTION *)a_void)->name,
499                         ((FUNCTION *)b_void)->name,8));
500         }
501
502 /* static unsigned long MS_CALLBACK hash(FUNCTION *a) */
503 static unsigned long MS_CALLBACK hash(const void *a_void)
504         {
505         return(lh_strhash(((FUNCTION *)a_void)->name));
506         }