diff options
author | Tomas Mraz <tomas@openssl.org> | 2021-04-16 16:22:03 +0200 |
---|---|---|
committer | Tomas Mraz <tomas@openssl.org> | 2021-04-26 12:05:05 +0200 |
commit | 6c9bc258d2e9e7b500236a1c696da1f384f0b907 (patch) | |
tree | 28928eb5dc1acc246c1b3309328aea2031056ce3 /doc/man3 | |
parent | d21224f1adcd948699e536eaf570f42ef9a051f7 (diff) |
Add type_name member to provided methods and use it
Fixes #14701
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14898)
Diffstat (limited to 'doc/man3')
-rw-r--r-- | doc/man3/EVP_ASYM_CIPHER_free.pod | 9 | ||||
-rw-r--r-- | doc/man3/EVP_KEM_free.pod | 9 | ||||
-rw-r--r-- | doc/man3/EVP_KEYEXCH_free.pod | 9 | ||||
-rw-r--r-- | doc/man3/EVP_KEYMGMT.pod | 16 | ||||
-rw-r--r-- | doc/man3/EVP_SIGNATURE_free.pod | 10 |
5 files changed, 41 insertions, 12 deletions
diff --git a/doc/man3/EVP_ASYM_CIPHER_free.pod b/doc/man3/EVP_ASYM_CIPHER_free.pod index dfe67d9993..93df44ec8f 100644 --- a/doc/man3/EVP_ASYM_CIPHER_free.pod +++ b/doc/man3/EVP_ASYM_CIPHER_free.pod @@ -5,7 +5,7 @@ EVP_ASYM_CIPHER_fetch, EVP_ASYM_CIPHER_free, EVP_ASYM_CIPHER_up_ref, EVP_ASYM_CIPHER_number, EVP_ASYM_CIPHER_is_a, EVP_ASYM_CIPHER_provider, EVP_ASYM_CIPHER_do_all_provided, EVP_ASYM_CIPHER_names_do_all, -EVP_ASYM_CIPHER_description, +EVP_ASYM_CIPHER_name, EVP_ASYM_CIPHER_description, EVP_ASYM_CIPHER_gettable_ctx_params, EVP_ASYM_CIPHER_settable_ctx_params - Functions to manage EVP_ASYM_CIPHER algorithm objects @@ -18,6 +18,7 @@ EVP_ASYM_CIPHER_gettable_ctx_params, EVP_ASYM_CIPHER_settable_ctx_params void EVP_ASYM_CIPHER_free(EVP_ASYM_CIPHER *cipher); int EVP_ASYM_CIPHER_up_ref(EVP_ASYM_CIPHER *cipher); int EVP_ASYM_CIPHER_number(const EVP_ASYM_CIPHER *cipher); + const char *EVP_ASYM_CIPHER_name(const EVP_ASYM_CIPHER *cipher); int EVP_ASYM_CIPHER_is_a(const EVP_ASYM_CIPHER *cipher, const char *name); OSSL_PROVIDER *EVP_ASYM_CIPHER_provider(const EVP_ASYM_CIPHER *cipher); void EVP_ASYM_CIPHER_do_all_provided(OSSL_LIB_CTX *libctx, @@ -63,6 +64,12 @@ method and the given I<arg> as argument. EVP_ASYM_CIPHER_number() returns the internal dynamic number assigned to I<cipher>. +EVP_ASYM_CIPHER_name() returns the algorithm name from the provided +implementation for the given I<cipher>. Note that the I<cipher> 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 +by the I<cipher> object and should not be freed by the caller. + EVP_ASYM_CIPHER_names_do_all() traverses all names for I<cipher>, and calls I<fn> with each name and I<data>. diff --git a/doc/man3/EVP_KEM_free.pod b/doc/man3/EVP_KEM_free.pod index 906f4eebed..13600c521c 100644 --- a/doc/man3/EVP_KEM_free.pod +++ b/doc/man3/EVP_KEM_free.pod @@ -3,7 +3,7 @@ =head1 NAME EVP_KEM_fetch, EVP_KEM_free, EVP_KEM_up_ref, -EVP_KEM_number, EVP_KEM_is_a, EVP_KEM_provider, +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_gettable_ctx_params, EVP_KEM_settable_ctx_params - Functions to manage EVP_KEM algorithm objects @@ -17,6 +17,7 @@ EVP_KEM_gettable_ctx_params, EVP_KEM_settable_ctx_params 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_is_a(const EVP_KEM *kem, const char *name); OSSL_PROVIDER *EVP_KEM_provider(const EVP_KEM *kem); void EVP_KEM_do_all_provided(OSSL_LIB_CTX *libctx, @@ -56,6 +57,12 @@ and the given I<arg> as argument. EVP_KEM_number() returns the internal dynamic number assigned to I<kem>. +EVP_KEM_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 +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>. diff --git a/doc/man3/EVP_KEYEXCH_free.pod b/doc/man3/EVP_KEYEXCH_free.pod index 1257dd2e5c..d0a0b6ef06 100644 --- a/doc/man3/EVP_KEYEXCH_free.pod +++ b/doc/man3/EVP_KEYEXCH_free.pod @@ -5,7 +5,7 @@ EVP_KEYEXCH_fetch, EVP_KEYEXCH_free, EVP_KEYEXCH_up_ref, EVP_KEYEXCH_provider, EVP_KEYEXCH_is_a, EVP_KEYEXCH_do_all_provided, EVP_KEYEXCH_number, EVP_KEYEXCH_names_do_all, -EVP_KEYEXCH_description, +EVP_KEYEXCH_name, EVP_KEYEXCH_description, EVP_KEYEXCH_gettable_ctx_params, EVP_KEYEXCH_settable_ctx_params - Functions to manage EVP_KEYEXCH algorithm objects @@ -20,6 +20,7 @@ EVP_KEYEXCH_gettable_ctx_params, EVP_KEYEXCH_settable_ctx_params OSSL_PROVIDER *EVP_KEYEXCH_provider(const EVP_KEYEXCH *exchange); int EVP_KEYEXCH_is_a(const EVP_KEYEXCH *exchange, const char *name); int EVP_KEYEXCH_number(const EVP_KEYEXCH *exchange); + const char *EVP_KEYEXCH_name(const EVP_KEYEXCH *exchange); void EVP_KEYEXCH_do_all_provided(OSSL_LIB_CTX *libctx, void (*fn)(EVP_KEYEXCH *exchange, void *arg), void *arg); @@ -55,6 +56,12 @@ algorithm that's identifiable with I<name>. EVP_KEYEXCH_number() returns the internal dynamic number assigned to the I<exchange>. +EVP_KEYEXCH_name() returns the algorithm name from the provided +implementation for the given I<exchange>. Note that the I<exchange> 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 +by the I<exchange> object and should not be freed by the caller. + EVP_KEYEXCH_names_do_all() traverses all names for the I<exchange>, and calls I<fn> with each name and I<data>. diff --git a/doc/man3/EVP_KEYMGMT.pod b/doc/man3/EVP_KEYMGMT.pod index d62f1cb3f5..9f143cd6ed 100644 --- a/doc/man3/EVP_KEYMGMT.pod +++ b/doc/man3/EVP_KEYMGMT.pod @@ -10,7 +10,7 @@ EVP_KEYMGMT_provider, EVP_KEYMGMT_is_a, EVP_KEYMGMT_number, EVP_KEYMGMT_description, -EVP_KEYMGMT_get0_first_name, +EVP_KEYMGMT_name, EVP_KEYMGMT_do_all_provided, EVP_KEYMGMT_names_do_all, EVP_KEYMGMT_gettable_params, @@ -31,7 +31,7 @@ EVP_KEYMGMT_gen_settable_params const OSSL_PROVIDER *EVP_KEYMGMT_provider(const EVP_KEYMGMT *keymgmt); int EVP_KEYMGMT_is_a(const EVP_KEYMGMT *keymgmt, const char *name); int EVP_KEYMGMT_number(const EVP_KEYMGMT *keymgmt); - const char *EVP_KEYMGMT_get0_first_name(const EVP_KEYMGMT *keymgmt); + const char *EVP_KEYMGMT_name(const EVP_KEYMGMT *keymgmt); const char *EVP_KEYMGMT_description(const EVP_KEYMGMT *keymgmt); void EVP_KEYMGMT_do_all_provided(OSSL_LIB_CTX *libctx, @@ -74,11 +74,11 @@ algorithm that's identifiable with I<name>. EVP_KEYMGMT_number() returns the internal dynamic number assigned to the I<keymgmt>. -EVP_KEYMGMT_get0_first_name() returns the first algorithm name that is found for -the given I<keymgmt>. Note that the I<keymgmt> may have multiple synonyms -associated with it. In this case it is undefined which one will be returned. -Ownership of the returned string is retained by the I<keymgmt> object and should -not be freed by the caller. +EVP_KEYMGMT_name() returns the algorithm name from the provided implementation +for the given I<keymgmt>. Note that the I<keymgmt> 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 by the +I<keymgmt> object and should not be freed by the caller. EVP_KEYMGMT_names_do_all() traverses all names for the I<keymgmt>, and calls I<fn> with each name and I<data>. @@ -129,7 +129,7 @@ otherwise 0. EVP_KEYMGMT_number() returns an integer. -EVP_KEYMGMT_get0_first_name() returns the name that is found or NULL on error. +EVP_KEYMGMT_name() returns the algorithm name, or NULL on error. EVP_KEYMGMT_description() returns a pointer to a decription, or NULL if there isn't one. diff --git a/doc/man3/EVP_SIGNATURE_free.pod b/doc/man3/EVP_SIGNATURE_free.pod index 71f283fdc6..a1897bbdb0 100644 --- a/doc/man3/EVP_SIGNATURE_free.pod +++ b/doc/man3/EVP_SIGNATURE_free.pod @@ -5,7 +5,7 @@ EVP_SIGNATURE_fetch, EVP_SIGNATURE_free, EVP_SIGNATURE_up_ref, EVP_SIGNATURE_number, EVP_SIGNATURE_is_a, EVP_SIGNATURE_provider, EVP_SIGNATURE_do_all_provided, EVP_SIGNATURE_names_do_all, -EVP_SIGNATURE_description, +EVP_SIGNATURE_name, EVP_SIGNATURE_description, EVP_SIGNATURE_gettable_ctx_params, EVP_SIGNATURE_settable_ctx_params - Functions to manage EVP_SIGNATURE algorithm objects @@ -18,6 +18,7 @@ EVP_SIGNATURE_gettable_ctx_params, EVP_SIGNATURE_settable_ctx_params void EVP_SIGNATURE_free(EVP_SIGNATURE *signature); int EVP_SIGNATURE_up_ref(EVP_SIGNATURE *signature); int EVP_SIGNATURE_number(const EVP_SIGNATURE *signature); + const char *EVP_SIGNATURE_name(const EVP_SIGNATURE *signature); int EVP_SIGNATURE_is_a(const EVP_SIGNATURE *signature, const char *name); OSSL_PROVIDER *EVP_SIGNATURE_provider(const EVP_SIGNATURE *signature); void EVP_SIGNATURE_do_all_provided(OSSL_LIB_CTX *libctx, @@ -27,6 +28,7 @@ EVP_SIGNATURE_gettable_ctx_params, EVP_SIGNATURE_settable_ctx_params int EVP_SIGNATURE_names_do_all(const EVP_SIGNATURE *signature, void (*fn)(const char *name, void *data), void *data); + const char *EVP_SIGNATURE_name(const EVP_SIGNATURE *signature); const char *EVP_SIGNATURE_description(const EVP_SIGNATURE *signature); const OSSL_PARAM *EVP_SIGNATURE_gettable_ctx_params(const EVP_SIGNATURE *sig); const OSSL_PARAM *EVP_SIGNATURE_settable_ctx_params(const EVP_SIGNATURE *sig); @@ -63,6 +65,12 @@ and the given I<arg> as argument. EVP_SIGNATURE_number() returns the internal dynamic number assigned to I<signature>. +EVP_SIGNATURE_name() returns the algorithm name from the provided +implementation for the given I<signature>. Note that the I<signature> 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 +by the I<signature> object and should not be freed by the caller. + EVP_SIGNATURE_names_do_all() traverses all names for I<signature>, and calls I<fn> with each name and I<data>. |