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