Camellia cipher, contributed by NTT
[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-2006 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 #ifndef OPENSSL_NO_ENGINE
126 #include <openssl/engine.h>
127 #endif
128 #define USE_SOCKETS /* needed for the _O_BINARY defs in the MS world */
129 #include "progs.h"
130 #include "s_apps.h"
131 #include <openssl/err.h>
132
133 /* The LHASH callbacks ("hash" & "cmp") have been replaced by functions with the
134  * base prototypes (we cast each variable inside the function to the required
135  * type of "FUNCTION*"). This removes the necessity for macro-generated wrapper
136  * functions. */
137
138 /* static unsigned long MS_CALLBACK hash(FUNCTION *a); */
139 static unsigned long MS_CALLBACK hash(const void *a_void);
140 /* static int MS_CALLBACK cmp(FUNCTION *a,FUNCTION *b); */
141 static int MS_CALLBACK cmp(const void *a_void,const void *b_void);
142 static LHASH *prog_init(void );
143 static int do_cmd(LHASH *prog,int argc,char *argv[]);
144 static void list_pkey(BIO *out);
145 char *default_config_file=NULL;
146
147 /* Make sure there is only one when MONOLITH is defined */
148 #ifdef MONOLITH
149 CONF *config=NULL;
150 BIO *bio_err=NULL;
151 #endif
152
153
154 static void lock_dbg_cb(int mode, int type, const char *file, int line)
155         {
156         static int modes[CRYPTO_NUM_LOCKS]; /* = {0, 0, ... } */
157         const char *errstr = NULL;
158         int rw;
159         
160         rw = mode & (CRYPTO_READ|CRYPTO_WRITE);
161         if (!((rw == CRYPTO_READ) || (rw == CRYPTO_WRITE)))
162                 {
163                 errstr = "invalid mode";
164                 goto err;
165                 }
166
167         if (type < 0 || type >= CRYPTO_NUM_LOCKS)
168                 {
169                 errstr = "type out of bounds";
170                 goto err;
171                 }
172
173         if (mode & CRYPTO_LOCK)
174                 {
175                 if (modes[type])
176                         {
177                         errstr = "already locked";
178                         /* must not happen in a single-threaded program
179                          * (would deadlock) */
180                         goto err;
181                         }
182
183                 modes[type] = rw;
184                 }
185         else if (mode & CRYPTO_UNLOCK)
186                 {
187                 if (!modes[type])
188                         {
189                         errstr = "not locked";
190                         goto err;
191                         }
192                 
193                 if (modes[type] != rw)
194                         {
195                         errstr = (rw == CRYPTO_READ) ?
196                                 "CRYPTO_r_unlock on write lock" :
197                                 "CRYPTO_w_unlock on read lock";
198                         }
199
200                 modes[type] = 0;
201                 }
202         else
203                 {
204                 errstr = "invalid mode";
205                 goto err;
206                 }
207
208  err:
209         if (errstr)
210                 {
211                 /* we cannot use bio_err here */
212                 fprintf(stderr, "openssl (lock_dbg_cb): %s (mode=%d, type=%d) at %s:%d\n",
213                         errstr, mode, type, file, line);
214                 }
215         }
216
217
218 int main(int Argc, char *Argv[])
219         {
220         ARGS arg;
221 #define PROG_NAME_SIZE  39
222         char pname[PROG_NAME_SIZE+1];
223         FUNCTION f,*fp;
224         MS_STATIC const char *prompt;
225         MS_STATIC char buf[1024];
226         char *to_free=NULL;
227         int n,i,ret=0;
228         int argc;
229         char **argv,*p;
230         LHASH *prog=NULL;
231         long errline;
232  
233         arg.data=NULL;
234         arg.count=0;
235
236         if (bio_err == NULL)
237                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
238                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
239
240         if (getenv("OPENSSL_DEBUG_MEMORY") != NULL) /* if not defined, use compiled-in library defaults */
241                 {
242                 if (!(0 == strcmp(getenv("OPENSSL_DEBUG_MEMORY"), "off")))
243                         {
244                         CRYPTO_malloc_debug_init();
245                         CRYPTO_set_mem_debug_options(V_CRYPTO_MDEBUG_ALL);
246                         }
247                 else
248                         {
249                         /* OPENSSL_DEBUG_MEMORY=off */
250                         CRYPTO_set_mem_debug_functions(0, 0, 0, 0, 0);
251                         }
252                 }
253         CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
254
255 #if 0
256         if (getenv("OPENSSL_DEBUG_LOCKING") != NULL)
257 #endif
258                 {
259                 CRYPTO_set_locking_callback(lock_dbg_cb);
260                 }
261
262         apps_startup();
263
264         /* Lets load up our environment a little */
265         p=getenv("OPENSSL_CONF");
266         if (p == NULL)
267                 p=getenv("SSLEAY_CONF");
268         if (p == NULL)
269                 p=to_free=make_config_name();
270
271         default_config_file=p;
272
273         config=NCONF_new(NULL);
274         i=NCONF_load(config,p,&errline);
275         if (i == 0)
276                 {
277                 NCONF_free(config);
278                 config = NULL;
279                 ERR_clear_error();
280                 }
281
282         prog=prog_init();
283
284         /* first check the program name */
285         program_name(Argv[0],pname,sizeof pname);
286
287         f.name=pname;
288         fp=(FUNCTION *)lh_retrieve(prog,&f);
289         if (fp != NULL)
290                 {
291                 Argv[0]=pname;
292                 ret=fp->func(Argc,Argv);
293                 goto end;
294                 }
295
296         /* ok, now check that there are not arguments, if there are,
297          * run with them, shifting the ssleay off the front */
298         if (Argc != 1)
299                 {
300                 Argc--;
301                 Argv++;
302                 ret=do_cmd(prog,Argc,Argv);
303                 if (ret < 0) ret=0;
304                 goto end;
305                 }
306
307         /* ok, lets enter the old 'OpenSSL>' mode */
308         
309         for (;;)
310                 {
311                 ret=0;
312                 p=buf;
313                 n=sizeof buf;
314                 i=0;
315                 for (;;)
316                         {
317                         p[0]='\0';
318                         if (i++)
319                                 prompt=">";
320                         else    prompt="OpenSSL> ";
321                         fputs(prompt,stdout);
322                         fflush(stdout);
323                         fgets(p,n,stdin);
324                         if (p[0] == '\0') goto end;
325                         i=strlen(p);
326                         if (i <= 1) break;
327                         if (p[i-2] != '\\') break;
328                         i-=2;
329                         p+=i;
330                         n-=i;
331                         }
332                 if (!chopup_args(&arg,buf,&argc,&argv)) break;
333
334                 ret=do_cmd(prog,argc,argv);
335                 if (ret < 0)
336                         {
337                         ret=0;
338                         goto end;
339                         }
340                 if (ret != 0)
341                         BIO_printf(bio_err,"error in %s\n",argv[0]);
342                 (void)BIO_flush(bio_err);
343                 }
344         BIO_printf(bio_err,"bad exit\n");
345         ret=1;
346 end:
347         if (to_free)
348                 OPENSSL_free(to_free);
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         OPENSSL_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 #define LIST_PUBLIC_KEY_ALGORITHMS "list-public-key-algorithms"
372
373 static int do_cmd(LHASH *prog, int argc, char *argv[])
374         {
375         FUNCTION f,*fp;
376         int i,ret=1,tp,nl;
377
378         if ((argc <= 0) || (argv[0] == NULL))
379                 { ret=0; goto end; }
380         f.name=argv[0];
381         fp=(FUNCTION *)lh_retrieve(prog,&f);
382         if (fp != NULL)
383                 {
384                 ret=fp->func(argc,argv);
385                 }
386         else if ((strncmp(argv[0],"no-",3)) == 0)
387                 {
388                 BIO *bio_stdout = BIO_new_fp(stdout,BIO_NOCLOSE);
389 #ifdef OPENSSL_SYS_VMS
390                 {
391                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
392                 bio_stdout = BIO_push(tmpbio, bio_stdout);
393                 }
394 #endif
395                 f.name=argv[0]+3;
396                 ret = (lh_retrieve(prog,&f) != NULL);
397                 if (!ret)
398                         BIO_printf(bio_stdout, "%s\n", argv[0]);
399                 else
400                         BIO_printf(bio_stdout, "%s\n", argv[0]+3);
401                 BIO_free_all(bio_stdout);
402                 goto end;
403                 }
404         else if ((strcmp(argv[0],"quit") == 0) ||
405                 (strcmp(argv[0],"q") == 0) ||
406                 (strcmp(argv[0],"exit") == 0) ||
407                 (strcmp(argv[0],"bye") == 0))
408                 {
409                 ret= -1;
410                 goto end;
411                 }
412         else if ((strcmp(argv[0],LIST_STANDARD_COMMANDS) == 0) ||
413                 (strcmp(argv[0],LIST_MESSAGE_DIGEST_COMMANDS) == 0) ||
414                 (strcmp(argv[0],LIST_CIPHER_COMMANDS) == 0) ||
415                 (strcmp(argv[0],LIST_PUBLIC_KEY_ALGORITHMS) == 0))
416                 {
417                 int list_type;
418                 BIO *bio_stdout;
419
420                 if (strcmp(argv[0],LIST_STANDARD_COMMANDS) == 0)
421                         list_type = FUNC_TYPE_GENERAL;
422                 else if (strcmp(argv[0],LIST_MESSAGE_DIGEST_COMMANDS) == 0)
423                         list_type = FUNC_TYPE_MD;
424                 else if (strcmp(argv[0],LIST_PUBLIC_KEY_ALGORITHMS) == 0)
425                         list_type = FUNC_TYPE_PKEY;
426                 else /* strcmp(argv[0],LIST_CIPHER_COMMANDS) == 0 */
427                         list_type = FUNC_TYPE_CIPHER;
428                 bio_stdout = BIO_new_fp(stdout,BIO_NOCLOSE);
429 #ifdef OPENSSL_SYS_VMS
430                 {
431                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
432                 bio_stdout = BIO_push(tmpbio, bio_stdout);
433                 }
434 #endif
435
436                 if (!load_config(bio_err, NULL))
437                         goto end;
438
439                 if (list_type == FUNC_TYPE_PKEY)
440                         list_pkey(bio_stdout);  
441                 else
442                         {
443                         for (fp=functions; fp->name != NULL; fp++)
444                                 if (fp->type == list_type)
445                                         BIO_printf(bio_stdout, "%s\n",
446                                                                 fp->name);
447                         }
448                 BIO_free_all(bio_stdout);
449                 ret=0;
450                 goto end;
451                 }
452         else
453                 {
454                 BIO_printf(bio_err,"openssl:Error: '%s' is an invalid command.\n",
455                         argv[0]);
456                 BIO_printf(bio_err, "\nStandard commands");
457                 i=0;
458                 tp=0;
459                 for (fp=functions; fp->name != NULL; fp++)
460                         {
461                         nl=0;
462 #ifdef OPENSSL_NO_CAMELLIA
463                         if (((i++) % 5) == 0)
464 #else
465                         if (((i++) % 4) == 0)
466 #endif
467                                 {
468                                 BIO_printf(bio_err,"\n");
469                                 nl=1;
470                                 }
471                         if (fp->type != tp)
472                                 {
473                                 tp=fp->type;
474                                 if (!nl) BIO_printf(bio_err,"\n");
475                                 if (tp == FUNC_TYPE_MD)
476                                         {
477                                         i=1;
478                                         BIO_printf(bio_err,
479                                                 "\nMessage Digest commands (see the `dgst' command for more details)\n");
480                                         }
481                                 else if (tp == FUNC_TYPE_CIPHER)
482                                         {
483                                         i=1;
484                                         BIO_printf(bio_err,"\nCipher commands (see the `enc' command for more details)\n");
485                                         }
486                                 }
487 #ifdef OPENSSL_NO_CAMELLIA
488                         BIO_printf(bio_err,"%-15s",fp->name);
489 #else
490                         BIO_printf(bio_err,"%-18s",fp->name);
491 #endif
492                         }
493                 BIO_printf(bio_err,"\n\n");
494                 ret=0;
495                 }
496 end:
497         return(ret);
498         }
499
500 static int SortFnByName(const void *_f1,const void *_f2)
501     {
502     const FUNCTION *f1=_f1;
503     const FUNCTION *f2=_f2;
504
505     if(f1->type != f2->type)
506         return f1->type-f2->type;
507     return strcmp(f1->name,f2->name);
508     }
509
510 static void list_pkey(BIO *out)
511         {
512         int i;
513         for (i = 0; i < EVP_PKEY_asn1_get_count(); i++)
514                 {
515                 const EVP_PKEY_ASN1_METHOD *ameth;
516                 int pkey_id, pkey_base_id, pkey_flags;
517                 const char *pinfo, *pem_str;
518                 ameth = EVP_PKEY_asn1_get0(i);
519                 EVP_PKEY_asn1_get0_info(&pkey_id, &pkey_base_id, &pkey_flags,
520                                                 &pinfo, &pem_str, ameth);
521                 if (pkey_flags & ASN1_PKEY_ALIAS)
522                         {
523                         BIO_printf(out, "Name: %s\n", 
524                                         OBJ_nid2ln(pkey_id));
525                         BIO_printf(out, "\tType: Alias to %s\n",
526                                         OBJ_nid2ln(pkey_base_id));
527                         }
528                 else
529                         {
530                         BIO_printf(out, "Name: %s\n", pinfo);
531                         BIO_printf(out, "\tType: %s Algorithm\n", 
532                                 pkey_flags & ASN1_PKEY_DYNAMIC ?
533                                         "External" : "Builtin");
534                         BIO_printf(out, "\tOID: %s\n", OBJ_nid2ln(pkey_id));
535                         if (pem_str == NULL)
536                                 pem_str = "(none)";
537                         BIO_printf(out, "\tPEM string: %s\n", pem_str);
538                         }
539                                         
540                 }
541         }
542
543 static LHASH *prog_init(void)
544         {
545         LHASH *ret;
546         FUNCTION *f;
547         size_t i;
548
549         /* Purely so it looks nice when the user hits ? */
550         for(i=0,f=functions ; f->name != NULL ; ++f,++i)
551             ;
552         qsort(functions,i,sizeof *functions,SortFnByName);
553
554         if ((ret=lh_new(hash, cmp)) == NULL)
555                 return(NULL);
556
557         for (f=functions; f->name != NULL; f++)
558                 lh_insert(ret,f);
559         return(ret);
560         }
561
562 /* static int MS_CALLBACK cmp(FUNCTION *a, FUNCTION *b) */
563 static int MS_CALLBACK cmp(const void *a_void, const void *b_void)
564         {
565         return(strncmp(((const FUNCTION *)a_void)->name,
566                         ((const FUNCTION *)b_void)->name,8));
567         }
568
569 /* static unsigned long MS_CALLBACK hash(FUNCTION *a) */
570 static unsigned long MS_CALLBACK hash(const void *a_void)
571         {
572         return(lh_strhash(((const FUNCTION *)a_void)->name));
573         }