Coverage Report

Created: 2025-06-13 06:58

/src/openssl31/crypto/objects/o_names.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 1998-2022 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 <stdlib.h>
12
#include <string.h>
13
14
#include <openssl/err.h>
15
#include <openssl/lhash.h>
16
#include <openssl/objects.h>
17
#include <openssl/safestack.h>
18
#include <openssl/e_os2.h>
19
#include "internal/thread_once.h"
20
#include "crypto/lhash.h"
21
#include "obj_local.h"
22
#include "internal/e_os.h"
23
24
/*
25
 * I use the ex_data stuff to manage the identifiers for the obj_name_types
26
 * that applications may define.  I only really use the free function field.
27
 */
28
static LHASH_OF(OBJ_NAME) *names_lh = NULL;
29
static int names_type_num = OBJ_NAME_TYPE_NUM;
30
static CRYPTO_RWLOCK *obj_lock = NULL;
31
32
struct name_funcs_st {
33
    unsigned long (*hash_func) (const char *name);
34
    int (*cmp_func) (const char *a, const char *b);
35
    void (*free_func) (const char *, int, const char *);
36
};
37
38
static STACK_OF(NAME_FUNCS) *name_funcs_stack;
39
40
/*
41
 * The LHASH callbacks now use the raw "void *" prototypes and do
42
 * per-variable casting in the functions. This prevents function pointer
43
 * casting without the need for macro-generated wrapper functions.
44
 */
45
46
static unsigned long obj_name_hash(const OBJ_NAME *a);
47
static int obj_name_cmp(const OBJ_NAME *a, const OBJ_NAME *b);
48
49
static CRYPTO_ONCE init = CRYPTO_ONCE_STATIC_INIT;
50
DEFINE_RUN_ONCE_STATIC(o_names_init)
51
71
{
52
71
    names_lh = NULL;
53
71
    obj_lock = CRYPTO_THREAD_lock_new();
54
71
    if (obj_lock != NULL)
55
71
        names_lh = lh_OBJ_NAME_new(obj_name_hash, obj_name_cmp);
56
71
    if (names_lh == NULL) {
57
0
        CRYPTO_THREAD_lock_free(obj_lock);
58
0
        obj_lock = NULL;
59
0
    }
60
71
    return names_lh != NULL && obj_lock != NULL;
61
71
}
62
63
int OBJ_NAME_init(void)
64
157k
{
65
157k
    return RUN_ONCE(&init, o_names_init);
66
157k
}
67
68
int OBJ_NAME_new_index(unsigned long (*hash_func) (const char *),
69
                       int (*cmp_func) (const char *, const char *),
70
                       void (*free_func) (const char *, int, const char *))
71
0
{
72
0
    int ret = 0, i, push;
73
0
    NAME_FUNCS *name_funcs;
74
75
0
    if (!OBJ_NAME_init())
76
0
        return 0;
77
78
0
    if (!CRYPTO_THREAD_write_lock(obj_lock))
79
0
        return 0;
80
81
0
    if (name_funcs_stack == NULL)
82
0
        name_funcs_stack = sk_NAME_FUNCS_new_null();
83
0
    if (name_funcs_stack == NULL) {
84
        /* ERROR */
85
0
        goto out;
86
0
    }
87
0
    ret = names_type_num;
88
0
    names_type_num++;
89
0
    for (i = sk_NAME_FUNCS_num(name_funcs_stack); i < names_type_num; i++) {
90
0
        name_funcs = OPENSSL_zalloc(sizeof(*name_funcs));
91
0
        if (name_funcs == NULL) {
92
0
            ERR_raise(ERR_LIB_OBJ, ERR_R_MALLOC_FAILURE);
93
0
            ret = 0;
94
0
            goto out;
95
0
        }
96
0
        name_funcs->hash_func = ossl_lh_strcasehash;
97
0
        name_funcs->cmp_func = OPENSSL_strcasecmp;
98
0
        push = sk_NAME_FUNCS_push(name_funcs_stack, name_funcs);
99
100
0
        if (!push) {
101
0
            ERR_raise(ERR_LIB_OBJ, ERR_R_MALLOC_FAILURE);
102
0
            OPENSSL_free(name_funcs);
103
0
            ret = 0;
104
0
            goto out;
105
0
        }
106
0
    }
107
0
    name_funcs = sk_NAME_FUNCS_value(name_funcs_stack, ret);
108
0
    if (hash_func != NULL)
109
0
        name_funcs->hash_func = hash_func;
110
0
    if (cmp_func != NULL)
111
0
        name_funcs->cmp_func = cmp_func;
112
0
    if (free_func != NULL)
113
0
        name_funcs->free_func = free_func;
114
115
0
out:
116
0
    CRYPTO_THREAD_unlock(obj_lock);
117
0
    return ret;
118
0
}
119
120
static int obj_name_cmp(const OBJ_NAME *a, const OBJ_NAME *b)
121
138k
{
122
138k
    int ret;
123
124
138k
    ret = a->type - b->type;
125
138k
    if (ret == 0) {
126
138k
        if ((name_funcs_stack != NULL)
127
138k
            && (sk_NAME_FUNCS_num(name_funcs_stack) > a->type)) {
128
0
            ret = sk_NAME_FUNCS_value(name_funcs_stack,
129
0
                                      a->type)->cmp_func(a->name, b->name);
130
0
        } else
131
138k
            ret = OPENSSL_strcasecmp(a->name, b->name);
132
138k
    }
133
138k
    return ret;
134
138k
}
135
136
static unsigned long obj_name_hash(const OBJ_NAME *a)
137
161k
{
138
161k
    unsigned long ret;
139
140
161k
    if ((name_funcs_stack != NULL)
141
161k
        && (sk_NAME_FUNCS_num(name_funcs_stack) > a->type)) {
142
0
        ret =
143
0
            sk_NAME_FUNCS_value(name_funcs_stack,
144
0
                                a->type)->hash_func(a->name);
145
161k
    } else {
146
161k
        ret = ossl_lh_strcasehash(a->name);
147
161k
    }
148
161k
    ret ^= a->type;
149
161k
    return ret;
150
161k
}
151
152
const char *OBJ_NAME_get(const char *name, int type)
153
110k
{
154
110k
    OBJ_NAME on, *ret;
155
110k
    int num = 0, alias;
156
110k
    const char *value = NULL;
157
158
110k
    if (name == NULL)
159
0
        return NULL;
160
110k
    if (!OBJ_NAME_init())
161
0
        return NULL;
162
110k
    if (!CRYPTO_THREAD_read_lock(obj_lock))
163
0
        return NULL;
164
165
110k
    alias = type & OBJ_NAME_ALIAS;
166
110k
    type &= ~OBJ_NAME_ALIAS;
167
168
110k
    on.name = name;
169
110k
    on.type = type;
170
171
114k
    for (;;) {
172
114k
        ret = lh_OBJ_NAME_retrieve(names_lh, &on);
173
114k
        if (ret == NULL)
174
5.90k
            break;
175
108k
        if ((ret->alias) && !alias) {
176
3.87k
            if (++num > 10)
177
0
                break;
178
3.87k
            on.name = ret->data;
179
104k
        } else {
180
104k
            value = ret->data;
181
104k
            break;
182
104k
        }
183
108k
    }
184
185
110k
    CRYPTO_THREAD_unlock(obj_lock);
186
110k
    return value;
187
110k
}
188
189
int OBJ_NAME_add(const char *name, int type, const char *data)
190
30.0k
{
191
30.0k
    OBJ_NAME *onp, *ret;
192
30.0k
    int alias, ok = 0;
193
194
30.0k
    if (!OBJ_NAME_init())
195
0
        return 0;
196
197
30.0k
    alias = type & OBJ_NAME_ALIAS;
198
30.0k
    type &= ~OBJ_NAME_ALIAS;
199
200
30.0k
    onp = OPENSSL_malloc(sizeof(*onp));
201
30.0k
    if (onp == NULL)
202
0
        return 0;
203
204
30.0k
    onp->name = name;
205
30.0k
    onp->alias = alias;
206
30.0k
    onp->type = type;
207
30.0k
    onp->data = data;
208
209
30.0k
    if (!CRYPTO_THREAD_write_lock(obj_lock)) {
210
0
        OPENSSL_free(onp);
211
0
        return 0;
212
0
    }
213
214
30.0k
    ret = lh_OBJ_NAME_insert(names_lh, onp);
215
30.0k
    if (ret != NULL) {
216
        /* free things */
217
12.9k
        if ((name_funcs_stack != NULL)
218
12.9k
            && (sk_NAME_FUNCS_num(name_funcs_stack) > ret->type)) {
219
            /*
220
             * XXX: I'm not sure I understand why the free function should
221
             * get three arguments... -- Richard Levitte
222
             */
223
0
            sk_NAME_FUNCS_value(name_funcs_stack,
224
0
                                ret->type)->free_func(ret->name, ret->type,
225
0
                                                      ret->data);
226
0
        }
227
12.9k
        OPENSSL_free(ret);
228
17.1k
    } else {
229
17.1k
        if (lh_OBJ_NAME_error(names_lh)) {
230
            /* ERROR */
231
0
            OPENSSL_free(onp);
232
0
            goto unlock;
233
0
        }
234
17.1k
    }
235
236
30.0k
    ok = 1;
237
238
30.0k
unlock:
239
30.0k
    CRYPTO_THREAD_unlock(obj_lock);
240
30.0k
    return ok;
241
30.0k
}
242
243
int OBJ_NAME_remove(const char *name, int type)
244
17.1k
{
245
17.1k
    OBJ_NAME on, *ret;
246
17.1k
    int ok = 0;
247
248
17.1k
    if (!OBJ_NAME_init())
249
0
        return 0;
250
251
17.1k
    if (!CRYPTO_THREAD_write_lock(obj_lock))
252
0
        return 0;
253
254
17.1k
    type &= ~OBJ_NAME_ALIAS;
255
17.1k
    on.name = name;
256
17.1k
    on.type = type;
257
17.1k
    ret = lh_OBJ_NAME_delete(names_lh, &on);
258
17.1k
    if (ret != NULL) {
259
        /* free things */
260
17.1k
        if ((name_funcs_stack != NULL)
261
17.1k
            && (sk_NAME_FUNCS_num(name_funcs_stack) > ret->type)) {
262
            /*
263
             * XXX: I'm not sure I understand why the free function should
264
             * get three arguments... -- Richard Levitte
265
             */
266
0
            sk_NAME_FUNCS_value(name_funcs_stack,
267
0
                                ret->type)->free_func(ret->name, ret->type,
268
0
                                                      ret->data);
269
0
        }
270
17.1k
        OPENSSL_free(ret);
271
17.1k
        ok = 1;
272
17.1k
    }
273
274
17.1k
    CRYPTO_THREAD_unlock(obj_lock);
275
17.1k
    return ok;
276
17.1k
}
277
278
typedef struct {
279
    int type;
280
    void (*fn) (const OBJ_NAME *, void *arg);
281
    void *arg;
282
} OBJ_DOALL;
283
284
static void do_all_fn(const OBJ_NAME *name, OBJ_DOALL *d)
285
21.6k
{
286
21.6k
    if (name->type == d->type)
287
10.8k
        d->fn(name, d->arg);
288
21.6k
}
289
290
IMPLEMENT_LHASH_DOALL_ARG_CONST(OBJ_NAME, OBJ_DOALL);
291
292
void OBJ_NAME_do_all(int type, void (*fn) (const OBJ_NAME *, void *arg),
293
                     void *arg)
294
90
{
295
90
    OBJ_DOALL d;
296
297
90
    d.type = type;
298
90
    d.fn = fn;
299
90
    d.arg = arg;
300
301
90
    lh_OBJ_NAME_doall_OBJ_DOALL(names_lh, do_all_fn, &d);
302
90
}
303
304
struct doall_sorted {
305
    int type;
306
    int n;
307
    const OBJ_NAME **names;
308
};
309
310
static void do_all_sorted_fn(const OBJ_NAME *name, void *d_)
311
0
{
312
0
    struct doall_sorted *d = d_;
313
314
0
    if (name->type != d->type)
315
0
        return;
316
317
0
    d->names[d->n++] = name;
318
0
}
319
320
static int do_all_sorted_cmp(const void *n1_, const void *n2_)
321
0
{
322
0
    const OBJ_NAME *const *n1 = n1_;
323
0
    const OBJ_NAME *const *n2 = n2_;
324
325
0
    return strcmp((*n1)->name, (*n2)->name);
326
0
}
327
328
void OBJ_NAME_do_all_sorted(int type,
329
                            void (*fn) (const OBJ_NAME *, void *arg),
330
                            void *arg)
331
0
{
332
0
    struct doall_sorted d;
333
0
    int n;
334
335
0
    d.type = type;
336
0
    d.names =
337
0
        OPENSSL_malloc(sizeof(*d.names) * lh_OBJ_NAME_num_items(names_lh));
338
    /* Really should return an error if !d.names...but its a void function! */
339
0
    if (d.names != NULL) {
340
0
        d.n = 0;
341
0
        OBJ_NAME_do_all(type, do_all_sorted_fn, &d);
342
343
0
        qsort((void *)d.names, d.n, sizeof(*d.names), do_all_sorted_cmp);
344
345
0
        for (n = 0; n < d.n; ++n)
346
0
            fn(d.names[n], arg);
347
348
0
        OPENSSL_free((void *)d.names);
349
0
    }
350
0
}
351
352
static int free_type;
353
354
static void names_lh_free_doall(OBJ_NAME *onp)
355
38.4k
{
356
38.4k
    if (onp == NULL)
357
0
        return;
358
359
38.4k
    if (free_type < 0 || free_type == onp->type)
360
17.1k
        OBJ_NAME_remove(onp->name, onp->type);
361
38.4k
}
362
363
static void name_funcs_free(NAME_FUNCS *ptr)
364
0
{
365
0
    OPENSSL_free(ptr);
366
0
}
367
368
void OBJ_NAME_cleanup(int type)
369
532
{
370
532
    unsigned long down_load;
371
372
532
    if (names_lh == NULL)
373
248
        return;
374
375
284
    free_type = type;
376
284
    down_load = lh_OBJ_NAME_get_down_load(names_lh);
377
284
    lh_OBJ_NAME_set_down_load(names_lh, 0);
378
379
284
    lh_OBJ_NAME_doall(names_lh, names_lh_free_doall);
380
284
    if (type < 0) {
381
71
        lh_OBJ_NAME_free(names_lh);
382
71
        sk_NAME_FUNCS_pop_free(name_funcs_stack, name_funcs_free);
383
71
        CRYPTO_THREAD_lock_free(obj_lock);
384
71
        names_lh = NULL;
385
71
        name_funcs_stack = NULL;
386
71
        obj_lock = NULL;
387
71
    } else
388
213
        lh_OBJ_NAME_set_down_load(names_lh, down_load);
389
284
}