DPDK  18.11.6
rte_security.h
Go to the documentation of this file.
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 
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 
39 };
40 
47 };
48 
55 };
56 
67  void *device;
69  const struct rte_security_ops *ops;
71  uint16_t sess_cnt;
73 };
74 
84  union {
85  struct {
86  struct in_addr src_ip;
88  struct in_addr dst_ip;
90  uint8_t dscp;
92  uint8_t df;
94  uint8_t ttl;
96  } ipv4;
98  struct {
99  struct in6_addr src_addr;
101  struct in6_addr dst_addr;
103  uint8_t dscp;
105  uint32_t flabel;
107  uint8_t hlimit;
109  } ipv6;
111  };
112 };
113 
123  uint32_t esn : 1;
124 
131  uint32_t udp_encap : 1;
132 
140  uint32_t copy_dscp : 1;
141 
148  uint32_t copy_flabel : 1;
149 
156  uint32_t copy_df : 1;
157 
165  uint32_t dec_ttl : 1;
166 };
167 
174 };
175 
182  uint32_t spi;
184  uint32_t salt;
196  uint64_t esn_soft_limit;
198 };
199 
205  int dummy;
206 };
207 
214 };
215 
220 };
221 
234 };
235 
242  int8_t bearer;
246  uint8_t en_ordering;
261  uint32_t hfn;
263  uint32_t hfn_threshold;
264 };
265 
284 };
285 
294 };
295 
305  union {
306  struct rte_security_ipsec_xform ipsec;
307  struct rte_security_macsec_xform macsec;
308  struct rte_security_pdcp_xform pdcp;
309  };
313  void *userdata;
315 };
316 
317 struct rte_security_session {
318  void *sess_private_data;
320 };
321 
332 struct rte_security_session *
334  struct rte_security_session_conf *conf,
335  struct rte_mempool *mp);
336 
347 int __rte_experimental
349  struct rte_security_session *sess,
350  struct rte_security_session_conf *conf);
351 
361 unsigned int
363 
376 int
378  struct rte_security_session *sess);
379 
393 int
395  struct rte_security_session *sess,
396  struct rte_mbuf *mb, void *params);
397 
415 void * __rte_experimental
416 rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md);
417 
424 static inline int
426  struct rte_security_session *sess)
427 {
428  sym_op->sec_session = sess;
429 
430  return 0;
431 }
432 
433 static inline void *
434 get_sec_session_private_data(const struct rte_security_session *sess)
435 {
436  return sess->sess_private_data;
437 }
438 
439 static inline void
440 set_sec_session_private_data(struct rte_security_session *sess,
441  void *private_data)
442 {
443  sess->sess_private_data = private_data;
444 }
445 
455 static inline int
457  struct rte_security_session *sess)
458 {
460  return -EINVAL;
461 
463 
464  return __rte_security_attach_session(op->sym, sess);
465 }
466 
467 struct rte_security_macsec_stats {
468  uint64_t reserved;
469 };
470 
471 struct rte_security_ipsec_stats {
472  uint64_t reserved;
473 
474 };
475 
476 struct rte_security_pdcp_stats {
477  uint64_t reserved;
478 };
479 
480 struct rte_security_stats {
481  enum rte_security_session_protocol protocol;
485  union {
486  struct rte_security_macsec_stats macsec;
487  struct rte_security_ipsec_stats ipsec;
488  struct rte_security_pdcp_stats pdcp;
489  };
490 };
491 
502 int __rte_experimental
504  struct rte_security_session *sess,
505  struct rte_security_stats *stats);
506 
516  union {
517  struct {
526  } ipsec;
528  struct {
529  /* To be Filled */
530  int dummy;
531  } macsec;
533  struct {
536  uint32_t capa_flags;
538  } pdcp;
540  };
541 
545  uint32_t ol_flags;
547 };
548 
554 #define RTE_SECURITY_PDCP_ORDERING_CAP 0x00000001
555 
560 #define RTE_SECURITY_PDCP_DUP_DETECT_CAP 0x00000002
561 
562 #define RTE_SECURITY_TX_OLOAD_NEED_MDATA 0x00000001
563 
566 #define RTE_SECURITY_TX_HW_TRAILER_OFFLOAD 0x00000002
567 
572 #define RTE_SECURITY_RX_HW_TRAILER_OFFLOAD 0x00010000
573 
585  enum rte_security_session_protocol protocol;
586 
588  union {
589  struct {
591  enum rte_security_ipsec_sa_mode mode;
592  enum rte_security_ipsec_sa_direction direction;
593  } ipsec;
594  struct {
595  enum rte_security_pdcp_domain domain;
596  uint32_t capa_flags;
597  } pdcp;
598  };
599 };
600 
610 const struct rte_security_capability *
612 
624 const struct rte_security_capability *
626  struct rte_security_capability_idx *idx);
627 
628 #ifdef __cplusplus
629 }
630 #endif
631 
632 #endif /* _RTE_SECURITY_H_ */
rte_security_pdcp_direction
rte_security_pdcp_direction
Definition: rte_security.h:217
rte_security_ctx::device
void * device
Definition: rte_security.h:67
rte_security_ipsec_tunnel_param::hlimit
uint8_t hlimit
Definition: rte_security.h:107
RTE_SECURITY_IPSEC_SA_DIR_INGRESS
@ RTE_SECURITY_IPSEC_SA_DIR_INGRESS
Definition: rte_security.h:172
RTE_CRYPTO_OP_SECURITY_SESSION
@ RTE_CRYPTO_OP_SECURITY_SESSION
Definition: rte_crypto.h:65
rte_security_capability
Definition: rte_security.h:510
rte_security_session_protocol
rte_security_session_protocol
Definition: rte_security.h:287
rte_security_capabilities_get
const struct rte_security_capability * rte_security_capabilities_get(struct rte_security_ctx *instance)
rte_security_ipsec_sa_options::copy_dscp
uint32_t copy_dscp
Definition: rte_security.h:140
rte_security_pdcp_xform::bearer
int8_t bearer
Definition: rte_security.h:242
rte_security_pdcp_xform::hfn
uint32_t hfn
Definition: rte_security.h:261
RTE_SECURITY_PROTOCOL_PDCP
@ RTE_SECURITY_PROTOCOL_PDCP
Definition: rte_security.h:292
rte_memory.h
rte_security_macsec_xform::dummy
int dummy
Definition: rte_security.h:205
rte_security_capability::ol_flags
uint32_t ol_flags
Definition: rte_security.h:545
rte_security_session_action_type
rte_security_session_action_type
Definition: rte_security.h:269
rte_cryptodev_capabilities
Definition: rte_cryptodev.h:176
rte_security_ipsec_sa_options::dec_ttl
uint32_t dec_ttl
Definition: rte_security.h:165
RTE_SECURITY_IPSEC_SA_DIR_EGRESS
@ RTE_SECURITY_IPSEC_SA_DIR_EGRESS
Definition: rte_security.h:170
unlikely
#define unlikely(x)
Definition: rte_branch_prediction.h:38
RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL
@ RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL
Definition: rte_security.h:276
rte_security_ipsec_tunnel_param::src_addr
struct in6_addr src_addr
Definition: rte_security.h:99
rte_crypto.h
rte_security_set_pkt_metadata
int rte_security_set_pkt_metadata(struct rte_security_ctx *instance, struct rte_security_session *sess, struct rte_mbuf *mb, void *params)
rte_security_macsec_xform
Definition: rte_security.h:203
RTE_SECURITY_PDCP_SN_SIZE_12
@ RTE_SECURITY_PDCP_SN_SIZE_12
Definition: rte_security.h:229
rte_security_ipsec_sa_direction
rte_security_ipsec_sa_direction
Definition: rte_security.h:169
rte_security_pdcp_sn_size
rte_security_pdcp_sn_size
Definition: rte_security.h:223
rte_security_pdcp_xform::pkt_dir
enum rte_security_pdcp_direction pkt_dir
Definition: rte_security.h:255
rte_security_ipsec_tunnel_param
Definition: rte_security.h:80
rte_security_ipsec_sa_options
Definition: rte_security.h:117
RTE_SECURITY_PDCP_MODE_CONTROL
@ RTE_SECURITY_PDCP_MODE_CONTROL
Definition: rte_security.h:212
rte_security_ipsec_xform::mode
enum rte_security_ipsec_sa_mode mode
Definition: rte_security.h:192
rte_security_ctx
Definition: rte_security.h:66
RTE_SECURITY_IPSEC_SA_MODE_TUNNEL
@ RTE_SECURITY_IPSEC_SA_MODE_TUNNEL
Definition: rte_security.h:37
rte_security_session_destroy
int rte_security_session_destroy(struct rte_security_ctx *instance, struct rte_security_session *sess)
rte_security_get_userdata
void *__rte_experimental rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md)
RTE_SECURITY_IPSEC_SA_PROTO_AH
@ RTE_SECURITY_IPSEC_SA_PROTO_AH
Definition: rte_security.h:43
rte_security_session_conf::crypto_xform
struct rte_crypto_sym_xform * crypto_xform
Definition: rte_security.h:311
rte_security_ipsec_tunnel_param::ttl
uint8_t ttl
Definition: rte_security.h:94
rte_mbuf
Definition: rte_mbuf.h:478
RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO
@ RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO
Definition: rte_security.h:272
rte_security_pdcp_xform::en_ordering
uint8_t en_ordering
Definition: rte_security.h:246
rte_security_session_conf::userdata
void * userdata
Definition: rte_security.h:313
rte_security_ipsec_sa_mode
rte_security_ipsec_sa_mode
Definition: rte_security.h:34
rte_security_ipsec_xform::spi
uint32_t spi
Definition: rte_security.h:182
rte_crypto_op
Definition: rte_crypto.h:78
rte_security_ipsec_sa_options::copy_df
uint32_t copy_df
Definition: rte_security.h:156
rte_security_ipsec_tunnel_type
rte_security_ipsec_tunnel_type
Definition: rte_security.h:50
RTE_SECURITY_IPSEC_TUNNEL_IPV4
@ RTE_SECURITY_IPSEC_TUNNEL_IPV4
Definition: rte_security.h:51
rte_security_ipsec_sa_options::udp_encap
uint32_t udp_encap
Definition: rte_security.h:131
rte_security_capability::capa_flags
uint32_t capa_flags
Definition: rte_security.h:536
rte_security_ipsec_tunnel_param::src_ip
struct in_addr src_ip
Definition: rte_security.h:86
rte_security_ipsec_xform::salt
uint32_t salt
Definition: rte_security.h:184
rte_security_session_conf::action_type
enum rte_security_session_action_type action_type
Definition: rte_security.h:300
rte_security_capability::crypto_capabilities
const struct rte_cryptodev_capabilities * crypto_capabilities
Definition: rte_security.h:542
rte_security_pdcp_xform::sn_size
enum rte_security_pdcp_sn_size sn_size
Definition: rte_security.h:257
rte_security_capability::action
enum rte_security_session_action_type action
Definition: rte_security.h:511
__rte_security_attach_session
static int __rte_security_attach_session(struct rte_crypto_sym_op *sym_op, struct rte_security_session *sess)
Definition: rte_security.h:425
rte_crypto_op::sym
struct rte_crypto_sym_op sym[0]
Definition: rte_crypto.h:118
rte_security_ipsec_sa_options::copy_flabel
uint32_t copy_flabel
Definition: rte_security.h:148
rte_security_ops
Definition: rte_security_driver.h:136
rte_security_ctx::sess_cnt
uint16_t sess_cnt
Definition: rte_security.h:71
rte_security_capability::options
struct rte_security_ipsec_sa_options options
Definition: rte_security.h:524
rte_security_session_update
int __rte_experimental rte_security_session_update(struct rte_security_ctx *instance, struct rte_security_session *sess, struct rte_security_session_conf *conf)
rte_security_capability_idx
Definition: rte_security.h:583
RTE_SECURITY_PDCP_UPLINK
@ RTE_SECURITY_PDCP_UPLINK
Definition: rte_security.h:218
RTE_SECURITY_PDCP_SN_SIZE_18
@ RTE_SECURITY_PDCP_SN_SIZE_18
Definition: rte_security.h:233
rte_security_ipsec_xform::esn_soft_limit
uint64_t esn_soft_limit
Definition: rte_security.h:196
rte_crypto_sym_op::sec_session
struct rte_security_session * sec_session
Definition: rte_crypto_sym.h:500
RTE_SECURITY_PDCP_DOWNLINK
@ RTE_SECURITY_PDCP_DOWNLINK
Definition: rte_security.h:219
rte_security_ipsec_sa_options::esn
uint32_t esn
Definition: rte_security.h:123
rte_common.h
rte_security_ipsec_tunnel_param::dscp
uint8_t dscp
Definition: rte_security.h:90
RTE_SECURITY_PROTOCOL_MACSEC
@ RTE_SECURITY_PROTOCOL_MACSEC
Definition: rte_security.h:290
RTE_SECURITY_PDCP_SN_SIZE_15
@ RTE_SECURITY_PDCP_SN_SIZE_15
Definition: rte_security.h:231
rte_security_session_conf::protocol
enum rte_security_session_protocol protocol
Definition: rte_security.h:302
rte_security_capability::mode
enum rte_security_ipsec_sa_mode mode
Definition: rte_security.h:520
rte_security_ipsec_tunnel_param::type
enum rte_security_ipsec_tunnel_type type
Definition: rte_security.h:81
RTE_SECURITY_IPSEC_TUNNEL_IPV6
@ RTE_SECURITY_IPSEC_TUNNEL_IPV6
Definition: rte_security.h:53
rte_security_ipsec_xform::direction
enum rte_security_ipsec_sa_direction direction
Definition: rte_security.h:188
rte_crypto_sym_xform
Definition: rte_crypto_sym.h:442
rte_security_session_stats_get
int __rte_experimental rte_security_session_stats_get(struct rte_security_ctx *instance, struct rte_security_session *sess, struct rte_security_stats *stats)
rte_mempool
Definition: rte_mempool.h:213
rte_security_capability::domain
enum rte_security_pdcp_domain domain
Definition: rte_security.h:534
rte_security_pdcp_xform
Definition: rte_security.h:241
rte_security_ipsec_xform::options
struct rte_security_ipsec_sa_options options
Definition: rte_security.h:186
RTE_CRYPTO_OP_TYPE_SYMMETRIC
@ RTE_CRYPTO_OP_TYPE_SYMMETRIC
Definition: rte_crypto.h:32
rte_security_ipsec_tunnel_param::ipv4
struct rte_security_ipsec_tunnel_param::@226::@228 ipv4
RTE_STD_C11
#define RTE_STD_C11
Definition: rte_common.h:37
RTE_SECURITY_PDCP_SN_SIZE_5
@ RTE_SECURITY_PDCP_SN_SIZE_5
Definition: rte_security.h:225
rte_security_capability::protocol
enum rte_security_session_protocol protocol
Definition: rte_security.h:513
rte_security_ipsec_tunnel_param::ipv6
struct rte_security_ipsec_tunnel_param::@226::@229 ipv6
rte_mempool.h
RTE_SECURITY_PROTOCOL_IPSEC
@ RTE_SECURITY_PROTOCOL_IPSEC
Definition: rte_security.h:288
rte_crypto_op::sess_type
uint8_t sess_type
Definition: rte_crypto.h:94
rte_security_ipsec_tunnel_param::flabel
uint32_t flabel
Definition: rte_security.h:105
RTE_SECURITY_IPSEC_SA_PROTO_ESP
@ RTE_SECURITY_IPSEC_SA_PROTO_ESP
Definition: rte_security.h:45
rte_security_capability::macsec
struct rte_security_capability::@234::@237 macsec
rte_security_capability::ipsec
struct rte_security_capability::@234::@236 ipsec
rte_security_pdcp_xform::domain
enum rte_security_pdcp_domain domain
Definition: rte_security.h:253
rte_mbuf.h
RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL
@ RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL
Definition: rte_security.h:280
RTE_SECURITY_PDCP_MODE_DATA
@ RTE_SECURITY_PDCP_MODE_DATA
Definition: rte_security.h:213
rte_security_session_create
struct rte_security_session * rte_security_session_create(struct rte_security_ctx *instance, struct rte_security_session_conf *conf, struct rte_mempool *mp)
rte_security_ctx::ops
const struct rte_security_ops * ops
Definition: rte_security.h:69
rte_security_ipsec_xform::proto
enum rte_security_ipsec_sa_protocol proto
Definition: rte_security.h:190
rte_security_ipsec_tunnel_param::dst_addr
struct in6_addr dst_addr
Definition: rte_security.h:101
rte_security_ipsec_xform::tunnel
struct rte_security_ipsec_tunnel_param tunnel
Definition: rte_security.h:194
rte_crypto_op::type
uint8_t type
Definition: rte_crypto.h:84
rte_security_session_conf
Definition: rte_security.h:299
RTE_SECURITY_PDCP_SN_SIZE_7
@ RTE_SECURITY_PDCP_SN_SIZE_7
Definition: rte_security.h:227
rte_security_capability::pdcp
struct rte_security_capability::@234::@238 pdcp
rte_security_capability::direction
enum rte_security_ipsec_sa_direction direction
Definition: rte_security.h:522
rte_security_pdcp_xform::hfn_threshold
uint32_t hfn_threshold
Definition: rte_security.h:263
rte_security_pdcp_xform::remove_duplicates
uint8_t remove_duplicates
Definition: rte_security.h:251
rte_security_capability::proto
enum rte_security_ipsec_sa_protocol proto
Definition: rte_security.h:518
rte_security_ipsec_sa_protocol
rte_security_ipsec_sa_protocol
Definition: rte_security.h:42
rte_security_pdcp_domain
rte_security_pdcp_domain
Definition: rte_security.h:211
rte_security_ipsec_tunnel_param::df
uint8_t df
Definition: rte_security.h:92
rte_crypto_sym_op
Definition: rte_crypto_sym.h:490
rte_security_capability_get
const struct rte_security_capability * rte_security_capability_get(struct rte_security_ctx *instance, struct rte_security_capability_idx *idx)
rte_security_session_get_size
unsigned int rte_security_session_get_size(struct rte_security_ctx *instance)
rte_security_ipsec_xform
Definition: rte_security.h:181
RTE_SECURITY_ACTION_TYPE_NONE
@ RTE_SECURITY_ACTION_TYPE_NONE
Definition: rte_security.h:270
RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT
@ RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT
Definition: rte_security.h:35
rte_security_attach_session
static int rte_security_attach_session(struct rte_crypto_op *op, struct rte_security_session *sess)
Definition: rte_security.h:456
rte_security_ipsec_tunnel_param::dst_ip
struct in_addr dst_ip
Definition: rte_security.h:88