/src/openssl30/crypto/store/store_register.c

Source (jump to first uncovered line)
/*
 * Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <string.h>
#include "crypto/ctype.h"
#include <assert.h>

#include <openssl/err.h>
#include <openssl/lhash.h>
#include "store_local.h"

static CRYPTO_RWLOCK *registry_lock;
static CRYPTO_ONCE registry_init = CRYPTO_ONCE_STATIC_INIT;

DEFINE_RUN_ONCE_STATIC(do_registry_init)
{
    registry_lock = CRYPTO_THREAD_lock_new();
    return registry_lock != NULL;
}

/*
 *  Functions for manipulating OSSL_STORE_LOADERs
 */

OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme)
{
    OSSL_STORE_LOADER *res = NULL;

    /*
     * We usually don't check NULL arguments.  For loaders, though, the
     * scheme is crucial and must never be NULL, or the user will get
     * mysterious errors when trying to register the created loader
     * later on.
     */
    if (scheme == NULL) {
        ERR_raise(ERR_LIB_OSSL_STORE, OSSL_STORE_R_INVALID_SCHEME);
        return NULL;
    }

    if ((res = OPENSSL_zalloc(sizeof(*res))) == NULL) {
        ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_MALLOC_FAILURE);
        return NULL;
    }

    res->engine = e;
    res->scheme = scheme;
    return res;
}

const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER *loader)
{
    return loader->engine;
}

const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER *loader)
{
    return loader->scheme;
}

int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *loader,
                               OSSL_STORE_open_fn open_function)
{
    loader->open = open_function;
    return 1;
}

int OSSL_STORE_LOADER_set_open_ex
    (OSSL_STORE_LOADER *loader,
     OSSL_STORE_open_ex_fn open_ex_function)
{
    loader->open_ex = open_ex_function;
    return 1;
}

int OSSL_STORE_LOADER_set_attach(OSSL_STORE_LOADER *loader,
                                 OSSL_STORE_attach_fn attach_function)
{
    loader->attach = attach_function;
    return 1;
}

int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *loader,
                               OSSL_STORE_ctrl_fn ctrl_function)
{
    loader->ctrl = ctrl_function;
    return 1;
}

int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER *loader,
                                 OSSL_STORE_expect_fn expect_function)
{
    loader->expect = expect_function;
    return 1;
}

int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER *loader,
                               OSSL_STORE_find_fn find_function)
{
    loader->find = find_function;
    return 1;
}

int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *loader,
                               OSSL_STORE_load_fn load_function)
{
    loader->load = load_function;
    return 1;
}

int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *loader,
                              OSSL_STORE_eof_fn eof_function)
{
    loader->eof = eof_function;
    return 1;
}

int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *loader,
                                OSSL_STORE_error_fn error_function)
{
    loader->error = error_function;
    return 1;
}

int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *loader,
                                OSSL_STORE_close_fn close_function)
{
    loader->closefn = close_function;
    return 1;
}

/*
 *  Functions for registering OSSL_STORE_LOADERs
 */

static unsigned long store_loader_hash(const OSSL_STORE_LOADER *v)
{
    return OPENSSL_LH_strhash(v->scheme);
}

static int store_loader_cmp(const OSSL_STORE_LOADER *a,
                            const OSSL_STORE_LOADER *b)
{
    assert(a->scheme != NULL && b->scheme != NULL);
    return strcmp(a->scheme, b->scheme);
}

static LHASH_OF(OSSL_STORE_LOADER) *loader_register = NULL;
static int ossl_store_register_init(void)
{
    if (loader_register == NULL) {
        loader_register = lh_OSSL_STORE_LOADER_new(store_loader_hash,
                                                   store_loader_cmp);
    }
    return loader_register != NULL;
}

int ossl_store_register_loader_int(OSSL_STORE_LOADER *loader)
{
    const char *scheme = loader->scheme;
    int ok = 0;

    /*
     * Check that the given scheme conforms to correct scheme syntax as per
     * RFC 3986:
     *
     * scheme        = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
     */
    if (ossl_isalpha(*scheme))
        while (*scheme != '\0'
               && (ossl_isalpha(*scheme)
                   || ossl_isdigit(*scheme)
                   || strchr("+-.", *scheme) != NULL))
            scheme++;
    if (*scheme != '\0') {
        ERR_raise_data(ERR_LIB_OSSL_STORE, OSSL_STORE_R_INVALID_SCHEME,
                       "scheme=%s", loader->scheme);
        return 0;
    }

    /* Check that functions we absolutely require are present */
    if (loader->open == NULL || loader->load == NULL || loader->eof == NULL
        || loader->error == NULL || loader->closefn == NULL) {
        ERR_raise(ERR_LIB_OSSL_STORE, OSSL_STORE_R_LOADER_INCOMPLETE);
        return 0;
    }

    if (!RUN_ONCE(&registry_init, do_registry_init)) {
        ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_MALLOC_FAILURE);
        return 0;
    }
    if (!CRYPTO_THREAD_write_lock(registry_lock))
        return 0;

    if (ossl_store_register_init()
        && (lh_OSSL_STORE_LOADER_insert(loader_register, loader) != NULL
            || lh_OSSL_STORE_LOADER_error(loader_register) == 0))
        ok = 1;

    CRYPTO_THREAD_unlock(registry_lock);

    return ok;
}
int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader)
{
    return ossl_store_register_loader_int(loader);
}

const OSSL_STORE_LOADER *ossl_store_get0_loader_int(const char *scheme)
{
    OSSL_STORE_LOADER template;
    OSSL_STORE_LOADER *loader = NULL;

    template.scheme = scheme;
    template.open = NULL;
    template.load = NULL;
    template.eof = NULL;
    template.closefn = NULL;
    template.open_ex = NULL;

    if (!RUN_ONCE(&registry_init, do_registry_init)) {
        ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_MALLOC_FAILURE);
        return NULL;
    }
    if (!CRYPTO_THREAD_write_lock(registry_lock))
        return NULL;

    if (!ossl_store_register_init())
        ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_INTERNAL_ERROR);
    else if ((loader = lh_OSSL_STORE_LOADER_retrieve(loader_register,
                                                     &template)) == NULL)
        ERR_raise_data(ERR_LIB_OSSL_STORE, OSSL_STORE_R_UNREGISTERED_SCHEME,
                       "scheme=%s", scheme);

    CRYPTO_THREAD_unlock(registry_lock);

    return loader;
}

OSSL_STORE_LOADER *ossl_store_unregister_loader_int(const char *scheme)
{
    OSSL_STORE_LOADER template;
    OSSL_STORE_LOADER *loader = NULL;

    template.scheme = scheme;
    template.open = NULL;
    template.load = NULL;
    template.eof = NULL;
    template.closefn = NULL;

    if (!RUN_ONCE(&registry_init, do_registry_init)) {
        ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_MALLOC_FAILURE);
        return NULL;
    }
    if (!CRYPTO_THREAD_write_lock(registry_lock))
        return NULL;

    if (!ossl_store_register_init())
        ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_INTERNAL_ERROR);
    else if ((loader = lh_OSSL_STORE_LOADER_delete(loader_register,
                                                   &template)) == NULL)
        ERR_raise_data(ERR_LIB_OSSL_STORE, OSSL_STORE_R_UNREGISTERED_SCHEME,
                       "scheme=%s", scheme);

    CRYPTO_THREAD_unlock(registry_lock);

    return loader;
}
OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme)
{
    return ossl_store_unregister_loader_int(scheme);
}

void ossl_store_destroy_loaders_int(void)
{
    lh_OSSL_STORE_LOADER_free(loader_register);
    loader_register = NULL;
    CRYPTO_THREAD_lock_free(registry_lock);
    registry_lock = NULL;
}

/*
 *  Functions to list OSSL_STORE loaders
 */

IMPLEMENT_LHASH_DOALL_ARG_CONST(OSSL_STORE_LOADER, void);
int OSSL_STORE_do_all_loaders(void (*do_function) (const OSSL_STORE_LOADER
                                                   *loader, void *do_arg),
                              void *do_arg)
{
    if (ossl_store_register_init())
        lh_OSSL_STORE_LOADER_doall_void(loader_register, do_function, do_arg);
    return 1;
}

Coverage Report

Created: 2023-09-25 06:45

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 2016-2021 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 <string.h>
11		#include "crypto/ctype.h"
12		#include <assert.h>
13
14		#include <openssl/err.h>
15		#include <openssl/lhash.h>
16		#include "store_local.h"
17
18		static CRYPTO_RWLOCK *registry_lock;
19		static CRYPTO_ONCE registry_init = CRYPTO_ONCE_STATIC_INIT;
20
21		DEFINE_RUN_ONCE_STATIC(do_registry_init)
22	0	{
23	0	registry_lock = CRYPTO_THREAD_lock_new();
24	0	return registry_lock != NULL;
25	0	}
26
27		/*
28		* Functions for manipulating OSSL_STORE_LOADERs
29		*/
30
31		OSSL_STORE_LOADER OSSL_STORE_LOADER_new(ENGINE e, const char *scheme)
32	0	{
33	0	OSSL_STORE_LOADER *res = NULL;
34
35		/*
36		* We usually don't check NULL arguments. For loaders, though, the
37		* scheme is crucial and must never be NULL, or the user will get
38		* mysterious errors when trying to register the created loader
39		* later on.
40		*/
41	0	if (scheme == NULL) {
42	0	ERR_raise(ERR_LIB_OSSL_STORE, OSSL_STORE_R_INVALID_SCHEME);
43	0	return NULL;
44	0	}
45
46	0	if ((res = OPENSSL_zalloc(sizeof(*res))) == NULL) {
47	0	ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_MALLOC_FAILURE);
48	0	return NULL;
49	0	}
50
51	0	res->engine = e;
52	0	res->scheme = scheme;
53	0	return res;
54	0	}
55
56		const ENGINE OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER loader)
57	0	{
58	0	return loader->engine;
59	0	}
60
61		const char OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER loader)
62	0	{
63	0	return loader->scheme;
64	0	}
65
66		int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *loader,
67		OSSL_STORE_open_fn open_function)
68	0	{
69	0	loader->open = open_function;
70	0	return 1;
71	0	}
72
73		int OSSL_STORE_LOADER_set_open_ex
74		(OSSL_STORE_LOADER *loader,
75		OSSL_STORE_open_ex_fn open_ex_function)
76	0	{
77	0	loader->open_ex = open_ex_function;
78	0	return 1;
79	0	}
80
81		int OSSL_STORE_LOADER_set_attach(OSSL_STORE_LOADER *loader,
82		OSSL_STORE_attach_fn attach_function)
83	0	{
84	0	loader->attach = attach_function;
85	0	return 1;
86	0	}
87
88		int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *loader,
89		OSSL_STORE_ctrl_fn ctrl_function)
90	0	{
91	0	loader->ctrl = ctrl_function;
92	0	return 1;
93	0	}
94
95		int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER *loader,
96		OSSL_STORE_expect_fn expect_function)
97	0	{
98	0	loader->expect = expect_function;
99	0	return 1;
100	0	}
101
102		int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER *loader,
103		OSSL_STORE_find_fn find_function)
104	0	{
105	0	loader->find = find_function;
106	0	return 1;
107	0	}
108
109		int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *loader,
110		OSSL_STORE_load_fn load_function)
111	0	{
112	0	loader->load = load_function;
113	0	return 1;
114	0	}
115
116		int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *loader,
117		OSSL_STORE_eof_fn eof_function)
118	0	{
119	0	loader->eof = eof_function;
120	0	return 1;
121	0	}
122
123		int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *loader,
124		OSSL_STORE_error_fn error_function)
125	0	{
126	0	loader->error = error_function;
127	0	return 1;
128	0	}
129
130		int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *loader,
131		OSSL_STORE_close_fn close_function)
132	0	{
133	0	loader->closefn = close_function;
134	0	return 1;
135	0	}
136
137		/*
138		* Functions for registering OSSL_STORE_LOADERs
139		*/
140
141		static unsigned long store_loader_hash(const OSSL_STORE_LOADER *v)
142	0	{
143	0	return OPENSSL_LH_strhash(v->scheme);
144	0	}
145
146		static int store_loader_cmp(const OSSL_STORE_LOADER *a,
147		const OSSL_STORE_LOADER *b)
148	0	{
149	0	assert(a->scheme != NULL && b->scheme != NULL);
150	0	return strcmp(a->scheme, b->scheme);
151	0	}
152
153		static LHASH_OF(OSSL_STORE_LOADER) *loader_register = NULL;
154		static int ossl_store_register_init(void)
155	0	{
156	0	if (loader_register == NULL) {
157	0	loader_register = lh_OSSL_STORE_LOADER_new(store_loader_hash,
158	0	store_loader_cmp);
159	0	}
160	0	return loader_register != NULL;
161	0	}
162
163		int ossl_store_register_loader_int(OSSL_STORE_LOADER *loader)
164	0	{
165	0	const char *scheme = loader->scheme;
166	0	int ok = 0;
167
168		/*
169		* Check that the given scheme conforms to correct scheme syntax as per
170		* RFC 3986:
171		*
172		* scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
173		*/
174	0	if (ossl_isalpha(*scheme))
175	0	while (*scheme != '\0'
176	0	&& (ossl_isalpha(*scheme)
177	0	\|\| ossl_isdigit(*scheme)
178	0	\|\| strchr("+-.", *scheme) != NULL))
179	0	scheme++;
180	0	if (*scheme != '\0') {
181	0	ERR_raise_data(ERR_LIB_OSSL_STORE, OSSL_STORE_R_INVALID_SCHEME,
182	0	"scheme=%s", loader->scheme);
183	0	return 0;
184	0	}
185
186		/* Check that functions we absolutely require are present */
187	0	if (loader->open == NULL \|\| loader->load == NULL \|\| loader->eof == NULL
188	0	\|\| loader->error == NULL \|\| loader->closefn == NULL) {
189	0	ERR_raise(ERR_LIB_OSSL_STORE, OSSL_STORE_R_LOADER_INCOMPLETE);
190	0	return 0;
191	0	}
192
193	0	if (!RUN_ONCE(&registry_init, do_registry_init)) {
194	0	ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_MALLOC_FAILURE);
195	0	return 0;
196	0	}
197	0	if (!CRYPTO_THREAD_write_lock(registry_lock))
198	0	return 0;
199
200	0	if (ossl_store_register_init()
201	0	&& (lh_OSSL_STORE_LOADER_insert(loader_register, loader) != NULL
202	0	\|\| lh_OSSL_STORE_LOADER_error(loader_register) == 0))
203	0	ok = 1;
204
205	0	CRYPTO_THREAD_unlock(registry_lock);
206
207	0	return ok;
208	0	}
209		int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader)
210	0	{
211	0	return ossl_store_register_loader_int(loader);
212	0	}
213
214		const OSSL_STORE_LOADER ossl_store_get0_loader_int(const char scheme)
215	0	{
216	0	OSSL_STORE_LOADER template;
217	0	OSSL_STORE_LOADER *loader = NULL;
218
219	0	template.scheme = scheme;
220	0	template.open = NULL;
221	0	template.load = NULL;
222	0	template.eof = NULL;
223	0	template.closefn = NULL;
224	0	template.open_ex = NULL;
225
226	0	if (!RUN_ONCE(&registry_init, do_registry_init)) {
227	0	ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_MALLOC_FAILURE);
228	0	return NULL;
229	0	}
230	0	if (!CRYPTO_THREAD_write_lock(registry_lock))
231	0	return NULL;
232
233	0	if (!ossl_store_register_init())
234	0	ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_INTERNAL_ERROR);
235	0	else if ((loader = lh_OSSL_STORE_LOADER_retrieve(loader_register,
236	0	&template)) == NULL)
237	0	ERR_raise_data(ERR_LIB_OSSL_STORE, OSSL_STORE_R_UNREGISTERED_SCHEME,
238	0	"scheme=%s", scheme);
239
240	0	CRYPTO_THREAD_unlock(registry_lock);
241
242	0	return loader;
243	0	}
244
245		OSSL_STORE_LOADER ossl_store_unregister_loader_int(const char scheme)
246	0	{
247	0	OSSL_STORE_LOADER template;
248	0	OSSL_STORE_LOADER *loader = NULL;
249
250	0	template.scheme = scheme;
251	0	template.open = NULL;
252	0	template.load = NULL;
253	0	template.eof = NULL;
254	0	template.closefn = NULL;
255
256	0	if (!RUN_ONCE(&registry_init, do_registry_init)) {
257	0	ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_MALLOC_FAILURE);
258	0	return NULL;
259	0	}
260	0	if (!CRYPTO_THREAD_write_lock(registry_lock))
261	0	return NULL;
262
263	0	if (!ossl_store_register_init())
264	0	ERR_raise(ERR_LIB_OSSL_STORE, ERR_R_INTERNAL_ERROR);
265	0	else if ((loader = lh_OSSL_STORE_LOADER_delete(loader_register,
266	0	&template)) == NULL)
267	0	ERR_raise_data(ERR_LIB_OSSL_STORE, OSSL_STORE_R_UNREGISTERED_SCHEME,
268	0	"scheme=%s", scheme);
269
270	0	CRYPTO_THREAD_unlock(registry_lock);
271
272	0	return loader;
273	0	}
274		OSSL_STORE_LOADER OSSL_STORE_unregister_loader(const char scheme)
275	0	{
276	0	return ossl_store_unregister_loader_int(scheme);
277	0	}
278
279		void ossl_store_destroy_loaders_int(void)
280	54	{
281	54	lh_OSSL_STORE_LOADER_free(loader_register);
282	54	loader_register = NULL;
283	54	CRYPTO_THREAD_lock_free(registry_lock);
284	54	registry_lock = NULL;
285	54	}
286
287		/*
288		* Functions to list OSSL_STORE loaders
289		*/
290
291		IMPLEMENT_LHASH_DOALL_ARG_CONST(OSSL_STORE_LOADER, void);
292		int OSSL_STORE_do_all_loaders(void (*do_function) (const OSSL_STORE_LOADER
293		loader, void do_arg),
294		void *do_arg)
295	0	{
296	0	if (ossl_store_register_init())
297	0	lh_OSSL_STORE_LOADER_doall_void(loader_register, do_function, do_arg);
298	0	return 1;
299	0	}