xref: /openssl/doc/man1/openssl-pkeyparam.pod.in (revision 1dbb67c4)
1=pod
2
3=begin comment
4{- join("\n", @autowarntext) -}
5
6=end comment
7
8=head1 NAME
9
10openssl-pkeyparam - public key algorithm parameter processing command
11
12=head1 SYNOPSIS
13
14B<openssl> B<pkeyparam>
15[B<-help>]
16[B<-in> I<filename>]
17[B<-out> I<filename>]
18[B<-text>]
19[B<-noout>]
20[B<-check>]
21{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
22
23=head1 DESCRIPTION
24
25This command processes public key algorithm parameters.
26They can be checked for correctness and their components printed out.
27
28=head1 OPTIONS
29
30=over 4
31
32=item B<-help>
33
34Print out a usage message.
35
36=item B<-in> I<filename>
37
38This specifies the input file to read parameters from or standard input if
39this option is not specified.
40
41=item B<-out> I<filename>
42
43This specifies the output filename to write parameters to or standard output if
44this option is not specified.
45The output filename can be the same as the input filename,
46which leads to replacing the file contents.
47Note that file I/O is not atomic. The output file is truncated and then written.
48
49=item B<-text>
50
51Prints out the parameters in plain text in addition to the encoded version.
52
53=item B<-noout>
54
55Do not output the encoded version of the parameters.
56
57=item B<-check>
58
59This option checks the correctness of parameters.
60
61{- $OpenSSL::safe::opt_engine_item -}
62
63{- $OpenSSL::safe::opt_provider_item -}
64
65=back
66
67=head1 EXAMPLES
68
69Print out text version of parameters:
70
71 openssl pkeyparam -in param.pem -text
72
73=head1 NOTES
74
75There are no B<-inform> or B<-outform> options for this command because only
76PEM format is supported because the key type is determined by the PEM headers.
77
78=head1 SEE ALSO
79
80L<openssl(1)>,
81L<openssl-genpkey(1)>,
82L<openssl-rsa(1)>,
83L<openssl-pkcs8(1)>,
84L<openssl-dsa(1)>,
85L<openssl-genrsa(1)>,
86L<openssl-gendsa(1)>
87
88=head1 HISTORY
89
90The B<-engine> option was deprecated in OpenSSL 3.0.
91
92=head1 COPYRIGHT
93
94Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.
95
96Licensed under the Apache License 2.0 (the "License").  You may not use
97this file except in compliance with the License.  You can obtain a copy
98in the file LICENSE in the source distribution or at
99L<https://www.openssl.org/source/license.html>.
100
101=cut
102