1 .\" Automatically generated by Pod::Man 2.28 (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 "BN_generate_prime 3"
136 .TH BN_generate_prime 3 "2015-12-03" "1.0.1q" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 BN_generate_prime, BN_is_prime, BN_is_prime_fasttest \- generate primes and test for primality
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/bn.h>
148 \& BIGNUM *BN_generate_prime(BIGNUM *ret, int num, int safe, BIGNUM *add,
149 \& BIGNUM *rem, void (*callback)(int, int, void *), void *cb_arg);
151 \& int BN_is_prime(const BIGNUM *a, int checks, void (*callback)(int, int,
152 \& void *), BN_CTX *ctx, void *cb_arg);
154 \& int BN_is_prime_fasttest(const BIGNUM *a, int checks,
155 \& void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg,
156 \& int do_trial_division);
159 .IX Header "DESCRIPTION"
160 \&\fIBN_generate_prime()\fR generates a pseudo-random prime number of \fBnum\fR
162 If \fBret\fR is not \fB\s-1NULL\s0\fR, it will be used to store the number.
164 If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it is called as follows:
166 \&\fBcallback(0, i, cb_arg)\fR is called after generating the i\-th
167 potential prime number.
169 While the number is being tested for primality, \fBcallback(1, j,
170 cb_arg)\fR is called as described below.
172 When a prime has been found, \fBcallback(2, i, cb_arg)\fR is called.
174 The prime may have to fulfill additional requirements for use in
175 Diffie-Hellman key exchange:
177 If \fBadd\fR is not \fB\s-1NULL\s0\fR, the prime will fulfill the condition p % \fBadd\fR
178 == \fBrem\fR (p % \fBadd\fR == 1 if \fBrem\fR == \fB\s-1NULL\s0\fR) in order to suit a given
181 If \fBsafe\fR is true, it will be a safe prime (i.e. a prime p so
182 that (p\-1)/2 is also prime).
184 The \s-1PRNG\s0 must be seeded prior to calling \fIBN_generate_prime()\fR.
185 The prime number generation has a negligible error probability.
187 \&\fIBN_is_prime()\fR and \fIBN_is_prime_fasttest()\fR test if the number \fBa\fR is
188 prime. The following tests are performed until one of them shows that
189 \&\fBa\fR is composite; if \fBa\fR passes all these tests, it is considered
192 \&\fIBN_is_prime_fasttest()\fR, when called with \fBdo_trial_division == 1\fR,
193 first attempts trial division by a number of small primes;
194 if no divisors are found by this test and \fBcallback\fR is not \fB\s-1NULL\s0\fR,
195 \&\fBcallback(1, \-1, cb_arg)\fR is called.
196 If \fBdo_trial_division == 0\fR, this test is skipped.
198 Both \fIBN_is_prime()\fR and \fIBN_is_prime_fasttest()\fR perform a Miller-Rabin
199 probabilistic primality test with \fBchecks\fR iterations. If
200 \&\fBchecks == BN_prime_checks\fR, a number of iterations is used that
201 yields a false positive rate of at most 2^\-80 for random input.
203 If \fBcallback\fR is not \fB\s-1NULL\s0\fR, \fBcallback(1, j, cb_arg)\fR is called
204 after the j\-th iteration (j = 0, 1, ...). \fBctx\fR is a
205 pre-allocated \fB\s-1BN_CTX\s0\fR (to save the overhead of allocating and
206 freeing the structure in a loop), or \fB\s-1NULL\s0\fR.
208 .IX Header "RETURN VALUES"
209 \&\fIBN_generate_prime()\fR returns the prime number on success, \fB\s-1NULL\s0\fR otherwise.
211 \&\fIBN_is_prime()\fR returns 0 if the number is composite, 1 if it is
212 prime with an error probability of less than 0.25^\fBchecks\fR, and
215 The error codes can be obtained by \fIERR_get_error\fR\|(3).
217 .IX Header "SEE ALSO"
218 \&\fIbn\fR\|(3), \fIERR_get_error\fR\|(3), \fIrand\fR\|(3)
221 The \fBcb_arg\fR arguments to \fIBN_generate_prime()\fR and to \fIBN_is_prime()\fR
222 were added in SSLeay 0.9.0. The \fBret\fR argument to \fIBN_generate_prime()\fR
223 was added in SSLeay 0.9.1.
224 \&\fIBN_is_prime_fasttest()\fR was added in OpenSSL 0.9.5.