summaryrefslogtreecommitdiffstats
path: root/secure/lib/libcrypto/man/RSA_generate_key.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/RSA_generate_key.3')
-rw-r--r--secure/lib/libcrypto/man/RSA_generate_key.357
1 files changed, 24 insertions, 33 deletions
diff --git a/secure/lib/libcrypto/man/RSA_generate_key.3 b/secure/lib/libcrypto/man/RSA_generate_key.3
index b794c2d..b32411f 100644
--- a/secure/lib/libcrypto/man/RSA_generate_key.3
+++ b/secure/lib/libcrypto/man/RSA_generate_key.3
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Mar 17 09:38:38 2004
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" Standard preamble:
-.\" ======================================================================
+.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
@@ -15,12 +14,6 @@
.if t .sp .5v
.if n .sp
..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
.de Vb \" Begin verbatim text
.ft CW
.nf
@@ -28,15 +21,14 @@
..
.de Ve \" End verbatim text
.ft R
-
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
-.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
-.\" to do unbreakable dashes and therefore won't be available. \*(C` and
-.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
@@ -56,10 +48,10 @@
. ds R" ''
'br\}
.\"
-.\" If the F register is turned on, we'll generate index entries on stderr
-.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
-.\" index entries marked with X<> in POD. Of course, you'll have to process
-.\" the output yourself in some meaningful fashion.
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
@@ -68,14 +60,13 @@
. rr F
.\}
.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it
-.\" makes way too many mistakes in technical documents.
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
-.bd B 3
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
@@ -135,18 +126,18 @@
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
-.\" ======================================================================
+.\" ========================================================================
.\"
.IX Title "RSA_generate_key 3"
-.TH RSA_generate_key 3 "0.9.7d" "2004-03-17" "OpenSSL"
-.UC
+.TH RSA_generate_key 3 "2005-02-24" "0.9.7d" "OpenSSL"
.SH "NAME"
-RSA_generate_key \- generate \s-1RSA\s0 key pair
+RSA_generate_key \- generate RSA key pair
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/rsa.h>
.Ve
+.PP
.Vb 2
\& RSA *RSA_generate_key(int num, unsigned long e,
\& void (*callback)(int,int,void *), void *cb_arg);
@@ -164,21 +155,21 @@ 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 \fBcallback\fR is not \fB\s-1NULL\s0\fR, it
will be called as follows:
-.Ip "\(bu" 4
+.IP "\(bu" 4
While a random prime number is generated, it is called as
-described in BN_generate_prime(3).
-.Ip "\(bu" 4
-When the n-th randomly generated prime is rejected as not
+described in \fIBN_generate_prime\fR\|(3).
+.IP "\(bu" 4
+When the n\-th randomly generated prime is rejected as not
suitable for the key, \fBcallback(2, n, cb_arg)\fR is called.
-.Ip "\(bu" 4
-When a random p has been found with p-1 relatively prime to \fBe\fR,
+.IP "\(bu" 4
+When a random p has been found with p\-1 relatively prime to \fBe\fR,
it is called as \fBcallback(3, 0, cb_arg)\fR.
.PP
The process is then repeated for prime q with \fBcallback(3, 1, cb_arg)\fR.
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
If key generation fails, \fIRSA_generate_key()\fR returns \fB\s-1NULL\s0\fR; the
-error codes can be obtained by ERR_get_error(3).
+error codes can be obtained by \fIERR_get_error\fR\|(3).
.SH "BUGS"
.IX Header "BUGS"
\&\fBcallback(2, x, cb_arg)\fR is used with two different meanings.
@@ -186,8 +177,8 @@ error codes can be obtained by ERR_get_error(3).
\&\fIRSA_generate_key()\fR goes into an infinite loop for illegal input values.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-ERR_get_error(3), rand(3), rsa(3),
-RSA_free(3)
+\&\fIERR_get_error\fR\|(3), \fIrand\fR\|(3), \fIrsa\fR\|(3),
+\&\fIRSA_free\fR\|(3)
.SH "HISTORY"
.IX Header "HISTORY"
The \fBcb_arg\fR argument was added in SSLeay 0.9.0.
OpenPOWER on IntegriCloud