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