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