2 * Copyright 1995-2019 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
12 #include "internal/cryptlib.h"
16 * The quick sieve algorithm approach to weeding out primes is Philip
17 * Zimmermann's, as implemented in PGP. I have had a read of his comments
18 * and implemented my own version.
22 static int witness(BIGNUM *w, const BIGNUM *a, const BIGNUM *a1,
23 const BIGNUM *a1_odd, int k, BN_CTX *ctx,
25 static int probable_prime(BIGNUM *rnd, int bits, prime_t *mods);
26 static int probable_prime_dh_safe(BIGNUM *rnd, int bits,
27 const BIGNUM *add, const BIGNUM *rem,
30 int BN_GENCB_call(BN_GENCB *cb, int a, int b)
32 /* No callback means continue */
37 /* Deprecated-style callbacks */
40 cb->cb.cb_1(a, b, cb->arg);
43 /* New-style callbacks */
44 return cb->cb.cb_2(a, b, cb);
48 /* Unrecognised callback type */
52 int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe,
53 const BIGNUM *add, const BIGNUM *rem, BN_GENCB *cb)
60 int checks = BN_prime_checks_for_size(bits);
63 /* There are no prime numbers this small. */
64 BNerr(BN_F_BN_GENERATE_PRIME_EX, BN_R_BITS_TOO_SMALL);
66 } else if (bits == 2 && safe) {
67 /* The smallest safe prime (7) is three bits. */
68 BNerr(BN_F_BN_GENERATE_PRIME_EX, BN_R_BITS_TOO_SMALL);
72 mods = OPENSSL_zalloc(sizeof(*mods) * NUMPRIMES);
84 /* make a random number and set the top and bottom bits */
86 if (!probable_prime(ret, bits, mods))
90 if (!probable_prime_dh_safe(ret, bits, add, rem, ctx))
93 if (!bn_probable_prime_dh(ret, bits, add, rem, ctx))
98 if (!BN_GENCB_call(cb, 0, c1++))
103 i = BN_is_prime_fasttest_ex(ret, checks, ctx, 0, cb);
110 * for "safe prime" generation, check that (p-1)/2 is prime. Since a
111 * prime is odd, We just need to divide by 2
113 if (!BN_rshift1(t, ret))
116 for (i = 0; i < checks; i++) {
117 j = BN_is_prime_fasttest_ex(ret, 1, ctx, 0, cb);
123 j = BN_is_prime_fasttest_ex(t, 1, ctx, 0, cb);
129 if (!BN_GENCB_call(cb, 2, c1 - 1))
131 /* We have a safe prime test pass */
134 /* we have a prime :-) */
144 int BN_is_prime_ex(const BIGNUM *a, int checks, BN_CTX *ctx_passed,
147 return BN_is_prime_fasttest_ex(a, checks, ctx_passed, 0, cb);
150 int BN_is_prime_fasttest_ex(const BIGNUM *a, int checks, BN_CTX *ctx_passed,
151 int do_trial_division, BN_GENCB *cb)
156 BIGNUM *A1, *A1_odd, *A3, *check; /* taken from ctx */
157 BN_MONT_CTX *mont = NULL;
159 /* Take care of the really small primes 2 & 3 */
160 if (BN_is_word(a, 2) || BN_is_word(a, 3))
163 /* Check odd and bigger than 1 */
164 if (!BN_is_odd(a) || BN_cmp(a, BN_value_one()) <= 0)
167 if (checks == BN_prime_checks)
168 checks = BN_prime_checks_for_size(BN_num_bits(a));
170 /* first look for small factors */
171 if (do_trial_division) {
172 for (i = 1; i < NUMPRIMES; i++) {
173 BN_ULONG mod = BN_mod_word(a, primes[i]);
174 if (mod == (BN_ULONG)-1)
177 return BN_is_word(a, primes[i]);
179 if (!BN_GENCB_call(cb, 1, -1))
183 if (ctx_passed != NULL)
185 else if ((ctx = BN_CTX_new()) == NULL)
189 A1 = BN_CTX_get(ctx);
190 A3 = BN_CTX_get(ctx);
191 A1_odd = BN_CTX_get(ctx);
192 check = BN_CTX_get(ctx);
196 /* compute A1 := a - 1 */
197 if (!BN_copy(A1, a) || !BN_sub_word(A1, 1))
199 /* compute A3 := a - 3 */
200 if (!BN_copy(A3, a) || !BN_sub_word(A3, 3))
203 /* write A1 as A1_odd * 2^k */
205 while (!BN_is_bit_set(A1, k))
207 if (!BN_rshift(A1_odd, A1, k))
210 /* Montgomery setup for computations mod a */
211 mont = BN_MONT_CTX_new();
214 if (!BN_MONT_CTX_set(mont, a, ctx))
217 for (i = 0; i < checks; i++) {
218 /* 1 < check < a-1 */
219 if (!BN_priv_rand_range(check, A3) || !BN_add_word(check, 2))
222 j = witness(check, a, A1, A1_odd, k, ctx, mont);
229 if (!BN_GENCB_call(cb, 1, i))
236 if (ctx_passed == NULL)
239 BN_MONT_CTX_free(mont);
244 static int witness(BIGNUM *w, const BIGNUM *a, const BIGNUM *a1,
245 const BIGNUM *a1_odd, int k, BN_CTX *ctx,
248 if (!BN_mod_exp_mont(w, w, a1_odd, a, ctx, mont)) /* w := w^a1_odd mod a */
251 return 0; /* probably prime */
252 if (BN_cmp(w, a1) == 0)
253 return 0; /* w == -1 (mod a), 'a' is probably prime */
255 if (!BN_mod_mul(w, w, w, a, ctx)) /* w := w^2 mod a */
258 return 1; /* 'a' is composite, otherwise a previous 'w'
259 * would have been == -1 (mod 'a') */
260 if (BN_cmp(w, a1) == 0)
261 return 0; /* w == -1 (mod a), 'a' is probably prime */
264 * If we get here, 'w' is the (a-1)/2-th power of the original 'w', and
265 * it is neither -1 nor +1 -- so 'a' cannot be prime
271 static int probable_prime(BIGNUM *rnd, int bits, prime_t *mods)
275 BN_ULONG maxdelta = BN_MASK2 - primes[NUMPRIMES - 1];
276 char is_single_word = bits <= BN_BITS2;
279 /* TODO: Not all primes are private */
280 if (!BN_priv_rand(rnd, bits, BN_RAND_TOP_TWO, BN_RAND_BOTTOM_ODD))
282 /* we now have a random number 'rnd' to test. */
283 for (i = 1; i < NUMPRIMES; i++) {
284 BN_ULONG mod = BN_mod_word(rnd, (BN_ULONG)primes[i]);
285 if (mod == (BN_ULONG)-1)
287 mods[i] = (prime_t) mod;
290 * If bits is so small that it fits into a single word then we
291 * additionally don't want to exceed that many bits.
293 if (is_single_word) {
296 if (bits == BN_BITS2) {
298 * Shifting by this much has undefined behaviour so we do it a
301 size_limit = ~((BN_ULONG)0) - BN_get_word(rnd);
303 size_limit = (((BN_ULONG)1) << bits) - BN_get_word(rnd) - 1;
305 if (size_limit < maxdelta)
306 maxdelta = size_limit;
310 if (is_single_word) {
311 BN_ULONG rnd_word = BN_get_word(rnd);
314 * In the case that the candidate prime is a single word then
316 * 1) It's greater than primes[i] because we shouldn't reject
317 * 3 as being a prime number because it's a multiple of
319 * 2) That it's not a multiple of a known prime. We don't
320 * check that rnd-1 is also coprime to all the known
321 * primes because there aren't many small primes where
324 for (i = 1; i < NUMPRIMES && primes[i] < rnd_word; i++) {
325 if ((mods[i] + delta) % primes[i] == 0) {
327 if (delta > maxdelta)
333 for (i = 1; i < NUMPRIMES; i++) {
335 * check that rnd is not a prime and also that gcd(rnd-1,primes)
336 * == 1 (except for 2)
338 if (((mods[i] + delta) % primes[i]) <= 1) {
340 if (delta > maxdelta)
346 if (!BN_add_word(rnd, delta))
348 if (BN_num_bits(rnd) != bits)
354 int bn_probable_prime_dh(BIGNUM *rnd, int bits,
355 const BIGNUM *add, const BIGNUM *rem, BN_CTX *ctx)
361 if ((t1 = BN_CTX_get(ctx)) == NULL)
364 if (!BN_rand(rnd, bits, BN_RAND_TOP_ONE, BN_RAND_BOTTOM_ODD))
367 /* we need ((rnd-rem) % add) == 0 */
369 if (!BN_mod(t1, rnd, add, ctx))
371 if (!BN_sub(rnd, rnd, t1))
374 if (!BN_add_word(rnd, 1))
377 if (!BN_add(rnd, rnd, rem))
381 /* we now have a random number 'rand' to test. */
384 for (i = 1; i < NUMPRIMES; i++) {
385 /* check that rnd is a prime */
386 BN_ULONG mod = BN_mod_word(rnd, (BN_ULONG)primes[i]);
387 if (mod == (BN_ULONG)-1)
390 if (!BN_add(rnd, rnd, add))
403 static int probable_prime_dh_safe(BIGNUM *p, int bits, const BIGNUM *padd,
404 const BIGNUM *rem, BN_CTX *ctx)
407 BIGNUM *t1, *qadd, *q;
411 t1 = BN_CTX_get(ctx);
413 qadd = BN_CTX_get(ctx);
417 if (!BN_rshift1(qadd, padd))
420 if (!BN_rand(q, bits, BN_RAND_TOP_ONE, BN_RAND_BOTTOM_ODD))
423 /* we need ((rnd-rem) % add) == 0 */
424 if (!BN_mod(t1, q, qadd, ctx))
426 if (!BN_sub(q, q, t1))
429 if (!BN_add_word(q, 1))
432 if (!BN_rshift1(t1, rem))
434 if (!BN_add(q, q, t1))
438 /* we now have a random number 'rand' to test. */
439 if (!BN_lshift1(p, q))
441 if (!BN_add_word(p, 1))
445 for (i = 1; i < NUMPRIMES; i++) {
446 /* check that p and q are prime */
448 * check that for p and q gcd(p-1,primes) == 1 (except for 2)
450 BN_ULONG pmod = BN_mod_word(p, (BN_ULONG)primes[i]);
451 BN_ULONG qmod = BN_mod_word(q, (BN_ULONG)primes[i]);
452 if (pmod == (BN_ULONG)-1 || qmod == (BN_ULONG)-1)
454 if (pmod == 0 || qmod == 0) {
455 if (!BN_add(p, p, padd))
457 if (!BN_add(q, q, qadd))