ade5c89c763855934d07cde8f5505f4988929c2b
[dragonfly.git] / secure / lib / libcrypto / man / BN_generate_prime.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
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<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
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
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
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.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
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
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
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'
105 .\}
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 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "BN_generate_prime 3"
136 .TH BN_generate_prime 3 "2015-03-19" "1.0.1m" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 BN_generate_prime, BN_is_prime, BN_is_prime_fasttest \- generate primes and test for primality
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/bn.h>
147 \&
148 \& BIGNUM *BN_generate_prime(BIGNUM *ret, int num, int safe, BIGNUM *add,
149 \&     BIGNUM *rem, void (*callback)(int, int, void *), void *cb_arg);
150 \&
151 \& int BN_is_prime(const BIGNUM *a, int checks, void (*callback)(int, int, 
152 \&     void *), BN_CTX *ctx, void *cb_arg);
153 \&
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);
157 .Ve
158 .SH "DESCRIPTION"
159 .IX Header "DESCRIPTION"
160 \&\fIBN_generate_prime()\fR generates a pseudo-random prime number of \fBnum\fR
161 bits.
162 If \fBret\fR is not \fB\s-1NULL\s0\fR, it will be used to store the number.
163 .PP
164 If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it is called as follows:
165 .IP "\(bu" 4
166 \&\fBcallback(0, i, cb_arg)\fR is called after generating the i\-th
167 potential prime number.
168 .IP "\(bu" 4
169 While the number is being tested for primality, \fBcallback(1, j,
170 cb_arg)\fR is called as described below.
171 .IP "\(bu" 4
172 When a prime has been found, \fBcallback(2, i, cb_arg)\fR is called.
173 .PP
174 The prime may have to fulfill additional requirements for use in
175 Diffie-Hellman key exchange:
176 .PP
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
179 generator.
180 .PP
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).
183 .PP
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.
186 .PP
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
190 prime.
191 .PP
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.
197 .PP
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.
202 .PP
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.
207 .SH "RETURN VALUES"
208 .IX Header "RETURN VALUES"
209 \&\fIBN_generate_prime()\fR returns the prime number on success, \fB\s-1NULL\s0\fR otherwise.
210 .PP
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
213 \&\-1 on error.
214 .PP
215 The error codes can be obtained by \fIERR_get_error\fR\|(3).
216 .SH "SEE ALSO"
217 .IX Header "SEE ALSO"
218 \&\fIbn\fR\|(3), \fIERR_get_error\fR\|(3), \fIrand\fR\|(3)
219 .SH "HISTORY"
220 .IX Header "HISTORY"
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.