lib/librte_security/rte_security.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2017 NXP.
   3  * Copyright(c) 2017 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 };
 216
 217 /**
 218  * MACsec security session configuration
 219  */
 220 struct rte_security_macsec_xform {
 221         /** To be Filled */
 222         int dummy;
 223 };
 224
 225 /**
 226  * PDCP Mode of session
 227  */
 228 enum rte_security_pdcp_domain {
 229         RTE_SECURITY_PDCP_MODE_CONTROL, /**< PDCP control plane */
 230         RTE_SECURITY_PDCP_MODE_DATA,    /**< PDCP data plane */
 231 };
 232
 233 /** PDCP Frame direction */
 234 enum rte_security_pdcp_direction {
 235         RTE_SECURITY_PDCP_UPLINK,       /**< Uplink */
 236         RTE_SECURITY_PDCP_DOWNLINK,     /**< Downlink */
 237 };
 238
 239 /** PDCP Sequence Number Size selectors */
 240 enum rte_security_pdcp_sn_size {
 241         /** PDCP_SN_SIZE_5: 5bit sequence number */
 242         RTE_SECURITY_PDCP_SN_SIZE_5 = 5,
 243         /** PDCP_SN_SIZE_7: 7bit sequence number */
 244         RTE_SECURITY_PDCP_SN_SIZE_7 = 7,
 245         /** PDCP_SN_SIZE_12: 12bit sequence number */
 246         RTE_SECURITY_PDCP_SN_SIZE_12 = 12,
 247         /** PDCP_SN_SIZE_15: 15bit sequence number */
 248         RTE_SECURITY_PDCP_SN_SIZE_15 = 15,
 249         /** PDCP_SN_SIZE_18: 18bit sequence number */
 250         RTE_SECURITY_PDCP_SN_SIZE_18 = 18
 251 };
 252
 253 /**
 254  * PDCP security association configuration data.
 255  *
 256  * This structure contains data required to create a PDCP security session.
 257  */
 258 struct rte_security_pdcp_xform {
 259         int8_t bearer;  /**< PDCP bearer ID */
 260         /** Enable in order delivery, this field shall be set only if
 261          * driver/HW is capable. See RTE_SECURITY_PDCP_ORDERING_CAP.
 262          */
 263         uint8_t en_ordering;
 264         /** Notify driver/HW to detect and remove duplicate packets.
 265          * This field should be set only when driver/hw is capable.
 266          * See RTE_SECURITY_PDCP_DUP_DETECT_CAP.
 267          */
 268         uint8_t remove_duplicates;
 269         /** PDCP mode of operation: Control or data */
 270         enum rte_security_pdcp_domain domain;
 271         /** PDCP Frame Direction 0:UL 1:DL */
 272         enum rte_security_pdcp_direction pkt_dir;
 273         /** Sequence number size, 5/7/12/15/18 */
 274         enum rte_security_pdcp_sn_size sn_size;
 275         /** Starting Hyper Frame Number to be used together with the SN
 276          * from the PDCP frames
 277          */
 278         uint32_t hfn;
 279         /** HFN Threshold for key renegotiation */
 280         uint32_t hfn_threshold;
 281 };
 282
 283 /**
 284  * Security session action type.
 285  */
 286 enum rte_security_session_action_type {
 287         RTE_SECURITY_ACTION_TYPE_NONE,
 288         /**< No security actions */
 289         RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO,
 290         /**< Crypto processing for security protocol is processed inline
 291          * during transmission
 292          */
 293         RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL,
 294         /**< All security protocol processing is performed inline during
 295          * transmission
 296          */
 297         RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL
 298         /**< All security protocol processing including crypto is performed
 299          * on a lookaside accelerator
 300          */
 301 };
 302
 303 /** Security session protocol definition */
 304 enum rte_security_session_protocol {
 305         RTE_SECURITY_PROTOCOL_IPSEC = 1,
 306         /**< IPsec Protocol */
 307         RTE_SECURITY_PROTOCOL_MACSEC,
 308         /**< MACSec Protocol */
 309         RTE_SECURITY_PROTOCOL_PDCP,
 310         /**< PDCP Protocol */
 311 };
 312
 313 /**
 314  * Security session configuration
 315  */
 316 struct rte_security_session_conf {
 317         enum rte_security_session_action_type action_type;
 318         /**< Type of action to be performed on the session */
 319         enum rte_security_session_protocol protocol;
 320         /**< Security protocol to be configured */
 321         RTE_STD_C11
 322         union {
 323                 struct rte_security_ipsec_xform ipsec;
 324                 struct rte_security_macsec_xform macsec;
 325                 struct rte_security_pdcp_xform pdcp;
 326         };
 327         /**< Configuration parameters for security session */
 328         struct rte_crypto_sym_xform *crypto_xform;
 329         /**< Security Session Crypto Transformations */
 330         void *userdata;
 331         /**< Application specific userdata to be saved with session */
 332 };
 333
 334 struct rte_security_session {
 335         void *sess_private_data;
 336         /**< Private session material */
 337         uint64_t opaque_data;
 338         /**< Opaque user defined data */
 339 };
 340
 341 /**
 342  * Create security session as specified by the session configuration
 343  *
 344  * @param   instance    security instance
 345  * @param   conf        session configuration parameters
 346  * @param   mp          mempool to allocate session objects from
 347  * @return
 348  *  - On success, pointer to session
 349  *  - On failure, NULL
 350  */
 351 struct rte_security_session *
 352 rte_security_session_create(struct rte_security_ctx *instance,
 353                             struct rte_security_session_conf *conf,
 354                             struct rte_mempool *mp);
 355
 356 /**
 357  * Update security session as specified by the session configuration
 358  *
 359  * @param   instance    security instance
 360  * @param   sess        session to update parameters
 361  * @param   conf        update configuration parameters
 362  * @return
 363  *  - On success returns 0
 364  *  - On failure return errno
 365  */
 366 __rte_experimental
 367 int
 368 rte_security_session_update(struct rte_security_ctx *instance,
 369                             struct rte_security_session *sess,
 370                             struct rte_security_session_conf *conf);
 371
 372 /**
 373  * Get the size of the security session data for a device.
 374  *
 375  * @param   instance    security instance.
 376  *
 377  * @return
 378  *   - Size of the private data, if successful
 379  *   - 0 if device is invalid or does not support the operation.
 380  */
 381 unsigned int
 382 rte_security_session_get_size(struct rte_security_ctx *instance);
 383
 384 /**
 385  * Free security session header and the session private data and
 386  * return it to its original mempool.
 387  *
 388  * @param   instance    security instance
 389  * @param   sess        security session to freed
 390  *
 391  * @return
 392  *  - 0 if successful.
 393  *  - -EINVAL if session is NULL.
 394  *  - -EBUSY if not all device private data has been freed.
 395  */
 396 int
 397 rte_security_session_destroy(struct rte_security_ctx *instance,
 398                              struct rte_security_session *sess);
 399
 400 /**
 401  *  Updates the buffer with device-specific defined metadata
 402  *
 403  * @param       instance        security instance
 404  * @param       sess            security session
 405  * @param       mb              packet mbuf to set metadata on.
 406  * @param       params          device-specific defined parameters
 407  *                              required for metadata
 408  *
 409  * @return
 410  *  - On success, zero.
 411  *  - On failure, a negative value.
 412  */
 413 int
 414 rte_security_set_pkt_metadata(struct rte_security_ctx *instance,
 415                               struct rte_security_session *sess,
 416                               struct rte_mbuf *mb, void *params);
 417
 418 /**
 419  * Get userdata associated with the security session. Device specific metadata
 420  * provided would be used to uniquely identify the security session being
 421  * referred to. This userdata would be registered while creating the session,
 422  * and application can use this to identify the SA etc.
 423  *
 424  * Device specific metadata would be set in mbuf for inline processed inbound
 425  * packets. In addition, the same metadata would be set for IPsec events
 426  * reported by rte_eth_event framework.
 427  *
 428  * @param   instance    security instance
 429  * @param   md          device-specific metadata
 430  *
 431  * @return
 432  *  - On success, userdata
 433  *  - On failure, NULL
 434  */
 435 __rte_experimental
 436 void *
 437 rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md);
 438
 439 /**
 440  * Attach a session to a symmetric crypto operation
 441  *
 442  * @param       sym_op  crypto operation
 443  * @param       sess    security session
 444  */
 445 static inline int
 446 __rte_security_attach_session(struct rte_crypto_sym_op *sym_op,
 447                               struct rte_security_session *sess)
 448 {
 449         sym_op->sec_session = sess;
 450
 451         return 0;
 452 }
 453
 454 static inline void *
 455 get_sec_session_private_data(const struct rte_security_session *sess)
 456 {
 457         return sess->sess_private_data;
 458 }
 459
 460 static inline void
 461 set_sec_session_private_data(struct rte_security_session *sess,
 462                              void *private_data)
 463 {
 464         sess->sess_private_data = private_data;
 465 }
 466
 467 /**
 468  * Attach a session to a crypto operation.
 469  * This API is needed only in case of RTE_SECURITY_SESS_CRYPTO_PROTO_OFFLOAD
 470  * For other rte_security_session_action_type, ol_flags in rte_mbuf may be
 471  * defined to perform security operations.
 472  *
 473  * @param       op      crypto operation
 474  * @param       sess    security session
 475  */
 476 static inline int
 477 rte_security_attach_session(struct rte_crypto_op *op,
 478                             struct rte_security_session *sess)
 479 {
 480         if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
 481                 return -EINVAL;
 482
 483         op->sess_type =  RTE_CRYPTO_OP_SECURITY_SESSION;
 484
 485         return __rte_security_attach_session(op->sym, sess);
 486 }
 487
 488 struct rte_security_macsec_stats {
 489         uint64_t reserved;
 490 };
 491
 492 struct rte_security_ipsec_stats {
 493         uint64_t ipackets;  /**< Successfully received IPsec packets. */
 494         uint64_t opackets;  /**< Successfully transmitted IPsec packets.*/
 495         uint64_t ibytes;    /**< Successfully received IPsec bytes. */
 496         uint64_t obytes;    /**< Successfully transmitted IPsec bytes. */
 497         uint64_t ierrors;   /**< IPsec packets receive/decrypt errors. */
 498         uint64_t oerrors;   /**< IPsec packets transmit/encrypt errors. */
 499         uint64_t reserved1; /**< Reserved for future use. */
 500         uint64_t reserved2; /**< Reserved for future use. */
 501 };
 502
 503 struct rte_security_pdcp_stats {
 504         uint64_t reserved;
 505 };
 506
 507 struct rte_security_stats {
 508         enum rte_security_session_protocol protocol;
 509         /**< Security protocol to be configured */
 510
 511         RTE_STD_C11
 512         union {
 513                 struct rte_security_macsec_stats macsec;
 514                 struct rte_security_ipsec_stats ipsec;
 515                 struct rte_security_pdcp_stats pdcp;
 516         };
 517 };
 518
 519 /**
 520  * Get security session statistics
 521  *
 522  * @param       instance        security instance
 523  * @param       sess            security session
 524  * If security session is NULL then global (per security instance) statistics
 525  * will be retrieved, if supported. Global statistics collection is not
 526  * dependent on the per session statistics configuration.
 527  * @param       stats           statistics
 528  * @return
 529  *  - On success, return 0
 530  *  - On failure, a negative value
 531  */
 532 __rte_experimental
 533 int
 534 rte_security_session_stats_get(struct rte_security_ctx *instance,
 535                                struct rte_security_session *sess,
 536                                struct rte_security_stats *stats);
 537
 538 /**
 539  * Security capability definition
 540  */
 541 struct rte_security_capability {
 542         enum rte_security_session_action_type action;
 543         /**< Security action type*/
 544         enum rte_security_session_protocol protocol;
 545         /**< Security protocol */
 546         RTE_STD_C11
 547         union {
 548                 struct {
 549                         enum rte_security_ipsec_sa_protocol proto;
 550                         /**< IPsec SA protocol */
 551                         enum rte_security_ipsec_sa_mode mode;
 552                         /**< IPsec SA mode */
 553                         enum rte_security_ipsec_sa_direction direction;
 554                         /**< IPsec SA direction */
 555                         struct rte_security_ipsec_sa_options options;
 556                         /**< IPsec SA supported options */
 557                 } ipsec;
 558                 /**< IPsec capability */
 559                 struct {
 560                         /* To be Filled */
 561                         int dummy;
 562                 } macsec;
 563                 /**< MACsec capability */
 564                 struct {
 565                         enum rte_security_pdcp_domain domain;
 566                         /**< PDCP mode of operation: Control or data */
 567                         uint32_t capa_flags;
 568                         /**< Capability flags, see RTE_SECURITY_PDCP_* */
 569                 } pdcp;
 570                 /**< PDCP capability */
 571         };
 572
 573         const struct rte_cryptodev_capabilities *crypto_capabilities;
 574         /**< Corresponding crypto capabilities for security capability  */
 575
 576         uint32_t ol_flags;
 577         /**< Device offload flags */
 578 };
 579
 580 /** Underlying Hardware/driver which support PDCP may or may not support
 581  * packet ordering. Set RTE_SECURITY_PDCP_ORDERING_CAP if it support.
 582  * If it is not set, driver/HW assumes packets received are in order
 583  * and it will be application's responsibility to maintain ordering.
 584  */
 585 #define RTE_SECURITY_PDCP_ORDERING_CAP          0x00000001
 586
 587 /** Underlying Hardware/driver which support PDCP may or may not detect
 588  * duplicate packet. Set RTE_SECURITY_PDCP_DUP_DETECT_CAP if it support.
 589  * If it is not set, driver/HW assumes there is no duplicate packet received.
 590  */
 591 #define RTE_SECURITY_PDCP_DUP_DETECT_CAP        0x00000002
 592
 593 #define RTE_SECURITY_TX_OLOAD_NEED_MDATA        0x00000001
 594 /**< HW needs metadata update, see rte_security_set_pkt_metadata().
 595  */
 596
 597 #define RTE_SECURITY_TX_HW_TRAILER_OFFLOAD      0x00000002
 598 /**< HW constructs trailer of packets
 599  * Transmitted packets will have the trailer added to them
 600  * by hardware. The next protocol field will be based on
 601  * the mbuf->inner_esp_next_proto field.
 602  */
 603 #define RTE_SECURITY_RX_HW_TRAILER_OFFLOAD      0x00010000
 604 /**< HW removes trailer of packets
 605  * Received packets have no trailer, the next protocol field
 606  * is supplied in the mbuf->inner_esp_next_proto field.
 607  * Inner packet is not modified.
 608  */
 609
 610 /**
 611  * Security capability index used to query a security instance for a specific
 612  * security capability
 613  */
 614 struct rte_security_capability_idx {
 615         enum rte_security_session_action_type action;
 616         enum rte_security_session_protocol protocol;
 617
 618         RTE_STD_C11
 619         union {
 620                 struct {
 621                         enum rte_security_ipsec_sa_protocol proto;
 622                         enum rte_security_ipsec_sa_mode mode;
 623                         enum rte_security_ipsec_sa_direction direction;
 624                 } ipsec;
 625                 struct {
 626                         enum rte_security_pdcp_domain domain;
 627                         uint32_t capa_flags;
 628                 } pdcp;
 629         };
 630 };
 631
 632 /**
 633  *  Returns array of security instance capabilities
 634  *
 635  * @param       instance        Security instance.
 636  *
 637  * @return
 638  *   - Returns array of security capabilities.
 639  *   - Return NULL if no capabilities available.
 640  */
 641 const struct rte_security_capability *
 642 rte_security_capabilities_get(struct rte_security_ctx *instance);
 643
 644 /**
 645  * Query if a specific capability is available on security instance
 646  *
 647  * @param       instance        security instance.
 648  * @param       idx             security capability index to match against
 649  *
 650  * @return
 651  *   - Returns pointer to security capability on match of capability
 652  *     index criteria.
 653  *   - Return NULL if the capability not matched on security instance.
 654  */
 655 const struct rte_security_capability *
 656 rte_security_capability_get(struct rte_security_ctx *instance,
 657                             struct rte_security_capability_idx *idx);
 658
 659 #ifdef __cplusplus
 660 }
 661 #endif
 662
 663 #endif /* _RTE_SECURITY_H_ */