rte_crypto_sym.h(3)

📦

version 25.11 · 5 versions

💖 `rte_crypto_sym.h(3)` 💖

okay bestie, welcome to the symmetric crypto header page — it's a DPDK one, section 3, and it's a whole meal. grab a snack 🍓

✨ NAME ✨

rte_crypto_sym.h — no cap, that's literally the whole name 💅

🦋 SYNOPSIS 🦋

the includes, in this exact order, queen:

#include <string.h>
#include <rte_compat.h>
#include <rte_mbuf.h>
#include <rte_memory.h>
#include <rte_mempool.h>
#include <rte_common.h>

🌸 Data Structures 🌸

struct rte_crypto_vec
struct rte_crypto_sgl
struct rte_crypto_va_iova_ptr
struct rte_crypto_sym_vec
union rte_crypto_sym_ofs
struct rte_crypto_cipher_xform
struct rte_crypto_auth_xform
struct rte_crypto_sym_xform
struct rte_crypto_sym_op

🎀 Enumerations 🎀

enum rte_crypto_cipher_algorithm — and yes, the = 1 on the first one is load-bearing, don't touch it:

{ RTE_CRYPTO_CIPHER_NULL = 1,
  RTE_CRYPTO_CIPHER_3DES_CBC, RTE_CRYPTO_CIPHER_3DES_CTR,
  RTE_CRYPTO_CIPHER_3DES_ECB, RTE_CRYPTO_CIPHER_AES_CBC,
  RTE_CRYPTO_CIPHER_AES_CTR, RTE_CRYPTO_CIPHER_AES_ECB,
  RTE_CRYPTO_CIPHER_AES_F8, RTE_CRYPTO_CIPHER_AES_XTS,
  RTE_CRYPTO_CIPHER_ARC4, RTE_CRYPTO_CIPHER_KASUMI_F8,
  RTE_CRYPTO_CIPHER_SNOW3G_UEA2, RTE_CRYPTO_CIPHER_ZUC_EEA3,
  RTE_CRYPTO_CIPHER_DES_CBC, RTE_CRYPTO_CIPHER_AES_DOCSISBPI,
  RTE_CRYPTO_CIPHER_DES_DOCSISBPI, RTE_CRYPTO_CIPHER_SM4_ECB,
  RTE_CRYPTO_CIPHER_SM4_CBC, RTE_CRYPTO_CIPHER_SM4_CTR,
  RTE_CRYPTO_CIPHER_SM4_OFB, RTE_CRYPTO_CIPHER_SM4_CFB,
  RTE_CRYPTO_CIPHER_SM4_XTS }

enum rte_crypto_cipher_operation:

{ RTE_CRYPTO_CIPHER_OP_ENCRYPT,
  RTE_CRYPTO_CIPHER_OP_DECRYPT }

enum rte_crypto_auth_algorithm — buckle up, it's long:

{ RTE_CRYPTO_AUTH_NULL = 1,
  RTE_CRYPTO_AUTH_AES_CBC_MAC, RTE_CRYPTO_AUTH_AES_CMAC,
  RTE_CRYPTO_AUTH_AES_GMAC, RTE_CRYPTO_AUTH_AES_XCBC_MAC,
  RTE_CRYPTO_AUTH_KASUMI_F9, RTE_CRYPTO_AUTH_MD5,
  RTE_CRYPTO_AUTH_MD5_HMAC, RTE_CRYPTO_AUTH_SHA1,
  RTE_CRYPTO_AUTH_SHA1_HMAC, RTE_CRYPTO_AUTH_SHA224,
  RTE_CRYPTO_AUTH_SHA224_HMAC, RTE_CRYPTO_AUTH_SHA256,
  RTE_CRYPTO_AUTH_SHA256_HMAC, RTE_CRYPTO_AUTH_SHA384,
  RTE_CRYPTO_AUTH_SHA384_HMAC, RTE_CRYPTO_AUTH_SHA512,
  RTE_CRYPTO_AUTH_SHA512_HMAC, RTE_CRYPTO_AUTH_SNOW3G_UIA2,
  RTE_CRYPTO_AUTH_ZUC_EIA3, RTE_CRYPTO_AUTH_SHA3_224,
  RTE_CRYPTO_AUTH_SHA3_224_HMAC, RTE_CRYPTO_AUTH_SHA3_256,
  RTE_CRYPTO_AUTH_SHA3_256_HMAC, RTE_CRYPTO_AUTH_SHA3_384,
  RTE_CRYPTO_AUTH_SHA3_384_HMAC, RTE_CRYPTO_AUTH_SHA3_512,
  RTE_CRYPTO_AUTH_SHA3_512_HMAC, RTE_CRYPTO_AUTH_SM3,
  RTE_CRYPTO_AUTH_SHAKE_128, RTE_CRYPTO_AUTH_SHAKE_256,
  RTE_CRYPTO_AUTH_SM3_HMAC }

enum rte_crypto_auth_operation:

{ RTE_CRYPTO_AUTH_OP_VERIFY,
  RTE_CRYPTO_AUTH_OP_GENERATE }

enum rte_crypto_aead_algorithm:

{ RTE_CRYPTO_AEAD_AES_CCM = 1,
  RTE_CRYPTO_AEAD_AES_GCM, RTE_CRYPTO_AEAD_CHACHA20_POLY1305,
  RTE_CRYPTO_AEAD_SM4_GCM }

enum rte_crypto_aead_operation:

{ RTE_CRYPTO_AEAD_OP_ENCRYPT,
  RTE_CRYPTO_AEAD_OP_DECRYPT }

enum rte_crypto_sym_xform_type:

{ RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED = 0,
  RTE_CRYPTO_SYM_XFORM_AUTH, RTE_CRYPTO_SYM_XFORM_CIPHER,
  RTE_CRYPTO_SYM_XFORM_AEAD }

🧚 Functions 🧚

here they are, verbatim, because signatures are sacred:

static void __rte_crypto_sym_op_reset (struct rte_crypto_sym_op *op)
static struct rte_crypto_sym_xform *
    __rte_crypto_sym_op_sym_xforms_alloc (struct rte_crypto_sym_op
    *sym_op, void *priv_data, uint8_t nb_xforms)
static int __rte_crypto_sym_op_attach_sym_session (struct
    rte_crypto_sym_op *sym_op, void *sess)
static __rte_experimental int rte_crypto_mbuf_to_vec (const struct
    rte_mbuf *mb, uint32_t ofs, uint32_t len, struct rte_crypto_vec
    vec[], uint32_t num)

heads up: rte_crypto_mbuf_to_vec is marked __rte_experimental — that's the experimental tag, so it can still change on you. don't build your whole personality on it 😭

⭐ Variables ⭐

const char * rte_crypto_cipher_operation_strings []
const char * rte_crypto_auth_operation_strings []
const char * rte_crypto_aead_operation_strings []

💜 Detailed Description 💜

RTE Definitions for Symmetric Cryptography — say it with me 👑

This header defines symmetric cipher and authentication algorithms and modes, as well as supported symmetric crypto operation combinations. it's giving "the whole toolbox" energy fr fr.

Definition in file rte_crypto_sym.h.

🌈 Enumeration Type Documentation 🌈

💅 `enum rte_crypto_cipher_algorithm` 💅

Symmetric Cipher Algorithms.

okay so before you touch anything, note this — to avoid ABI breakage across releases:

LIST_END should not be added to this enum
the order of enums should not be changed
new algorithms should only be added to the end

like, the order is the vibe. respect the order. periodt.

Enumerator

RTE_CRYPTO_CIPHER_NULL — NULL cipher algorithm. no mode applies to the NULL algorithm, she's built different.
RTE_CRYPTO_CIPHER_3DES_CBC — Triple DES algorithm in CBC mode
RTE_CRYPTO_CIPHER_3DES_CTR — Triple DES algorithm in CTR mode
RTE_CRYPTO_CIPHER_3DES_ECB — Triple DES algorithm in ECB mode
RTE_CRYPTO_CIPHER_AES_CBC — AES algorithm in CBC mode
RTE_CRYPTO_CIPHER_AES_CTR — AES algorithm in Counter mode
RTE_CRYPTO_CIPHER_AES_ECB — AES algorithm in ECB mode
RTE_CRYPTO_CIPHER_AES_F8 — AES algorithm in F8 mode
RTE_CRYPTO_CIPHER_AES_XTS — AES algorithm in XTS mode
RTE_CRYPTO_CIPHER_ARC4 — (A)RC4 cipher algorithm
RTE_CRYPTO_CIPHER_KASUMI_F8 — KASUMI algorithm in F8 mode
RTE_CRYPTO_CIPHER_SNOW3G_UEA2 — SNOW 3G algorithm in UEA2 mode
RTE_CRYPTO_CIPHER_ZUC_EEA3 — ZUC algorithm in EEA3 mode
RTE_CRYPTO_CIPHER_DES_CBC — DES algorithm in CBC mode
RTE_CRYPTO_CIPHER_AES_DOCSISBPI — AES algorithm using modes required by DOCSIS Baseline Privacy Plus Spec. ⚠️ chained mbufs are not supported in this mode, i.e. rte_mbuf.next for m_src and m_dst in the rte_crypto_sym_op must be NULL. like, actually NULL. don't test her.
RTE_CRYPTO_CIPHER_DES_DOCSISBPI — DES algorithm using modes required by DOCSIS Baseline Privacy Plus Spec. ⚠️ same deal, chained mbufs are not supported in this mode, i.e. rte_mbuf.next for m_src and m_dst in the rte_crypto_sym_op must be NULL.
RTE_CRYPTO_CIPHER_SM4_ECB — ShangMi 4 (SM4) algorithm in ECB mode
RTE_CRYPTO_CIPHER_SM4_CBC — ShangMi 4 (SM4) algorithm in CBC mode
RTE_CRYPTO_CIPHER_SM4_CTR — ShangMi 4 (SM4) algorithm in CTR mode
RTE_CRYPTO_CIPHER_SM4_OFB — ShangMi 4 (SM4) algorithm in OFB mode
RTE_CRYPTO_CIPHER_SM4_CFB — ShangMi 4 (SM4) algorithm in CFB mode
RTE_CRYPTO_CIPHER_SM4_XTS — ShangMi 4 (SM4) algorithm in XTS mode

Definition at line 120 of file rte_crypto_sym.h.

🫶 `enum rte_crypto_cipher_operation` 🫶

Symmetric Cipher Direction — which way are we going, bestie?

Enumerator

RTE_CRYPTO_CIPHER_OP_ENCRYPT — Encrypt cipher operation
RTE_CRYPTO_CIPHER_OP_DECRYPT — Decrypt cipher operation

Definition at line 186 of file rte_crypto_sym.h.

🎀 `enum rte_crypto_auth_algorithm` 🎀

Symmetric Authentication / Hash Algorithms.

and again, to avoid ABI breakage across releases:

LIST_END should not be added to this enum
the order of enums should not be changed
new algorithms should only be added to the end

Enumerator

RTE_CRYPTO_AUTH_NULL — NULL hash algorithm.
RTE_CRYPTO_AUTH_AES_CBC_MAC — AES-CBC-MAC algorithm. only 128-bit keys are supported — so no, your 256-bit key is not invited to this one 🙈
RTE_CRYPTO_AUTH_AES_CMAC — AES CMAC algorithm.
RTE_CRYPTO_AUTH_AES_GMAC — AES GMAC algorithm.
RTE_CRYPTO_AUTH_AES_XCBC_MAC — AES XCBC algorithm.
RTE_CRYPTO_AUTH_KASUMI_F9 — KASUMI algorithm in F9 mode.
RTE_CRYPTO_AUTH_MD5 — MD5 algorithm
RTE_CRYPTO_AUTH_MD5_HMAC — HMAC using MD5 algorithm
RTE_CRYPTO_AUTH_SHA1 — 160 bit SHA algorithm.
RTE_CRYPTO_AUTH_SHA1_HMAC — HMAC using 160 bit SHA algorithm. 🎀 HMAC-SHA-1-96 can be generated by setting digest_length to 12 bytes in auth/aead xforms.
RTE_CRYPTO_AUTH_SHA224 — 224 bit SHA algorithm.
RTE_CRYPTO_AUTH_SHA224_HMAC — HMAC using 224 bit SHA algorithm.
RTE_CRYPTO_AUTH_SHA256 — 256 bit SHA algorithm.
RTE_CRYPTO_AUTH_SHA256_HMAC — HMAC using 256 bit SHA algorithm.
RTE_CRYPTO_AUTH_SHA384 — 384 bit SHA algorithm.
RTE_CRYPTO_AUTH_SHA384_HMAC — HMAC using 384 bit SHA algorithm.
RTE_CRYPTO_AUTH_SHA512 — 512 bit SHA algorithm.
RTE_CRYPTO_AUTH_SHA512_HMAC — HMAC using 512 bit SHA algorithm.
RTE_CRYPTO_AUTH_SNOW3G_UIA2 — SNOW 3G algorithm in UIA2 mode.
RTE_CRYPTO_AUTH_ZUC_EIA3 — ZUC algorithm in EIA3 mode
RTE_CRYPTO_AUTH_SHA3_224 — 224 bit SHA3 algorithm.
RTE_CRYPTO_AUTH_SHA3_224_HMAC — HMAC using 224 bit SHA3 algorithm.
RTE_CRYPTO_AUTH_SHA3_256 — 256 bit SHA3 algorithm.
RTE_CRYPTO_AUTH_SHA3_256_HMAC — HMAC using 256 bit SHA3 algorithm.
RTE_CRYPTO_AUTH_SHA3_384 — 384 bit SHA3 algorithm.
RTE_CRYPTO_AUTH_SHA3_384_HMAC — HMAC using 384 bit SHA3 algorithm.
RTE_CRYPTO_AUTH_SHA3_512 — 512 bit SHA3 algorithm.
RTE_CRYPTO_AUTH_SHA3_512_HMAC — HMAC using 512 bit SHA3 algorithm.
RTE_CRYPTO_AUTH_SM3 — ShangMi 3 (SM3) algorithm
RTE_CRYPTO_AUTH_SHAKE_128 — 128 bit SHAKE algorithm.
RTE_CRYPTO_AUTH_SHAKE_256 — 256 bit SHAKE algorithm.

Definition at line 311 of file rte_crypto_sym.h.

🦋 `enum rte_crypto_auth_operation` 🦋

Symmetric Authentication / Hash Operations.

Enumerator

RTE_CRYPTO_AUTH_OP_VERIFY — Verify authentication digest
RTE_CRYPTO_AUTH_OP_GENERATE — Generate authentication digest

Definition at line 390 of file rte_crypto_sym.h.

🔥 `enum rte_crypto_aead_algorithm` 🔥

Symmetric AEAD Algorithms.

once more with feeling, to avoid ABI breakage across releases:

LIST_END should not be added to this enum
the order of enums should not be changed
new algorithms should only be added to the end

Enumerator

RTE_CRYPTO_AEAD_AES_CCM — AES algorithm in CCM mode.
RTE_CRYPTO_AEAD_AES_GCM — AES algorithm in GCM mode.
RTE_CRYPTO_AEAD_CHACHA20_POLY1305 — Chacha20 cipher with poly1305 authenticator
RTE_CRYPTO_AEAD_SM4_GCM — SM4 cipher in GCM mode

Definition at line 480 of file rte_crypto_sym.h.

🌸 `enum rte_crypto_aead_operation` 🌸

Symmetric AEAD Operations.

Enumerator

RTE_CRYPTO_AEAD_OP_ENCRYPT — Encrypt and generate digest
RTE_CRYPTO_AEAD_OP_DECRYPT — Verify digest and decrypt

Definition at line 492 of file rte_crypto_sym.h.

👑 `enum rte_crypto_sym_xform_type` 👑

Crypto transformation types — the "what kind of xform am I even looking at" enum.

Enumerator

RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED — No xform specified
RTE_CRYPTO_SYM_XFORM_AUTH — Authentication xform
RTE_CRYPTO_SYM_XFORM_CIPHER — Cipher xform
RTE_CRYPTO_SYM_XFORM_AEAD — AEAD xform

Definition at line 564 of file rte_crypto_sym.h.

to be continued bestie 💀 part 2 is coming and it's not done with us yet 🧚✨

💅 FUNCTION DOCUMENTATION 💅

okay bestie, this is the part where the actual functions live — small helpers, all static + inline, all defined right there in the header. no cap, these are the little glue gidgets that make a symmetric crypto op behave. let's go one by one 🫶

🧼 `__rte_crypto_sym_op_reset`

static void __rte_crypto_sym_op_reset (struct rte_crypto_sym_op * op)

[inline], [static]

Reset the fields of a symmetric operation to their default values. that's it, that's the job — a clean slate for your op, no leftover vibes from whatever it was doing before ✨

Parameters

op — the crypto operation to be reset.

Definition at line 887 of file rte_crypto_sym.h.

🧚 `__rte_crypto_sym_op_sym_xforms_alloc`

static struct rte_crypto_sym_xform* __rte_crypto_sym_op_sym_xforms_alloc
    (struct rte_crypto_sym_op * sym_op, void * priv_data, uint8_t nb_xforms)

[inline], [static]

Allocate space for symmetric crypto xforms in the private data space of the crypto operation. and because it's an overachiever, it also defaults the crypto xform type to RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED and configures the chaining of the xforms in the crypto operation. one call, three jobs, main character energy fr 🔥

Returns

On success, returns a pointer to the first crypto xform in the crypto operation's chain 🎀
On failure, returns NULL 😭

Definition at line 904 of file rte_crypto_sym.h.

🔗 `__rte_crypto_sym_op_attach_sym_session`

static int __rte_crypto_sym_op_attach_sym_session (struct rte_crypto_sym_op
    * sym_op, void * sess)

[inline], [static]

Attach a session to a symmetric crypto operation. yes bestie, this is the "you two belong together" function 💖

Parameters

sym_op — crypto operation
sess — cryptodev session

Definition at line 927 of file rte_crypto_sym.h.

🦋 `rte_crypto_mbuf_to_vec`

static __rte_experimental int rte_crypto_mbuf_to_vec (const struct rte_mbuf
    * mb, uint32_t ofs, uint32_t len, struct rte_crypto_vec vec[], uint32_t
    num)

[inline], [static]

Converts a portion of mbuf data into a vector representation. each segment gets its own separate entry in the vec array — one segment, one lil' slot, no cramming 🌸

⚠️ heads up: this function expects that the provided ofs + len does not exceed the mbuf's pkt_len. it's not gonna check your math for you, so pls do check it 🙈

Parameters

mb — pointer to the rte_mbuf object.
ofs — offset within the mbuf data to start with.
len — length of data to represent.
vec — pointer to an output array of IO vectors.
num — size of the output array.

Returns

the number of successfully filled entries in the vec array ⭐
a negative number of elements in the vec array required 💀 (so like, it can tell you how much room it actually needed)

Definition at line 954 of file rte_crypto_sym.h.

🎀 VARIABLE DOCUMENTATION 🎀

just three little extern string arrays, chilling. they're name strings for the operations — handy for printing stuff in a human-readable way, iykyk 👑

const char* rte_crypto_cipher_operation_strings[] [extern] — cipher operation name strings 🔐
const char* rte_crypto_auth_operation_strings[] [extern] — authentication operation name strings ✅
const char* rte_crypto_aead_operation_strings[] [extern] — authentication operation name strings 👀 (yes, it says authentication again — that's literally what the page says, not me being chaotic, I promise 🫶)

👑 AUTHOR 👑

Generated automatically by Doxygen for DPDK from the source code. so no human author to thank here — the robots did this one, and honestly? they ate 🤖✨

and that's a wrap on part 2, bestie!! 🎉 this page came straight out of the DPDK source code, version 25.11.0, dated Fri Jan 30 2026 — go forth and sym-op responsibly 💜🎀🦋

📦 where this page comes from

centos-stream 9: dpdk-devel 2:25.11-1.el9 · BSD and LGPLv2 and GPLv2
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-06: a language model's rewrite of the original, under its terms

rte_crypto_sym.h(3)

💖 rte_crypto_sym.h(3) 💖

✨ NAME ✨

🦋 SYNOPSIS 🦋

🌸 Data Structures 🌸

🎀 Enumerations 🎀

🧚 Functions 🧚

⭐ Variables ⭐

💜 Detailed Description 💜

🌈 Enumeration Type Documentation 🌈

💅 enum rte_crypto_cipher_algorithm 💅

Enumerator

🫶 enum rte_crypto_cipher_operation 🫶

Enumerator

🎀 enum rte_crypto_auth_algorithm 🎀

Enumerator

🦋 enum rte_crypto_auth_operation 🦋

Enumerator

🔥 enum rte_crypto_aead_algorithm 🔥

Enumerator

🌸 enum rte_crypto_aead_operation 🌸

Enumerator

👑 enum rte_crypto_sym_xform_type 👑

Enumerator

💅 FUNCTION DOCUMENTATION 💅

🧼 __rte_crypto_sym_op_reset

🧚 __rte_crypto_sym_op_sym_xforms_alloc

🔗 __rte_crypto_sym_op_attach_sym_session

🦋 rte_crypto_mbuf_to_vec

🎀 VARIABLE DOCUMENTATION 🎀

👑 AUTHOR 👑

💖 `rte_crypto_sym.h(3)` 💖

💅 `enum rte_crypto_cipher_algorithm` 💅

🫶 `enum rte_crypto_cipher_operation` 🫶

🎀 `enum rte_crypto_auth_algorithm` 🎀

🦋 `enum rte_crypto_auth_operation` 🦋

🔥 `enum rte_crypto_aead_algorithm` 🔥

🌸 `enum rte_crypto_aead_operation` 🌸

👑 `enum rte_crypto_sym_xform_type` 👑

🧼 `__rte_crypto_sym_op_reset`

🧚 `__rte_crypto_sym_op_sym_xforms_alloc`

🔗 `__rte_crypto_sym_op_attach_sym_session`

🦋 `rte_crypto_mbuf_to_vec`