summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPauli <paul.dale@oracle.com>2020-06-25 10:40:20 +1000
committerRichard Levitte <levitte@openssl.org>2020-07-16 09:12:26 +0200
commit0a684b09d8911a5849744f2de90e81ae07bd59fb (patch)
tree8fcd75a6e7b9ca1dde9607bcc09e282d05ed1050
parent910b71cf47266233fcb0a46d3e742e1a0834069f (diff)
apps/list: deprecate engine support
Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12226)
-rw-r--r--apps/list.c23
-rw-r--r--doc/man1/openssl-list.pod.in23
2 files changed, 35 insertions, 11 deletions
diff --git a/apps/list.c b/apps/list.c
index ed93186254..52641e41cb 100644
--- a/apps/list.c
+++ b/apps/list.c
@@ -522,9 +522,10 @@ static void list_pkey_meth(void)
}
}
+#ifndef OPENSSL_NO_DEPRECATED_3_0
static void list_engines(void)
{
-#ifndef OPENSSL_NO_ENGINE
+# ifndef OPENSSL_NO_ENGINE
ENGINE *e;
BIO_puts(bio_out, "Engines:\n");
@@ -533,10 +534,11 @@ static void list_engines(void)
BIO_printf(bio_out, "%s\n", ENGINE_get_id(e));
e = ENGINE_get_next(e);
}
-#else
+# else
BIO_puts(bio_out, "Engine support is disabled.\n");
-#endif
+# endif
}
+#endif
static void list_disabled(void)
{
@@ -592,7 +594,7 @@ static void list_disabled(void)
#ifdef OPENSSL_NO_EC2M
BIO_puts(bio_out, "EC2M\n");
#endif
-#ifdef OPENSSL_NO_ENGINE
+#if defined(OPENSSL_NO_ENGINE) && !defined(OPENSSL_NO_DEPRECATED_3_0)
BIO_puts(bio_out, "ENGINE\n");
#endif
#ifdef OPENSSL_NO_GOST
@@ -689,8 +691,11 @@ typedef enum HELPLIST_CHOICE {
OPT_ERR = -1, OPT_EOF = 0, OPT_HELP, OPT_ONE, OPT_VERBOSE,
OPT_COMMANDS, OPT_DIGEST_COMMANDS, OPT_MAC_ALGORITHMS, OPT_OPTIONS,
OPT_DIGEST_ALGORITHMS, OPT_CIPHER_COMMANDS, OPT_CIPHER_ALGORITHMS,
- OPT_PK_ALGORITHMS, OPT_PK_METHOD, OPT_ENGINES, OPT_DISABLED,
+ OPT_PK_ALGORITHMS, OPT_PK_METHOD, OPT_DISABLED,
OPT_KDF_ALGORITHMS, OPT_RANDOM_GENERATORS, OPT_MISSING_HELP, OPT_OBJECTS,
+#ifndef OPENSSL_NO_DEPRECATED_3_0
+ OPT_ENGINES,
+#endif
OPT_PROV_ENUM
} HELPLIST_CHOICE;
@@ -721,8 +726,10 @@ const OPTIONS list_options[] = {
"List of public key algorithms"},
{"public-key-methods", OPT_PK_METHOD, '-',
"List of public key methods"},
+#ifndef OPENSSL_NO_DEPRECATED_3_0
{"engines", OPT_ENGINES, '-',
"List of loaded engines"},
+#endif
{"disabled", OPT_DISABLED, '-',
"List of disabled features"},
{"missing-help", OPT_MISSING_HELP, '-',
@@ -752,7 +759,9 @@ int list_main(int argc, char **argv)
unsigned int cipher_algorithms:1;
unsigned int pk_algorithms:1;
unsigned int pk_method:1;
+#ifndef OPENSSL_NO_DEPRECATED_3_0
unsigned int engines:1;
+#endif
unsigned int disabled:1;
unsigned int missing_help:1;
unsigned int objects:1;
@@ -805,9 +814,11 @@ opthelp:
case OPT_PK_METHOD:
todo.pk_method = 1;
break;
+#ifndef OPENSSL_NO_DEPRECATED_3_0
case OPT_ENGINES:
todo.engines = 1;
break;
+#endif
case OPT_DISABLED:
todo.disabled = 1;
break;
@@ -855,8 +866,10 @@ opthelp:
list_pkey();
if (todo.pk_method)
list_pkey_meth();
+#ifndef OPENSSL_NO_DEPRECATED_3_0
if (todo.engines)
list_engines();
+#endif
if (todo.disabled)
list_disabled();
if (todo.missing_help)
diff --git a/doc/man1/openssl-list.pod.in b/doc/man1/openssl-list.pod.in
index 1eb62d3feb..4cceb2ba0d 100644
--- a/doc/man1/openssl-list.pod.in
+++ b/doc/man1/openssl-list.pod.in
@@ -21,7 +21,10 @@ B<openssl list>
[B<-cipher-algorithms>]
[B<-public-key-algorithms>]
[B<-public-key-methods>]
-[B<-engines>]
+
+{- output_off() if $disabled{"deprecated-3.0"}; ""
+-}[B<-engines>]{-
+ output_on() if $disabled{"deprecated-3.0"}; "" -}
[B<-disabled>]
[B<-objects>]
[B<-options> I<command>]
@@ -92,11 +95,15 @@ a block of multiple lines, all but the first are indented.
=item B<-public-key-methods>
Display a list of public key method OIDs.
-
-=item B<-engines>
-
-Display a list of loaded engines.
-
+{- if (!$disabled{"deprecated-3.0"}) {
+ "\n"
+ . "=item B<-engines>\n"
+ . "\n"
+ . "This option is deprecated.\n"
+ . "\n"
+ . "Display a list of loaded engines.\n"
+ }
+-}
=item B<-disabled>
Display a list of disabled features, those that were compiled out
@@ -146,6 +153,10 @@ In both cases, C<bar> is the name of the provider.
=back
+=head1 HISTORY
+
+The B<-engines> option was deprecated in OpenSSL 3.0.
+
=head1 COPYRIGHT
Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.