diff options
| author | Matt Caswell <matt@openssl.org> | 2021-04-28 15:23:16 +0100 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2021-05-04 12:00:21 +0100 |
| commit | f9548d21bae8667b71254d82478e0094a5a3982d (patch) | |
| tree | 0c3f439c5fde3c6884e04594b85f718e0be54708 /doc/man3/OSSL_LIB_CTX.pod | |
| parent | 93954ab050b395275a9d8b084ab4aa9e815ce119 (diff) | |
Document the new core BIO public API support
Fixes #14409
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15072)
Diffstat (limited to 'doc/man3/OSSL_LIB_CTX.pod')
| -rw-r--r-- | doc/man3/OSSL_LIB_CTX.pod | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/man3/OSSL_LIB_CTX.pod b/doc/man3/OSSL_LIB_CTX.pod index 5ba85cc485..9796c8575c 100644 --- a/doc/man3/OSSL_LIB_CTX.pod +++ b/doc/man3/OSSL_LIB_CTX.pod @@ -2,8 +2,9 @@ =head1 NAME -OSSL_LIB_CTX, OSSL_LIB_CTX_new, OSSL_LIB_CTX_free, OSSL_LIB_CTX_load_config, -OSSL_LIB_CTX_get0_global_default, OSSL_LIB_CTX_set0_default +OSSL_LIB_CTX, OSSL_LIB_CTX_new, OSSL_LIB_CTX_new_from_dispatch, +OSSL_LIB_CTX_free, OSSL_LIB_CTX_load_config, OSSL_LIB_CTX_get0_global_default, +OSSL_LIB_CTX_set0_default - OpenSSL library context =head1 SYNOPSIS @@ -13,6 +14,7 @@ OSSL_LIB_CTX_get0_global_default, OSSL_LIB_CTX_set0_default typedef struct ossl_lib_ctx_st OSSL_LIB_CTX; OSSL_LIB_CTX *OSSL_LIB_CTX_new(void); + OSSL_LIB_CTX *OSSL_LIB_CTX_new_from_dispatch(const OSSL_DISPATCH *in); int OSSL_LIB_CTX_load_config(OSSL_LIB_CTX *ctx, const char *config_file); void OSSL_LIB_CTX_free(OSSL_LIB_CTX *ctx); OSSL_LIB_CTX *OSSL_LIB_CTX_get0_global_default(void); @@ -32,6 +34,13 @@ See L<OPENSSL_thread_stop_ex(3)> for more information. OSSL_LIB_CTX_new() creates a new OpenSSL library context. +OSSL_LIB_CTX_new_from_dispatch() creates a new OpenSSL library context +initialised to use callbacks from the OSSL_DISPATCH structure. This is primarily +useful for provider authors. The dispatch structure passed should be the same +one as passed to a provider's OSSL_provider_init function in the I<in> argument. +Some OpenSSL functions, such as L<BIO_new_from_core_bio(3)>, require the library +context to be created in this way in order to work. + OSSL_LIB_CTX_load_config() loads a configuration file using the given C<ctx>. This can be used to associate a library context with providers that are loaded from a configuration. @@ -69,9 +78,7 @@ OSSL_LIB_CTX_free() doesn't return any value. =head1 HISTORY -OSSL_LIB_CTX, OSSL_LIB_CTX_new(), OSSL_LIB_CTX_load_config(), -OSSL_LIB_CTX_free(), OSSL_LIB_CTX_get0_global_default() and -OSSL_LIB_CTX_set0_default() were added in OpenSSL 3.0. +All of the functions described on this page were added in OpenSSL 3.0. =head1 COPYRIGHT |