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_EncryptInit.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_EncryptInit.pod')
| -rw-r--r-- | doc/man3/EVP_EncryptInit.pod | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod index 9090dc8ad3..303e93fe06 100644 --- a/doc/man3/EVP_EncryptInit.pod +++ b/doc/man3/EVP_EncryptInit.pod @@ -34,6 +34,7 @@ EVP_get_cipherbynid, EVP_get_cipherbyobj, EVP_CIPHER_is_a, EVP_CIPHER_name, +EVP_CIPHER_description, EVP_CIPHER_number, EVP_CIPHER_names_do_all, EVP_CIPHER_provider, @@ -143,6 +144,7 @@ EVP_CIPHER_do_all_provided void (*fn)(const char *name, void *data), void *data); const char *EVP_CIPHER_name(const EVP_CIPHER *cipher); + const char *EVP_CIPHER_description(const EVP_CIPHER *cipher); const OSSL_PROVIDER *EVP_CIPHER_provider(const EVP_CIPHER *cipher); int EVP_CIPHER_block_size(const EVP_CIPHER *e); int EVP_CIPHER_key_length(const EVP_CIPHER *e); @@ -408,6 +410,10 @@ EVP_CIPHER_names_do_all() traverses all names for the I<cipher>, and calls I<fn> with each name and I<data>. This is only useful with fetched B<EVP_CIPHER>s. +EVP_CIPHER_description() returns a description of the cipher, meant for +display and human consumption. The description is at the discretion of the +cipher implementation. + EVP_CIPHER_provider() returns an B<OSSL_PROVIDER> pointer to the provider that implements the given B<EVP_CIPHER>. |