1 .\" Automatically generated by Pod::Man 2.16 (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 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
134 .IX Title "RSA_generate_key 3"
135 .TH RSA_generate_key 3 "2010-02-27" "0.9.8m" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 RSA_generate_key \- generate RSA key pair
143 .IX Header "SYNOPSIS"
145 \& #include <openssl/rsa.h>
147 \& RSA *RSA_generate_key(int num, unsigned long e,
148 \& void (*callback)(int,int,void *), void *cb_arg);
151 .IX Header "DESCRIPTION"
152 \&\fIRSA_generate_key()\fR generates a key pair and returns it in a newly
153 allocated \fB\s-1RSA\s0\fR structure. The pseudo-random number generator must
154 be seeded prior to calling \fIRSA_generate_key()\fR.
156 The modulus size will be \fBnum\fR bits, and the public exponent will be
157 \&\fBe\fR. Key sizes with \fBnum\fR < 1024 should be considered insecure.
158 The exponent is an odd number, typically 3, 17 or 65537.
160 A callback function may be used to provide feedback about the
161 progress of the key generation. If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it
162 will be called as follows:
164 While a random prime number is generated, it is called as
165 described in \fIBN_generate_prime\fR\|(3).
167 When the n\-th randomly generated prime is rejected as not
168 suitable for the key, \fBcallback(2, n, cb_arg)\fR is called.
170 When a random p has been found with p\-1 relatively prime to \fBe\fR,
171 it is called as \fBcallback(3, 0, cb_arg)\fR.
173 The process is then repeated for prime q with \fBcallback(3, 1, cb_arg)\fR.
175 .IX Header "RETURN VALUE"
176 If key generation fails, \fIRSA_generate_key()\fR returns \fB\s-1NULL\s0\fR; the
177 error codes can be obtained by \fIERR_get_error\fR\|(3).
180 \&\fBcallback(2, x, cb_arg)\fR is used with two different meanings.
182 \&\fIRSA_generate_key()\fR goes into an infinite loop for illegal input values.
184 .IX Header "SEE ALSO"
185 \&\fIERR_get_error\fR\|(3), \fIrand\fR\|(3), \fIrsa\fR\|(3),
186 \&\fIRSA_free\fR\|(3)
189 The \fBcb_arg\fR argument was added in SSLeay 0.9.0.