6a3376b1fdeb8f79551d1ec696ed925e2c90aefe
[openssl.git] / doc / man3 / BN_generate_prime.pod
1 =pod
2
3 =head1 NAME
4
5 BN_generate_prime_ex2, BN_generate_prime_ex, BN_is_prime_ex,
6 BN_is_prime_fasttest_ex, BN_GENCB_call, BN_GENCB_new, BN_GENCB_free,
7 BN_GENCB_set_old, BN_GENCB_set, BN_GENCB_get_arg, BN_generate_prime,
8 BN_is_prime, BN_is_prime_fasttest - generate primes and test for primality
9
10 =head1 SYNOPSIS
11
12  #include <openssl/bn.h>
13
14  int BN_generate_prime_ex2(BIGNUM *ret, int bits, int safe,
15                            const BIGNUM *add, const BIGNUM *rem, BN_GENCB *cb,
16                            BN_CTX *ctx);
17
18  int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
19                           const BIGNUM *rem, BN_GENCB *cb);
20
21  int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
22
23  int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
24                              int do_trial_division, BN_GENCB *cb);
25
26  int BN_GENCB_call(BN_GENCB *cb, int a, int b);
27
28  BN_GENCB *BN_GENCB_new(void);
29
30  void BN_GENCB_free(BN_GENCB *cb);
31
32  void BN_GENCB_set_old(BN_GENCB *gencb,
33                        void (*callback)(int, int, void *), void *cb_arg);
34
35  void BN_GENCB_set(BN_GENCB *gencb,
36                    int (*callback)(int, int, BN_GENCB *), void *cb_arg);
37
38  void *BN_GENCB_get_arg(BN_GENCB *cb);
39
40 Deprecated since OpenSSL 0.9.8, can be hidden entirely by defining
41 B<OPENSSL_API_COMPAT> with a suitable version value, see
42 L<openssl_user_macros(7)>:
43
44  BIGNUM *BN_generate_prime(BIGNUM *ret, int num, int safe, BIGNUM *add,
45                            BIGNUM *rem, void (*callback)(int, int, void *),
46                            void *cb_arg);
47
48  int BN_is_prime(const BIGNUM *a, int checks,
49                  void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg);
50
51  int BN_is_prime_fasttest(const BIGNUM *a, int checks,
52                           void (*callback)(int, int, void *), BN_CTX *ctx,
53                           void *cb_arg, int do_trial_division);
54
55 =head1 DESCRIPTION
56
57 BN_generate_prime_ex2() generates a pseudo-random prime number of
58 at least bit length B<bits> using the BN_CTX provided in B<ctx>. The value of
59 B<ctx> must not be NULL.
60 The returned number is probably prime with a negligible error.
61 If B<add> is B<NULL> the returned prime number will have exact bit
62 length B<bits> with the top most two bits set.
63
64 If B<ret> is not B<NULL>, it will be used to store the number.
65
66 If B<cb> is not B<NULL>, it is used as follows:
67
68 =over 2
69
70 =item *
71
72 B<BN_GENCB_call(cb, 0, i)> is called after generating the i-th
73 potential prime number.
74
75 =item *
76
77 While the number is being tested for primality,
78 B<BN_GENCB_call(cb, 1, j)> is called as described below.
79
80 =item *
81
82 When a prime has been found, B<BN_GENCB_call(cb, 2, i)> is called.
83
84 =item *
85
86 The callers of BN_generate_prime_ex() may call B<BN_GENCB_call(cb, i, j)> with
87 other values as described in their respective man pages; see L</SEE ALSO>.
88
89 =back
90
91 The prime may have to fulfill additional requirements for use in
92 Diffie-Hellman key exchange:
93
94 If B<add> is not B<NULL>, the prime will fulfill the condition p % B<add>
95 == B<rem> (p % B<add> == 1 if B<rem> == B<NULL>) in order to suit a given
96 generator.
97
98 If B<safe> is true, it will be a safe prime (i.e. a prime p so
99 that (p-1)/2 is also prime). If B<safe> is true, and B<rem> == B<NULL>
100 the condition will be p % B<add> == 3.
101 It is recommended that B<add> is a multiple of 4.
102
103 The random generator must be seeded prior to calling BN_generate_prime_ex().
104 If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
105 external circumstances (see L<RAND(7)>), the operation will fail.
106 The random number generator configured for the OPENSSL_CTX associated with
107 B<ctx> will be used.
108
109 BN_generate_prime_ex() is the same as BN_generate_prime_ex2() except that no
110 B<ctx> parameter is passed.
111 In this case the random number generator associated with the default OPENSSL_CTX
112 will be used.
113
114 BN_is_prime_ex() and BN_is_prime_fasttest_ex() test if the number B<p> is
115 prime.  The following tests are performed until one of them shows that
116 B<p> is composite; if B<p> passes all these tests, it is considered
117 prime.
118
119 BN_is_prime_fasttest_ex(), when called with B<do_trial_division == 1>,
120 first attempts trial division by a number of small primes;
121 if no divisors are found by this test and B<cb> is not B<NULL>,
122 B<BN_GENCB_call(cb, 1, -1)> is called.
123 If B<do_trial_division == 0>, this test is skipped.
124
125 Both BN_is_prime_ex() and BN_is_prime_fasttest_ex() perform a Miller-Rabin
126 probabilistic primality test with B<nchecks> iterations. If
127 B<nchecks == BN_prime_checks>, a number of iterations is used that
128 yields a false positive rate of at most 2^-64 for random input.
129 The error rate depends on the size of the prime and goes down for bigger primes.
130 The rate is 2^-80 starting at 308 bits, 2^-112 at 852 bits, 2^-128 at 1080 bits,
131 2^-192 at 3747 bits and 2^-256 at 6394 bits.
132
133 When the source of the prime is not random or not trusted, the number
134 of checks needs to be much higher to reach the same level of assurance:
135 It should equal half of the targeted security level in bits (rounded up to the
136 next integer if necessary).
137 For instance, to reach the 128 bit security level, B<nchecks> should be set to
138 64.
139
140 If B<cb> is not B<NULL>, B<BN_GENCB_call(cb, 1, j)> is called
141 after the j-th iteration (j = 0, 1, ...). B<ctx> is a
142 pre-allocated B<BN_CTX> (to save the overhead of allocating and
143 freeing the structure in a loop), or B<NULL>.
144
145 BN_GENCB_call() calls the callback function held in the B<BN_GENCB> structure
146 and passes the ints B<a> and B<b> as arguments. There are two types of
147 B<BN_GENCB> structure that are supported: "new" style and "old" style. New
148 programs should prefer the "new" style, whilst the "old" style is provided
149 for backwards compatibility purposes.
150
151 A B<BN_GENCB> structure should be created through a call to BN_GENCB_new(),
152 and freed through a call to BN_GENCB_free().
153
154 For "new" style callbacks a BN_GENCB structure should be initialised with a
155 call to BN_GENCB_set(), where B<gencb> is a B<BN_GENCB *>, B<callback> is of
156 type B<int (*callback)(int, int, BN_GENCB *)> and B<cb_arg> is a B<void *>.
157 "Old" style callbacks are the same except they are initialised with a call
158 to BN_GENCB_set_old() and B<callback> is of type
159 B<void (*callback)(int, int, void *)>.
160
161 A callback is invoked through a call to B<BN_GENCB_call>. This will check
162 the type of the callback and will invoke B<callback(a, b, gencb)> for new
163 style callbacks or B<callback(a, b, cb_arg)> for old style.
164
165 It is possible to obtain the argument associated with a BN_GENCB structure
166 (set via a call to BN_GENCB_set or BN_GENCB_set_old) using BN_GENCB_get_arg.
167
168 BN_generate_prime() (deprecated) works in the same way as
169 BN_generate_prime_ex() but expects an old-style callback function
170 directly in the B<callback> parameter, and an argument to pass to it in
171 the B<cb_arg>. BN_is_prime() and BN_is_prime_fasttest()
172 can similarly be compared to BN_is_prime_ex() and
173 BN_is_prime_fasttest_ex(), respectively.
174
175 =head1 RETURN VALUES
176
177 BN_generate_prime_ex() return 1 on success or 0 on error.
178
179 BN_is_prime_ex(), BN_is_prime_fasttest_ex(), BN_is_prime() and
180 BN_is_prime_fasttest() return 0 if the number is composite, 1 if it is
181 prime with an error probability of less than 0.25^B<nchecks>, and
182 -1 on error.
183
184 BN_generate_prime() returns the prime number on success, B<NULL> otherwise.
185
186 BN_GENCB_new returns a pointer to a BN_GENCB structure on success, or B<NULL>
187 otherwise.
188
189 BN_GENCB_get_arg returns the argument previously associated with a BN_GENCB
190 structure.
191
192 Callback functions should return 1 on success or 0 on error.
193
194 The error codes can be obtained by L<ERR_get_error(3)>.
195
196 =head1 REMOVED FUNCTIONALITY
197
198 As of OpenSSL 1.1.0 it is no longer possible to create a BN_GENCB structure
199 directly, as in:
200
201  BN_GENCB callback;
202
203 Instead applications should create a BN_GENCB structure using BN_GENCB_new:
204
205  BN_GENCB *callback;
206  callback = BN_GENCB_new();
207  if (!callback)
208      /* error */
209  ...
210  BN_GENCB_free(callback);
211
212 =head1 SEE ALSO
213
214 L<DH_generate_parameters(3)>, L<DSA_generate_parameters(3)>,
215 L<RSA_generate_key(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
216 L<RAND(7)>
217
218 =head1 HISTORY
219
220 The BN_GENCB_new(), BN_GENCB_free(),
221 and BN_GENCB_get_arg() functions were added in OpenSSL 1.1.0.
222
223 =head1 COPYRIGHT
224
225 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
226
227 Licensed under the Apache License 2.0 (the "License").  You may not use
228 this file except in compliance with the License.  You can obtain a copy
229 in the file LICENSE in the source distribution or at
230 L<https://www.openssl.org/source/license.html>.
231
232 =cut