1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
124 .\" ========================================================================
126 .IX Title "RSA_generate_key 3"
127 .TH RSA_generate_key 3 "2007-10-24" "0.9.8g" "OpenSSL"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 RSA_generate_key \- generate RSA key pair
135 .IX Header "SYNOPSIS"
137 \& #include <openssl/rsa.h>
139 \& RSA *RSA_generate_key(int num, unsigned long e,
140 \& void (*callback)(int,int,void *), void *cb_arg);
143 .IX Header "DESCRIPTION"
144 \&\fIRSA_generate_key()\fR generates a key pair and returns it in a newly
145 allocated \fB\s-1RSA\s0\fR structure. The pseudo-random number generator must
146 be seeded prior to calling \fIRSA_generate_key()\fR.
148 The modulus size will be \fBnum\fR bits, and the public exponent will be
149 \&\fBe\fR. Key sizes with \fBnum\fR < 1024 should be considered insecure.
150 The exponent is an odd number, typically 3, 17 or 65537.
152 A callback function may be used to provide feedback about the
153 progress of the key generation. If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it
154 will be called as follows:
156 While a random prime number is generated, it is called as
157 described in \fIBN_generate_prime\fR\|(3).
159 When the n\-th randomly generated prime is rejected as not
160 suitable for the key, \fBcallback(2, n, cb_arg)\fR is called.
162 When a random p has been found with p\-1 relatively prime to \fBe\fR,
163 it is called as \fBcallback(3, 0, cb_arg)\fR.
165 The process is then repeated for prime q with \fBcallback(3, 1, cb_arg)\fR.
167 .IX Header "RETURN VALUE"
168 If key generation fails, \fIRSA_generate_key()\fR returns \fB\s-1NULL\s0\fR; the
169 error codes can be obtained by \fIERR_get_error\fR\|(3).
172 \&\fBcallback(2, x, cb_arg)\fR is used with two different meanings.
174 \&\fIRSA_generate_key()\fR goes into an infinite loop for illegal input values.
176 .IX Header "SEE ALSO"
177 \&\fIERR_get_error\fR\|(3), \fIrand\fR\|(3), \fIrsa\fR\|(3),
178 \&\fIRSA_free\fR\|(3)
181 The \fBcb_arg\fR argument was added in SSLeay 0.9.0.