1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2017 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 * For AES-XTS mode of operation, two keys must be provided and
128 * key.data must point to the two keys concatenated together (Key1 ||
129 * Key2). The cipher key length will contain the total size of both
132 * Cipher key length is in bytes. For AES it can be 128 bits (16 bytes),
133 * 192 bits (24 bytes) or 256 bits (32 bytes).
135 * For the RTE_CRYPTO_CIPHER_AES_F8 mode of operation, key.length
136 * should be set to the combined length of the encryption key and the
137 * keymask. Since the keymask and the encryption key are the same size,
138 * key.length should be set to 2 x the AES encryption key length.
140 * For the AES-XTS mode of operation:
141 * - Two keys must be provided and key.length refers to total length of
143 * - Each key can be either 128 bits (16 bytes) or 256 bits (32 bytes).
144 * - Both keys must have the same size.
148 /**< Starting point for Initialisation Vector or Counter,
149 * specified as number of bytes from start of crypto
150 * operation (rte_crypto_op).
152 * - For block ciphers in CBC or F8 mode, or for KASUMI
153 * in F8 mode, or for SNOW 3G in UEA2 mode, this is the
154 * Initialisation Vector (IV) value.
156 * - For block ciphers in CTR mode, this is the counter.
158 * - For GCM mode, this is either the IV (if the length
159 * is 96 bits) or J0 (for other sizes), where J0 is as
160 * defined by NIST SP800-38D. Regardless of the IV
161 * length, a full 16 bytes needs to be allocated.
163 * - For CCM mode, the first byte is reserved, and the
164 * nonce should be written starting at &iv[1] (to allow
165 * space for the implementation to write in the flags
166 * in the first byte). Note that a full 16 bytes should
167 * be allocated, even though the length field will
168 * have a value less than this. Note that the PMDs may
169 * modify the memory reserved (the first byte and the
172 * - For AES-XTS, this is the 128bit tweak, i, from
173 * IEEE Std 1619-2007.
175 * For optimum performance, the data pointed to SHOULD
179 /**< Length of valid IV data.
181 * - For block ciphers in CBC or F8 mode, or for KASUMI
182 * in F8 mode, or for SNOW 3G in UEA2 mode, this is the
183 * length of the IV (which must be the same as the
184 * block length of the cipher).
186 * - For block ciphers in CTR mode, this is the length
187 * of the counter (which must be the same as the block
188 * length of the cipher).
190 * - For GCM mode, this is either 12 (for 96-bit IVs)
191 * or 16, in which case data points to J0.
193 * - For CCM mode, this is the length of the nonce,
194 * which can be in the range 7 to 13 inclusive.
196 } iv; /**< Initialisation vector parameters */
199 /** Symmetric Authentication / Hash Algorithms */
200 enum rte_crypto_auth_algorithm {
201 RTE_CRYPTO_AUTH_NULL = 1,
202 /**< NULL hash algorithm. */
204 RTE_CRYPTO_AUTH_AES_CBC_MAC,
205 /**< AES-CBC-MAC algorithm. Only 128-bit keys are supported. */
206 RTE_CRYPTO_AUTH_AES_CMAC,
207 /**< AES CMAC algorithm. */
208 RTE_CRYPTO_AUTH_AES_GMAC,
209 /**< AES GMAC algorithm. */
210 RTE_CRYPTO_AUTH_AES_XCBC_MAC,
211 /**< AES XCBC algorithm. */
213 RTE_CRYPTO_AUTH_KASUMI_F9,
214 /**< KASUMI algorithm in F9 mode. */
217 /**< MD5 algorithm */
218 RTE_CRYPTO_AUTH_MD5_HMAC,
219 /**< HMAC using MD5 algorithm */
221 RTE_CRYPTO_AUTH_SHA1,
222 /**< 128 bit SHA algorithm. */
223 RTE_CRYPTO_AUTH_SHA1_HMAC,
224 /**< HMAC using 128 bit SHA algorithm. */
225 RTE_CRYPTO_AUTH_SHA224,
226 /**< 224 bit SHA algorithm. */
227 RTE_CRYPTO_AUTH_SHA224_HMAC,
228 /**< HMAC using 224 bit SHA algorithm. */
229 RTE_CRYPTO_AUTH_SHA256,
230 /**< 256 bit SHA algorithm. */
231 RTE_CRYPTO_AUTH_SHA256_HMAC,
232 /**< HMAC using 256 bit SHA algorithm. */
233 RTE_CRYPTO_AUTH_SHA384,
234 /**< 384 bit SHA algorithm. */
235 RTE_CRYPTO_AUTH_SHA384_HMAC,
236 /**< HMAC using 384 bit SHA algorithm. */
237 RTE_CRYPTO_AUTH_SHA512,
238 /**< 512 bit SHA algorithm. */
239 RTE_CRYPTO_AUTH_SHA512_HMAC,
240 /**< HMAC using 512 bit SHA algorithm. */
242 RTE_CRYPTO_AUTH_SNOW3G_UIA2,
243 /**< SNOW 3G algorithm in UIA2 mode. */
245 RTE_CRYPTO_AUTH_ZUC_EIA3,
246 /**< ZUC algorithm in EIA3 mode */
248 RTE_CRYPTO_AUTH_LIST_END
251 /** Authentication algorithm name strings */
253 rte_crypto_auth_algorithm_strings[];
255 /** Symmetric Authentication / Hash Operations */
256 enum rte_crypto_auth_operation {
257 RTE_CRYPTO_AUTH_OP_VERIFY, /**< Verify authentication digest */
258 RTE_CRYPTO_AUTH_OP_GENERATE /**< Generate authentication digest */
261 /** Authentication operation name strings */
263 rte_crypto_auth_operation_strings[];
266 * Authentication / Hash transform data.
268 * This structure contains data relating to an authentication/hash crypto
269 * transforms. The fields op, algo and digest_length are common to all
270 * authentication transforms and MUST be set.
272 struct rte_crypto_auth_xform {
273 enum rte_crypto_auth_operation op;
274 /**< Authentication operation type */
275 enum rte_crypto_auth_algorithm algo;
276 /**< Authentication algorithm selection */
279 uint8_t *data; /**< pointer to key data */
280 uint16_t length;/**< key length in bytes */
282 /**< Authentication key data.
283 * The authentication key length MUST be less than or equal to the
284 * block size of the algorithm. It is the callers responsibility to
285 * ensure that the key length is compliant with the standard being used
286 * (for example RFC 2104, FIPS 198a).
291 /**< Starting point for Initialisation Vector or Counter,
292 * specified as number of bytes from start of crypto
293 * operation (rte_crypto_op).
295 * - For SNOW 3G in UIA2 mode, for ZUC in EIA3 mode and
296 * for AES-GMAC, this is the authentication
297 * Initialisation Vector (IV) value.
299 * - For KASUMI in F9 mode and other authentication
300 * algorithms, this field is not used.
302 * For optimum performance, the data pointed to SHOULD
306 /**< Length of valid IV data.
308 * - For SNOW3G in UIA2 mode, for ZUC in EIA3 mode and
309 * for AES-GMAC, this is the length of the IV.
311 * - For KASUMI in F9 mode and other authentication
312 * algorithms, this field is not used.
315 } iv; /**< Initialisation vector parameters */
317 uint16_t digest_length;
318 /**< Length of the digest to be returned. If the verify option is set,
319 * this specifies the length of the digest to be compared for the
322 * It is the caller's responsibility to ensure that the
323 * digest length is compliant with the hash algorithm being used.
324 * If the value is less than the maximum length allowed by the hash,
325 * the result shall be truncated.
330 /** Symmetric AEAD Algorithms */
331 enum rte_crypto_aead_algorithm {
332 RTE_CRYPTO_AEAD_AES_CCM = 1,
333 /**< AES algorithm in CCM mode. */
334 RTE_CRYPTO_AEAD_AES_GCM,
335 /**< AES algorithm in GCM mode. */
336 RTE_CRYPTO_AEAD_LIST_END
339 /** AEAD algorithm name strings */
341 rte_crypto_aead_algorithm_strings[];
343 /** Symmetric AEAD Operations */
344 enum rte_crypto_aead_operation {
345 RTE_CRYPTO_AEAD_OP_ENCRYPT,
346 /**< Encrypt and generate digest */
347 RTE_CRYPTO_AEAD_OP_DECRYPT
348 /**< Verify digest and decrypt */
351 /** Authentication operation name strings */
353 rte_crypto_aead_operation_strings[];
355 struct rte_crypto_aead_xform {
356 enum rte_crypto_aead_operation op;
357 /**< AEAD operation type */
358 enum rte_crypto_aead_algorithm algo;
359 /**< AEAD algorithm selection */
362 uint8_t *data; /**< pointer to key data */
363 uint16_t length;/**< key length in bytes */
368 /**< Starting point for Initialisation Vector or Counter,
369 * specified as number of bytes from start of crypto
370 * operation (rte_crypto_op).
372 * - For GCM mode, this is either the IV (if the length
373 * is 96 bits) or J0 (for other sizes), where J0 is as
374 * defined by NIST SP800-38D. Regardless of the IV
375 * length, a full 16 bytes needs to be allocated.
377 * - For CCM mode, the first byte is reserved, and the
378 * nonce should be written starting at &iv[1] (to allow
379 * space for the implementation to write in the flags
380 * in the first byte). Note that a full 16 bytes should
381 * be allocated, even though the length field will
382 * have a value less than this.
384 * For optimum performance, the data pointed to SHOULD
388 /**< Length of valid IV data.
390 * - For GCM mode, this is either 12 (for 96-bit IVs)
391 * or 16, in which case data points to J0.
393 * - For CCM mode, this is the length of the nonce,
394 * which can be in the range 7 to 13 inclusive.
396 } iv; /**< Initialisation vector parameters */
398 uint16_t digest_length;
401 /**< The length of the additional authenticated data (AAD) in bytes.
402 * For CCM mode, this is the length of the actual AAD, even though
403 * it is required to reserve 18 bytes before the AAD and padding
404 * at the end of it, so a multiple of 16 bytes is allocated.
408 /** Crypto transformation types */
409 enum rte_crypto_sym_xform_type {
410 RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED = 0, /**< No xform specified */
411 RTE_CRYPTO_SYM_XFORM_AUTH, /**< Authentication xform */
412 RTE_CRYPTO_SYM_XFORM_CIPHER, /**< Cipher xform */
413 RTE_CRYPTO_SYM_XFORM_AEAD /**< AEAD xform */
417 * Symmetric crypto transform structure.
419 * This is used to specify the crypto transforms required, multiple transforms
420 * can be chained together to specify a chain transforms such as authentication
421 * then cipher, or cipher then authentication. Each transform structure can
422 * hold a single transform, the type field is used to specify which transform
423 * is contained within the union
425 struct rte_crypto_sym_xform {
426 struct rte_crypto_sym_xform *next;
427 /**< next xform in chain */
428 enum rte_crypto_sym_xform_type type
432 struct rte_crypto_auth_xform auth;
433 /**< Authentication / hash xform */
434 struct rte_crypto_cipher_xform cipher;
436 struct rte_crypto_aead_xform aead;
441 struct rte_cryptodev_sym_session;
444 * Symmetric Cryptographic Operation.
446 * This structure contains data relating to performing symmetric cryptographic
447 * processing on a referenced mbuf data buffer.
449 * When a symmetric crypto operation is enqueued with the device for processing
450 * it must have a valid *rte_mbuf* structure attached, via m_src parameter,
451 * which contains the source data which the crypto operation is to be performed
453 * While the mbuf is in use by a crypto operation no part of the mbuf should be
454 * changed by the application as the device may read or write to any part of the
455 * mbuf. In the case of hardware crypto devices some or all of the mbuf
456 * may be DMAed in and out of the device, so writing over the original data,
457 * though only the part specified by the rte_crypto_sym_op for transformation
459 * Out-of-place (OOP) operation, where the source mbuf is different to the
460 * destination mbuf, is a special case. Data will be copied from m_src to m_dst.
461 * The part copied includes all the parts of the source mbuf that will be
462 * operated on, based on the cipher.data.offset+cipher.data.length and
463 * auth.data.offset+auth.data.length values in the rte_crypto_sym_op. The part
464 * indicated by the cipher parameters will be transformed, any extra data around
465 * this indicated by the auth parameters will be copied unchanged from source to
467 * Also in OOP operation the cipher.data.offset and auth.data.offset apply to
468 * both source and destination mbufs. As these offsets are relative to the
469 * data_off parameter in each mbuf this can result in the data written to the
470 * destination buffer being at a different alignment, relative to buffer start,
471 * to the data in the source buffer.
473 struct rte_crypto_sym_op {
474 struct rte_mbuf *m_src; /**< source mbuf */
475 struct rte_mbuf *m_dst; /**< destination mbuf */
479 struct rte_cryptodev_sym_session *session;
480 /**< Handle for the initialised session context */
481 struct rte_crypto_sym_xform *xform;
482 /**< Session-less API crypto operation parameters */
483 struct rte_security_session *sec_session;
484 /**< Handle for the initialised security session context */
492 /**< Starting point for AEAD processing, specified as
493 * number of bytes from start of packet in source
497 /**< The message length, in bytes, of the source buffer
498 * on which the cryptographic operation will be
499 * computed. This must be a multiple of the block size
501 } data; /**< Data offsets and length for AEAD */
504 /**< This points to the location where the digest result
505 * should be inserted (in the case of digest generation)
506 * or where the purported digest exists (in the case of
507 * digest verification).
509 * At session creation time, the client specified the
510 * digest result length with the digest_length member
511 * of the @ref rte_crypto_auth_xform structure. For
512 * physical crypto devices the caller must allocate at
513 * least digest_length of physically contiguous memory
516 * For digest generation, the digest result will
517 * overwrite any data at this location.
520 * For GCM (@ref RTE_CRYPTO_AEAD_AES_GCM), for
521 * "digest result" read "authentication tag T".
523 rte_iova_t phys_addr;
524 /**< Physical address of digest */
525 } digest; /**< Digest parameters */
528 /**< Pointer to Additional Authenticated Data (AAD)
529 * needed for authenticated cipher mechanisms (CCM and
532 * Specifically for CCM (@ref RTE_CRYPTO_AEAD_AES_CCM),
533 * the caller should setup this field as follows:
535 * - the additional authentication data itself should
536 * be written starting at an offset of 18 bytes into
537 * the array, leaving room for the first block (16 bytes)
538 * and the length encoding in the first two bytes of the
541 * - the array should be big enough to hold the above
542 * fields, plus any padding to round this up to the
543 * nearest multiple of the block size (16 bytes).
544 * Padding will be added by the implementation.
546 * - Note that PMDs may modify the memory reserved
547 * (first 18 bytes and the final padding).
549 * Finally, for GCM (@ref RTE_CRYPTO_AEAD_AES_GCM), the
550 * caller should setup this field as follows:
552 * - the AAD is written in starting at byte 0
553 * - the array must be big enough to hold the AAD, plus
554 * any space to round this up to the nearest multiple
555 * of the block size (16 bytes).
558 rte_iova_t phys_addr; /**< physical address */
560 /**< Additional authentication parameters */
567 /**< Starting point for cipher processing,
568 * specified as number of bytes from start
569 * of data in the source buffer.
570 * The result of the cipher operation will be
571 * written back into the output buffer
572 * starting at this location.
575 * For SNOW 3G @ RTE_CRYPTO_CIPHER_SNOW3G_UEA2,
576 * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
577 * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
578 * this field should be in bits.
581 /**< The message length, in bytes, of the
582 * source buffer on which the cryptographic
583 * operation will be computed.
584 * This must be a multiple of the block size
585 * if a block cipher is being used. This is
586 * also the same as the result length.
589 * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UEA2,
590 * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
591 * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
592 * this field should be in bits.
594 } data; /**< Data offsets and length for ciphering */
600 /**< Starting point for hash processing,
601 * specified as number of bytes from start of
602 * packet in source buffer.
605 * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
606 * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
607 * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
608 * this field should be in bits.
611 * For KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
612 * this offset should be such that
613 * data to authenticate starts at COUNT.
616 /**< The message length, in bytes, of the source
617 * buffer that the hash will be computed on.
620 * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
621 * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
622 * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
623 * this field should be in bits.
626 * For KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
627 * the length should include the COUNT,
628 * FRESH, message, direction bit and padding
629 * (to be multiple of 8 bits).
632 /**< Data offsets and length for authentication */
636 /**< This points to the location where
637 * the digest result should be inserted
638 * (in the case of digest generation)
639 * or where the purported digest exists
640 * (in the case of digest verification).
642 * At session creation time, the client
643 * specified the digest result length with
644 * the digest_length member of the
645 * @ref rte_crypto_auth_xform structure.
646 * For physical crypto devices the caller
647 * must allocate at least digest_length of
648 * physically contiguous memory at this
651 * For digest generation, the digest result
652 * will overwrite any data at this location.
655 rte_iova_t phys_addr;
656 /**< Physical address of digest */
657 } digest; /**< Digest parameters */
665 * Reset the fields of a symmetric operation to their default values.
667 * @param op The crypto operation to be reset.
670 __rte_crypto_sym_op_reset(struct rte_crypto_sym_op *op)
672 memset(op, 0, sizeof(*op));
677 * Allocate space for symmetric crypto xforms in the private data space of the
678 * crypto operation. This also defaults the crypto xform type to
679 * RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED and configures the chaining of the xforms
680 * in the crypto operation
683 * - On success returns pointer to first crypto xform in crypto operations chain
684 * - On failure returns NULL
686 static inline struct rte_crypto_sym_xform *
687 __rte_crypto_sym_op_sym_xforms_alloc(struct rte_crypto_sym_op *sym_op,
688 void *priv_data, uint8_t nb_xforms)
690 struct rte_crypto_sym_xform *xform;
692 sym_op->xform = xform = (struct rte_crypto_sym_xform *)priv_data;
695 xform->type = RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED;
696 xform = xform->next = --nb_xforms > 0 ? xform + 1 : NULL;
699 return sym_op->xform;
704 * Attach a session to a symmetric crypto operation
706 * @param sym_op crypto operation
707 * @param sess cryptodev session
710 __rte_crypto_sym_op_attach_sym_session(struct rte_crypto_sym_op *sym_op,
711 struct rte_cryptodev_sym_session *sess)
713 sym_op->session = sess;
723 #endif /* _RTE_CRYPTO_SYM_H_ */