summaryrefslogtreecommitdiffstats
path: root/doc/man3/OSSL_PROVIDER.pod
diff options
context:
space:
mode:
authorDmitry Belyavskiy <beldmit@gmail.com>2023-08-02 17:54:01 +0200
committerDmitry Belyavskiy <beldmit@gmail.com>2023-08-30 21:55:47 +0200
commit9d2f7e1f611f03e65f25adf08b76e08821b315da (patch)
tree4266d8ecdf4ab3db508db67bd91687a80d1a0ed6 /doc/man3/OSSL_PROVIDER.pod
parentd57d0b818935c20a7b468c0e717773ea8a3373e6 (diff)
OSSL_PROVIDER_load_ex
Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/21604)
Diffstat (limited to 'doc/man3/OSSL_PROVIDER.pod')
-rw-r--r--doc/man3/OSSL_PROVIDER.pod16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/man3/OSSL_PROVIDER.pod b/doc/man3/OSSL_PROVIDER.pod
index 1790c0e678..12151021c5 100644
--- a/doc/man3/OSSL_PROVIDER.pod
+++ b/doc/man3/OSSL_PROVIDER.pod
@@ -5,6 +5,7 @@
OSSL_PROVIDER_set_default_search_path,
OSSL_PROVIDER_get0_default_search_path,
OSSL_PROVIDER, OSSL_PROVIDER_load, OSSL_PROVIDER_try_load, OSSL_PROVIDER_unload,
+OSSL_PROVIDER_load_ex, OSSL_PROVIDER_try_load_ex,
OSSL_PROVIDER_available, OSSL_PROVIDER_do_all,
OSSL_PROVIDER_gettable_params, OSSL_PROVIDER_get_params,
OSSL_PROVIDER_query_operation, OSSL_PROVIDER_unquery_operation,
@@ -24,8 +25,13 @@ OSSL_PROVIDER_self_test
const char *OSSL_PROVIDER_get0_default_search_path(OSSL_LIB_CTX *libctx);
OSSL_PROVIDER *OSSL_PROVIDER_load(OSSL_LIB_CTX *libctx, const char *name);
+ OSSL_PROVIDER *OSSL_PROVIDER_load_ex(OSSL_LIB_CTX *, const char *name,
+ OSSL_PARAM *params);
OSSL_PROVIDER *OSSL_PROVIDER_try_load(OSSL_LIB_CTX *libctx, const char *name,
int retain_fallbacks);
+ OSSL_PROVIDER *OSSL_PROVIDER_try_load_ex(OSSL_LIB_CTX *, const char *name,
+ OSSL_PARAM *params,
+ int retain_fallbacks);
int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);
int OSSL_PROVIDER_available(OSSL_LIB_CTX *libctx, const char *name);
int OSSL_PROVIDER_do_all(OSSL_LIB_CTX *ctx,
@@ -101,6 +107,13 @@ loaded and initialized or if I<retain_fallbacks> is nonzero.
If the provider loads successfully and I<retain_fallbacks> is zero, the
fallback providers are disabled.
+OSSL_PROVIDER_load_ex() and OSSL_PROVIDER_try_load_ex() are the variants
+of the previous functions accepting an C<OSSL_PARAM> array of the parameters
+that are passed as the configuration of the loaded provider. The parameters
+of any type but C<OSSL_PARAM_UTF8_STRING> are silently ignored. If the
+parameters are provided, they replace B<all> the ones specified in the
+configuration file.
+
OSSL_PROVIDER_unload() unloads the given provider.
For a provider added with OSSL_PROVIDER_add_builtin(), this simply
runs its teardown function.
@@ -221,6 +234,9 @@ L<openssl-core.h(7)>, L<OSSL_LIB_CTX(3)>, L<provider(7)>
The type and functions described here were added in OpenSSL 3.0.
+The I<OSSL_PROVIDER_load_ex> and I<OSSL_PROVIDER_try_load_ex> functions were
+added in OpenSSL 3.2.
+
=head1 COPYRIGHT
Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.