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