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

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