16b887be994cf8fdf0af781e95178a26f35068d9
[openssl.git] / doc / man1 / openssl-genrsa.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-genrsa - generate an RSA private key
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<genrsa>
11 [B<-help>]
12 [B<-out> I<filename>]
13 [B<-passout> I<arg>]
14 [B<-aes128>]
15 [B<-aes192>]
16 [B<-aes256>]
17 [B<-aria128>]
18 [B<-aria192>]
19 [B<-aria256>]
20 [B<-camellia128>]
21 [B<-camellia192>]
22 [B<-camellia256>]
23 [B<-des>]
24 [B<-des3>]
25 [B<-idea>]
26 [B<-f4>|B<-3>]
27 [B<-engine> I<id>]
28 [B<-primes> I<num>]
29 [B<-verbose>]
30 {- $OpenSSL::safe::opt_r_synopsis -}
31 [B<numbits>]
32
33 =for openssl ifdef engine
34
35 =head1 DESCRIPTION
36
37 This command generates an RSA private key.
38
39 =head1 OPTIONS
40
41 =over 4
42
43 =item B<-help>
44
45 Print out a usage message.
46
47 =item B<-out> I<filename>
48
49 Output the key to the specified file. If this argument is not specified then
50 standard output is used.
51
52 =item B<-passout> I<arg>
53
54 The output file password source. For more information about the format
55 see L<openssl(1)/Pass Phrase Options>.
56
57 =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>
58
59 These options encrypt the private key with specified
60 cipher before outputting it. If none of these options is
61 specified no encryption is used. If encryption is used a pass phrase is prompted
62 for if it is not supplied via the B<-passout> argument.
63
64 =item B<-F4>|B<-3>
65
66 The public exponent to use, either 65537 or 3. The default is 65537.
67
68 =item B<-engine> I<id>
69
70 Specifying an engine (by its unique I<id> string) will cause this command
71 to attempt to obtain a functional reference to the specified engine,
72 thus initialising it if needed. The engine will then be set as the default
73 for all available algorithms.
74
75 =item B<-primes> I<num>
76
77 Specify the number of primes to use while generating the RSA key. The I<num>
78 parameter must be a positive integer that is greater than 1 and less than 16.
79 If I<num> is greater than 2, then the generated key is called a 'multi-prime'
80 RSA key, which is defined in RFC 8017.
81
82 =item B<-verbose>
83
84 Print extra details about the operations being performed.
85
86 {- $OpenSSL::safe::opt_r_item -}
87
88 =item B<numbits>
89
90 The size of the private key to generate in bits. This must be the last option
91 specified. The default is 2048 and values less than 512 are not allowed.
92
93 =back
94
95 =head1 NOTES
96
97 RSA private key generation essentially involves the generation of two or more
98 prime numbers. When generating a private key various symbols will be output to
99 indicate the progress of the generation. A B<.> represents each number which
100 has passed an initial sieve test, B<+> means a number has passed a single
101 round of the Miller-Rabin primality test, B<*> means the current prime starts
102 a regenerating progress due to some failed tests. A newline means that the number
103 has passed all the prime tests (the actual number depends on the key size).
104
105 Because key generation is a random process the time taken to generate a key
106 may vary somewhat. But in general, more primes lead to less generation time
107 of a key.
108
109 =head1 SEE ALSO
110
111 L<openssl(1)>,
112 L<openssl-gendsa(1)>
113
114 =head1 COPYRIGHT
115
116 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
117
118 Licensed under the Apache License 2.0 (the "License").  You may not use
119 this file except in compliance with the License.  You can obtain a copy
120 in the file LICENSE in the source distribution or at
121 L<https://www.openssl.org/source/license.html>.
122
123 =cut