apps: document the deprecation of the -engine option
authorPauli <paul.dale@oracle.com>
Thu, 25 Jun 2020 01:27:51 +0000 (11:27 +1000)
committerRichard Levitte <levitte@openssl.org>
Thu, 16 Jul 2020 07:12:27 +0000 (09:12 +0200)
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12226)

34 files changed:
doc/man1/openssl-ca.pod.in
doc/man1/openssl-cmp.pod.in
doc/man1/openssl-cms.pod.in
doc/man1/openssl-dgst.pod.in
doc/man1/openssl-dhparam.pod.in
doc/man1/openssl-dsa.pod.in
doc/man1/openssl-dsaparam.pod.in
doc/man1/openssl-ec.pod.in
doc/man1/openssl-ecparam.pod.in
doc/man1/openssl-enc.pod.in
doc/man1/openssl-gendsa.pod.in
doc/man1/openssl-genpkey.pod.in
doc/man1/openssl-list.pod.in
doc/man1/openssl-pkcs12.pod.in
doc/man1/openssl-pkcs7.pod.in
doc/man1/openssl-pkcs8.pod.in
doc/man1/openssl-pkey.pod.in
doc/man1/openssl-pkeyparam.pod.in
doc/man1/openssl-pkeyutl.pod.in
doc/man1/openssl-rand.pod.in
doc/man1/openssl-req.pod.in
doc/man1/openssl-rsa.pod.in
doc/man1/openssl-rsautl.pod.in
doc/man1/openssl-s_client.pod.in
doc/man1/openssl-s_server.pod.in
doc/man1/openssl-smime.pod.in
doc/man1/openssl-speed.pod.in
doc/man1/openssl-spkac.pod.in
doc/man1/openssl-srp.pod.in
doc/man1/openssl-storeutl.pod.in
doc/man1/openssl-ts.pod.in
doc/man1/openssl-verify.pod.in
doc/man1/openssl-x509.pod.in
doc/perlvars.pm

index 519f5f4eed2a6055dddb18dfbc9c7f20c13141ee..5f7dc2d16fc51e5adf178af866ba4eeb45913ffb 100644 (file)
@@ -794,6 +794,8 @@ The B<-certform> option has become obsolete in OpenSSL 3.0.0 and has no effect.
 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 and have no effect.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 SEE ALSO
 
 L<openssl(1)>,
index b148afb2dca7763a4444a841f65e382fa4efeace..6ed11f442f13aaef84569246f02150a7264a530e 100644 (file)
@@ -71,7 +71,7 @@ B<openssl> B<cmp>
 [B<-keyform> I<PEM|DER|P12|ENGINE>]
 [B<-certsform> I<PEM|DER|P12>]
 [B<-otherpass> I<arg>]
-[B<-engine> I<id>]
+{- $OpenSSL::safe::opt_engine_synopsis -}
 {- $OpenSSL::safe::opt_provider_synopsis -}
 
 [B<-tls_used>]
@@ -698,6 +698,7 @@ If not given here, the password will be prompted for if needed.
 
 For more information about the format of B<arg> see the
 B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
+{- output_off() if $disabled{"deprecated-3.0"}; "" -}
 
 =item B<-engine> I<id>
 
@@ -714,6 +715,7 @@ the engine.
 as supported, e.g., by libp11:
 C<-key engine:pkcs11:object=my-private-key;type=private;pin-value=1234>
 
+{- output_on() if $disabled{"deprecated-3.0"}; "" -}
 {- $OpenSSL::safe::opt_provider_item -}
 
 =back
index b4c57d37fffc2f7753701ba94e18884ccf0f456f..6ee411d550a439050050be73dd560be508436cd0 100644 (file)
@@ -781,6 +781,8 @@ and have no effect.
 
 The B<-nameopt> option was added in OpenSSL 3.0.0.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
index 22c07a5a7f2bbe6569ea2ab1d8d8b16a613fafc8..6a5bb28a69b48a0d6fe626a3e81ff93ea6f7a7dd 100644 (file)
@@ -30,7 +30,9 @@ B<openssl> B<dgst>|I<digest>
 [B<-macopt> I<nm>:I<v>]
 [B<-fips-fingerprint>]
 {- $OpenSSL::safe::opt_engine_synopsis -}
-[B<-engine_impl> I<id>]
+{- output_off() if $disabled{"deprecated-3.0"}; ""
+-}[B<-engine_impl> I<id>]{-
+  output_on() if $disabled{"deprecated-3.0"}; "" -}
 {- $OpenSSL::safe::opt_r_synopsis -}
 {- $OpenSSL::safe::opt_provider_synopsis -}
 [I<file> ...]
@@ -178,6 +180,7 @@ Compute HMAC using a specific key for certain OpenSSL-FIPS operations.
 {- $OpenSSL::safe::opt_r_item -}
 
 {- $OpenSSL::safe::opt_engine_item -}
+{- output_off() if $disabled{"deprecated-3.0"}; "" -}
 The engine is not used for digests unless the B<-engine_impl> option is
 used or it is configured to do so, see L<config(5)/Engine Configuration Module>.
 
@@ -186,6 +189,7 @@ used or it is configured to do so, see L<config(5)/Engine Configuration Module>.
 When used with the B<-engine> option, it specifies to also use
 engine I<id> for digest operations.
 
+{- output_on() if $disabled{"deprecated-3.0"}; "" -}
 {- $OpenSSL::safe::opt_provider_item -}
 
 =item I<file> ...
@@ -251,6 +255,8 @@ The FIPS-related options were removed in OpenSSL 1.1.0.
 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 and have no effect.
 
+The B<-engine> and B<-engine_impl> options were deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 91883fb8409f445e55392ca6b3ac573cd728eb49..d6fcb59751f6c53d9c535fdf3572c2c4f9948033 100644 (file)
@@ -135,7 +135,7 @@ L<openssl-dsaparam(1)>
 
 =head1 HISTORY
 
-The B<-dsaparam> option was deprecated in OpenSSL 3.0.
+The B<-dsaparam> and B<-engine> options were deprecated in OpenSSL 3.0.
 
 =head1 COPYRIGHT
 
index 2db04078217d18b059315ee5db58b1cfccfe4cee..9ab1b3818ac832d8d1824172a3d2632df18d3c0a 100644 (file)
@@ -159,6 +159,10 @@ L<openssl-gendsa(1)>,
 L<openssl-rsa(1)>,
 L<openssl-genrsa(1)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 27bd6517e193ea5e8a9ff21c3e738441fe7ba2d3..0e6e6cb6de2474ca65822caa21cee4ca255669a2 100644 (file)
@@ -104,6 +104,10 @@ L<openssl-dsa(1)>,
 L<openssl-genrsa(1)>,
 L<openssl-rsa(1)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index c1e92ef51eadb043582a8a0e0c6304df57e0816e..9a12f40f80601be31cbe910c477a10139e056f85 100644 (file)
@@ -186,6 +186,10 @@ L<openssl-ecparam(1)>,
 L<openssl-dsa(1)>,
 L<openssl-rsa(1)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2003-2020 The OpenSSL Project Authors. All Rights Reserved.
index ff4d97ea5da849e8b76252d1c025b090e8c36afd..9c9b098270b53e2e3a6bdb18f4fd7cc2a597ee75 100644 (file)
@@ -168,6 +168,10 @@ L<openssl-genpkey(1)>,
 L<openssl-ec(1)>,
 L<openssl-dsaparam(1)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2003-2020 The OpenSSL Project Authors. All Rights Reserved.
index dcbeb8877b1309338e4f4aa76188da5e4785b8d6..954b17e7781259f97b9214154c94b5529f647d24 100644 (file)
@@ -426,7 +426,7 @@ The default digest was changed from MD5 to SHA256 in OpenSSL 1.1.0.
 
 The B<-list> option was added in OpenSSL 1.1.1e.
 
-The B<-ciphers> option was deprecated in OpenSSL 3.0.
+The B<-ciphers> and B<-engine> options were deprecated in OpenSSL 3.0.
 
 =head1 COPYRIGHT
 
index aca9bb516578dc5904531bbae421ab9b0d95c6c0..cba85f41fa67ff8390a4d36800bffc08533e7cef 100644 (file)
@@ -92,6 +92,10 @@ L<openssl-dsa(1)>,
 L<openssl-genrsa(1)>,
 L<openssl-rsa(1)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index d38c1422b2d99b56c9506838b7ee679dc650d18e..4334d0c3c1161f5a997c1745147e6d438d68f525 100644 (file)
@@ -359,6 +359,8 @@ were added in OpenSSL 1.0.2.
 The ability to generate X25519 keys was added in OpenSSL 1.1.0.
 The ability to generate X448, ED25519 and ED448 keys was added in OpenSSL 1.1.1.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
index 4cceb2ba0df4f6d81c9c05af3e03edce53459cf0..527e96a08418228fc6daad48ed96b3584951b832 100644 (file)
@@ -21,10 +21,9 @@ B<openssl list>
 [B<-cipher-algorithms>]
 [B<-public-key-algorithms>]
 [B<-public-key-methods>]
-
-{- output_off() if $disabled{"deprecated-3.0"}; ""
--}[B<-engines>]{-
-  output_on() if $disabled{"deprecated-3.0"}; "" -}
+{- output_off() if $disabled{"deprecated-3.0"}; "" -}
+[B<-engines>]
+{- output_on() if $disabled{"deprecated-3.0"}; "" -}
 [B<-disabled>]
 [B<-objects>]
 [B<-options> I<command>]
@@ -95,15 +94,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.
-{- if (!$disabled{"deprecated-3.0"}) {
-    "\n"
-  . "=item B<-engines>\n"
-  . "\n"
-  . "This option is deprecated.\n"
-  . "\n"
-  . "Display a list of loaded engines.\n"
-  }
--}
+{- output_off() if $disabled{"deprecated-3.0"}; "" -}
+
+=item B<-engines>
+
+This option is deprecated.
+
+Display a list of loaded engines.
+
+{- output_on() if $disabled{"deprecated-3.0"}; "" -}
 =item B<-disabled>
 
 Display a list of disabled features, those that were compiled out
index 7d0629b37612ae2c47fd60b2cd83c18882570cc4..8c819c56f8624ab66465d49386e7d810bd8c3bcf 100644 (file)
@@ -365,6 +365,10 @@ L<openssl(1)>,
 L<openssl-pkcs8(1)>,
 L<ossl_store-file(7)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 6a05dd4149c1302a837d018ff6314e0085a7465a..fb6b9b4ebc107208012377c50b40453df40038f6 100644 (file)
@@ -97,6 +97,10 @@ Output all certificates in a file:
 L<openssl(1)>,
 L<openssl-crl2pkcs7(1)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 719e3d9168963f5161efb6fe8a401e1bd1a8d17f..6955b441be8d2afc3acc9d7ee3521996ab3dac7c 100644 (file)
@@ -273,6 +273,8 @@ L<openssl-gendsa(1)>
 
 The B<-iter> option was added in OpenSSL 1.1.0.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index de1bef954cb1e61537315e7b831b228be641aa59..1fe94c8efc73bf8495bf551742c73a26e519ee9f 100644 (file)
@@ -197,6 +197,10 @@ L<openssl-dsa(1)>,
 L<openssl-genrsa(1)>,
 L<openssl-gendsa(1)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
index c5f949cfd1b8c99ea5c2e9c7cc747472b07cbb8b..3e7f60a6b76d1f6b8beef492f8e428f24a1cc98c 100644 (file)
@@ -85,6 +85,10 @@ L<openssl-dsa(1)>,
 L<openssl-genrsa(1)>,
 L<openssl-gendsa(1)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
index 2bcbb54c5796756040931b5a1a5b22b16684aa0e..378cfccad624fa298e70d5390703309386dd8c23 100644 (file)
@@ -409,6 +409,8 @@ L<EVP_PKEY_CTX_set_tls1_prf_md(3)>,
 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 and have no effect.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
index 7299f5c65322a5e677249464104239cad63d13d1..67696ee4139b2809721ebc7a224d1f6f01c80856 100644 (file)
@@ -65,6 +65,10 @@ L<RAND_bytes(3)>,
 L<RAND(7)>,
 L<RAND_DRBG(7)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 25295d02fcc4cf431b4f586f403b0f6bd660be80..07354453be00988ebc95a08e4e68c34a819f02fa 100644 (file)
@@ -695,6 +695,8 @@ The B<-section> option was added in OpenSSL 3.0.0.
 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 and have no effect.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index b2477b2b2cd6b9143e07772ef82549b05c943fea..4f9c41d66888871974296310c88a7eb237832581 100644 (file)
@@ -187,6 +187,10 @@ L<openssl-dsa(1)>,
 L<openssl-genrsa(1)>,
 L<openssl-gendsa(1)>
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 5383fe21160529216defc9532036335067c5b807..477e4a1ece569993d58753dca1c5a861690311b6 100644 (file)
@@ -241,6 +241,8 @@ This command was deprecated in OpenSSL 3.0.
 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 and have no effect.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index e8f73cdb99d9ad7f4bc13be94f84d29382310326..78f4cc679c59c00c7d78acd68b69fb77dcd203e8 100644 (file)
@@ -910,6 +910,8 @@ The B<-certform> option has become obsolete in OpenSSL 3.0.0 and has no effect.
 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 and have no effect.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 07cde67cdef03db49501e53bff1687bbb1850c49..47515af42a656a1102d87b954f1a6bfe512da8cc 100644 (file)
@@ -840,6 +840,8 @@ have become obsolete in OpenSSL 3.0.0 and have no effect.
 The B<-certform> and B<-dcertform> options have become obsolete in OpenSSL 3.0.0
 and have no effect.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 4dce01a46e8aad1cc3f5053f397dc5a8b07ff676..b15be731c02b2a5e202987007f8213bc1d99b8f0 100644 (file)
@@ -483,6 +483,8 @@ The -no_alt_chains option was added in OpenSSL 1.1.0.
 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 and have no effect.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index b3e2a80769cb0e92ff6a108d02140d1087a0b3ea..cbcc776f14d5469f7401c3183fac1af0004a1143 100644 (file)
@@ -113,6 +113,10 @@ pre-compiled grand selection is tested.
 
 =back
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index ca7d097d85299241fa38ba34f72e806c1f262fda..7a95dd6ff3f2295e7d464834251a5f008fdd6a0a 100644 (file)
@@ -154,6 +154,8 @@ L<openssl-ca(1)>
 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
 and have no effect.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 5f4a36c60abd877a18a89fd15ec67075df5933f3..e2b04fe91e53e4c591de3a983c6285b21059dc70 100644 (file)
@@ -81,6 +81,10 @@ see L<openssl(1)/Pass Phrase Options>.
 
 =back
 
+=head1 HISTORY
+
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.
index 70e9ca6566b7b143012dae852a30f6412e6e327a..2c92f825a0935966ff6a767934a04e5713553d29 100644 (file)
@@ -123,6 +123,8 @@ L<openssl(1)>
 
 This command was added in OpenSSL 1.1.1.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
index e7bc607a1f48ef089eb5594d562ab61e2e176a25..7a1ed418ceca0d1bdba542094e80affd47f29782 100644 (file)
@@ -626,6 +626,8 @@ seeding mechanism. The new seeding mechanism makes it unnecessary to
 define a RANDFILE for saving and restoring randomness. This option is
 retained mainly for compatibility reasons.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 SEE ALSO
 
 L<openssl(1)>,
index bccaa2642f2f67c612d1e9992685b127b8588197..ff4d88f577ca45767b3523691698d1df357aa019 100644 (file)
@@ -153,6 +153,8 @@ L<ossl_store-file(7)>
 
 The B<-show_chain> option was added in OpenSSL 1.1.0.
 
+The B<-engine option> was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 918c91b34b6cb329565ef9d793b5914eca4984c6..33e24ac6e9420bb7c9c05d8aa6a5ffe3dc4427b1 100644 (file)
@@ -835,6 +835,8 @@ have become obsolete in OpenSSL 3.0.0 and have no effect.
 
 The B<-CAform> option has become obsolete in OpenSSL 3.0.0 and has no effect.
 
+The B<-engine> option was deprecated in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
index 6d77ce77cb10fc4d47d48cf494928b4735491895..98c348859f95d92ed16ab42cc3a6bf18c50c1f75 100644 (file)
@@ -8,6 +8,8 @@
 # Set some Perl variables for use by util/dofile.pl when processing
 # POD files (mainly man1).
 
+use configdata;
+
 # Verify options
 $OpenSSL::safe::opt_v_synopsis = ""
 . "[B<-allow_proxy_certs>]\n"
@@ -100,12 +102,17 @@ $OpenSSL::safe::opt_provider_item = ""
 . "See L<openssl(1)/Provider Options>.";
 
 # Engine option
-$OpenSSL::safe::opt_engine_synopsis = ""
-. "[B<-engine> I<id>]";
-$OpenSSL::safe::opt_engine_item = ""
-. "=item B<-engine> I<id>\n"
-. "\n"
-. "See L<openssl(1)/Engine Options>.";
+$OpenSSL::safe::opt_engine_synopsis = "";
+$OpenSSL::safe::opt_engine_item = "";
+if (!$disabled{"deprecated-3.0"}) {
+  $OpenSSL::safe::opt_engine_synopsis = ""
+  . "[B<-engine> I<id>]";
+  $OpenSSL::safe::opt_engine_item = ""
+  . "=item B<-engine> I<id>\n"
+  . "\n"
+  . "See L<openssl(1)/Engine Options>.\n"
+  . "This option is deprecated.";
+}
 
 # Trusted certs options
 $OpenSSL::safe::opt_trust_synopsis = ""