1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.41)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
136 .TH PKEY 1 "2020-12-08" "1.1.1i" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 openssl\-pkey, pkey \- public or private key processing tool
144 .IX Header "SYNOPSIS"
145 \&\fBopenssl\fR \fBpkey\fR
147 [\fB\-inform PEM|DER\fR]
148 [\fB\-outform PEM|DER\fR]
149 [\fB\-in filename\fR]
151 [\fB\-out filename\fR]
152 [\fB\-passout arg\fR]
153 [\fB\-traditional\fR]
154 [\fB\-\f(BIcipher\fB\fR]
164 .IX Header "DESCRIPTION"
165 The \fBpkey\fR command processes public or private keys. They can be converted
166 between various forms and their components printed out.
171 Print out a usage message.
172 .IP "\fB\-inform DER|PEM\fR" 4
173 .IX Item "-inform DER|PEM"
174 This specifies the input format \s-1DER\s0 or \s-1PEM.\s0 The default format is \s-1PEM.\s0
175 .IP "\fB\-outform DER|PEM\fR" 4
176 .IX Item "-outform DER|PEM"
177 This specifies the output format, the options have the same meaning and default
178 as the \fB\-inform\fR option.
179 .IP "\fB\-in filename\fR" 4
180 .IX Item "-in filename"
181 This specifies the input filename to read a key from or standard input if this
182 option is not specified. If the key is encrypted a pass phrase will be
184 .IP "\fB\-passin arg\fR" 4
185 .IX Item "-passin arg"
186 The input file password source. For more information about the format of \fBarg\fR
187 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
188 .IP "\fB\-out filename\fR" 4
189 .IX Item "-out filename"
190 This specifies the output filename to write a key to or standard output if this
191 option is not specified. If any encryption options are set then a pass phrase
192 will be prompted for. The output filename should \fBnot\fR be the same as the input
194 .IP "\fB\-passout password\fR" 4
195 .IX Item "-passout password"
196 The output file password source. For more information about the format of \fBarg\fR
197 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
198 .IP "\fB\-traditional\fR" 4
199 .IX Item "-traditional"
200 Normally a private key is written using standard format: this is PKCS#8 form
201 with the appropriate encryption algorithm (if any). If the \fB\-traditional\fR
202 option is specified then the older \*(L"traditional\*(R" format is used instead.
203 .IP "\fB\-\f(BIcipher\fB\fR" 4
205 These options encrypt the private key with the supplied cipher. Any algorithm
206 name accepted by \fBEVP_get_cipherbyname()\fR is acceptable such as \fBdes3\fR.
209 Prints out the various public or private key components in
210 plain text in addition to the encoded version.
211 .IP "\fB\-text_pub\fR" 4
213 Print out only public key components even if a private key is being processed.
214 .IP "\fB\-noout\fR" 4
216 Do not output the encoded version of the key.
217 .IP "\fB\-pubin\fR" 4
219 By default a private key is read from the input file: with this
220 option a public key is read instead.
221 .IP "\fB\-pubout\fR" 4
223 By default a private key is output: with this option a public
224 key will be output instead. This option is automatically set if
225 the input is a public key.
226 .IP "\fB\-engine id\fR" 4
227 .IX Item "-engine id"
228 Specifying an engine (by its unique \fBid\fR string) will cause \fBpkey\fR
229 to attempt to obtain a functional reference to the specified engine,
230 thus initialising it if needed. The engine will then be set as the default
231 for all available algorithms.
232 .IP "\fB\-check\fR" 4
234 This option checks the consistency of a key pair for both public and private
236 .IP "\fB\-pubcheck\fR" 4
238 This option checks the correctness of either a public key or the public component
241 .IX Header "EXAMPLES"
242 To remove the pass phrase on an \s-1RSA\s0 private key:
245 \& openssl pkey \-in key.pem \-out keyout.pem
248 To encrypt a private key using triple \s-1DES:\s0
251 \& openssl pkey \-in key.pem \-des3 \-out keyout.pem
254 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
257 \& openssl pkey \-in key.pem \-outform DER \-out keyout.der
260 To print out the components of a private key to standard output:
263 \& openssl pkey \-in key.pem \-text \-noout
266 To print out the public components of a private key to standard output:
269 \& openssl pkey \-in key.pem \-text_pub \-noout
272 To just output the public part of a private key:
275 \& openssl pkey \-in key.pem \-pubout \-out pubkey.pem
278 .IX Header "SEE ALSO"
279 \&\fBgenpkey\fR\|(1), \fBrsa\fR\|(1), \fBpkcs8\fR\|(1),
280 \&\fBdsa\fR\|(1), \fBgenrsa\fR\|(1), \fBgendsa\fR\|(1)
282 .IX Header "COPYRIGHT"
283 Copyright 2006\-2017 The OpenSSL Project Authors. All Rights Reserved.
285 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
286 this file except in compliance with the License. You can obtain a copy
287 in the file \s-1LICENSE\s0 in the source distribution or at
288 <https://www.openssl.org/source/license.html>.