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

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