rte_crypto_asym.h(3)

📦
version 25.11.3 · 9 versions
, in ubuntu resolute, ubuntu stonking

✨ rte_crypto_asym.h ✨ <span>— the rte_crypto_asym.h(3) glow-up</span>

okay bestie, grab a strawberry drink 🍓 because this is the asym crypto header of DPDK and it is a lot, but in the best way. it's in the Library Functions Manual, it's iconic, and we're gonna get through it together. no cap.

🌸 NAME 🌸

rte_crypto_asym.h

like... the file itself. that's the name. main character energy from the jump 💅

🦋 SYNOPSIS 🦋

first you gotta pull in the crew:

#include <string.h>
#include <stdint.h>
#include <rte_memory.h>
#include <rte_mempool.h>
#include <rte_common.h>
#include 'rte_crypto_sym.h'

(and yes, that last one is written with single quotes in the original, so we keep it exactly like that, don't come for me 🙈)

💜 Data Structures

here's the whole cast list, in order, and every single one of them matters:

  • struct rte_crypto_param_t
  • struct rte_crypto_ec_point
  • struct rte_crypto_rsa_priv_key_qt
  • struct rte_crypto_rsa_padding
  • struct rte_crypto_rsa_xform
  • struct rte_crypto_modex_xform
  • struct rte_crypto_modinv_xform
  • struct rte_crypto_dh_xform
  • struct rte_crypto_dsa_xform
  • struct rte_crypto_ec_xform
  • struct rte_crypto_mod_op_param
  • struct rte_crypto_rsa_op_param
  • struct rte_crypto_dh_op_param
  • struct rte_crypto_ecdh_op_param
  • struct rte_crypto_dsa_op_param
  • struct rte_crypto_ecdsa_op_param
  • struct rte_crypto_eddsa_op_param
  • struct rte_crypto_ecpm_op_param
  • struct rte_crypto_sm2_op_param
  • struct rte_crypto_ml_kem_xform
  • struct rte_crypto_ml_kem_keygen_op
  • struct rte_crypto_ml_kem_keyver_op
  • struct rte_crypto_ml_kem_encap_op
  • struct rte_crypto_ml_kem_decap_op
  • struct rte_crypto_ml_kem_op
  • struct rte_crypto_ml_dsa_xform
  • struct rte_crypto_ml_dsa_keygen_op
  • struct rte_crypto_ml_dsa_siggen_op
  • struct rte_crypto_ml_dsa_sigver_op
  • struct rte_crypto_ml_dsa_op
  • struct rte_crypto_asym_xform
  • struct rte_crypto_asym_op

🎀 Macros

tiny but mighty, and yes they are all RTE_BIT32 coded:

  • #define RTE_CRYPTO_ASYM_FLAG_PUB_KEY_NO_PADDING RTE_BIT32(0)
  • #define RTE_CRYPTO_ASYM_FLAG_SHARED_KEY_NO_PADDING RTE_BIT32(1)
  • #define RTE_CRYPTO_ASYM_FLAG_PUB_KEY_COMPRESSED RTE_BIT32(2)

🌈 Typedefs

  • typedef struct rte_crypto_param_t rte_crypto_param
  • typedef rte_crypto_param rte_crypto_uint

⭐ Enumerations

so many enums, and each one is giving something:

  • enum rte_crypto_curve_id
  • enum rte_crypto_edward_instance
  • enum rte_crypto_asym_xform_type { RTE_CRYPTO_ASYM_XFORM_UNSPECIFIED = 0, RTE_CRYPTO_ASYM_XFORM_NONE, RTE_CRYPTO_ASYM_XFORM_RSA, RTE_CRYPTO_ASYM_XFORM_DH, RTE_CRYPTO_ASYM_XFORM_DSA, RTE_CRYPTO_ASYM_XFORM_MODINV, RTE_CRYPTO_ASYM_XFORM_MODEX, RTE_CRYPTO_ASYM_XFORM_ECDSA, RTE_CRYPTO_ASYM_XFORM_ECDH, RTE_CRYPTO_ASYM_XFORM_ECPM, RTE_CRYPTO_ASYM_XFORM_ECFPM, RTE_CRYPTO_ASYM_XFORM_SM2, RTE_CRYPTO_ASYM_XFORM_EDDSA, RTE_CRYPTO_ASYM_XFORM_ML_KEM, RTE_CRYPTO_ASYM_XFORM_ML_DSA }
  • enum rte_crypto_asym_op_type { RTE_CRYPTO_ASYM_OP_ENCRYPT, RTE_CRYPTO_ASYM_OP_DECRYPT, RTE_CRYPTO_ASYM_OP_SIGN, RTE_CRYPTO_ASYM_OP_VERIFY, RTE_CRYPTO_ASYM_OP_LIST_END }
  • enum rte_crypto_asym_ke_type { RTE_CRYPTO_ASYM_KE_PRIV_KEY_GENERATE, RTE_CRYPTO_ASYM_KE_PUB_KEY_GENERATE, RTE_CRYPTO_ASYM_KE_SHARED_SECRET_COMPUTE, RTE_CRYPTO_ASYM_KE_PUB_KEY_VERIFY }
  • enum rte_crypto_rsa_padding_type { RTE_CRYPTO_RSA_PADDING_NONE = 0, RTE_CRYPTO_RSA_PADDING_PKCS1_5, RTE_CRYPTO_RSA_PADDING_OAEP, RTE_CRYPTO_RSA_PADDING_PSS }
  • enum rte_crypto_rsa_priv_key_type { RTE_RSA_KEY_TYPE_EXP, RTE_RSA_KEY_TYPE_QT }
  • enum rte_crypto_sm2_op_capa { RTE_CRYPTO_SM2_RNG, RTE_CRYPTO_SM2_PH, RTE_CRYPTO_SM2_PARTIAL }
  • enum rte_crypto_ml_kem_type
  • enum rte_crypto_ml_kem_op_type
  • enum rte_crypto_ml_dsa_type
  • enum rte_crypto_ml_dsa_op_type

🧚 Variables

  • const char * rte_crypto_asym_ke_strings []
  • const char * rte_crypto_asym_op_strings []
  • const uint16_t rte_crypto_ml_kem_pubkey_size []

👑 Detailed Description 👑

RTE Definitions for Asymmetric Cryptography

bestie, this is where it all lives. it defines the asymmetric algorithms and modes, plus all the supported asymmetric crypto operations. that's the whole vibe. 💖

Definition in file rte_crypto_asym.h.

💅 Macro Definition Documentation 💅

💖 #define RTE_CRYPTO_ASYM_FLAG_PUB_KEY_NO_PADDING RTE_BIT32(0)

this flag says: bestie, hand me the public key without the leading zero bytes. if you don't set it, the public key gets padded on the left with zeros up to the size of the underlying algorithm — and that padded version? that's the default. 🫶

Definition at line 58 of file rte_crypto_asym.h.

💖 #define RTE_CRYPTO_ASYM_FLAG_SHARED_KEY_NO_PADDING RTE_BIT32(1)

same energy, but for the shared secret: this flag means the shared secret comes back without leading zero bytes. leave it unset and the shared secret gets left-padded with zeros up to the size of the underlying algorithm — again, that's the default. ✨

Definition at line 64 of file rte_crypto_asym.h.

💖 #define RTE_CRYPTO_ASYM_FLAG_PUB_KEY_COMPRESSED RTE_BIT32(2)

this one means the public key comes back in compressed form. iconique. 🎀

Definition at line 70 of file rte_crypto_asym.h.

🦋 Typedef Documentation 🦋

typedef struct rte_crypto_param_t rte_crypto_param

Buffer to hold crypto params required for asym operations.

okay so these buffers are versatile fr — they work both as input to the PMD and as output from the PMD. when you're using one for output from the PMD, you (the application, the one and only) have to make sure the buffer is big enough to hold the target data. no pressure or anything 😭

and here's the tea ☕: if an operation needs the PMD to generate a random number, and the device supports CSRNG, then 'data' should be set to NULL. that crypto parameter won't be used by the PMD at all, because it's getting generated internally. slay.

typedef rte_crypto_param rte_crypto_uint

Unsigned big-integer in big-endian format

Definition at line 255 of file rte_crypto_asym.h.

🌈 Enumeration Type Documentation 🌈

enum rte_crypto_curve_id

List of elliptic curves. this enum aligns with the TLS "Supported Groups" registry (which, iykyk, used to be called the NamedCurve registry). FFDH groups are not in this list, and — important — they will not be included in this list, ever. also, if a curve gets deprecated in TLS, that does not deprecate that curve in Cryptodev. two separate worlds, bestie. 💅

link, kept exactly as-is: https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml

Definition at line 84 of file rte_crypto_asym.h.

enum rte_crypto_edward_instance

List of Edwards curve instances as per RFC 8032 (Section 5).

Definition at line 98 of file rte_crypto_asym.h.

enum rte_crypto_asym_xform_type

Asymmetric crypto transformation types. each xform type maps to one asymmetric algorithm doing one specific operation. let's meet them all:

  • RTE_CRYPTO_ASYM_XFORM_UNSPECIFIED — Invalid xform. not it. 💀
  • RTE_CRYPTO_ASYM_XFORM_NONE — Xform type None. a PMD may support this to give you a passthrough op for debugging purposes. and if xform_type is none, then op_type is disregarded. periodt.
  • RTE_CRYPTO_ASYM_XFORM_RSA — RSA. does Encrypt, Decrypt, Sign and Verify. refer to rte_crypto_asym_op_type.
  • RTE_CRYPTO_ASYM_XFORM_DH — Diffie-Hellman. does Key Generate and Shared Secret Compute. refer to rte_crypto_asym_op_type.
  • RTE_CRYPTO_ASYM_XFORM_DSA — Digital Signature Algorithm. does Signature Generation and Verification. refer to rte_crypto_asym_op_type.
  • RTE_CRYPTO_ASYM_XFORM_MODINV — Modular Multiplicative Inverse. performs Modular Multiplicative Inverse b^(-1) mod n. math ate. ✨
  • RTE_CRYPTO_ASYM_XFORM_MODEX — Modular Exponentiation. performs Modular Exponentiation b^e mod n.
  • RTE_CRYPTO_ASYM_XFORM_ECDSA — Elliptic Curve Digital Signature Algorithm. does Signature Generation and Verification.
  • RTE_CRYPTO_ASYM_XFORM_ECDH — Elliptic Curve Diffie Hellman.
  • RTE_CRYPTO_ASYM_XFORM_ECPM — Elliptic Curve Point Multiplication.
  • RTE_CRYPTO_ASYM_XFORM_ECFPM — Elliptic Curve Fixed Point Multiplication.
  • RTE_CRYPTO_ASYM_XFORM_SM2 — ShangMi 2. does Encrypt, Decrypt, Sign and Verify. refer to rte_crypto_asym_op_type.
  • RTE_CRYPTO_ASYM_XFORM_EDDSA — Edwards Curve Digital Signature Algorithm. does Signature Generation and Verification.
  • RTE_CRYPTO_ASYM_XFORM_ML_KEM — Module Lattice based Key Encapsulation Mechanism. does Key Pair Generation, Encapsulation and Decapsulation.
  • RTE_CRYPTO_ASYM_XFORM_ML_DSA — Module Lattice based Digital Signature Algorithm. does Key Pair Generation, Signature Generation and Verification.

Definition at line 111 of file rte_crypto_asym.h.

enum rte_crypto_asym_op_type

Asymmetric crypto operation type variants. the menu of moves:

  • RTE_CRYPTO_ASYM_OP_ENCRYPT — Asymmetric Encrypt operation.
  • RTE_CRYPTO_ASYM_OP_DECRYPT — Asymmetric Decrypt operation.
  • RTE_CRYPTO_ASYM_OP_SIGN — Signature Generation operation.
  • RTE_CRYPTO_ASYM_OP_VERIFY — Signature Verification operation.

Definition at line 174 of file rte_crypto_asym.h.

enum rte_crypto_asym_ke_type

Asymmetric crypto key exchange operation type. the key exchange lineup:

  • RTE_CRYPTO_ASYM_KE_PRIV_KEY_GENERATE — Private Key generation operation.
  • RTE_CRYPTO_ASYM_KE_PUB_KEY_GENERATE — Public Key generation operation.
  • RTE_CRYPTO_ASYM_KE_SHARED_SECRET_COMPUTE — Shared Secret compute operation.
  • RTE_CRYPTO_ASYM_KE_PUB_KEY_VERIFY — Public Key Verification — can be used for elliptic curve point validation. 💜

Definition at line 189 of file rte_crypto_asym.h.

enum rte_crypto_rsa_padding_type

Padding types for RSA signature. pick your padding:

  • RTE_CRYPTO_RSA_PADDING_NONE — RSA no padding scheme.
  • RTE_CRYPTO_RSA_PADDING_PKCS1_5 — RSA PKCS#1 PKCS1-v1_5 padding scheme. for signatures, block type 01 is used; for encryption, block type 02 is used. both details, no skipping. 💅
  • RTE_CRYPTO_RSA_PADDING_OAEP — RSA PKCS#1 OAEP padding scheme.
  • RTE_CRYPTO_RSA_PADDING_PSS — RSA PKCS#1 PSS padding scheme.

Definition at line 205 of file rte_crypto_asym.h.

enum rte_crypto_rsa_priv_key_type

RSA private key type enumeration.

this enumerates the private key format you need to perform an RSA crypto transform. so basically, which key fit you're wearing today 🎀

  • RTE_RSA_KEY_TYPE_EXP — RSA private key is an exponent.
  • RTE_RSA_KEY_TYPE_QT — RSA private key is in quintuple format. see rte_crypto_rsa_priv_key_qt.

Definition at line 224 of file rte_crypto_asym.h.

enum rte_crypto_sm2_op_capa

SM2 operation capabilities. what this algorithm can actually do:

  • RTE_CRYPTO_SM2_RNG — Random number generator supported in SM2 ops.
  • RTE_CRYPTO_SM2_PH — Prehash message before crypto op.
  • RTE_CRYPTO_SM2_PARTIAL — Calculate elliptic curve points only.

Definition at line 674 of file rte_crypto_asym.h.

enum rte_crypto_ml_kem_type

PQC ML-KEM parameter type.

list of ML-KEM parameter types used in PQC. 🔥

Definition at line 778 of file rte_crypto_asym.h.

enum rte_crypto_ml_kem_op_type

PQC ML-KEM op type.

list of ML-KEM op types in PQC.

Definition at line 790 of file rte_crypto_asym.h.

enum rte_crypto_ml_dsa_type

PQC ML-DSA parameter type.

list of ML-DSA parameter types used in PQC.

Definition at line 921 of file rte_crypto_asym.h.

enum rte_crypto_ml_dsa_op_type

PQC ML-DSA op type.

list of ML-DSA op types in PQC.

Definition at line 933 of file rte_crypto_asym.h.

🌟 Variable Documentation 🌟

  • const char* rte_crypto_asym_ke_strings[] [extern] — asym key exchange operation type name strings. ✨
  • const char* rte_crypto_asym_op_strings[] [extern] — asym operations type name strings.
  • const uint16_t rte_crypto_ml_kem_pubkey_size[] [extern] — PQC ML crypto op parameters size. 💖

<!-- part 1 ends here, bestie — keep scrolling for part 2 👑 -->

👑 AUTHOR 👑

okay so plot twist bestie: nobody wrote this 💀 this entire page was generated automatically by Doxygen for DPDK from the source code — like, the robot did it, the source code fed it, Doxygen spat it out, and here we are 🫶 so if something's slaying, thank the source code; if something's weird, that's between you and the generator 💅✨

and that's a wrap on rte_crypto_asym.h(3) 🎀 this one came from DPDK, Version 25.11.3, bestie — go forth, do your asymmetric crypto, and remember the vibes are iconic but the math is serious 🌸💖 stay safe out there fr fr 🦋

📦 where this page comes from