---
name: "rte_security_macsec_xform"
section: "3"
platform: "linux"
package: "dpdk-doc"
version: "24.11.4-0+deb13u1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/rte_security_macsec_xform"
---

# rte\_security\_macsec\_xform(3)

## NAME

rte\_security\_macsec\_xform

## SYNOPSIS

`#include <rte_security.h>`

### Data Fields

enum **rte\_security\_macsec\_direction** **dir**\
 enum **rte\_security\_macsec\_alg** **alg**\
 uint8\_t **cipher\_off**\
 uint64\_t **sci**\
 uint16\_t **sc\_id**\

## Detailed Description

MACsec security session configuration

Definition at line **429** of file **rte\_security.h**.

## Field Documentation

### enum rte\_security\_macsec\_direction dir

Direction of flow/secure channel

Definition at line **431** of file **rte\_security.h**.

### enum rte\_security\_macsec\_alg alg

MACsec algorithm to be used

Definition at line **433** of file **rte\_security.h**.

### uint8\_t cipher\_off

Cipher offset from start of Ethernet header

Definition at line **435** of file **rte\_security.h**.

### uint64\_t sci

SCI to be used for RX flow identification or to set SCI in packet for TX when send\_sci is set

Definition at line **440** of file **rte\_security.h**.

### uint16\_t sc\_id

Receive/transmit secure channel ID created by *rte\_security\_macsec\_sc\_create*

Definition at line **442** of file **rte\_security.h**.

### uint16\_t mtu

MTU for transmit frame (valid for inline processing)

Definition at line **446** of file **rte\_security.h**.

### uint8\_t sectag\_off

Offset to insert sectag from start of ethernet header or from a matching VLAN tag

Definition at line **451** of file **rte\_security.h**.

### uint16\_t protect\_frames

Enable MACsec protection of frames

Definition at line **453** of file **rte\_security.h**.

### uint16\_t sectag\_insert\_mode

Sectag insertion mode If 1, Sectag is inserted at fixed sectag\_off set above. If 0, Sectag is inserted at relative sectag\_off from a matching VLAN tag set.

Definition at line **460** of file **rte\_security.h**.

### uint16\_t icv\_include\_da\_sa

ICV includes source and destination MAC addresses

Definition at line **462** of file **rte\_security.h**.

### uint16\_t ctrl\_port\_enable

Control port is enabled

Definition at line **464** of file **rte\_security.h**.

### uint16\_t sectag\_version

Version of MACsec header. Should be 0

Definition at line **466** of file **rte\_security.h**.

### uint16\_t end\_station

Enable end station. SCI is not valid

Definition at line **468** of file **rte\_security.h**.

### uint16\_t send\_sci

Send SCI along with sectag

Definition at line **470** of file **rte\_security.h**.

### uint16\_t scb

enable secure channel support EPON - single copy broadcast

Definition at line **472** of file **rte\_security.h**.

### uint16\_t encrypt

Enable packet encryption and set RTE\_MACSEC\_TCI\_C and RTE\_MACSEC\_TCI\_E in sectag

Definition at line **477** of file **rte\_security.h**.

### uint16\_t reserved

Reserved bitfields for future

Definition at line **479** of file **rte\_security.h**.

### uint32\_t replay\_win\_sz

Replay Window size to be supported

Definition at line **483** of file **rte\_security.h**.

### uint16\_t validate\_frames

Set bits as per RTE\_SECURITY\_MACSEC\_VALIDATE\_\*

Definition at line **485** of file **rte\_security.h**.

### uint16\_t preserve\_sectag

Do not strip SecTAG after processing

Definition at line **491** of file **rte\_security.h**.

### uint16\_t preserve\_icv

Do not strip ICV from the packet after processing

Definition at line **493** of file **rte\_security.h**.

### uint16\_t replay\_protect

Enable anti-replay protection

Definition at line **495** of file **rte\_security.h**.

## Author

Generated automatically by Doxygen for DPDK from the source code.
