1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2017,2019 NXP
3 * Copyright(c) 2017 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 <netinet/in.h>
23 #include <netinet/ip.h>
24 #include <netinet/ip6.h>
26 #include <rte_compat.h>
27 #include <rte_common.h>
28 #include <rte_crypto.h>
30 #include <rte_memory.h>
31 #include <rte_mempool.h>
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 */
42 enum rte_security_ipsec_sa_protocol {
43 RTE_SECURITY_IPSEC_SA_PROTO_AH = 1,
45 RTE_SECURITY_IPSEC_SA_PROTO_ESP,
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 */
58 * Security context for crypto/eth devices
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.
66 struct rte_security_ctx {
68 /**< Crypto/ethernet device attached */
69 const struct rte_security_ops *ops;
70 /**< Pointer to security ops for the device */
72 /**< Number of sessions attached to this context */
76 * IPSEC tunnel parameters
78 * These parameters are used to build outbound tunnel headers.
80 struct rte_security_ipsec_tunnel_param {
81 enum rte_security_ipsec_tunnel_type type;
82 /**< Tunnel type: IPv4 or IPv6 */
86 struct in_addr src_ip;
87 /**< IPv4 source address */
88 struct in_addr dst_ip;
89 /**< IPv4 destination address */
91 /**< IPv4 Differentiated Services Code Point */
93 /**< IPv4 Don't Fragment bit */
95 /**< IPv4 Time To Live */
97 /**< IPv4 header parameters */
99 struct in6_addr src_addr;
100 /**< IPv6 source address */
101 struct in6_addr dst_addr;
102 /**< IPv6 destination address */
104 /**< IPv6 Differentiated Services Code Point */
106 /**< IPv6 flow label */
108 /**< IPv6 hop limit */
110 /**< IPv6 header parameters */
115 * IPsec Security Association option flags
117 struct rte_security_ipsec_sa_options {
118 /** Extended Sequence Numbers (ESN)
120 * * 1: Use extended (64 bit) sequence numbers
121 * * 0: Use normal sequence numbers
125 /** UDP encapsulation
127 * * 1: Do UDP encapsulation/decapsulation so that IPSEC packets can
128 * traverse through NAT boxes.
129 * * 0: No UDP encapsulation
131 uint32_t udp_encap : 1;
135 * * 1: Copy IPv4 or IPv6 DSCP bits from inner IP header to
136 * the outer IP header in encapsulation, and vice versa in
138 * * 0: Do not change DSCP field.
140 uint32_t copy_dscp : 1;
142 /** Copy IPv6 Flow Label
144 * * 1: Copy IPv6 flow label from inner IPv6 header to the
146 * * 0: Outer header is not modified.
148 uint32_t copy_flabel : 1;
150 /** Copy IPv4 Don't Fragment bit
152 * * 1: Copy the DF bit from the inner IPv4 header to the outer
154 * * 0: Outer header is not modified.
156 uint32_t copy_df : 1;
158 /** Decrement inner packet Time To Live (TTL) field
160 * * 1: In tunnel mode, decrement inner packet IPv4 TTL or
161 * IPv6 Hop Limit after tunnel decapsulation, or before tunnel
163 * * 0: Inner packet is not modified.
165 uint32_t dec_ttl : 1;
167 /** Explicit Congestion Notification (ECN)
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.
176 /** Security statistics
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.
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 */
194 * IPsec security association configuration data.
196 * This structure contains data required to create an IPsec SA security session.
198 struct rte_security_ipsec_xform {
200 /**< SA security parameter index */
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 */
218 * MACsec security session configuration
220 struct rte_security_macsec_xform {
226 * PDCP Mode of session
228 enum rte_security_pdcp_domain {
229 RTE_SECURITY_PDCP_MODE_CONTROL, /**< PDCP control plane */
230 RTE_SECURITY_PDCP_MODE_DATA, /**< PDCP data plane */
233 /** PDCP Frame direction */
234 enum rte_security_pdcp_direction {
235 RTE_SECURITY_PDCP_UPLINK, /**< Uplink */
236 RTE_SECURITY_PDCP_DOWNLINK, /**< Downlink */
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
254 * PDCP security association configuration data.
256 * This structure contains data required to create a PDCP security session.
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.
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.
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
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.
293 * Security session action type.
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
302 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL,
303 /**< All security protocol processing is performed inline during
306 RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL
307 /**< All security protocol processing including crypto is performed
308 * on a lookaside accelerator
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 */
323 * Security session configuration
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 */
332 struct rte_security_ipsec_xform ipsec;
333 struct rte_security_macsec_xform macsec;
334 struct rte_security_pdcp_xform pdcp;
336 /**< Configuration parameters for security session */
337 struct rte_crypto_sym_xform *crypto_xform;
338 /**< Security Session Crypto Transformations */
340 /**< Application specific userdata to be saved with session */
343 struct rte_security_session {
344 void *sess_private_data;
345 /**< Private session material */
346 uint64_t opaque_data;
347 /**< Opaque user defined data */
351 * Create security session as specified by the session configuration
353 * @param instance security instance
354 * @param conf session configuration parameters
355 * @param mp mempool to allocate session objects from
357 * - On success, pointer to session
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);
366 * Update security session as specified by the session configuration
368 * @param instance security instance
369 * @param sess session to update parameters
370 * @param conf update configuration parameters
372 * - On success returns 0
373 * - On failure return errno
377 rte_security_session_update(struct rte_security_ctx *instance,
378 struct rte_security_session *sess,
379 struct rte_security_session_conf *conf);
382 * Get the size of the security session data for a device.
384 * @param instance security instance.
387 * - Size of the private data, if successful
388 * - 0 if device is invalid or does not support the operation.
391 rte_security_session_get_size(struct rte_security_ctx *instance);
394 * Free security session header and the session private data and
395 * return it to its original mempool.
397 * @param instance security instance
398 * @param sess security session to freed
402 * - -EINVAL if session is NULL.
403 * - -EBUSY if not all device private data has been freed.
406 rte_security_session_destroy(struct rte_security_ctx *instance,
407 struct rte_security_session *sess);
410 * Updates the buffer with device-specific defined metadata
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
419 * - On success, zero.
420 * - On failure, a negative value.
423 rte_security_set_pkt_metadata(struct rte_security_ctx *instance,
424 struct rte_security_session *sess,
425 struct rte_mbuf *mb, void *params);
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.
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.
437 * @param instance security instance
438 * @param md device-specific metadata
441 * - On success, userdata
446 rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md);
449 * Attach a session to a symmetric crypto operation
451 * @param sym_op crypto operation
452 * @param sess security session
455 __rte_security_attach_session(struct rte_crypto_sym_op *sym_op,
456 struct rte_security_session *sess)
458 sym_op->sec_session = sess;
464 get_sec_session_private_data(const struct rte_security_session *sess)
466 return sess->sess_private_data;
470 set_sec_session_private_data(struct rte_security_session *sess,
473 sess->sess_private_data = private_data;
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.
482 * @param op crypto operation
483 * @param sess security session
486 rte_security_attach_session(struct rte_crypto_op *op,
487 struct rte_security_session *sess)
489 if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
492 op->sess_type = RTE_CRYPTO_OP_SECURITY_SESSION;
494 return __rte_security_attach_session(op->sym, sess);
497 struct rte_security_macsec_stats {
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. */
512 struct rte_security_pdcp_stats {
516 struct rte_security_stats {
517 enum rte_security_session_protocol protocol;
518 /**< Security protocol to be configured */
522 struct rte_security_macsec_stats macsec;
523 struct rte_security_ipsec_stats ipsec;
524 struct rte_security_pdcp_stats pdcp;
529 * Get security session statistics
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
538 * - On success, return 0
539 * - On failure, a negative value
543 rte_security_session_stats_get(struct rte_security_ctx *instance,
544 struct rte_security_session *sess,
545 struct rte_security_stats *stats);
548 * Security capability definition
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 */
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 */
567 /**< IPsec capability */
572 /**< MACsec capability */
574 enum rte_security_pdcp_domain domain;
575 /**< PDCP mode of operation: Control or data */
577 /**< Capability flags, see RTE_SECURITY_PDCP_* */
579 /**< PDCP capability */
582 const struct rte_cryptodev_capabilities *crypto_capabilities;
583 /**< Corresponding crypto capabilities for security capability */
586 /**< Device offload flags */
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.
594 #define RTE_SECURITY_PDCP_ORDERING_CAP 0x00000001
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.
600 #define RTE_SECURITY_PDCP_DUP_DETECT_CAP 0x00000002
602 #define RTE_SECURITY_TX_OLOAD_NEED_MDATA 0x00000001
603 /**< HW needs metadata update, see rte_security_set_pkt_metadata().
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.
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.
620 * Security capability index used to query a security instance for a specific
621 * security capability
623 struct rte_security_capability_idx {
624 enum rte_security_session_action_type action;
625 enum rte_security_session_protocol protocol;
630 enum rte_security_ipsec_sa_protocol proto;
631 enum rte_security_ipsec_sa_mode mode;
632 enum rte_security_ipsec_sa_direction direction;
635 enum rte_security_pdcp_domain domain;
642 * Returns array of security instance capabilities
644 * @param instance Security instance.
647 * - Returns array of security capabilities.
648 * - Return NULL if no capabilities available.
650 const struct rte_security_capability *
651 rte_security_capabilities_get(struct rte_security_ctx *instance);
654 * Query if a specific capability is available on security instance
656 * @param instance security instance.
657 * @param idx security capability index to match against
660 * - Returns pointer to security capability on match of capability
662 * - Return NULL if the capability not matched on security instance.
664 const struct rte_security_capability *
665 rte_security_capability_get(struct rte_security_ctx *instance,
666 struct rte_security_capability_idx *idx);
672 #endif /* _RTE_SECURITY_H_ */