RTE_SECURITY_IPSEC_XFORM(3)

πŸ’– rte_security_ipsec_xform πŸ’–

okay bestie, so this is rte_security_ipsec_xform(3) β€” a lil manual page from the DPDK library functions crew, and it's literally about the struct you use to set up an IPsec security association. no cap, it's giving "glue code that makes the crypto go brrr". let's get into it 🫢


✨ NAME ✨

rte_security_ipsec_xform β€” the struct, bestie. that's the whole name. iconic πŸ’…


🌸 SYNOPSIS 🌸

first things first, you gotta pull in the header:

#include <rte_security.h>

πŸŽ€ Data Fields πŸŽ€

here's every single field, in order, no skipping, we love a complete list ✨

  • uint32_t spi
  • uint32_t salt
  • struct rte_security_ipsec_sa_options options
  • enum rte_security_ipsec_sa_direction direction
  • enum rte_security_ipsec_sa_protocol proto
  • enum rte_security_ipsec_sa_mode mode
  • struct rte_security_ipsec_tunnel_param tunnel
  • struct rte_security_ipsec_lifetime life
  • uint32_t replay_win_sz
  • union, and it's an empty-ish one:
union {
} esn
  • struct rte_security_ipsec_udp_param udp

πŸ¦‹ Detailed Description πŸ¦‹

so what is this thing? it's IPsec security association configuration data. πŸŽ€

basically, this structure is holding all the data you need to create an IPsec SA security session. that's the vibe. that's the whole job. it's the main character of SA setup πŸ’œ

πŸ“ Definition location: line 301 of file rte_security.h.

πŸ‘‘ Field Documentation πŸ‘‘

okay now the fun part, field by field, with the receipts πŸ’–

⭐ uint32_t spi

SA security parameter index. the number that says "this one, not that one".

Definition at line 302 of file rte_security.h.

⭐ uint32_t salt

SA salt. a lil extra seasoning on your keys πŸ§‚βœ¨

Definition at line 304 of file rte_security.h.

⭐ struct rte_security_ipsec_sa_options options

various SA options. the settings drawer, bestie.

Definition at line 306 of file rte_security.h.

⭐ enum rte_security_ipsec_sa_direction direction

IPSec SA Direction β€” Egress/Ingress. are we going out or coming in? πŸšͺ

Definition at line 308 of file rte_security.h.

⭐ enum rte_security_ipsec_sa_protocol proto

IPsec SA Protocol β€” AH/ESP. pick your fighter πŸ₯Š

Definition at line 310 of file rte_security.h.

⭐ enum rte_security_ipsec_sa_mode mode

IPsec SA Mode β€” transport/tunnel. tunnel mode is lowkey the drama one πŸš‡

Definition at line 312 of file rte_security.h.

⭐ struct rte_security_ipsec_tunnel_param tunnel

Tunnel parameters β€” and heads up, this is NULL for transport mode. don't be out here setting tunnel stuff in transport mode, bestie 😭

Definition at line 314 of file rte_security.h.

⭐ struct rte_security_ipsec_lifetime life

IPsec SA lifetime. everything has an era and this SA's era has a number 🌈

Definition at line 316 of file rte_security.h.

⭐ uint32_t replay_win_sz

Anti replay window size, used to enable sequence replay attack handling. and listen β€” replay checking is disabled if the window size is 0. zero means no protection, periodt. set it if you care πŸ’€

Definition at line 318 of file rte_security.h.

⭐ union { ... } esn

Extended Sequence Number. that's it, that's the description ✨

⭐ struct rte_security_ipsec_udp_param udp

UDP parameters β€” and these get ignored when the udp_encap option is not specified. not me warning you twice but yeah, ignored πŸ™ˆ

Definition at line 330 of file rte_security.h.

πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for DPDK from the source code. so technically Doxygen wrote this and i just gave it a glow-up πŸŽ€


and that's the whole page, bestie!! 🌟 this was DPDK, Version 25.11.3, page rte_security_ipsec_xform(3) β€” go forth and configure your IPsec SAs responsibly, mwah πŸ’…πŸ’–βœ¨

πŸ“¦ where this page comes from