diff options
| author | Pauli <pauli@openssl.org> | 2021-05-05 11:22:08 +1000 |
|---|---|---|
| committer | Pauli <pauli@openssl.org> | 2021-05-07 23:53:18 +1000 |
| commit | 2876528de594308df43301a5f282e7eec69b8ff5 (patch) | |
| tree | 3a54f68303aae8bf4ca475d5b8858e940738b958 /doc | |
| parent | ced7df26382e7b1713ac6662958933d31151b4b8 (diff) | |
doc: document the new ossl_provider_clear_all_operation_bits() function
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15042)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/internal/man3/ossl_provider_new.pod | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/internal/man3/ossl_provider_new.pod b/doc/internal/man3/ossl_provider_new.pod index 8506839dee..e83869a9de 100644 --- a/doc/internal/man3/ossl_provider_new.pod +++ b/doc/internal/man3/ossl_provider_new.pod @@ -13,7 +13,7 @@ ossl_provider_name, ossl_provider_dso, ossl_provider_module_name, ossl_provider_module_path, ossl_provider_libctx, ossl_provider_teardown, ossl_provider_gettable_params, -ossl_provider_get_params, +ossl_provider_get_params, ossl_provider_clear_all_operation_bits, ossl_provider_query_operation, ossl_provider_unquery_operation, ossl_provider_set_operation_bit, ossl_provider_test_operation_bit, ossl_provider_get_capabilities @@ -80,6 +80,7 @@ ossl_provider_get_capabilities int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum); int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum, int *result); + int ossl_provider_clear_all_operation_bits(OSSL_LIB_CTX *libctx); =head1 DESCRIPTION @@ -245,10 +246,13 @@ that all relevant information has been copied. ossl_provider_set_operation_bit() registers a 1 for operation I<bitnum> in a bitstring that's internal to I<provider>. -ossl_provider_tests_operation_bit() checks if the bit operation I<bitnum> +ossl_provider_test_operation_bit() checks if the bit operation I<bitnum> is set (1) or not (0) in the internal I<provider> bitstring, and sets I<*result> to 1 or 0 accorddingly. +ossl_provider_clear_all_operation_bits() clears all of the operation bits +to (0) for all providers in the library context I<libctx>. + =head1 NOTES Locating a provider module happens as follows: @@ -319,6 +323,8 @@ If this function isn't available in the provider, 0 is returned. ossl_provider_set_operation_bit() and ossl_provider_test_operation_bit() return 1 on success, or 0 on error. +ossl_provider_clear_all_operation_bits() returns 1 on success, or 0 on error. + ossl_provider_get_capabilities() returns 1 on success, or 0 on error. If this function isn't available in the provider or the provider does not support the requested capability then 0 is returned. |