1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2017,2019-2020 NXP
3 * Copyright(c) 2017-2020 Intel Corporation.
6 #ifndef _RTE_SECURITY_H_
7 #define _RTE_SECURITY_H_
10 * @file rte_security.h
12 * RTE Security Common Definitions
20 #include <sys/types.h>
22 #include <rte_compat.h>
23 #include <rte_common.h>
24 #include <rte_crypto.h>
27 #include <rte_mbuf_dyn.h>
28 #include <rte_memory.h>
29 #include <rte_mempool.h>
31 /** IPSec protocol mode */
32 enum rte_security_ipsec_sa_mode {
33 RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT = 1,
34 /**< IPSec Transport mode */
35 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL,
36 /**< IPSec Tunnel mode */
40 enum rte_security_ipsec_sa_protocol {
41 RTE_SECURITY_IPSEC_SA_PROTO_AH = 1,
43 RTE_SECURITY_IPSEC_SA_PROTO_ESP,
47 /** IPSEC tunnel type */
48 enum rte_security_ipsec_tunnel_type {
49 RTE_SECURITY_IPSEC_TUNNEL_IPV4 = 1,
50 /**< Outer header is IPv4 */
51 RTE_SECURITY_IPSEC_TUNNEL_IPV6,
52 /**< Outer header is IPv6 */
56 * IPSEC tunnel header verification mode
58 * Controls how outer IP header is verified in inbound.
60 #define RTE_SECURITY_IPSEC_TUNNEL_VERIFY_DST_ADDR 0x1
61 #define RTE_SECURITY_IPSEC_TUNNEL_VERIFY_SRC_DST_ADDR 0x2
64 * Security context for crypto/eth devices
66 * Security instance for each driver to register security operations.
67 * The application can get the security context from the crypto/eth device id
68 * using the APIs rte_cryptodev_get_sec_ctx()/rte_eth_dev_get_sec_ctx()
69 * This structure is used to identify the device(crypto/eth) for which the
70 * security operations need to be performed.
72 struct rte_security_ctx {
74 /**< Crypto/ethernet device attached */
75 const struct rte_security_ops *ops;
76 /**< Pointer to security ops for the device */
78 /**< Number of sessions attached to this context */
80 /**< Flags for security context */
83 #define RTE_SEC_CTX_F_FAST_SET_MDATA 0x00000001
84 /**< Driver uses fast metadata update without using driver specific callback */
86 #define RTE_SEC_CTX_F_FAST_GET_UDATA 0x00000002
87 /**< Driver provides udata using fast method without using driver specific
88 * callback. For fast mdata and udata, mbuf dynamic field would be registered
89 * by driver via rte_security_dynfield_register().
93 * IPSEC tunnel parameters
95 * These parameters are used to build outbound tunnel headers.
97 struct rte_security_ipsec_tunnel_param {
98 enum rte_security_ipsec_tunnel_type type;
99 /**< Tunnel type: IPv4 or IPv6 */
103 struct in_addr src_ip;
104 /**< IPv4 source address */
105 struct in_addr dst_ip;
106 /**< IPv4 destination address */
108 /**< IPv4 Differentiated Services Code Point */
110 /**< IPv4 Don't Fragment bit */
112 /**< IPv4 Time To Live */
114 /**< IPv4 header parameters */
116 struct in6_addr src_addr;
117 /**< IPv6 source address */
118 struct in6_addr dst_addr;
119 /**< IPv6 destination address */
121 /**< IPv6 Differentiated Services Code Point */
123 /**< IPv6 flow label */
125 /**< IPv6 hop limit */
127 /**< IPv6 header parameters */
131 struct rte_security_ipsec_udp_param {
137 * IPsec Security Association option flags
139 struct rte_security_ipsec_sa_options {
140 /** Extended Sequence Numbers (ESN)
142 * * 1: Use extended (64 bit) sequence numbers
143 * * 0: Use normal sequence numbers
147 /** UDP encapsulation
149 * * 1: Do UDP encapsulation/decapsulation so that IPSEC packets can
150 * traverse through NAT boxes.
151 * * 0: No UDP encapsulation
153 uint32_t udp_encap : 1;
157 * * 1: Copy IPv4 or IPv6 DSCP bits from inner IP header to
158 * the outer IP header in encapsulation, and vice versa in
160 * * 0: Do not change DSCP field.
162 uint32_t copy_dscp : 1;
164 /** Copy IPv6 Flow Label
166 * * 1: Copy IPv6 flow label from inner IPv6 header to the
168 * * 0: Outer header is not modified.
170 uint32_t copy_flabel : 1;
172 /** Copy IPv4 Don't Fragment bit
174 * * 1: Copy the DF bit from the inner IPv4 header to the outer
176 * * 0: Outer header is not modified.
178 uint32_t copy_df : 1;
180 /** Decrement inner packet Time To Live (TTL) field
182 * * 1: In tunnel mode, decrement inner packet IPv4 TTL or
183 * IPv6 Hop Limit after tunnel decapsulation, or before tunnel
185 * * 0: Inner packet is not modified.
187 uint32_t dec_ttl : 1;
189 /** Explicit Congestion Notification (ECN)
191 * * 1: In tunnel mode, enable outer header ECN Field copied from
192 * inner header in tunnel encapsulation, or inner header ECN
193 * field construction in decapsulation.
194 * * 0: Inner/outer header are not modified.
198 /** Security statistics
200 * * 1: Enable per session security statistics collection for
201 * this SA, if supported by the driver.
202 * * 0: Disable per session security statistics collection for this SA.
206 /** Disable IV generation in PMD
208 * * 1: Disable IV generation in PMD. When disabled, IV provided in
209 * rte_crypto_op will be used by the PMD.
211 * * 0: Enable IV generation in PMD. When enabled, PMD generated random
212 * value would be used and application is not required to provide
215 * Note: For inline cases, IV generation would always need to be handled
218 uint32_t iv_gen_disable : 1;
220 /** Verify tunnel header in inbound
221 * * ``RTE_SECURITY_IPSEC_TUNNEL_VERIFY_DST_ADDR``: Verify destination
224 * * ``RTE_SECURITY_IPSEC_TUNNEL_VERIFY_SRC_DST_ADDR``: Verify both
225 * source and destination IP addresses.
227 uint32_t tunnel_hdr_verify : 2;
229 /** Verify UDP encapsulation ports in inbound
231 * * 1: Match UDP source and destination ports
232 * * 0: Do not match UDP ports
234 uint32_t udp_ports_verify : 1;
236 /** Compute/verify inner packet IPv4 header checksum in tunnel mode
238 * * 1: For outbound, compute inner packet IPv4 header checksum
239 * before tunnel encapsulation and for inbound, verify after
240 * tunnel decapsulation.
241 * * 0: Inner packet IP header checksum is not computed/verified.
243 * The checksum verification status would be set in mbuf using
244 * PKT_RX_IP_CKSUM_xxx flags.
246 * Inner IP checksum computation can also be enabled(per operation)
247 * by setting the flag PKT_TX_IP_CKSUM in mbuf.
249 uint32_t ip_csum_enable : 1;
251 /** Compute/verify inner packet L4 checksum in tunnel mode
253 * * 1: For outbound, compute inner packet L4 checksum before
254 * tunnel encapsulation and for inbound, verify after
255 * tunnel decapsulation.
256 * * 0: Inner packet L4 checksum is not computed/verified.
258 * The checksum verification status would be set in mbuf using
259 * PKT_RX_L4_CKSUM_xxx flags.
261 * Inner L4 checksum computation can also be enabled(per operation)
262 * by setting the flags PKT_TX_TCP_CKSUM or PKT_TX_SCTP_CKSUM or
263 * PKT_TX_UDP_CKSUM or PKT_TX_L4_MASK in mbuf.
265 uint32_t l4_csum_enable : 1;
268 /** IPSec security association direction */
269 enum rte_security_ipsec_sa_direction {
270 RTE_SECURITY_IPSEC_SA_DIR_EGRESS,
271 /**< Encrypt and generate digest */
272 RTE_SECURITY_IPSEC_SA_DIR_INGRESS,
273 /**< Verify digest and decrypt */
277 * Configure soft and hard lifetime of an IPsec SA
279 * Lifetime of an IPsec SA would specify the maximum number of packets or bytes
280 * that can be processed. IPsec operations would start failing once any hard
283 * Soft limits can be specified to generate notification when the SA is
284 * approaching hard limits for lifetime. For inline operations, reaching soft
285 * expiry limit would result in raising an eth event for the same. For lookaside
286 * operations, this would result in a warning returned in
287 * ``rte_crypto_op.aux_flags``.
289 struct rte_security_ipsec_lifetime {
290 uint64_t packets_soft_limit;
291 /**< Soft expiry limit in number of packets */
292 uint64_t bytes_soft_limit;
293 /**< Soft expiry limit in bytes */
294 uint64_t packets_hard_limit;
295 /**< Soft expiry limit in number of packets */
296 uint64_t bytes_hard_limit;
297 /**< Soft expiry limit in bytes */
301 * IPsec security association configuration data.
303 * This structure contains data required to create an IPsec SA security session.
305 struct rte_security_ipsec_xform {
307 /**< SA security parameter index */
310 struct rte_security_ipsec_sa_options options;
311 /**< various SA options */
312 enum rte_security_ipsec_sa_direction direction;
313 /**< IPSec SA Direction - Egress/Ingress */
314 enum rte_security_ipsec_sa_protocol proto;
315 /**< IPsec SA Protocol - AH/ESP */
316 enum rte_security_ipsec_sa_mode mode;
317 /**< IPsec SA Mode - transport/tunnel */
318 struct rte_security_ipsec_tunnel_param tunnel;
319 /**< Tunnel parameters, NULL for transport mode */
320 struct rte_security_ipsec_lifetime life;
321 /**< IPsec SA lifetime */
322 uint32_t replay_win_sz;
323 /**< Anti replay window size to enable sequence replay attack handling.
324 * replay checking is disabled if the window size is 0.
333 /**< Extended Sequence Number */
334 struct rte_security_ipsec_udp_param udp;
335 /**< UDP parameters, ignored when udp_encap option not specified */
339 * MACsec security session configuration
341 struct rte_security_macsec_xform {
347 * PDCP Mode of session
349 enum rte_security_pdcp_domain {
350 RTE_SECURITY_PDCP_MODE_CONTROL, /**< PDCP control plane */
351 RTE_SECURITY_PDCP_MODE_DATA, /**< PDCP data plane */
352 RTE_SECURITY_PDCP_MODE_SHORT_MAC, /**< PDCP short mac */
355 /** PDCP Frame direction */
356 enum rte_security_pdcp_direction {
357 RTE_SECURITY_PDCP_UPLINK, /**< Uplink */
358 RTE_SECURITY_PDCP_DOWNLINK, /**< Downlink */
361 /** PDCP Sequence Number Size selectors */
362 enum rte_security_pdcp_sn_size {
363 /** PDCP_SN_SIZE_5: 5bit sequence number */
364 RTE_SECURITY_PDCP_SN_SIZE_5 = 5,
365 /** PDCP_SN_SIZE_7: 7bit sequence number */
366 RTE_SECURITY_PDCP_SN_SIZE_7 = 7,
367 /** PDCP_SN_SIZE_12: 12bit sequence number */
368 RTE_SECURITY_PDCP_SN_SIZE_12 = 12,
369 /** PDCP_SN_SIZE_15: 15bit sequence number */
370 RTE_SECURITY_PDCP_SN_SIZE_15 = 15,
371 /** PDCP_SN_SIZE_18: 18bit sequence number */
372 RTE_SECURITY_PDCP_SN_SIZE_18 = 18
376 * PDCP security association configuration data.
378 * This structure contains data required to create a PDCP security session.
380 struct rte_security_pdcp_xform {
381 int8_t bearer; /**< PDCP bearer ID */
382 /** Enable in order delivery, this field shall be set only if
383 * driver/HW is capable. See RTE_SECURITY_PDCP_ORDERING_CAP.
386 /** Notify driver/HW to detect and remove duplicate packets.
387 * This field should be set only when driver/hw is capable.
388 * See RTE_SECURITY_PDCP_DUP_DETECT_CAP.
390 uint8_t remove_duplicates;
391 /** PDCP mode of operation: Control or data */
392 enum rte_security_pdcp_domain domain;
393 /** PDCP Frame Direction 0:UL 1:DL */
394 enum rte_security_pdcp_direction pkt_dir;
395 /** Sequence number size, 5/7/12/15/18 */
396 enum rte_security_pdcp_sn_size sn_size;
397 /** Starting Hyper Frame Number to be used together with the SN
398 * from the PDCP frames
401 /** HFN Threshold for key renegotiation */
402 uint32_t hfn_threshold;
403 /** HFN can be given as a per packet value also.
404 * As we do not have IV in case of PDCP, and HFN is
405 * used to generate IV. IV field can be used to get the
406 * per packet HFN while enq/deq.
407 * If hfn_ovrd field is set, user is expected to set the
408 * per packet HFN in place of IV. PMDs will extract the HFN
409 * and perform operations accordingly.
412 /** In case of 5G NR, a new protocol (SDAP) header may be set
413 * inside PDCP payload which should be authenticated but not
414 * encrypted. Hence, driver should be notified if SDAP is
415 * enabled or not, so that SDAP header is not encrypted.
417 uint8_t sdap_enabled;
418 /** Reserved for future */
422 /** DOCSIS direction */
423 enum rte_security_docsis_direction {
424 RTE_SECURITY_DOCSIS_UPLINK,
426 * - Decryption, followed by CRC Verification
428 RTE_SECURITY_DOCSIS_DOWNLINK,
430 * - CRC Generation, followed by Encryption
435 * DOCSIS security session configuration.
437 * This structure contains data required to create a DOCSIS security session.
439 struct rte_security_docsis_xform {
440 enum rte_security_docsis_direction direction;
441 /**< DOCSIS direction */
445 * Security session action type.
447 enum rte_security_session_action_type {
448 RTE_SECURITY_ACTION_TYPE_NONE,
449 /**< No security actions */
450 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO,
451 /**< Crypto processing for security protocol is processed inline
452 * during transmission
454 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL,
455 /**< All security protocol processing is performed inline during
458 RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL,
459 /**< All security protocol processing including crypto is performed
460 * on a lookaside accelerator
462 RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO
463 /**< Similar to ACTION_TYPE_NONE but crypto processing for security
464 * protocol is processed synchronously by a CPU.
468 /** Security session protocol definition */
469 enum rte_security_session_protocol {
470 RTE_SECURITY_PROTOCOL_IPSEC = 1,
471 /**< IPsec Protocol */
472 RTE_SECURITY_PROTOCOL_MACSEC,
473 /**< MACSec Protocol */
474 RTE_SECURITY_PROTOCOL_PDCP,
475 /**< PDCP Protocol */
476 RTE_SECURITY_PROTOCOL_DOCSIS,
477 /**< DOCSIS Protocol */
481 * Security session configuration
483 struct rte_security_session_conf {
484 enum rte_security_session_action_type action_type;
485 /**< Type of action to be performed on the session */
486 enum rte_security_session_protocol protocol;
487 /**< Security protocol to be configured */
490 struct rte_security_ipsec_xform ipsec;
491 struct rte_security_macsec_xform macsec;
492 struct rte_security_pdcp_xform pdcp;
493 struct rte_security_docsis_xform docsis;
495 /**< Configuration parameters for security session */
496 struct rte_crypto_sym_xform *crypto_xform;
497 /**< Security Session Crypto Transformations */
499 /**< Application specific userdata to be saved with session */
502 struct rte_security_session {
503 void *sess_private_data;
504 /**< Private session material */
505 uint64_t opaque_data;
506 /**< Opaque user defined data */
510 * Create security session as specified by the session configuration
512 * @param instance security instance
513 * @param conf session configuration parameters
514 * @param mp mempool to allocate session objects from
515 * @param priv_mp mempool to allocate session private data objects from
517 * - On success, pointer to session
520 struct rte_security_session *
521 rte_security_session_create(struct rte_security_ctx *instance,
522 struct rte_security_session_conf *conf,
523 struct rte_mempool *mp,
524 struct rte_mempool *priv_mp);
527 * Update security session as specified by the session configuration
529 * @param instance security instance
530 * @param sess session to update parameters
531 * @param conf update configuration parameters
533 * - On success returns 0
534 * - On failure returns a negative errno value.
538 rte_security_session_update(struct rte_security_ctx *instance,
539 struct rte_security_session *sess,
540 struct rte_security_session_conf *conf);
543 * Get the size of the security session data for a device.
545 * @param instance security instance.
548 * - Size of the private data, if successful
549 * - 0 if device is invalid or does not support the operation.
552 rte_security_session_get_size(struct rte_security_ctx *instance);
555 * Free security session header and the session private data and
556 * return it to its original mempool.
558 * @param instance security instance
559 * @param sess security session to be freed
563 * - -EINVAL if session or context instance is NULL.
564 * - -EBUSY if not all device private data has been freed.
565 * - -ENOTSUP if destroying private data is not supported.
566 * - other negative values in case of freeing private data errors.
569 rte_security_session_destroy(struct rte_security_ctx *instance,
570 struct rte_security_session *sess);
572 /** Device-specific metadata field type */
573 typedef uint64_t rte_security_dynfield_t;
574 /** Dynamic mbuf field for device-specific metadata */
575 extern int rte_security_dynfield_offset;
579 * @b EXPERIMENTAL: this API may change without prior notice
581 * Get pointer to mbuf field for device-specific metadata.
583 * For performance reason, no check is done,
584 * the dynamic field may not be registered.
585 * @see rte_security_dynfield_is_registered
587 * @param mbuf packet to access
588 * @return pointer to mbuf field
591 static inline rte_security_dynfield_t *
592 rte_security_dynfield(struct rte_mbuf *mbuf)
594 return RTE_MBUF_DYNFIELD(mbuf,
595 rte_security_dynfield_offset,
596 rte_security_dynfield_t *);
601 * @b EXPERIMENTAL: this API may change without prior notice
603 * Check whether the dynamic field is registered.
605 * @return true if rte_security_dynfield_register() has been called.
608 static inline bool rte_security_dynfield_is_registered(void)
610 return rte_security_dynfield_offset >= 0;
613 /** Function to call PMD specific function pointer set_pkt_metadata() */
615 extern int __rte_security_set_pkt_metadata(struct rte_security_ctx *instance,
616 struct rte_security_session *sess,
617 struct rte_mbuf *m, void *params);
620 * Updates the buffer with device-specific defined metadata
622 * @param instance security instance
623 * @param sess security session
624 * @param mb packet mbuf to set metadata on.
625 * @param params device-specific defined parameters
626 * required for metadata
629 * - On success, zero.
630 * - On failure, a negative value.
633 rte_security_set_pkt_metadata(struct rte_security_ctx *instance,
634 struct rte_security_session *sess,
635 struct rte_mbuf *mb, void *params)
638 if (instance->flags & RTE_SEC_CTX_F_FAST_SET_MDATA) {
639 *rte_security_dynfield(mb) =
640 (rte_security_dynfield_t)(sess->sess_private_data);
644 /* Jump to PMD specific function pointer */
645 return __rte_security_set_pkt_metadata(instance, sess, mb, params);
648 /** Function to call PMD specific function pointer get_userdata() */
650 extern void *__rte_security_get_userdata(struct rte_security_ctx *instance,
654 * Get userdata associated with the security session. Device specific metadata
655 * provided would be used to uniquely identify the security session being
656 * referred to. This userdata would be registered while creating the session,
657 * and application can use this to identify the SA etc.
659 * Device specific metadata would be set in mbuf for inline processed inbound
660 * packets. In addition, the same metadata would be set for IPsec events
661 * reported by rte_eth_event framework.
663 * @param instance security instance
664 * @param md device-specific metadata
667 * - On success, userdata
672 rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md)
675 if (instance->flags & RTE_SEC_CTX_F_FAST_GET_UDATA)
676 return (void *)(uintptr_t)md;
678 /* Jump to PMD specific function pointer */
679 return __rte_security_get_userdata(instance, md);
683 * Attach a session to a symmetric crypto operation
685 * @param sym_op crypto operation
686 * @param sess security session
689 __rte_security_attach_session(struct rte_crypto_sym_op *sym_op,
690 struct rte_security_session *sess)
692 sym_op->sec_session = sess;
698 get_sec_session_private_data(const struct rte_security_session *sess)
700 return sess->sess_private_data;
704 set_sec_session_private_data(struct rte_security_session *sess,
707 sess->sess_private_data = private_data;
711 * Attach a session to a crypto operation.
712 * This API is needed only in case of RTE_SECURITY_SESS_CRYPTO_PROTO_OFFLOAD
713 * For other rte_security_session_action_type, ol_flags in rte_mbuf may be
714 * defined to perform security operations.
716 * @param op crypto operation
717 * @param sess security session
720 rte_security_attach_session(struct rte_crypto_op *op,
721 struct rte_security_session *sess)
723 if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
726 op->sess_type = RTE_CRYPTO_OP_SECURITY_SESSION;
728 return __rte_security_attach_session(op->sym, sess);
731 struct rte_security_macsec_stats {
735 struct rte_security_ipsec_stats {
736 uint64_t ipackets; /**< Successfully received IPsec packets. */
737 uint64_t opackets; /**< Successfully transmitted IPsec packets.*/
738 uint64_t ibytes; /**< Successfully received IPsec bytes. */
739 uint64_t obytes; /**< Successfully transmitted IPsec bytes. */
740 uint64_t ierrors; /**< IPsec packets receive/decrypt errors. */
741 uint64_t oerrors; /**< IPsec packets transmit/encrypt errors. */
742 uint64_t reserved1; /**< Reserved for future use. */
743 uint64_t reserved2; /**< Reserved for future use. */
746 struct rte_security_pdcp_stats {
750 struct rte_security_docsis_stats {
754 struct rte_security_stats {
755 enum rte_security_session_protocol protocol;
756 /**< Security protocol to be configured */
760 struct rte_security_macsec_stats macsec;
761 struct rte_security_ipsec_stats ipsec;
762 struct rte_security_pdcp_stats pdcp;
763 struct rte_security_docsis_stats docsis;
768 * Get security session statistics
770 * @param instance security instance
771 * @param sess security session
772 * If security session is NULL then global (per security instance) statistics
773 * will be retrieved, if supported. Global statistics collection is not
774 * dependent on the per session statistics configuration.
775 * @param stats statistics
777 * - On success, return 0
778 * - On failure, a negative value
782 rte_security_session_stats_get(struct rte_security_ctx *instance,
783 struct rte_security_session *sess,
784 struct rte_security_stats *stats);
787 * Security capability definition
789 struct rte_security_capability {
790 enum rte_security_session_action_type action;
791 /**< Security action type*/
792 enum rte_security_session_protocol protocol;
793 /**< Security protocol */
797 enum rte_security_ipsec_sa_protocol proto;
798 /**< IPsec SA protocol */
799 enum rte_security_ipsec_sa_mode mode;
800 /**< IPsec SA mode */
801 enum rte_security_ipsec_sa_direction direction;
802 /**< IPsec SA direction */
803 struct rte_security_ipsec_sa_options options;
804 /**< IPsec SA supported options */
805 uint32_t replay_win_sz_max;
806 /**< IPsec Anti Replay Window Size. A '0' value
807 * indicates that Anti Replay is not supported.
810 /**< IPsec capability */
815 /**< MACsec capability */
817 enum rte_security_pdcp_domain domain;
818 /**< PDCP mode of operation: Control or data */
820 /**< Capability flags, see RTE_SECURITY_PDCP_* */
822 /**< PDCP capability */
824 enum rte_security_docsis_direction direction;
825 /**< DOCSIS direction */
827 /**< DOCSIS capability */
830 const struct rte_cryptodev_capabilities *crypto_capabilities;
831 /**< Corresponding crypto capabilities for security capability */
834 /**< Device offload flags */
837 /** Underlying Hardware/driver which support PDCP may or may not support
838 * packet ordering. Set RTE_SECURITY_PDCP_ORDERING_CAP if it support.
839 * If it is not set, driver/HW assumes packets received are in order
840 * and it will be application's responsibility to maintain ordering.
842 #define RTE_SECURITY_PDCP_ORDERING_CAP 0x00000001
844 /** Underlying Hardware/driver which support PDCP may or may not detect
845 * duplicate packet. Set RTE_SECURITY_PDCP_DUP_DETECT_CAP if it support.
846 * If it is not set, driver/HW assumes there is no duplicate packet received.
848 #define RTE_SECURITY_PDCP_DUP_DETECT_CAP 0x00000002
850 #define RTE_SECURITY_TX_OLOAD_NEED_MDATA 0x00000001
851 /**< HW needs metadata update, see rte_security_set_pkt_metadata().
854 #define RTE_SECURITY_TX_HW_TRAILER_OFFLOAD 0x00000002
855 /**< HW constructs trailer of packets
856 * Transmitted packets will have the trailer added to them
857 * by hardware. The next protocol field will be based on
858 * the mbuf->inner_esp_next_proto field.
860 #define RTE_SECURITY_RX_HW_TRAILER_OFFLOAD 0x00010000
861 /**< HW removes trailer of packets
862 * Received packets have no trailer, the next protocol field
863 * is supplied in the mbuf->inner_esp_next_proto field.
864 * Inner packet is not modified.
868 * Security capability index used to query a security instance for a specific
869 * security capability
871 struct rte_security_capability_idx {
872 enum rte_security_session_action_type action;
873 enum rte_security_session_protocol protocol;
878 enum rte_security_ipsec_sa_protocol proto;
879 enum rte_security_ipsec_sa_mode mode;
880 enum rte_security_ipsec_sa_direction direction;
883 enum rte_security_pdcp_domain domain;
887 enum rte_security_docsis_direction direction;
893 * Returns array of security instance capabilities
895 * @param instance Security instance.
898 * - Returns array of security capabilities.
899 * - Return NULL if no capabilities available.
901 const struct rte_security_capability *
902 rte_security_capabilities_get(struct rte_security_ctx *instance);
905 * Query if a specific capability is available on security instance
907 * @param instance security instance.
908 * @param idx security capability index to match against
911 * - Returns pointer to security capability on match of capability
913 * - Return NULL if the capability not matched on security instance.
915 const struct rte_security_capability *
916 rte_security_capability_get(struct rte_security_ctx *instance,
917 struct rte_security_capability_idx *idx);
923 #endif /* _RTE_SECURITY_H_ */