summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/OSSL_PROVIDER.3ssl
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man3/OSSL_PROVIDER.3ssl')
-rw-r--r--upstream/debian-unstable/man3/OSSL_PROVIDER.3ssl28
1 files changed, 27 insertions, 1 deletions
diff --git a/upstream/debian-unstable/man3/OSSL_PROVIDER.3ssl b/upstream/debian-unstable/man3/OSSL_PROVIDER.3ssl
index fc0ea617..e2245568 100644
--- a/upstream/debian-unstable/man3/OSSL_PROVIDER.3ssl
+++ b/upstream/debian-unstable/man3/OSSL_PROVIDER.3ssl
@@ -55,14 +55,16 @@
.\" ========================================================================
.\"
.IX Title "OSSL_PROVIDER 3SSL"
-.TH OSSL_PROVIDER 3SSL 2024-02-03 3.1.5 OpenSSL
+.TH OSSL_PROVIDER 3SSL 2024-04-04 3.2.2-dev OpenSSL
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
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,
@@ -79,10 +81,16 @@ OSSL_PROVIDER_self_test
\&
\& int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *libctx,
\& const char *path);
+\& 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,
@@ -130,6 +138,11 @@ that is to be used for looking for providers in the specified \fIlibctx\fR.
If left unspecified, an environment variable and a fall back default value will
be used instead.
.PP
+\&\fBOSSL_PROVIDER_get0_default_search_path()\fR retrieves the default search \fIpath\fR
+that is to be used for looking for providers in the specified \fIlibctx\fR.
+If successful returns the path or empty string; the path is valid until the
+context is released or \fBOSSL_PROVIDER_set_default_search_path()\fR is called.
+.PP
\&\fBOSSL_PROVIDER_add_builtin()\fR is used to add a built in provider to
\&\fBOSSL_PROVIDER\fR store in the given library context, by associating a
provider name with a provider initialization function.
@@ -152,6 +165,13 @@ loaded and initialized or if \fIretain_fallbacks\fR is nonzero.
If the provider loads successfully and \fIretain_fallbacks\fR is zero, the
fallback providers are disabled.
.PP
+\&\fBOSSL_PROVIDER_load_ex()\fR and \fBOSSL_PROVIDER_try_load_ex()\fR are the variants
+of the previous functions accepting an \f(CW\*(C`OSSL_PARAM\*(C'\fR array of the parameters
+that are passed as the configuration of the loaded provider. The parameters
+of any type but \f(CW\*(C`OSSL_PARAM_UTF8_STRING\*(C'\fR are silently ignored. If the
+parameters are provided, they replace \fBall\fR the ones specified in the
+configuration file.
+.PP
\&\fBOSSL_PROVIDER_unload()\fR unloads the given provider.
For a provider added with \fBOSSL_PROVIDER_add_builtin()\fR, this simply
runs its teardown function.
@@ -217,6 +237,9 @@ capabilities and what they can be used for please see
\&\fBOSSL_PROVIDER_unload()\fR, \fBOSSL_PROVIDER_get_params()\fR and
\&\fBOSSL_PROVIDER_get_capabilities()\fR return 1 on success, or 0 on error.
.PP
+\&\fBOSSL_PROVIDER_get0_default_search_path()\fR returns a pointer to a path on success,
+or NULL on error or if the path has not previously been set.
+.PP
\&\fBOSSL_PROVIDER_load()\fR and \fBOSSL_PROVIDER_try_load()\fR return a pointer to a
provider object on success, or NULL on error.
.PP
@@ -266,6 +289,9 @@ its build information.
.SH HISTORY
.IX Header "HISTORY"
The type and functions described here were added in OpenSSL 3.0.
+.PP
+The \fIOSSL_PROVIDER_load_ex\fR and \fIOSSL_PROVIDER_try_load_ex\fR functions were
+added in OpenSSL 3.2.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2019\-2023 The OpenSSL Project Authors. All Rights Reserved.