openssl-pkeyparam.pod.in 2.0 KB
Newer Older
1 2
=pod

R
Rich Salz 已提交
3 4 5 6 7
=begin comment
{- join("\n", @autowarntext) -}

=end comment

8 9
=head1 NAME

10
openssl-pkeyparam - public key algorithm parameter processing command
11 12 13 14

=head1 SYNOPSIS

B<openssl> B<pkeyparam>
15
[B<-help>]
16 17
[B<-in> I<filename>]
[B<-out> I<filename>]
18 19
[B<-text>]
[B<-noout>]
20
[B<-check>]
R
Rich Salz 已提交
21
{- $OpenSSL::safe::opt_engine_synopsis -}
22
{- $OpenSSL::safe::opt_provider_synopsis -}
23

24
=for openssl ifdef engine
R
Rich Salz 已提交
25

26 27
=head1 DESCRIPTION

28
This command processes public key algorithm parameters.
29
They can be checked for correctness and their components printed out.
30

R
Rich Salz 已提交
31
=head1 OPTIONS
32 33 34

=over 4

35 36 37 38
=item B<-help>

Print out a usage message.

39
=item B<-in> I<filename>
40 41 42 43

This specifies the input filename to read parameters from or standard input if
this option is not specified.

44
=item B<-out> I<filename>
45 46 47 48 49 50

This specifies the output filename to write parameters to or standard output if
this option is not specified.

=item B<-text>

P
Pauli 已提交
51
Prints out the parameters in plain text in addition to the encoded version.
52 53 54

=item B<-noout>

P
Pauli 已提交
55
Do not output the encoded version of the parameters.
56

57 58 59 60
=item B<-check>

This option checks the correctness of parameters.

R
Rich Salz 已提交
61 62
{- $OpenSSL::safe::opt_engine_item -}

63 64
{- $OpenSSL::safe::opt_provider_item -}

65 66
=back

67
=head1 EXAMPLES
68 69 70 71 72 73 74 75 76 77 78 79

Print out text version of parameters:

 openssl pkeyparam -in param.pem -text

=head1 NOTES

There are no B<-inform> or B<-outform> options for this command because only
PEM format is supported because the key type is determined by the PEM headers.

=head1 SEE ALSO

80 81 82 83 84 85 86
L<openssl(1)>,
L<openssl-genpkey(1)>,
L<openssl-rsa(1)>,
L<openssl-pkcs8(1)>,
L<openssl-dsa(1)>,
L<openssl-genrsa(1)>,
L<openssl-gendsa(1)>
87

88 89 90 91
=head1 HISTORY

The B<-engine> option was deprecated in OpenSSL 3.0.

R
Rich Salz 已提交
92 93
=head1 COPYRIGHT

M
Matt Caswell 已提交
94
Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
R
Rich Salz 已提交
95

96
Licensed under the Apache License 2.0 (the "License").  You may not use
R
Rich Salz 已提交
97 98 99 100 101
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut