doc/apps/rsa.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 rsa - RSA key processing tool
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<rsa>
  10 [B<-help>]
  11 [B<-inform PEM|NET|DER>]
  12 [B<-outform PEM|NET|DER>]
  13 [B<-in filename>]
  14 [B<-passin arg>]
  15 [B<-out filename>]
  16 [B<-passout arg>]
  17 [B<-aes128>]
  18 [B<-aes192>]
  19 [B<-aes256>]
  20 [B<-camellia128>]
  21 [B<-camellia192>]
  22 [B<-camellia256>]
  23 [B<-des>]
  24 [B<-des3>]
  25 [B<-idea>]
  26 [B<-text>]
  27 [B<-noout>]
  28 [B<-modulus>]
  29 [B<-check>]
  30 [B<-pubin>]
  31 [B<-pubout>]
  32 [B<-RSAPublicKey_in>]
  33 [B<-RSAPublicKey_out>]
  34 [B<-engine id>]
  35
  36 =head1 DESCRIPTION
  37
  38 The B<rsa> command processes RSA keys. They can be converted between various
  39 forms and their components printed out. B<Note> this command uses the
  40 traditional SSLeay compatible format for private key encryption: newer
  41 applications should use the more secure PKCS#8 format using the B<pkcs8>
  42 utility.
  43
  44 =head1 COMMAND OPTIONS
  45
  46 =over 4
  47
  48 =item B<-help>
  49
  50 Print out a usage message.
  51
  52 =item B<-inform DER|NET|PEM>
  53
  54 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
  55 form compatible with the PKCS#1 RSAPrivateKey or SubjectPublicKeyInfo format.
  56 The B<PEM> form is the default format: it consists of the B<DER> format base64
  57 encoded with additional header and footer lines. On input PKCS#8 format private
  58 keys are also accepted. The B<NET> form is a format is described in the B<NOTES>
  59 section.
  60
  61 =item B<-outform DER|NET|PEM>
  62
  63 This specifies the output format, the options have the same meaning as the
  64 B<-inform> option.
  65
  66 =item B<-in filename>
  67
  68 This specifies the input filename to read a key from or standard input if this
  69 option is not specified. If the key is encrypted a pass phrase will be
  70 prompted for.
  71
  72 =item B<-passin arg>
  73
  74 the input file password source. For more information about the format of B<arg>
  75 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  76
  77 =item B<-out filename>
  78
  79 This specifies the output filename to write a key to or standard output if this
  80 option is not specified. If any encryption options are set then a pass phrase
  81 will be prompted for. The output filename should B<not> be the same as the input
  82 filename.
  83
  84 =item B<-passout password>
  85
  86 the output file password source. For more information about the format of B<arg>
  87 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  88
  89 =item B<-aes128|-aes192|-aes256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea>
  90
  91 These options encrypt the private key with the specified
  92 cipher before outputting it. A pass phrase is prompted for.
  93 If none of these options is specified the key is written in plain text. This
  94 means that using the B<rsa> utility to read in an encrypted key with no
  95 encryption option can be used to remove the pass phrase from a key, or by
  96 setting the encryption options it can be use to add or change the pass phrase.
  97 These options can only be used with PEM format output files.
  98
  99 =item B<-text>
 100
 101 prints out the various public or private key components in
 102 plain text in addition to the encoded version.
 103
 104 =item B<-noout>
 105
 106 this option prevents output of the encoded version of the key.
 107
 108 =item B<-modulus>
 109
 110 this option prints out the value of the modulus of the key.
 111
 112 =item B<-check>
 113
 114 this option checks the consistency of an RSA private key.
 115
 116 =item B<-pubin>
 117
 118 by default a private key is read from the input file: with this
 119 option a public key is read instead.
 120
 121 =item B<-pubout>
 122
 123 by default a private key is output: with this option a public
 124 key will be output instead. This option is automatically set if
 125 the input is a public key.
 126
 127 =item B<-RSAPublicKey_in>, B<-RSAPublicKey_out>
 128
 129 like B<-pubin> and B<-pubout> except B<RSAPublicKey> format is used instead.
 130
 131 =item B<-engine id>
 132
 133 specifying an engine (by its unique B<id> string) will cause B<rsa>
 134 to attempt to obtain a functional reference to the specified engine,
 135 thus initialising it if needed. The engine will then be set as the default
 136 for all available algorithms.
 137
 138 =back
 139
 140 =head1 NOTES
 141
 142 The PEM private key format uses the header and footer lines:
 143
 144  -----BEGIN RSA PRIVATE KEY-----
 145  -----END RSA PRIVATE KEY-----
 146
 147 The PEM public key format uses the header and footer lines:
 148
 149  -----BEGIN PUBLIC KEY-----
 150  -----END PUBLIC KEY-----
 151
 152 The PEM B<RSAPublicKey> format uses the header and footer lines:
 153
 154  -----BEGIN RSA PUBLIC KEY-----
 155  -----END RSA PUBLIC KEY-----
 156
 157 The B<NET> form is a format compatible with older Netscape servers
 158 and Microsoft IIS .key files, this uses unsalted RC4 for its encryption.
 159 It is not very secure and so should only be used when necessary.
 160
 161 Some newer version of IIS have additional data in the exported .key
 162 files. To use these with the utility, view the file with a binary editor
 163 and look for the string "private-key", then trace back to the byte
 164 sequence 0x30, 0x82 (this is an ASN1 SEQUENCE). Copy all the data
 165 from this point onwards to another file and use that as the input
 166 to the B<rsa> utility with the B<-inform NET> option.
 167
 168 =head1 EXAMPLES
 169
 170 To remove the pass phrase on an RSA private key:
 171
 172  openssl rsa -in key.pem -out keyout.pem
 173
 174 To encrypt a private key using triple DES:
 175
 176  openssl rsa -in key.pem -des3 -out keyout.pem
 177
 178 To convert a private key from PEM to DER format:
 179
 180  openssl rsa -in key.pem -outform DER -out keyout.der
 181
 182 To print out the components of a private key to standard output:
 183
 184  openssl rsa -in key.pem -text -noout
 185
 186 To just output the public part of a private key:
 187
 188  openssl rsa -in key.pem -pubout -out pubkey.pem
 189
 190 Output the public part of a private key in B<RSAPublicKey> format:
 191
 192  openssl rsa -in key.pem -RSAPublicKey_out -out pubkey.pem
 193
 194 =head1 BUGS
 195
 196 The command line password arguments don't currently work with
 197 B<NET> format.
 198
 199 There should be an option that automatically handles .key files,
 200 without having to manually edit them.
 201
 202 =head1 SEE ALSO
 203
 204 L<pkcs8(1)>, L<dsa(1)>, L<genrsa(1)>,
 205 L<gendsa(1)>
 206
 207 =cut
 208
 209 =head1 COPYRIGHT
 210
 211 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 212
 213 Licensed under the OpenSSL license (the "License").  You may not use
 214 this file except in compliance with the License.  You can obtain a copy
 215 in the file LICENSE in the source distribution or at
 216 L<https://www.openssl.org/source/license.html>.
 217
 218 =cut