diff options
| author | Shane Lontis <shane.lontis@oracle.com> | 2019-09-11 17:52:30 +1000 |
|---|---|---|
| committer | Shane Lontis <shane.lontis@oracle.com> | 2019-09-11 17:52:30 +1000 |
| commit | dc64dc2edd215d6cc5843c1bfe1f0b64bff26adc (patch) | |
| tree | 2e2fb32d97e77ddc2cac66d0577dba3ddd73fa1c /doc | |
| parent | 64115f05ac950390e80e3993703513cda439fca0 (diff) | |
Add EVP_CIPHER_CTX_tag_length()
There is no deprecated CTRL support for this new field.
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9698)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/EVP_EncryptInit.pod | 9 | ||||
| -rw-r--r-- | doc/man7/provider-cipher.pod | 5 |
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod index 11d0250a0d..78f67bd643 100644 --- a/doc/man3/EVP_EncryptInit.pod +++ b/doc/man3/EVP_EncryptInit.pod @@ -49,6 +49,7 @@ EVP_CIPHER_CTX_settable_params, EVP_CIPHER_CTX_block_size, EVP_CIPHER_CTX_key_length, EVP_CIPHER_CTX_iv_length, +EVP_CIPHER_CTX_tag_length, EVP_CIPHER_CTX_get_app_data, EVP_CIPHER_CTX_set_app_data, EVP_CIPHER_CTX_type, @@ -137,6 +138,7 @@ EVP_CIPHER_do_all_ex int EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx); int EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx); int EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx); + int EVP_CIPHER_CTX_tag_length(const EVP_CIPHER_CTX *ctx); void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx); void EVP_CIPHER_CTX_set_app_data(const EVP_CIPHER_CTX *ctx, void *data); int EVP_CIPHER_CTX_type(const EVP_CIPHER_CTX *ctx); @@ -297,6 +299,10 @@ length of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX>. It will return zero if the cipher does not use an IV. The constant B<EVP_MAX_IV_LENGTH> is the maximum IV length for all ciphers. +EVP_CIPHER_CTX_tag_length() returns the tag length of a AEAD cipher when passed +a B<EVP_CIPHER_CTX>. It will return zero if the cipher does not support a tag. +It returns a default value if the tag length has not been set. + EVP_CIPHER_block_size() and EVP_CIPHER_CTX_block_size() return the block size of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX> structure. The constant B<EVP_MAX_BLOCK_LENGTH> is also the maximum block @@ -395,6 +401,9 @@ EVP_CIPHER_CTX_set_padding() always returns 1. EVP_CIPHER_iv_length() and EVP_CIPHER_CTX_iv_length() return the IV length or zero if the cipher does not use an IV. +EVP_CIPHER_CTX_tag_length() return the tag length or zero if the cipher does not +use a tag. + EVP_CIPHER_type() and EVP_CIPHER_CTX_type() return the NID of the cipher's OBJECT IDENTIFIER or NID_undef if it has no defined OBJECT IDENTIFIER. diff --git a/doc/man7/provider-cipher.pod b/doc/man7/provider-cipher.pod index 1b7dff8f76..d5d2f13390 100644 --- a/doc/man7/provider-cipher.pod +++ b/doc/man7/provider-cipher.pod @@ -248,6 +248,11 @@ block has been "used" already. Gets or sets the AEAD tag for the associated cipher ctx. See L<EVP_EncryptInit(3)/AEAD Interface>. +=item B<OSSL_CIPHER_PARAM_AEAD_TAGLEN> (size_t) + +Gets the tag length to be used for an AEAD cipher for the associated cipher ctx. +It returns a default value if it has not been set. + =item B<OSSL_CIPHER_PARAM_AEAD_TLS1_AAD> (octet_string) =for comment TODO(3.0): Consider changing this interface so that all ciphers |