Coverage Report

Created: 2025-12-10 06:24

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/crypto/objects/o_names.c
Line
Count
Source
1
/*
2
 * Copyright 1998-2025 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
3
{
52
3
    names_lh = NULL;
53
3
    obj_lock = CRYPTO_THREAD_lock_new();
54
3
    if (obj_lock != NULL)
55
3
        names_lh = lh_OBJ_NAME_new(obj_name_hash, obj_name_cmp);
56
3
    if (names_lh == NULL) {
57
0
        CRYPTO_THREAD_lock_free(obj_lock);
58
0
        obj_lock = NULL;
59
0
    }
60
3
    return names_lh != NULL && obj_lock != NULL;
61
3
}
62
63
int OBJ_NAME_init(void)
64
3.46k
{
65
3.46k
    return RUN_ONCE(&init, o_names_init);
66
3.46k
}
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
            ret = 0;
93
0
            goto out;
94
0
        }
95
0
        name_funcs->hash_func = ossl_lh_strcasehash;
96
0
        name_funcs->cmp_func = OPENSSL_strcasecmp;
97
0
        push = sk_NAME_FUNCS_push(name_funcs_stack, name_funcs);
98
99
0
        if (!push) {
100
0
            ERR_raise(ERR_LIB_OBJ, ERR_R_CRYPTO_LIB);
101
0
            OPENSSL_free(name_funcs);
102
0
            ret = 0;
103
0
            goto out;
104
0
        }
105
0
    }
106
0
    name_funcs = sk_NAME_FUNCS_value(name_funcs_stack, ret);
107
0
    if (hash_func != NULL)
108
0
        name_funcs->hash_func = hash_func;
109
0
    if (cmp_func != NULL)
110
0
        name_funcs->cmp_func = cmp_func;
111
0
    if (free_func != NULL)
112
0
        name_funcs->free_func = free_func;
113
114
0
out:
115
0
    CRYPTO_THREAD_unlock(obj_lock);
116
0
    return ret;
117
0
}
118
119
static int obj_name_cmp(const OBJ_NAME *a, const OBJ_NAME *b)
120
2.76k
{
121
2.76k
    int ret;
122
123
2.76k
    ret = a->type - b->type;
124
2.76k
    if (ret == 0) {
125
2.76k
        if ((name_funcs_stack != NULL)
126
0
            && (sk_NAME_FUNCS_num(name_funcs_stack) > a->type)) {
127
0
            ret = sk_NAME_FUNCS_value(name_funcs_stack,
128
0
                a->type)
129
0
                      ->cmp_func(a->name, b->name);
130
0
        } else
131
2.76k
            ret = OPENSSL_strcasecmp(a->name, b->name);
132
2.76k
    }
133
2.76k
    return ret;
134
2.76k
}
135
136
static unsigned long obj_name_hash(const OBJ_NAME *a)
137
3.80k
{
138
3.80k
    unsigned long ret;
139
140
3.80k
    if ((name_funcs_stack != NULL)
141
0
        && (sk_NAME_FUNCS_num(name_funcs_stack) > a->type)) {
142
0
        ret = sk_NAME_FUNCS_value(name_funcs_stack,
143
0
            a->type)
144
0
                  ->hash_func(a->name);
145
3.80k
    } else {
146
3.80k
        ret = ossl_lh_strcasehash(a->name);
147
3.80k
    }
148
3.80k
    ret ^= a->type;
149
3.80k
    return ret;
150
3.80k
}
151
152
const char *OBJ_NAME_get(const char *name, int type)
153
1.54k
{
154
1.54k
    OBJ_NAME on, *ret;
155
1.54k
    int num = 0, alias;
156
1.54k
    const char *value = NULL;
157
158
1.54k
    if (name == NULL)
159
0
        return NULL;
160
1.54k
    if (!OBJ_NAME_init())
161
0
        return NULL;
162
1.54k
    if (!CRYPTO_THREAD_read_lock(obj_lock))
163
0
        return NULL;
164
165
1.54k
    alias = type & OBJ_NAME_ALIAS;
166
1.54k
    type &= ~OBJ_NAME_ALIAS;
167
168
1.54k
    on.name = name;
169
1.54k
    on.type = type;
170
171
1.88k
    for (;;) {
172
1.88k
        ret = lh_OBJ_NAME_retrieve(names_lh, &on);
173
1.88k
        if (ret == NULL)
174
333
            break;
175
1.55k
        if ((ret->alias) && !alias) {
176
334
            if (++num > 10)
177
0
                break;
178
334
            on.name = ret->data;
179
1.21k
        } else {
180
1.21k
            value = ret->data;
181
1.21k
            break;
182
1.21k
        }
183
1.55k
    }
184
185
1.54k
    CRYPTO_THREAD_unlock(obj_lock);
186
1.54k
    return value;
187
1.54k
}
188
189
int OBJ_NAME_add(const char *name, int type, const char *data)
190
1.21k
{
191
1.21k
    OBJ_NAME *onp, *ret;
192
1.21k
    int alias, ok = 0;
193
194
1.21k
    if (!OBJ_NAME_init())
195
0
        return 0;
196
197
1.21k
    alias = type & OBJ_NAME_ALIAS;
198
1.21k
    type &= ~OBJ_NAME_ALIAS;
199
200
1.21k
    onp = OPENSSL_malloc(sizeof(*onp));
201
1.21k
    if (onp == NULL)
202
0
        return 0;
203
204
1.21k
    onp->name = name;
205
1.21k
    onp->alias = alias;
206
1.21k
    onp->type = type;
207
1.21k
    onp->data = data;
208
209
1.21k
    if (!CRYPTO_THREAD_write_lock(obj_lock)) {
210
0
        OPENSSL_free(onp);
211
0
        return 0;
212
0
    }
213
214
1.21k
    ret = lh_OBJ_NAME_insert(names_lh, onp);
215
1.21k
    if (ret != NULL) {
216
        /* free things */
217
519
        if ((name_funcs_stack != NULL)
218
0
            && (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)
225
0
                ->free_func(ret->name, ret->type,
226
0
                    ret->data);
227
0
        }
228
519
        OPENSSL_free(ret);
229
699
    } else {
230
699
        if (lh_OBJ_NAME_error(names_lh)) {
231
            /* ERROR */
232
0
            OPENSSL_free(onp);
233
0
            goto unlock;
234
0
        }
235
699
    }
236
237
1.21k
    ok = 1;
238
239
1.21k
unlock:
240
1.21k
    CRYPTO_THREAD_unlock(obj_lock);
241
1.21k
    return ok;
242
1.21k
}
243
244
int OBJ_NAME_remove(const char *name, int type)
245
699
{
246
699
    OBJ_NAME on, *ret;
247
699
    int ok = 0;
248
249
699
    if (!OBJ_NAME_init())
250
0
        return 0;
251
252
699
    if (!CRYPTO_THREAD_write_lock(obj_lock))
253
0
        return 0;
254
255
699
    type &= ~OBJ_NAME_ALIAS;
256
699
    on.name = name;
257
699
    on.type = type;
258
699
    ret = lh_OBJ_NAME_delete(names_lh, &on);
259
699
    if (ret != NULL) {
260
        /* free things */
261
699
        if ((name_funcs_stack != NULL)
262
0
            && (sk_NAME_FUNCS_num(name_funcs_stack) > ret->type)) {
263
            /*
264
             * XXX: I'm not sure I understand why the free function should
265
             * get three arguments... -- Richard Levitte
266
             */
267
0
            sk_NAME_FUNCS_value(name_funcs_stack,
268
0
                ret->type)
269
0
                ->free_func(ret->name, ret->type,
270
0
                    ret->data);
271
0
        }
272
699
        OPENSSL_free(ret);
273
699
        ok = 1;
274
699
    }
275
276
699
    CRYPTO_THREAD_unlock(obj_lock);
277
699
    return ok;
278
699
}
279
280
typedef struct {
281
    int type;
282
    void (*fn)(const OBJ_NAME *, void *arg);
283
    void *arg;
284
} OBJ_DOALL;
285
286
static void do_all_fn(const OBJ_NAME *name, OBJ_DOALL *d)
287
1.86k
{
288
1.86k
    if (name->type == d->type)
289
932
        d->fn(name, d->arg);
290
1.86k
}
291
292
IMPLEMENT_LHASH_DOALL_ARG_CONST(OBJ_NAME, OBJ_DOALL);
293
294
void OBJ_NAME_do_all(int type, void (*fn)(const OBJ_NAME *, void *arg),
295
    void *arg)
296
8
{
297
8
    OBJ_DOALL d;
298
299
8
    d.type = type;
300
8
    d.fn = fn;
301
8
    d.arg = arg;
302
303
8
    lh_OBJ_NAME_doall_OBJ_DOALL(names_lh, do_all_fn, &d);
304
8
}
305
306
struct doall_sorted {
307
    int type;
308
    int n;
309
    const OBJ_NAME **names;
310
};
311
312
static void do_all_sorted_fn(const OBJ_NAME *name, void *d_)
313
0
{
314
0
    struct doall_sorted *d = d_;
315
316
0
    if (name->type != d->type)
317
0
        return;
318
319
0
    d->names[d->n++] = name;
320
0
}
321
322
static int do_all_sorted_cmp(const void *n1_, const void *n2_)
323
0
{
324
0
    const OBJ_NAME *const *n1 = n1_;
325
0
    const OBJ_NAME *const *n2 = n2_;
326
327
0
    return strcmp((*n1)->name, (*n2)->name);
328
0
}
329
330
void OBJ_NAME_do_all_sorted(int type,
331
    void (*fn)(const OBJ_NAME *, void *arg),
332
    void *arg)
333
0
{
334
0
    struct doall_sorted d;
335
0
    int n;
336
337
0
    d.type = type;
338
0
    d.names = OPENSSL_malloc_array(lh_OBJ_NAME_num_items(names_lh), sizeof(*d.names));
339
    /* Really should return an error if !d.names...but its a void function! */
340
0
    if (d.names != NULL) {
341
0
        d.n = 0;
342
0
        OBJ_NAME_do_all(type, do_all_sorted_fn, &d);
343
344
0
        qsort((void *)d.names, d.n, sizeof(*d.names), do_all_sorted_cmp);
345
346
0
        for (n = 0; n < d.n; ++n)
347
0
            fn(d.names[n], arg);
348
349
0
        OPENSSL_free((void *)d.names);
350
0
    }
351
0
}
352
353
static int free_type;
354
355
static void names_lh_free_doall(OBJ_NAME *onp)
356
1.57k
{
357
1.57k
    if (onp == NULL)
358
0
        return;
359
360
1.57k
    if (free_type < 0 || free_type == onp->type)
361
699
        OBJ_NAME_remove(onp->name, onp->type);
362
1.57k
}
363
364
static void name_funcs_free(NAME_FUNCS *ptr)
365
0
{
366
0
    OPENSSL_free(ptr);
367
0
}
368
369
void OBJ_NAME_cleanup(int type)
370
12
{
371
12
    unsigned long down_load;
372
373
12
    if (names_lh == NULL)
374
0
        return;
375
376
12
    free_type = type;
377
12
    down_load = lh_OBJ_NAME_get_down_load(names_lh);
378
12
    lh_OBJ_NAME_set_down_load(names_lh, 0);
379
380
12
    lh_OBJ_NAME_doall(names_lh, names_lh_free_doall);
381
12
    if (type < 0) {
382
3
        lh_OBJ_NAME_free(names_lh);
383
3
        sk_NAME_FUNCS_pop_free(name_funcs_stack, name_funcs_free);
384
3
        CRYPTO_THREAD_lock_free(obj_lock);
385
3
        names_lh = NULL;
386
3
        name_funcs_stack = NULL;
387
3
        obj_lock = NULL;
388
3
    } else
389
9
        lh_OBJ_NAME_set_down_load(names_lh, down_load);
390
12
}