5 OSSL_STORE_LOADER, OSSL_STORE_LOADER_CTX, OSSL_STORE_LOADER_new,
6 OSSL_STORE_LOADER_get0_engine, OSSL_STORE_LOADER_get0_scheme,
7 OSSL_STORE_LOADER_set_open, OSSL_STORE_LOADER_set_attach,
8 OSSL_STORE_LOADER_set_ctrl, OSSL_STORE_LOADER_set_expect,
9 OSSL_STORE_LOADER_set_find, OSSL_STORE_LOADER_set_load,
10 OSSL_STORE_LOADER_set_eof, OSSL_STORE_LOADER_set_error,
11 OSSL_STORE_LOADER_set_close,
12 OSSL_STORE_LOADER_free, OSSL_STORE_register_loader,
13 OSSL_STORE_unregister_loader,
14 OSSL_STORE_open_fn, OSSL_STORE_attach_fn, OSSL_STORE_ctrl_fn,
15 OSSL_STORE_expect_fn, OSSL_STORE_find_fn,
16 OSSL_STORE_load_fn, OSSL_STORE_eof_fn, OSSL_STORE_error_fn,
17 OSSL_STORE_close_fn - Types and functions to manipulate, register and
18 unregister STORE loaders for different URI schemes
22 #include <openssl/store.h>
24 typedef struct ossl_store_loader_st OSSL_STORE_LOADER;
26 OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme);
27 const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER
29 const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER
32 /* struct ossl_store_loader_ctx_st is defined differently by each loader */
33 typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX;
35 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_fn)(
36 const char *uri, const UI_METHOD *ui_method, void *ui_data);
37 int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *store_loader,
38 OSSL_STORE_open_fn store_open_function);
39 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_attach_fn)
40 (const OSSL_STORE_LOADER *loader, BIO *bio,
41 OPENSSL_CTX *libctx, const char *propq,
42 const UI_METHOD *ui_method, void *ui_data);
43 int OSSL_STORE_LOADER_set_attach(OSSL_STORE_LOADER *loader,
44 OSSL_STORE_attach_fn attach_function);
45 typedef int (*OSSL_STORE_ctrl_fn)(OSSL_STORE_LOADER_CTX *ctx, int cmd,
47 int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *store_loader,
48 OSSL_STORE_ctrl_fn store_ctrl_function);
49 typedef int (*OSSL_STORE_expect_fn)(OSSL_STORE_LOADER_CTX *ctx, int expected);
50 int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER *loader,
51 OSSL_STORE_expect_fn expect_function);
52 typedef int (*OSSL_STORE_find_fn)(OSSL_STORE_LOADER_CTX *ctx,
53 OSSL_STORE_SEARCH *criteria);
54 int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER *loader,
55 OSSL_STORE_find_fn find_function);
56 typedef OSSL_STORE_INFO *(*OSSL_STORE_load_fn)(OSSL_STORE_LOADER_CTX *ctx,
59 int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *store_loader,
60 OSSL_STORE_load_fn store_load_function);
61 typedef int (*OSSL_STORE_eof_fn)(OSSL_STORE_LOADER_CTX *ctx);
62 int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *store_loader,
63 OSSL_STORE_eof_fn store_eof_function);
64 typedef int (*OSSL_STORE_error_fn)(OSSL_STORE_LOADER_CTX *ctx);
65 int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *store_loader,
66 OSSL_STORE_error_fn store_error_function);
67 typedef int (*OSSL_STORE_close_fn)(OSSL_STORE_LOADER_CTX *ctx);
68 int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *store_loader,
69 OSSL_STORE_close_fn store_close_function);
70 void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER *store_loader);
72 int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader);
73 OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme);
77 These functions help applications and engines to create loaders for
82 B<OSSL_STORE_LOADER> is the type to hold a loader.
83 It contains a scheme and the functions needed to implement
84 OSSL_STORE_open(), OSSL_STORE_load(), OSSL_STORE_eof(), OSSL_STORE_error() and
85 OSSL_STORE_close() for this scheme.
87 B<OSSL_STORE_LOADER_CTX> is a type template, to be defined by each loader
88 using B<struct ossl_store_loader_ctx_st { ... }>.
90 B<OSSL_STORE_open_fn>, B<OSSL_STORE_ctrl_fn>, B<OSSL_STORE_expect_fn>,
91 B<OSSL_STORE_find_fn>, B<OSSL_STORE_load_fn>, B<OSSL_STORE_eof_fn>,
92 and B<OSSL_STORE_close_fn>
93 are the function pointer types used within a STORE loader.
94 The functions pointed at define the functionality of the given loader.
98 =item B<OSSL_STORE_open_fn>
100 This function takes a URI and is expected to interpret it in the best
101 manner possible according to the scheme the loader implements, it also
102 takes a B<UI_METHOD> and associated data, to be used any time
103 something needs to be prompted for.
104 Furthermore, this function is expected to initialize what needs to be
105 initialized, to create a private data store (B<OSSL_STORE_LOADER_CTX>, see
106 above), and to return it.
107 If something goes wrong, this function is expected to return NULL.
109 =item B<OSSL_STORE_open_fn>
111 This function takes a B<BIO>, otherwise works like B<OSSL_STORE_open_fn>.
113 =item B<OSSL_STORE_ctrl_fn>
115 This function takes a B<OSSL_STORE_LOADER_CTX> pointer, a command number
116 B<cmd> and a B<va_list> B<args> and is used to manipulate loader
121 Globally known command numbers are documented in L<OSSL_STORE_ctrl(3)>,
122 along with what B<args> are expected with each of them.
126 Loader specific command numbers must begin at B<OSSL_STORE_C_CUSTOM_START>.
127 Any number below that is reserved for future globally known command
130 This function is expected to return 1 on success, 0 on error.
132 =item B<OSSL_STORE_expect_fn>
134 This function takes a B<OSSL_STORE_LOADER_CTX> pointer and a B<OSSL_STORE_INFO>
135 identity B<expected>, and is used to tell the loader what object type is
137 B<expected> may be zero to signify that no specific object type is expected.
139 This function is expected to return 1 on success, 0 on error.
141 =item B<OSSL_STORE_find_fn>
143 This function takes a B<OSSL_STORE_LOADER_CTX> pointer and a
144 B<OSSL_STORE_SEARCH> search criterion, and is used to tell the loader what
147 When called with the loader context being B<NULL>, this function is expected
148 to return 1 if the loader supports the criterion, otherwise 0.
150 When called with the loader context being something other than B<NULL>, this
151 function is expected to return 1 on success, 0 on error.
153 =item B<OSSL_STORE_load_fn>
155 This function takes a B<OSSL_STORE_LOADER_CTX> pointer and a B<UI_METHOD>
156 with associated data.
157 It's expected to load the next available data, mold it into a data
158 structure that can be wrapped in a B<OSSL_STORE_INFO> using one of the
159 L<OSSL_STORE_INFO(3)> functions.
160 If no more data is available or an error occurs, this function is
161 expected to return NULL.
162 The B<OSSL_STORE_eof_fn> and B<OSSL_STORE_error_fn> functions must indicate if
163 it was in fact the end of data or if an error occurred.
165 Note that this function retrieves I<one> data item only.
167 =item B<OSSL_STORE_eof_fn>
169 This function takes a B<OSSL_STORE_LOADER_CTX> pointer and is expected to
170 return 1 to indicate that the end of available data has been reached.
171 It is otherwise expected to return 0.
173 =item B<OSSL_STORE_error_fn>
175 This function takes a B<OSSL_STORE_LOADER_CTX> pointer and is expected to
176 return 1 to indicate that an error occurred in a previous call to the
177 B<OSSL_STORE_load_fn> function.
178 It is otherwise expected to return 0.
180 =item B<OSSL_STORE_close_fn>
182 This function takes a B<OSSL_STORE_LOADER_CTX> pointer and is expected to
183 close or shut down what needs to be closed, and finally free the
184 contents of the B<OSSL_STORE_LOADER_CTX> pointer.
185 It returns 1 on success and 0 on error.
191 OSSL_STORE_LOADER_new() creates a new B<OSSL_STORE_LOADER>.
192 It takes an B<ENGINE> B<e> and a string B<scheme>.
193 B<scheme> must I<always> be set.
194 Both B<e> and B<scheme> are used as is and must therefore be alive as
195 long as the created loader is.
197 OSSL_STORE_LOADER_get0_engine() returns the engine of the B<store_loader>.
198 OSSL_STORE_LOADER_get0_scheme() returns the scheme of the B<store_loader>.
200 OSSL_STORE_LOADER_set_open() sets the opener function for the
203 OSSL_STORE_LOADER_set_attach() sets the attacher function for the
206 OSSL_STORE_LOADER_set_ctrl() sets the control function for the
209 OSSL_STORE_LOADER_set_expect() sets the expect function for the
212 OSSL_STORE_LOADER_set_load() sets the loader function for the
215 OSSL_STORE_LOADER_set_eof() sets the end of file checker function for the
218 OSSL_STORE_LOADER_set_close() sets the closing function for the
221 OSSL_STORE_LOADER_free() frees the given B<store_loader>.
223 OSSL_STORE_register_loader() register the given B<store_loader> and thereby
224 makes it available for use with OSSL_STORE_open(), OSSL_STORE_load(),
225 OSSL_STORE_eof() and OSSL_STORE_close().
227 OSSL_STORE_unregister_loader() unregister the store loader for the given
232 The B<file:> scheme has built in support.
236 The functions with the types B<OSSL_STORE_open_fn>, B<OSSL_STORE_ctrl_fn>,
237 B<OSSL_STORE_expect_fn>,
238 B<OSSL_STORE_load_fn>, B<OSSL_STORE_eof_fn> and B<OSSL_STORE_close_fn> have the
239 same return values as OSSL_STORE_open(), OSSL_STORE_ctrl(), OSSL_STORE_expect(),
240 OSSL_STORE_load(), OSSL_STORE_eof() and OSSL_STORE_close(), respectively.
242 OSSL_STORE_LOADER_new() returns a pointer to a B<OSSL_STORE_LOADER> on success,
243 or B<NULL> on failure.
245 OSSL_STORE_LOADER_set_open(), OSSL_STORE_LOADER_set_ctrl(),
246 OSSL_STORE_LOADER_set_load(), OSSL_STORE_LOADER_set_eof() and
247 OSSL_STORE_LOADER_set_close() return 1 on success, or 0 on failure.
249 OSSL_STORE_register_loader() returns 1 on success, or 0 on failure.
251 OSSL_STORE_unregister_loader() returns the unregistered loader on success,
252 or B<NULL> on failure.
256 L<ossl_store(7)>, L<OSSL_STORE_open(3)>
260 OSSL_STORE_LOADER(), OSSL_STORE_LOADER_CTX(), OSSL_STORE_LOADER_new(),
261 OSSL_STORE_LOADER_set0_scheme(), OSSL_STORE_LOADER_set_open(),
262 OSSL_STORE_LOADER_set_ctrl(), OSSL_STORE_LOADER_set_load(),
263 OSSL_STORE_LOADER_set_eof(), OSSL_STORE_LOADER_set_close(),
264 OSSL_STORE_LOADER_free(), OSSL_STORE_register_loader(),
265 OSSL_STORE_unregister_loader(), OSSL_STORE_open_fn(), OSSL_STORE_ctrl_fn(),
266 OSSL_STORE_load_fn(), OSSL_STORE_eof_fn() and OSSL_STORE_close_fn()
267 were added in OpenSSL 1.1.1.
271 Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
273 Licensed under the Apache License 2.0 (the "License"). You may not use
274 this file except in compliance with the License. You can obtain a copy
275 in the file LICENSE in the source distribution or at
276 L<https://www.openssl.org/source/license.html>.