1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2019 Intel Corporation
5 #ifndef _RTE_CRYPTO_SYM_H_
6 #define _RTE_CRYPTO_SYM_H_
9 * @file rte_crypto_sym.h
11 * RTE Definitions for Symmetric Cryptography
13 * Defines symmetric cipher and authentication algorithms and modes, as well
14 * as supported symmetric crypto operation combinations.
24 #include <rte_memory.h>
25 #include <rte_mempool.h>
26 #include <rte_common.h>
29 /** Symmetric Cipher Algorithms */
30 enum rte_crypto_cipher_algorithm {
31 RTE_CRYPTO_CIPHER_NULL = 1,
32 /**< NULL cipher algorithm. No mode applies to the NULL algorithm. */
34 RTE_CRYPTO_CIPHER_3DES_CBC,
35 /**< Triple DES algorithm in CBC mode */
36 RTE_CRYPTO_CIPHER_3DES_CTR,
37 /**< Triple DES algorithm in CTR mode */
38 RTE_CRYPTO_CIPHER_3DES_ECB,
39 /**< Triple DES algorithm in ECB mode */
41 RTE_CRYPTO_CIPHER_AES_CBC,
42 /**< AES algorithm in CBC mode */
43 RTE_CRYPTO_CIPHER_AES_CTR,
44 /**< AES algorithm in Counter mode */
45 RTE_CRYPTO_CIPHER_AES_ECB,
46 /**< AES algorithm in ECB mode */
47 RTE_CRYPTO_CIPHER_AES_F8,
48 /**< AES algorithm in F8 mode */
49 RTE_CRYPTO_CIPHER_AES_XTS,
50 /**< AES algorithm in XTS mode */
52 RTE_CRYPTO_CIPHER_ARC4,
53 /**< (A)RC4 cipher algorithm */
55 RTE_CRYPTO_CIPHER_KASUMI_F8,
56 /**< KASUMI algorithm in F8 mode */
58 RTE_CRYPTO_CIPHER_SNOW3G_UEA2,
59 /**< SNOW 3G algorithm in UEA2 mode */
61 RTE_CRYPTO_CIPHER_ZUC_EEA3,
62 /**< ZUC algorithm in EEA3 mode */
64 RTE_CRYPTO_CIPHER_DES_CBC,
65 /**< DES algorithm in CBC mode */
67 RTE_CRYPTO_CIPHER_AES_DOCSISBPI,
68 /**< AES algorithm using modes required by
69 * DOCSIS Baseline Privacy Plus Spec.
70 * Chained mbufs are not supported in this mode, i.e. rte_mbuf.next
71 * for m_src and m_dst in the rte_crypto_sym_op must be NULL.
74 RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
75 /**< DES algorithm using modes required by
76 * DOCSIS Baseline Privacy Plus Spec.
77 * Chained mbufs are not supported in this mode, i.e. rte_mbuf.next
78 * for m_src and m_dst in the rte_crypto_sym_op must be NULL.
81 RTE_CRYPTO_CIPHER_LIST_END
85 /** Cipher algorithm name strings */
87 rte_crypto_cipher_algorithm_strings[];
89 /** Symmetric Cipher Direction */
90 enum rte_crypto_cipher_operation {
91 RTE_CRYPTO_CIPHER_OP_ENCRYPT,
92 /**< Encrypt cipher operation */
93 RTE_CRYPTO_CIPHER_OP_DECRYPT
94 /**< Decrypt cipher operation */
97 /** Cipher operation name strings */
99 rte_crypto_cipher_operation_strings[];
102 * Symmetric Cipher Setup Data.
104 * This structure contains data relating to Cipher (Encryption and Decryption)
105 * use to create a session.
107 struct rte_crypto_cipher_xform {
108 enum rte_crypto_cipher_operation op;
109 /**< This parameter determines if the cipher operation is an encrypt or
110 * a decrypt operation. For the RC4 algorithm and the F8/CTR modes,
111 * only encrypt operations are valid.
113 enum rte_crypto_cipher_algorithm algo;
114 /**< Cipher algorithm */
117 uint8_t *data; /**< pointer to key data */
118 uint16_t length;/**< key length in bytes */
122 * For the RTE_CRYPTO_CIPHER_AES_F8 mode of operation, key.data will
123 * point to a concatenation of the AES encryption key followed by a
124 * keymask. As per RFC3711, the keymask should be padded with trailing
125 * bytes to match the length of the encryption key used.
127 * Cipher key length is in bytes. For AES it can be 128 bits (16 bytes),
128 * 192 bits (24 bytes) or 256 bits (32 bytes).
130 * For the RTE_CRYPTO_CIPHER_AES_F8 mode of operation, key.length
131 * should be set to the combined length of the encryption key and the
132 * keymask. Since the keymask and the encryption key are the same size,
133 * key.length should be set to 2 x the AES encryption key length.
135 * For the AES-XTS mode of operation:
136 * - Two keys must be provided and key.length refers to total length of
138 * - key.data must point to the two keys concatenated together
140 * - Each key can be either 128 bits (16 bytes) or 256 bits (32 bytes).
141 * - Both keys must have the same size.
145 /**< Starting point for Initialisation Vector or Counter,
146 * specified as number of bytes from start of crypto
147 * operation (rte_crypto_op).
149 * - For block ciphers in CBC or F8 mode, or for KASUMI
150 * in F8 mode, or for SNOW 3G in UEA2 mode, this is the
151 * Initialisation Vector (IV) value.
153 * - For block ciphers in CTR mode, this is the counter.
155 * - For GCM mode, this is either the IV (if the length
156 * is 96 bits) or J0 (for other sizes), where J0 is as
157 * defined by NIST SP800-38D. Regardless of the IV
158 * length, a full 16 bytes needs to be allocated.
160 * - For CCM mode, the first byte is reserved, and the
161 * nonce should be written starting at &iv[1] (to allow
162 * space for the implementation to write in the flags
163 * in the first byte). Note that a full 16 bytes should
164 * be allocated, even though the length field will
165 * have a value less than this. Note that the PMDs may
166 * modify the memory reserved (the first byte and the
169 * - For AES-XTS, this is the 128bit tweak, i, from
170 * IEEE Std 1619-2007.
172 * For optimum performance, the data pointed to SHOULD
176 /**< Length of valid IV data.
178 * - For block ciphers in CBC or F8 mode, or for KASUMI
179 * in F8 mode, or for SNOW 3G in UEA2 mode, this is the
180 * length of the IV (which must be the same as the
181 * block length of the cipher).
183 * - For block ciphers in CTR mode, this is the length
184 * of the counter (which must be the same as the block
185 * length of the cipher).
187 * - For GCM mode, this is either 12 (for 96-bit IVs)
188 * or 16, in which case data points to J0.
190 * - For CCM mode, this is the length of the nonce,
191 * which can be in the range 7 to 13 inclusive.
193 } iv; /**< Initialisation vector parameters */
196 /** Symmetric Authentication / Hash Algorithms */
197 enum rte_crypto_auth_algorithm {
198 RTE_CRYPTO_AUTH_NULL = 1,
199 /**< NULL hash algorithm. */
201 RTE_CRYPTO_AUTH_AES_CBC_MAC,
202 /**< AES-CBC-MAC algorithm. Only 128-bit keys are supported. */
203 RTE_CRYPTO_AUTH_AES_CMAC,
204 /**< AES CMAC algorithm. */
205 RTE_CRYPTO_AUTH_AES_GMAC,
206 /**< AES GMAC algorithm. */
207 RTE_CRYPTO_AUTH_AES_XCBC_MAC,
208 /**< AES XCBC algorithm. */
210 RTE_CRYPTO_AUTH_KASUMI_F9,
211 /**< KASUMI algorithm in F9 mode. */
214 /**< MD5 algorithm */
215 RTE_CRYPTO_AUTH_MD5_HMAC,
216 /**< HMAC using MD5 algorithm */
218 RTE_CRYPTO_AUTH_SHA1,
219 /**< 128 bit SHA algorithm. */
220 RTE_CRYPTO_AUTH_SHA1_HMAC,
221 /**< HMAC using 128 bit SHA algorithm. */
222 RTE_CRYPTO_AUTH_SHA224,
223 /**< 224 bit SHA algorithm. */
224 RTE_CRYPTO_AUTH_SHA224_HMAC,
225 /**< HMAC using 224 bit SHA algorithm. */
226 RTE_CRYPTO_AUTH_SHA256,
227 /**< 256 bit SHA algorithm. */
228 RTE_CRYPTO_AUTH_SHA256_HMAC,
229 /**< HMAC using 256 bit SHA algorithm. */
230 RTE_CRYPTO_AUTH_SHA384,
231 /**< 384 bit SHA algorithm. */
232 RTE_CRYPTO_AUTH_SHA384_HMAC,
233 /**< HMAC using 384 bit SHA algorithm. */
234 RTE_CRYPTO_AUTH_SHA512,
235 /**< 512 bit SHA algorithm. */
236 RTE_CRYPTO_AUTH_SHA512_HMAC,
237 /**< HMAC using 512 bit SHA algorithm. */
239 RTE_CRYPTO_AUTH_SNOW3G_UIA2,
240 /**< SNOW 3G algorithm in UIA2 mode. */
242 RTE_CRYPTO_AUTH_ZUC_EIA3,
243 /**< ZUC algorithm in EIA3 mode */
245 RTE_CRYPTO_AUTH_SHA3_224,
246 /**< 224 bit SHA3 algorithm. */
247 RTE_CRYPTO_AUTH_SHA3_224_HMAC,
248 /**< HMAC using 224 bit SHA3 algorithm. */
249 RTE_CRYPTO_AUTH_SHA3_256,
250 /**< 256 bit SHA3 algorithm. */
251 RTE_CRYPTO_AUTH_SHA3_256_HMAC,
252 /**< HMAC using 256 bit SHA3 algorithm. */
253 RTE_CRYPTO_AUTH_SHA3_384,
254 /**< 384 bit SHA3 algorithm. */
255 RTE_CRYPTO_AUTH_SHA3_384_HMAC,
256 /**< HMAC using 384 bit SHA3 algorithm. */
257 RTE_CRYPTO_AUTH_SHA3_512,
258 /**< 512 bit SHA3 algorithm. */
259 RTE_CRYPTO_AUTH_SHA3_512_HMAC,
260 /**< HMAC using 512 bit SHA3 algorithm. */
262 RTE_CRYPTO_AUTH_LIST_END
265 /** Authentication algorithm name strings */
267 rte_crypto_auth_algorithm_strings[];
269 /** Symmetric Authentication / Hash Operations */
270 enum rte_crypto_auth_operation {
271 RTE_CRYPTO_AUTH_OP_VERIFY, /**< Verify authentication digest */
272 RTE_CRYPTO_AUTH_OP_GENERATE /**< Generate authentication digest */
275 /** Authentication operation name strings */
277 rte_crypto_auth_operation_strings[];
280 * Authentication / Hash transform data.
282 * This structure contains data relating to an authentication/hash crypto
283 * transforms. The fields op, algo and digest_length are common to all
284 * authentication transforms and MUST be set.
286 struct rte_crypto_auth_xform {
287 enum rte_crypto_auth_operation op;
288 /**< Authentication operation type */
289 enum rte_crypto_auth_algorithm algo;
290 /**< Authentication algorithm selection */
293 uint8_t *data; /**< pointer to key data */
294 uint16_t length;/**< key length in bytes */
296 /**< Authentication key data.
297 * The authentication key length MUST be less than or equal to the
298 * block size of the algorithm. It is the callers responsibility to
299 * ensure that the key length is compliant with the standard being used
300 * (for example RFC 2104, FIPS 198a).
305 /**< Starting point for Initialisation Vector or Counter,
306 * specified as number of bytes from start of crypto
307 * operation (rte_crypto_op).
309 * - For SNOW 3G in UIA2 mode, for ZUC in EIA3 mode and
310 * for AES-GMAC, this is the authentication
311 * Initialisation Vector (IV) value.
313 * - For KASUMI in F9 mode and other authentication
314 * algorithms, this field is not used.
316 * For optimum performance, the data pointed to SHOULD
320 /**< Length of valid IV data.
322 * - For SNOW3G in UIA2 mode, for ZUC in EIA3 mode and
323 * for AES-GMAC, this is the length of the IV.
325 * - For KASUMI in F9 mode and other authentication
326 * algorithms, this field is not used.
329 } iv; /**< Initialisation vector parameters */
331 uint16_t digest_length;
332 /**< Length of the digest to be returned. If the verify option is set,
333 * this specifies the length of the digest to be compared for the
336 * It is the caller's responsibility to ensure that the
337 * digest length is compliant with the hash algorithm being used.
338 * If the value is less than the maximum length allowed by the hash,
339 * the result shall be truncated.
344 /** Symmetric AEAD Algorithms */
345 enum rte_crypto_aead_algorithm {
346 RTE_CRYPTO_AEAD_AES_CCM = 1,
347 /**< AES algorithm in CCM mode. */
348 RTE_CRYPTO_AEAD_AES_GCM,
349 /**< AES algorithm in GCM mode. */
350 RTE_CRYPTO_AEAD_LIST_END
353 /** AEAD algorithm name strings */
355 rte_crypto_aead_algorithm_strings[];
357 /** Symmetric AEAD Operations */
358 enum rte_crypto_aead_operation {
359 RTE_CRYPTO_AEAD_OP_ENCRYPT,
360 /**< Encrypt and generate digest */
361 RTE_CRYPTO_AEAD_OP_DECRYPT
362 /**< Verify digest and decrypt */
365 /** Authentication operation name strings */
367 rte_crypto_aead_operation_strings[];
369 struct rte_crypto_aead_xform {
370 enum rte_crypto_aead_operation op;
371 /**< AEAD operation type */
372 enum rte_crypto_aead_algorithm algo;
373 /**< AEAD algorithm selection */
376 uint8_t *data; /**< pointer to key data */
377 uint16_t length;/**< key length in bytes */
382 /**< Starting point for Initialisation Vector or Counter,
383 * specified as number of bytes from start of crypto
384 * operation (rte_crypto_op).
386 * - For GCM mode, this is either the IV (if the length
387 * is 96 bits) or J0 (for other sizes), where J0 is as
388 * defined by NIST SP800-38D. Regardless of the IV
389 * length, a full 16 bytes needs to be allocated.
391 * - For CCM mode, the first byte is reserved, and the
392 * nonce should be written starting at &iv[1] (to allow
393 * space for the implementation to write in the flags
394 * in the first byte). Note that a full 16 bytes should
395 * be allocated, even though the length field will
396 * have a value less than this.
398 * For optimum performance, the data pointed to SHOULD
402 /**< Length of valid IV data.
404 * - For GCM mode, this is either 12 (for 96-bit IVs)
405 * or 16, in which case data points to J0.
407 * - For CCM mode, this is the length of the nonce,
408 * which can be in the range 7 to 13 inclusive.
410 } iv; /**< Initialisation vector parameters */
412 uint16_t digest_length;
415 /**< The length of the additional authenticated data (AAD) in bytes.
416 * For CCM mode, this is the length of the actual AAD, even though
417 * it is required to reserve 18 bytes before the AAD and padding
418 * at the end of it, so a multiple of 16 bytes is allocated.
422 /** Crypto transformation types */
423 enum rte_crypto_sym_xform_type {
424 RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED = 0, /**< No xform specified */
425 RTE_CRYPTO_SYM_XFORM_AUTH, /**< Authentication xform */
426 RTE_CRYPTO_SYM_XFORM_CIPHER, /**< Cipher xform */
427 RTE_CRYPTO_SYM_XFORM_AEAD /**< AEAD xform */
431 * Symmetric crypto transform structure.
433 * This is used to specify the crypto transforms required, multiple transforms
434 * can be chained together to specify a chain transforms such as authentication
435 * then cipher, or cipher then authentication. Each transform structure can
436 * hold a single transform, the type field is used to specify which transform
437 * is contained within the union
439 struct rte_crypto_sym_xform {
440 struct rte_crypto_sym_xform *next;
441 /**< next xform in chain */
442 enum rte_crypto_sym_xform_type type
446 struct rte_crypto_auth_xform auth;
447 /**< Authentication / hash xform */
448 struct rte_crypto_cipher_xform cipher;
450 struct rte_crypto_aead_xform aead;
455 struct rte_cryptodev_sym_session;
458 * Symmetric Cryptographic Operation.
460 * This structure contains data relating to performing symmetric cryptographic
461 * processing on a referenced mbuf data buffer.
463 * When a symmetric crypto operation is enqueued with the device for processing
464 * it must have a valid *rte_mbuf* structure attached, via m_src parameter,
465 * which contains the source data which the crypto operation is to be performed
467 * While the mbuf is in use by a crypto operation no part of the mbuf should be
468 * changed by the application as the device may read or write to any part of the
469 * mbuf. In the case of hardware crypto devices some or all of the mbuf
470 * may be DMAed in and out of the device, so writing over the original data,
471 * though only the part specified by the rte_crypto_sym_op for transformation
473 * Out-of-place (OOP) operation, where the source mbuf is different to the
474 * destination mbuf, is a special case. Data will be copied from m_src to m_dst.
475 * The part copied includes all the parts of the source mbuf that will be
476 * operated on, based on the cipher.data.offset+cipher.data.length and
477 * auth.data.offset+auth.data.length values in the rte_crypto_sym_op. The part
478 * indicated by the cipher parameters will be transformed, any extra data around
479 * this indicated by the auth parameters will be copied unchanged from source to
481 * Also in OOP operation the cipher.data.offset and auth.data.offset apply to
482 * both source and destination mbufs. As these offsets are relative to the
483 * data_off parameter in each mbuf this can result in the data written to the
484 * destination buffer being at a different alignment, relative to buffer start,
485 * to the data in the source buffer.
487 struct rte_crypto_sym_op {
488 struct rte_mbuf *m_src; /**< source mbuf */
489 struct rte_mbuf *m_dst; /**< destination mbuf */
493 struct rte_cryptodev_sym_session *session;
494 /**< Handle for the initialised session context */
495 struct rte_crypto_sym_xform *xform;
496 /**< Session-less API crypto operation parameters */
497 struct rte_security_session *sec_session;
498 /**< Handle for the initialised security session context */
506 /**< Starting point for AEAD processing, specified as
507 * number of bytes from start of packet in source
511 /**< The message length, in bytes, of the source buffer
512 * on which the cryptographic operation will be
513 * computed. This must be a multiple of the block size
515 } data; /**< Data offsets and length for AEAD */
518 /**< This points to the location where the digest result
519 * should be inserted (in the case of digest generation)
520 * or where the purported digest exists (in the case of
521 * digest verification).
523 * At session creation time, the client specified the
524 * digest result length with the digest_length member
525 * of the @ref rte_crypto_auth_xform structure. For
526 * physical crypto devices the caller must allocate at
527 * least digest_length of physically contiguous memory
530 * For digest generation, the digest result will
531 * overwrite any data at this location.
534 * For GCM (@ref RTE_CRYPTO_AEAD_AES_GCM), for
535 * "digest result" read "authentication tag T".
537 rte_iova_t phys_addr;
538 /**< Physical address of digest */
539 } digest; /**< Digest parameters */
542 /**< Pointer to Additional Authenticated Data (AAD)
543 * needed for authenticated cipher mechanisms (CCM and
546 * Specifically for CCM (@ref RTE_CRYPTO_AEAD_AES_CCM),
547 * the caller should setup this field as follows:
549 * - the additional authentication data itself should
550 * be written starting at an offset of 18 bytes into
551 * the array, leaving room for the first block (16 bytes)
552 * and the length encoding in the first two bytes of the
555 * - the array should be big enough to hold the above
556 * fields, plus any padding to round this up to the
557 * nearest multiple of the block size (16 bytes).
558 * Padding will be added by the implementation.
560 * - Note that PMDs may modify the memory reserved
561 * (first 18 bytes and the final padding).
563 * Finally, for GCM (@ref RTE_CRYPTO_AEAD_AES_GCM), the
564 * caller should setup this field as follows:
566 * - the AAD is written in starting at byte 0
567 * - the array must be big enough to hold the AAD, plus
568 * any space to round this up to the nearest multiple
569 * of the block size (16 bytes).
572 rte_iova_t phys_addr; /**< physical address */
574 /**< Additional authentication parameters */
581 /**< Starting point for cipher processing,
582 * specified as number of bytes from start
583 * of data in the source buffer.
584 * The result of the cipher operation will be
585 * written back into the output buffer
586 * starting at this location.
589 * For SNOW 3G @ RTE_CRYPTO_CIPHER_SNOW3G_UEA2,
590 * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
591 * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
592 * this field should be in bits.
595 /**< The message length, in bytes, of the
596 * source buffer on which the cryptographic
597 * operation will be computed.
598 * This must be a multiple of the block size
599 * if a block cipher is being used. This is
600 * also the same as the result length.
603 * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UEA2,
604 * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
605 * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
606 * this field should be in bits.
608 } data; /**< Data offsets and length for ciphering */
614 /**< Starting point for hash processing,
615 * specified as number of bytes from start of
616 * packet in source buffer.
619 * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
620 * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
621 * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
622 * this field should be in bits.
625 * For KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
626 * this offset should be such that
627 * data to authenticate starts at COUNT.
630 /**< The message length, in bytes, of the source
631 * buffer that the hash will be computed on.
634 * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
635 * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
636 * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
637 * this field should be in bits.
640 * For KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
641 * the length should include the COUNT,
642 * FRESH, message, direction bit and padding
643 * (to be multiple of 8 bits).
646 /**< Data offsets and length for authentication */
650 /**< This points to the location where
651 * the digest result should be inserted
652 * (in the case of digest generation)
653 * or where the purported digest exists
654 * (in the case of digest verification).
656 * At session creation time, the client
657 * specified the digest result length with
658 * the digest_length member of the
659 * @ref rte_crypto_auth_xform structure.
660 * For physical crypto devices the caller
661 * must allocate at least digest_length of
662 * physically contiguous memory at this
665 * For digest generation, the digest result
666 * will overwrite any data at this location.
669 rte_iova_t phys_addr;
670 /**< Physical address of digest */
671 } digest; /**< Digest parameters */
679 * Reset the fields of a symmetric operation to their default values.
681 * @param op The crypto operation to be reset.
684 __rte_crypto_sym_op_reset(struct rte_crypto_sym_op *op)
686 memset(op, 0, sizeof(*op));
691 * Allocate space for symmetric crypto xforms in the private data space of the
692 * crypto operation. This also defaults the crypto xform type to
693 * RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED and configures the chaining of the xforms
694 * in the crypto operation
697 * - On success returns pointer to first crypto xform in crypto operations chain
698 * - On failure returns NULL
700 static inline struct rte_crypto_sym_xform *
701 __rte_crypto_sym_op_sym_xforms_alloc(struct rte_crypto_sym_op *sym_op,
702 void *priv_data, uint8_t nb_xforms)
704 struct rte_crypto_sym_xform *xform;
706 sym_op->xform = xform = (struct rte_crypto_sym_xform *)priv_data;
709 xform->type = RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED;
710 xform = xform->next = --nb_xforms > 0 ? xform + 1 : NULL;
713 return sym_op->xform;
718 * Attach a session to a symmetric crypto operation
720 * @param sym_op crypto operation
721 * @param sess cryptodev session
724 __rte_crypto_sym_op_attach_sym_session(struct rte_crypto_sym_op *sym_op,
725 struct rte_cryptodev_sym_session *sess)
727 sym_op->session = sess;
737 #endif /* _RTE_CRYPTO_SYM_H_ */