doc/apps/rsa.pod

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