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

   1 .rn '' }`
   2 ''' $RCSfile$$Revision$$Date$
   3 '''
   4 ''' $Log$
   5 '''
   6 .de Sh
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve
  30 .ft R
  31
  32 .fi
  33 ..
  34 '''
  35 '''
  36 '''     Set up \*(-- to give an unbreakable dash;
  37 '''     string Tr holds user defined translation string.
  38 '''     Bell System Logo is used as a dummy character.
  39 '''
  40 .tr \(*W-|\(bv\*(Tr
  41 .ie n \{\
  42 .ds -- \(*W-
  43 .ds PI pi
  44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  46 .ds L" ""
  47 .ds R" ""
  48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
  49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
  50 '''   such as .IP and .SH, which do another additional levels of
  51 '''   double-quote interpretation
  52 .ds M" """
  53 .ds S" """
  54 .ds N" """""
  55 .ds T" """""
  56 .ds L' '
  57 .ds R' '
  58 .ds M' '
  59 .ds S' '
  60 .ds N' '
  61 .ds T' '
  62 'br\}
  63 .el\{\
  64 .ds -- \(em\|
  65 .tr \*(Tr
  66 .ds L" ``
  67 .ds R" ''
  68 .ds M" ``
  69 .ds S" ''
  70 .ds N" ``
  71 .ds T" ''
  72 .ds L' `
  73 .ds R' '
  74 .ds M' `
  75 .ds S' '
  76 .ds N' `
  77 .ds T' '
  78 .ds PI \(*p
  79 'br\}
  80 .\"     If the F register is turned on, we'll generate
  81 .\"     index entries out stderr for the following things:
  82 .\"             TH      Title
  83 .\"             SH      Header
  84 .\"             Sh      Subsection
  85 .\"             Ip      Item
  86 .\"             X<>     Xref  (embedded
  87 .\"     Of course, you have to process the output yourself
  88 .\"     in some meaninful fashion.
  89 .if \nF \{
  90 .de IX
  91 .tm Index:\\$1\t\\n%\t"\\$2"
  92 ..
  93 .nr % 0
  94 .rr F
  95 .\}
  96 .TH RSA 1 "0.9.7d" "2/Sep/2004" "OpenSSL"
  97 .UC
  98 .if n .hy 0
  99 .if n .na
 100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 101 .de CQ          \" put $1 in typewriter font
 102 .ft CW
 103 'if n "\c
 104 'if t \\&\\$1\c
 105 'if n \\&\\$1\c
 106 'if n \&"
 107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 108 '.ft R
 109 ..
 110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 111 .       \" AM - accent mark definitions
 112 .bd B 3
 113 .       \" fudge factors for nroff and troff
 114 .if n \{\
 115 .       ds #H 0
 116 .       ds #V .8m
 117 .       ds #F .3m
 118 .       ds #[ \f1
 119 .       ds #] \fP
 120 .\}
 121 .if t \{\
 122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 123 .       ds #V .6m
 124 .       ds #F 0
 125 .       ds #[ \&
 126 .       ds #] \&
 127 .\}
 128 .       \" simple accents for nroff and troff
 129 .if n \{\
 130 .       ds ' \&
 131 .       ds ` \&
 132 .       ds ^ \&
 133 .       ds , \&
 134 .       ds ~ ~
 135 .       ds ? ?
 136 .       ds ! !
 137 .       ds /
 138 .       ds q
 139 .\}
 140 .if t \{\
 141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 150 .\}
 151 .       \" troff and (daisy-wheel) nroff accents
 152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 163 .ds ae a\h'-(\w'a'u*4/10)'e
 164 .ds Ae A\h'-(\w'A'u*4/10)'E
 165 .ds oe o\h'-(\w'o'u*4/10)'e
 166 .ds Oe O\h'-(\w'O'u*4/10)'E
 167 .       \" corrections for vroff
 168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 170 .       \" for low resolution devices (crt and lpr)
 171 .if \n(.H>23 .if \n(.V>19 \
 172 \{\
 173 .       ds : e
 174 .       ds 8 ss
 175 .       ds v \h'-1'\o'\(aa\(ga'
 176 .       ds _ \h'-1'^
 177 .       ds . \h'-1'.
 178 .       ds 3 3
 179 .       ds o a
 180 .       ds d- d\h'-1'\(ga
 181 .       ds D- D\h'-1'\(hy
 182 .       ds th \o'bp'
 183 .       ds Th \o'LP'
 184 .       ds ae ae
 185 .       ds Ae AE
 186 .       ds oe oe
 187 .       ds Oe OE
 188 .\}
 189 .rm #[ #] #H #V #F C
 190 .SH "NAME"
 191 rsa \- RSA key processing tool
 192 .SH "SYNOPSIS"
 193 \fBopenssl\fR \fBrsa\fR
 194 [\fB\-inform PEM|NET|DER\fR]
 195 [\fB\-outform PEM|NET|DER\fR]
 196 [\fB\-in filename\fR]
 197 [\fB\-passin arg\fR]
 198 [\fB\-out filename\fR]
 199 [\fB\-passout arg\fR]
 200 [\fB\-sgckey\fR]
 201 [\fB\-des\fR]
 202 [\fB\-des3\fR]
 203 [\fB\-idea\fR]
 204 [\fB\-text\fR]
 205 [\fB\-noout\fR]
 206 [\fB\-modulus\fR]
 207 [\fB\-check\fR]
 208 [\fB\-pubin\fR]
 209 [\fB\-pubout\fR]
 210 [\fB\-engine id\fR]
 211 .SH "DESCRIPTION"
 212 The \fBrsa\fR command processes RSA keys. They can be converted between various
 213 forms and their components printed out. \fBNote\fR this command uses the
 214 traditional SSLeay compatible format for private key encryption: newer
 215 applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
 216 utility.
 217 .SH "COMMAND OPTIONS"
 218 .Ip "\fB\-inform \s-1DER\s0|\s-1NET\s0|\s-1PEM\s0\fR" 4
 219 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
 220 form compatible with the \s-1PKCS\s0#1 RSAPrivateKey or SubjectPublicKeyInfo format.
 221 The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
 222 encoded with additional header and footer lines. On input \s-1PKCS\s0#8 format private
 223 keys are also accepted. The \fB\s-1NET\s0\fR form is a format is described in the \fB\s-1NOTES\s0\fR
 224 section.
 225 .Ip "\fB\-outform \s-1DER\s0|\s-1NET\s0|\s-1PEM\s0\fR" 4
 226 This specifies the output format, the options have the same meaning as the
 227 \fB\-inform\fR option.
 228 .Ip "\fB\-in filename\fR" 4
 229 This specifies the input filename to read a key from or standard input if this
 230 option is not specified. If the key is encrypted a pass phrase will be
 231 prompted for.
 232 .Ip "\fB\-passin arg\fR" 4
 233 the input file password source. For more information about the format of \fBarg\fR
 234 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in openssl(1).
 235 .Ip "\fB\-out filename\fR" 4
 236 This specifies the output filename to write a key to or standard output if this
 237 option is not specified. If any encryption options are set then a pass phrase
 238 will be prompted for. The output filename should \fBnot\fR be the same as the input
 239 filename.
 240 .Ip "\fB\-passout password\fR" 4
 241 the output file password source. For more information about the format of \fBarg\fR
 242 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in openssl(1).
 243 .Ip "\fB\-sgckey\fR" 4
 244 use the modified \s-1NET\s0 algorithm used with some versions of Microsoft \s-1IIS\s0 and \s-1SGC\s0
 245 keys.
 246 .Ip "\fB\-des|\-des3|\-idea\fR" 4
 247 These options encrypt the private key with the \s-1DES\s0, triple \s-1DES\s0, or the
 248 \s-1IDEA\s0 ciphers respectively before outputting it. A pass phrase is prompted for.
 249 If none of these options is specified the key is written in plain text. This
 250 means that using the \fBrsa\fR utility to read in an encrypted key with no
 251 encryption option can be used to remove the pass phrase from a key, or by
 252 setting the encryption options it can be use to add or change the pass phrase.
 253 These options can only be used with \s-1PEM\s0 format output files.
 254 .Ip "\fB\-text\fR" 4
 255 prints out the various public or private key components in
 256 plain text in addition to the encoded version.
 257 .Ip "\fB\-noout\fR" 4
 258 this option prevents output of the encoded version of the key.
 259 .Ip "\fB\-modulus\fR" 4
 260 this option prints out the value of the modulus of the key.
 261 .Ip "\fB\-check\fR" 4
 262 this option checks the consistency of an \s-1RSA\s0 private key.
 263 .Ip "\fB\-pubin\fR" 4
 264 by default a private key is read from the input file: with this
 265 option a public key is read instead.
 266 .Ip "\fB\-pubout\fR" 4
 267 by default a private key is output: with this option a public
 268 key will be output instead. This option is automatically set if
 269 the input is a public key.
 270 .Ip "\fB\-engine id\fR" 4
 271 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
 272 to attempt to obtain a functional reference to the specified engine,
 273 thus initialising it if needed. The engine will then be set as the default
 274 for all available algorithms.
 275 .SH "NOTES"
 276 The PEM private key format uses the header and footer lines:
 277 .PP
 278 .Vb 2
 279 \& -----BEGIN RSA PRIVATE KEY-----
 280 \& -----END RSA PRIVATE KEY-----
 281 .Ve
 282 The PEM public key format uses the header and footer lines:
 283 .PP
 284 .Vb 2
 285 \& -----BEGIN PUBLIC KEY-----
 286 \& -----END PUBLIC KEY-----
 287 .Ve
 288 The \fBNET\fR form is a format compatible with older Netscape servers
 289 and Microsoft IIS .key files, this uses unsalted RC4 for its encryption.
 290 It is not very secure and so should only be used when necessary.
 291 .PP
 292 Some newer version of IIS have additional data in the exported .key
 293 files. To use these with the utility, view the file with a binary editor
 294 and look for the string \*(L"private-key\*(R", then trace back to the byte
 295 sequence 0x30, 0x82 (this is an ASN1 SEQUENCE). Copy all the data
 296 from this point onwards to another file and use that as the input
 297 to the \fBrsa\fR utility with the \fB\-inform NET\fR option. If you get
 298 an error after entering the password try the \fB\-sgckey\fR option.
 299 .SH "EXAMPLES"
 300 To remove the pass phrase on an RSA private key:
 301 .PP
 302 .Vb 1
 303 \& openssl rsa -in key.pem -out keyout.pem
 304 .Ve
 305 To encrypt a private key using triple DES:
 306 .PP
 307 .Vb 1
 308 \& openssl rsa -in key.pem -des3 -out keyout.pem
 309 .Ve
 310 To convert a private key from PEM to DER format:
 311 .PP
 312 .Vb 1
 313 \& openssl rsa -in key.pem -outform DER -out keyout.der
 314 .Ve
 315 To print out the components of a private key to standard output:
 316 .PP
 317 .Vb 1
 318 \& openssl rsa -in key.pem -text -noout
 319 .Ve
 320 To just output the public part of a private key:
 321 .PP
 322 .Vb 1
 323 \& openssl rsa -in key.pem -pubout -out pubkey.pem
 324 .Ve
 325 .SH "BUGS"
 326 The command line password arguments don't currently work with
 327 \fBNET\fR format.
 328 .PP
 329 There should be an option that automatically handles .key files,
 330 without having to manually edit them.
 331 .SH "SEE ALSO"
 332 pkcs8(1), dsa(1), genrsa(1),
 333 gendsa(1)
 334
 335 .rn }` ''
 336 .IX Title "RSA 1"
 337 .IX Name "rsa - RSA key processing tool"
 338
 339 .IX Header "NAME"
 340
 341 .IX Header "SYNOPSIS"
 342
 343 .IX Header "DESCRIPTION"
 344
 345 .IX Header "COMMAND OPTIONS"
 346
 347 .IX Item "\fB\-inform \s-1DER\s0|\s-1NET\s0|\s-1PEM\s0\fR"
 348
 349 .IX Item "\fB\-outform \s-1DER\s0|\s-1NET\s0|\s-1PEM\s0\fR"
 350
 351 .IX Item "\fB\-in filename\fR"
 352
 353 .IX Item "\fB\-passin arg\fR"
 354
 355 .IX Item "\fB\-out filename\fR"
 356
 357 .IX Item "\fB\-passout password\fR"
 358
 359 .IX Item "\fB\-sgckey\fR"
 360
 361 .IX Item "\fB\-des|\-des3|\-idea\fR"
 362
 363 .IX Item "\fB\-text\fR"
 364
 365 .IX Item "\fB\-noout\fR"
 366
 367 .IX Item "\fB\-modulus\fR"
 368
 369 .IX Item "\fB\-check\fR"
 370
 371 .IX Item "\fB\-pubin\fR"
 372
 373 .IX Item "\fB\-pubout\fR"
 374
 375 .IX Item "\fB\-engine id\fR"
 376
 377 .IX Header "NOTES"
 378
 379 .IX Header "EXAMPLES"
 380
 381 .IX Header "BUGS"
 382
 383 .IX Header "SEE ALSO"
 384