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

   1 .\" Automatically generated by Pod::Man 4.07 (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 "2017-11-02" "1.0.2m" "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,
 139 pkey \- public or private key processing tool
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 \&\fBopenssl\fR \fBpkey\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\-cipher\fR]
 150 [\fB\-text\fR]
 151 [\fB\-text_pub\fR]
 152 [\fB\-noout\fR]
 153 [\fB\-pubin\fR]
 154 [\fB\-pubout\fR]
 155 [\fB\-engine id\fR]
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 The \fBpkey\fR command processes public or private keys. They can be converted
 159 between various forms and their components printed out.
 160 .SH "COMMAND OPTIONS"
 161 .IX Header "COMMAND OPTIONS"
 162 .IP "\fB\-inform DER|PEM\fR" 4
 163 .IX Item "-inform DER|PEM"
 164 This specifies the input format \s-1DER\s0 or \s-1PEM.\s0
 165 .IP "\fB\-outform DER|PEM\fR" 4
 166 .IX Item "-outform DER|PEM"
 167 This specifies the output format, the options have the same meaning as the
 168 \&\fB\-inform\fR option.
 169 .IP "\fB\-in filename\fR" 4
 170 .IX Item "-in filename"
 171 This specifies the input filename to read a key from or standard input if this
 172 option is not specified. If the key is encrypted a pass phrase will be
 173 prompted for.
 174 .IP "\fB\-passin arg\fR" 4
 175 .IX Item "-passin arg"
 176 the input file password source. For more information about the format of \fBarg\fR
 177 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 178 .IP "\fB\-out filename\fR" 4
 179 .IX Item "-out filename"
 180 This specifies the output filename to write a key to or standard output if this
 181 option is not specified. If any encryption options are set then a pass phrase
 182 will be prompted for. The output filename should \fBnot\fR be the same as the input
 183 filename.
 184 .IP "\fB\-passout password\fR" 4
 185 .IX Item "-passout password"
 186 the output file password source. For more information about the format of \fBarg\fR
 187 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 188 .IP "\fB\-cipher\fR" 4
 189 .IX Item "-cipher"
 190 These options encrypt the private key with the supplied cipher. Any algorithm
 191 name accepted by \fIEVP_get_cipherbyname()\fR is acceptable such as \fBdes3\fR.
 192 .IP "\fB\-text\fR" 4
 193 .IX Item "-text"
 194 prints out the various public or private key components in
 195 plain text in addition to the encoded version.
 196 .IP "\fB\-text_pub\fR" 4
 197 .IX Item "-text_pub"
 198 print out only public key components even if a private key is being processed.
 199 .IP "\fB\-noout\fR" 4
 200 .IX Item "-noout"
 201 do not output the encoded version of the key.
 202 .IP "\fB\-pubin\fR" 4
 203 .IX Item "-pubin"
 204 by default a private key is read from the input file: with this
 205 option a public key is read instead.
 206 .IP "\fB\-pubout\fR" 4
 207 .IX Item "-pubout"
 208 by default a private key is output: with this option a public
 209 key will be output instead. This option is automatically set if
 210 the input is a public key.
 211 .IP "\fB\-engine id\fR" 4
 212 .IX Item "-engine id"
 213 specifying an engine (by its unique \fBid\fR string) will cause \fBpkey\fR
 214 to attempt to obtain a functional reference to the specified engine,
 215 thus initialising it if needed. The engine will then be set as the default
 216 for all available algorithms.
 217 .SH "EXAMPLES"
 218 .IX Header "EXAMPLES"
 219 To remove the pass phrase on an \s-1RSA\s0 private key:
 220 .PP
 221 .Vb 1
 222 \& openssl pkey \-in key.pem \-out keyout.pem
 223 .Ve
 224 .PP
 225 To encrypt a private key using triple \s-1DES:\s0
 226 .PP
 227 .Vb 1
 228 \& openssl pkey \-in key.pem \-des3 \-out keyout.pem
 229 .Ve
 230 .PP
 231 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
 232 .PP
 233 .Vb 1
 234 \& openssl pkey \-in key.pem \-outform DER \-out keyout.der
 235 .Ve
 236 .PP
 237 To print out the components of a private key to standard output:
 238 .PP
 239 .Vb 1
 240 \& openssl pkey \-in key.pem \-text \-noout
 241 .Ve
 242 .PP
 243 To print out the public components of a private key to standard output:
 244 .PP
 245 .Vb 1
 246 \& openssl pkey \-in key.pem \-text_pub \-noout
 247 .Ve
 248 .PP
 249 To just output the public part of a private key:
 250 .PP
 251 .Vb 1
 252 \& openssl pkey \-in key.pem \-pubout \-out pubkey.pem
 253 .Ve
 254 .SH "SEE ALSO"
 255 .IX Header "SEE ALSO"
 256 \&\fIgenpkey\fR\|(1), \fIrsa\fR\|(1), \fIpkcs8\fR\|(1),
 257 \&\fIdsa\fR\|(1), \fIgenrsa\fR\|(1), \fIgendsa\fR\|(1)