diff options
| author | Richard Levitte <levitte@openssl.org> | 2021-03-16 14:23:54 +0100 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2021-04-02 08:57:47 +0200 |
| commit | 03888233290bf3b8410e8dc2acbef8950fffef60 (patch) | |
| tree | cffa3d7c31504acbc2b80d7fe7d826381acc76fe /doc/man3/EVP_KEM_free.pod | |
| parent | b638dad970c65e311e9a724b89972441268adc9f (diff) | |
EVP: Add EVP_<TYPE>_description()
The following operation types are covered:
EVP_MD, EVP_CIPHER, EVP_MAC, EVP_RAND, EVP_KEYMGMT, EVP_SIGNATURE,
EVP_ASYM_CIPHER, EVP_KEM, EVP_KEYEXCH, EVP_KDF. Also EVP_PKEY.
For EVP_MD and EVP_CIPHER, OBJ_nid2ln() is used as a fallback for
legacy implementations.
For EVP_PKEY, the info field of the EVP_PKEY_ASN1_METHOD is used as a
fallback for legacy implementations.
Fixes #14514
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14656)
Diffstat (limited to 'doc/man3/EVP_KEM_free.pod')
| -rw-r--r-- | doc/man3/EVP_KEM_free.pod | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/man3/EVP_KEM_free.pod b/doc/man3/EVP_KEM_free.pod index 69302880c7..0551afcf8d 100644 --- a/doc/man3/EVP_KEM_free.pod +++ b/doc/man3/EVP_KEM_free.pod @@ -4,7 +4,7 @@ EVP_KEM_fetch, EVP_KEM_free, EVP_KEM_up_ref, EVP_KEM_number, EVP_KEM_is_a, EVP_KEM_provider, -EVP_KEM_do_all_provided, EVP_KEM_names_do_all, +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 @@ -23,6 +23,7 @@ EVP_KEM_gettable_ctx_params, EVP_KEM_settable_ctx_params 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 OSSL_PARAM *EVP_KEM_gettable_ctx_params(const EVP_KEM *kem); const OSSL_PARAM *EVP_KEM_settable_ctx_params(const EVP_KEM *kem); @@ -58,6 +59,10 @@ EVP_KEM_number() returns the internal dynamic number assigned to I<kem>. 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_gettable_ctx_params() and EVP_KEM_settable_ctx_params() return a constant B<OSSL_PARAM> array that describes the names and types of key parameters that can be retrieved or set by a key encapsulation algorithm using |