diff options
author | Tomas Mraz <tomas@openssl.org> | 2021-05-21 16:58:08 +0200 |
---|---|---|
committer | Tomas Mraz <tomas@openssl.org> | 2021-06-01 12:40:00 +0200 |
commit | ed576acdf591d4164905ab98e89ca5a3b99d90ab (patch) | |
tree | c0f36ca1b3d42f34c0c502e700ad09b69b713d3c /doc/man3/EVP_KEM_free.pod | |
parent | 5e2d22d53ed322a7124e26a4fbd116a8210eb77a (diff) | |
download | openssl-new-ed576acdf591d4164905ab98e89ca5a3b99d90ab.tar.gz |
Rename all getters to use get/get0 in name
For functions that exist in 1.1.1 provide a simple aliases via #define.
Fixes #15236
Functions with OSSL_DECODER_, OSSL_ENCODER_, OSSL_STORE_LOADER_,
EVP_KEYEXCH_, EVP_KEM_, EVP_ASYM_CIPHER_, EVP_SIGNATURE_,
EVP_KEYMGMT_, EVP_RAND_, EVP_MAC_, EVP_KDF_, EVP_PKEY_,
EVP_MD_, and EVP_CIPHER_ prefixes are renamed.
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15405)
Diffstat (limited to 'doc/man3/EVP_KEM_free.pod')
-rw-r--r-- | doc/man3/EVP_KEM_free.pod | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/man3/EVP_KEM_free.pod b/doc/man3/EVP_KEM_free.pod index 13600c521c..766825859b 100644 --- a/doc/man3/EVP_KEM_free.pod +++ b/doc/man3/EVP_KEM_free.pod @@ -3,8 +3,8 @@ =head1 NAME EVP_KEM_fetch, EVP_KEM_free, EVP_KEM_up_ref, -EVP_KEM_number, EVP_KEM_name, EVP_KEM_is_a, EVP_KEM_provider, -EVP_KEM_do_all_provided, EVP_KEM_names_do_all, EVP_KEM_description, +EVP_KEM_get_number, EVP_KEM_get0_name, EVP_KEM_is_a, EVP_KEM_get0_provider, +EVP_KEM_do_all_provided, EVP_KEM_names_do_all, EVP_KEM_get0_description, EVP_KEM_gettable_ctx_params, EVP_KEM_settable_ctx_params - Functions to manage EVP_KEM algorithm objects @@ -16,15 +16,15 @@ EVP_KEM_gettable_ctx_params, EVP_KEM_settable_ctx_params const char *properties); void EVP_KEM_free(EVP_KEM *kem); int EVP_KEM_up_ref(EVP_KEM *kem); - int EVP_KEM_number(const EVP_KEM *kem); - const char *EVP_KEM_name(const EVP_KEM *kem); + int EVP_KEM_get_number(const EVP_KEM *kem); + const char *EVP_KEM_get0_name(const EVP_KEM *kem); int EVP_KEM_is_a(const EVP_KEM *kem, const char *name); - OSSL_PROVIDER *EVP_KEM_provider(const EVP_KEM *kem); + OSSL_PROVIDER *EVP_KEM_get0_provider(const EVP_KEM *kem); void EVP_KEM_do_all_provided(OSSL_LIB_CTX *libctx, void (*fn)(EVP_KEM *kem, void *arg), void *arg); int EVP_KEM_names_do_all(const EVP_KEM *kem, void (*fn)(const char *name, void *data), void *data); - const char *EVP_KEM_description(const EVP_KEM *kem); + const char *EVP_KEM_get0_description(const EVP_KEM *kem); const OSSL_PARAM *EVP_KEM_gettable_ctx_params(const EVP_KEM *kem); const OSSL_PARAM *EVP_KEM_settable_ctx_params(const EVP_KEM *kem); @@ -48,16 +48,16 @@ EVP_KEM_up_ref() increments the reference count for an B<EVP_KEM> structure. EVP_KEM_is_a() returns 1 if I<kem> is an implementation of an algorithm that's identifiable with I<name>, otherwise 0. -EVP_KEM_provider() returns the provider that I<kem> was fetched from. +EVP_KEM_get0_provider() returns the provider that I<kem> was fetched from. EVP_KEM_do_all_provided() traverses all EVP_KEMs implemented by all activated providers in the given library context I<libctx>, and for each of the implementations, calls the given function I<fn> with the implementation method and the given I<arg> as argument. -EVP_KEM_number() returns the internal dynamic number assigned to I<kem>. +EVP_KEM_get_number() returns the internal dynamic number assigned to I<kem>. -EVP_KEM_name() returns the algorithm name from the provided +EVP_KEM_get0_name() returns the algorithm name from the provided implementation for the given I<kem>. Note that the I<kem> may have multiple synonyms associated with it. In this case the first name from the algorithm definition is returned. Ownership of the returned string is retained @@ -66,9 +66,9 @@ by the I<kem> object and should not be freed by the caller. EVP_KEM_names_do_all() traverses all names for I<kem>, and calls I<fn> with each name and I<data>. -EVP_KEM_description() returns a description of the I<kem>, meant for display -and human consumption. The description is at the discretion of the I<kem> -implementation. +EVP_KEM_get0_description() returns a description of the I<kem>, meant for +display and human consumption. The description is at the discretion of +the I<kem> implementation. EVP_KEM_gettable_ctx_params() and EVP_KEM_settable_ctx_params() return a constant B<OSSL_PARAM> array that describes the names and types of key |