]>
Commit | Line | Data |
---|---|---|
1 | =pod | |
2 | ||
3 | =begin comment | |
4 | {- join("\n", @autowarntext) -} | |
5 | ||
6 | =end comment | |
7 | ||
8 | =head1 NAME | |
9 | ||
10 | openssl-pkey - public or private key processing tool | |
11 | ||
12 | =head1 SYNOPSIS | |
13 | ||
14 | B<openssl> B<pkey> | |
15 | [B<-help>] | |
16 | [B<-inform> B<DER>|B<PEM>] | |
17 | [B<-outform> B<DER>|B<PEM>] | |
18 | [B<-in> I<filename>] | |
19 | [B<-passin> I<arg>] | |
20 | [B<-out> I<filename>] | |
21 | [B<-passout> I<arg>] | |
22 | [B<-traditional>] | |
23 | [B<-I<cipher>>] | |
24 | [B<-text>] | |
25 | [B<-text_pub>] | |
26 | [B<-noout>] | |
27 | [B<-pubin>] | |
28 | [B<-pubout>] | |
29 | [B<-check>] | |
30 | [B<-pubcheck>] | |
31 | {- $OpenSSL::safe::opt_engine_synopsis -} | |
32 | ||
33 | =for openssl ifdef engine | |
34 | ||
35 | =head1 DESCRIPTION | |
36 | ||
37 | This command processes public or private keys. They can be | |
38 | converted between various forms and their components printed out. | |
39 | ||
40 | =head1 OPTIONS | |
41 | ||
42 | =over 4 | |
43 | ||
44 | =item B<-help> | |
45 | ||
46 | Print out a usage message. | |
47 | ||
48 | =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM> | |
49 | ||
50 | The input and formats; the default is B<PEM>. | |
51 | See L<openssl(1)/Format Options> for details. | |
52 | ||
53 | =item B<-in> I<filename> | |
54 | ||
55 | This specifies the input filename to read a key from or standard input if this | |
56 | option is not specified. If the key is encrypted a pass phrase will be | |
57 | prompted for. | |
58 | ||
59 | =item B<-passin> I<arg>, B<-passout> I<arg> | |
60 | ||
61 | The password source for the input and output file. | |
62 | For more information about the format of B<arg> | |
63 | see L<openssl(1)/Pass Phrase Options>. | |
64 | ||
65 | =item B<-out> I<filename> | |
66 | ||
67 | This specifies the output filename to write a key to or standard output if this | |
68 | option is not specified. If any encryption options are set then a pass phrase | |
69 | will be prompted for. The output filename should B<not> be the same as the input | |
70 | filename. | |
71 | ||
72 | =item B<-traditional> | |
73 | ||
74 | Normally a private key is written using standard format: this is PKCS#8 form | |
75 | with the appropriate encryption algorithm (if any). If the B<-traditional> | |
76 | option is specified then the older "traditional" format is used instead. | |
77 | ||
78 | =item B<-I<cipher>> | |
79 | ||
80 | These options encrypt the private key with the supplied cipher. Any algorithm | |
81 | name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>. | |
82 | ||
83 | =item B<-text> | |
84 | ||
85 | Prints out the various public or private key components in | |
86 | plain text in addition to the encoded version. | |
87 | ||
88 | =item B<-text_pub> | |
89 | ||
90 | Print out only public key components even if a private key is being processed. | |
91 | ||
92 | =item B<-noout> | |
93 | ||
94 | Do not output the encoded version of the key. | |
95 | ||
96 | =item B<-pubin> | |
97 | ||
98 | By default a private key is read from the input file: with this | |
99 | option a public key is read instead. | |
100 | ||
101 | =item B<-pubout> | |
102 | ||
103 | By default a private key is output: with this option a public | |
104 | key will be output instead. This option is automatically set if | |
105 | the input is a public key. | |
106 | ||
107 | =item B<-check> | |
108 | ||
109 | This option checks the consistency of a key pair for both public and private | |
110 | components. | |
111 | ||
112 | =item B<-pubcheck> | |
113 | ||
114 | This option checks the correctness of either a public key or the public component | |
115 | of a key pair. | |
116 | ||
117 | {- $OpenSSL::safe::opt_engine_item -} | |
118 | ||
119 | =back | |
120 | ||
121 | =head1 EXAMPLES | |
122 | ||
123 | To remove the pass phrase on a private key: | |
124 | ||
125 | openssl pkey -in key.pem -out keyout.pem | |
126 | ||
127 | To encrypt a private key using triple DES: | |
128 | ||
129 | openssl pkey -in key.pem -des3 -out keyout.pem | |
130 | ||
131 | To convert a private key from PEM to DER format: | |
132 | ||
133 | openssl pkey -in key.pem -outform DER -out keyout.der | |
134 | ||
135 | To print out the components of a private key to standard output: | |
136 | ||
137 | openssl pkey -in key.pem -text -noout | |
138 | ||
139 | To print out the public components of a private key to standard output: | |
140 | ||
141 | openssl pkey -in key.pem -text_pub -noout | |
142 | ||
143 | To just output the public part of a private key: | |
144 | ||
145 | openssl pkey -in key.pem -pubout -out pubkey.pem | |
146 | ||
147 | =head1 SEE ALSO | |
148 | ||
149 | L<openssl(1)>, | |
150 | L<openssl-genpkey(1)>, | |
151 | L<openssl-rsa(1)>, | |
152 | L<openssl-pkcs8(1)>, | |
153 | L<openssl-dsa(1)>, | |
154 | L<openssl-genrsa(1)>, | |
155 | L<openssl-gendsa(1)> | |
156 | ||
157 | =head1 COPYRIGHT | |
158 | ||
159 | Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved. | |
160 | ||
161 | Licensed under the Apache License 2.0 (the "License"). You may not use | |
162 | this file except in compliance with the License. You can obtain a copy | |
163 | in the file LICENSE in the source distribution or at | |
164 | L<https://www.openssl.org/source/license.html>. | |
165 | ||
166 | =cut |