Coverage Report

Created: 2023-06-08 06:41

/src/openssl30/crypto/bn/bn_rand.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (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
8
 */
9
10
#include <stdio.h>
11
#include <time.h>
12
#include "internal/cryptlib.h"
13
#include "crypto/rand.h"
14
#include "bn_local.h"
15
#include <openssl/rand.h>
16
#include <openssl/sha.h>
17
#include <openssl/evp.h>
18
19
typedef enum bnrand_flag_e {
20
    NORMAL, TESTING, PRIVATE
21
} BNRAND_FLAG;
22
23
static int bnrand(BNRAND_FLAG flag, BIGNUM *rnd, int bits, int top, int bottom,
24
                  unsigned int strength, BN_CTX *ctx)
25
4.33k
{
26
4.33k
    unsigned char *buf = NULL;
27
4.33k
    int b, ret = 0, bit, bytes, mask;
28
4.33k
    OSSL_LIB_CTX *libctx = ossl_bn_get_libctx(ctx);
29
30
4.33k
    if (bits == 0) {
31
0
        if (top != BN_RAND_TOP_ANY || bottom != BN_RAND_BOTTOM_ANY)
32
0
            goto toosmall;
33
0
        BN_zero(rnd);
34
0
        return 1;
35
0
    }
36
4.33k
    if (bits < 0 || (bits == 1 && top > 0))
37
0
        goto toosmall;
38
39
4.33k
    bytes = (bits + 7) / 8;
40
4.33k
    bit = (bits - 1) % 8;
41
4.33k
    mask = 0xff << (bit + 1);
42
43
4.33k
    buf = OPENSSL_malloc(bytes);
44
4.33k
    if (buf == NULL) {
45
0
        ERR_raise(ERR_LIB_BN, ERR_R_MALLOC_FAILURE);
46
0
        goto err;
47
0
    }
48
49
    /* make a random number and set the top and bottom bits */
50
4.33k
    b = flag == NORMAL ? RAND_bytes_ex(libctx, buf, bytes, strength)
51
4.33k
                       : RAND_priv_bytes_ex(libctx, buf, bytes, strength);
52
4.33k
    if (b <= 0)
53
0
        goto err;
54
55
4.33k
    if (flag == TESTING) {
56
        /*
57
         * generate patterns that are more likely to trigger BN library bugs
58
         */
59
0
        int i;
60
0
        unsigned char c;
61
62
0
        for (i = 0; i < bytes; i++) {
63
0
            if (RAND_bytes_ex(libctx, &c, 1, strength) <= 0)
64
0
                goto err;
65
0
            if (c >= 128 && i > 0)
66
0
                buf[i] = buf[i - 1];
67
0
            else if (c < 42)
68
0
                buf[i] = 0;
69
0
            else if (c < 84)
70
0
                buf[i] = 255;
71
0
        }
72
0
    }
73
74
4.33k
    if (top >= 0) {
75
3.69k
        if (top) {
76
0
            if (bit == 0) {
77
0
                buf[0] = 1;
78
0
                buf[1] |= 0x80;
79
0
            } else {
80
0
                buf[0] |= (3 << (bit - 1));
81
0
            }
82
3.69k
        } else {
83
3.69k
            buf[0] |= (1 << bit);
84
3.69k
        }
85
3.69k
    }
86
4.33k
    buf[0] &= ~mask;
87
4.33k
    if (bottom)                 /* set bottom bit if requested */
88
0
        buf[bytes - 1] |= 1;
89
4.33k
    if (!BN_bin2bn(buf, bytes, rnd))
90
0
        goto err;
91
4.33k
    ret = 1;
92
4.33k
 err:
93
4.33k
    OPENSSL_clear_free(buf, bytes);
94
4.33k
    bn_check_top(rnd);
95
4.33k
    return ret;
96
97
0
toosmall:
98
0
    ERR_raise(ERR_LIB_BN, BN_R_BITS_TOO_SMALL);
99
0
    return 0;
100
4.33k
}
101
102
int BN_rand_ex(BIGNUM *rnd, int bits, int top, int bottom,
103
               unsigned int strength, BN_CTX *ctx)
104
0
{
105
0
    return bnrand(NORMAL, rnd, bits, top, bottom, strength, ctx);
106
0
}
107
#ifndef FIPS_MODULE
108
int BN_rand(BIGNUM *rnd, int bits, int top, int bottom)
109
0
{
110
0
    return bnrand(NORMAL, rnd, bits, top, bottom, 0, NULL);
111
0
}
112
113
int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom)
114
0
{
115
0
    return bnrand(TESTING, rnd, bits, top, bottom, 0, NULL);
116
0
}
117
#endif
118
119
int BN_priv_rand_ex(BIGNUM *rnd, int bits, int top, int bottom,
120
                    unsigned int strength, BN_CTX *ctx)
121
3.91k
{
122
3.91k
    return bnrand(PRIVATE, rnd, bits, top, bottom, strength, ctx);
123
3.91k
}
124
125
#ifndef FIPS_MODULE
126
int BN_priv_rand(BIGNUM *rnd, int bits, int top, int bottom)
127
0
{
128
0
    return bnrand(PRIVATE, rnd, bits, top, bottom, 0, NULL);
129
0
}
130
#endif
131
132
/* random number r:  0 <= r < range */
133
static int bnrand_range(BNRAND_FLAG flag, BIGNUM *r, const BIGNUM *range,
134
                        unsigned int strength, BN_CTX *ctx)
135
412
{
136
412
    int n;
137
412
    int count = 100;
138
139
412
    if (r == NULL) {
140
0
        ERR_raise(ERR_LIB_BN, ERR_R_PASSED_NULL_PARAMETER);
141
0
        return 0;
142
0
    }
143
144
412
    if (range->neg || BN_is_zero(range)) {
145
0
        ERR_raise(ERR_LIB_BN, BN_R_INVALID_RANGE);
146
0
        return 0;
147
0
    }
148
149
412
    n = BN_num_bits(range);     /* n > 0 */
150
151
    /* BN_is_bit_set(range, n - 1) always holds */
152
153
412
    if (n == 1)
154
0
        BN_zero(r);
155
412
    else if (!BN_is_bit_set(range, n - 2) && !BN_is_bit_set(range, n - 3)) {
156
        /*
157
         * range = 100..._2, so 3*range (= 11..._2) is exactly one bit longer
158
         * than range
159
         */
160
231
        do {
161
231
            if (!bnrand(flag, r, n + 1, BN_RAND_TOP_ANY, BN_RAND_BOTTOM_ANY,
162
231
                        strength, ctx))
163
0
                return 0;
164
165
            /*
166
             * If r < 3*range, use r := r MOD range (which is either r, r -
167
             * range, or r - 2*range). Otherwise, iterate once more. Since
168
             * 3*range = 11..._2, each iteration succeeds with probability >=
169
             * .75.
170
             */
171
231
            if (BN_cmp(r, range) >= 0) {
172
133
                if (!BN_sub(r, r, range))
173
0
                    return 0;
174
133
                if (BN_cmp(r, range) >= 0)
175
39
                    if (!BN_sub(r, r, range))
176
0
                        return 0;
177
133
            }
178
179
231
            if (!--count) {
180
0
                ERR_raise(ERR_LIB_BN, BN_R_TOO_MANY_ITERATIONS);
181
0
                return 0;
182
0
            }
183
184
231
        }
185
231
        while (BN_cmp(r, range) >= 0);
186
231
    } else {
187
181
        do {
188
            /* range = 11..._2  or  range = 101..._2 */
189
181
            if (!bnrand(flag, r, n, BN_RAND_TOP_ANY, BN_RAND_BOTTOM_ANY, 0,
190
181
                        ctx))
191
0
                return 0;
192
193
181
            if (!--count) {
194
0
                ERR_raise(ERR_LIB_BN, BN_R_TOO_MANY_ITERATIONS);
195
0
                return 0;
196
0
            }
197
181
        }
198
181
        while (BN_cmp(r, range) >= 0);
199
181
    }
200
201
412
    bn_check_top(r);
202
412
    return 1;
203
412
}
204
205
int BN_rand_range_ex(BIGNUM *r, const BIGNUM *range, unsigned int strength,
206
                     BN_CTX *ctx)
207
0
{
208
0
    return bnrand_range(NORMAL, r, range, strength, ctx);
209
0
}
210
211
#ifndef FIPS_MODULE
212
int BN_rand_range(BIGNUM *r, const BIGNUM *range)
213
0
{
214
0
    return bnrand_range(NORMAL, r, range, 0, NULL);
215
0
}
216
#endif
217
218
int BN_priv_rand_range_ex(BIGNUM *r, const BIGNUM *range, unsigned int strength,
219
                          BN_CTX *ctx)
220
412
{
221
412
    return bnrand_range(PRIVATE, r, range, strength, ctx);
222
412
}
223
224
#ifndef FIPS_MODULE
225
int BN_priv_rand_range(BIGNUM *r, const BIGNUM *range)
226
0
{
227
0
    return bnrand_range(PRIVATE, r, range, 0, NULL);
228
0
}
229
230
# ifndef OPENSSL_NO_DEPRECATED_3_0
231
int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom)
232
0
{
233
0
    return BN_rand(rnd, bits, top, bottom);
234
0
}
235
236
int BN_pseudo_rand_range(BIGNUM *r, const BIGNUM *range)
237
0
{
238
0
    return BN_rand_range(r, range);
239
0
}
240
# endif
241
#endif
242
243
/*
244
 * BN_generate_dsa_nonce generates a random number 0 <= out < range. Unlike
245
 * BN_rand_range, it also includes the contents of |priv| and |message| in
246
 * the generation so that an RNG failure isn't fatal as long as |priv|
247
 * remains secret. This is intended for use in DSA and ECDSA where an RNG
248
 * weakness leads directly to private key exposure unless this function is
249
 * used.
250
 */
251
int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
252
                          const BIGNUM *priv, const unsigned char *message,
253
                          size_t message_len, BN_CTX *ctx)
254
0
{
255
0
    EVP_MD_CTX *mdctx = EVP_MD_CTX_new();
256
    /*
257
     * We use 512 bits of random data per iteration to ensure that we have at
258
     * least |range| bits of randomness.
259
     */
260
0
    unsigned char random_bytes[64];
261
0
    unsigned char digest[SHA512_DIGEST_LENGTH];
262
0
    unsigned done, todo;
263
    /* We generate |range|+8 bytes of random output. */
264
0
    const unsigned num_k_bytes = BN_num_bytes(range) + 8;
265
0
    unsigned char private_bytes[96];
266
0
    unsigned char *k_bytes = NULL;
267
0
    int ret = 0;
268
0
    EVP_MD *md = NULL;
269
0
    OSSL_LIB_CTX *libctx = ossl_bn_get_libctx(ctx);
270
271
0
    if (mdctx == NULL)
272
0
        goto err;
273
274
0
    k_bytes = OPENSSL_malloc(num_k_bytes);
275
0
    if (k_bytes == NULL)
276
0
        goto err;
277
278
    /* We copy |priv| into a local buffer to avoid exposing its length. */
279
0
    if (BN_bn2binpad(priv, private_bytes, sizeof(private_bytes)) < 0) {
280
        /*
281
         * No reasonable DSA or ECDSA key should have a private key this
282
         * large and we don't handle this case in order to avoid leaking the
283
         * length of the private key.
284
         */
285
0
        ERR_raise(ERR_LIB_BN, BN_R_PRIVATE_KEY_TOO_LARGE);
286
0
        goto err;
287
0
    }
288
289
0
    md = EVP_MD_fetch(libctx, "SHA512", NULL);
290
0
    if (md == NULL) {
291
0
        ERR_raise(ERR_LIB_BN, BN_R_NO_SUITABLE_DIGEST);
292
0
        goto err;
293
0
    }
294
0
    for (done = 0; done < num_k_bytes;) {
295
0
        if (RAND_priv_bytes_ex(libctx, random_bytes, sizeof(random_bytes), 0) <= 0)
296
0
            goto err;
297
298
0
        if (!EVP_DigestInit_ex(mdctx, md, NULL)
299
0
                || !EVP_DigestUpdate(mdctx, &done, sizeof(done))
300
0
                || !EVP_DigestUpdate(mdctx, private_bytes,
301
0
                                     sizeof(private_bytes))
302
0
                || !EVP_DigestUpdate(mdctx, message, message_len)
303
0
                || !EVP_DigestUpdate(mdctx, random_bytes, sizeof(random_bytes))
304
0
                || !EVP_DigestFinal_ex(mdctx, digest, NULL))
305
0
            goto err;
306
307
0
        todo = num_k_bytes - done;
308
0
        if (todo > SHA512_DIGEST_LENGTH)
309
0
            todo = SHA512_DIGEST_LENGTH;
310
0
        memcpy(k_bytes + done, digest, todo);
311
0
        done += todo;
312
0
    }
313
314
0
    if (!BN_bin2bn(k_bytes, num_k_bytes, out))
315
0
        goto err;
316
0
    if (BN_mod(out, out, range, ctx) != 1)
317
0
        goto err;
318
0
    ret = 1;
319
320
0
 err:
321
0
    EVP_MD_CTX_free(mdctx);
322
0
    EVP_MD_free(md);
323
0
    OPENSSL_clear_free(k_bytes, num_k_bytes);
324
0
    OPENSSL_cleanse(digest, sizeof(digest));
325
0
    OPENSSL_cleanse(random_bytes, sizeof(random_bytes));
326
0
    OPENSSL_cleanse(private_bytes, sizeof(private_bytes));
327
0
    return ret;
328
0
}