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

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