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 */
132 * IPsec Security Association option flags
134 struct rte_security_ipsec_sa_options {
135 /** Extended Sequence Numbers (ESN)
137 * * 1: Use extended (64 bit) sequence numbers
138 * * 0: Use normal sequence numbers
142 /** UDP encapsulation
144 * * 1: Do UDP encapsulation/decapsulation so that IPSEC packets can
145 * traverse through NAT boxes.
146 * * 0: No UDP encapsulation
148 uint32_t udp_encap : 1;
152 * * 1: Copy IPv4 or IPv6 DSCP bits from inner IP header to
153 * the outer IP header in encapsulation, and vice versa in
155 * * 0: Do not change DSCP field.
157 uint32_t copy_dscp : 1;
159 /** Copy IPv6 Flow Label
161 * * 1: Copy IPv6 flow label from inner IPv6 header to the
163 * * 0: Outer header is not modified.
165 uint32_t copy_flabel : 1;
167 /** Copy IPv4 Don't Fragment bit
169 * * 1: Copy the DF bit from the inner IPv4 header to the outer
171 * * 0: Outer header is not modified.
173 uint32_t copy_df : 1;
175 /** Decrement inner packet Time To Live (TTL) field
177 * * 1: In tunnel mode, decrement inner packet IPv4 TTL or
178 * IPv6 Hop Limit after tunnel decapsulation, or before tunnel
180 * * 0: Inner packet is not modified.
182 uint32_t dec_ttl : 1;
184 /** Explicit Congestion Notification (ECN)
186 * * 1: In tunnel mode, enable outer header ECN Field copied from
187 * inner header in tunnel encapsulation, or inner header ECN
188 * field construction in decapsulation.
189 * * 0: Inner/outer header are not modified.
193 /** Security statistics
195 * * 1: Enable per session security statistics collection for
196 * this SA, if supported by the driver.
197 * * 0: Disable per session security statistics collection for this SA.
201 /** Disable IV generation in PMD
203 * * 1: Disable IV generation in PMD. When disabled, IV provided in
204 * rte_crypto_op will be used by the PMD.
206 * * 0: Enable IV generation in PMD. When enabled, PMD generated random
207 * value would be used and application is not required to provide
210 * Note: For inline cases, IV generation would always need to be handled
213 uint32_t iv_gen_disable : 1;
215 /** Verify tunnel header in inbound
216 * * ``RTE_SECURITY_IPSEC_TUNNEL_VERIFY_DST_ADDR``: Verify destination
219 * * ``RTE_SECURITY_IPSEC_TUNNEL_VERIFY_SRC_DST_ADDR``: Verify both
220 * source and destination IP addresses.
222 uint32_t tunnel_hdr_verify : 2;
224 /** Verify UDP encapsulation ports in inbound
226 * * 1: Match UDP source and destination ports
227 * * 0: Do not match UDP ports
229 uint32_t udp_ports_verify : 1;
231 /** Compute/verify inner packet IPv4 header checksum in tunnel mode
233 * * 1: For outbound, compute inner packet IPv4 header checksum
234 * before tunnel encapsulation and for inbound, verify after
235 * tunnel decapsulation.
236 * * 0: Inner packet IP header checksum is not computed/verified.
238 * The checksum verification status would be set in mbuf using
239 * PKT_RX_IP_CKSUM_xxx flags.
241 * Inner IP checksum computation can also be enabled(per operation)
242 * by setting the flag PKT_TX_IP_CKSUM in mbuf.
244 uint32_t ip_csum_enable : 1;
246 /** Compute/verify inner packet L4 checksum in tunnel mode
248 * * 1: For outbound, compute inner packet L4 checksum before
249 * tunnel encapsulation and for inbound, verify after
250 * tunnel decapsulation.
251 * * 0: Inner packet L4 checksum is not computed/verified.
253 * The checksum verification status would be set in mbuf using
254 * PKT_RX_L4_CKSUM_xxx flags.
256 * Inner L4 checksum computation can also be enabled(per operation)
257 * by setting the flags PKT_TX_TCP_CKSUM or PKT_TX_SCTP_CKSUM or
258 * PKT_TX_UDP_CKSUM or PKT_TX_L4_MASK in mbuf.
260 uint32_t l4_csum_enable : 1;
263 /** IPSec security association direction */
264 enum rte_security_ipsec_sa_direction {
265 RTE_SECURITY_IPSEC_SA_DIR_EGRESS,
266 /**< Encrypt and generate digest */
267 RTE_SECURITY_IPSEC_SA_DIR_INGRESS,
268 /**< Verify digest and decrypt */
272 * Configure soft and hard lifetime of an IPsec SA
274 * Lifetime of an IPsec SA would specify the maximum number of packets or bytes
275 * that can be processed. IPsec operations would start failing once any hard
278 * Soft limits can be specified to generate notification when the SA is
279 * approaching hard limits for lifetime. For inline operations, reaching soft
280 * expiry limit would result in raising an eth event for the same. For lookaside
281 * operations, this would result in a warning returned in
282 * ``rte_crypto_op.aux_flags``.
284 struct rte_security_ipsec_lifetime {
285 uint64_t packets_soft_limit;
286 /**< Soft expiry limit in number of packets */
287 uint64_t bytes_soft_limit;
288 /**< Soft expiry limit in bytes */
289 uint64_t packets_hard_limit;
290 /**< Soft expiry limit in number of packets */
291 uint64_t bytes_hard_limit;
292 /**< Soft expiry limit in bytes */
296 * IPsec security association configuration data.
298 * This structure contains data required to create an IPsec SA security session.
300 struct rte_security_ipsec_xform {
302 /**< SA security parameter index */
305 struct rte_security_ipsec_sa_options options;
306 /**< various SA options */
307 enum rte_security_ipsec_sa_direction direction;
308 /**< IPSec SA Direction - Egress/Ingress */
309 enum rte_security_ipsec_sa_protocol proto;
310 /**< IPsec SA Protocol - AH/ESP */
311 enum rte_security_ipsec_sa_mode mode;
312 /**< IPsec SA Mode - transport/tunnel */
313 struct rte_security_ipsec_tunnel_param tunnel;
314 /**< Tunnel parameters, NULL for transport mode */
315 struct rte_security_ipsec_lifetime life;
316 /**< IPsec SA lifetime */
317 uint32_t replay_win_sz;
318 /**< Anti replay window size to enable sequence replay attack handling.
319 * replay checking is disabled if the window size is 0.
328 /**< Extended Sequence Number */
332 * MACsec security session configuration
334 struct rte_security_macsec_xform {
340 * PDCP Mode of session
342 enum rte_security_pdcp_domain {
343 RTE_SECURITY_PDCP_MODE_CONTROL, /**< PDCP control plane */
344 RTE_SECURITY_PDCP_MODE_DATA, /**< PDCP data plane */
345 RTE_SECURITY_PDCP_MODE_SHORT_MAC, /**< PDCP short mac */
348 /** PDCP Frame direction */
349 enum rte_security_pdcp_direction {
350 RTE_SECURITY_PDCP_UPLINK, /**< Uplink */
351 RTE_SECURITY_PDCP_DOWNLINK, /**< Downlink */
354 /** PDCP Sequence Number Size selectors */
355 enum rte_security_pdcp_sn_size {
356 /** PDCP_SN_SIZE_5: 5bit sequence number */
357 RTE_SECURITY_PDCP_SN_SIZE_5 = 5,
358 /** PDCP_SN_SIZE_7: 7bit sequence number */
359 RTE_SECURITY_PDCP_SN_SIZE_7 = 7,
360 /** PDCP_SN_SIZE_12: 12bit sequence number */
361 RTE_SECURITY_PDCP_SN_SIZE_12 = 12,
362 /** PDCP_SN_SIZE_15: 15bit sequence number */
363 RTE_SECURITY_PDCP_SN_SIZE_15 = 15,
364 /** PDCP_SN_SIZE_18: 18bit sequence number */
365 RTE_SECURITY_PDCP_SN_SIZE_18 = 18
369 * PDCP security association configuration data.
371 * This structure contains data required to create a PDCP security session.
373 struct rte_security_pdcp_xform {
374 int8_t bearer; /**< PDCP bearer ID */
375 /** Enable in order delivery, this field shall be set only if
376 * driver/HW is capable. See RTE_SECURITY_PDCP_ORDERING_CAP.
379 /** Notify driver/HW to detect and remove duplicate packets.
380 * This field should be set only when driver/hw is capable.
381 * See RTE_SECURITY_PDCP_DUP_DETECT_CAP.
383 uint8_t remove_duplicates;
384 /** PDCP mode of operation: Control or data */
385 enum rte_security_pdcp_domain domain;
386 /** PDCP Frame Direction 0:UL 1:DL */
387 enum rte_security_pdcp_direction pkt_dir;
388 /** Sequence number size, 5/7/12/15/18 */
389 enum rte_security_pdcp_sn_size sn_size;
390 /** Starting Hyper Frame Number to be used together with the SN
391 * from the PDCP frames
394 /** HFN Threshold for key renegotiation */
395 uint32_t hfn_threshold;
396 /** HFN can be given as a per packet value also.
397 * As we do not have IV in case of PDCP, and HFN is
398 * used to generate IV. IV field can be used to get the
399 * per packet HFN while enq/deq.
400 * If hfn_ovrd field is set, user is expected to set the
401 * per packet HFN in place of IV. PMDs will extract the HFN
402 * and perform operations accordingly.
405 /** In case of 5G NR, a new protocol (SDAP) header may be set
406 * inside PDCP payload which should be authenticated but not
407 * encrypted. Hence, driver should be notified if SDAP is
408 * enabled or not, so that SDAP header is not encrypted.
410 uint8_t sdap_enabled;
411 /** Reserved for future */
415 /** DOCSIS direction */
416 enum rte_security_docsis_direction {
417 RTE_SECURITY_DOCSIS_UPLINK,
419 * - Decryption, followed by CRC Verification
421 RTE_SECURITY_DOCSIS_DOWNLINK,
423 * - CRC Generation, followed by Encryption
428 * DOCSIS security session configuration.
430 * This structure contains data required to create a DOCSIS security session.
432 struct rte_security_docsis_xform {
433 enum rte_security_docsis_direction direction;
434 /**< DOCSIS direction */
438 * Security session action type.
440 enum rte_security_session_action_type {
441 RTE_SECURITY_ACTION_TYPE_NONE,
442 /**< No security actions */
443 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO,
444 /**< Crypto processing for security protocol is processed inline
445 * during transmission
447 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL,
448 /**< All security protocol processing is performed inline during
451 RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL,
452 /**< All security protocol processing including crypto is performed
453 * on a lookaside accelerator
455 RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO
456 /**< Similar to ACTION_TYPE_NONE but crypto processing for security
457 * protocol is processed synchronously by a CPU.
461 /** Security session protocol definition */
462 enum rte_security_session_protocol {
463 RTE_SECURITY_PROTOCOL_IPSEC = 1,
464 /**< IPsec Protocol */
465 RTE_SECURITY_PROTOCOL_MACSEC,
466 /**< MACSec Protocol */
467 RTE_SECURITY_PROTOCOL_PDCP,
468 /**< PDCP Protocol */
469 RTE_SECURITY_PROTOCOL_DOCSIS,
470 /**< DOCSIS Protocol */
474 * Security session configuration
476 struct rte_security_session_conf {
477 enum rte_security_session_action_type action_type;
478 /**< Type of action to be performed on the session */
479 enum rte_security_session_protocol protocol;
480 /**< Security protocol to be configured */
483 struct rte_security_ipsec_xform ipsec;
484 struct rte_security_macsec_xform macsec;
485 struct rte_security_pdcp_xform pdcp;
486 struct rte_security_docsis_xform docsis;
488 /**< Configuration parameters for security session */
489 struct rte_crypto_sym_xform *crypto_xform;
490 /**< Security Session Crypto Transformations */
492 /**< Application specific userdata to be saved with session */
495 struct rte_security_session {
496 void *sess_private_data;
497 /**< Private session material */
498 uint64_t opaque_data;
499 /**< Opaque user defined data */
503 * Create security session as specified by the session configuration
505 * @param instance security instance
506 * @param conf session configuration parameters
507 * @param mp mempool to allocate session objects from
508 * @param priv_mp mempool to allocate session private data objects from
510 * - On success, pointer to session
513 struct rte_security_session *
514 rte_security_session_create(struct rte_security_ctx *instance,
515 struct rte_security_session_conf *conf,
516 struct rte_mempool *mp,
517 struct rte_mempool *priv_mp);
520 * Update security session as specified by the session configuration
522 * @param instance security instance
523 * @param sess session to update parameters
524 * @param conf update configuration parameters
526 * - On success returns 0
527 * - On failure returns a negative errno value.
531 rte_security_session_update(struct rte_security_ctx *instance,
532 struct rte_security_session *sess,
533 struct rte_security_session_conf *conf);
536 * Get the size of the security session data for a device.
538 * @param instance security instance.
541 * - Size of the private data, if successful
542 * - 0 if device is invalid or does not support the operation.
545 rte_security_session_get_size(struct rte_security_ctx *instance);
548 * Free security session header and the session private data and
549 * return it to its original mempool.
551 * @param instance security instance
552 * @param sess security session to be freed
556 * - -EINVAL if session or context instance is NULL.
557 * - -EBUSY if not all device private data has been freed.
558 * - -ENOTSUP if destroying private data is not supported.
559 * - other negative values in case of freeing private data errors.
562 rte_security_session_destroy(struct rte_security_ctx *instance,
563 struct rte_security_session *sess);
565 /** Device-specific metadata field type */
566 typedef uint64_t rte_security_dynfield_t;
567 /** Dynamic mbuf field for device-specific metadata */
568 extern int rte_security_dynfield_offset;
572 * @b EXPERIMENTAL: this API may change without prior notice
574 * Get pointer to mbuf field for device-specific metadata.
576 * For performance reason, no check is done,
577 * the dynamic field may not be registered.
578 * @see rte_security_dynfield_is_registered
580 * @param mbuf packet to access
581 * @return pointer to mbuf field
584 static inline rte_security_dynfield_t *
585 rte_security_dynfield(struct rte_mbuf *mbuf)
587 return RTE_MBUF_DYNFIELD(mbuf,
588 rte_security_dynfield_offset,
589 rte_security_dynfield_t *);
594 * @b EXPERIMENTAL: this API may change without prior notice
596 * Check whether the dynamic field is registered.
598 * @return true if rte_security_dynfield_register() has been called.
601 static inline bool rte_security_dynfield_is_registered(void)
603 return rte_security_dynfield_offset >= 0;
606 /** Function to call PMD specific function pointer set_pkt_metadata() */
608 extern int __rte_security_set_pkt_metadata(struct rte_security_ctx *instance,
609 struct rte_security_session *sess,
610 struct rte_mbuf *m, void *params);
613 * Updates the buffer with device-specific defined metadata
615 * @param instance security instance
616 * @param sess security session
617 * @param mb packet mbuf to set metadata on.
618 * @param params device-specific defined parameters
619 * required for metadata
622 * - On success, zero.
623 * - On failure, a negative value.
626 rte_security_set_pkt_metadata(struct rte_security_ctx *instance,
627 struct rte_security_session *sess,
628 struct rte_mbuf *mb, void *params)
631 if (instance->flags & RTE_SEC_CTX_F_FAST_SET_MDATA) {
632 *rte_security_dynfield(mb) =
633 (rte_security_dynfield_t)(sess->sess_private_data);
637 /* Jump to PMD specific function pointer */
638 return __rte_security_set_pkt_metadata(instance, sess, mb, params);
641 /** Function to call PMD specific function pointer get_userdata() */
643 extern void *__rte_security_get_userdata(struct rte_security_ctx *instance,
647 * Get userdata associated with the security session. Device specific metadata
648 * provided would be used to uniquely identify the security session being
649 * referred to. This userdata would be registered while creating the session,
650 * and application can use this to identify the SA etc.
652 * Device specific metadata would be set in mbuf for inline processed inbound
653 * packets. In addition, the same metadata would be set for IPsec events
654 * reported by rte_eth_event framework.
656 * @param instance security instance
657 * @param md device-specific metadata
660 * - On success, userdata
665 rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md)
668 if (instance->flags & RTE_SEC_CTX_F_FAST_GET_UDATA)
669 return (void *)(uintptr_t)md;
671 /* Jump to PMD specific function pointer */
672 return __rte_security_get_userdata(instance, md);
676 * Attach a session to a symmetric crypto operation
678 * @param sym_op crypto operation
679 * @param sess security session
682 __rte_security_attach_session(struct rte_crypto_sym_op *sym_op,
683 struct rte_security_session *sess)
685 sym_op->sec_session = sess;
691 get_sec_session_private_data(const struct rte_security_session *sess)
693 return sess->sess_private_data;
697 set_sec_session_private_data(struct rte_security_session *sess,
700 sess->sess_private_data = private_data;
704 * Attach a session to a crypto operation.
705 * This API is needed only in case of RTE_SECURITY_SESS_CRYPTO_PROTO_OFFLOAD
706 * For other rte_security_session_action_type, ol_flags in rte_mbuf may be
707 * defined to perform security operations.
709 * @param op crypto operation
710 * @param sess security session
713 rte_security_attach_session(struct rte_crypto_op *op,
714 struct rte_security_session *sess)
716 if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
719 op->sess_type = RTE_CRYPTO_OP_SECURITY_SESSION;
721 return __rte_security_attach_session(op->sym, sess);
724 struct rte_security_macsec_stats {
728 struct rte_security_ipsec_stats {
729 uint64_t ipackets; /**< Successfully received IPsec packets. */
730 uint64_t opackets; /**< Successfully transmitted IPsec packets.*/
731 uint64_t ibytes; /**< Successfully received IPsec bytes. */
732 uint64_t obytes; /**< Successfully transmitted IPsec bytes. */
733 uint64_t ierrors; /**< IPsec packets receive/decrypt errors. */
734 uint64_t oerrors; /**< IPsec packets transmit/encrypt errors. */
735 uint64_t reserved1; /**< Reserved for future use. */
736 uint64_t reserved2; /**< Reserved for future use. */
739 struct rte_security_pdcp_stats {
743 struct rte_security_docsis_stats {
747 struct rte_security_stats {
748 enum rte_security_session_protocol protocol;
749 /**< Security protocol to be configured */
753 struct rte_security_macsec_stats macsec;
754 struct rte_security_ipsec_stats ipsec;
755 struct rte_security_pdcp_stats pdcp;
756 struct rte_security_docsis_stats docsis;
761 * Get security session statistics
763 * @param instance security instance
764 * @param sess security session
765 * If security session is NULL then global (per security instance) statistics
766 * will be retrieved, if supported. Global statistics collection is not
767 * dependent on the per session statistics configuration.
768 * @param stats statistics
770 * - On success, return 0
771 * - On failure, a negative value
775 rte_security_session_stats_get(struct rte_security_ctx *instance,
776 struct rte_security_session *sess,
777 struct rte_security_stats *stats);
780 * Security capability definition
782 struct rte_security_capability {
783 enum rte_security_session_action_type action;
784 /**< Security action type*/
785 enum rte_security_session_protocol protocol;
786 /**< Security protocol */
790 enum rte_security_ipsec_sa_protocol proto;
791 /**< IPsec SA protocol */
792 enum rte_security_ipsec_sa_mode mode;
793 /**< IPsec SA mode */
794 enum rte_security_ipsec_sa_direction direction;
795 /**< IPsec SA direction */
796 struct rte_security_ipsec_sa_options options;
797 /**< IPsec SA supported options */
798 uint32_t replay_win_sz_max;
799 /**< IPsec Anti Replay Window Size. A '0' value
800 * indicates that Anti Replay is not supported.
803 /**< IPsec capability */
808 /**< MACsec capability */
810 enum rte_security_pdcp_domain domain;
811 /**< PDCP mode of operation: Control or data */
813 /**< Capability flags, see RTE_SECURITY_PDCP_* */
815 /**< PDCP capability */
817 enum rte_security_docsis_direction direction;
818 /**< DOCSIS direction */
820 /**< DOCSIS capability */
823 const struct rte_cryptodev_capabilities *crypto_capabilities;
824 /**< Corresponding crypto capabilities for security capability */
827 /**< Device offload flags */
830 /** Underlying Hardware/driver which support PDCP may or may not support
831 * packet ordering. Set RTE_SECURITY_PDCP_ORDERING_CAP if it support.
832 * If it is not set, driver/HW assumes packets received are in order
833 * and it will be application's responsibility to maintain ordering.
835 #define RTE_SECURITY_PDCP_ORDERING_CAP 0x00000001
837 /** Underlying Hardware/driver which support PDCP may or may not detect
838 * duplicate packet. Set RTE_SECURITY_PDCP_DUP_DETECT_CAP if it support.
839 * If it is not set, driver/HW assumes there is no duplicate packet received.
841 #define RTE_SECURITY_PDCP_DUP_DETECT_CAP 0x00000002
843 #define RTE_SECURITY_TX_OLOAD_NEED_MDATA 0x00000001
844 /**< HW needs metadata update, see rte_security_set_pkt_metadata().
847 #define RTE_SECURITY_TX_HW_TRAILER_OFFLOAD 0x00000002
848 /**< HW constructs trailer of packets
849 * Transmitted packets will have the trailer added to them
850 * by hardware. The next protocol field will be based on
851 * the mbuf->inner_esp_next_proto field.
853 #define RTE_SECURITY_RX_HW_TRAILER_OFFLOAD 0x00010000
854 /**< HW removes trailer of packets
855 * Received packets have no trailer, the next protocol field
856 * is supplied in the mbuf->inner_esp_next_proto field.
857 * Inner packet is not modified.
861 * Security capability index used to query a security instance for a specific
862 * security capability
864 struct rte_security_capability_idx {
865 enum rte_security_session_action_type action;
866 enum rte_security_session_protocol protocol;
871 enum rte_security_ipsec_sa_protocol proto;
872 enum rte_security_ipsec_sa_mode mode;
873 enum rte_security_ipsec_sa_direction direction;
876 enum rte_security_pdcp_domain domain;
880 enum rte_security_docsis_direction direction;
886 * Returns array of security instance capabilities
888 * @param instance Security instance.
891 * - Returns array of security capabilities.
892 * - Return NULL if no capabilities available.
894 const struct rte_security_capability *
895 rte_security_capabilities_get(struct rte_security_ctx *instance);
898 * Query if a specific capability is available on security instance
900 * @param instance security instance.
901 * @param idx security capability index to match against
904 * - Returns pointer to security capability on match of capability
906 * - Return NULL if the capability not matched on security instance.
908 const struct rte_security_capability *
909 rte_security_capability_get(struct rte_security_ctx *instance,
910 struct rte_security_capability_idx *idx);
916 #endif /* _RTE_SECURITY_H_ */