xref: /openssl/crypto/property/defn_cache.c (revision 5317b6ee)
1 /*
2  * Copyright 2019-2022 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright (c) 2019, Oracle and/or its affiliates.  All rights reserved.
4  *
5  * Licensed under the Apache License 2.0 (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  */
10 
11 #include <string.h>
12 #include <openssl/err.h>
13 #include <openssl/lhash.h>
14 #include "internal/propertyerr.h"
15 #include "internal/property.h"
16 #include "internal/core.h"
17 #include "property_local.h"
18 #include "crypto/context.h"
19 
20 /*
21  * Implement a property definition cache.
22  * These functions assume that they are called under a write lock.
23  * No attempt is made to clean out the cache, except when it is shut down.
24  */
25 
26 typedef struct {
27     const char *prop;
28     OSSL_PROPERTY_LIST *defn;
29     char body[1];
30 } PROPERTY_DEFN_ELEM;
31 
32 DEFINE_LHASH_OF_EX(PROPERTY_DEFN_ELEM);
33 
property_defn_hash(const PROPERTY_DEFN_ELEM * a)34 static unsigned long property_defn_hash(const PROPERTY_DEFN_ELEM *a)
35 {
36     return OPENSSL_LH_strhash(a->prop);
37 }
38 
property_defn_cmp(const PROPERTY_DEFN_ELEM * a,const PROPERTY_DEFN_ELEM * b)39 static int property_defn_cmp(const PROPERTY_DEFN_ELEM *a,
40                              const PROPERTY_DEFN_ELEM *b)
41 {
42     return strcmp(a->prop, b->prop);
43 }
44 
property_defn_free(PROPERTY_DEFN_ELEM * elem)45 static void property_defn_free(PROPERTY_DEFN_ELEM *elem)
46 {
47     ossl_property_free(elem->defn);
48     OPENSSL_free(elem);
49 }
50 
ossl_property_defns_free(void * vproperty_defns)51 void ossl_property_defns_free(void *vproperty_defns)
52 {
53     LHASH_OF(PROPERTY_DEFN_ELEM) *property_defns = vproperty_defns;
54 
55     if (property_defns != NULL) {
56         lh_PROPERTY_DEFN_ELEM_doall(property_defns,
57                                     &property_defn_free);
58         lh_PROPERTY_DEFN_ELEM_free(property_defns);
59     }
60 }
61 
ossl_property_defns_new(OSSL_LIB_CTX * ctx)62 void *ossl_property_defns_new(OSSL_LIB_CTX *ctx) {
63     return lh_PROPERTY_DEFN_ELEM_new(&property_defn_hash, &property_defn_cmp);
64 }
65 
ossl_prop_defn_get(OSSL_LIB_CTX * ctx,const char * prop)66 OSSL_PROPERTY_LIST *ossl_prop_defn_get(OSSL_LIB_CTX *ctx, const char *prop)
67 {
68     PROPERTY_DEFN_ELEM elem, *r;
69     LHASH_OF(PROPERTY_DEFN_ELEM) *property_defns;
70 
71     property_defns = ossl_lib_ctx_get_data(ctx,
72                                            OSSL_LIB_CTX_PROPERTY_DEFN_INDEX);
73     if (property_defns == NULL || !ossl_lib_ctx_read_lock(ctx))
74         return NULL;
75 
76     elem.prop = prop;
77     r = lh_PROPERTY_DEFN_ELEM_retrieve(property_defns, &elem);
78     ossl_lib_ctx_unlock(ctx);
79     return r != NULL ? r->defn : NULL;
80 }
81 
82 /*
83  * Cache the property list for a given property string. Callers of this function
84  * should call ossl_prop_defn_get first to ensure that there is no existing
85  * cache entry for this property string.
86  */
ossl_prop_defn_set(OSSL_LIB_CTX * ctx,const char * prop,OSSL_PROPERTY_LIST * pl)87 int ossl_prop_defn_set(OSSL_LIB_CTX *ctx, const char *prop,
88                        OSSL_PROPERTY_LIST *pl)
89 {
90     PROPERTY_DEFN_ELEM elem, *old, *p = NULL;
91     size_t len;
92     LHASH_OF(PROPERTY_DEFN_ELEM) *property_defns;
93     int res = 1;
94 
95     property_defns = ossl_lib_ctx_get_data(ctx,
96                                            OSSL_LIB_CTX_PROPERTY_DEFN_INDEX);
97     if (property_defns == NULL)
98         return 0;
99 
100     if (prop == NULL)
101         return 1;
102 
103     if (!ossl_lib_ctx_write_lock(ctx))
104         return 0;
105     if (pl == NULL) {
106         elem.prop = prop;
107         lh_PROPERTY_DEFN_ELEM_delete(property_defns, &elem);
108         goto end;
109     }
110     len = strlen(prop);
111     p = OPENSSL_malloc(sizeof(*p) + len);
112     if (p != NULL) {
113         p->prop = p->body;
114         p->defn = pl;
115         memcpy(p->body, prop, len + 1);
116         old = lh_PROPERTY_DEFN_ELEM_insert(property_defns, p);
117         if (!ossl_assert(old == NULL)) {
118             /*
119              * This should not happen. Any caller of ossl_prop_defn_set should
120              * have called ossl_prop_defn_get first - so we should know that
121              * there is no existing entry. If we get here we have a bug. We
122              * deliberately leak the |old| reference in order to avoid a crash
123              * if there are any existing users of it.
124              */
125             goto end;
126         }
127         if (!lh_PROPERTY_DEFN_ELEM_error(property_defns))
128             goto end;
129     }
130     OPENSSL_free(p);
131     res = 0;
132  end:
133     ossl_lib_ctx_unlock(ctx);
134     return res;
135 }
136