1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Tue Jul 30 09:21:50 2002
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
138 .\" ======================================================================
140 .IX Title "RSA_generate_key 3"
141 .TH RSA_generate_key 3 "0.9.6e" "2002-07-30" "OpenSSL"
144 RSA_generate_key \- generate \s-1RSA\s0 key pair
146 .IX Header "SYNOPSIS"
148 \& #include <openssl/rsa.h>
151 \& RSA *RSA_generate_key(int num, unsigned long e,
152 \& void (*callback)(int,int,void *), void *cb_arg);
155 .IX Header "DESCRIPTION"
156 \&\fIRSA_generate_key()\fR generates a key pair and returns it in a newly
157 allocated \fB\s-1RSA\s0\fR structure. The pseudo-random number generator must
158 be seeded prior to calling \fIRSA_generate_key()\fR.
160 The modulus size will be \fBnum\fR bits, and the public exponent will be
161 \&\fBe\fR. Key sizes with \fBnum\fR < 1024 should be considered insecure.
162 The exponent is an odd number, typically 3, 17 or 65537.
164 A callback function may be used to provide feedback about the
165 progress of the key generation. If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it
166 will be called as follows:
168 While a random prime number is generated, it is called as
169 described in BN_generate_prime(3).
171 When the n-th randomly generated prime is rejected as not
172 suitable for the key, \fBcallback(2, n, cb_arg)\fR is called.
174 When a random p has been found with p-1 relatively prime to \fBe\fR,
175 it is called as \fBcallback(3, 0, cb_arg)\fR.
177 The process is then repeated for prime q with \fBcallback(3, 1, cb_arg)\fR.
179 .IX Header "RETURN VALUE"
180 If key generation fails, \fIRSA_generate_key()\fR returns \fB\s-1NULL\s0\fR; the
181 error codes can be obtained by ERR_get_error(3).
184 \&\fBcallback(2, x, cb_arg)\fR is used with two different meanings.
186 \&\fIRSA_generate_key()\fR goes into an infinite loop for illegal input values.
188 .IX Header "SEE ALSO"
189 err(3), rand(3), rsa(3), RSA_free(3)
192 The \fBcb_arg\fR argument was added in SSLeay 0.9.0.