RTE_SECURITY_MACSEC_XFORM(3)

💖 rte_security_macsec_xform 💖

so bestie, welcome to the rte_security_macsec_xform page from the DPDK Library Functions Manual — yes it's a struct, yes it's iconic, and yes we're gonna go through literally every field together. no skips. 🫶

---

✨ NAME ✨

rte_security_macsec_xform — the MACsec session config struct, periodt.

---

🌸 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 🦋

okay so this whole struct is the MACsec security session configuration. that's the vibe. that's the whole thing. 💅

Definition at line 429 of file rte_security.h.

---

👑 Field Documentation 👑

🌈 enum rte_security_macsec_direction dir

Direction of flow / secure channel. so like, which way is this even going, bestie.

Definition at line 431 of file rte_security.h.

---

🌈 enum rte_security_macsec_alg alg

The MACsec algorithm to be used. pick your fighter. ✨

Definition at line 433 of file rte_security.h.

---

🌈 uint8_t cipher_off

Cipher offset from start of Ethernet header. i.e. how far past the Ethernet header the ciphering kicks in. 📏

Definition at line 435 of file rte_security.h.

---

🌈 uint64_t sci

SCI to be used for RX flow identification, or to set the SCI in the packet for TX when send_sci is set. conditional queen. 👑

Definition at line 440 of file rte_security.h.

---

🌈 uint16_t sc_id

Receive/transmit secure channel ID, and it's created by rte_security_macsec_sc_create. so like, go make it first, then come back. 🎀

Definition at line 442 of file rte_security.h.

---

🌈 uint16_t mtu

MTU for the transmit frame — and heads up, this is only valid for inline processing. 🫶

Definition at line 446 of file rte_security.h.

---

🌈 uint8_t sectag_off

Offset to insert the sectag, measured from the start of the ethernet header or from a matching VLAN tag. depends on the mode, iykyk. 📐

Definition at line 451 of file rte_security.h.

---

🌈 uint16_t protect_frames

Enable MACsec protection of frames. protect the frames, protect your peace. 🛡️

Definition at line 453 of file rte_security.h.

---

🌈 uint16_t sectag_insert_mode

Sectag insertion mode, and it's giving two moods:

• If 1, the Sectag is inserted at the fixed sectag_off set above.
• If 0, the Sectag is inserted at the 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 the source and destination MAC addresses. yes, the whole address situation goes in. 💌

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 the MACsec header. and bestie — it should be 0. not negotiable, not a suggestion.

Definition at line 466 of file rte_security.h.

---

🌈 uint16_t end_station

Enable end station. ⚠️ heads up: when this is set, the SCI is not valid.

Definition at line 468 of file rte_security.h.

---

🌈 uint16_t send_sci

Send SCI along with the sectag. it's travelling together, cute. 🧳

Definition at line 470 of file rte_security.h.

---

🌈 uint16_t scb

Enable secure channel support EPON — single copy broadcast. yup, it's actually called scb. slay.

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 the sectag. two flags, one field, no cap. 🔥

Definition at line 477 of file rte_security.h.

---

🌈 uint16_t reserved

Reserved bitfields for the future. it's literally saving a seat, don't sit there. 🙈

Definition at line 479 of file rte_security.h.

---

🌈 uint32_t replay_win_sz

Replay Window size to be supported. how wide the window is, bestie. 🪟

Definition at line 483 of file rte_security.h.

---

🌈 uint16_t validate_frames

Set bits as per RTE_SECURITY_MACSEC_VALIDATE_*. go read those, not me, I'm just the messenger. ✨

Definition at line 485 of file rte_security.h.

---

🌈 uint16_t preserve_sectag

Do not strip the SecTAG after processing. keep it, keep it, keep it. 💅

Definition at line 491 of file rte_security.h.

---

🌈 uint16_t preserve_icv

Do not strip the ICV from the packet after processing. same energy, different field. 🫶

Definition at line 493 of file rte_security.h.

---

🌈 uint16_t replay_protect

Enable anti-replay protection. nothing gets replayed on our watch. 🚫🔁

Definition at line 495 of file rte_security.h.

---

💜 Author 💜

Generated automatically by Doxygen for DPDK from the source code.

---

and that's the whole page, bestie 💖 every single field, every single line number, nothing skipped, no notes. this little icon was auto-generated by Doxygen for DPDK — Version 25.11.3 — so go forth and configure your MACsec sessions, you main character. 🌸🦋✨