lib/librte_security/rte_security.h

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