Coverage Report

Created: 2023-09-25 06:41

/src/openssl/crypto/mem.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 "internal/e_os.h"
11
#include "internal/cryptlib.h"
12
#include "crypto/cryptlib.h"
13
#include <stdio.h>
14
#include <stdlib.h>
15
#include <limits.h>
16
#include <openssl/crypto.h>
17
18
/*
19
 * the following pointers may be changed as long as 'allow_customize' is set
20
 */
21
static int allow_customize = 1;
22
static CRYPTO_malloc_fn malloc_impl = CRYPTO_malloc;
23
static CRYPTO_realloc_fn realloc_impl = CRYPTO_realloc;
24
static CRYPTO_free_fn free_impl = CRYPTO_free;
25
26
#if !defined(OPENSSL_NO_CRYPTO_MDEBUG) && !defined(FIPS_MODULE)
27
# include "internal/tsan_assist.h"
28
29
# ifdef TSAN_REQUIRES_LOCKING
30
#  define INCREMENT(x) /* empty */
31
#  define LOAD(x) 0
32
# else  /* TSAN_REQUIRES_LOCKING */
33
static TSAN_QUALIFIER int malloc_count;
34
static TSAN_QUALIFIER int realloc_count;
35
static TSAN_QUALIFIER int free_count;
36
37
#  define INCREMENT(x) tsan_counter(&(x))
38
#  define LOAD(x)      tsan_load(&x)
39
# endif /* TSAN_REQUIRES_LOCKING */
40
41
static char *md_failstring;
42
static long md_count;
43
static int md_fail_percent = 0;
44
static int md_tracefd = -1;
45
46
static void parseit(void);
47
static int shouldfail(void);
48
49
# define FAILTEST() if (shouldfail()) return NULL
50
51
#else
52
53
# define INCREMENT(x) /* empty */
54
# define FAILTEST() /* empty */
55
#endif
56
57
int CRYPTO_set_mem_functions(CRYPTO_malloc_fn malloc_fn,
58
                             CRYPTO_realloc_fn realloc_fn,
59
                             CRYPTO_free_fn free_fn)
60
0
{
61
0
    if (!allow_customize)
62
0
        return 0;
63
0
    if (malloc_fn != NULL)
64
0
        malloc_impl = malloc_fn;
65
0
    if (realloc_fn != NULL)
66
0
        realloc_impl = realloc_fn;
67
0
    if (free_fn != NULL)
68
0
        free_impl = free_fn;
69
0
    return 1;
70
0
}
71
72
void CRYPTO_get_mem_functions(CRYPTO_malloc_fn *malloc_fn,
73
                              CRYPTO_realloc_fn *realloc_fn,
74
                              CRYPTO_free_fn *free_fn)
75
0
{
76
0
    if (malloc_fn != NULL)
77
0
        *malloc_fn = malloc_impl;
78
0
    if (realloc_fn != NULL)
79
0
        *realloc_fn = realloc_impl;
80
0
    if (free_fn != NULL)
81
0
        *free_fn = free_impl;
82
0
}
83
84
#if !defined(OPENSSL_NO_CRYPTO_MDEBUG) && !defined(FIPS_MODULE)
85
void CRYPTO_get_alloc_counts(int *mcount, int *rcount, int *fcount)
86
{
87
    if (mcount != NULL)
88
        *mcount = LOAD(malloc_count);
89
    if (rcount != NULL)
90
        *rcount = LOAD(realloc_count);
91
    if (fcount != NULL)
92
        *fcount = LOAD(free_count);
93
}
94
95
/*
96
 * Parse a "malloc failure spec" string.  This likes like a set of fields
97
 * separated by semicolons.  Each field has a count and an optional failure
98
 * percentage.  For example:
99
 *          100@0;100@25;0@0
100
 *    or    100;100@25;0
101
 * This means 100 mallocs succeed, then next 100 fail 25% of the time, and
102
 * all remaining (count is zero) succeed.
103
 */
104
static void parseit(void)
105
{
106
    char *semi = strchr(md_failstring, ';');
107
    char *atsign;
108
109
    if (semi != NULL)
110
        *semi++ = '\0';
111
112
    /* Get the count (atol will stop at the @ if there), and percentage */
113
    md_count = atol(md_failstring);
114
    atsign = strchr(md_failstring, '@');
115
    md_fail_percent = atsign == NULL ? 0 : atoi(atsign + 1);
116
117
    if (semi != NULL)
118
        md_failstring = semi;
119
}
120
121
/*
122
 * Windows doesn't have random(), but it has rand()
123
 * Some rand() implementations aren't good, but we're not
124
 * dealing with secure randomness here.
125
 */
126
# ifdef _WIN32
127
#  define random() rand()
128
# endif
129
/*
130
 * See if the current malloc should fail.
131
 */
132
static int shouldfail(void)
133
{
134
    int roll = (int)(random() % 100);
135
    int shoulditfail = roll < md_fail_percent;
136
# ifndef _WIN32
137
/* suppressed on Windows as POSIX-like file descriptors are non-inheritable */
138
    int len;
139
    char buff[80];
140
141
    if (md_tracefd > 0) {
142
        BIO_snprintf(buff, sizeof(buff),
143
                     "%c C%ld %%%d R%d\n",
144
                     shoulditfail ? '-' : '+', md_count, md_fail_percent, roll);
145
        len = strlen(buff);
146
        if (write(md_tracefd, buff, len) != len)
147
            perror("shouldfail write failed");
148
    }
149
# endif
150
151
    if (md_count) {
152
        /* If we used up this one, go to the next. */
153
        if (--md_count == 0)
154
            parseit();
155
    }
156
157
    return shoulditfail;
158
}
159
160
void ossl_malloc_setup_failures(void)
161
{
162
    const char *cp = getenv("OPENSSL_MALLOC_FAILURES");
163
164
    if (cp != NULL && (md_failstring = strdup(cp)) != NULL)
165
        parseit();
166
    if ((cp = getenv("OPENSSL_MALLOC_FD")) != NULL)
167
        md_tracefd = atoi(cp);
168
}
169
#endif
170
171
void *CRYPTO_malloc(size_t num, const char *file, int line)
172
11.5M
{
173
11.5M
    void *ptr;
174
175
11.5M
    INCREMENT(malloc_count);
176
11.5M
    if (malloc_impl != CRYPTO_malloc) {
177
0
        ptr = malloc_impl(num, file, line);
178
0
        if (ptr != NULL || num == 0)
179
0
            return ptr;
180
0
        goto err;
181
0
    }
182
183
11.5M
    if (num == 0)
184
0
        return NULL;
185
186
11.5M
    FAILTEST();
187
11.5M
    if (allow_customize) {
188
        /*
189
         * Disallow customization after the first allocation. We only set this
190
         * if necessary to avoid a store to the same cache line on every
191
         * allocation.
192
         */
193
2
        allow_customize = 0;
194
2
    }
195
196
11.5M
    ptr = malloc(num);
197
11.5M
    if (ptr != NULL)
198
11.5M
        return ptr;
199
0
 err:
200
    /*
201
     * ossl_err_get_state_int() in err.c uses CRYPTO_zalloc(num, NULL, 0) for
202
     * ERR_STATE allocation. Prevent mem alloc error loop while reporting error.
203
     */
204
0
    if (file != NULL || line != 0) {
205
0
        ERR_new();
206
0
        ERR_set_debug(file, line, NULL);
207
0
        ERR_set_error(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE, NULL);
208
0
    }
209
0
    return NULL;
210
11.5M
}
211
212
void *CRYPTO_zalloc(size_t num, const char *file, int line)
213
7.74M
{
214
7.74M
    void *ret;
215
216
7.74M
    ret = CRYPTO_malloc(num, file, line);
217
7.74M
    if (ret != NULL)
218
7.74M
        memset(ret, 0, num);
219
220
7.74M
    return ret;
221
7.74M
}
222
223
void *CRYPTO_realloc(void *str, size_t num, const char *file, int line)
224
588k
{
225
588k
    INCREMENT(realloc_count);
226
588k
    if (realloc_impl != CRYPTO_realloc)
227
0
        return realloc_impl(str, num, file, line);
228
229
588k
    if (str == NULL)
230
257k
        return CRYPTO_malloc(num, file, line);
231
232
330k
    if (num == 0) {
233
0
        CRYPTO_free(str, file, line);
234
0
        return NULL;
235
0
    }
236
237
330k
    FAILTEST();
238
330k
    return realloc(str, num);
239
330k
}
240
241
void *CRYPTO_clear_realloc(void *str, size_t old_len, size_t num,
242
                           const char *file, int line)
243
219k
{
244
219k
    void *ret = NULL;
245
246
219k
    if (str == NULL)
247
99.1k
        return CRYPTO_malloc(num, file, line);
248
249
120k
    if (num == 0) {
250
0
        CRYPTO_clear_free(str, old_len, file, line);
251
0
        return NULL;
252
0
    }
253
254
    /* Can't shrink the buffer since memcpy below copies |old_len| bytes. */
255
120k
    if (num < old_len) {
256
0
        OPENSSL_cleanse((char*)str + num, old_len - num);
257
0
        return str;
258
0
    }
259
260
120k
    ret = CRYPTO_malloc(num, file, line);
261
120k
    if (ret != NULL) {
262
120k
        memcpy(ret, str, old_len);
263
120k
        CRYPTO_clear_free(str, old_len, file, line);
264
120k
    }
265
120k
    return ret;
266
120k
}
267
268
void CRYPTO_free(void *str, const char *file, int line)
269
18.1M
{
270
18.1M
    INCREMENT(free_count);
271
18.1M
    if (free_impl != CRYPTO_free) {
272
0
        free_impl(str, file, line);
273
0
        return;
274
0
    }
275
276
18.1M
    free(str);
277
18.1M
}
278
279
void CRYPTO_clear_free(void *str, size_t num, const char *file, int line)
280
2.09M
{
281
2.09M
    if (str == NULL)
282
169k
        return;
283
1.92M
    if (num)
284
1.92M
        OPENSSL_cleanse(str, num);
285
1.92M
    CRYPTO_free(str, file, line);
286
1.92M
}
287
288
#if !defined(OPENSSL_NO_CRYPTO_MDEBUG)
289
290
# ifndef OPENSSL_NO_DEPRECATED_3_0
291
int CRYPTO_mem_ctrl(int mode)
292
{
293
    (void)mode;
294
    return -1;
295
}
296
297
int CRYPTO_set_mem_debug(int flag)
298
{
299
    (void)flag;
300
    return -1;
301
}
302
303
int CRYPTO_mem_debug_push(const char *info, const char *file, int line)
304
{
305
    (void)info; (void)file; (void)line;
306
    return 0;
307
}
308
309
int CRYPTO_mem_debug_pop(void)
310
{
311
    return 0;
312
}
313
314
void CRYPTO_mem_debug_malloc(void *addr, size_t num, int flag,
315
                             const char *file, int line)
316
{
317
    (void)addr; (void)num; (void)flag; (void)file; (void)line;
318
}
319
320
void CRYPTO_mem_debug_realloc(void *addr1, void *addr2, size_t num, int flag,
321
                              const char *file, int line)
322
{
323
    (void)addr1; (void)addr2; (void)num; (void)flag; (void)file; (void)line;
324
}
325
326
void CRYPTO_mem_debug_free(void *addr, int flag,
327
                           const char *file, int line)
328
{
329
    (void)addr; (void)flag; (void)file; (void)line;
330
}
331
332
int CRYPTO_mem_leaks(BIO *b)
333
{
334
    (void)b;
335
    return -1;
336
}
337
338
#  ifndef OPENSSL_NO_STDIO
339
int CRYPTO_mem_leaks_fp(FILE *fp)
340
{
341
    (void)fp;
342
    return -1;
343
}
344
#  endif
345
346
int CRYPTO_mem_leaks_cb(int (*cb)(const char *str, size_t len, void *u),
347
                        void *u)
348
{
349
    (void)cb; (void)u;
350
    return -1;
351
}
352
353
# endif
354
355
#endif