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

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
   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 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "RSA 1"
 127 .TH RSA 1 "2014-06-05" "1.0.1h" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 rsa \- RSA key processing tool
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 \&\fBopenssl\fR \fBrsa\fR
 137 [\fB\-inform PEM|NET|DER\fR]
 138 [\fB\-outform PEM|NET|DER\fR]
 139 [\fB\-in filename\fR]
 140 [\fB\-passin arg\fR]
 141 [\fB\-out filename\fR]
 142 [\fB\-passout arg\fR]
 143 [\fB\-sgckey\fR]
 144 [\fB\-des\fR]
 145 [\fB\-des3\fR]
 146 [\fB\-idea\fR]
 147 [\fB\-text\fR]
 148 [\fB\-noout\fR]
 149 [\fB\-modulus\fR]
 150 [\fB\-check\fR]
 151 [\fB\-pubin\fR]
 152 [\fB\-pubout\fR]
 153 [\fB\-RSAPublicKey_in\fR]
 154 [\fB\-RSAPublicKey_out\fR]
 155 [\fB\-engine id\fR]
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 The \fBrsa\fR command processes \s-1RSA\s0 keys. They can be converted between various
 159 forms and their components printed out. \fBNote\fR this command uses the
 160 traditional SSLeay compatible format for private key encryption: newer
 161 applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
 162 utility.
 163 .SH "COMMAND OPTIONS"
 164 .IX Header "COMMAND OPTIONS"
 165 .IP "\fB\-inform DER|NET|PEM\fR" 4
 166 .IX Item "-inform DER|NET|PEM"
 167 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
 168 form compatible with the PKCS#1 RSAPrivateKey or SubjectPublicKeyInfo format.
 169 The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
 170 encoded with additional header and footer lines. On input PKCS#8 format private
 171 keys are also accepted. The \fB\s-1NET\s0\fR form is a format is described in the \fB\s-1NOTES\s0\fR
 172 section.
 173 .IP "\fB\-outform DER|NET|PEM\fR" 4
 174 .IX Item "-outform DER|NET|PEM"
 175 This specifies the output format, the options have the same meaning as the
 176 \&\fB\-inform\fR option.
 177 .IP "\fB\-in filename\fR" 4
 178 .IX Item "-in filename"
 179 This specifies the input filename to read a key from or standard input if this
 180 option is not specified. If the key is encrypted a pass phrase will be
 181 prompted for.
 182 .IP "\fB\-passin arg\fR" 4
 183 .IX Item "-passin arg"
 184 the input file password source. For more information about the format of \fBarg\fR
 185 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 186 .IP "\fB\-out filename\fR" 4
 187 .IX Item "-out filename"
 188 This specifies the output filename to write a key to or standard output if this
 189 option is not specified. If any encryption options are set then a pass phrase
 190 will be prompted for. The output filename should \fBnot\fR be the same as the input
 191 filename.
 192 .IP "\fB\-passout password\fR" 4
 193 .IX Item "-passout password"
 194 the output file password source. For more information about the format of \fBarg\fR
 195 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 196 .IP "\fB\-sgckey\fR" 4
 197 .IX Item "-sgckey"
 198 use the modified \s-1NET\s0 algorithm used with some versions of Microsoft \s-1IIS\s0 and \s-1SGC\s0
 199 keys.
 200 .IP "\fB\-des|\-des3|\-idea\fR" 4
 201 .IX Item "-des|-des3|-idea"
 202 These options encrypt the private key with the \s-1DES\s0, triple \s-1DES\s0, or the
 203 \&\s-1IDEA\s0 ciphers respectively before outputting it. A pass phrase is prompted for.
 204 If none of these options is specified the key is written in plain text. This
 205 means that using the \fBrsa\fR utility to read in an encrypted key with no
 206 encryption option can be used to remove the pass phrase from a key, or by
 207 setting the encryption options it can be use to add or change the pass phrase.
 208 These options can only be used with \s-1PEM\s0 format output files.
 209 .IP "\fB\-text\fR" 4
 210 .IX Item "-text"
 211 prints out the various public or private key components in
 212 plain text in addition to the encoded version.
 213 .IP "\fB\-noout\fR" 4
 214 .IX Item "-noout"
 215 this option prevents output of the encoded version of the key.
 216 .IP "\fB\-modulus\fR" 4
 217 .IX Item "-modulus"
 218 this option prints out the value of the modulus of the key.
 219 .IP "\fB\-check\fR" 4
 220 .IX Item "-check"
 221 this option checks the consistency of an \s-1RSA\s0 private key.
 222 .IP "\fB\-pubin\fR" 4
 223 .IX Item "-pubin"
 224 by default a private key is read from the input file: with this
 225 option a public key is read instead.
 226 .IP "\fB\-pubout\fR" 4
 227 .IX Item "-pubout"
 228 by default a private key is output: with this option a public
 229 key will be output instead. This option is automatically set if
 230 the input is a public key.
 231 .IP "\fB\-RSAPublicKey_in\fR, \fB\-RSAPublicKey_out\fR" 4
 232 .IX Item "-RSAPublicKey_in, -RSAPublicKey_out"
 233 like \fB\-pubin\fR and \fB\-pubout\fR except \fBRSAPublicKey\fR format is used instead.
 234 .IP "\fB\-engine id\fR" 4
 235 .IX Item "-engine id"
 236 specifying an engine (by its unique \fBid\fR string) will cause \fBrsa\fR
 237 to attempt to obtain a functional reference to the specified engine,
 238 thus initialising it if needed. The engine will then be set as the default
 239 for all available algorithms.
 240 .SH "NOTES"
 241 .IX Header "NOTES"
 242 The \s-1PEM\s0 private key format uses the header and footer lines:
 243 .PP
 244 .Vb 2
 245 \& \-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-
 246 \& \-\-\-\-\-END RSA PRIVATE KEY\-\-\-\-\-
 247 .Ve
 248 .PP
 249 The \s-1PEM\s0 public key format uses the header and footer lines:
 250 .PP
 251 .Vb 2
 252 \& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-
 253 \& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\-
 254 .Ve
 255 .PP
 256 The \s-1PEM\s0 \fBRSAPublicKey\fR format uses the header and footer lines:
 257 .PP
 258 .Vb 2
 259 \& \-\-\-\-\-BEGIN RSA PUBLIC KEY\-\-\-\-\-
 260 \& \-\-\-\-\-END RSA PUBLIC KEY\-\-\-\-\-
 261 .Ve
 262 .PP
 263 The \fB\s-1NET\s0\fR form is a format compatible with older Netscape servers
 264 and Microsoft \s-1IIS\s0 .key files, this uses unsalted \s-1RC4\s0 for its encryption.
 265 It is not very secure and so should only be used when necessary.
 266 .PP
 267 Some newer version of \s-1IIS\s0 have additional data in the exported .key
 268 files. To use these with the utility, view the file with a binary editor
 269 and look for the string \*(L"private-key\*(R", then trace back to the byte
 270 sequence 0x30, 0x82 (this is an \s-1ASN1\s0 \s-1SEQUENCE\s0). Copy all the data
 271 from this point onwards to another file and use that as the input
 272 to the \fBrsa\fR utility with the \fB\-inform \s-1NET\s0\fR option. If you get
 273 an error after entering the password try the \fB\-sgckey\fR option.
 274 .SH "EXAMPLES"
 275 .IX Header "EXAMPLES"
 276 To remove the pass phrase on an \s-1RSA\s0 private key:
 277 .PP
 278 .Vb 1
 279 \& openssl rsa \-in key.pem \-out keyout.pem
 280 .Ve
 281 .PP
 282 To encrypt a private key using triple \s-1DES:\s0
 283 .PP
 284 .Vb 1
 285 \& openssl rsa \-in key.pem \-des3 \-out keyout.pem
 286 .Ve
 287 .PP
 288 To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
 289 .PP
 290 .Vb 1
 291 \& openssl rsa \-in key.pem \-outform DER \-out keyout.der
 292 .Ve
 293 .PP
 294 To print out the components of a private key to standard output:
 295 .PP
 296 .Vb 1
 297 \& openssl rsa \-in key.pem \-text \-noout
 298 .Ve
 299 .PP
 300 To just output the public part of a private key:
 301 .PP
 302 .Vb 1
 303 \& openssl rsa \-in key.pem \-pubout \-out pubkey.pem
 304 .Ve
 305 .PP
 306 Output the public part of a private key in \fBRSAPublicKey\fR format:
 307 .PP
 308 .Vb 1
 309 \& openssl rsa \-in key.pem \-RSAPublicKey_out \-out pubkey.pem
 310 .Ve
 311 .SH "BUGS"
 312 .IX Header "BUGS"
 313 The command line password arguments don't currently work with
 314 \&\fB\s-1NET\s0\fR format.
 315 .PP
 316 There should be an option that automatically handles .key files,
 317 without having to manually edit them.
 318 .SH "SEE ALSO"
 319 .IX Header "SEE ALSO"
 320 \&\fIpkcs8\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
 321 \&\fIgendsa\fR\|(1)