b1aa4af454bcf2140f5c666aa37ba2c8d5137217
[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>, B<-outform> B<DER>|B<PEM>
44
45 The input and formats; the default is B<PEM>.
46 See L<openssl(1)/Format Options> for details.
47
48 =item B<-in> I<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> I<arg>, B<-passout> I<arg>
55
56 The password source for the input and output file.
57 For more information about the format of B<arg>
58 see L<openssl(1)/Pass Phrase Options>.
59
60 =item B<-out> I<filename>
61
62 This specifies the output filename to write a key to or standard output if this
63 option is not specified. If any encryption options are set then a pass phrase
64 will be prompted for. The output filename should B<not> be the same as the input
65 filename.
66
67 =item B<-traditional>
68
69 Normally a private key is written using standard format: this is PKCS#8 form
70 with the appropriate encryption algorithm (if any). If the B<-traditional>
71 option is specified then the older "traditional" format is used instead.
72
73 =item B<-I<cipher>>
74
75 These options encrypt the private key with the supplied cipher. Any algorithm
76 name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>.
77
78 =item B<-text>
79
80 Prints out the various public or private key components in
81 plain text in addition to the encoded version.
82
83 =item B<-text_pub>
84
85 Print out only public key components even if a private key is being processed.
86
87 =item B<-noout>
88
89 Do not output the encoded version of the key.
90
91 =item B<-pubin>
92
93 By default a private key is read from the input file: with this
94 option a public key is read instead.
95
96 =item B<-pubout>
97
98 By default a private key is output: with this option a public
99 key will be output instead. This option is automatically set if
100 the input is a public key.
101
102 =item B<-engine> I<id>
103
104 Specifying an engine (by its unique I<id> string) will cause this command
105 to attempt to obtain a functional reference to the specified engine,
106 thus initialising it if needed. The engine will then be set as the default
107 for all available algorithms.
108
109 =item B<-check>
110
111 This option checks the consistency of a key pair for both public and private
112 components.
113
114 =item B<-pubcheck>
115
116 This option checks the correctness of either a public key or the public component
117 of a key pair.
118
119 =back
120
121 =head1 EXAMPLES
122
123 To remove the pass phrase on an RSA 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