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