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