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

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