pkey: update command line tool examples in light of deprecations.

[openssl.git] / doc / man1 / openssl-rsautl.pod.in

diff --git a/doc/man1/openssl-rsautl.pod.in b/doc/man1/openssl-rsautl.pod.in
index 374b87a40609c9d484bc5f3d0defcd8a265cba21..1a3a1516e340b92e46fe92c1a296879959758606 100644 (file)
--- a/doc/man1/openssl-rsautl.pod.in
+++ b/doc/man1/openssl-rsautl.pod.in
@@ -1,9 +1,5 @@
 =pod
 =pod

-
-=begin comment
-{- join("\n", @autowarntext) -}
-
-=end comment
+{- OpenSSL::safe::output_do_not_edit_headers(); -}

 
 =head1 NAME
 
 
 =head1 NAME
 


@@ -14,6 +10,8 @@ openssl-rsautl - RSA utility
 B<openssl> B<rsautl>
 [B<-help>]
 [B<-in> I<file>]
 B<openssl> B<rsautl>
 [B<-help>]
 [B<-in> I<file>]

+[B<-passin> I<arg>]
+[B<-rev>]

 [B<-out> I<file>]
 [B<-inkey> I<file>]
 [B<-keyform> B<DER>|B<PEM>|B<ENGINE>]
 [B<-out> I<file>]
 [B<-inkey> I<file>]
 [B<-keyform> B<DER>|B<PEM>|B<ENGINE>]


@@ -24,16 +22,25 @@ B<openssl> B<rsautl>
 [B<-encrypt>]
 [B<-decrypt>]
 [B<-pkcs>]
 [B<-encrypt>]
 [B<-decrypt>]
 [B<-pkcs>]

+[B<-x931>]
+[B<-oaep>]
+[B<-ssl>]
+[B<-raw>]
+[B<-pkcs>]

 [B<-ssl>]
 [B<-raw>]
 [B<-hexdump>]
 [B<-asn1parse>]
 [B<-ssl>]
 [B<-raw>]
 [B<-hexdump>]
 [B<-asn1parse>]

+{- $OpenSSL::safe::opt_engine_synopsis -}

 {- $OpenSSL::safe::opt_r_synopsis -}
 
 =for openssl ifdef engine
 
 =head1 DESCRIPTION
 
 {- $OpenSSL::safe::opt_r_synopsis -}
 
 =for openssl ifdef engine
 
 =head1 DESCRIPTION
 

+This command has been deprecated.
+The L<openssl-pkeyutl(1)> command should be used instead.
+

 This command can be used to sign, verify, encrypt and decrypt
 data using the RSA algorithm.
 
 This command can be used to sign, verify, encrypt and decrypt
 data using the RSA algorithm.
 


@@ -50,6 +57,15 @@ Print out a usage message.
 This specifies the input filename to read data from or standard input
 if this option is not specified.
 
 This specifies the input filename to read data from or standard input
 if this option is not specified.
 

+=item B<-passin> I<arg>
+
+The passphrase used in the output file.
+See see L<openssl(1)/Pass Phrase Options>.
+
+=item B<-rev>
+
+Reverse the order of the input.
+

 =item B<-out> I<filename>
 
 Specifies the output filename to write to or standard output by
 =item B<-out> I<filename>
 
 Specifies the output filename to write to or standard output by


@@ -89,9 +105,10 @@ Encrypt the input data using an RSA public key.
 
 Decrypt the input data using an RSA private key.
 
 
 Decrypt the input data using an RSA private key.
 

-=item B<-pkcs>, B<-oaep>, B<-ssl>, B<-raw>
+=item B<-pkcs>, B<-oaep>, B<-x931> B<-ssl>, B<-raw>

 
 The padding to use: PKCS#1 v1.5 (the default), PKCS#1 OAEP,
 
 The padding to use: PKCS#1 v1.5 (the default), PKCS#1 OAEP,

+ANSI X9.31,

 special padding used in SSL v2 backwards compatible handshakes,
 or no padding, respectively.
 For signatures, only B<-pkcs> and B<-raw> can be used.
 special padding used in SSL v2 backwards compatible handshakes,
 or no padding, respectively.
 For signatures, only B<-pkcs> and B<-raw> can be used.


@@ -105,6 +122,8 @@ Hex dump the output data.
 Parse the ASN.1 output data, this is useful when combined with the
 B<-verify> option.
 
 Parse the ASN.1 output data, this is useful when combined with the
 B<-verify> option.
 

+{- $OpenSSL::safe::opt_engine_item -}
+

 {- $OpenSSL::safe::opt_r_item -}
 
 =back
 {- $OpenSSL::safe::opt_r_item -}
 
 =back


@@ -116,6 +135,9 @@ used to sign or verify small pieces of data.
 
 =head1 EXAMPLES
 
 
 =head1 EXAMPLES
 

+Examples equivalent to these can be found in the documentation for the
+non-deprecated L<openssl-pkeyutl(1)> command.
+

 Sign some data using a private key:
 
  openssl rsautl -sign -in file -inkey key.pem -out sig
 Sign some data using a private key:
 
  openssl rsautl -sign -in file -inkey key.pem -out sig


@@ -203,10 +225,15 @@ which it can be seen agrees with the recovered value above.
 =head1 SEE ALSO
 
 L<openssl(1)>,
 =head1 SEE ALSO
 
 L<openssl(1)>,

+L<openssl-pkeyutl(1)>,

 L<openssl-dgst(1)>,
 L<openssl-rsa(1)>,
 L<openssl-genrsa(1)>
 
 L<openssl-dgst(1)>,
 L<openssl-rsa(1)>,
 L<openssl-genrsa(1)>
 

+=head1 HISTORY
+
+This command was deprecated in OpenSSL 3.0.
+

 =head1 COPYRIGHT
 
 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 =head1 COPYRIGHT
 
 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.