diff options
author | Richard Levitte <levitte@openssl.org> | 2019-08-14 20:17:39 +0200 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2019-08-15 11:58:25 +0200 |
commit | dca97d0062397005a33dd9fd24b1238ebe9e52e7 (patch) | |
tree | 7b0bcd2ea9ddcd1e5f57ceec703d19396d2f052d /doc | |
parent | 9f643f54236d6cf0d0d24327acd3b858883f0686 (diff) |
Rename provider and core get_param_types functions
It was argued that names like SOMETHING_set_param_types were confusing,
and a rename has been proposed to SOMETHING_settable_params, and by
consequence, SOMETHING_get_param_types is renamed
SOMETHING_gettable_params.
This changes implements this change for the dispatched provider and
core functions.
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/9591)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/internal/man3/ossl_provider_new.pod | 8 | ||||
-rw-r--r-- | doc/man3/OSSL_PROVIDER.pod | 8 | ||||
-rw-r--r-- | doc/man7/provider-base.pod | 22 |
3 files changed, 19 insertions, 19 deletions
diff --git a/doc/internal/man3/ossl_provider_new.pod b/doc/internal/man3/ossl_provider_new.pod index c567290302..dd9f1cbec5 100644 --- a/doc/internal/man3/ossl_provider_new.pod +++ b/doc/internal/man3/ossl_provider_new.pod @@ -11,7 +11,7 @@ ossl_provider_ctx, ossl_provider_forall_loaded, ossl_provider_name, ossl_provider_dso, ossl_provider_module_name, ossl_provider_module_path, -ossl_provider_teardown, ossl_provider_get_param_types, +ossl_provider_teardown, ossl_provider_gettable_params, ossl_provider_get_params, ossl_provider_query_operation - internal provider routines @@ -55,7 +55,7 @@ ossl_provider_get_params, ossl_provider_query_operation /* Thin wrappers around calls to the provider */ void ossl_provider_teardown(const OSSL_PROVIDER *prov); - const OSSL_PARAM *ossl_provider_get_param_types(const OSSL_PROVIDER *prov); + const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov); int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[]); const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov, int operation_id, @@ -188,7 +188,7 @@ for providers that come in the form of loadable modules. ossl_provider_teardown() calls the provider's I<teardown> function, if the provider has one. -ossl_provider_get_param_types() calls the provider's I<get_param_types> +ossl_provider_gettable_params() calls the provider's I<gettable_params> function, if the provider has one. It should return an array of I<OSSL_PARAM> to describe all the parameters that the provider has for the provider object. @@ -254,7 +254,7 @@ is returned. ossl_provider_teardown() doesnt't return any value. -ossl_provider_get_param_types() returns a pointer to a constant +ossl_provider_gettable_params() returns a pointer to a constant I<OSSL_PARAM> array if this function is available in the provider, otherwise NULL. diff --git a/doc/man3/OSSL_PROVIDER.pod b/doc/man3/OSSL_PROVIDER.pod index 5608bf394c..f4f8a3bd5e 100644 --- a/doc/man3/OSSL_PROVIDER.pod +++ b/doc/man3/OSSL_PROVIDER.pod @@ -4,7 +4,7 @@ OSSL_PROVIDER, OSSL_PROVIDER_load, OSSL_PROVIDER_unload, OSSL_PROVIDER_available, -OSSL_PROVIDER_get_param_types, OSSL_PROVIDER_get_params, +OSSL_PROVIDER_gettable_params, OSSL_PROVIDER_get_params, OSSL_PROVIDER_add_builtin, OSSL_PROVIDER_name - provider routines =head1 SYNOPSIS @@ -17,7 +17,7 @@ OSSL_PROVIDER_add_builtin, OSSL_PROVIDER_name - provider routines int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov); int OSSL_PROVIDER_available(OPENSSL_CTX *libctx, const char *name); - const OSSL_PARAM *OSSL_PROVIDER_get_param_types(OSSL_PROVIDER *prov); + const OSSL_PARAM *OSSL_PROVIDER_gettable_params(OSSL_PROVIDER *prov); int OSSL_PROVIDER_get_params(OSSL_PROVIDER *prov, OSSL_PARAM params[]); int OSSL_PROVIDER_add_builtin(OPENSSL_CTX *libctx, const char *name, @@ -57,7 +57,7 @@ runs its teardown function. OSSL_PROVIDER_available() checks if a named provider is available for use. -OSSL_PROVIDER_get_param_types() is used to get a provider parameter +OSSL_PROVIDER_gettable_params() is used to get a provider parameter descriptor set as a constant B<OSSL_PARAM> array. See L<OSSL_PARAM(3)> for more information. @@ -80,7 +80,7 @@ OSSL_PROVIDER_unload() returns 1 on success, or 0 on error. OSSL_PROVIDER_available() returns 1 if the named provider is available, otherwise 0. -OSSL_PROVIDER_get_param_types() returns a pointer to an array +OSSL_PROVIDER_gettable_params() returns a pointer to an array of constant B<OSSL_PARAM>, or NULL if none is provided. OSSL_PROVIDER_get_params() returns 1 on success, or 0 on error. diff --git a/doc/man7/provider-base.pod b/doc/man7/provider-base.pod index aa1a3d634b..0f28ce718f 100644 --- a/doc/man7/provider-base.pod +++ b/doc/man7/provider-base.pod @@ -16,7 +16,7 @@ provider-base */ /* Functions offered by libcrypto to the providers */ - const OSSL_ITEM *core_get_param_types(const OSSL_PROVIDER *prov); + const OSSL_ITEM *core_gettable_params(const OSSL_PROVIDER *prov); int core_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[]); int core_thread_start(const OSSL_PROVIDER *prov, OSSL_thread_stop_handler_fn handfn); @@ -56,7 +56,7 @@ provider-base /* Functions offered by the provider to libcrypto */ void provider_teardown(void *provctx); - const OSSL_ITEM *provider_get_param_types(void *provctx); + const OSSL_ITEM *provider_gettable_params(void *provctx); int provider_get_params(void *provctx, OSSL_PARAM params[]); const OSSL_ALGORITHM *provider_query_operation(void *provctx, int operation_id, @@ -74,12 +74,12 @@ All these "functions" have a corresponding function type definition named B<OSSL_{name}_fn>, and a helper function to retrieve the function pointer from a B<OSSL_DISPATCH> element named B<OSSL_get_{name}>. -For example, the "function" core_get_param_types() has these: +For example, the "function" core_gettable_params() has these: typedef OSSL_ITEM * - (OSSL_core_get_param_types_fn)(const OSSL_PROVIDER *prov); - static ossl_inline OSSL_NAME_core_get_param_types_fn - OSSL_get_core_get_param_types(const OSSL_DISPATCH *opf); + (OSSL_core_gettable_params_fn)(const OSSL_PROVIDER *prov); + static ossl_inline OSSL_NAME_core_gettable_params_fn + OSSL_get_core_gettable_params(const OSSL_DISPATCH *opf); B<OSSL_DISPATCH> arrays are indexed by numbers that are provided as macros in L<openssl-core_numbers.h(7)>, as follows: @@ -87,7 +87,7 @@ macros in L<openssl-core_numbers.h(7)>, as follows: For I<in> (the B<OSSL_DISPATCH> array passed from F<libcrypto> to the provider): - core_get_param_types OSSL_FUNC_CORE_GET_PARAM_TYPES + core_gettable_params OSSL_FUNC_CORE_GETTABLE_PARAMS core_get_params OSSL_FUNC_CORE_GET_PARAMS core_thread_start OSSL_FUNC_CORE_THREAD_START core_get_library_context OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT @@ -115,14 +115,14 @@ For I<*out> (the B<OSSL_DISPATCH> array passed from the provider to F<libcrypto>): provider_teardown OSSL_FUNC_PROVIDER_TEARDOWN - provider_get_param_types OSSL_FUNC_PROVIDER_GET_PARAM_TYPES + provider_gettable_params OSSL_FUNC_PROVIDER_GETTABLE_PARAMS provider_get_params OSSL_FUNC_PROVIDER_GET_PARAMS provider_query_operation OSSL_FUNC_PROVIDER_QUERY_OPERATION provider_get_reason_strings OSSL_FUNC_PROVIDER_GET_REASON_STRINGS =head2 Core functions -core_get_param_types() returns a constant array of descriptor +core_gettable_params() returns a constant array of descriptor B<OSSL_PARAM>, for parameters that core_get_params() can handle. core_get_params() retrieves I<prov> parameters from the core. @@ -189,7 +189,7 @@ provider_teardown() is called when a provider is shut down and removed from the core's provider store. It must free the passed I<provctx>. -provider_get_param_types() should return a constant array of +provider_gettable_params() should return a constant array of descriptor B<OSSL_PARAM>, for parameters that provider_get_params() can handle. @@ -208,7 +208,7 @@ use when reporting errors using core_put_error(). None of these functions are mandatory, but a provider is fairly useless without at least provider_query_operation(), and -provider_get_param_types() is fairly useless if not accompanied by +provider_gettable_params() is fairly useless if not accompanied by provider_get_params(). =head2 Core parameters |