Authentication algorithm capabilities. More...

#include <crypto_types.h>

Data Fields
uint32_t	digest_len
	Digest length in bytes.

uint32_t	key_len
	Key length in bytes.

uint32_t	iv_len
	IV length in bytes.

struct {

uint32_t min
	Minimum AAD length in bytes. More...

uint32_t max
	Maximum AAD length in bytes. More...

uint32_t inc
	Increment of supported lengths between min and max (in bytes) More...

}	aad_len
	Additional Authenticated Data (AAD) lengths.

odp_bool_t	bit_mode
	Auth algorithm supports bit mode.

Detailed Description

Authentication algorithm capabilities.

Examples: ipsec_crypto/odp_ipsec.c, odp_crypto.c, and odp_sysinfo.c.

Definition at line 1224 of file api/spec/crypto_types.h.

Field Documentation

◆ digest_len

uint32_t odp_crypto_auth_capability_t::digest_len

Digest length in bytes.

Examples: ipsec_crypto/odp_ipsec.c, and odp_crypto.c.

Definition at line 1226 of file api/spec/crypto_types.h.

◆ key_len

uint32_t odp_crypto_auth_capability_t::key_len

Key length in bytes.

Examples: ipsec_crypto/odp_ipsec.c, and odp_crypto.c.

Definition at line 1229 of file api/spec/crypto_types.h.

◆ iv_len

uint32_t odp_crypto_auth_capability_t::iv_len

IV length in bytes.

Examples: ipsec_crypto/odp_ipsec.c, and odp_crypto.c.

Definition at line 1232 of file api/spec/crypto_types.h.

◆ min

uint32_t odp_crypto_auth_capability_t::min

Minimum AAD length in bytes.

Examples: odp_crypto.c.

Definition at line 1237 of file api/spec/crypto_types.h.

◆ max

uint32_t odp_crypto_auth_capability_t::max

Maximum AAD length in bytes.

Examples: odp_crypto.c.

Definition at line 1240 of file api/spec/crypto_types.h.

◆ inc

uint32_t odp_crypto_auth_capability_t::inc

Increment of supported lengths between min and max (in bytes)

Examples: odp_crypto.c.

Definition at line 1244 of file api/spec/crypto_types.h.

◆ bit_mode

odp_bool_t odp_crypto_auth_capability_t::bit_mode

Auth algorithm supports bit mode.

This auth algorithm can work on a range of bits in addition to a range of bytes. When this capability is not present, only byte ranges are supported. The unit of auth range is selected at session creation through the auth_range_in_bits session parameter.

Note: In bit mode the auth range must start on a byte boundary. Using an offset which is not divisible by 8 will result in undefined behaviour.

Note2: If the range length in bit mode is not a multiple of 8, the remaining bits of the data in the last byte of the input/output will be the most significant bits, i.e. the most significant bit is considered to be the first bit of a byte for the purpose of input and output data range. The output bits that fall out of the output range are undefined.

Examples: ipsec_crypto/odp_ipsec.c, and odp_crypto.c.

Definition at line 1265 of file api/spec/crypto_types.h.

The documentation for this struct was generated from the following file:

api/spec/crypto_types.h

Data Fields