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