Allow for bn(64,32) on LP64 platforms.
[openssl.git] / doc / crypto / RSA_generate_key.pod
index cdf527069a43a1de208ef4b52420e979b557b501..52dbb14a537debb5e727a5a03d520f6c60080f01 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RSA_generate_key - Generate RSA key pair
+RSA_generate_key - generate RSA key pair
 
 =head1 SYNOPSIS
 
@@ -19,7 +19,7 @@ be seeded prior to calling RSA_generate_key().
 
 The modulus size will be B<num> bits, and the public exponent will be
 B<e>. Key sizes with B<num> E<lt> 1024 should be considered insecure.
-The exponent is an odd number, typically 3 or 65535.
+The exponent is an odd number, typically 3, 17 or 65537.
 
 A callback function may be used to provide feedback about the
 progress of the key generation. If B<callback> is not B<NULL>, it
@@ -30,7 +30,7 @@ will be called as follows:
 =item *
 
 While a random prime number is generated, it is called as
-described in L<BN_generate_prime(3)>.
+described in L<BN_generate_prime(3)|BN_generate_prime(3)>.
 
 =item *
 
@@ -46,10 +46,10 @@ it is called as B<callback(3, 0, cb_arg)>.
 
 The process is then repeated for prime q with B<callback(3, 1, cb_arg)>.
 
-=head1 RETURN VALUES
+=head1 RETURN VALUE
 
 If key generation fails, RSA_generate_key() returns B<NULL>; the
-error codes can be obtained by ERR_get_error(3).
+error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
 
 =head1 BUGS
 
@@ -59,7 +59,8 @@ RSA_generate_key() goes into an infinite loop for illegal input values.
 
 =head1 SEE ALSO
 
-err(3), rand(3), rsa(3), RSA_free(3)
+L<ERR_get_error(3)|ERR_get_error(3)>, L<rand(3)|rand(3)>, L<rsa(3)|rsa(3)>,
+L<RSA_free(3)|RSA_free(3)>
 
 =head1 HISTORY