crypto/external/bsd/openssl/lib/libcrypto/man/openssl_pkey.1

   1 .\"     $NetBSD: openssl_pkey.1,v 1.14 2015/06/12 17:01:15 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .de Vb \" Begin verbatim text
  12 .ft CW
  13 .nf
  14 .ne \\$1
  15 ..
  16 .de Ve \" End verbatim text
  17 .ft R
  18 .fi
  19 ..
  20 .\" Set up some character translations and predefined strings.  \*(-- will
  21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  22 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  23 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  24 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  25 .\" nothing in troff, for use with C<>.
  26 .tr \(*W-
  27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  28 .ie n \{\
  29 .    ds -- \(*W-
  30 .    ds PI pi
  31 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  32 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  33 .    ds L" ""
  34 .    ds R" ""
  35 .    ds C` ""
  36 .    ds C' ""
  37 'br\}
  38 .el\{\
  39 .    ds -- \|\(em\|
  40 .    ds PI \(*p
  41 .    ds L" ``
  42 .    ds R" ''
  43 .    ds C`
  44 .    ds C'
  45 'br\}
  46 .\"
  47 .\" Escape single quotes in literal strings from groff's Unicode transform.
  48 .ie \n(.g .ds Aq \(aq
  49 .el       .ds Aq '
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .\"
  56 .\" Avoid warning from groff about undefined register 'F'.
  57 .de IX
  58 ..
  59 .nr rF 0
  60 .if \n(.g .if rF .nr rF 1
  61 .if (\n(rF:(\n(.g==0)) \{
  62 .    if \nF \{
  63 .        de IX
  64 .        tm Index:\\$1\t\\n%\t"\\$2"
  65 ..
  66 .        if !\nF==2 \{
  67 .            nr % 0
  68 .            nr F 2
  69 .        \}
  70 .    \}
  71 .\}
  72 .rr rF
  73 .\"
  74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  75 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  76 .    \" fudge factors for nroff and troff
  77 .if n \{\
  78 .    ds #H 0
  79 .    ds #V .8m
  80 .    ds #F .3m
  81 .    ds #[ \f1
  82 .    ds #] \fP
  83 .\}
  84 .if t \{\
  85 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  86 .    ds #V .6m
  87 .    ds #F 0
  88 .    ds #[ \&
  89 .    ds #] \&
  90 .\}
  91 .    \" simple accents for nroff and troff
  92 .if n \{\
  93 .    ds ' \&
  94 .    ds ` \&
  95 .    ds ^ \&
  96 .    ds , \&
  97 .    ds ~ ~
  98 .    ds /
  99 .\}
 100 .if t \{\
 101 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 102 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 103 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 104 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 105 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 106 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 107 .\}
 108 .    \" troff and (daisy-wheel) nroff accents
 109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 116 .ds ae a\h'-(\w'a'u*4/10)'e
 117 .ds Ae A\h'-(\w'A'u*4/10)'E
 118 .    \" corrections for vroff
 119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 121 .    \" for low resolution devices (crt and lpr)
 122 .if \n(.H>23 .if \n(.V>19 \
 123 \{\
 124 .    ds : e
 125 .    ds 8 ss
 126 .    ds o a
 127 .    ds d- d\h'-1'\(ga
 128 .    ds D- D\h'-1'\(hy
 129 .    ds th \o'bp'
 130 .    ds Th \o'LP'
 131 .    ds ae ae
 132 .    ds Ae AE
 133 .\}
 134 .rm #[ #] #H #V #F C
 135 .\" ========================================================================
 136 .\"
 137 .IX Title "PKEY 1"
 138 .TH PKEY 1 "2009-07-19" "1.0.1n" "OpenSSL"
 139 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 140 .\" way too many mistakes in technical documents.
 141 .if n .ad l
 142 .nh
 143 .SH "NAME"
 144 pkey \- public or private key processing tool
 145 .SH "LIBRARY"
 146 libcrypto, -lcrypto
 147 .SH "SYNOPSIS"
 148 .IX Header "SYNOPSIS"
 149 \&\fBopenssl\fR \fBpkey\fR
 150 [\fB\-inform PEM|DER\fR]
 151 [\fB\-outform PEM|DER\fR]
 152 [\fB\-in filename\fR]
 153 [\fB\-passin arg\fR]
 154 [\fB\-out filename\fR]
 155 [\fB\-passout arg\fR]
 156 [\fB\-cipher\fR]
 157 [\fB\-text\fR]
 158 [\fB\-text_pub\fR]
 159 [\fB\-noout\fR]
 160 [\fB\-pubin\fR]
 161 [\fB\-pubout\fR]
 162 [\fB\-engine id\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 "COMMAND OPTIONS"
 168 .IX Header "COMMAND OPTIONS"
 169 .IP "\fB\-inform DER|PEM\fR" 4
 170 .IX Item "-inform DER|PEM"
 171 This specifies the input format \s-1DER\s0 or \s-1PEM.\s0
 172 .IP "\fB\-outform DER|PEM\fR" 4
 173 .IX Item "-outform DER|PEM"
 174 This specifies the output format, the options have the same meaning as the
 175 \&\fB\-inform\fR option.
 176 .IP "\fB\-in filename\fR" 4
 177 .IX Item "-in filename"
 178 This specifies the input filename to read a key from or standard input if this
 179 option is not specified. If the key is encrypted a pass phrase will be
 180 prompted for.
 181 .IP "\fB\-passin arg\fR" 4
 182 .IX Item "-passin arg"
 183 the input file password source. For more information about the format of \fBarg\fR
 184 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 185 .IP "\fB\-out filename\fR" 4
 186 .IX Item "-out filename"
 187 This specifies the output filename to write a key to or standard output if this
 188 option is not specified. If any encryption options are set then a pass phrase
 189 will be prompted for. The output filename should \fBnot\fR be the same as the input
 190 filename.
 191 .IP "\fB\-passout password\fR" 4
 192 .IX Item "-passout password"
 193 the output file password source. For more information about the format of \fBarg\fR
 194 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 195 .IP "\fB\-cipher\fR" 4
 196 .IX Item "-cipher"
 197 These options encrypt the private key with the supplied cipher. Any algorithm
 198 name accepted by \fIEVP_get_cipherbyname()\fR is acceptable such as \fBdes3\fR.
 199 .IP "\fB\-text\fR" 4
 200 .IX Item "-text"
 201 prints out the various public or private key components in
 202 plain text in addition to the encoded version.
 203 .IP "\fB\-text_pub\fR" 4
 204 .IX Item "-text_pub"
 205 print out only public key components even if a private key is being processed.
 206 .IP "\fB\-noout\fR" 4
 207 .IX Item "-noout"
 208 do not output the encoded version of the key.
 209 .IP "\fB\-pubin\fR" 4
 210 .IX Item "-pubin"
 211 by default a private key is read from the input file: with this
 212 option a public key is read instead.
 213 .IP "\fB\-pubout\fR" 4
 214 .IX Item "-pubout"
 215 by default a private key is output: with this option a public
 216 key will be output instead. This option is automatically set if
 217 the input is a public key.
 218 .IP "\fB\-engine id\fR" 4
 219 .IX Item "-engine id"
 220 specifying an engine (by its unique \fBid\fR string) will cause \fBpkey\fR
 221 to attempt to obtain a functional reference to the specified engine,
 222 thus initialising it if needed. The engine will then be set as the default
 223 for all available algorithms.
 224 .SH "EXAMPLES"
 225 .IX Header "EXAMPLES"
 226 To remove the pass phrase on an \s-1RSA\s0 private key:
 227 .PP
 228 .Vb 1
 229 \& openssl pkey \-in key.pem \-out keyout.pem
 230 .Ve
 231 .PP
 232 To encrypt a private key using triple \s-1DES:\s0
 233 .PP
 234 .Vb 1
 235 \& openssl pkey \-in key.pem \-des3 \-out keyout.pem
 236 .Ve
 237 .PP
 238 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
 239 .PP
 240 .Vb 1
 241 \& openssl pkey \-in key.pem \-outform DER \-out keyout.der
 242 .Ve
 243 .PP
 244 To print out the components of a private key to standard output:
 245 .PP
 246 .Vb 1
 247 \& openssl pkey \-in key.pem \-text \-noout
 248 .Ve
 249 .PP
 250 To print out the public components of a private key to standard output:
 251 .PP
 252 .Vb 1
 253 \& openssl pkey \-in key.pem \-text_pub \-noout
 254 .Ve
 255 .PP
 256 To just output the public part of a private key:
 257 .PP
 258 .Vb 1
 259 \& openssl pkey \-in key.pem \-pubout \-out pubkey.pem
 260 .Ve
 261 .SH "SEE ALSO"
 262 .IX Header "SEE ALSO"
 263 \&\fIgenpkey\fR\|(1), \fIopenssl_rsa\fR\|(1), \fIopenssl_pkcs8\fR\|(1),
 264 \&\fIopenssl_dsa\fR\|(1), \fIopenssl_genrsa\fR\|(1), \fIopenssl_gendsa\fR\|(1)