2 * Copyright 1995-2017 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
13 #include <openssl/bio.h>
14 #include <openssl/crypto.h>
15 #include <openssl/lhash.h>
16 #include <openssl/conf.h>
17 #include <openssl/x509.h>
18 #include <openssl/pem.h>
19 #include <openssl/ssl.h>
20 #ifndef OPENSSL_NO_ENGINE
21 # include <openssl/engine.h>
23 #include <openssl/err.h>
24 #define USE_SOCKETS /* needed for the _O_BINARY defs in the MS world */
26 /* Needed to get the other O_xxx flags. */
27 #ifdef OPENSSL_SYS_VMS
30 #define INCLUDE_FUNCTION_TABLE
34 #ifdef OPENSSL_NO_CAMELLIA
35 # define FORMAT "%-15s"
38 # define FORMAT "%-18s"
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_type(FUNC_TYPE ft);
55 static void list_disabled(void);
56 char *default_config_file = NULL;
62 static int apps_startup()
65 signal(SIGPIPE, SIG_IGN);
68 /* Set non-default library initialisation settings */
69 if (!OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_ALL_BUILTIN
70 | OPENSSL_INIT_LOAD_CONFIG, NULL))
78 static void apps_shutdown()
83 static char *make_config_name()
89 if ((t = getenv("OPENSSL_CONF")) != NULL)
90 return OPENSSL_strdup(t);
92 t = X509_get_default_cert_area();
93 len = strlen(t) + 1 + strlen(OPENSSL_CONF) + 1;
94 p = app_malloc(len, "config filename buffer");
96 #ifndef OPENSSL_SYS_VMS
99 strcat(p, OPENSSL_CONF);
104 int main(int argc, char *argv[])
107 LHASH_OF(FUNCTION) *prog = NULL;
108 char **copied_argv = NULL;
113 int first, n, i, ret = 0;
118 /* Set up some of the environment. */
119 default_config_file = make_config_name();
120 bio_in = dup_bio_in(FORMAT_TEXT);
121 bio_out = dup_bio_out(FORMAT_TEXT);
122 bio_err = dup_bio_err(FORMAT_TEXT);
124 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
125 copied_argv = argv = copy_argv(&argc, argv);
126 #elif defined(_WIN32)
128 * Replace argv[] with UTF-8 encoded strings.
130 win32_utf8argv(&argc, &argv);
133 p = getenv("OPENSSL_DEBUG_MEMORY");
134 if (p != NULL && strcmp(p, "on") == 0)
135 CRYPTO_set_mem_debug(1);
136 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
138 if (getenv("OPENSSL_FIPS")) {
139 BIO_printf(bio_err, "FIPS mode not supported.\n");
143 if (!apps_startup()) {
145 "FATAL: Startup failure (dev note: apps_startup() failed)\n");
146 ERR_print_errors(bio_err);
152 pname = opt_progname(argv[0]);
154 /* first check the program name */
156 fp = lh_FUNCTION_retrieve(prog, &f);
159 ret = fp->func(argc, argv);
163 /* If there is stuff on the command line, run with that. */
167 ret = do_cmd(prog, argc, argv);
173 /* ok, lets enter interactive mode */
176 /* Read a line, continue reading if line ends with \ */
177 for (p = buf, n = sizeof buf, i = 0, first = 1; n > 0; first = 0) {
178 prompt = first ? "OpenSSL> " : "> ";
181 fputs(prompt, stdout);
183 if (!fgets(p, n, stdin))
190 if (p[i - 2] != '\\')
197 extern char *readline(const char *);
198 extern void add_history(const char *cp);
201 text = readline(prompt);
207 if (text[i - 1] != '\\') {
208 p += strlen(strcpy(p, text));
215 p += strlen(strcpy(p, text));
222 if (!chopup_args(&arg, buf)) {
223 BIO_printf(bio_err, "Can't parse (no memory?)\n");
227 ret = do_cmd(prog, arg.argc, arg.argv);
228 if (ret == EXIT_THE_PROGRAM) {
233 BIO_printf(bio_err, "error in %s\n", arg.argv[0]);
234 (void)BIO_flush(bio_out);
235 (void)BIO_flush(bio_err);
239 OPENSSL_free(copied_argv);
240 OPENSSL_free(default_config_file);
241 lh_FUNCTION_free(prog);
242 OPENSSL_free(arg.argv);
246 BIO_free_all(bio_out);
248 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
249 if (CRYPTO_mem_leaks(bio_err) <= 0)
256 const OPTIONS exit_options[] = {
260 static void list_cipher_fn(const EVP_CIPHER *c,
261 const char *from, const char *to, void *arg)
264 BIO_printf(arg, "%s\n", EVP_CIPHER_name(c));
267 from = "<undefined>";
270 BIO_printf(arg, "%s => %s\n", from, to);
274 static void list_md_fn(const EVP_MD *m,
275 const char *from, const char *to, void *arg)
278 BIO_printf(arg, "%s\n", EVP_MD_name(m));
281 from = "<undefined>";
284 BIO_printf((BIO *)arg, "%s => %s\n", from, to);
288 static void list_missing_help(void)
293 for (fp = functions; fp->name != NULL; fp++) {
294 if ((o = fp->help) == NULL) {
295 BIO_printf(bio_out, "%s *\n", fp->name);
298 for ( ; o->name != NULL; o++) {
299 if (o->helpstr == NULL)
300 BIO_printf(bio_out, "%s %s\n", fp->name, o->name);
306 /* Unified enum for help and list commands. */
307 typedef enum HELPLIST_CHOICE {
308 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
309 OPT_COMMANDS, OPT_DIGEST_COMMANDS,
310 OPT_DIGEST_ALGORITHMS, OPT_CIPHER_COMMANDS, OPT_CIPHER_ALGORITHMS,
311 OPT_PK_ALGORITHMS, OPT_DISABLED, OPT_MISSING_HELP
314 const OPTIONS list_options[] = {
315 {"help", OPT_HELP, '-', "Display this summary"},
316 {"commands", OPT_COMMANDS, '-', "List of standard commands"},
317 {"digest-commands", OPT_DIGEST_COMMANDS, '-',
318 "List of message digest commands"},
319 {"digest-algorithms", OPT_DIGEST_ALGORITHMS, '-',
320 "List of message digest algorithms"},
321 {"cipher-commands", OPT_CIPHER_COMMANDS, '-', "List of cipher commands"},
322 {"cipher-algorithms", OPT_CIPHER_ALGORITHMS, '-',
323 "List of cipher algorithms"},
324 {"public-key-algorithms", OPT_PK_ALGORITHMS, '-',
325 "List of public key algorithms"},
326 {"disabled", OPT_DISABLED, '-',
327 "List of disabled features"},
328 {"missing-help", OPT_MISSING_HELP, '-',
329 "List missing detailed help strings"},
333 int list_main(int argc, char **argv)
339 prog = opt_init(argc, argv, list_options);
340 while ((o = opt_next()) != OPT_EOF) {
342 case OPT_EOF: /* Never hit, but suppresses warning */
344 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
347 opt_help(list_options);
350 list_type(FT_general);
352 case OPT_DIGEST_COMMANDS:
355 case OPT_DIGEST_ALGORITHMS:
356 EVP_MD_do_all_sorted(list_md_fn, bio_out);
358 case OPT_CIPHER_COMMANDS:
359 list_type(FT_cipher);
361 case OPT_CIPHER_ALGORITHMS:
362 EVP_CIPHER_do_all_sorted(list_cipher_fn, bio_out);
364 case OPT_PK_ALGORITHMS:
370 case OPT_MISSING_HELP:
378 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
385 typedef enum HELP_CHOICE {
386 OPT_hERR = -1, OPT_hEOF = 0, OPT_hHELP
389 const OPTIONS help_options[] = {
390 {"help", OPT_hHELP, '-', "Display this summary"},
395 int help_main(int argc, char **argv)
403 prog = opt_init(argc, argv, help_options);
404 while ((o = opt_next()) != OPT_hEOF) {
408 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
411 opt_help(help_options);
416 if (opt_num_rest() != 0) {
417 BIO_printf(bio_err, "Usage: %s\n", prog);
421 BIO_printf(bio_err, "\nStandard commands");
424 for (fp = functions; fp->name != NULL; fp++) {
426 if (((i++) % COLUMNS) == 0) {
427 BIO_printf(bio_err, "\n");
430 if (fp->type != tp) {
433 BIO_printf(bio_err, "\n");
437 "\nMessage Digest commands (see the `dgst' command for more details)\n");
438 } else if (tp == FT_cipher) {
441 "\nCipher commands (see the `enc' command for more details)\n");
444 BIO_printf(bio_err, FORMAT, fp->name);
446 BIO_printf(bio_err, "\n\n");
450 int exit_main(int argc, char **argv)
452 return EXIT_THE_PROGRAM;
455 static void list_type(FUNC_TYPE ft)
460 for (fp = functions; fp->name != NULL; fp++)
461 if (fp->type == ft) {
462 if ((i++ % COLUMNS) == 0)
463 BIO_printf(bio_out, "\n");
464 BIO_printf(bio_out, FORMAT, fp->name);
466 BIO_printf(bio_out, "\n");
469 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[])
473 if (argc <= 0 || argv[0] == NULL)
476 fp = lh_FUNCTION_retrieve(prog, &f);
478 if (EVP_get_digestbyname(argv[0])) {
482 } else if (EVP_get_cipherbyname(argv[0])) {
489 return (fp->func(argc, argv));
491 if ((strncmp(argv[0], "no-", 3)) == 0) {
493 * User is asking if foo is unsupported, by trying to "run" the
494 * no-foo command. Strange.
496 f.name = argv[0] + 3;
497 if (lh_FUNCTION_retrieve(prog, &f) == NULL) {
498 BIO_printf(bio_out, "%s\n", argv[0]);
501 BIO_printf(bio_out, "%s\n", argv[0] + 3);
504 if (strcmp(argv[0], "quit") == 0 || strcmp(argv[0], "q") == 0 ||
505 strcmp(argv[0], "exit") == 0 || strcmp(argv[0], "bye") == 0)
506 /* Special value to mean "exit the program. */
507 return EXIT_THE_PROGRAM;
509 BIO_printf(bio_err, "Invalid command '%s'; type \"help\" for a list.\n",
514 static void list_pkey(void)
518 for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
519 const EVP_PKEY_ASN1_METHOD *ameth;
520 int pkey_id, pkey_base_id, pkey_flags;
521 const char *pinfo, *pem_str;
522 ameth = EVP_PKEY_asn1_get0(i);
523 EVP_PKEY_asn1_get0_info(&pkey_id, &pkey_base_id, &pkey_flags,
524 &pinfo, &pem_str, ameth);
525 if (pkey_flags & ASN1_PKEY_ALIAS) {
526 BIO_printf(bio_out, "Name: %s\n", OBJ_nid2ln(pkey_id));
527 BIO_printf(bio_out, "\tAlias for: %s\n",
528 OBJ_nid2ln(pkey_base_id));
530 BIO_printf(bio_out, "Name: %s\n", pinfo);
531 BIO_printf(bio_out, "\tType: %s Algorithm\n",
532 pkey_flags & ASN1_PKEY_DYNAMIC ?
533 "External" : "Builtin");
534 BIO_printf(bio_out, "\tOID: %s\n", OBJ_nid2ln(pkey_id));
537 BIO_printf(bio_out, "\tPEM string: %s\n", pem_str);
543 static int function_cmp(const FUNCTION * a, const FUNCTION * b)
545 return strncmp(a->name, b->name, 8);
548 static unsigned long function_hash(const FUNCTION * a)
550 return OPENSSL_LH_strhash(a->name);
553 static int SortFnByName(const void *_f1, const void *_f2)
555 const FUNCTION *f1 = _f1;
556 const FUNCTION *f2 = _f2;
558 if (f1->type != f2->type)
559 return f1->type - f2->type;
560 return strcmp(f1->name, f2->name);
563 static void list_disabled(void)
565 BIO_puts(bio_out, "Disabled algorithms:\n");
566 #ifdef OPENSSL_NO_ARIA
567 BIO_puts(bio_out, "ARIA\n");
570 BIO_puts(bio_out, "BF\n");
572 #ifdef OPENSSL_NO_BLAKE2
573 BIO_puts(bio_out, "BLAKE2\n");
575 #ifdef OPENSSL_NO_CAMELLIA
576 BIO_puts(bio_out, "CAMELLIA\n");
578 #ifdef OPENSSL_NO_CAST
579 BIO_puts(bio_out, "CAST\n");
581 #ifdef OPENSSL_NO_CMAC
582 BIO_puts(bio_out, "CMAC\n");
584 #ifdef OPENSSL_NO_CMS
585 BIO_puts(bio_out, "CMS\n");
587 #ifdef OPENSSL_NO_COMP
588 BIO_puts(bio_out, "COMP\n");
590 #ifdef OPENSSL_NO_DES
591 BIO_puts(bio_out, "DES\n");
593 #ifdef OPENSSL_NO_DGRAM
594 BIO_puts(bio_out, "DGRAM\n");
597 BIO_puts(bio_out, "DH\n");
599 #ifdef OPENSSL_NO_DSA
600 BIO_puts(bio_out, "DSA\n");
602 #if defined(OPENSSL_NO_DTLS)
603 BIO_puts(bio_out, "DTLS\n");
605 #if defined(OPENSSL_NO_DTLS1)
606 BIO_puts(bio_out, "DTLS1\n");
608 #if defined(OPENSSL_NO_DTLS1_2)
609 BIO_puts(bio_out, "DTLS1_2\n");
612 BIO_puts(bio_out, "EC\n");
614 #ifdef OPENSSL_NO_EC2M
615 BIO_puts(bio_out, "EC2M\n");
617 #ifdef OPENSSL_NO_ENGINE
618 BIO_puts(bio_out, "ENGINE\n");
620 #ifdef OPENSSL_NO_GOST
621 BIO_puts(bio_out, "GOST\n");
623 #ifdef OPENSSL_NO_HEARTBEATS
624 BIO_puts(bio_out, "HEARTBEATS\n");
626 #ifdef OPENSSL_NO_IDEA
627 BIO_puts(bio_out, "IDEA\n");
629 #ifdef OPENSSL_NO_MD2
630 BIO_puts(bio_out, "MD2\n");
632 #ifdef OPENSSL_NO_MD4
633 BIO_puts(bio_out, "MD4\n");
635 #ifdef OPENSSL_NO_MD5
636 BIO_puts(bio_out, "MD5\n");
638 #ifdef OPENSSL_NO_MDC2
639 BIO_puts(bio_out, "MDC2\n");
641 #ifdef OPENSSL_NO_OCB
642 BIO_puts(bio_out, "OCB\n");
644 #ifdef OPENSSL_NO_OCSP
645 BIO_puts(bio_out, "OCSP\n");
647 #ifdef OPENSSL_NO_PSK
648 BIO_puts(bio_out, "PSK\n");
650 #ifdef OPENSSL_NO_RC2
651 BIO_puts(bio_out, "RC2\n");
653 #ifdef OPENSSL_NO_RC4
654 BIO_puts(bio_out, "RC4\n");
656 #ifdef OPENSSL_NO_RC5
657 BIO_puts(bio_out, "RC5\n");
659 #ifdef OPENSSL_NO_RMD160
660 BIO_puts(bio_out, "RMD160\n");
662 #ifdef OPENSSL_NO_RSA
663 BIO_puts(bio_out, "RSA\n");
665 #ifdef OPENSSL_NO_SCRYPT
666 BIO_puts(bio_out, "SCRYPT\n");
668 #ifdef OPENSSL_NO_SCTP
669 BIO_puts(bio_out, "SCTP\n");
671 #ifdef OPENSSL_NO_SEED
672 BIO_puts(bio_out, "SEED\n");
674 #ifdef OPENSSL_NO_SOCK
675 BIO_puts(bio_out, "SOCK\n");
677 #ifdef OPENSSL_NO_SRP
678 BIO_puts(bio_out, "SRP\n");
680 #ifdef OPENSSL_NO_SRTP
681 BIO_puts(bio_out, "SRTP\n");
683 #ifdef OPENSSL_NO_SSL3
684 BIO_puts(bio_out, "SSL3\n");
686 #ifdef OPENSSL_NO_TLS1
687 BIO_puts(bio_out, "TLS1\n");
689 #ifdef OPENSSL_NO_TLS1_1
690 BIO_puts(bio_out, "TLS1_1\n");
692 #ifdef OPENSSL_NO_TLS1_2
693 BIO_puts(bio_out, "TLS1_2\n");
695 #ifdef OPENSSL_NO_WHIRLPOOL
696 BIO_puts(bio_out, "WHIRLPOOL\n");
699 BIO_puts(bio_out, "ZLIB\n");
703 static LHASH_OF(FUNCTION) *prog_init(void)
705 LHASH_OF(FUNCTION) *ret;
709 /* Sort alphabetically within category. For nicer help displays. */
710 for (i = 0, f = functions; f->name != NULL; ++f, ++i) ;
711 qsort(functions, i, sizeof(*functions), SortFnByName);
713 if ((ret = lh_FUNCTION_new(function_hash, function_cmp)) == NULL)
716 for (f = functions; f->name != NULL; f++)
717 (void)lh_FUNCTION_insert(ret, f);