2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #include <internal/cryptlib.h>
14 #include <openssl/bio.h>
15 #include <openssl/crypto.h>
16 #include <openssl/lhash.h>
17 #include <openssl/conf.h>
18 #include <openssl/x509.h>
19 #include <openssl/pem.h>
20 #include <openssl/ssl.h>
21 #ifndef OPENSSL_NO_ENGINE
22 # include <openssl/engine.h>
24 #include <openssl/err.h>
26 /* Needed to get the other O_xxx flags. */
27 #ifdef OPENSSL_SYS_VMS
31 #define INCLUDE_FUNCTION_TABLE
34 /* Structure to hold the number of columns to be displayed and the
35 * field width used to display them.
42 /* Special sentinel to exit the program. */
43 #define EXIT_THE_PROGRAM (-1)
46 * The LHASH callbacks ("hash" & "cmp") have been replaced by functions with
47 * the base prototypes (we cast each variable inside the function to the
48 * required type of "FUNCTION*"). This removes the necessity for
49 * macro-generated wrapper functions.
51 static LHASH_OF(FUNCTION) *prog_init(void);
52 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[]);
53 static void list_pkey(void);
54 static void list_pkey_meth(void);
55 static void list_type(FUNC_TYPE ft, int one);
56 static void list_disabled(void);
57 char *default_config_file = NULL;
63 static void calculate_columns(DISPLAY_COLUMNS *dc)
68 for (f = functions; f->name != NULL; ++f)
69 if (f->type == FT_general || f->type == FT_md || f->type == FT_cipher)
70 if ((len = strlen(f->name)) > maxlen)
73 dc->width = maxlen + 2;
74 dc->columns = (80 - 1) / dc->width;
77 static int apps_startup(void)
80 signal(SIGPIPE, SIG_IGN);
83 /* Set non-default library initialisation settings */
84 if (!OPENSSL_init_ssl(OPENSSL_INIT_ENGINE_ALL_BUILTIN
85 | OPENSSL_INIT_LOAD_CONFIG, NULL))
93 static void apps_shutdown(void)
96 destroy_prefix_method();
99 static char *make_config_name(void)
105 if ((t = getenv("OPENSSL_CONF")) != NULL)
106 return OPENSSL_strdup(t);
108 t = X509_get_default_cert_area();
109 len = strlen(t) + 1 + strlen(OPENSSL_CONF) + 1;
110 p = app_malloc(len, "config filename buffer");
112 #ifndef OPENSSL_SYS_VMS
115 strcat(p, OPENSSL_CONF);
120 int main(int argc, char *argv[])
123 LHASH_OF(FUNCTION) *prog = NULL;
124 char **copied_argv = NULL;
129 int first, n, i, ret = 0;
134 /* Set up some of the environment. */
135 default_config_file = make_config_name();
136 bio_in = dup_bio_in(FORMAT_TEXT);
137 bio_out = dup_bio_out(FORMAT_TEXT);
138 bio_err = dup_bio_err(FORMAT_TEXT);
140 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
141 copied_argv = argv = copy_argv(&argc, argv);
142 #elif defined(_WIN32)
144 * Replace argv[] with UTF-8 encoded strings.
146 win32_utf8argv(&argc, &argv);
149 p = getenv("OPENSSL_DEBUG_MEMORY");
150 if (p != NULL && strcmp(p, "on") == 0)
151 CRYPTO_set_mem_debug(1);
152 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
154 if (getenv("OPENSSL_FIPS")) {
155 BIO_printf(bio_err, "FIPS mode not supported.\n");
159 if (!apps_startup()) {
161 "FATAL: Startup failure (dev note: apps_startup() failed)\n");
162 ERR_print_errors(bio_err);
168 pname = opt_progname(argv[0]);
170 /* first check the program name */
172 fp = lh_FUNCTION_retrieve(prog, &f);
175 ret = fp->func(argc, argv);
179 /* If there is stuff on the command line, run with that. */
183 ret = do_cmd(prog, argc, argv);
189 /* ok, lets enter interactive mode */
192 /* Read a line, continue reading if line ends with \ */
193 for (p = buf, n = sizeof(buf), i = 0, first = 1; n > 0; first = 0) {
194 prompt = first ? "OpenSSL> " : "> ";
197 fputs(prompt, stdout);
199 if (!fgets(p, n, stdin))
206 if (p[i - 2] != '\\')
213 extern char *readline(const char *);
214 extern void add_history(const char *cp);
217 text = readline(prompt);
223 if (text[i - 1] != '\\') {
224 p += strlen(strcpy(p, text));
231 p += strlen(strcpy(p, text));
238 if (!chopup_args(&arg, buf)) {
239 BIO_printf(bio_err, "Can't parse (no memory?)\n");
243 ret = do_cmd(prog, arg.argc, arg.argv);
244 if (ret == EXIT_THE_PROGRAM) {
249 BIO_printf(bio_err, "error in %s\n", arg.argv[0]);
250 (void)BIO_flush(bio_out);
251 (void)BIO_flush(bio_err);
255 OPENSSL_free(copied_argv);
256 OPENSSL_free(default_config_file);
257 lh_FUNCTION_free(prog);
258 OPENSSL_free(arg.argv);
262 BIO_free_all(bio_out);
264 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
265 if (CRYPTO_mem_leaks(bio_err) <= 0)
272 static void list_cipher_fn(const EVP_CIPHER *c,
273 const char *from, const char *to, void *arg)
276 BIO_printf(arg, "%s\n", EVP_CIPHER_name(c));
279 from = "<undefined>";
282 BIO_printf(arg, "%s => %s\n", from, to);
286 static void list_md_fn(const EVP_MD *m,
287 const char *from, const char *to, void *arg)
290 BIO_printf(arg, "%s\n", EVP_MD_name(m));
293 from = "<undefined>";
296 BIO_printf((BIO *)arg, "%s => %s\n", from, to);
300 static void list_missing_help(void)
305 for (fp = functions; fp->name != NULL; fp++) {
306 if ((o = fp->help) != NULL) {
307 /* If there is help, list what flags are not documented. */
308 for ( ; o->name != NULL; o++) {
309 if (o->helpstr == NULL)
310 BIO_printf(bio_out, "%s %s\n", fp->name, o->name);
312 } else if (fp->func != dgst_main) {
313 /* If not aliased to the dgst command, */
314 BIO_printf(bio_out, "%s *\n", fp->name);
319 static void list_options_for_command(const char *command)
324 for (fp = functions; fp->name != NULL; fp++)
325 if (strcmp(fp->name, command) == 0)
327 if (fp->name == NULL) {
328 BIO_printf(bio_err, "Invalid command '%s'; type \"help\" for a list.\n",
333 if ((o = fp->help) == NULL)
336 for ( ; o->name != NULL; o++) {
337 if (o->name == OPT_HELP_STR
338 || o->name == OPT_MORE_STR
339 || o->name[0] == '\0')
341 BIO_printf(bio_out, "%s %c\n", o->name, o->valtype);
346 /* Unified enum for help and list commands. */
347 typedef enum HELPLIST_CHOICE {
348 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP, OPT_ONE,
349 OPT_COMMANDS, OPT_DIGEST_COMMANDS, OPT_OPTIONS,
350 OPT_DIGEST_ALGORITHMS, OPT_CIPHER_COMMANDS, OPT_CIPHER_ALGORITHMS,
351 OPT_PK_ALGORITHMS, OPT_PK_METHOD, OPT_DISABLED, OPT_MISSING_HELP
354 const OPTIONS list_options[] = {
355 {"help", OPT_HELP, '-', "Display this summary"},
356 {"1", OPT_ONE, '-', "List in one column"},
357 {"commands", OPT_COMMANDS, '-', "List of standard commands"},
358 {"digest-commands", OPT_DIGEST_COMMANDS, '-',
359 "List of message digest commands"},
360 {"digest-algorithms", OPT_DIGEST_ALGORITHMS, '-',
361 "List of message digest algorithms"},
362 {"cipher-commands", OPT_CIPHER_COMMANDS, '-', "List of cipher commands"},
363 {"cipher-algorithms", OPT_CIPHER_ALGORITHMS, '-',
364 "List of cipher algorithms"},
365 {"public-key-algorithms", OPT_PK_ALGORITHMS, '-',
366 "List of public key algorithms"},
367 {"public-key-methods", OPT_PK_METHOD, '-',
368 "List of public key methods"},
369 {"disabled", OPT_DISABLED, '-',
370 "List of disabled features"},
371 {"missing-help", OPT_MISSING_HELP, '-',
372 "List missing detailed help strings"},
373 {"options", OPT_OPTIONS, 's',
374 "List options for specified command"},
378 int list_main(int argc, char **argv)
382 int one = 0, done = 0;
384 prog = opt_init(argc, argv, list_options);
385 while ((o = opt_next()) != OPT_EOF) {
387 case OPT_EOF: /* Never hit, but suppresses warning */
390 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
393 opt_help(list_options);
399 list_type(FT_general, one);
401 case OPT_DIGEST_COMMANDS:
402 list_type(FT_md, one);
404 case OPT_DIGEST_ALGORITHMS:
405 EVP_MD_do_all_sorted(list_md_fn, bio_out);
407 case OPT_CIPHER_COMMANDS:
408 list_type(FT_cipher, one);
410 case OPT_CIPHER_ALGORITHMS:
411 EVP_CIPHER_do_all_sorted(list_cipher_fn, bio_out);
413 case OPT_PK_ALGORITHMS:
422 case OPT_MISSING_HELP:
426 list_options_for_command(opt_arg());
431 if (opt_num_rest() != 0) {
432 BIO_printf(bio_err, "Extra arguments given.\n");
442 typedef enum HELP_CHOICE {
443 OPT_hERR = -1, OPT_hEOF = 0, OPT_hHELP
446 const OPTIONS help_options[] = {
447 {OPT_HELP_STR, 1, '-', "Usage: help [options]\n"},
448 {OPT_HELP_STR, 1, '-', " help [command]\n"},
449 {"help", OPT_hHELP, '-', "Display this summary"},
454 int help_main(int argc, char **argv)
463 prog = opt_init(argc, argv, help_options);
464 while ((o = opt_next()) != OPT_hEOF) {
468 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
471 opt_help(help_options);
476 if (opt_num_rest() == 1) {
479 new_argv[0] = opt_rest()[0];
480 new_argv[1] = "--help";
482 return do_cmd(prog_init(), 2, new_argv);
484 if (opt_num_rest() != 0) {
485 BIO_printf(bio_err, "Usage: %s\n", prog);
489 calculate_columns(&dc);
490 BIO_printf(bio_err, "Standard commands");
493 for (fp = functions; fp->name != NULL; fp++) {
495 if (i++ % dc.columns == 0) {
496 BIO_printf(bio_err, "\n");
499 if (fp->type != tp) {
502 BIO_printf(bio_err, "\n");
506 "\nMessage Digest commands (see the `dgst' command for more details)\n");
507 } else if (tp == FT_cipher) {
510 "\nCipher commands (see the `enc' command for more details)\n");
513 BIO_printf(bio_err, "%-*s", dc.width, fp->name);
515 BIO_printf(bio_err, "\n\n");
519 static void list_type(FUNC_TYPE ft, int one)
523 DISPLAY_COLUMNS dc = {0};
526 calculate_columns(&dc);
528 for (fp = functions; fp->name != NULL; fp++) {
532 BIO_printf(bio_out, "%s\n", fp->name);
534 if (i % dc.columns == 0 && i > 0)
535 BIO_printf(bio_out, "\n");
536 BIO_printf(bio_out, "%-*s", dc.width, fp->name);
541 BIO_printf(bio_out, "\n\n");
544 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[])
548 if (argc <= 0 || argv[0] == NULL)
551 fp = lh_FUNCTION_retrieve(prog, &f);
553 if (EVP_get_digestbyname(argv[0])) {
557 } else if (EVP_get_cipherbyname(argv[0])) {
564 return fp->func(argc, argv);
566 if ((strncmp(argv[0], "no-", 3)) == 0) {
568 * User is asking if foo is unsupported, by trying to "run" the
569 * no-foo command. Strange.
571 f.name = argv[0] + 3;
572 if (lh_FUNCTION_retrieve(prog, &f) == NULL) {
573 BIO_printf(bio_out, "%s\n", argv[0]);
576 BIO_printf(bio_out, "%s\n", argv[0] + 3);
579 if (strcmp(argv[0], "quit") == 0 || strcmp(argv[0], "q") == 0 ||
580 strcmp(argv[0], "exit") == 0 || strcmp(argv[0], "bye") == 0)
581 /* Special value to mean "exit the program. */
582 return EXIT_THE_PROGRAM;
584 BIO_printf(bio_err, "Invalid command '%s'; type \"help\" for a list.\n",
589 static void list_pkey(void)
593 for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
594 const EVP_PKEY_ASN1_METHOD *ameth;
595 int pkey_id, pkey_base_id, pkey_flags;
596 const char *pinfo, *pem_str;
597 ameth = EVP_PKEY_asn1_get0(i);
598 EVP_PKEY_asn1_get0_info(&pkey_id, &pkey_base_id, &pkey_flags,
599 &pinfo, &pem_str, ameth);
600 if (pkey_flags & ASN1_PKEY_ALIAS) {
601 BIO_printf(bio_out, "Name: %s\n", OBJ_nid2ln(pkey_id));
602 BIO_printf(bio_out, "\tAlias for: %s\n",
603 OBJ_nid2ln(pkey_base_id));
605 BIO_printf(bio_out, "Name: %s\n", pinfo);
606 BIO_printf(bio_out, "\tType: %s Algorithm\n",
607 pkey_flags & ASN1_PKEY_DYNAMIC ?
608 "External" : "Builtin");
609 BIO_printf(bio_out, "\tOID: %s\n", OBJ_nid2ln(pkey_id));
612 BIO_printf(bio_out, "\tPEM string: %s\n", pem_str);
618 static void list_pkey_meth(void)
621 size_t meth_count = EVP_PKEY_meth_get_count();
623 for (i = 0; i < meth_count; i++) {
624 const EVP_PKEY_METHOD *pmeth = EVP_PKEY_meth_get0(i);
625 int pkey_id, pkey_flags;
627 EVP_PKEY_meth_get0_info(&pkey_id, &pkey_flags, pmeth);
628 BIO_printf(bio_out, "%s\n", OBJ_nid2ln(pkey_id));
629 BIO_printf(bio_out, "\tType: %s Algorithm\n",
630 pkey_flags & ASN1_PKEY_DYNAMIC ? "External" : "Builtin");
634 static int function_cmp(const FUNCTION * a, const FUNCTION * b)
636 return strncmp(a->name, b->name, 8);
639 static unsigned long function_hash(const FUNCTION * a)
641 return OPENSSL_LH_strhash(a->name);
644 static int SortFnByName(const void *_f1, const void *_f2)
646 const FUNCTION *f1 = _f1;
647 const FUNCTION *f2 = _f2;
649 if (f1->type != f2->type)
650 return f1->type - f2->type;
651 return strcmp(f1->name, f2->name);
654 static void list_disabled(void)
656 BIO_puts(bio_out, "Disabled algorithms:\n");
657 #ifdef OPENSSL_NO_ARIA
658 BIO_puts(bio_out, "ARIA\n");
661 BIO_puts(bio_out, "BF\n");
663 #ifdef OPENSSL_NO_BLAKE2
664 BIO_puts(bio_out, "BLAKE2\n");
666 #ifdef OPENSSL_NO_CAMELLIA
667 BIO_puts(bio_out, "CAMELLIA\n");
669 #ifdef OPENSSL_NO_CAST
670 BIO_puts(bio_out, "CAST\n");
672 #ifdef OPENSSL_NO_CMAC
673 BIO_puts(bio_out, "CMAC\n");
675 #ifdef OPENSSL_NO_CMS
676 BIO_puts(bio_out, "CMS\n");
678 #ifdef OPENSSL_NO_COMP
679 BIO_puts(bio_out, "COMP\n");
681 #ifdef OPENSSL_NO_DES
682 BIO_puts(bio_out, "DES\n");
684 #ifdef OPENSSL_NO_DGRAM
685 BIO_puts(bio_out, "DGRAM\n");
688 BIO_puts(bio_out, "DH\n");
690 #ifdef OPENSSL_NO_DSA
691 BIO_puts(bio_out, "DSA\n");
693 #if defined(OPENSSL_NO_DTLS)
694 BIO_puts(bio_out, "DTLS\n");
696 #if defined(OPENSSL_NO_DTLS1)
697 BIO_puts(bio_out, "DTLS1\n");
699 #if defined(OPENSSL_NO_DTLS1_2)
700 BIO_puts(bio_out, "DTLS1_2\n");
703 BIO_puts(bio_out, "EC\n");
705 #ifdef OPENSSL_NO_EC2M
706 BIO_puts(bio_out, "EC2M\n");
708 #ifdef OPENSSL_NO_ENGINE
709 BIO_puts(bio_out, "ENGINE\n");
711 #ifdef OPENSSL_NO_GOST
712 BIO_puts(bio_out, "GOST\n");
714 #ifdef OPENSSL_NO_HEARTBEATS
715 BIO_puts(bio_out, "HEARTBEATS\n");
717 #ifdef OPENSSL_NO_IDEA
718 BIO_puts(bio_out, "IDEA\n");
720 #ifdef OPENSSL_NO_MD2
721 BIO_puts(bio_out, "MD2\n");
723 #ifdef OPENSSL_NO_MD4
724 BIO_puts(bio_out, "MD4\n");
726 #ifdef OPENSSL_NO_MD5
727 BIO_puts(bio_out, "MD5\n");
729 #ifdef OPENSSL_NO_MDC2
730 BIO_puts(bio_out, "MDC2\n");
732 #ifdef OPENSSL_NO_OCB
733 BIO_puts(bio_out, "OCB\n");
735 #ifdef OPENSSL_NO_OCSP
736 BIO_puts(bio_out, "OCSP\n");
738 #ifdef OPENSSL_NO_PSK
739 BIO_puts(bio_out, "PSK\n");
741 #ifdef OPENSSL_NO_RC2
742 BIO_puts(bio_out, "RC2\n");
744 #ifdef OPENSSL_NO_RC4
745 BIO_puts(bio_out, "RC4\n");
747 #ifdef OPENSSL_NO_RC5
748 BIO_puts(bio_out, "RC5\n");
750 #ifdef OPENSSL_NO_RMD160
751 BIO_puts(bio_out, "RMD160\n");
753 #ifdef OPENSSL_NO_RSA
754 BIO_puts(bio_out, "RSA\n");
756 #ifdef OPENSSL_NO_SCRYPT
757 BIO_puts(bio_out, "SCRYPT\n");
759 #ifdef OPENSSL_NO_SCTP
760 BIO_puts(bio_out, "SCTP\n");
762 #ifdef OPENSSL_NO_SEED
763 BIO_puts(bio_out, "SEED\n");
765 #ifdef OPENSSL_NO_SM2
766 BIO_puts(bio_out, "SM2\n");
768 #ifdef OPENSSL_NO_SM3
769 BIO_puts(bio_out, "SM3\n");
771 #ifdef OPENSSL_NO_SM4
772 BIO_puts(bio_out, "SM4\n");
774 #ifdef OPENSSL_NO_SOCK
775 BIO_puts(bio_out, "SOCK\n");
777 #ifdef OPENSSL_NO_SRP
778 BIO_puts(bio_out, "SRP\n");
780 #ifdef OPENSSL_NO_SRTP
781 BIO_puts(bio_out, "SRTP\n");
783 #ifdef OPENSSL_NO_SSL3
784 BIO_puts(bio_out, "SSL3\n");
786 #ifdef OPENSSL_NO_TLS1
787 BIO_puts(bio_out, "TLS1\n");
789 #ifdef OPENSSL_NO_TLS1_1
790 BIO_puts(bio_out, "TLS1_1\n");
792 #ifdef OPENSSL_NO_TLS1_2
793 BIO_puts(bio_out, "TLS1_2\n");
795 #ifdef OPENSSL_NO_WHIRLPOOL
796 BIO_puts(bio_out, "WHIRLPOOL\n");
799 BIO_puts(bio_out, "ZLIB\n");
803 static LHASH_OF(FUNCTION) *prog_init(void)
805 static LHASH_OF(FUNCTION) *ret = NULL;
806 static int prog_inited = 0;
815 /* Sort alphabetically within category. For nicer help displays. */
816 for (i = 0, f = functions; f->name != NULL; ++f, ++i)
818 qsort(functions, i, sizeof(*functions), SortFnByName);
820 if ((ret = lh_FUNCTION_new(function_hash, function_cmp)) == NULL)
823 for (f = functions; f->name != NULL; f++)
824 (void)lh_FUNCTION_insert(ret, f);