ispell (and minor modifications)
[openssl.git] / doc / apps / genrsa.pod
1 =pod
2
3 =head1 NAME
4
5 genrsa - generate an RSA private key
6
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<genrsa>
11 [B<-out filename>]
12 [B<-des>]
13 [B<-des3>]
14 [B<-idea>]
15 [B<-f4>]
16 [B<-3>]
17 [B<-rand file(s)>]
18 [B<numbits>]
19
20 =head1 DESCRIPTION
21
22 The B<genrsa> command generates an RSA private key.
23
24 =head1 OPTIONS
25
26 =over 4
27
28 =item B<-des|-des3|-idea>
29
30 These options encrypt the private key with the DES, triple DES, or the 
31 IDEA ciphers respectively before outputting it. A pass phrase is prompted for.
32 If none of these options is specified no encryption is used.
33
34 =item B<-F4|-3>
35
36 the public exponent to use, either 65537 or 3. The default is 65537.
37
38 =item B<-rand file(s)>
39
40 a file or files containing random data used to seed the random number
41 generator. Multiple files can be specified separated by a OS-dependent
42 character.  For MS-Windows, the separator is B<;>.  For OpenVMS, it's
43 B<,>.  For all others, it's B<:>.
44
45 =item B<numbits>
46
47 the size of the private key to generate in bits. This must be the last option
48 specified. The default is 512.
49
50 =back
51
52 =head1 NOTES
53
54 RSA private key generation essentially involves the generation of two prime
55 numbers. When generating a private key various symbols will be output to
56 indicate the progress of the generation. A B<.> represents each number tested.
57 A B<+> means a number has passed a single primality test. A newline means that
58 the number has passed all the prime tests (currently set to 5 single tests).
59
60 Because key generation is a random process the time taken to generate a key
61 may vary somewhat.
62
63 =head1 BUGS
64
65 A quirk of the prime generation algorithm is that it cannot generate small
66 primes. Therefore the number of bits should not be less that 64. For typical
67 private keys this will not matter because for security reasons they will
68 be much larger (typically 1024 bits).
69
70 =head1 SEE ALSO
71
72 L<gendsa(1)|gendsa(1)>