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