secure/usr.bin/openssl/man/rsa.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 "RSA 1"
 132 .TH RSA 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\-rsa, rsa \- RSA key processing tool
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBopenssl\fR \fBrsa\fR
 142 [\fB\-help\fR]
 143 [\fB\-inform PEM|NET|DER\fR]
 144 [\fB\-outform PEM|NET|DER\fR]
 145 [\fB\-in filename\fR]
 146 [\fB\-passin arg\fR]
 147 [\fB\-out filename\fR]
 148 [\fB\-passout arg\fR]
 149 [\fB\-aes128\fR]
 150 [\fB\-aes192\fR]
 151 [\fB\-aes256\fR]
 152 [\fB\-aria128\fR]
 153 [\fB\-aria192\fR]
 154 [\fB\-aria256\fR]
 155 [\fB\-camellia128\fR]
 156 [\fB\-camellia192\fR]
 157 [\fB\-camellia256\fR]
 158 [\fB\-des\fR]
 159 [\fB\-des3\fR]
 160 [\fB\-idea\fR]
 161 [\fB\-text\fR]
 162 [\fB\-noout\fR]
 163 [\fB\-modulus\fR]
 164 [\fB\-check\fR]
 165 [\fB\-pubin\fR]
 166 [\fB\-pubout\fR]
 167 [\fB\-RSAPublicKey_in\fR]
 168 [\fB\-RSAPublicKey_out\fR]
 169 [\fB\-engine id\fR]
 170 .SH "DESCRIPTION"
 171 .IX Header "DESCRIPTION"
 172 The \fBrsa\fR command processes \s-1RSA\s0 keys. They can be converted between various
 173 forms and their components printed out. \fBNote\fR this command uses the
 174 traditional SSLeay compatible format for private key encryption: newer
 175 applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
 176 utility.
 177 .SH "OPTIONS"
 178 .IX Header "OPTIONS"
 179 .IP "\fB\-help\fR" 4
 180 .IX Item "-help"
 181 Print out a usage message.
 182 .IP "\fB\-inform DER|NET|PEM\fR" 4
 183 .IX Item "-inform DER|NET|PEM"
 184 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1 DER\s0 encoded
 185 form compatible with the PKCS#1 RSAPrivateKey or SubjectPublicKeyInfo format.
 186 The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
 187 encoded with additional header and footer lines. On input PKCS#8 format private
 188 keys are also accepted. The \fB\s-1NET\s0\fR form is a format is described in the \fB\s-1NOTES\s0\fR
 189 section.
 190 .IP "\fB\-outform DER|NET|PEM\fR" 4
 191 .IX Item "-outform DER|NET|PEM"
 192 This specifies the output format, the options have the same meaning and default
 193 as the \fB\-inform\fR option.
 194 .IP "\fB\-in filename\fR" 4
 195 .IX Item "-in filename"
 196 This specifies the input filename to read a key from or standard input if this
 197 option is not specified. If the key is encrypted a pass phrase will be
 198 prompted for.
 199 .IP "\fB\-passin arg\fR" 4
 200 .IX Item "-passin arg"
 201 The input file password source. For more information about the format of \fBarg\fR
 202 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 203 .IP "\fB\-out filename\fR" 4
 204 .IX Item "-out filename"
 205 This specifies the output filename to write a key to or standard output if this
 206 option is not specified. If any encryption options are set then a pass phrase
 207 will be prompted for. The output filename should \fBnot\fR be the same as the input
 208 filename.
 209 .IP "\fB\-passout password\fR" 4
 210 .IX Item "-passout password"
 211 The output file password source. For more information about the format of \fBarg\fR
 212 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 213 .IP "\fB\-aes128\fR, \fB\-aes192\fR, \fB\-aes256\fR, \fB\-aria128\fR, \fB\-aria192\fR, \fB\-aria256\fR, \fB\-camellia128\fR, \fB\-camellia192\fR, \fB\-camellia256\fR, \fB\-des\fR, \fB\-des3\fR, \fB\-idea\fR" 4
 214 .IX Item "-aes128, -aes192, -aes256, -aria128, -aria192, -aria256, -camellia128, -camellia192, -camellia256, -des, -des3, -idea"
 215 These options encrypt the private key with the specified
 216 cipher before outputting it. A pass phrase is prompted for.
 217 If none of these options is specified the key is written in plain text. This
 218 means that using the \fBrsa\fR utility to read in an encrypted key with no
 219 encryption option can be used to remove the pass phrase from a key, or by
 220 setting the encryption options it can be use to add or change the pass phrase.
 221 These options can only be used with \s-1PEM\s0 format output files.
 222 .IP "\fB\-text\fR" 4
 223 .IX Item "-text"
 224 Prints out the various public or private key components in
 225 plain text in addition to the encoded version.
 226 .IP "\fB\-noout\fR" 4
 227 .IX Item "-noout"
 228 This option prevents output of the encoded version of the key.
 229 .IP "\fB\-modulus\fR" 4
 230 .IX Item "-modulus"
 231 This option prints out the value of the modulus of the key.
 232 .IP "\fB\-check\fR" 4
 233 .IX Item "-check"
 234 This option checks the consistency of an \s-1RSA\s0 private key.
 235 .IP "\fB\-pubin\fR" 4
 236 .IX Item "-pubin"
 237 By default a private key is read from the input file: with this
 238 option a public key is read instead.
 239 .IP "\fB\-pubout\fR" 4
 240 .IX Item "-pubout"
 241 By default a private key is output: with this option a public
 242 key will be output instead. This option is automatically set if
 243 the input is a public key.
 244 .IP "\fB\-RSAPublicKey_in\fR, \fB\-RSAPublicKey_out\fR" 4
 245 .IX Item "-RSAPublicKey_in, -RSAPublicKey_out"
 246 Like \fB\-pubin\fR and \fB\-pubout\fR except \fBRSAPublicKey\fR format is used instead.
 247 .IP "\fB\-engine id\fR" 4
 248 .IX Item "-engine id"
 249 Specifying an engine (by its unique \fBid\fR string) will cause \fBrsa\fR
 250 to attempt to obtain a functional reference to the specified engine,
 251 thus initialising it if needed. The engine will then be set as the default
 252 for all available algorithms.
 253 .SH "NOTES"
 254 .IX Header "NOTES"
 255 The \s-1PEM\s0 private key format uses the header and footer lines:
 256 .PP
 257 .Vb 2
 258 \& \-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-
 259 \& \-\-\-\-\-END RSA PRIVATE KEY\-\-\-\-\-
 260 .Ve
 261 .PP
 262 The \s-1PEM\s0 public key format uses the header and footer lines:
 263 .PP
 264 .Vb 2
 265 \& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-
 266 \& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\-
 267 .Ve
 268 .PP
 269 The \s-1PEM\s0 \fBRSAPublicKey\fR format uses the header and footer lines:
 270 .PP
 271 .Vb 2
 272 \& \-\-\-\-\-BEGIN RSA PUBLIC KEY\-\-\-\-\-
 273 \& \-\-\-\-\-END RSA PUBLIC KEY\-\-\-\-\-
 274 .Ve
 275 .PP
 276 The \fB\s-1NET\s0\fR form is a format compatible with older Netscape servers
 277 and Microsoft \s-1IIS\s0 .key files, this uses unsalted \s-1RC4\s0 for its encryption.
 278 It is not very secure and so should only be used when necessary.
 279 .PP
 280 Some newer version of \s-1IIS\s0 have additional data in the exported .key
 281 files. To use these with the utility, view the file with a binary editor
 282 and look for the string \*(L"private-key\*(R", then trace back to the byte
 283 sequence 0x30, 0x82 (this is an \s-1ASN1 SEQUENCE\s0). Copy all the data
 284 from this point onwards to another file and use that as the input
 285 to the \fBrsa\fR utility with the \fB\-inform \s-1NET\s0\fR option.
 286 .SH "EXAMPLES"
 287 .IX Header "EXAMPLES"
 288 To remove the pass phrase on an \s-1RSA\s0 private key:
 289 .PP
 290 .Vb 1
 291 \& openssl rsa \-in key.pem \-out keyout.pem
 292 .Ve
 293 .PP
 294 To encrypt a private key using triple \s-1DES:\s0
 295 .PP
 296 .Vb 1
 297 \& openssl rsa \-in key.pem \-des3 \-out keyout.pem
 298 .Ve
 299 .PP
 300 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
 301 .PP
 302 .Vb 1
 303 \& openssl rsa \-in key.pem \-outform DER \-out keyout.der
 304 .Ve
 305 .PP
 306 To print out the components of a private key to standard output:
 307 .PP
 308 .Vb 1
 309 \& openssl rsa \-in key.pem \-text \-noout
 310 .Ve
 311 .PP
 312 To just output the public part of a private key:
 313 .PP
 314 .Vb 1
 315 \& openssl rsa \-in key.pem \-pubout \-out pubkey.pem
 316 .Ve
 317 .PP
 318 Output the public part of a private key in \fBRSAPublicKey\fR format:
 319 .PP
 320 .Vb 1
 321 \& openssl rsa \-in key.pem \-RSAPublicKey_out \-out pubkey.pem
 322 .Ve
 323 .SH "BUGS"
 324 .IX Header "BUGS"
 325 The command line password arguments don't currently work with
 326 \&\fB\s-1NET\s0\fR format.
 327 .PP
 328 There should be an option that automatically handles .key files,
 329 without having to manually edit them.
 330 .SH "SEE ALSO"
 331 .IX Header "SEE ALSO"
 332 \&\fIpkcs8\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
 333 \&\fIgendsa\fR\|(1)
 334 .SH "COPYRIGHT"
 335 .IX Header "COPYRIGHT"
 336 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 337 .PP
 338 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 339 this file except in compliance with the License.  You can obtain a copy
 340 in the file \s-1LICENSE\s0 in the source distribution or at
 341 <https://www.openssl.org/source/license.html>.