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