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

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