secure/usr.bin/openssl/man/pkey.1

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  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<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  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
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  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.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  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
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  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'
 105 .\}
 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 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "PKEY 1"
 136 .TH PKEY 1 "2020-03-17" "1.1.1e" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 openssl\-pkey, pkey \- public or private key processing tool
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBpkey\fR
 146 [\fB\-help\fR]
 147 [\fB\-inform PEM|DER\fR]
 148 [\fB\-outform PEM|DER\fR]
 149 [\fB\-in filename\fR]
 150 [\fB\-passin arg\fR]
 151 [\fB\-out filename\fR]
 152 [\fB\-passout arg\fR]
 153 [\fB\-traditional\fR]
 154 [\fB\-\f(BIcipher\fB\fR]
 155 [\fB\-text\fR]
 156 [\fB\-text_pub\fR]
 157 [\fB\-noout\fR]
 158 [\fB\-pubin\fR]
 159 [\fB\-pubout\fR]
 160 [\fB\-engine id\fR]
 161 [\fB\-check\fR]
 162 [\fB\-pubcheck\fR]
 163 .SH "DESCRIPTION"
 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.
 167 .SH "OPTIONS"
 168 .IX Header "OPTIONS"
 169 .IP "\fB\-help\fR" 4
 170 .IX Item "-help"
 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
 183 prompted for.
 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
 193 filename.
 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
 204 .IX Item "-cipher"
 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.
 207 .IP "\fB\-text\fR" 4
 208 .IX Item "-text"
 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
 212 .IX Item "-text_pub"
 213 Print out only public key components even if a private key is being processed.
 214 .IP "\fB\-noout\fR" 4
 215 .IX Item "-noout"
 216 Do not output the encoded version of the key.
 217 .IP "\fB\-pubin\fR" 4
 218 .IX Item "-pubin"
 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
 222 .IX Item "-pubout"
 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
 233 .IX Item "-check"
 234 This option checks the consistency of a key pair for both public and private
 235 components.
 236 .IP "\fB\-pubcheck\fR" 4
 237 .IX Item "-pubcheck"
 238 This option checks the correctness of either a public key or the public component
 239 of a key pair.
 240 .SH "EXAMPLES"
 241 .IX Header "EXAMPLES"
 242 To remove the pass phrase on an \s-1RSA\s0 private key:
 243 .PP
 244 .Vb 1
 245 \& openssl pkey \-in key.pem \-out keyout.pem
 246 .Ve
 247 .PP
 248 To encrypt a private key using triple \s-1DES:\s0
 249 .PP
 250 .Vb 1
 251 \& openssl pkey \-in key.pem \-des3 \-out keyout.pem
 252 .Ve
 253 .PP
 254 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
 255 .PP
 256 .Vb 1
 257 \& openssl pkey \-in key.pem \-outform DER \-out keyout.der
 258 .Ve
 259 .PP
 260 To print out the components of a private key to standard output:
 261 .PP
 262 .Vb 1
 263 \& openssl pkey \-in key.pem \-text \-noout
 264 .Ve
 265 .PP
 266 To print out the public components of a private key to standard output:
 267 .PP
 268 .Vb 1
 269 \& openssl pkey \-in key.pem \-text_pub \-noout
 270 .Ve
 271 .PP
 272 To just output the public part of a private key:
 273 .PP
 274 .Vb 1
 275 \& openssl pkey \-in key.pem \-pubout \-out pubkey.pem
 276 .Ve
 277 .SH "SEE ALSO"
 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)
 281 .SH "COPYRIGHT"
 282 .IX Header "COPYRIGHT"
 283 Copyright 2006\-2017 The OpenSSL Project Authors. All Rights Reserved.
 284 .PP
 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>.