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