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
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
30 #define INCLUDE_FUNCTION_TABLE
33 /* Structure to hold the number of columns to be displayed and the
34 * field width used to display them.
41 /* Special sentinel to exit the program. */
42 #define EXIT_THE_PROGRAM (-1)
45 * The LHASH callbacks ("hash" & "cmp") have been replaced by functions with
46 * the base prototypes (we cast each variable inside the function to the
47 * required type of "FUNCTION*"). This removes the necessity for
48 * macro-generated wrapper functions.
50 static LHASH_OF(FUNCTION
) *prog_init(void);
51 static int do_cmd(LHASH_OF(FUNCTION
) *prog
, int argc
, char *argv
[]);
52 static void list_pkey(void);
53 static void list_pkey_meth(void);
54 static void list_type(FUNC_TYPE ft
, int one
);
55 static void list_disabled(void);
56 char *default_config_file
= NULL
;
62 static void calculate_columns(DISPLAY_COLUMNS
*dc
)
67 for (f
= functions
; f
->name
!= NULL
; ++f
)
68 if (f
->type
== FT_general
|| f
->type
== FT_md
|| f
->type
== FT_cipher
)
69 if ((len
= strlen(f
->name
)) > maxlen
)
72 dc
->width
= maxlen
+ 2;
73 dc
->columns
= (80 - 1) / dc
->width
;
76 static int apps_startup()
79 signal(SIGPIPE
, SIG_IGN
);
82 /* Set non-default library initialisation settings */
83 if (!OPENSSL_init_ssl(OPENSSL_INIT_ENGINE_ALL_BUILTIN
84 | OPENSSL_INIT_LOAD_CONFIG
, NULL
))
92 static void apps_shutdown()
97 static char *make_config_name()
103 if ((t
= getenv("OPENSSL_CONF")) != NULL
)
104 return OPENSSL_strdup(t
);
106 t
= X509_get_default_cert_area();
107 len
= strlen(t
) + 1 + strlen(OPENSSL_CONF
) + 1;
108 p
= app_malloc(len
, "config filename buffer");
110 #ifndef OPENSSL_SYS_VMS
113 strcat(p
, OPENSSL_CONF
);
118 int main(int argc
, char *argv
[])
121 LHASH_OF(FUNCTION
) *prog
= NULL
;
122 char **copied_argv
= NULL
;
127 int first
, n
, i
, ret
= 0;
132 /* Set up some of the environment. */
133 default_config_file
= make_config_name();
134 bio_in
= dup_bio_in(FORMAT_TEXT
);
135 bio_out
= dup_bio_out(FORMAT_TEXT
);
136 bio_err
= dup_bio_err(FORMAT_TEXT
);
138 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
139 copied_argv
= argv
= copy_argv(&argc
, argv
);
140 #elif defined(_WIN32)
142 * Replace argv[] with UTF-8 encoded strings.
144 win32_utf8argv(&argc
, &argv
);
147 p
= getenv("OPENSSL_DEBUG_MEMORY");
148 if (p
!= NULL
&& strcmp(p
, "on") == 0)
149 CRYPTO_set_mem_debug(1);
150 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON
);
152 if (getenv("OPENSSL_FIPS")) {
153 BIO_printf(bio_err
, "FIPS mode not supported.\n");
157 if (!apps_startup()) {
159 "FATAL: Startup failure (dev note: apps_startup() failed)\n");
160 ERR_print_errors(bio_err
);
166 pname
= opt_progname(argv
[0]);
168 /* first check the program name */
170 fp
= lh_FUNCTION_retrieve(prog
, &f
);
173 ret
= fp
->func(argc
, argv
);
177 /* If there is stuff on the command line, run with that. */
181 ret
= do_cmd(prog
, argc
, argv
);
187 /* ok, lets enter interactive mode */
190 /* Read a line, continue reading if line ends with \ */
191 for (p
= buf
, n
= sizeof(buf
), i
= 0, first
= 1; n
> 0; first
= 0) {
192 prompt
= first
? "OpenSSL> " : "> ";
195 fputs(prompt
, stdout
);
197 if (!fgets(p
, n
, stdin
))
204 if (p
[i
- 2] != '\\')
211 extern char *readline(const char *);
212 extern void add_history(const char *cp
);
215 text
= readline(prompt
);
221 if (text
[i
- 1] != '\\') {
222 p
+= strlen(strcpy(p
, text
));
229 p
+= strlen(strcpy(p
, text
));
236 if (!chopup_args(&arg
, buf
)) {
237 BIO_printf(bio_err
, "Can't parse (no memory?)\n");
241 ret
= do_cmd(prog
, arg
.argc
, arg
.argv
);
242 if (ret
== EXIT_THE_PROGRAM
) {
247 BIO_printf(bio_err
, "error in %s\n", arg
.argv
[0]);
248 (void)BIO_flush(bio_out
);
249 (void)BIO_flush(bio_err
);
253 OPENSSL_free(copied_argv
);
254 OPENSSL_free(default_config_file
);
255 lh_FUNCTION_free(prog
);
256 OPENSSL_free(arg
.argv
);
260 BIO_free_all(bio_out
);
262 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
263 if (CRYPTO_mem_leaks(bio_err
) <= 0)
270 static void list_cipher_fn(const EVP_CIPHER
*c
,
271 const char *from
, const char *to
, void *arg
)
274 BIO_printf(arg
, "%s\n", EVP_CIPHER_name(c
));
277 from
= "<undefined>";
280 BIO_printf(arg
, "%s => %s\n", from
, to
);
284 static void list_md_fn(const EVP_MD
*m
,
285 const char *from
, const char *to
, void *arg
)
288 BIO_printf(arg
, "%s\n", EVP_MD_name(m
));
291 from
= "<undefined>";
294 BIO_printf((BIO
*)arg
, "%s => %s\n", from
, to
);
298 static void list_missing_help(void)
303 for (fp
= functions
; fp
->name
!= NULL
; fp
++) {
304 if ((o
= fp
->help
) != NULL
) {
305 /* If there is help, list what flags are not documented. */
306 for ( ; o
->name
!= NULL
; o
++) {
307 if (o
->helpstr
== NULL
)
308 BIO_printf(bio_out
, "%s %s\n", fp
->name
, o
->name
);
310 } else if (fp
->func
!= dgst_main
) {
311 /* If not aliased to the dgst command, */
312 BIO_printf(bio_out
, "%s *\n", fp
->name
);
317 static void list_options_for_command(const char *command
)
322 for (fp
= functions
; fp
->name
!= NULL
; fp
++)
323 if (strcmp(fp
->name
, command
) == 0)
325 if (fp
->name
== NULL
) {
326 BIO_printf(bio_err
, "Invalid command '%s'; type \"help\" for a list.\n",
331 if ((o
= fp
->help
) == NULL
)
334 for ( ; o
->name
!= NULL
; o
++) {
335 if (o
->name
== OPT_HELP_STR
336 || o
->name
== OPT_MORE_STR
337 || o
->name
[0] == '\0')
339 BIO_printf(bio_out
, "%s %c\n", o
->name
, o
->valtype
);
344 /* Unified enum for help and list commands. */
345 typedef enum HELPLIST_CHOICE
{
346 OPT_ERR
= -1, OPT_EOF
= 0, OPT_HELP
, OPT_ONE
,
347 OPT_COMMANDS
, OPT_DIGEST_COMMANDS
, OPT_OPTIONS
,
348 OPT_DIGEST_ALGORITHMS
, OPT_CIPHER_COMMANDS
, OPT_CIPHER_ALGORITHMS
,
349 OPT_PK_ALGORITHMS
, OPT_PK_METHOD
, OPT_DISABLED
, OPT_MISSING_HELP
352 const OPTIONS list_options
[] = {
353 {"help", OPT_HELP
, '-', "Display this summary"},
354 {"1", OPT_ONE
, '-', "List in one column"},
355 {"commands", OPT_COMMANDS
, '-', "List of standard commands"},
356 {"digest-commands", OPT_DIGEST_COMMANDS
, '-',
357 "List of message digest commands"},
358 {"digest-algorithms", OPT_DIGEST_ALGORITHMS
, '-',
359 "List of message digest algorithms"},
360 {"cipher-commands", OPT_CIPHER_COMMANDS
, '-', "List of cipher commands"},
361 {"cipher-algorithms", OPT_CIPHER_ALGORITHMS
, '-',
362 "List of cipher algorithms"},
363 {"public-key-algorithms", OPT_PK_ALGORITHMS
, '-',
364 "List of public key algorithms"},
365 {"public-key-methods", OPT_PK_METHOD
, '-',
366 "List of public key methods"},
367 {"disabled", OPT_DISABLED
, '-',
368 "List of disabled features"},
369 {"missing-help", OPT_MISSING_HELP
, '-',
370 "List missing detailed help strings"},
371 {"options", OPT_OPTIONS
, 's',
372 "List options for specified command"},
376 int list_main(int argc
, char **argv
)
380 int one
= 0, done
= 0;
382 prog
= opt_init(argc
, argv
, list_options
);
383 while ((o
= opt_next()) != OPT_EOF
) {
385 case OPT_EOF
: /* Never hit, but suppresses warning */
388 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
391 opt_help(list_options
);
397 list_type(FT_general
, one
);
399 case OPT_DIGEST_COMMANDS
:
400 list_type(FT_md
, one
);
402 case OPT_DIGEST_ALGORITHMS
:
403 EVP_MD_do_all_sorted(list_md_fn
, bio_out
);
405 case OPT_CIPHER_COMMANDS
:
406 list_type(FT_cipher
, one
);
408 case OPT_CIPHER_ALGORITHMS
:
409 EVP_CIPHER_do_all_sorted(list_cipher_fn
, bio_out
);
411 case OPT_PK_ALGORITHMS
:
420 case OPT_MISSING_HELP
:
424 list_options_for_command(opt_arg());
429 if (opt_num_rest() != 0) {
430 BIO_printf(bio_err
, "Extra arguments given.\n");
440 typedef enum HELP_CHOICE
{
441 OPT_hERR
= -1, OPT_hEOF
= 0, OPT_hHELP
444 const OPTIONS help_options
[] = {
445 {OPT_HELP_STR
, 1, '-', "Usage: help [options]\n"},
446 {OPT_HELP_STR
, 1, '-', " help [command]\n"},
447 {"help", OPT_hHELP
, '-', "Display this summary"},
452 int help_main(int argc
, char **argv
)
461 prog
= opt_init(argc
, argv
, help_options
);
462 while ((o
= opt_next()) != OPT_hEOF
) {
466 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
469 opt_help(help_options
);
474 if (opt_num_rest() == 1) {
477 new_argv
[0] = opt_rest()[0];
478 new_argv
[1] = "--help";
480 return do_cmd(prog_init(), 2, new_argv
);
482 if (opt_num_rest() != 0) {
483 BIO_printf(bio_err
, "Usage: %s\n", prog
);
487 calculate_columns(&dc
);
488 BIO_printf(bio_err
, "Standard commands");
491 for (fp
= functions
; fp
->name
!= NULL
; fp
++) {
493 if (i
++ % dc
.columns
== 0) {
494 BIO_printf(bio_err
, "\n");
497 if (fp
->type
!= tp
) {
500 BIO_printf(bio_err
, "\n");
504 "\nMessage Digest commands (see the `dgst' command for more details)\n");
505 } else if (tp
== FT_cipher
) {
508 "\nCipher commands (see the `enc' command for more details)\n");
511 BIO_printf(bio_err
, "%-*s", dc
.width
, fp
->name
);
513 BIO_printf(bio_err
, "\n\n");
517 static void list_type(FUNC_TYPE ft
, int one
)
524 calculate_columns(&dc
);
526 for (fp
= functions
; fp
->name
!= NULL
; fp
++) {
530 BIO_printf(bio_out
, "%s\n", fp
->name
);
532 if (i
% dc
.columns
== 0 && i
> 0)
533 BIO_printf(bio_out
, "\n");
534 BIO_printf(bio_out
, "%-*s", dc
.width
, fp
->name
);
539 BIO_printf(bio_out
, "\n\n");
542 static int do_cmd(LHASH_OF(FUNCTION
) *prog
, int argc
, char *argv
[])
546 if (argc
<= 0 || argv
[0] == NULL
)
549 fp
= lh_FUNCTION_retrieve(prog
, &f
);
551 if (EVP_get_digestbyname(argv
[0])) {
555 } else if (EVP_get_cipherbyname(argv
[0])) {
562 return fp
->func(argc
, argv
);
564 if ((strncmp(argv
[0], "no-", 3)) == 0) {
566 * User is asking if foo is unsupported, by trying to "run" the
567 * no-foo command. Strange.
569 f
.name
= argv
[0] + 3;
570 if (lh_FUNCTION_retrieve(prog
, &f
) == NULL
) {
571 BIO_printf(bio_out
, "%s\n", argv
[0]);
574 BIO_printf(bio_out
, "%s\n", argv
[0] + 3);
577 if (strcmp(argv
[0], "quit") == 0 || strcmp(argv
[0], "q") == 0 ||
578 strcmp(argv
[0], "exit") == 0 || strcmp(argv
[0], "bye") == 0)
579 /* Special value to mean "exit the program. */
580 return EXIT_THE_PROGRAM
;
582 BIO_printf(bio_err
, "Invalid command '%s'; type \"help\" for a list.\n",
587 static void list_pkey(void)
591 for (i
= 0; i
< EVP_PKEY_asn1_get_count(); i
++) {
592 const EVP_PKEY_ASN1_METHOD
*ameth
;
593 int pkey_id
, pkey_base_id
, pkey_flags
;
594 const char *pinfo
, *pem_str
;
595 ameth
= EVP_PKEY_asn1_get0(i
);
596 EVP_PKEY_asn1_get0_info(&pkey_id
, &pkey_base_id
, &pkey_flags
,
597 &pinfo
, &pem_str
, ameth
);
598 if (pkey_flags
& ASN1_PKEY_ALIAS
) {
599 BIO_printf(bio_out
, "Name: %s\n", OBJ_nid2ln(pkey_id
));
600 BIO_printf(bio_out
, "\tAlias for: %s\n",
601 OBJ_nid2ln(pkey_base_id
));
603 BIO_printf(bio_out
, "Name: %s\n", pinfo
);
604 BIO_printf(bio_out
, "\tType: %s Algorithm\n",
605 pkey_flags
& ASN1_PKEY_DYNAMIC
?
606 "External" : "Builtin");
607 BIO_printf(bio_out
, "\tOID: %s\n", OBJ_nid2ln(pkey_id
));
610 BIO_printf(bio_out
, "\tPEM string: %s\n", pem_str
);
616 static void list_pkey_meth(void)
619 size_t meth_count
= EVP_PKEY_meth_get_count();
621 for (i
= 0; i
< meth_count
; i
++) {
622 const EVP_PKEY_METHOD
*pmeth
= EVP_PKEY_meth_get0(i
);
623 int pkey_id
, pkey_flags
;
625 EVP_PKEY_meth_get0_info(&pkey_id
, &pkey_flags
, pmeth
);
626 BIO_printf(bio_out
, "%s\n", OBJ_nid2ln(pkey_id
));
627 BIO_printf(bio_out
, "\tType: %s Algorithm\n",
628 pkey_flags
& ASN1_PKEY_DYNAMIC
? "External" : "Builtin");
632 static int function_cmp(const FUNCTION
* a
, const FUNCTION
* b
)
634 return strncmp(a
->name
, b
->name
, 8);
637 static unsigned long function_hash(const FUNCTION
* a
)
639 return OPENSSL_LH_strhash(a
->name
);
642 static int SortFnByName(const void *_f1
, const void *_f2
)
644 const FUNCTION
*f1
= _f1
;
645 const FUNCTION
*f2
= _f2
;
647 if (f1
->type
!= f2
->type
)
648 return f1
->type
- f2
->type
;
649 return strcmp(f1
->name
, f2
->name
);
652 static void list_disabled(void)
654 BIO_puts(bio_out
, "Disabled algorithms:\n");
655 #ifdef OPENSSL_NO_ARIA
656 BIO_puts(bio_out
, "ARIA\n");
659 BIO_puts(bio_out
, "BF\n");
661 #ifdef OPENSSL_NO_BLAKE2
662 BIO_puts(bio_out
, "BLAKE2\n");
664 #ifdef OPENSSL_NO_CAMELLIA
665 BIO_puts(bio_out
, "CAMELLIA\n");
667 #ifdef OPENSSL_NO_CAST
668 BIO_puts(bio_out
, "CAST\n");
670 #ifdef OPENSSL_NO_CMAC
671 BIO_puts(bio_out
, "CMAC\n");
673 #ifdef OPENSSL_NO_CMS
674 BIO_puts(bio_out
, "CMS\n");
676 #ifdef OPENSSL_NO_COMP
677 BIO_puts(bio_out
, "COMP\n");
679 #ifdef OPENSSL_NO_DES
680 BIO_puts(bio_out
, "DES\n");
682 #ifdef OPENSSL_NO_DGRAM
683 BIO_puts(bio_out
, "DGRAM\n");
686 BIO_puts(bio_out
, "DH\n");
688 #ifdef OPENSSL_NO_DSA
689 BIO_puts(bio_out
, "DSA\n");
691 #if defined(OPENSSL_NO_DTLS)
692 BIO_puts(bio_out
, "DTLS\n");
694 #if defined(OPENSSL_NO_DTLS1)
695 BIO_puts(bio_out
, "DTLS1\n");
697 #if defined(OPENSSL_NO_DTLS1_2)
698 BIO_puts(bio_out
, "DTLS1_2\n");
701 BIO_puts(bio_out
, "EC\n");
703 #ifdef OPENSSL_NO_EC2M
704 BIO_puts(bio_out
, "EC2M\n");
706 #ifdef OPENSSL_NO_ENGINE
707 BIO_puts(bio_out
, "ENGINE\n");
709 #ifdef OPENSSL_NO_GOST
710 BIO_puts(bio_out
, "GOST\n");
712 #ifdef OPENSSL_NO_HEARTBEATS
713 BIO_puts(bio_out
, "HEARTBEATS\n");
715 #ifdef OPENSSL_NO_IDEA
716 BIO_puts(bio_out
, "IDEA\n");
718 #ifdef OPENSSL_NO_MD2
719 BIO_puts(bio_out
, "MD2\n");
721 #ifdef OPENSSL_NO_MD4
722 BIO_puts(bio_out
, "MD4\n");
724 #ifdef OPENSSL_NO_MD5
725 BIO_puts(bio_out
, "MD5\n");
727 #ifdef OPENSSL_NO_MDC2
728 BIO_puts(bio_out
, "MDC2\n");
730 #ifdef OPENSSL_NO_OCB
731 BIO_puts(bio_out
, "OCB\n");
733 #ifdef OPENSSL_NO_OCSP
734 BIO_puts(bio_out
, "OCSP\n");
736 #ifdef OPENSSL_NO_PSK
737 BIO_puts(bio_out
, "PSK\n");
739 #ifdef OPENSSL_NO_RC2
740 BIO_puts(bio_out
, "RC2\n");
742 #ifdef OPENSSL_NO_RC4
743 BIO_puts(bio_out
, "RC4\n");
745 #ifdef OPENSSL_NO_RC5
746 BIO_puts(bio_out
, "RC5\n");
748 #ifdef OPENSSL_NO_RMD160
749 BIO_puts(bio_out
, "RMD160\n");
751 #ifdef OPENSSL_NO_RSA
752 BIO_puts(bio_out
, "RSA\n");
754 #ifdef OPENSSL_NO_SCRYPT
755 BIO_puts(bio_out
, "SCRYPT\n");
757 #ifdef OPENSSL_NO_SCTP
758 BIO_puts(bio_out
, "SCTP\n");
760 #ifdef OPENSSL_NO_SEED
761 BIO_puts(bio_out
, "SEED\n");
763 #ifdef OPENSSL_NO_SM3
764 BIO_puts(bio_out
, "SM3\n");
766 #ifdef OPENSSL_NO_SM4
767 BIO_puts(bio_out
, "SM4\n");
769 #ifdef OPENSSL_NO_SOCK
770 BIO_puts(bio_out
, "SOCK\n");
772 #ifdef OPENSSL_NO_SRP
773 BIO_puts(bio_out
, "SRP\n");
775 #ifdef OPENSSL_NO_SRTP
776 BIO_puts(bio_out
, "SRTP\n");
778 #ifdef OPENSSL_NO_SSL3
779 BIO_puts(bio_out
, "SSL3\n");
781 #ifdef OPENSSL_NO_TLS1
782 BIO_puts(bio_out
, "TLS1\n");
784 #ifdef OPENSSL_NO_TLS1_1
785 BIO_puts(bio_out
, "TLS1_1\n");
787 #ifdef OPENSSL_NO_TLS1_2
788 BIO_puts(bio_out
, "TLS1_2\n");
790 #ifdef OPENSSL_NO_WHIRLPOOL
791 BIO_puts(bio_out
, "WHIRLPOOL\n");
794 BIO_puts(bio_out
, "ZLIB\n");
798 static LHASH_OF(FUNCTION
) *prog_init(void)
800 static LHASH_OF(FUNCTION
) *ret
= NULL
;
801 static int prog_inited
= 0;
810 /* Sort alphabetically within category. For nicer help displays. */
811 for (i
= 0, f
= functions
; f
->name
!= NULL
; ++f
, ++i
)
813 qsort(functions
, i
, sizeof(*functions
), SortFnByName
);
815 if ((ret
= lh_FUNCTION_new(function_hash
, function_cmp
)) == NULL
)
818 for (f
= functions
; f
->name
!= NULL
; f
++)
819 (void)lh_FUNCTION_insert(ret
, f
);