lib/librte_security/rte_security.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2017,2019 NXP
   3  * Copyright(c) 2017-2020 Intel Corporation.
   4  */
   5
   6 #ifndef _RTE_SECURITY_H_
   7 #define _RTE_SECURITY_H_
   8
   9 /**
  10  * @file rte_security.h
  11  *
  12  * RTE Security Common Definitions
  13  *
  14  */
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 #include <sys/types.h>
  21
  22 #include <netinet/in.h>
  23 #include <netinet/ip.h>
  24 #include <netinet/ip6.h>
  25
  26 #include <rte_compat.h>
  27 #include <rte_common.h>
  28 #include <rte_crypto.h>
  29 #include <rte_mbuf.h>
  30 #include <rte_memory.h>
  31 #include <rte_mempool.h>
  32
  33 /** IPSec protocol mode */
  34 enum rte_security_ipsec_sa_mode {
  35         RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT = 1,
  36         /**< IPSec Transport mode */
  37         RTE_SECURITY_IPSEC_SA_MODE_TUNNEL,
  38         /**< IPSec Tunnel mode */
  39 };
  40
  41 /** IPSec Protocol */
  42 enum rte_security_ipsec_sa_protocol {
  43         RTE_SECURITY_IPSEC_SA_PROTO_AH = 1,
  44         /**< AH protocol */
  45         RTE_SECURITY_IPSEC_SA_PROTO_ESP,
  46         /**< ESP protocol */
  47 };
  48
  49 /** IPSEC tunnel type */
  50 enum rte_security_ipsec_tunnel_type {
  51         RTE_SECURITY_IPSEC_TUNNEL_IPV4 = 1,
  52         /**< Outer header is IPv4 */
  53         RTE_SECURITY_IPSEC_TUNNEL_IPV6,
  54         /**< Outer header is IPv6 */
  55 };
  56
  57 /**
  58  * Security context for crypto/eth devices
  59  *
  60  * Security instance for each driver to register security operations.
  61  * The application can get the security context from the crypto/eth device id
  62  * using the APIs rte_cryptodev_get_sec_ctx()/rte_eth_dev_get_sec_ctx()
  63  * This structure is used to identify the device(crypto/eth) for which the
  64  * security operations need to be performed.
  65  */
  66 struct rte_security_ctx {
  67         void *device;
  68         /**< Crypto/ethernet device attached */
  69         const struct rte_security_ops *ops;
  70         /**< Pointer to security ops for the device */
  71         uint16_t sess_cnt;
  72         /**< Number of sessions attached to this context */
  73 };
  74
  75 /**
  76  * IPSEC tunnel parameters
  77  *
  78  * These parameters are used to build outbound tunnel headers.
  79  */
  80 struct rte_security_ipsec_tunnel_param {
  81         enum rte_security_ipsec_tunnel_type type;
  82         /**< Tunnel type: IPv4 or IPv6 */
  83         RTE_STD_C11
  84         union {
  85                 struct {
  86                         struct in_addr src_ip;
  87                         /**< IPv4 source address */
  88                         struct in_addr dst_ip;
  89                         /**< IPv4 destination address */
  90                         uint8_t dscp;
  91                         /**< IPv4 Differentiated Services Code Point */
  92                         uint8_t df;
  93                         /**< IPv4 Don't Fragment bit */
  94                         uint8_t ttl;
  95                         /**< IPv4 Time To Live */
  96                 } ipv4;
  97                 /**< IPv4 header parameters */
  98                 struct {
  99                         struct in6_addr src_addr;
 100                         /**< IPv6 source address */
 101                         struct in6_addr dst_addr;
 102                         /**< IPv6 destination address */
 103                         uint8_t dscp;
 104                         /**< IPv6 Differentiated Services Code Point */
 105                         uint32_t flabel;
 106                         /**< IPv6 flow label */
 107                         uint8_t hlimit;
 108                         /**< IPv6 hop limit */
 109                 } ipv6;
 110                 /**< IPv6 header parameters */
 111         };
 112 };
 113
 114 /**
 115  * IPsec Security Association option flags
 116  */
 117 struct rte_security_ipsec_sa_options {
 118         /** Extended Sequence Numbers (ESN)
 119          *
 120          * * 1: Use extended (64 bit) sequence numbers
 121          * * 0: Use normal sequence numbers
 122          */
 123         uint32_t esn : 1;
 124
 125         /** UDP encapsulation
 126          *
 127          * * 1: Do UDP encapsulation/decapsulation so that IPSEC packets can
 128          *      traverse through NAT boxes.
 129          * * 0: No UDP encapsulation
 130          */
 131         uint32_t udp_encap : 1;
 132
 133         /** Copy DSCP bits
 134          *
 135          * * 1: Copy IPv4 or IPv6 DSCP bits from inner IP header to
 136          *      the outer IP header in encapsulation, and vice versa in
 137          *      decapsulation.
 138          * * 0: Do not change DSCP field.
 139          */
 140         uint32_t copy_dscp : 1;
 141
 142         /** Copy IPv6 Flow Label
 143          *
 144          * * 1: Copy IPv6 flow label from inner IPv6 header to the
 145          *      outer IPv6 header.
 146          * * 0: Outer header is not modified.
 147          */
 148         uint32_t copy_flabel : 1;
 149
 150         /** Copy IPv4 Don't Fragment bit
 151          *
 152          * * 1: Copy the DF bit from the inner IPv4 header to the outer
 153          *      IPv4 header.
 154          * * 0: Outer header is not modified.
 155          */
 156         uint32_t copy_df : 1;
 157
 158         /** Decrement inner packet Time To Live (TTL) field
 159          *
 160          * * 1: In tunnel mode, decrement inner packet IPv4 TTL or
 161          *      IPv6 Hop Limit after tunnel decapsulation, or before tunnel
 162          *      encapsulation.
 163          * * 0: Inner packet is not modified.
 164          */
 165         uint32_t dec_ttl : 1;
 166
 167         /** Explicit Congestion Notification (ECN)
 168          *
 169          * * 1: In tunnel mode, enable outer header ECN Field copied from
 170          *      inner header in tunnel encapsulation, or inner header ECN
 171          *      field construction in decapsulation.
 172          * * 0: Inner/outer header are not modified.
 173          */
 174         uint32_t ecn : 1;
 175
 176         /** Security statistics
 177          *
 178          * * 1: Enable per session security statistics collection for
 179          *      this SA, if supported by the driver.
 180          * * 0: Disable per session security statistics collection for this SA.
 181          */
 182         uint32_t stats : 1;
 183 };
 184
 185 /** IPSec security association direction */
 186 enum rte_security_ipsec_sa_direction {
 187         RTE_SECURITY_IPSEC_SA_DIR_EGRESS,
 188         /**< Encrypt and generate digest */
 189         RTE_SECURITY_IPSEC_SA_DIR_INGRESS,
 190         /**< Verify digest and decrypt */
 191 };
 192
 193 /**
 194  * IPsec security association configuration data.
 195  *
 196  * This structure contains data required to create an IPsec SA security session.
 197  */
 198 struct rte_security_ipsec_xform {
 199         uint32_t spi;
 200         /**< SA security parameter index */
 201         uint32_t salt;
 202         /**< SA salt */
 203         struct rte_security_ipsec_sa_options options;
 204         /**< various SA options */
 205         enum rte_security_ipsec_sa_direction direction;
 206         /**< IPSec SA Direction - Egress/Ingress */
 207         enum rte_security_ipsec_sa_protocol proto;
 208         /**< IPsec SA Protocol - AH/ESP */
 209         enum rte_security_ipsec_sa_mode mode;
 210         /**< IPsec SA Mode - transport/tunnel */
 211         struct rte_security_ipsec_tunnel_param tunnel;
 212         /**< Tunnel parameters, NULL for transport mode */
 213         uint64_t esn_soft_limit;
 214         /**< ESN for which the overflow event need to be raised */
 215         uint32_t replay_win_sz;
 216         /**< Anti replay window size to enable sequence replay attack handling.
 217          * replay checking is disabled if the window size is 0.
 218          */
 219 };
 220
 221 /**
 222  * MACsec security session configuration
 223  */
 224 struct rte_security_macsec_xform {
 225         /** To be Filled */
 226         int dummy;
 227 };
 228
 229 /**
 230  * PDCP Mode of session
 231  */
 232 enum rte_security_pdcp_domain {
 233         RTE_SECURITY_PDCP_MODE_CONTROL, /**< PDCP control plane */
 234         RTE_SECURITY_PDCP_MODE_DATA,    /**< PDCP data plane */
 235 };
 236
 237 /** PDCP Frame direction */
 238 enum rte_security_pdcp_direction {
 239         RTE_SECURITY_PDCP_UPLINK,       /**< Uplink */
 240         RTE_SECURITY_PDCP_DOWNLINK,     /**< Downlink */
 241 };
 242
 243 /** PDCP Sequence Number Size selectors */
 244 enum rte_security_pdcp_sn_size {
 245         /** PDCP_SN_SIZE_5: 5bit sequence number */
 246         RTE_SECURITY_PDCP_SN_SIZE_5 = 5,
 247         /** PDCP_SN_SIZE_7: 7bit sequence number */
 248         RTE_SECURITY_PDCP_SN_SIZE_7 = 7,
 249         /** PDCP_SN_SIZE_12: 12bit sequence number */
 250         RTE_SECURITY_PDCP_SN_SIZE_12 = 12,
 251         /** PDCP_SN_SIZE_15: 15bit sequence number */
 252         RTE_SECURITY_PDCP_SN_SIZE_15 = 15,
 253         /** PDCP_SN_SIZE_18: 18bit sequence number */
 254         RTE_SECURITY_PDCP_SN_SIZE_18 = 18
 255 };
 256
 257 /**
 258  * PDCP security association configuration data.
 259  *
 260  * This structure contains data required to create a PDCP security session.
 261  */
 262 struct rte_security_pdcp_xform {
 263         int8_t bearer;  /**< PDCP bearer ID */
 264         /** Enable in order delivery, this field shall be set only if
 265          * driver/HW is capable. See RTE_SECURITY_PDCP_ORDERING_CAP.
 266          */
 267         uint8_t en_ordering;
 268         /** Notify driver/HW to detect and remove duplicate packets.
 269          * This field should be set only when driver/hw is capable.
 270          * See RTE_SECURITY_PDCP_DUP_DETECT_CAP.
 271          */
 272         uint8_t remove_duplicates;
 273         /** PDCP mode of operation: Control or data */
 274         enum rte_security_pdcp_domain domain;
 275         /** PDCP Frame Direction 0:UL 1:DL */
 276         enum rte_security_pdcp_direction pkt_dir;
 277         /** Sequence number size, 5/7/12/15/18 */
 278         enum rte_security_pdcp_sn_size sn_size;
 279         /** Starting Hyper Frame Number to be used together with the SN
 280          * from the PDCP frames
 281          */
 282         uint32_t hfn;
 283         /** HFN Threshold for key renegotiation */
 284         uint32_t hfn_threshold;
 285         /** HFN can be given as a per packet value also.
 286          * As we do not have IV in case of PDCP, and HFN is
 287          * used to generate IV. IV field can be used to get the
 288          * per packet HFN while enq/deq.
 289          * If hfn_ovrd field is set, user is expected to set the
 290          * per packet HFN in place of IV. PMDs will extract the HFN
 291          * and perform operations accordingly.
 292          */
 293         uint32_t hfn_ovrd;
 294 };
 295
 296 /** DOCSIS direction */
 297 enum rte_security_docsis_direction {
 298         RTE_SECURITY_DOCSIS_UPLINK,
 299         /**< Uplink
 300          * - Decryption, followed by CRC Verification
 301          */
 302         RTE_SECURITY_DOCSIS_DOWNLINK,
 303         /**< Downlink
 304          * - CRC Generation, followed by Encryption
 305          */
 306 };
 307
 308 /**
 309  * DOCSIS security session configuration.
 310  *
 311  * This structure contains data required to create a DOCSIS security session.
 312  */
 313 struct rte_security_docsis_xform {
 314         enum rte_security_docsis_direction direction;
 315         /**< DOCSIS direction */
 316 };
 317
 318 /**
 319  * Security session action type.
 320  */
 321 enum rte_security_session_action_type {
 322         RTE_SECURITY_ACTION_TYPE_NONE,
 323         /**< No security actions */
 324         RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO,
 325         /**< Crypto processing for security protocol is processed inline
 326          * during transmission
 327          */
 328         RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL,
 329         /**< All security protocol processing is performed inline during
 330          * transmission
 331          */
 332         RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL,
 333         /**< All security protocol processing including crypto is performed
 334          * on a lookaside accelerator
 335          */
 336         RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO
 337         /**< Similar to ACTION_TYPE_NONE but crypto processing for security
 338          * protocol is processed synchronously by a CPU.
 339          */
 340 };
 341
 342 /** Security session protocol definition */
 343 enum rte_security_session_protocol {
 344         RTE_SECURITY_PROTOCOL_IPSEC = 1,
 345         /**< IPsec Protocol */
 346         RTE_SECURITY_PROTOCOL_MACSEC,
 347         /**< MACSec Protocol */
 348         RTE_SECURITY_PROTOCOL_PDCP,
 349         /**< PDCP Protocol */
 350         RTE_SECURITY_PROTOCOL_DOCSIS,
 351         /**< DOCSIS Protocol */
 352 };
 353
 354 /**
 355  * Security session configuration
 356  */
 357 struct rte_security_session_conf {
 358         enum rte_security_session_action_type action_type;
 359         /**< Type of action to be performed on the session */
 360         enum rte_security_session_protocol protocol;
 361         /**< Security protocol to be configured */
 362         RTE_STD_C11
 363         union {
 364                 struct rte_security_ipsec_xform ipsec;
 365                 struct rte_security_macsec_xform macsec;
 366                 struct rte_security_pdcp_xform pdcp;
 367                 struct rte_security_docsis_xform docsis;
 368         };
 369         /**< Configuration parameters for security session */
 370         struct rte_crypto_sym_xform *crypto_xform;
 371         /**< Security Session Crypto Transformations */
 372         void *userdata;
 373         /**< Application specific userdata to be saved with session */
 374 };
 375
 376 struct rte_security_session {
 377         void *sess_private_data;
 378         /**< Private session material */
 379         uint64_t opaque_data;
 380         /**< Opaque user defined data */
 381 };
 382
 383 /**
 384  * Create security session as specified by the session configuration
 385  *
 386  * @param   instance    security instance
 387  * @param   conf        session configuration parameters
 388  * @param   mp          mempool to allocate session objects from
 389  * @return
 390  *  - On success, pointer to session
 391  *  - On failure, NULL
 392  */
 393 struct rte_security_session *
 394 rte_security_session_create(struct rte_security_ctx *instance,
 395                             struct rte_security_session_conf *conf,
 396                             struct rte_mempool *mp);
 397
 398 /**
 399  * Update security session as specified by the session configuration
 400  *
 401  * @param   instance    security instance
 402  * @param   sess        session to update parameters
 403  * @param   conf        update configuration parameters
 404  * @return
 405  *  - On success returns 0
 406  *  - On failure returns a negative errno value.
 407  */
 408 __rte_experimental
 409 int
 410 rte_security_session_update(struct rte_security_ctx *instance,
 411                             struct rte_security_session *sess,
 412                             struct rte_security_session_conf *conf);
 413
 414 /**
 415  * Get the size of the security session data for a device.
 416  *
 417  * @param   instance    security instance.
 418  *
 419  * @return
 420  *   - Size of the private data, if successful
 421  *   - 0 if device is invalid or does not support the operation.
 422  */
 423 unsigned int
 424 rte_security_session_get_size(struct rte_security_ctx *instance);
 425
 426 /**
 427  * Free security session header and the session private data and
 428  * return it to its original mempool.
 429  *
 430  * @param   instance    security instance
 431  * @param   sess        security session to be freed
 432  *
 433  * @return
 434  *  - 0 if successful.
 435  *  - -EINVAL if session or context instance is NULL.
 436  *  - -EBUSY if not all device private data has been freed.
 437  *  - -ENOTSUP if destroying private data is not supported.
 438  *  - other negative values in case of freeing private data errors.
 439  */
 440 int
 441 rte_security_session_destroy(struct rte_security_ctx *instance,
 442                              struct rte_security_session *sess);
 443
 444 /**
 445  *  Updates the buffer with device-specific defined metadata
 446  *
 447  * @param       instance        security instance
 448  * @param       sess            security session
 449  * @param       mb              packet mbuf to set metadata on.
 450  * @param       params          device-specific defined parameters
 451  *                              required for metadata
 452  *
 453  * @return
 454  *  - On success, zero.
 455  *  - On failure, a negative value.
 456  */
 457 int
 458 rte_security_set_pkt_metadata(struct rte_security_ctx *instance,
 459                               struct rte_security_session *sess,
 460                               struct rte_mbuf *mb, void *params);
 461
 462 /**
 463  * Get userdata associated with the security session. Device specific metadata
 464  * provided would be used to uniquely identify the security session being
 465  * referred to. This userdata would be registered while creating the session,
 466  * and application can use this to identify the SA etc.
 467  *
 468  * Device specific metadata would be set in mbuf for inline processed inbound
 469  * packets. In addition, the same metadata would be set for IPsec events
 470  * reported by rte_eth_event framework.
 471  *
 472  * @param   instance    security instance
 473  * @param   md          device-specific metadata
 474  *
 475  * @return
 476  *  - On success, userdata
 477  *  - On failure, NULL
 478  */
 479 __rte_experimental
 480 void *
 481 rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md);
 482
 483 /**
 484  * Attach a session to a symmetric crypto operation
 485  *
 486  * @param       sym_op  crypto operation
 487  * @param       sess    security session
 488  */
 489 static inline int
 490 __rte_security_attach_session(struct rte_crypto_sym_op *sym_op,
 491                               struct rte_security_session *sess)
 492 {
 493         sym_op->sec_session = sess;
 494
 495         return 0;
 496 }
 497
 498 static inline void *
 499 get_sec_session_private_data(const struct rte_security_session *sess)
 500 {
 501         return sess->sess_private_data;
 502 }
 503
 504 static inline void
 505 set_sec_session_private_data(struct rte_security_session *sess,
 506                              void *private_data)
 507 {
 508         sess->sess_private_data = private_data;
 509 }
 510
 511 /**
 512  * Attach a session to a crypto operation.
 513  * This API is needed only in case of RTE_SECURITY_SESS_CRYPTO_PROTO_OFFLOAD
 514  * For other rte_security_session_action_type, ol_flags in rte_mbuf may be
 515  * defined to perform security operations.
 516  *
 517  * @param       op      crypto operation
 518  * @param       sess    security session
 519  */
 520 static inline int
 521 rte_security_attach_session(struct rte_crypto_op *op,
 522                             struct rte_security_session *sess)
 523 {
 524         if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
 525                 return -EINVAL;
 526
 527         op->sess_type =  RTE_CRYPTO_OP_SECURITY_SESSION;
 528
 529         return __rte_security_attach_session(op->sym, sess);
 530 }
 531
 532 struct rte_security_macsec_stats {
 533         uint64_t reserved;
 534 };
 535
 536 struct rte_security_ipsec_stats {
 537         uint64_t ipackets;  /**< Successfully received IPsec packets. */
 538         uint64_t opackets;  /**< Successfully transmitted IPsec packets.*/
 539         uint64_t ibytes;    /**< Successfully received IPsec bytes. */
 540         uint64_t obytes;    /**< Successfully transmitted IPsec bytes. */
 541         uint64_t ierrors;   /**< IPsec packets receive/decrypt errors. */
 542         uint64_t oerrors;   /**< IPsec packets transmit/encrypt errors. */
 543         uint64_t reserved1; /**< Reserved for future use. */
 544         uint64_t reserved2; /**< Reserved for future use. */
 545 };
 546
 547 struct rte_security_pdcp_stats {
 548         uint64_t reserved;
 549 };
 550
 551 struct rte_security_docsis_stats {
 552         uint64_t reserved;
 553 };
 554
 555 struct rte_security_stats {
 556         enum rte_security_session_protocol protocol;
 557         /**< Security protocol to be configured */
 558
 559         RTE_STD_C11
 560         union {
 561                 struct rte_security_macsec_stats macsec;
 562                 struct rte_security_ipsec_stats ipsec;
 563                 struct rte_security_pdcp_stats pdcp;
 564                 struct rte_security_docsis_stats docsis;
 565         };
 566 };
 567
 568 /**
 569  * Get security session statistics
 570  *
 571  * @param       instance        security instance
 572  * @param       sess            security session
 573  * If security session is NULL then global (per security instance) statistics
 574  * will be retrieved, if supported. Global statistics collection is not
 575  * dependent on the per session statistics configuration.
 576  * @param       stats           statistics
 577  * @return
 578  *  - On success, return 0
 579  *  - On failure, a negative value
 580  */
 581 __rte_experimental
 582 int
 583 rte_security_session_stats_get(struct rte_security_ctx *instance,
 584                                struct rte_security_session *sess,
 585                                struct rte_security_stats *stats);
 586
 587 /**
 588  * Security capability definition
 589  */
 590 struct rte_security_capability {
 591         enum rte_security_session_action_type action;
 592         /**< Security action type*/
 593         enum rte_security_session_protocol protocol;
 594         /**< Security protocol */
 595         RTE_STD_C11
 596         union {
 597                 struct {
 598                         enum rte_security_ipsec_sa_protocol proto;
 599                         /**< IPsec SA protocol */
 600                         enum rte_security_ipsec_sa_mode mode;
 601                         /**< IPsec SA mode */
 602                         enum rte_security_ipsec_sa_direction direction;
 603                         /**< IPsec SA direction */
 604                         struct rte_security_ipsec_sa_options options;
 605                         /**< IPsec SA supported options */
 606                         uint32_t replay_win_sz_max;
 607                         /**< IPsec Anti Replay Window Size. A '0' value
 608                          * indicates that Anti Replay is not supported.
 609                          */
 610                 } ipsec;
 611                 /**< IPsec capability */
 612                 struct {
 613                         /* To be Filled */
 614                         int dummy;
 615                 } macsec;
 616                 /**< MACsec capability */
 617                 struct {
 618                         enum rte_security_pdcp_domain domain;
 619                         /**< PDCP mode of operation: Control or data */
 620                         uint32_t capa_flags;
 621                         /**< Capability flags, see RTE_SECURITY_PDCP_* */
 622                 } pdcp;
 623                 /**< PDCP capability */
 624                 struct {
 625                         enum rte_security_docsis_direction direction;
 626                         /**< DOCSIS direction */
 627                 } docsis;
 628                 /**< DOCSIS capability */
 629         };
 630
 631         const struct rte_cryptodev_capabilities *crypto_capabilities;
 632         /**< Corresponding crypto capabilities for security capability  */
 633
 634         uint32_t ol_flags;
 635         /**< Device offload flags */
 636 };
 637
 638 /** Underlying Hardware/driver which support PDCP may or may not support
 639  * packet ordering. Set RTE_SECURITY_PDCP_ORDERING_CAP if it support.
 640  * If it is not set, driver/HW assumes packets received are in order
 641  * and it will be application's responsibility to maintain ordering.
 642  */
 643 #define RTE_SECURITY_PDCP_ORDERING_CAP          0x00000001
 644
 645 /** Underlying Hardware/driver which support PDCP may or may not detect
 646  * duplicate packet. Set RTE_SECURITY_PDCP_DUP_DETECT_CAP if it support.
 647  * If it is not set, driver/HW assumes there is no duplicate packet received.
 648  */
 649 #define RTE_SECURITY_PDCP_DUP_DETECT_CAP        0x00000002
 650
 651 #define RTE_SECURITY_TX_OLOAD_NEED_MDATA        0x00000001
 652 /**< HW needs metadata update, see rte_security_set_pkt_metadata().
 653  */
 654
 655 #define RTE_SECURITY_TX_HW_TRAILER_OFFLOAD      0x00000002
 656 /**< HW constructs trailer of packets
 657  * Transmitted packets will have the trailer added to them
 658  * by hardware. The next protocol field will be based on
 659  * the mbuf->inner_esp_next_proto field.
 660  */
 661 #define RTE_SECURITY_RX_HW_TRAILER_OFFLOAD      0x00010000
 662 /**< HW removes trailer of packets
 663  * Received packets have no trailer, the next protocol field
 664  * is supplied in the mbuf->inner_esp_next_proto field.
 665  * Inner packet is not modified.
 666  */
 667
 668 /**
 669  * Security capability index used to query a security instance for a specific
 670  * security capability
 671  */
 672 struct rte_security_capability_idx {
 673         enum rte_security_session_action_type action;
 674         enum rte_security_session_protocol protocol;
 675
 676         RTE_STD_C11
 677         union {
 678                 struct {
 679                         enum rte_security_ipsec_sa_protocol proto;
 680                         enum rte_security_ipsec_sa_mode mode;
 681                         enum rte_security_ipsec_sa_direction direction;
 682                 } ipsec;
 683                 struct {
 684                         enum rte_security_pdcp_domain domain;
 685                         uint32_t capa_flags;
 686                 } pdcp;
 687                 struct {
 688                         enum rte_security_docsis_direction direction;
 689                 } docsis;
 690         };
 691 };
 692
 693 /**
 694  *  Returns array of security instance capabilities
 695  *
 696  * @param       instance        Security instance.
 697  *
 698  * @return
 699  *   - Returns array of security capabilities.
 700  *   - Return NULL if no capabilities available.
 701  */
 702 const struct rte_security_capability *
 703 rte_security_capabilities_get(struct rte_security_ctx *instance);
 704
 705 /**
 706  * Query if a specific capability is available on security instance
 707  *
 708  * @param       instance        security instance.
 709  * @param       idx             security capability index to match against
 710  *
 711  * @return
 712  *   - Returns pointer to security capability on match of capability
 713  *     index criteria.
 714  *   - Return NULL if the capability not matched on security instance.
 715  */
 716 const struct rte_security_capability *
 717 rte_security_capability_get(struct rte_security_ctx *instance,
 718                             struct rte_security_capability_idx *idx);
 719
 720 #ifdef __cplusplus
 721 }
 722 #endif
 723
 724 #endif /* _RTE_SECURITY_H_ */