1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
57 /* ====================================================================
58 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
86 * 6. Redistributions of any form whatsoever must retain the following
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
114 #include <openssl/bio.h>
115 #include <openssl/crypto.h>
116 #include <openssl/rand.h>
117 #include <openssl/lhash.h>
118 #include <openssl/conf.h>
119 #include <openssl/x509.h>
120 #include <openssl/pem.h>
121 #include <openssl/ssl.h>
122 #ifndef OPENSSL_NO_ENGINE
123 # include <openssl/engine.h>
125 /* needed for the _O_BINARY defs in the MS world */
128 #include <openssl/err.h>
130 # include <openssl/fips.h>
132 #define INCLUDE_FUNCTION_TABLE
136 #ifdef OPENSSL_NO_CAMELLIA
137 # define FORMAT "%-15s"
140 # define FORMAT "%-18s"
144 /* Special sentinel to exit the program. */
145 #define EXIT_THE_PROGRAM (-1)
148 * The LHASH callbacks ("hash" & "cmp") have been replaced by functions with
149 * the base prototypes (we cast each variable inside the function to the
150 * required type of "FUNCTION*"). This removes the necessity for
151 * macro-generated wrapper functions.
153 DECLARE_LHASH_OF(FUNCTION);
154 static LHASH_OF(FUNCTION) *prog_init(void);
155 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[]);
156 static void list_pkey(void);
157 static void list_type(FUNC_TYPE ft);
158 char *default_config_file = NULL;
165 static void apps_startup()
168 signal(SIGPIPE, SIG_IGN);
170 CRYPTO_malloc_init();
171 ERR_load_crypto_strings();
172 ERR_load_SSL_strings();
173 OpenSSL_add_all_algorithms();
174 OpenSSL_add_ssl_algorithms();
175 OPENSSL_load_builtin_modules();
177 /*SSL_library_init();*/
178 #ifndef OPENSSL_NO_ENGINE
179 ENGINE_load_builtin_engines();
183 static void apps_shutdown()
185 #ifndef OPENSSL_NO_ENGINE
189 CONF_modules_unload(1);
190 #ifndef OPENSSL_NO_COMP
192 SSL_COMP_free_compression_methods();
196 CRYPTO_cleanup_all_ex_data();
197 ERR_remove_thread_state(NULL);
202 static char *make_config_name()
208 if ((t = getenv("OPENSSL_CONF")) != NULL
209 || (t = getenv("SSLEAY_CONF")) != NULL)
210 return BUF_strdup(t);
212 t = X509_get_default_cert_area();
213 len = strlen(t) + 1 + strlen(OPENSSL_CONF) + 1;
214 p = app_malloc(len, "config filename buffer");
216 #ifndef OPENSSL_SYS_VMS
219 strcat(p, OPENSSL_CONF);
224 static void lock_dbg_cb(int mode, int type, const char *file, int line)
226 static int modes[CRYPTO_NUM_LOCKS];
227 const char *errstr = NULL;
228 int rw = mode & (CRYPTO_READ | CRYPTO_WRITE);
230 if (rw != CRYPTO_READ && rw != CRYPTO_WRITE) {
231 errstr = "invalid mode";
235 if (type < 0 || type >= CRYPTO_NUM_LOCKS) {
236 errstr = "type out of bounds";
240 if (mode & CRYPTO_LOCK) {
242 errstr = "already locked";
243 /* must not happen in a single-threaded program --> deadlock! */
247 } else if (mode & CRYPTO_UNLOCK) {
249 errstr = "not locked";
253 if (modes[type] != rw) {
254 errstr = (rw == CRYPTO_READ) ?
255 "CRYPTO_r_unlock on write lock" :
256 "CRYPTO_w_unlock on read lock";
261 errstr = "invalid mode";
267 /* we cannot use bio_err here */
269 "openssl (lock_dbg_cb): %s (mode=%d, type=%d) at %s:%d\n",
270 errstr, mode, type, file, line);
274 BIO *dup_bio_in(void)
276 return BIO_new_fp(stdin, BIO_NOCLOSE | BIO_FP_TEXT);
279 BIO *dup_bio_out(void)
281 BIO *b = BIO_new_fp(stdout, BIO_NOCLOSE | BIO_FP_TEXT);
282 #ifdef OPENSSL_SYS_VMS
283 b = BIO_push(BIO_new(BIO_f_linebuffer()), b);
288 void unbuffer(FILE *fp)
293 static BIO *bio_open_default_(const char *filename, const char *mode, int quiet)
297 if (filename == NULL || strcmp(filename, "-") == 0) {
298 ret = *mode == 'r' ? dup_bio_in() : dup_bio_out();
306 "Can't open %s, %s\n",
307 *mode == 'r' ? "stdin" : "stdout", strerror(errno));
309 ret = BIO_new_file(filename, mode);
317 "Can't open %s for %s, %s\n",
319 *mode == 'r' ? "reading" : "writing", strerror(errno));
321 ERR_print_errors(bio_err);
324 BIO *bio_open_default(const char *filename, const char *mode)
326 return bio_open_default_(filename, mode, 0);
328 BIO *bio_open_default_quiet(const char *filename, const char *mode)
330 return bio_open_default_(filename, mode, 1);
333 #if defined( OPENSSL_SYS_VMS)
334 extern char **copy_argv(int *argc, char **argv);
337 int main(int argc, char *argv[])
340 LHASH_OF(FUNCTION) *prog = NULL;
341 char **copied_argv = NULL;
346 int first, n, i, ret = 0;
351 #if defined( OPENSSL_SYS_VMS)
352 copied_argv = argv = copy_argv(&argc, argv);
355 p = getenv("OPENSSL_DEBUG_MEMORY");
357 /* if not set, use compiled-in default */
359 else if (strcmp(p, "off") != 0) {
360 CRYPTO_malloc_debug_init();
361 CRYPTO_set_mem_debug_options(V_CRYPTO_MDEBUG_ALL);
363 CRYPTO_set_mem_debug_functions(0, 0, 0, 0, 0);
365 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
366 CRYPTO_set_locking_callback(lock_dbg_cb);
368 if (getenv("OPENSSL_FIPS")) {
370 if (!FIPS_mode_set(1)) {
371 ERR_load_crypto_strings();
372 ERR_print_errors(BIO_new_fp(stderr, BIO_NOCLOSE));
376 fprintf(stderr, "FIPS mode not supported.\n");
384 * If first argument is a colon, skip it. Because in "interactive"
385 * mode our prompt is a colon and we can cut/paste whole lines
386 * by doing this hack.
388 if (argv[1] && strcmp(argv[1], ":") == 0) {
394 pname = opt_progname(argv[0]);
396 /* Lets load up our environment a little */
397 default_config_file = make_config_name();
398 bio_in = dup_bio_in();
399 bio_out = dup_bio_out();
400 bio_err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
402 /* first check the program name */
404 fp = lh_FUNCTION_retrieve(prog, &f);
407 ret = fp->func(argc, argv);
411 /* If there is stuff on the command line, run with that. */
415 ret = do_cmd(prog, argc, argv);
421 /* ok, lets enter interactive mode */
424 /* Read a line, continue reading if line ends with \ */
425 for (p = buf, n = sizeof buf, i = 0, first = 1; n > 0; first = 0) {
426 prompt = first ? "openssl : " : "> ";
429 fputs(prompt, stdout);
431 if (!fgets(p, n, stdin))
438 if (p[i - 2] != '\\')
445 extern char *readline(const char *);
446 extern void add_history(const char *cp);
449 char *text = readline(prompt);
455 if (text[i - 1] != '\\') {
456 p += strlen(strcpy(p, text));
463 p += strlen(strcpy(p, text));
470 if (!chopup_args(&arg, buf)) {
471 BIO_printf(bio_err, "Can't parse (no memory?)\n");
475 ret = do_cmd(prog, arg.argc, arg.argv);
476 if (ret == EXIT_THE_PROGRAM) {
481 BIO_printf(bio_err, "error in %s\n", arg.argv[0]);
482 (void)BIO_flush(bio_out);
483 (void)BIO_flush(bio_err);
487 OPENSSL_free(copied_argv);
488 OPENSSL_free(default_config_file);
491 lh_FUNCTION_free(prog);
492 OPENSSL_free(arg.argv);
495 BIO_free_all(bio_out);
497 CRYPTO_mem_leaks(bio_err);
502 OPTIONS exit_options[] = {
506 static void list_cipher_fn(const EVP_CIPHER *c,
507 const char *from, const char *to, void *arg)
510 BIO_printf(arg, "%s\n", EVP_CIPHER_name(c));
513 from = "<undefined>";
516 BIO_printf(arg, "%s => %s\n", from, to);
520 static void list_md_fn(const EVP_MD *m,
521 const char *from, const char *to, void *arg)
524 BIO_printf(arg, "%s\n", EVP_MD_name(m));
527 from = "<undefined>";
530 BIO_printf((BIO *)arg, "%s => %s\n", from, to);
534 /* Unified enum for help and list commands. */
535 typedef enum HELPLIST_CHOICE {
536 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
537 OPT_COMMANDS, OPT_DIGEST_COMMANDS,
538 OPT_DIGEST_ALGORITHMS, OPT_CIPHER_COMMANDS, OPT_CIPHER_ALGORITHMS,
542 OPTIONS list_options[] = {
543 {"help", OPT_HELP, '-', "Display this summary"},
544 {"commands", OPT_COMMANDS, '-', "List of standard commands"},
545 {"digest-commands", OPT_DIGEST_COMMANDS, '-',
546 "List of message digest commands"},
547 {"digest-algorithms", OPT_DIGEST_ALGORITHMS, '-',
548 "List of message digest algorithms"},
549 {"cipher-commands", OPT_CIPHER_COMMANDS, '-', "List of cipher commands"},
550 {"cipher-algorithms", OPT_CIPHER_ALGORITHMS, '-',
551 "List of cipher algorithms"},
552 {"public-key-algorithms", OPT_PK_ALGORITHMS, '-',
553 "List of public key algorithms"},
557 int list_main(int argc, char **argv)
562 prog = opt_init(argc, argv, list_options);
563 while ((o = opt_next()) != OPT_EOF) {
567 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
570 opt_help(list_options);
573 list_type(FT_general);
575 case OPT_DIGEST_COMMANDS:
578 case OPT_DIGEST_ALGORITHMS:
579 EVP_MD_do_all_sorted(list_md_fn, bio_out);
581 case OPT_CIPHER_COMMANDS:
582 list_type(FT_cipher);
584 case OPT_CIPHER_ALGORITHMS:
585 EVP_CIPHER_do_all_sorted(list_cipher_fn, bio_out);
587 case OPT_PK_ALGORITHMS:
596 OPTIONS help_options[] = {
597 {"help", OPT_HELP, '-', "Display this summary"},
601 int help_main(int argc, char **argv)
609 prog = opt_init(argc, argv, help_options);
610 while ((o = opt_next()) != OPT_EOF) {
613 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
616 opt_help(help_options);
620 argc = opt_num_rest();
624 BIO_printf(bio_err, "Usage: %s\n", prog);
628 BIO_printf(bio_err, "\nStandard commands");
631 for (fp = functions; fp->name != NULL; fp++) {
633 if (((i++) % COLUMNS) == 0) {
634 BIO_printf(bio_err, "\n");
637 if (fp->type != tp) {
640 BIO_printf(bio_err, "\n");
644 "\nMessage Digest commands (see the `dgst' command for more details)\n");
645 } else if (tp == FT_cipher) {
648 "\nCipher commands (see the `enc' command for more details)\n");
651 BIO_printf(bio_err, FORMAT, fp->name);
653 BIO_printf(bio_err, "\n\n");
657 int exit_main(int argc, char **argv)
659 return EXIT_THE_PROGRAM;
662 static void list_type(FUNC_TYPE ft)
667 for (fp = functions; fp->name != NULL; fp++)
668 if (fp->type == ft) {
669 if ((i++ % COLUMNS) == 0)
670 BIO_printf(bio_out, "\n");
671 BIO_printf(bio_out, FORMAT, fp->name);
673 BIO_printf(bio_out, "\n");
676 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[])
680 if (argc <= 0 || argv[0] == NULL)
683 fp = lh_FUNCTION_retrieve(prog, &f);
685 if (EVP_get_digestbyname(argv[0])) {
689 } else if (EVP_get_cipherbyname(argv[0])) {
696 return (fp->func(argc, argv));
698 if ((strncmp(argv[0], "no-", 3)) == 0) {
700 * User is asking if foo is unsupported, by trying to "run" the
701 * no-foo command. Strange.
703 f.name = argv[0] + 3;
704 if (lh_FUNCTION_retrieve(prog, &f) == NULL) {
705 BIO_printf(bio_out, "%s\n", argv[0]);
708 BIO_printf(bio_out, "%s\n", argv[0] + 3);
711 if (strcmp(argv[0], "quit") == 0 || strcmp(argv[0], "q") == 0 ||
712 strcmp(argv[0], "exit") == 0 || strcmp(argv[0], "bye") == 0)
713 /* Special value to mean "exit the program. */
714 return EXIT_THE_PROGRAM;
716 BIO_printf(bio_err, "Invalid command '%s'; type \"help\" for a list.\n",
721 static void list_pkey(void)
725 for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
726 const EVP_PKEY_ASN1_METHOD *ameth;
727 int pkey_id, pkey_base_id, pkey_flags;
728 const char *pinfo, *pem_str;
729 ameth = EVP_PKEY_asn1_get0(i);
730 EVP_PKEY_asn1_get0_info(&pkey_id, &pkey_base_id, &pkey_flags,
731 &pinfo, &pem_str, ameth);
732 if (pkey_flags & ASN1_PKEY_ALIAS) {
733 BIO_printf(bio_out, "Name: %s\n", OBJ_nid2ln(pkey_id));
734 BIO_printf(bio_out, "\tAlias for: %s\n",
735 OBJ_nid2ln(pkey_base_id));
737 BIO_printf(bio_out, "Name: %s\n", pinfo);
738 BIO_printf(bio_out, "\tType: %s Algorithm\n",
739 pkey_flags & ASN1_PKEY_DYNAMIC ?
740 "External" : "Builtin");
741 BIO_printf(bio_out, "\tOID: %s\n", OBJ_nid2ln(pkey_id));
744 BIO_printf(bio_out, "\tPEM string: %s\n", pem_str);
750 static int function_cmp(const FUNCTION * a, const FUNCTION * b)
752 return strncmp(a->name, b->name, 8);
755 static IMPLEMENT_LHASH_COMP_FN(function, FUNCTION)
757 static unsigned long function_hash(const FUNCTION * a)
759 return lh_strhash(a->name);
762 static IMPLEMENT_LHASH_HASH_FN(function, FUNCTION)
764 static int SortFnByName(const void *_f1, const void *_f2)
766 const FUNCTION *f1 = _f1;
767 const FUNCTION *f2 = _f2;
769 if (f1->type != f2->type)
770 return f1->type - f2->type;
771 return strcmp(f1->name, f2->name);
774 static LHASH_OF(FUNCTION) *prog_init(void)
776 LHASH_OF(FUNCTION) *ret;
780 /* Sort alphabetically within category. For nicer help displays. */
781 for (i = 0, f = functions; f->name != NULL; ++f, ++i) ;
782 qsort(functions, i, sizeof(*functions), SortFnByName);
784 if ((ret = lh_FUNCTION_new()) == NULL)
787 for (f = functions; f->name != NULL; f++)
788 (void)lh_FUNCTION_insert(ret, f);