genrsa.pod 2.7 KB
Newer Older
1 2 3 4 5 6 7 8 9
=pod

=head1 NAME

genrsa - generate an RSA private key

=head1 SYNOPSIS

B<openssl> B<genrsa>
10
[B<-help>]
11
[B<-out filename>]
D
Dr. Stephen Henson 已提交
12
[B<-passout arg>]
13 14 15 16 17 18
[B<-aes128>]
[B<-aes192>]
[B<-aes256>]
[B<-camellia128>]
[B<-camellia192>]
[B<-camellia256>]
19 20 21 22 23
[B<-des>]
[B<-des3>]
[B<-idea>]
[B<-f4>]
[B<-3>]
24
[B<-rand file(s)>]
25
[B<-engine id>]
26 27 28 29 30 31 32 33 34 35
[B<numbits>]

=head1 DESCRIPTION

The B<genrsa> command generates an RSA private key.

=head1 OPTIONS

=over 4

36 37 38 39
=item B<-help>

Print out a usage message.

40 41
=item B<-out filename>

42 43
Output the key to the specified file. If this argument is not specified then
standard output is used.
44

D
Dr. Stephen Henson 已提交
45
=item B<-passout arg>
46

D
Dr. Stephen Henson 已提交
47
the output file password source. For more information about the format of B<arg>
R
Rich Salz 已提交
48
see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
49

50
=item B<-aes128|-aes192|-aes256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea>
51

52 53
These options encrypt the private key with specified
cipher before outputting it. If none of these options is
54
specified no encryption is used. If encryption is used a pass phrase is prompted
D
Dr. Stephen Henson 已提交
55
for if it is not supplied via the B<-passout> argument.
56 57 58 59 60

=item B<-F4|-3>

the public exponent to use, either 65537 or 3. The default is 65537.

61
=item B<-rand file(s)>
62 63

a file or files containing random data used to seed the random number
R
Rich Salz 已提交
64
generator, or an EGD socket (see L<RAND_egd(3)>).
A
Alex Gaynor 已提交
65
Multiple files can be specified separated by an OS-dependent character.
R
Richard Levitte 已提交
66
The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
U
Ulf Möller 已提交
67
all others.
68 69 70

=item B<-engine id>

D
Dr. Stephen Henson 已提交
71
specifying an engine (by its unique B<id> string) will cause B<genrsa>
72 73 74
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
for all available algorithms.
75 76 77 78 79 80 81 82 83 84 85 86

=item B<numbits>

the size of the private key to generate in bits. This must be the last option
specified. The default is 512.

=back

=head1 NOTES

RSA private key generation essentially involves the generation of two prime
numbers. When generating a private key various symbols will be output to
D
Dr. Stephen Henson 已提交
87 88 89 90
indicate the progress of the generation. A B<.> represents each number which
has passed an initial sieve test, B<+> means a number has passed a single
round of the Miller-Rabin primality test. A newline means that the number has
passed all the prime tests (the actual number depends on the key size).
91 92 93 94 95 96 97 98 99 100 101 102 103

Because key generation is a random process the time taken to generate a key
may vary somewhat.

=head1 BUGS

A quirk of the prime generation algorithm is that it cannot generate small
primes. Therefore the number of bits should not be less that 64. For typical
private keys this will not matter because for security reasons they will
be much larger (typically 1024 bits).

=head1 SEE ALSO

R
Rich Salz 已提交
104
L<gendsa(1)>
U
Ulf Möller 已提交
105 106

=cut