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

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "PKEY 1"
 132 .TH PKEY 1 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 openssl\-pkey, pkey \- public or private key processing tool
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBopenssl\fR \fBpkey\fR
 142 [\fB\-help\fR]
 143 [\fB\-inform PEM|DER\fR]
 144 [\fB\-outform PEM|DER\fR]
 145 [\fB\-in filename\fR]
 146 [\fB\-passin arg\fR]
 147 [\fB\-out filename\fR]
 148 [\fB\-passout arg\fR]
 149 [\fB\-traditional\fR]
 150 [\fB\-\f(BIcipher\fB\fR]
 151 [\fB\-text\fR]
 152 [\fB\-text_pub\fR]
 153 [\fB\-noout\fR]
 154 [\fB\-pubin\fR]
 155 [\fB\-pubout\fR]
 156 [\fB\-engine id\fR]
 157 [\fB\-check\fR]
 158 [\fB\-pubcheck\fR]
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 The \fBpkey\fR command processes public or private keys. They can be converted
 162 between various forms and their components printed out.
 163 .SH "OPTIONS"
 164 .IX Header "OPTIONS"
 165 .IP "\fB\-help\fR" 4
 166 .IX Item "-help"
 167 Print out a usage message.
 168 .IP "\fB\-inform DER|PEM\fR" 4
 169 .IX Item "-inform DER|PEM"
 170 This specifies the input format \s-1DER\s0 or \s-1PEM.\s0 The default format is \s-1PEM.\s0
 171 .IP "\fB\-outform DER|PEM\fR" 4
 172 .IX Item "-outform DER|PEM"
 173 This specifies the output format, the options have the same meaning and default
 174 as the \fB\-inform\fR option.
 175 .IP "\fB\-in filename\fR" 4
 176 .IX Item "-in filename"
 177 This specifies the input filename to read a key from or standard input if this
 178 option is not specified. If the key is encrypted a pass phrase will be
 179 prompted for.
 180 .IP "\fB\-passin arg\fR" 4
 181 .IX Item "-passin arg"
 182 The input file password source. For more information about the format of \fBarg\fR
 183 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 184 .IP "\fB\-out filename\fR" 4
 185 .IX Item "-out filename"
 186 This specifies the output filename to write a key to or standard output if this
 187 option is not specified. If any encryption options are set then a pass phrase
 188 will be prompted for. The output filename should \fBnot\fR be the same as the input
 189 filename.
 190 .IP "\fB\-passout password\fR" 4
 191 .IX Item "-passout password"
 192 The output file password source. For more information about the format of \fBarg\fR
 193 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 194 .IP "\fB\-traditional\fR" 4
 195 .IX Item "-traditional"
 196 Normally a private key is written using standard format: this is PKCS#8 form
 197 with the appropriate encryption algorithm (if any). If the \fB\-traditional\fR
 198 option is specified then the older \*(L"traditional\*(R" format is used instead.
 199 .IP "\fB\-\f(BIcipher\fB\fR" 4
 200 .IX Item "-cipher"
 201 These options encrypt the private key with the supplied cipher. Any algorithm
 202 name accepted by \fIEVP_get_cipherbyname()\fR is acceptable such as \fBdes3\fR.
 203 .IP "\fB\-text\fR" 4
 204 .IX Item "-text"
 205 Prints out the various public or private key components in
 206 plain text in addition to the encoded version.
 207 .IP "\fB\-text_pub\fR" 4
 208 .IX Item "-text_pub"
 209 Print out only public key components even if a private key is being processed.
 210 .IP "\fB\-noout\fR" 4
 211 .IX Item "-noout"
 212 Do not output the encoded version of the key.
 213 .IP "\fB\-pubin\fR" 4
 214 .IX Item "-pubin"
 215 By default a private key is read from the input file: with this
 216 option a public key is read instead.
 217 .IP "\fB\-pubout\fR" 4
 218 .IX Item "-pubout"
 219 By default a private key is output: with this option a public
 220 key will be output instead. This option is automatically set if
 221 the input is a public key.
 222 .IP "\fB\-engine id\fR" 4
 223 .IX Item "-engine id"
 224 Specifying an engine (by its unique \fBid\fR string) will cause \fBpkey\fR
 225 to attempt to obtain a functional reference to the specified engine,
 226 thus initialising it if needed. The engine will then be set as the default
 227 for all available algorithms.
 228 .IP "\fB\-check\fR" 4
 229 .IX Item "-check"
 230 This option checks the consistency of a key pair for both public and private
 231 components.
 232 .IP "\fB\-pubcheck\fR" 4
 233 .IX Item "-pubcheck"
 234 This option checks the correctness of either a public key or the public component
 235 of a key pair.
 236 .SH "EXAMPLES"
 237 .IX Header "EXAMPLES"
 238 To remove the pass phrase on an \s-1RSA\s0 private key:
 239 .PP
 240 .Vb 1
 241 \& openssl pkey \-in key.pem \-out keyout.pem
 242 .Ve
 243 .PP
 244 To encrypt a private key using triple \s-1DES:\s0
 245 .PP
 246 .Vb 1
 247 \& openssl pkey \-in key.pem \-des3 \-out keyout.pem
 248 .Ve
 249 .PP
 250 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
 251 .PP
 252 .Vb 1
 253 \& openssl pkey \-in key.pem \-outform DER \-out keyout.der
 254 .Ve
 255 .PP
 256 To print out the components of a private key to standard output:
 257 .PP
 258 .Vb 1
 259 \& openssl pkey \-in key.pem \-text \-noout
 260 .Ve
 261 .PP
 262 To print out the public components of a private key to standard output:
 263 .PP
 264 .Vb 1
 265 \& openssl pkey \-in key.pem \-text_pub \-noout
 266 .Ve
 267 .PP
 268 To just output the public part of a private key:
 269 .PP
 270 .Vb 1
 271 \& openssl pkey \-in key.pem \-pubout \-out pubkey.pem
 272 .Ve
 273 .SH "SEE ALSO"
 274 .IX Header "SEE ALSO"
 275 \&\fIgenpkey\fR\|(1), \fIrsa\fR\|(1), \fIpkcs8\fR\|(1),
 276 \&\fIdsa\fR\|(1), \fIgenrsa\fR\|(1), \fIgendsa\fR\|(1)
 277 .SH "COPYRIGHT"
 278 .IX Header "COPYRIGHT"
 279 Copyright 2006\-2017 The OpenSSL Project Authors. All Rights Reserved.
 280 .PP
 281 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 282 this file except in compliance with the License.  You can obtain a copy
 283 in the file \s-1LICENSE\s0 in the source distribution or at
 284 <https://www.openssl.org/source/license.html>.