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