2 * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
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
11 #include "crypto/ctype.h"
14 #include <openssl/err.h>
15 #include <openssl/lhash.h>
16 #include "store_locl.h"
18 static CRYPTO_RWLOCK
*registry_lock
;
19 static CRYPTO_ONCE registry_init
= CRYPTO_ONCE_STATIC_INIT
;
21 DEFINE_RUN_ONCE_STATIC(do_registry_init
)
23 registry_lock
= CRYPTO_THREAD_lock_new();
24 return registry_lock
!= NULL
;
28 * Functions for manipulating OSSL_STORE_LOADERs
31 OSSL_STORE_LOADER
*OSSL_STORE_LOADER_new(ENGINE
*e
, const char *scheme
)
33 OSSL_STORE_LOADER
*res
= NULL
;
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
42 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_LOADER_NEW
,
43 OSSL_STORE_R_INVALID_SCHEME
);
47 if ((res
= OPENSSL_zalloc(sizeof(*res
))) == NULL
) {
48 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_LOADER_NEW
, ERR_R_MALLOC_FAILURE
);
57 const ENGINE
*OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER
*loader
)
59 return loader
->engine
;
62 const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER
*loader
)
64 return loader
->scheme
;
67 int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER
*loader
,
68 OSSL_STORE_open_fn open_function
)
70 loader
->open
= open_function
;
74 int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER
*loader
,
75 OSSL_STORE_ctrl_fn ctrl_function
)
77 loader
->ctrl
= ctrl_function
;
81 int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER
*loader
,
82 OSSL_STORE_expect_fn expect_function
)
84 loader
->expect
= expect_function
;
88 int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER
*loader
,
89 OSSL_STORE_find_fn find_function
)
91 loader
->find
= find_function
;
95 int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER
*loader
,
96 OSSL_STORE_load_fn load_function
)
98 loader
->load
= load_function
;
102 int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER
*loader
,
103 OSSL_STORE_eof_fn eof_function
)
105 loader
->eof
= eof_function
;
109 int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER
*loader
,
110 OSSL_STORE_error_fn error_function
)
112 loader
->error
= error_function
;
116 int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER
*loader
,
117 OSSL_STORE_close_fn close_function
)
119 loader
->close
= close_function
;
123 void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER
*loader
)
125 OPENSSL_free(loader
);
129 * Functions for registering OSSL_STORE_LOADERs
132 static unsigned long store_loader_hash(const OSSL_STORE_LOADER
*v
)
134 return OPENSSL_LH_strhash(v
->scheme
);
137 static int store_loader_cmp(const OSSL_STORE_LOADER
*a
,
138 const OSSL_STORE_LOADER
*b
)
140 assert(a
->scheme
!= NULL
&& b
->scheme
!= NULL
);
141 return strcmp(a
->scheme
, b
->scheme
);
144 static LHASH_OF(OSSL_STORE_LOADER
) *loader_register
= NULL
;
146 int ossl_store_register_loader_int(OSSL_STORE_LOADER
*loader
)
148 const char *scheme
= loader
->scheme
;
152 * Check that the given scheme conforms to correct scheme syntax as per
155 * scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
157 if (ossl_isalpha(*scheme
))
158 while (*scheme
!= '\0'
159 && (ossl_isalpha(*scheme
)
160 || ossl_isdigit(*scheme
)
161 || strchr("+-.", *scheme
) != NULL
))
163 if (*scheme
!= '\0') {
164 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_REGISTER_LOADER_INT
,
165 OSSL_STORE_R_INVALID_SCHEME
);
166 ERR_add_error_data(2, "scheme=", loader
->scheme
);
170 /* Check that functions we absolutely require are present */
171 if (loader
->open
== NULL
|| loader
->load
== NULL
|| loader
->eof
== NULL
172 || loader
->error
== NULL
|| loader
->close
== NULL
) {
173 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_REGISTER_LOADER_INT
,
174 OSSL_STORE_R_LOADER_INCOMPLETE
);
178 if (!RUN_ONCE(®istry_init
, do_registry_init
)) {
179 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_REGISTER_LOADER_INT
,
180 ERR_R_MALLOC_FAILURE
);
183 CRYPTO_THREAD_write_lock(registry_lock
);
185 if (loader_register
== NULL
) {
186 loader_register
= lh_OSSL_STORE_LOADER_new(store_loader_hash
,
190 if (loader_register
!= NULL
191 && (lh_OSSL_STORE_LOADER_insert(loader_register
, loader
) != NULL
192 || lh_OSSL_STORE_LOADER_error(loader_register
) == 0))
195 CRYPTO_THREAD_unlock(registry_lock
);
199 int OSSL_STORE_register_loader(OSSL_STORE_LOADER
*loader
)
201 if (!ossl_store_init_once())
203 return ossl_store_register_loader_int(loader
);
206 const OSSL_STORE_LOADER
*ossl_store_get0_loader_int(const char *scheme
)
208 OSSL_STORE_LOADER
template;
209 OSSL_STORE_LOADER
*loader
= NULL
;
211 template.scheme
= scheme
;
212 template.open
= NULL
;
213 template.load
= NULL
;
215 template.close
= NULL
;
217 if (!ossl_store_init_once())
220 if (!RUN_ONCE(®istry_init
, do_registry_init
)) {
221 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_GET0_LOADER_INT
,
222 ERR_R_MALLOC_FAILURE
);
225 CRYPTO_THREAD_write_lock(registry_lock
);
227 loader
= lh_OSSL_STORE_LOADER_retrieve(loader_register
, &template);
229 if (loader
== NULL
) {
230 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_GET0_LOADER_INT
,
231 OSSL_STORE_R_UNREGISTERED_SCHEME
);
232 ERR_add_error_data(2, "scheme=", scheme
);
235 CRYPTO_THREAD_unlock(registry_lock
);
240 OSSL_STORE_LOADER
*ossl_store_unregister_loader_int(const char *scheme
)
242 OSSL_STORE_LOADER
template;
243 OSSL_STORE_LOADER
*loader
= NULL
;
245 template.scheme
= scheme
;
246 template.open
= NULL
;
247 template.load
= NULL
;
249 template.close
= NULL
;
251 if (!RUN_ONCE(®istry_init
, do_registry_init
)) {
252 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_UNREGISTER_LOADER_INT
,
253 ERR_R_MALLOC_FAILURE
);
256 CRYPTO_THREAD_write_lock(registry_lock
);
258 loader
= lh_OSSL_STORE_LOADER_delete(loader_register
, &template);
260 if (loader
== NULL
) {
261 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_UNREGISTER_LOADER_INT
,
262 OSSL_STORE_R_UNREGISTERED_SCHEME
);
263 ERR_add_error_data(2, "scheme=", scheme
);
266 CRYPTO_THREAD_unlock(registry_lock
);
270 OSSL_STORE_LOADER
*OSSL_STORE_unregister_loader(const char *scheme
)
272 if (!ossl_store_init_once())
274 return ossl_store_unregister_loader_int(scheme
);
277 void ossl_store_destroy_loaders_int(void)
279 assert(lh_OSSL_STORE_LOADER_num_items(loader_register
) == 0);
280 lh_OSSL_STORE_LOADER_free(loader_register
);
281 loader_register
= NULL
;
282 CRYPTO_THREAD_lock_free(registry_lock
);
283 registry_lock
= NULL
;
287 * Functions to list OSSL_STORE loaders
290 IMPLEMENT_LHASH_DOALL_ARG_CONST(OSSL_STORE_LOADER
, void);
291 int OSSL_STORE_do_all_loaders(void (*do_function
) (const OSSL_STORE_LOADER
292 *loader
, void *do_arg
),
295 lh_OSSL_STORE_LOADER_doall_void(loader_register
, do_function
, do_arg
);