doc/man1/openssl-rsa.pod.in

   1 =pod
   2
   3 =begin comment
   4 {- join("\n", @autowarntext) -}
   5
   6 =end comment
   7
   8 =head1 NAME
   9
  10 openssl-rsa - RSA key processing command
  11
  12 =head1 SYNOPSIS
  13
  14 B<openssl> B<rsa>
  15 [B<-help>]
  16 [B<-inform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
  17 [B<-outform> B<DER>|B<PEM>]
  18 [B<-in> I<filename>]
  19 [B<-passin> I<arg>]
  20 [B<-out> I<filename>]
  21 [B<-passout> I<arg>]
  22 [B<-aes128>]
  23 [B<-aes192>]
  24 [B<-aes256>]
  25 [B<-aria128>]
  26 [B<-aria192>]
  27 [B<-aria256>]
  28 [B<-camellia128>]
  29 [B<-camellia192>]
  30 [B<-camellia256>]
  31 [B<-des>]
  32 [B<-des3>]
  33 [B<-idea>]
  34 [B<-text>]
  35 [B<-noout>]
  36 [B<-modulus>]
  37 [B<-check>]
  38 [B<-pubin>]
  39 [B<-pubout>]
  40 [B<-RSAPublicKey_in>]
  41 [B<-RSAPublicKey_out>]
  42 {- $OpenSSL::safe::opt_engine_synopsis -}
  43 {- $OpenSSL::safe::opt_provider_synopsis -}
  44
  45 =for openssl ifdef pvk-strong pvk-weak pvk-none engine
  46
  47 =head1 DESCRIPTION
  48
  49 This command processes RSA keys. They can be converted between
  50 various forms and their components printed out. B<Note> this command uses the
  51 traditional SSLeay compatible format for private key encryption: newer
  52 applications should use the more secure PKCS#8 format using the
  53 L<openssl-pkcs8(1)> command.
  54
  55 =head1 OPTIONS
  56
  57 =over 4
  58
  59 =item B<-help>
  60
  61 Print out a usage message.
  62
  63
  64 =item B<-inform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
  65
  66 The key input format; the default is B<PEM>.
  67 The only value with effect is B<ENGINE>; all others have become obsolete.
  68 See L<openssl(1)/Format Options> for details.
  69
  70 =item B<-outform> B<DER>|B<PEM>
  71
  72 The key output format; the default is B<PEM>.
  73 See L<openssl(1)/Format Options> for details.
  74
  75 =item B<-inform> B<DER>|B<PEM>
  76
  77 The data is a PKCS#1 B<RSAPrivateKey> or B<SubjectPublicKey> object.
  78 On input, PKCS#8 format private keys are also accepted.
  79
  80 =item B<-in> I<filename>
  81
  82 This specifies the input filename to read a key from or standard input if this
  83 option is not specified. If the key is encrypted a pass phrase will be
  84 prompted for.
  85
  86 =item B<-passin> I<arg>, B<-passout> I<arg>
  87
  88 The password source for the input and output file.
  89 For more information about the format of B<arg>
  90 see L<openssl(1)/Pass Phrase Options>.
  91
  92 =item B<-out> I<filename>
  93
  94 This specifies the output filename to write a key to or standard output if this
  95 option is not specified. If any encryption options are set then a pass phrase
  96 will be prompted for. The output filename should B<not> be the same as the input
  97 filename.
  98
  99 =item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>
 100
 101 These options encrypt the private key with the specified
 102 cipher before outputting it. A pass phrase is prompted for.
 103 If none of these options is specified the key is written in plain text. This
 104 means that this command can be used to remove the pass phrase from a key
 105 by not giving any encryption option is given, or to add or change the pass
 106 phrase by setting them.
 107 These options can only be used with PEM format output files.
 108
 109 =item B<-text>
 110
 111 Prints out the various public or private key components in
 112 plain text in addition to the encoded version.
 113
 114 =item B<-noout>
 115
 116 This option prevents output of the encoded version of the key.
 117
 118 =item B<-modulus>
 119
 120 This option prints out the value of the modulus of the key.
 121
 122 =item B<-check>
 123
 124 This option checks the consistency of an RSA private key.
 125
 126 =item B<-pubin>
 127
 128 By default a private key is read from the input file: with this
 129 option a public key is read instead.
 130
 131 =item B<-pubout>
 132
 133 By default a private key is output: with this option a public
 134 key will be output instead. This option is automatically set if
 135 the input is a public key.
 136
 137 =item B<-RSAPublicKey_in>, B<-RSAPublicKey_out>
 138
 139 Like B<-pubin> and B<-pubout> except B<RSAPublicKey> format is used instead.
 140
 141 {- $OpenSSL::safe::opt_engine_item -}
 142
 143 {- $OpenSSL::safe::opt_provider_item -}
 144
 145 =back
 146
 147 =head1 EXAMPLES
 148
 149 Examples equivalent to these can be found in the documentation for the
 150 non-deprecated L<openssl-pkey(1)> command.
 151
 152 To remove the pass phrase on an RSA private key:
 153
 154  openssl rsa -in key.pem -out keyout.pem
 155
 156 To encrypt a private key using triple DES:
 157
 158  openssl rsa -in key.pem -des3 -out keyout.pem
 159
 160 To convert a private key from PEM to DER format:
 161
 162  openssl rsa -in key.pem -outform DER -out keyout.der
 163
 164 To print out the components of a private key to standard output:
 165
 166  openssl rsa -in key.pem -text -noout
 167
 168 To just output the public part of a private key:
 169
 170  openssl rsa -in key.pem -pubout -out pubkey.pem
 171
 172 Output the public part of a private key in B<RSAPublicKey> format:
 173
 174  openssl rsa -in key.pem -RSAPublicKey_out -out pubkey.pem
 175
 176 =head1 BUGS
 177
 178 There should be an option that automatically handles F<.key> files,
 179 without having to manually edit them.
 180
 181 =head1 SEE ALSO
 182
 183 L<openssl(1)>,
 184 L<openssl-pkey(1)>,
 185 L<openssl-pkcs8(1)>,
 186 L<openssl-dsa(1)>,
 187 L<openssl-genrsa(1)>,
 188 L<openssl-gendsa(1)>
 189
 190 =head1 COPYRIGHT
 191
 192 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 193
 194 Licensed under the Apache License 2.0 (the "License").  You may not use
 195 this file except in compliance with the License.  You can obtain a copy
 196 in the file LICENSE in the source distribution or at
 197 L<https://www.openssl.org/source/license.html>.
 198
 199 =cut