aboutsummaryrefslogtreecommitdiffstats
path: root/doc/apps/genrsa.pod
diff options
context:
space:
mode:
authorDr. Stephen Henson <steve@openssl.org>2000-01-21 02:17:04 +0000
committerDr. Stephen Henson <steve@openssl.org>2000-01-21 02:17:04 +0000
commitdd46d58f65bd3a342bbcd8586680942be643fc7d (patch)
treef573df02bef40f2fcc2f81b0aa89f37b0f40819f /doc/apps/genrsa.pod
parente7f97e2d22e386df60c8da63277727a931bf22b7 (diff)
downloadopenssl-dd46d58f65bd3a342bbcd8586680942be643fc7d.tar.gz
Change the 'man' directory to 'apps'. Yes I wish cvs
could rename too :-(
Diffstat (limited to 'doc/apps/genrsa.pod')
-rw-r--r--doc/apps/genrsa.pod72
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/apps/genrsa.pod b/doc/apps/genrsa.pod
new file mode 100644
index 0000000000..b224bd1fc8
--- /dev/null
+++ b/doc/apps/genrsa.pod
@@ -0,0 +1,72 @@
+=pod
+
+=head1 NAME
+
+genrsa - generate an RSA private key
+
+
+=head1 SYNOPSIS
+
+B<openssl> B<genrsa>
+[B<-out filename>]
+[B<-des>]
+[B<-des3>]
+[B<-idea>]
+[B<-f4>]
+[B<-3>]
+[B<-rand file(s)>]
+[B<numbits>]
+
+=head1 DESCRIPTION
+
+The B<genrsa> command generates an RSA private key.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-des|-des3|-idea>
+
+These options encrypt the private key with the DES, triple DES, or the
+IDEA ciphers respectively before outputting it. A pass phrase is prompted for.
+If none of these options is specified no encryption is used.
+
+=item B<-F4|-3>
+
+the public exponent to use, either 65537 or 3. The default is 65537.
+
+=item B<-rand file(s)>
+
+a file or files containing random data used to seed the random number
+generator. Multiple files can be specified separated by a OS-dependent
+character. For MS-Windows, the separator is B<;>. For OpenVMS, it's
+B<,>. For all others, it's B<:>.
+
+=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
+indicate the progress of the generation. A B<.> represents each number tested.
+A B<+> means a number has passed a single primality test. A newline means that
+the number has passed all the prime tests (currently set to 5 single tests).
+
+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
+
+gendsa(1)