--- name: "rte_crypto_sym_op" 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_crypto_sym_op" --- # rte\_crypto\_sym\_op(3) ## NAME rte\_crypto\_sym\_op ## SYNOPSIS `#include ` ### Data Fields struct **rte\_mbuf** \* **m\_src**\ struct **rte\_mbuf** \* **m\_dst**\ ## Detailed Description Symmetric Cryptographic Operation. This structure contains data relating to performing symmetric cryptographic processing on a referenced mbuf data buffer. When a symmetric crypto operation is enqueued with the device for processing it must have a valid **rte\_mbuf structure attached, via m\_src parameter, which contains the source data which the crypto operation is to be performed on. While the mbuf is in use by a crypto operation no part of the mbuf should be changed by the application as the device may read or write to any part of the mbuf. In the case of hardware crypto devices some or all of the mbuf may be DMAed in and out of the device, so writing over the original data, though only the part specified by the rte\_crypto\_sym\_op for transformation will be changed. Out-of-place (OOP) operation, where the source mbuf is different to the destination mbuf, is a special case. Data will be copied from m\_src to m\_dst. The part copied includes all the parts of the source mbuf that will be operated on, based on the cipher.data.offset+cipher.data.length and auth.data.offset+auth.data.length values in the rte\_crypto\_sym\_op. The part indicated by the cipher parameters will be transformed, any extra data around this indicated by the auth parameters will be copied unchanged from source to destination mbuf. Also in OOP operation the cipher.data.offset and auth.data.offset apply to both source and destination mbufs. As these offsets are relative to the data\_off parameter in each mbuf this can result in the data written to the destination buffer being at a different alignment, relative to buffer start, to the data in the source buffer.** **Definition at line 626 of file rte\_crypto\_sym.h.** ## Field Documentation ### struct rte\_mbuf\* m\_src **source mbuf** **Definition at line 627 of file rte\_crypto\_sym.h.** ### struct rte\_mbuf\* m\_dst **destination mbuf** **Definition at line 628 of file rte\_crypto\_sym.h.** ### void\* session **Handle for the initialised crypto/security session context** **Definition at line 631 of file rte\_crypto\_sym.h.** ### struct rte\_crypto\_sym\_xform\* xform **Session-less API crypto operation parameters** **Definition at line 633 of file rte\_crypto\_sym.h.** ### uint32\_t offset **Starting point for AEAD processing, specified as number of bytes from start of packet in source buffer.** **Starting point for cipher processing, specified as number of bytes from start of data in the source buffer. The result of the cipher operation will be written back into the output buffer starting at this location.** **Note** **For SNOW 3G @ RTE\_CRYPTO\_CIPHER\_SNOW3G\_UEA2, KASUMI @ RTE\_CRYPTO\_CIPHER\_KASUMI\_F8 and ZUC @ RTE\_CRYPTO\_CIPHER\_ZUC\_EEA3, this field should be in bits. For digest-encrypted cases this must be an 8-bit multiple.** **Starting point for hash processing, specified as number of bytes from start of packet in source buffer.** **Note** **For SNOW 3G @ RTE\_CRYPTO\_AUTH\_SNOW3G\_UIA2, KASUMI @ RTE\_CRYPTO\_AUTH\_KASUMI\_F9 and ZUC @ RTE\_CRYPTO\_AUTH\_ZUC\_EIA3, this field should be in bits. For digest-encrypted cases this must be an 8-bit multiple.** **For KASUMI @ RTE\_CRYPTO\_AUTH\_KASUMI\_F9, this offset should be such that data to authenticate starts at COUNT.** **For DOCSIS security protocol, this offset is the DOCSIS header length and, therefore, also the CRC offset i.e. the number of bytes into the packet at which CRC calculation should begin.** **Definition at line 640 of file rte\_crypto\_sym.h.** ### uint32\_t length **The message length, in bytes, of the source buffer on which the cryptographic operation will be computed.** **The message length, in bytes, of the source buffer on which the cryptographic operation will be computed. This is also the same as the result length. For block ciphers, this must be a multiple of the block size, or for the AES-XTS a multiple of the data-unit length as described in xform.** **Note** **For SNOW 3G @ RTE\_CRYPTO\_AUTH\_SNOW3G\_UEA2, KASUMI @ RTE\_CRYPTO\_CIPHER\_KASUMI\_F8 and ZUC @ RTE\_CRYPTO\_CIPHER\_ZUC\_EEA3, this field should be in bits. For digest-encrypted cases this must be an 8-bit multiple.** **The message length, in bytes, of the source buffer that the hash will be computed on.** **Note** **For SNOW 3G @ RTE\_CRYPTO\_AUTH\_SNOW3G\_UIA2, KASUMI @ RTE\_CRYPTO\_AUTH\_KASUMI\_F9 and ZUC @ RTE\_CRYPTO\_AUTH\_ZUC\_EIA3, this field should be in bits. For digest-encrypted cases this must be an 8-bit multiple.** **For KASUMI @ RTE\_CRYPTO\_AUTH\_KASUMI\_F9, the length should include the COUNT, FRESH, message, direction bit and padding (to be multiple of 8 bits).** **For DOCSIS security protocol, this is the CRC length i.e. the number of bytes in the packet over which the CRC should be calculated** **Definition at line 645 of file rte\_crypto\_sym.h.** ### struct { ... } data **Data offsets and length for AEAD** ### uint8\_t\* data **This points to the location where the digest result should be inserted (in the case of digest generation) or where the purported digest exists (in the case of digest verification).** **At session creation time, the client specified the digest result length with the digest\_length member of the rte\_crypto\_auth\_xform structure. For physical crypto devices the caller must allocate at least digest\_length of physically contiguous memory at this location.** **For digest generation, the digest result will overwrite any data at this location.** **Note** **For GCM (RTE\_CRYPTO\_AEAD\_AES\_GCM), for 'digest result' read 'authentication tag T'.** **Pointer to Additional Authenticated Data (AAD) needed for authenticated cipher mechanisms (CCM and GCM)** **Specifically for CCM (RTE\_CRYPTO\_AEAD\_AES\_CCM), the caller should setup this field as follows:** - • **the additional authentication data itself should be written starting at an offset of 18 bytes into the array, leaving room for the first block (16 bytes) and the length encoding in the first two bytes of the second block.** - • **Note that PMDs may modify the memory reserved (first 18 bytes and the final padding).** **Finally, for GCM (RTE\_CRYPTO\_AEAD\_AES\_GCM), the caller should setup this field as follows:** **This points to the location where the digest result should be inserted (in the case of digest generation) or where the purported digest exists (in the case of digest verification).** **At session creation time, the client specified the digest result length with the digest\_length member of the rte\_crypto\_auth\_xform structure. For physical crypto devices the caller must allocate at least digest\_length of physically contiguous memory at this location.** **For digest generation, the digest result will overwrite any data at this location.** **Note** **Digest-encrypted case. Digest can be generated, appended to the end of raw data and encrypted together using chained digest generation (RTE\_CRYPTO\_AUTH\_OP\_GENERATE) and encryption (RTE\_CRYPTO\_CIPHER\_OP\_ENCRYPT) xforms. Similarly, authentication of the raw data against appended, decrypted digest, can be performed using decryption (RTE\_CRYPTO\_CIPHER\_OP\_DECRYPT) and digest verification (RTE\_CRYPTO\_AUTH\_OP\_VERIFY) chained xforms. To perform those operations, a few additional conditions must be met:** - • **caller must allocate at least digest\_length of memory at the end of source and (in case of out-of-place operations) destination buffer; those buffers can be linear or split using scatter-gather lists,** - • **digest data pointer must point to the end of source or (in case of out-of-place operations) destination data, which is pointer to the data buffer + auth.data.offset + auth.data.length,** - • **cipher.data.offset + cipher.data.length must be greater than auth.data.offset + auth.data.length and is typically equal to auth.data.offset + auth.data.length + digest\_length.** - • **for wireless algorithms, i.e. SNOW 3G, KASUMI and ZUC, as the cipher.data.length, cipher.data.offset, auth.data.length and auth.data.offset are in bits, they must be 8-bit multiples.** **Note, that for security reasons, it is PMDs' responsibility to not leave an unencrypted digest in any buffer after performing auth-cipher operations.** **Definition at line 652 of file rte\_crypto\_sym.h.** ### rte\_iova\_t phys\_addr **Physical address of digest** **physical address** **Definition at line 672 of file rte\_crypto\_sym.h.** ### struct { ... } digest **Digest parameters** ### struct { ... } aad **Additional authentication parameters** ### struct { ... } data **Data offsets and length for ciphering** ### struct { ... } data **Data offsets and length for authentication** ### struct { ... } digest **Digest parameters** ## Author **Generated automatically by Doxygen for DPDK from the source code.**