OSSL_STORE_LOADER.3ossl 19 KB

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