1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
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. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, 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 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "RSA_generate_key 3"
132 .TH RSA_generate_key 3 "2008-09-06" "0.9.8h" "OpenSSL"
134 RSA_generate_key \- generate RSA key pair
136 .IX Header "SYNOPSIS"
138 \& #include <openssl/rsa.h>
142 \& RSA *RSA_generate_key(int num, unsigned long e,
143 \& void (*callback)(int,int,void *), void *cb_arg);
146 .IX Header "DESCRIPTION"
147 \&\fIRSA_generate_key()\fR generates a key pair and returns it in a newly
148 allocated \fB\s-1RSA\s0\fR structure. The pseudo-random number generator must
149 be seeded prior to calling \fIRSA_generate_key()\fR.
151 The modulus size will be \fBnum\fR bits, and the public exponent will be
152 \&\fBe\fR. Key sizes with \fBnum\fR < 1024 should be considered insecure.
153 The exponent is an odd number, typically 3, 17 or 65537.
155 A callback function may be used to provide feedback about the
156 progress of the key generation. If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it
157 will be called as follows:
159 While a random prime number is generated, it is called as
160 described in \fIBN_generate_prime\fR\|(3).
162 When the n\-th randomly generated prime is rejected as not
163 suitable for the key, \fBcallback(2, n, cb_arg)\fR is called.
165 When a random p has been found with p\-1 relatively prime to \fBe\fR,
166 it is called as \fBcallback(3, 0, cb_arg)\fR.
168 The process is then repeated for prime q with \fBcallback(3, 1, cb_arg)\fR.
170 .IX Header "RETURN VALUE"
171 If key generation fails, \fIRSA_generate_key()\fR returns \fB\s-1NULL\s0\fR; the
172 error codes can be obtained by \fIERR_get_error\fR\|(3).
175 \&\fBcallback(2, x, cb_arg)\fR is used with two different meanings.
177 \&\fIRSA_generate_key()\fR goes into an infinite loop for illegal input values.
179 .IX Header "SEE ALSO"
180 \&\fIERR_get_error\fR\|(3), \fIrand\fR\|(3), \fIrsa\fR\|(3),
181 \&\fIRSA_free\fR\|(3)
184 The \fBcb_arg\fR argument was added in SSLeay 0.9.0.