PSA_AEAD_TAG_LENGTH macro

The length of a tag for an AEAD algorithm, in bytes. This macro can be used to allocate a buffer of sufficient size to store the tag output from psa_aead_finish(). See also #PSA_AEAD_TAG_MAX_SIZE.

Syntax

Show:

Summary

Declaration

from crypto_sizes.h:188

#define PSA_AEAD_TAG_LENGTH(key_type, key_bits, alg) \ (PSA_AEAD_NONCE_LENGTH(key_type, alg) != 0 ? \ PSA_ALG_AEAD_GET_TAG_LENGTH(alg) : \ ((void) (key_bits), 0u))

Arguments

Argument

Description

key_type

The type of the AEAD key.

key_bits

The size of the AEAD key in bits.

alg

An AEAD algorithm (\c PSA_ALG_XXX value such that #PSA_ALG_IS_AEAD(\p alg) is true).

Return value

The tag length for the specified algorithm and key. If the AEAD algorithm does not have an identified tag that can be distinguished from the rest of the ciphertext, return 0. If the key type or AEAD algorithm is not recognized, or the parameters are incompatible, return 0.

References

Code

Location

#define PSA_AEAD_TAG_LENGTH(key_type, key_bits, alg) \

crypto_sizes.h:188

PSA_AEAD_TAG_LENGTH macro

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle