]>
Commit | Line | Data |
---|---|---|
c4532834 RL |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
7c95390e | 5 | ossl_provider_find, ossl_provider_new, ossl_provider_up_ref, |
3bbec1af RL |
6 | ossl_provider_free, |
7 | ossl_provider_set_fallback, ossl_provider_set_module_path, | |
878be71c MC |
8 | ossl_provider_add_parameter, ossl_provider_set_child, ossl_provider_get_parent, |
9 | ossl_provider_up_ref_parent, ossl_provider_free_parent, | |
b1956770 | 10 | ossl_provider_default_props_update, ossl_provider_get0_dispatch, |
878be71c | 11 | ossl_provider_init_as_child, |
29d46e09 | 12 | ossl_provider_activate, ossl_provider_deactivate, ossl_provider_add_to_store, |
3bbec1af | 13 | ossl_provider_ctx, |
8f089576 | 14 | ossl_provider_doall_activated, |
85e2417c | 15 | ossl_provider_name, ossl_provider_dso, |
c4532834 | 16 | ossl_provider_module_name, ossl_provider_module_path, |
a829b735 | 17 | ossl_provider_libctx, |
dca97d00 | 18 | ossl_provider_teardown, ossl_provider_gettable_params, |
2876528d | 19 | ossl_provider_get_params, ossl_provider_clear_all_operation_bits, |
b0001d0c | 20 | ossl_provider_query_operation, ossl_provider_unquery_operation, |
82ec09ec MC |
21 | ossl_provider_set_operation_bit, ossl_provider_test_operation_bit, |
22 | ossl_provider_get_capabilities | |
099bd339 | 23 | - internal provider routines |
c4532834 RL |
24 | |
25 | =head1 SYNOPSIS | |
26 | ||
27 | #include "internal/provider.h" | |
28 | ||
b4250010 | 29 | OSSL_PROVIDER *ossl_provider_find(OSSL_LIB_CTX *libctx, const char *name, |
29dc6e00 | 30 | int noconfig); |
b4250010 | 31 | OSSL_PROVIDER *ossl_provider_new(OSSL_LIB_CTX *libctx, const char *name, |
29dc6e00 MC |
32 | ossl_provider_init_fn *init_function |
33 | int noconfig); | |
7c95390e | 34 | int ossl_provider_up_ref(OSSL_PROVIDER *prov); |
c4532834 RL |
35 | void ossl_provider_free(OSSL_PROVIDER *prov); |
36 | ||
37 | /* Setters */ | |
e55008a9 | 38 | int ossl_provider_set_fallback(OSSL_PROVIDER *prov); |
3bbec1af RL |
39 | int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *path); |
40 | int ossl_provider_add_parameter(OSSL_PROVIDER *prov, const char *name, | |
41 | const char *value); | |
c4532834 | 42 | |
878be71c MC |
43 | /* Child Providers */ |
44 | int ossl_provider_set_child(OSSL_PROVIDER *prov, | |
45 | const OSSL_CORE_HANDLE *handle); | |
46 | const OSSL_CORE_HANDLE *ossl_provider_get_parent(OSSL_PROVIDER *prov); | |
47 | int ossl_provider_up_ref_parent(OSSL_PROVIDER *prov, int activate); | |
48 | int ossl_provider_free_parent(OSSL_PROVIDER *prov, int deactivate); | |
b1956770 MC |
49 | int ossl_provider_default_props_update(OSSL_LIB_CTX *libctx, |
50 | const char *props); | |
878be71c | 51 | |
390f9bad RL |
52 | /* |
53 | * Activate the Provider | |
54 | * If the Provider is a module, the module will be loaded | |
55 | */ | |
29d46e09 | 56 | int ossl_provider_activate(OSSL_PROVIDER *prov, int upcalls, int aschild); |
390f9bad | 57 | int ossl_provider_deactivate(OSSL_PROVIDER *prov); |
29d46e09 | 58 | int ossl_provider_add_to_store(OSSL_PROVIDER *prov, int retain_fallbacks); |
c4532834 | 59 | |
a39eb840 RL |
60 | /* Return pointer to the provider's context */ |
61 | void *ossl_provider_ctx(const OSSL_PROVIDER *prov); | |
62 | ||
878be71c MC |
63 | const OSSL_DISPATCH *ossl_provider_get0_dispatch(const OSSL_PROVIDER *prov); |
64 | ||
85e2417c | 65 | /* Iterate over all loaded providers */ |
8f089576 P |
66 | int ossl_provider_doall_activated(OSSL_LIB_CTX *, |
67 | int (*cb)(OSSL_PROVIDER *provider, | |
68 | void *cbdata), | |
69 | void *cbdata); | |
85e2417c | 70 | |
c4532834 RL |
71 | /* Getters for other library functions */ |
72 | const char *ossl_provider_name(OSSL_PROVIDER *prov); | |
73 | const DSO *ossl_provider_dso(OSSL_PROVIDER *prov); | |
74 | const char *ossl_provider_module_name(OSSL_PROVIDER *prov); | |
75 | const char *ossl_provider_module_path(OSSL_PROVIDER *prov); | |
a829b735 | 76 | OSSL_LIB_CTX *ossl_provider_libctx(const OSSL_PROVIDER *prov); |
c4532834 RL |
77 | |
78 | /* Thin wrappers around calls to the provider */ | |
79 | void ossl_provider_teardown(const OSSL_PROVIDER *prov); | |
dca97d00 | 80 | const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov); |
4e7991b4 | 81 | int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[]); |
82ec09ec MC |
82 | int ossl_provider_get_capabilities(const OSSL_PROVIDER *prov, |
83 | const char *capability, | |
84 | OSSL_CALLBACK *cb, | |
85 | void *arg); | |
099bd339 RL |
86 | const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov, |
87 | int operation_id, | |
88 | int *no_cache); | |
b0001d0c P |
89 | void ossl_provider_unquery_operation(const OSSL_PROVIDER *prov, |
90 | int operation_id, | |
91 | const OSSL_ALGORITHM *algs); | |
c4532834 | 92 | |
5a29b628 RL |
93 | int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum); |
94 | int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum, | |
95 | int *result); | |
2876528d | 96 | int ossl_provider_clear_all_operation_bits(OSSL_LIB_CTX *libctx); |
5a29b628 | 97 | |
878be71c MC |
98 | int ossl_provider_init_as_child(OSSL_LIB_CTX *ctx, |
99 | const OSSL_CORE_HANDLE *handle, | |
100 | const OSSL_DISPATCH *in); | |
101 | ||
102 | ||
c4532834 RL |
103 | =head1 DESCRIPTION |
104 | ||
3bbec1af | 105 | I<OSSL_PROVIDER> is a type that holds all the necessary information |
c4532834 RL |
106 | to handle a provider, regardless of if it's built in to the |
107 | application or the OpenSSL libraries, or if it's a loadable provider | |
108 | module. | |
3bbec1af | 109 | Instances of this type are commonly referred to as "provider objects". |
c4532834 | 110 | |
3bbec1af | 111 | A provider object is always stored in a set of provider objects |
c4532834 RL |
112 | in the library context. |
113 | ||
3bbec1af | 114 | Provider objects are reference counted. |
c4532834 | 115 | |
3bbec1af RL |
116 | Provider objects are initially inactive, i.e. they are only recorded |
117 | in the store, but are not used. | |
c4532834 | 118 | They are activated with the first call to ossl_provider_activate(), |
390f9bad RL |
119 | and are deactivated with the last call to ossl_provider_deactivate(). |
120 | Activation affects a separate counter. | |
c4532834 RL |
121 | |
122 | =head2 Functions | |
123 | ||
3bbec1af | 124 | ossl_provider_find() finds an existing provider object in the provider |
29dc6e00 MC |
125 | object store by I<name>. |
126 | The config file will be automatically loaded unless I<noconfig> is set. | |
127 | Typically I<noconfig> should be 0. | |
128 | We set I<noconfig> to 1 only when calling these functions while processing a | |
129 | config file in order to avoid recursively attempting to load the file. | |
3bbec1af RL |
130 | The provider object it finds has its reference count incremented. |
131 | ||
132 | ossl_provider_new() creates a new provider object named I<name> and | |
133 | stores it in the provider object store, unless there already is one | |
134 | there with the same name. | |
135 | If there already is one with the same name, it's returned with its | |
136 | reference count incremented. | |
29dc6e00 MC |
137 | The config file will be automatically loaded unless I<noconfig> is set. |
138 | Typically I<noconfig> should be 0. | |
139 | We set I<noconfig> to 1 only when calling these functions while processing a | |
140 | config file in order to avoid recursively attempting to load the file. | |
3bbec1af RL |
141 | The reference count of a newly created provider object will always |
142 | be 2; one for being added to the store, and one for the returned | |
143 | reference. | |
144 | If I<init_function> is NULL, the provider is assumed to be a | |
145 | dynamically loadable module, with the symbol B<OSSL_provider_init> as | |
146 | its initialisation function. | |
147 | If I<init_function> isn't NULL, the provider is assumed to be built | |
148 | in, with I<init_function> being the pointer to its initialisation | |
149 | function. | |
150 | For further description of the initialisation function, see the | |
151 | description of ossl_provider_activate() below. | |
152 | ||
7c95390e | 153 | ossl_provider_up_ref() increments the provider object I<prov>'s |
3bbec1af RL |
154 | reference count. |
155 | ||
156 | ossl_provider_free() decrements the provider object I<prov>'s | |
390f9bad RL |
157 | reference count; when it drops to zero, the provider object is assumed |
158 | to have fallen out of use and will be deinitialized (its I<teardown> | |
159 | function is called), and the associated module will be unloaded if one | |
160 | was loaded, and I<prov> itself will be freed. | |
3bbec1af RL |
161 | |
162 | ossl_provider_set_fallback() marks an available provider I<prov> as | |
163 | fallback. | |
164 | Note that after this call, the provider object pointer that was | |
e55008a9 RL |
165 | used can simply be dropped, but not freed. |
166 | ||
3bbec1af RL |
167 | ossl_provider_set_module_path() sets the module path to load the |
168 | provider module given the provider object I<prov>. | |
169 | This will be used in preference to automatically trying to figure out | |
170 | the path from the provider name and the default module directory (more | |
171 | on this in L</NOTES>). | |
172 | ||
a829b735 | 173 | ossl_provider_libctx() returns the library context the given |
e74bd290 RL |
174 | provider I<prov> is registered in. |
175 | ||
3bbec1af RL |
176 | ossl_provider_add_parameter() adds a global parameter for the provider |
177 | to retrieve as it sees fit. | |
178 | The parameters are a combination of I<name> and I<value>, and the | |
179 | provider will use the name to find the value it wants. | |
180 | Only text parameters can be given, and it's up to the provider to | |
181 | interpret them. | |
182 | ||
878be71c MC |
183 | ossl_provider_set_child() marks this provider as a child of a provider in the |
184 | parent library context. I<handle> is the B<OSSL_CORE_HANDLE> object passed to | |
185 | the provider's B<OSSL_provider_init> function. | |
186 | ||
187 | ossl_provider_get_parent() obtains the handle on the parent provider. | |
188 | ||
189 | ossl_provider_up_ref_parent() increases the reference count on the parent | |
190 | provider. If I<activate> is nonzero then the parent provider is also activated. | |
191 | ||
192 | ossl_provider_free_parent() decreases the reference count on the parent | |
193 | provider. If I<deactivate> is nonzero then the parent provider is also | |
194 | deactivated. | |
195 | ||
b1956770 MC |
196 | ossl_provider_default_props_update() is responsible for informing any child |
197 | providers of an update to the default properties. The new properties are | |
198 | supplied in the I<props> string. | |
199 | ||
c4532834 | 200 | ossl_provider_activate() "activates" the provider for the given |
390f9bad RL |
201 | provider object I<prov> by incrementing its activation count, flagging |
202 | it as activated, and initializing it if it isn't already initialized. | |
203 | Initializing means one of the following: | |
c4532834 RL |
204 | |
205 | =over 4 | |
206 | ||
207 | =item * | |
208 | ||
209 | If an initialization function was given with ossl_provider_new(), that | |
210 | function will get called. | |
211 | ||
212 | =item * | |
213 | ||
c2969ff6 | 214 | If no initialization function was given with ossl_provider_new(), a |
3bbec1af RL |
215 | loadable module with the I<name> that was given to ossl_provider_new() |
216 | will be located and loaded, then the symbol B<OSSL_provider_init> will | |
c4532834 RL |
217 | be located in that module, and called. |
218 | ||
219 | =back | |
220 | ||
eb2263da | 221 | If I<upcalls> is nonzero then, if this is a child provider, upcalls to the |
29d46e09 MC |
222 | parent libctx will be made to inform it of an up-ref. If I<aschild> is nonzero |
223 | then the provider will only be activated if it is a child provider. Otherwise | |
224 | no action is taken and ossl_provider_activate() returns success. | |
299f5ff3 | 225 | |
390f9bad RL |
226 | ossl_provider_deactivate() "deactivates" the provider for the given |
227 | provider object I<prov> by decrementing its activation count. When | |
228 | that count reaches zero, the activation flag is cleared. | |
229 | ||
29d46e09 MC |
230 | ossl_provider_add_to_store() adds the provider I<prov> to the provider store and |
231 | makes it available to other threads. This will prevent future automatic loading | |
232 | of fallback providers, unless I<retain_fallbacks> is true. | |
233 | ||
a39eb840 RL |
234 | ossl_provider_ctx() returns a context created by the provider. |
235 | Outside of the provider, it's completely opaque, but it needs to be | |
236 | passed back to some of the provider functions. | |
237 | ||
878be71c MC |
238 | ossl_provider_get0_dispatch() returns the dispatch table that the provider |
239 | initially returned in the I<out> parameter of its B<OSSL_provider_init> | |
240 | function. | |
241 | ||
8f089576 | 242 | ossl_provider_doall_activated() iterates over all the currently |
3bbec1af | 243 | "activated" providers, and calls I<cb> for each of them. |
e55008a9 | 244 | If no providers have been "activated" yet, it tries to activate all |
3c5ce1ce | 245 | available fallback providers before iterating over them. |
85e2417c | 246 | |
c4532834 RL |
247 | ossl_provider_name() returns the name that was given with |
248 | ossl_provider_new(). | |
249 | ||
250 | ossl_provider_dso() returns a reference to the module, for providers | |
251 | that come in the form of loadable modules. | |
252 | ||
9c0586d5 | 253 | ossl_provider_module_name() returns the filename of the module, for |
c4532834 RL |
254 | providers that come in the form of loadable modules. |
255 | ||
256 | ossl_provider_module_path() returns the full path of the module file, | |
257 | for providers that come in the form of loadable modules. | |
258 | ||
3bbec1af | 259 | ossl_provider_teardown() calls the provider's I<teardown> function, if |
c4532834 RL |
260 | the provider has one. |
261 | ||
dca97d00 | 262 | ossl_provider_gettable_params() calls the provider's I<gettable_params> |
c4532834 | 263 | function, if the provider has one. |
26175013 | 264 | It should return an array of I<OSSL_PARAM> to describe all the |
3bbec1af | 265 | parameters that the provider has for the provider object. |
c4532834 RL |
266 | |
267 | ossl_provider_get_params() calls the provider's parameter request | |
268 | responder. | |
3bbec1af | 269 | It should treat the given I<OSSL_PARAM> array as described in |
c4532834 RL |
270 | L<OSSL_PARAM(3)>. |
271 | ||
82ec09ec MC |
272 | ossl_provider_get_capabilities() calls the provider's I<get_capabilities> function, |
273 | if the provider has one. It provides the name of the I<capability> and a | |
274 | callback I<cb> parameter to call for each capability that has a matching name in | |
275 | the provider. The callback gets passed OSSL_PARAM details about the capability as | |
276 | well as the caller supplied argument I<arg>. | |
277 | ||
099bd339 | 278 | ossl_provider_query_operation() calls the provider's |
3bbec1af RL |
279 | I<query_operation> function, if the provider has one. |
280 | It should return an array of I<OSSL_ALGORITHM> for the given | |
281 | I<operation_id>. | |
b0001d0c P |
282 | |
283 | ossl_provider_unquery_operation() informs the provider that the result of | |
284 | ossl_provider_query_operation() is no longer going to be directly accessed and | |
285 | that all relevant information has been copied. | |
099bd339 | 286 | |
5a29b628 RL |
287 | ossl_provider_set_operation_bit() registers a 1 for operation I<bitnum> |
288 | in a bitstring that's internal to I<provider>. | |
289 | ||
2876528d | 290 | ossl_provider_test_operation_bit() checks if the bit operation I<bitnum> |
5a29b628 RL |
291 | is set (1) or not (0) in the internal I<provider> bitstring, and sets |
292 | I<*result> to 1 or 0 accorddingly. | |
293 | ||
2876528d P |
294 | ossl_provider_clear_all_operation_bits() clears all of the operation bits |
295 | to (0) for all providers in the library context I<libctx>. | |
296 | ||
878be71c MC |
297 | ossl_provider_init_as_child() stores in the library context I<ctx> references to |
298 | the necessary upcalls for managing child providers. The I<handle> and I<in> | |
299 | parameters are the B<OSSL_CORE_HANDLE> and B<OSSL_DISPATCH> pointers that were | |
300 | passed to the provider's B<OSSL_provider_init> function. | |
301 | ||
c4532834 RL |
302 | =head1 NOTES |
303 | ||
304 | Locating a provider module happens as follows: | |
305 | ||
306 | =over 4 | |
307 | ||
308 | =item 1. | |
309 | ||
3bbec1af RL |
310 | If a path was given with ossl_provider_set_module_path(), use that as |
311 | module path. | |
312 | Otherwise, use the provider object's name as module path, with | |
313 | platform specific standard extensions added. | |
c4532834 RL |
314 | |
315 | =item 2. | |
316 | ||
3bbec1af RL |
317 | If the environment variable B<OPENSSL_MODULES> is defined, assume its |
318 | value is a directory specification and merge it with the module path. | |
319 | Otherwise, merge the value of the OpenSSL built in macro B<MODULESDIR> | |
320 | with the module path. | |
c4532834 | 321 | |
3bbec1af | 322 | =back |
c4532834 | 323 | |
3bbec1af RL |
324 | When this process is done, the result is used when trying to load the |
325 | provider module. | |
c4532834 | 326 | |
3bbec1af RL |
327 | The command C<openssl version -m> can be used to find out the value |
328 | of the built in macro B<MODULESDIR>. | |
c4532834 RL |
329 | |
330 | =head1 RETURN VALUES | |
331 | ||
332 | ossl_provider_find() and ossl_provider_new() return a pointer to a | |
3bbec1af | 333 | provider object (I<OSSL_PROVIDER>) on success, or NULL on error. |
c4532834 | 334 | |
7c95390e | 335 | ossl_provider_up_ref() returns the value of the reference count after |
c4532834 RL |
336 | it has been incremented. |
337 | ||
338 | ossl_provider_free() doesn't return any value. | |
339 | ||
8f089576 | 340 | ossl_provider_doall_activated() returns 1 if the callback was called for all |
3c5ce1ce P |
341 | activated providers. A return value of 0 means that the callback was not |
342 | called for any activated providers. | |
343 | ||
390f9bad | 344 | ossl_provider_set_module_path(), ossl_provider_set_fallback(), |
299f5ff3 | 345 | ossl_provider_activate(), ossl_provider_activate_leave_fallbacks() and |
29d46e09 MC |
346 | ossl_provider_deactivate(), ossl_provider_add_to_store(), |
347 | ossl_provider_default_props_update() return 1 on success, or 0 on error. | |
c4532834 RL |
348 | |
349 | ossl_provider_name(), ossl_provider_dso(), | |
350 | ossl_provider_module_name(), and ossl_provider_module_path() return a | |
3bbec1af | 351 | pointer to their respective data if it's available, otherwise NULL |
c4532834 RL |
352 | is returned. |
353 | ||
a829b735 | 354 | ossl_provider_libctx() return a pointer to the library context. |
e74bd290 RL |
355 | This may be NULL, and is perfectly valid, as it denotes the default |
356 | global library context. | |
357 | ||
79c44b4e | 358 | ossl_provider_teardown() doesn't return any value. |
c4532834 | 359 | |
dca97d00 | 360 | ossl_provider_gettable_params() returns a pointer to a constant |
26175013 RL |
361 | I<OSSL_PARAM> array if this function is available in the provider, |
362 | otherwise NULL. | |
c4532834 RL |
363 | |
364 | ossl_provider_get_params() returns 1 on success, or 0 on error. | |
365 | If this function isn't available in the provider, 0 is returned. | |
366 | ||
5a29b628 RL |
367 | ossl_provider_set_operation_bit() and ossl_provider_test_operation_bit() |
368 | return 1 on success, or 0 on error. | |
369 | ||
2876528d P |
370 | ossl_provider_clear_all_operation_bits() returns 1 on success, or 0 on error. |
371 | ||
82ec09ec MC |
372 | ossl_provider_get_capabilities() returns 1 on success, or 0 on error. |
373 | If this function isn't available in the provider or the provider does not | |
374 | support the requested capability then 0 is returned. | |
375 | ||
c4532834 RL |
376 | =head1 SEE ALSO |
377 | ||
3bbec1af | 378 | L<OSSL_PROVIDER(3)>, L<provider(7)>, L<openssl(1)> |
c4532834 RL |
379 | |
380 | =head1 HISTORY | |
381 | ||
382 | The functions described here were all added in OpenSSL 3.0. | |
383 | ||
384 | =head1 COPYRIGHT | |
385 | ||
8020d79b | 386 | Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved. |
c4532834 RL |
387 | |
388 | Licensed under the Apache License 2.0 (the "License"). You may not use | |
389 | this file except in compliance with the License. You can obtain a copy | |
390 | in the file LICENSE in the source distribution or at | |
391 | L<https://www.openssl.org/source/license.html>. | |
392 | ||
393 | =cut |