2 * Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
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
= OPENSSL_zalloc(sizeof(*res
));
36 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_LOADER_NEW
, ERR_R_MALLOC_FAILURE
);
41 * We usually don't check NULL arguments. For loaders, though, the
42 * scheme is crucial and must never be NULL, or the user will get
43 * mysterious errors when trying to register the created loader
47 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_LOADER_NEW
,
48 OSSL_STORE_R_INVALID_SCHEME
);
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_load(OSSL_STORE_LOADER
*loader
,
82 OSSL_STORE_load_fn load_function
)
84 loader
->load
= load_function
;
88 int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER
*loader
,
89 OSSL_STORE_eof_fn eof_function
)
91 loader
->eof
= eof_function
;
95 int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER
*loader
,
96 OSSL_STORE_error_fn error_function
)
98 loader
->error
= error_function
;
102 int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER
*loader
,
103 OSSL_STORE_close_fn close_function
)
105 loader
->close
= close_function
;
109 void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER
*loader
)
111 OPENSSL_free(loader
);
115 * Functions for registering OSSL_STORE_LOADERs
118 static unsigned long store_loader_hash(const OSSL_STORE_LOADER
*v
)
120 return OPENSSL_LH_strhash(v
->scheme
);
123 static int store_loader_cmp(const OSSL_STORE_LOADER
*a
,
124 const OSSL_STORE_LOADER
*b
)
126 assert(a
->scheme
!= NULL
&& b
->scheme
!= NULL
);
127 return strcmp(a
->scheme
, b
->scheme
);
130 static LHASH_OF(OSSL_STORE_LOADER
) *loader_register
= NULL
;
132 int ossl_store_register_loader_int(OSSL_STORE_LOADER
*loader
)
134 const char *scheme
= loader
->scheme
;
138 * Check that the given scheme conforms to correct scheme syntax as per
141 * scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
143 if (isalpha(*scheme
))
144 while (*scheme
!= '\0'
147 || strchr("+-.", *scheme
) != NULL
))
149 if (*scheme
!= '\0') {
150 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_REGISTER_LOADER_INT
,
151 OSSL_STORE_R_INVALID_SCHEME
);
152 ERR_add_error_data(4, "scheme=", loader
->scheme
);
156 if (!RUN_ONCE(®istry_init
, do_registry_init
)) {
157 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_REGISTER_LOADER_INT
,
158 ERR_R_MALLOC_FAILURE
);
161 CRYPTO_THREAD_write_lock(registry_lock
);
163 if (loader_register
== NULL
) {
164 loader_register
= lh_OSSL_STORE_LOADER_new(store_loader_hash
,
168 if (loader_register
!= NULL
169 && (lh_OSSL_STORE_LOADER_insert(loader_register
, loader
) != NULL
170 || lh_OSSL_STORE_LOADER_error(loader_register
) == 0))
173 CRYPTO_THREAD_unlock(registry_lock
);
177 int OSSL_STORE_register_loader(OSSL_STORE_LOADER
*loader
)
179 if (!ossl_store_init_once())
181 return ossl_store_register_loader_int(loader
);
184 const OSSL_STORE_LOADER
*ossl_store_get0_loader_int(const char *scheme
)
186 OSSL_STORE_LOADER
template;
187 OSSL_STORE_LOADER
*loader
= NULL
;
189 template.scheme
= scheme
;
190 template.open
= NULL
;
191 template.load
= NULL
;
193 template.close
= NULL
;
195 if (!ossl_store_init_once())
198 if (!RUN_ONCE(®istry_init
, do_registry_init
)) {
199 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_GET0_LOADER_INT
,
200 ERR_R_MALLOC_FAILURE
);
203 CRYPTO_THREAD_write_lock(registry_lock
);
205 loader
= lh_OSSL_STORE_LOADER_retrieve(loader_register
, &template);
207 if (loader
== NULL
) {
208 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_GET0_LOADER_INT
,
209 OSSL_STORE_R_UNREGISTERED_SCHEME
);
210 ERR_add_error_data(2, "scheme=", scheme
);
213 CRYPTO_THREAD_unlock(registry_lock
);
218 OSSL_STORE_LOADER
*ossl_store_unregister_loader_int(const char *scheme
)
220 OSSL_STORE_LOADER
template;
221 OSSL_STORE_LOADER
*loader
= NULL
;
223 template.scheme
= scheme
;
224 template.open
= NULL
;
225 template.load
= NULL
;
227 template.close
= NULL
;
229 if (!RUN_ONCE(®istry_init
, do_registry_init
)) {
230 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_UNREGISTER_LOADER_INT
,
231 ERR_R_MALLOC_FAILURE
);
234 CRYPTO_THREAD_write_lock(registry_lock
);
236 loader
= lh_OSSL_STORE_LOADER_delete(loader_register
, &template);
238 if (loader
== NULL
) {
239 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_UNREGISTER_LOADER_INT
,
240 OSSL_STORE_R_UNREGISTERED_SCHEME
);
241 ERR_add_error_data(2, "scheme=", scheme
);
244 CRYPTO_THREAD_unlock(registry_lock
);
248 OSSL_STORE_LOADER
*OSSL_STORE_unregister_loader(const char *scheme
)
250 if (!ossl_store_init_once())
252 return ossl_store_unregister_loader_int(scheme
);
255 void ossl_store_destroy_loaders_int(void)
257 assert(lh_OSSL_STORE_LOADER_num_items(loader_register
) == 0);
258 lh_OSSL_STORE_LOADER_free(loader_register
);
259 loader_register
= NULL
;
260 CRYPTO_THREAD_lock_free(registry_lock
);
261 registry_lock
= NULL
;
265 * Functions to list OSSL_STORE loaders
268 IMPLEMENT_LHASH_DOALL_ARG_CONST(OSSL_STORE_LOADER
, void);
269 int OSSL_STORE_do_all_loaders(void (*do_function
) (const OSSL_STORE_LOADER
270 *loader
, void *do_arg
),
273 lh_OSSL_STORE_LOADER_doall_void(loader_register
, do_function
, do_arg
);