| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "OSSL_STORE_LOADER 3SSL" |
| 58 |
.TH OSSL_STORE_LOADER 3SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
OSSL_STORE_LOADER, |
| 65 |
OSSL_STORE_LOADER_fetch, |
| 66 |
OSSL_STORE_LOADER_up_ref, |
| 67 |
OSSL_STORE_LOADER_free, |
| 68 |
OSSL_STORE_LOADER_get0_provider, |
| 69 |
OSSL_STORE_LOADER_get0_properties, |
| 70 |
OSSL_STORE_LOADER_is_a, |
| 71 |
OSSL_STORE_LOADER_get0_description, |
| 72 |
OSSL_STORE_LOADER_do_all_provided, |
| 73 |
OSSL_STORE_LOADER_names_do_all, |
| 74 |
OSSL_STORE_LOADER_CTX, OSSL_STORE_LOADER_new, |
| 75 |
OSSL_STORE_LOADER_get0_engine, OSSL_STORE_LOADER_get0_scheme, |
| 76 |
OSSL_STORE_LOADER_set_open, OSSL_STORE_LOADER_set_open_ex, |
| 77 |
OSSL_STORE_LOADER_set_attach, OSSL_STORE_LOADER_set_ctrl, |
| 78 |
OSSL_STORE_LOADER_set_expect, OSSL_STORE_LOADER_set_find, |
| 79 |
OSSL_STORE_LOADER_set_load, OSSL_STORE_LOADER_set_eof, |
| 80 |
OSSL_STORE_LOADER_set_error, OSSL_STORE_LOADER_set_close, |
| 81 |
OSSL_STORE_LOADER_settable_ctx_params, |
| 82 |
OSSL_STORE_register_loader, OSSL_STORE_unregister_loader, |
| 83 |
OSSL_STORE_open_fn, OSSL_STORE_open_ex_fn, |
| 84 |
OSSL_STORE_attach_fn, OSSL_STORE_ctrl_fn, |
| 85 |
OSSL_STORE_expect_fn, OSSL_STORE_find_fn, |
| 86 |
OSSL_STORE_load_fn, OSSL_STORE_eof_fn, OSSL_STORE_error_fn, |
| 87 |
OSSL_STORE_close_fn \- Types and functions to manipulate, register and |
| 88 |
unregister STORE loaders for different URI schemes |
| 89 |
.SH SYNOPSIS |
| 90 |
.IX Header "SYNOPSIS" |
| 91 |
.Vb 1 |
| 92 |
\& #include <openssl/store.h> |
| 93 |
\& |
| 94 |
\& typedef struct ossl_store_loader_st OSSL_STORE_LOADER; |
| 95 |
\& |
| 96 |
\& OSSL_STORE_LOADER *OSSL_STORE_LOADER_fetch(OSSL_LIB_CTX *libctx, |
| 97 |
\& const char *scheme, |
| 98 |
\& const char *properties); |
| 99 |
\& int OSSL_STORE_LOADER_up_ref(OSSL_STORE_LOADER *loader); |
| 100 |
\& void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER *loader); |
| 101 |
\& const OSSL_PROVIDER *OSSL_STORE_LOADER_get0_provider(const OSSL_STORE_LOADER * |
| 102 |
\& loader); |
| 103 |
\& const char *OSSL_STORE_LOADER_get0_properties(const OSSL_STORE_LOADER *loader); |
| 104 |
\& const char *OSSL_STORE_LOADER_get0_description(const OSSL_STORE_LOADER *loader); |
| 105 |
\& int OSSL_STORE_LOADER_is_a(const OSSL_STORE_LOADER *loader, |
| 106 |
\& const char *scheme); |
| 107 |
\& void OSSL_STORE_LOADER_do_all_provided(OSSL_LIB_CTX *libctx, |
| 108 |
\& void (*user_fn)(OSSL_STORE_LOADER *loader, |
| 109 |
\& void *arg), |
| 110 |
\& void *user_arg); |
| 111 |
\& int OSSL_STORE_LOADER_names_do_all(const OSSL_STORE_LOADER *loader, |
| 112 |
\& void (*fn)(const char *name, void *data), |
| 113 |
\& void *data); |
| 114 |
\& const OSSL_PARAM * |
| 115 |
\& OSSL_STORE_LOADER_settable_ctx_params(const OSSL_STORE_LOADER *loader); |
| 116 |
.Ve |
| 117 |
.PP |
| 118 |
The following functions have been deprecated since OpenSSL 3.0, and can be |
| 119 |
hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value, |
| 120 |
see \fBopenssl_user_macros\fR\|(7): |
| 121 |
.PP |
| 122 |
.Vb 5 |
| 123 |
\& OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme); |
| 124 |
\& const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER |
| 125 |
\& *store_loader); |
| 126 |
\& const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER |
| 127 |
\& *store_loader); |
| 128 |
\& |
| 129 |
\& /* struct ossl_store_loader_ctx_st is defined differently by each loader */ |
| 130 |
\& typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX; |
| 131 |
\& |
| 132 |
\& typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_fn)( |
| 133 |
\& const char *uri, const UI_METHOD *ui_method, void *ui_data); |
| 134 |
\& int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *store_loader, |
| 135 |
\& OSSL_STORE_open_fn store_open_function); |
| 136 |
\& typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_ex_fn)( |
| 137 |
\& const char *uri, const UI_METHOD *ui_method, void *ui_data); |
| 138 |
\& int OSSL_STORE_LOADER_set_open_ex |
| 139 |
\& (OSSL_STORE_LOADER *store_loader, |
| 140 |
\& OSSL_STORE_open_ex_fn store_open_ex_function); |
| 141 |
\& typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_attach_fn) |
| 142 |
\& (const OSSL_STORE_LOADER *loader, BIO *bio, |
| 143 |
\& OSSL_LIB_CTX *libctx, const char *propq, |
| 144 |
\& const UI_METHOD *ui_method, void *ui_data); |
| 145 |
\& int OSSL_STORE_LOADER_set_attach(OSSL_STORE_LOADER *loader, |
| 146 |
\& OSSL_STORE_attach_fn attach_function); |
| 147 |
\& typedef int (*OSSL_STORE_ctrl_fn)(OSSL_STORE_LOADER_CTX *ctx, int cmd, |
| 148 |
\& va_list args); |
| 149 |
\& int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *store_loader, |
| 150 |
\& OSSL_STORE_ctrl_fn store_ctrl_function); |
| 151 |
\& typedef int (*OSSL_STORE_expect_fn)(OSSL_STORE_LOADER_CTX *ctx, int expected); |
| 152 |
\& int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER *loader, |
| 153 |
\& OSSL_STORE_expect_fn expect_function); |
| 154 |
\& typedef int (*OSSL_STORE_find_fn)(OSSL_STORE_LOADER_CTX *ctx, |
| 155 |
\& OSSL_STORE_SEARCH *criteria); |
| 156 |
\& int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER *loader, |
| 157 |
\& OSSL_STORE_find_fn find_function); |
| 158 |
\& typedef OSSL_STORE_INFO *(*OSSL_STORE_load_fn)(OSSL_STORE_LOADER_CTX *ctx, |
| 159 |
\& UI_METHOD *ui_method, |
| 160 |
\& void *ui_data); |
| 161 |
\& int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *store_loader, |
| 162 |
\& OSSL_STORE_load_fn store_load_function); |
| 163 |
\& typedef int (*OSSL_STORE_eof_fn)(OSSL_STORE_LOADER_CTX *ctx); |
| 164 |
\& int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *store_loader, |
| 165 |
\& OSSL_STORE_eof_fn store_eof_function); |
| 166 |
\& typedef int (*OSSL_STORE_error_fn)(OSSL_STORE_LOADER_CTX *ctx); |
| 167 |
\& int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *store_loader, |
| 168 |
\& OSSL_STORE_error_fn store_error_function); |
| 169 |
\& typedef int (*OSSL_STORE_close_fn)(OSSL_STORE_LOADER_CTX *ctx); |
| 170 |
\& int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *store_loader, |
| 171 |
\& OSSL_STORE_close_fn store_close_function); |
| 172 |
\& |
| 173 |
\& int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader); |
| 174 |
\& OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme); |
| 175 |
.Ve |
| 176 |
.SH DESCRIPTION |
| 177 |
.IX Header "DESCRIPTION" |
| 178 |
\&\fBOSSL_STORE_LOADER\fR is a method for OSSL_STORE loaders, which implement |
| 179 |
\&\fBOSSL_STORE_open()\fR, \fBOSSL_STORE_open_ex()\fR, \fBOSSL_STORE_load()\fR, |
| 180 |
\&\fBOSSL_STORE_eof()\fR, \fBOSSL_STORE_error()\fR and \fBOSSL_STORE_close()\fR for specific |
| 181 |
storage schemes. |
| 182 |
.PP |
| 183 |
\&\fBOSSL_STORE_LOADER_fetch()\fR looks for an implementation for a storage |
| 184 |
\&\fIscheme\fR within the providers that has been loaded into the \fBOSSL_LIB_CTX\fR |
| 185 |
given by \fIlibctx\fR, and with the properties given by \fIproperties\fR. |
| 186 |
.PP |
| 187 |
\&\fBOSSL_STORE_LOADER_up_ref()\fR increments the reference count for the given |
| 188 |
\&\fIloader\fR. |
| 189 |
.PP |
| 190 |
\&\fBOSSL_STORE_LOADER_free()\fR decrements the reference count for the given |
| 191 |
\&\fIloader\fR, and when the count reaches zero, frees it. |
| 192 |
If the argument is NULL, nothing is done. |
| 193 |
.PP |
| 194 |
\&\fBOSSL_STORE_LOADER_get0_provider()\fR returns the provider of the given |
| 195 |
\&\fIloader\fR. |
| 196 |
.PP |
| 197 |
\&\fBOSSL_STORE_LOADER_get0_properties()\fR returns the property definition associated |
| 198 |
with the given \fIloader\fR. |
| 199 |
.PP |
| 200 |
\&\fBOSSL_STORE_LOADER_is_a()\fR checks if \fIloader\fR is an implementation |
| 201 |
of an algorithm that's identifiable with \fIscheme\fR. |
| 202 |
.PP |
| 203 |
\&\fBOSSL_STORE_LOADER_get0_description()\fR returns a description of the \fIloader\fR, meant |
| 204 |
for display and human consumption. The description is at the discretion of the |
| 205 |
\&\fIloader\fR implementation. |
| 206 |
.PP |
| 207 |
\&\fBOSSL_STORE_LOADER_do_all_provided()\fR traverses all store implementations |
| 208 |
by all activated providers in the library context \fIlibctx\fR, and for each |
| 209 |
of the implementations, calls \fIuser_fn\fR with the implementation method and |
| 210 |
\&\fIuser_arg\fR as arguments. |
| 211 |
.PP |
| 212 |
\&\fBOSSL_STORE_LOADER_names_do_all()\fR traverses all names for the given |
| 213 |
\&\fIloader\fR, and calls \fIfn\fR with each name and \fIdata\fR. |
| 214 |
.PP |
| 215 |
\&\fBOSSL_STORE_LOADER_settable_ctx_params()\fR return a constant \fBOSSL_PARAM\fR\|(3) array |
| 216 |
that describes the names and types of key parameters that can be passed to |
| 217 |
\&\fBOSSL_STORE_open_ex\fR\|(3). |
| 218 |
.SS "Legacy Types and Functions (deprecated)" |
| 219 |
.IX Subsection "Legacy Types and Functions (deprecated)" |
| 220 |
These functions help applications and engines to create loaders for |
| 221 |
schemes they support. These are all deprecated and discouraged in favour of |
| 222 |
provider implementations, see \fBprovider\-storemgmt\fR\|(7). |
| 223 |
.PP |
| 224 |
\&\fBOSSL_STORE_LOADER_CTX\fR is a type template, to be defined by each loader |
| 225 |
using \f(CW\*(C`struct ossl_store_loader_ctx_st { ... }\*(C'\fR. |
| 226 |
.PP |
| 227 |
\&\fBOSSL_STORE_open_fn\fR, \fBOSSL_STORE_open_ex_fn\fR, |
| 228 |
\&\fBOSSL_STORE_ctrl_fn\fR, \fBOSSL_STORE_expect_fn\fR, \fBOSSL_STORE_find_fn\fR, |
| 229 |
\&\fBOSSL_STORE_load_fn\fR, \fBOSSL_STORE_eof_fn\fR, and \fBOSSL_STORE_close_fn\fR |
| 230 |
are the function pointer types used within a STORE loader. |
| 231 |
The functions pointed at define the functionality of the given loader. |
| 232 |
.IP "\fBOSSL_STORE_open_fn\fR and \fBOSSL_STORE_open_ex_fn\fR" 4 |
| 233 |
.IX Item "OSSL_STORE_open_fn and OSSL_STORE_open_ex_fn" |
| 234 |
\&\fBOSSL_STORE_open_ex_fn\fR takes a URI and is expected to |
| 235 |
interpret it in the best manner possible according to the scheme the |
| 236 |
loader implements. It also takes a \fBUI_METHOD\fR and associated data, |
| 237 |
to be used any time something needs to be prompted for, as well as a |
| 238 |
library context \fIlibctx\fR with an associated property query \fIpropq\fR, |
| 239 |
to be used when fetching necessary algorithms to perform the loads. |
| 240 |
Furthermore, this function is expected to initialize what needs to be |
| 241 |
initialized, to create a private data store (\fBOSSL_STORE_LOADER_CTX\fR, |
| 242 |
see above), and to return it. |
| 243 |
If something goes wrong, this function is expected to return NULL. |
| 244 |
.Sp |
| 245 |
\&\fBOSSL_STORE_open_fn\fR does the same thing as |
| 246 |
\&\fBOSSL_STORE_open_ex_fn\fR but uses NULL for the library |
| 247 |
context \fIlibctx\fR and property query \fIpropq\fR. |
| 248 |
.IP \fBOSSL_STORE_attach_fn\fR 4 |
| 249 |
.IX Item "OSSL_STORE_attach_fn" |
| 250 |
This function takes a \fBBIO\fR, otherwise works like |
| 251 |
\&\fBOSSL_STORE_open_ex_fn\fR. |
| 252 |
.IP \fBOSSL_STORE_ctrl_fn\fR 4 |
| 253 |
.IX Item "OSSL_STORE_ctrl_fn" |
| 254 |
This function takes a \fBOSSL_STORE_LOADER_CTX\fR pointer, a command number |
| 255 |
\&\fIcmd\fR and a \fBva_list\fR \fIargs\fR and is used to manipulate loader |
| 256 |
specific parameters. |
| 257 |
.Sp |
| 258 |
Loader specific command numbers must begin at \fBOSSL_STORE_C_CUSTOM_START\fR. |
| 259 |
Any number below that is reserved for future globally known command |
| 260 |
numbers. |
| 261 |
.Sp |
| 262 |
This function is expected to return 1 on success, 0 on error. |
| 263 |
.IP \fBOSSL_STORE_expect_fn\fR 4 |
| 264 |
.IX Item "OSSL_STORE_expect_fn" |
| 265 |
This function takes a \fBOSSL_STORE_LOADER_CTX\fR pointer and a \fBOSSL_STORE_INFO\fR |
| 266 |
identity \fIexpected\fR, and is used to tell the loader what object type is |
| 267 |
expected. |
| 268 |
\&\fIexpected\fR may be zero to signify that no specific object type is expected. |
| 269 |
.Sp |
| 270 |
This function is expected to return 1 on success, 0 on error. |
| 271 |
.IP \fBOSSL_STORE_find_fn\fR 4 |
| 272 |
.IX Item "OSSL_STORE_find_fn" |
| 273 |
This function takes a \fBOSSL_STORE_LOADER_CTX\fR pointer and a |
| 274 |
\&\fBOSSL_STORE_SEARCH\fR search criterion, and is used to tell the loader what |
| 275 |
to search for. |
| 276 |
.Sp |
| 277 |
When called with the loader context being NULL, this function is expected |
| 278 |
to return 1 if the loader supports the criterion, otherwise 0. |
| 279 |
.Sp |
| 280 |
When called with the loader context being something other than NULL, this |
| 281 |
function is expected to return 1 on success, 0 on error. |
| 282 |
.IP \fBOSSL_STORE_load_fn\fR 4 |
| 283 |
.IX Item "OSSL_STORE_load_fn" |
| 284 |
This function takes a \fBOSSL_STORE_LOADER_CTX\fR pointer and a \fBUI_METHOD\fR |
| 285 |
with associated data. |
| 286 |
It's expected to load the next available data, mold it into a data |
| 287 |
structure that can be wrapped in a \fBOSSL_STORE_INFO\fR using one of the |
| 288 |
\&\fBOSSL_STORE_INFO\fR\|(3) functions. |
| 289 |
If no more data is available or an error occurs, this function is |
| 290 |
expected to return NULL. |
| 291 |
The \fBOSSL_STORE_eof_fn\fR and \fBOSSL_STORE_error_fn\fR functions must indicate if |
| 292 |
it was in fact the end of data or if an error occurred. |
| 293 |
.Sp |
| 294 |
Note that this function retrieves \fIone\fR data item only. |
| 295 |
.IP \fBOSSL_STORE_eof_fn\fR 4 |
| 296 |
.IX Item "OSSL_STORE_eof_fn" |
| 297 |
This function takes a \fBOSSL_STORE_LOADER_CTX\fR pointer and is expected to |
| 298 |
return 1 to indicate that the end of available data has been reached. |
| 299 |
It is otherwise expected to return 0. |
| 300 |
.IP \fBOSSL_STORE_error_fn\fR 4 |
| 301 |
.IX Item "OSSL_STORE_error_fn" |
| 302 |
This function takes a \fBOSSL_STORE_LOADER_CTX\fR pointer and is expected to |
| 303 |
return 1 to indicate that an error occurred in a previous call to the |
| 304 |
\&\fBOSSL_STORE_load_fn\fR function. |
| 305 |
It is otherwise expected to return 0. |
| 306 |
.IP \fBOSSL_STORE_close_fn\fR 4 |
| 307 |
.IX Item "OSSL_STORE_close_fn" |
| 308 |
This function takes a \fBOSSL_STORE_LOADER_CTX\fR pointer and is expected to |
| 309 |
close or shut down what needs to be closed, and finally free the |
| 310 |
contents of the \fBOSSL_STORE_LOADER_CTX\fR pointer. |
| 311 |
It returns 1 on success and 0 on error. |
| 312 |
.PP |
| 313 |
\&\fBOSSL_STORE_LOADER_new()\fR creates a new \fBOSSL_STORE_LOADER\fR. |
| 314 |
It takes an \fBENGINE\fR \fIe\fR and a string \fIscheme\fR. |
| 315 |
\&\fIscheme\fR must \fIalways\fR be set. |
| 316 |
Both \fIe\fR and \fIscheme\fR are used as is and must therefore be alive as |
| 317 |
long as the created loader is. |
| 318 |
.PP |
| 319 |
\&\fBOSSL_STORE_LOADER_get0_engine()\fR returns the engine of the \fIstore_loader\fR. |
| 320 |
\&\fBOSSL_STORE_LOADER_get0_scheme()\fR returns the scheme of the \fIstore_loader\fR. |
| 321 |
.PP |
| 322 |
\&\fBOSSL_STORE_LOADER_set_open()\fR sets the opener function for the |
| 323 |
\&\fIstore_loader\fR. |
| 324 |
.PP |
| 325 |
\&\fBOSSL_STORE_LOADER_set_open_ex()\fR sets the opener with library context |
| 326 |
function for the \fIstore_loader\fR. |
| 327 |
.PP |
| 328 |
\&\fBOSSL_STORE_LOADER_set_attach()\fR sets the attacher function for the |
| 329 |
\&\fIstore_loader\fR. |
| 330 |
.PP |
| 331 |
\&\fBOSSL_STORE_LOADER_set_ctrl()\fR sets the control function for the |
| 332 |
\&\fIstore_loader\fR. |
| 333 |
.PP |
| 334 |
\&\fBOSSL_STORE_LOADER_set_expect()\fR sets the expect function for the |
| 335 |
\&\fIstore_loader\fR. |
| 336 |
.PP |
| 337 |
\&\fBOSSL_STORE_LOADER_set_load()\fR sets the loader function for the |
| 338 |
\&\fIstore_loader\fR. |
| 339 |
.PP |
| 340 |
\&\fBOSSL_STORE_LOADER_set_eof()\fR sets the end of file checker function for the |
| 341 |
\&\fIstore_loader\fR. |
| 342 |
.PP |
| 343 |
\&\fBOSSL_STORE_LOADER_set_close()\fR sets the closing function for the |
| 344 |
\&\fIstore_loader\fR. |
| 345 |
.PP |
| 346 |
\&\fBOSSL_STORE_LOADER_free()\fR frees the given \fIstore_loader\fR. |
| 347 |
If the argument is NULL, nothing is done. |
| 348 |
.PP |
| 349 |
\&\fBOSSL_STORE_register_loader()\fR register the given \fIstore_loader\fR and |
| 350 |
thereby makes it available for use with \fBOSSL_STORE_open()\fR, |
| 351 |
\&\fBOSSL_STORE_open_ex()\fR, \fBOSSL_STORE_load()\fR, \fBOSSL_STORE_eof()\fR |
| 352 |
and \fBOSSL_STORE_close()\fR. |
| 353 |
.PP |
| 354 |
\&\fBOSSL_STORE_unregister_loader()\fR unregister the store loader for the given |
| 355 |
\&\fIscheme\fR. |
| 356 |
.SH "RETURN VALUES" |
| 357 |
.IX Header "RETURN VALUES" |
| 358 |
\&\fBOSSL_STORE_LOADER_fetch()\fR returns a pointer to an OSSL_STORE_LOADER object, |
| 359 |
or NULL on error. |
| 360 |
.PP |
| 361 |
\&\fBOSSL_STORE_LOADER_up_ref()\fR returns 1 on success, or 0 on error. |
| 362 |
.PP |
| 363 |
\&\fBOSSL_STORE_LOADER_names_do_all()\fR returns 1 if the callback was called for all |
| 364 |
names. A return value of 0 means that the callback was not called for any names. |
| 365 |
.PP |
| 366 |
\&\fBOSSL_STORE_LOADER_free()\fR doesn't return any value. |
| 367 |
.PP |
| 368 |
\&\fBOSSL_STORE_LOADER_get0_provider()\fR returns a pointer to a provider object, or |
| 369 |
NULL on error. |
| 370 |
.PP |
| 371 |
\&\fBOSSL_STORE_LOADER_get0_properties()\fR returns a pointer to a property |
| 372 |
definition string, or NULL on error. |
| 373 |
.PP |
| 374 |
\&\fBOSSL_STORE_LOADER_is_a()\fR returns 1 if \fIloader\fR was identifiable, |
| 375 |
otherwise 0. |
| 376 |
.PP |
| 377 |
\&\fBOSSL_STORE_LOADER_get0_description()\fR returns a pointer to a description, or NULL if |
| 378 |
there isn't one. |
| 379 |
.PP |
| 380 |
The functions with the types \fBOSSL_STORE_open_fn\fR, |
| 381 |
\&\fBOSSL_STORE_open_ex_fn\fR, \fBOSSL_STORE_ctrl_fn\fR, |
| 382 |
\&\fBOSSL_STORE_expect_fn\fR, \fBOSSL_STORE_load_fn\fR, \fBOSSL_STORE_eof_fn\fR |
| 383 |
and \fBOSSL_STORE_close_fn\fR have the same return values as \fBOSSL_STORE_open()\fR, |
| 384 |
\&\fBOSSL_STORE_open_ex()\fR, \fBOSSL_STORE_ctrl()\fR, \fBOSSL_STORE_expect()\fR, |
| 385 |
\&\fBOSSL_STORE_load()\fR, \fBOSSL_STORE_eof()\fR and \fBOSSL_STORE_close()\fR, respectively. |
| 386 |
.PP |
| 387 |
\&\fBOSSL_STORE_LOADER_new()\fR returns a pointer to a \fBOSSL_STORE_LOADER\fR on success, |
| 388 |
or NULL on failure. |
| 389 |
.PP |
| 390 |
\&\fBOSSL_STORE_LOADER_set_open()\fR, \fBOSSL_STORE_LOADER_set_open_ex()\fR, |
| 391 |
\&\fBOSSL_STORE_LOADER_set_ctrl()\fR, \fBOSSL_STORE_LOADER_set_load()\fR, |
| 392 |
\&\fBOSSL_STORE_LOADER_set_eof()\fR and \fBOSSL_STORE_LOADER_set_close()\fR return 1 |
| 393 |
on success, or 0 on failure. |
| 394 |
.PP |
| 395 |
\&\fBOSSL_STORE_register_loader()\fR returns 1 on success, or 0 on failure. |
| 396 |
.PP |
| 397 |
\&\fBOSSL_STORE_unregister_loader()\fR returns the unregistered loader on success, |
| 398 |
or NULL on failure. |
| 399 |
.SH "SEE ALSO" |
| 400 |
.IX Header "SEE ALSO" |
| 401 |
\&\fBossl_store\fR\|(7), \fBOSSL_STORE_open\fR\|(3), \fBOSSL_LIB_CTX\fR\|(3), |
| 402 |
\&\fBprovider\-storemgmt\fR\|(7) |
| 403 |
.SH HISTORY |
| 404 |
.IX Header "HISTORY" |
| 405 |
\&\fBOSSL_STORE_LOADER_fetch()\fR, \fBOSSL_STORE_LOADER_up_ref()\fR, |
| 406 |
\&\fBOSSL_STORE_LOADER_get0_provider()\fR, \fBOSSL_STORE_LOADER_get0_properties()\fR, |
| 407 |
\&\fBOSSL_STORE_LOADER_get0_description()\fR, \fBOSSL_STORE_LOADER_is_a()\fR, |
| 408 |
\&\fBOSSL_STORE_LOADER_do_all_provided()\fR and \fBOSSL_STORE_LOADER_names_do_all()\fR |
| 409 |
were added in OpenSSL 3.0. |
| 410 |
.PP |
| 411 |
\&\fBOSSL_STORE_LOADER\fR and \fBOSSL_STORE_LOADER_free()\fR were added in OpenSSL |
| 412 |
1.1.1. |
| 413 |
.PP |
| 414 |
\&\fBOSSL_STORE_LOADER_set_open_ex()\fR and \fBOSSL_STORE_open_ex_fn()\fR were added in |
| 415 |
OpenSSL 3.0, and are deprecated. |
| 416 |
.PP |
| 417 |
\&\fBOSSL_STORE_LOADER_CTX\fR, \fBOSSL_STORE_LOADER_new()\fR, |
| 418 |
\&\fBOSSL_STORE_LOADER_set0_scheme()\fR, \fBOSSL_STORE_LOADER_get0_scheme()\fR, |
| 419 |
\&\fBOSSL_STORE_LOADER_get0_engine()\fR, \fBOSSL_STORE_LOADER_set_expect()\fR, |
| 420 |
\&\fBOSSL_STORE_LOADER_set_find()\fR, \fBOSSL_STORE_LOADER_set_attach()\fR, |
| 421 |
\&\fBOSSL_STORE_LOADER_set_open_ex()\fR, \fBOSSL_STORE_LOADER_set_open()\fR, |
| 422 |
\&\fBOSSL_STORE_LOADER_set_ctrl()\fR, |
| 423 |
\&\fBOSSL_STORE_LOADER_set_load()\fR, \fBOSSL_STORE_LOADER_set_eof()\fR, |
| 424 |
\&\fBOSSL_STORE_LOADER_set_close()\fR, |
| 425 |
\&\fBOSSL_STORE_register_loader()\fR, \fBOSSL_STORE_LOADER_set_error()\fR, |
| 426 |
\&\fBOSSL_STORE_unregister_loader()\fR, \fBOSSL_STORE_open_fn()\fR, \fBOSSL_STORE_ctrl_fn()\fR, |
| 427 |
\&\fBOSSL_STORE_load_fn()\fR, \fBOSSL_STORE_eof_fn()\fR and \fBOSSL_STORE_close_fn()\fR |
| 428 |
were added in OpenSSL 1.1.1, and became deprecated in OpenSSL 3.0. |
| 429 |
.PP |
| 430 |
\&\fBOSSL_STORE_LOADER_settable_ctx_params()\fR was added in OpenSSL 3.6. |
| 431 |
.SH COPYRIGHT |
| 432 |
.IX Header "COPYRIGHT" |
| 433 |
Copyright 2016\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 434 |
.PP |
| 435 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 436 |
this file except in compliance with the License. You can obtain a copy |
| 437 |
in the file LICENSE in the source distribution or at |
| 438 |
<https://www.openssl.org/source/license.html>. |