IPSEC outbound operation options. More...

#include <ipsec_types.h>

Collaboration diagram for odp_ipsec_out_opt_t:

Data Fields
union {

struct {

uint32_t frag_mode: 1
	Use fragmentation mode option. More...

uint32_t tfc_pad: 1
	Use TFC padding length option. More...

uint32_t tfc_dummy: 1
	Tunnel mode TFC dummy packet. More...

uint32_t ip_param: 1
	Use IP parameters option. More...

} flag
	Option flags. More...

uint32_t all_flags
	All flag bits. More...

};
	Union of all flag bits.

odp_ipsec_frag_mode_t	frag_mode
	Fragmentation mode.

uint32_t	tfc_pad_len
	TFC padding length.

union {

odp_ipsec_ipv4_param_t ipv4
	Override IPv4 parameters in outer header creation. More...

odp_ipsec_ipv6_param_t ipv6
	Override IPv6 parameters in outer header creation. More...

};
	Union of IP parameters.

Detailed Description

IPSEC outbound operation options.

These may be used to override some SA level options. Supported options are listed in odp_ipsec_capability_t::out_op returned by odp_ipsec_capability(). Options that are not supported are ignored.

See also: odp_ipsec_out_op_capability_t

Definition at line 1253 of file api/spec/ipsec_types.h.

Field Documentation

◆ frag_mode [1/2]

uint32_t odp_ipsec_out_opt_t::frag_mode

Use fragmentation mode option.

Definition at line 1260 of file api/spec/ipsec_types.h.

◆ tfc_pad

uint32_t odp_ipsec_out_opt_t::tfc_pad

Use TFC padding length option.

Definition at line 1263 of file api/spec/ipsec_types.h.

◆ tfc_dummy

uint32_t odp_ipsec_out_opt_t::tfc_dummy

Tunnel mode TFC dummy packet.

This can be used only in tunnel mode. When the flag is set, packet length and content is ignored and instead a TFC dummy packet is created during IPSEC operation. The dummy packet length is defined by 'tfc_pad_len' option. If the SA is configured to copy IP header fields from inner IP packet, those fields must be passed with IP parameters option.

Definition at line 1273 of file api/spec/ipsec_types.h.

◆ ip_param

uint32_t odp_ipsec_out_opt_t::ip_param

Use IP parameters option.

Definition at line 1276 of file api/spec/ipsec_types.h.

◆ [struct]

struct { ... } odp_ipsec_out_opt_t::flag

Option flags.

Set flag for those options that are used, all other options are ignored.

◆ all_flags

uint32_t odp_ipsec_out_opt_t::all_flags

All flag bits.

This field can be used to set/clear all flags, or to perform bitwise operations over those.

Definition at line 1284 of file api/spec/ipsec_types.h.

◆ frag_mode [2/2]

odp_ipsec_frag_mode_t odp_ipsec_out_opt_t::frag_mode

Fragmentation mode.

Definition at line 1288 of file api/spec/ipsec_types.h.

◆ tfc_pad_len

uint32_t odp_ipsec_out_opt_t::tfc_pad_len

TFC padding length.

Number of TFC padding bytes added to the packet during IPSEC processing. Resulting packet should not exceed the maximum packet length of the pool, otherwise IPSEC operation may fail. Implementation guarantees that the padding does not contain any confidential information.

Definition at line 1297 of file api/spec/ipsec_types.h.

◆ ipv4

odp_ipsec_ipv4_param_t odp_ipsec_out_opt_t::ipv4

Override IPv4 parameters in outer header creation.

IP addresses are ignored.

Definition at line 1303 of file api/spec/ipsec_types.h.

◆ ipv6

odp_ipsec_ipv6_param_t odp_ipsec_out_opt_t::ipv6

Override IPv6 parameters in outer header creation.