examples/ipsec-secgw/ipsec.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016-2017 Intel Corporation
   3  */
   4
   5 #ifndef __IPSEC_H__
   6 #define __IPSEC_H__
   7
   8 #include <stdint.h>
   9
  10 #include <rte_byteorder.h>
  11 #include <rte_crypto.h>
  12 #include <rte_security.h>
  13 #include <rte_flow.h>
  14 #include <rte_ipsec.h>
  15
  16 #define RTE_LOGTYPE_IPSEC       RTE_LOGTYPE_USER1
  17 #define RTE_LOGTYPE_IPSEC_ESP   RTE_LOGTYPE_USER2
  18 #define RTE_LOGTYPE_IPSEC_IPIP  RTE_LOGTYPE_USER3
  19
  20 #define MAX_PKT_BURST 32
  21 #define MAX_INFLIGHT 128
  22 #define MAX_QP_PER_LCORE 256
  23
  24 #define MAX_DIGEST_SIZE 32 /* Bytes -- 256 bits */
  25
  26 #define IPSEC_OFFLOAD_ESN_SOFTLIMIT 0xffffff00
  27
  28 #define IV_OFFSET               (sizeof(struct rte_crypto_op) + \
  29                                 sizeof(struct rte_crypto_sym_op))
  30
  31 #define uint32_t_to_char(ip, a, b, c, d) do {\
  32                 *a = (uint8_t)(ip >> 24 & 0xff);\
  33                 *b = (uint8_t)(ip >> 16 & 0xff);\
  34                 *c = (uint8_t)(ip >> 8 & 0xff);\
  35                 *d = (uint8_t)(ip & 0xff);\
  36         } while (0)
  37
  38 #define DEFAULT_MAX_CATEGORIES  1
  39
  40 #define INVALID_SPI (0)
  41
  42 #define DISCARD INVALID_SPI
  43 #define BYPASS  UINT32_MAX
  44
  45 #define IPSEC_XFORM_MAX 2
  46
  47 #define IP6_VERSION (6)
  48
  49 struct rte_crypto_xform;
  50 struct ipsec_xform;
  51 struct rte_mbuf;
  52
  53 struct ipsec_sa;
  54 /*
  55  * Keeps number of configured SA's for each address family:
  56  */
  57 struct ipsec_sa_cnt {
  58         uint32_t        nb_v4;
  59         uint32_t        nb_v6;
  60 };
  61
  62 typedef int32_t (*ipsec_xform_fn)(struct rte_mbuf *m, struct ipsec_sa *sa,
  63                 struct rte_crypto_op *cop);
  64
  65 struct ip_addr {
  66         union {
  67                 uint32_t ip4;
  68                 union {
  69                         uint64_t ip6[2];
  70                         uint8_t ip6_b[16];
  71                 } ip6;
  72         } ip;
  73 };
  74
  75 #define MAX_KEY_SIZE            32
  76
  77 /*
  78  * application wide SA parameters
  79  */
  80 struct app_sa_prm {
  81         uint32_t enable; /* use librte_ipsec API for ipsec pkt processing */
  82         uint32_t window_size; /* replay window size */
  83         uint32_t enable_esn;  /* enable/disable ESN support */
  84         uint32_t cache_sz;      /* per lcore SA cache size */
  85         uint64_t flags;       /* rte_ipsec_sa_prm.flags */
  86 };
  87
  88 extern struct app_sa_prm app_sa_prm;
  89
  90 struct flow_info {
  91         struct rte_flow *rx_def_flow;
  92 };
  93
  94 extern struct flow_info flow_info_tbl[RTE_MAX_ETHPORTS];
  95
  96 enum {
  97         IPSEC_SESSION_PRIMARY = 0,
  98         IPSEC_SESSION_FALLBACK = 1,
  99         IPSEC_SESSION_MAX
 100 };
 101
 102 #define IPSEC_SA_OFFLOAD_FALLBACK_FLAG (1)
 103
 104 static inline struct ipsec_sa *
 105 ipsec_mask_saptr(void *ptr)
 106 {
 107         uintptr_t i = (uintptr_t)ptr;
 108         static const uintptr_t mask = IPSEC_SA_OFFLOAD_FALLBACK_FLAG;
 109
 110         i &= ~mask;
 111
 112         return (struct ipsec_sa *)i;
 113 }
 114
 115 struct ipsec_sa {
 116         struct rte_ipsec_session sessions[IPSEC_SESSION_MAX];
 117         uint32_t spi;
 118         uint32_t cdev_id_qp;
 119         uint64_t seq;
 120         uint32_t salt;
 121         uint32_t fallback_sessions;
 122         enum rte_crypto_cipher_algorithm cipher_algo;
 123         enum rte_crypto_auth_algorithm auth_algo;
 124         enum rte_crypto_aead_algorithm aead_algo;
 125         uint16_t digest_len;
 126         uint16_t iv_len;
 127         uint16_t block_size;
 128         uint16_t flags;
 129 #define IP4_TUNNEL (1 << 0)
 130 #define IP6_TUNNEL (1 << 1)
 131 #define TRANSPORT  (1 << 2)
 132 #define IP4_TRANSPORT (1 << 3)
 133 #define IP6_TRANSPORT (1 << 4)
 134         struct ip_addr src;
 135         struct ip_addr dst;
 136         uint8_t cipher_key[MAX_KEY_SIZE];
 137         uint16_t cipher_key_len;
 138         uint8_t auth_key[MAX_KEY_SIZE];
 139         uint16_t auth_key_len;
 140         uint16_t aad_len;
 141         union {
 142                 struct rte_crypto_sym_xform *xforms;
 143                 struct rte_security_ipsec_xform *sec_xform;
 144         };
 145         enum rte_security_ipsec_sa_direction direction;
 146         uint16_t portid;
 147
 148 #define MAX_RTE_FLOW_PATTERN (4)
 149 #define MAX_RTE_FLOW_ACTIONS (3)
 150         struct rte_flow_item pattern[MAX_RTE_FLOW_PATTERN];
 151         struct rte_flow_action action[MAX_RTE_FLOW_ACTIONS];
 152         struct rte_flow_attr attr;
 153         union {
 154                 struct rte_flow_item_ipv4 ipv4_spec;
 155                 struct rte_flow_item_ipv6 ipv6_spec;
 156         };
 157         struct rte_flow_item_esp esp_spec;
 158         struct rte_flow *flow;
 159         struct rte_security_session_conf sess_conf;
 160 } __rte_cache_aligned;
 161
 162 struct ipsec_mbuf_metadata {
 163         struct ipsec_sa *sa;
 164         struct rte_crypto_op cop;
 165         struct rte_crypto_sym_op sym_cop;
 166         uint8_t buf[32];
 167 } __rte_cache_aligned;
 168
 169 #define IS_TRANSPORT(flags) ((flags) & TRANSPORT)
 170
 171 #define IS_TUNNEL(flags) ((flags) & (IP4_TUNNEL | IP6_TUNNEL))
 172
 173 #define IS_IP4(flags) ((flags) & (IP4_TUNNEL | IP4_TRANSPORT))
 174
 175 #define IS_IP6(flags) ((flags) & (IP6_TUNNEL | IP6_TRANSPORT))
 176
 177 #define IS_IP4_TUNNEL(flags) ((flags) & IP4_TUNNEL)
 178
 179 #define IS_IP6_TUNNEL(flags) ((flags) & IP6_TUNNEL)
 180
 181 /*
 182  * Macro for getting ipsec_sa flags statuses without version of protocol
 183  * used for transport (IP4_TRANSPORT and IP6_TRANSPORT flags).
 184  */
 185 #define WITHOUT_TRANSPORT_VERSION(flags) \
 186                 ((flags) & (IP4_TUNNEL | \
 187                         IP6_TUNNEL | \
 188                         TRANSPORT))
 189
 190 struct cdev_qp {
 191         uint16_t id;
 192         uint16_t qp;
 193         uint16_t in_flight;
 194         uint16_t len;
 195         struct rte_crypto_op *buf[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
 196 };
 197
 198 struct ipsec_ctx {
 199         struct rte_hash *cdev_map;
 200         struct sp_ctx *sp4_ctx;
 201         struct sp_ctx *sp6_ctx;
 202         struct sa_ctx *sa_ctx;
 203         uint16_t nb_qps;
 204         uint16_t last_qp;
 205         struct cdev_qp tbl[MAX_QP_PER_LCORE];
 206         struct rte_mempool *session_pool;
 207         struct rte_mempool *session_priv_pool;
 208         struct rte_mbuf *ol_pkts[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
 209         uint16_t ol_pkts_cnt;
 210         uint64_t ipv4_offloads;
 211         uint64_t ipv6_offloads;
 212 };
 213
 214 struct cdev_key {
 215         uint16_t lcore_id;
 216         uint8_t cipher_algo;
 217         uint8_t auth_algo;
 218         uint8_t aead_algo;
 219 };
 220
 221 struct socket_ctx {
 222         struct sa_ctx *sa_in;
 223         struct sa_ctx *sa_out;
 224         struct sp_ctx *sp_ip4_in;
 225         struct sp_ctx *sp_ip4_out;
 226         struct sp_ctx *sp_ip6_in;
 227         struct sp_ctx *sp_ip6_out;
 228         struct rt_ctx *rt_ip4;
 229         struct rt_ctx *rt_ip6;
 230         struct rte_mempool *mbuf_pool;
 231         struct rte_mempool *mbuf_pool_indir;
 232         struct rte_mempool *session_pool;
 233         struct rte_mempool *session_priv_pool;
 234 };
 235
 236 struct cnt_blk {
 237         uint32_t salt;
 238         uint64_t iv;
 239         uint32_t cnt;
 240 } __attribute__((packed));
 241
 242 struct traffic_type {
 243         const uint8_t *data[MAX_PKT_BURST * 2];
 244         struct rte_mbuf *pkts[MAX_PKT_BURST * 2];
 245         void *saptr[MAX_PKT_BURST * 2];
 246         uint32_t res[MAX_PKT_BURST * 2];
 247         uint32_t num;
 248 };
 249
 250 struct ipsec_traffic {
 251         struct traffic_type ipsec;
 252         struct traffic_type ip4;
 253         struct traffic_type ip6;
 254 };
 255
 256 uint16_t
 257 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
 258                 uint16_t nb_pkts, uint16_t len);
 259
 260 uint16_t
 261 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
 262                 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len);
 263
 264 uint16_t
 265 ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
 266                 uint16_t len);
 267
 268 uint16_t
 269 ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
 270                 uint16_t len);
 271
 272 void
 273 ipsec_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
 274
 275 void
 276 ipsec_cqp_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
 277
 278 static inline uint16_t
 279 ipsec_metadata_size(void)
 280 {
 281         return sizeof(struct ipsec_mbuf_metadata);
 282 }
 283
 284 static inline struct ipsec_mbuf_metadata *
 285 get_priv(struct rte_mbuf *m)
 286 {
 287         return rte_mbuf_to_priv(m);
 288 }
 289
 290 static inline void *
 291 get_cnt_blk(struct rte_mbuf *m)
 292 {
 293         struct ipsec_mbuf_metadata *priv = get_priv(m);
 294
 295         return &priv->buf[0];
 296 }
 297
 298 static inline void *
 299 get_aad(struct rte_mbuf *m)
 300 {
 301         struct ipsec_mbuf_metadata *priv = get_priv(m);
 302
 303         return &priv->buf[16];
 304 }
 305
 306 static inline void *
 307 get_sym_cop(struct rte_crypto_op *cop)
 308 {
 309         return (cop + 1);
 310 }
 311
 312 static inline struct rte_ipsec_session *
 313 ipsec_get_primary_session(struct ipsec_sa *sa)
 314 {
 315         return &sa->sessions[IPSEC_SESSION_PRIMARY];
 316 }
 317
 318 static inline struct rte_ipsec_session *
 319 ipsec_get_fallback_session(struct ipsec_sa *sa)
 320 {
 321         return &sa->sessions[IPSEC_SESSION_FALLBACK];
 322 }
 323
 324 static inline enum rte_security_session_action_type
 325 ipsec_get_action_type(struct ipsec_sa *sa)
 326 {
 327         struct rte_ipsec_session *ips;
 328         ips = ipsec_get_primary_session(sa);
 329         return ips->type;
 330 }
 331
 332 int
 333 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx);
 334
 335 void
 336 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
 337                 void *sa[], uint16_t nb_pkts);
 338
 339 void
 340 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
 341                 void *sa[], uint16_t nb_pkts);
 342
 343 void
 344 sp4_init(struct socket_ctx *ctx, int32_t socket_id);
 345
 346 void
 347 sp6_init(struct socket_ctx *ctx, int32_t socket_id);
 348
 349 /*
 350  * Search through SP rules for given SPI.
 351  * Returns first rule index if found(greater or equal then zero),
 352  * or -ENOENT otherwise.
 353  */
 354 int
 355 sp4_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
 356                         uint32_t mask[2]);
 357 int
 358 sp6_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
 359                         uint32_t mask[2]);
 360
 361 /*
 362  * Search through SA entries for given SPI.
 363  * Returns first entry index if found(greater or equal then zero),
 364  * or -ENOENT otherwise.
 365  */
 366 int
 367 sa_spi_present(struct sa_ctx *sa_ctx, uint32_t spi, int inbound);
 368
 369 void
 370 sa_init(struct socket_ctx *ctx, int32_t socket_id);
 371
 372 void
 373 rt_init(struct socket_ctx *ctx, int32_t socket_id);
 374
 375 int
 376 sa_check_offloads(uint16_t port_id, uint64_t *rx_offloads,
 377                 uint64_t *tx_offloads);
 378
 379 int
 380 add_dst_ethaddr(uint16_t port, const struct rte_ether_addr *addr);
 381
 382 void
 383 enqueue_cop_burst(struct cdev_qp *cqp);
 384
 385 int
 386 create_lookaside_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa,
 387                 struct rte_ipsec_session *ips);
 388
 389 int
 390 create_inline_session(struct socket_ctx *skt_ctx, struct ipsec_sa *sa,
 391                 struct rte_ipsec_session *ips);
 392
 393 #endif /* __IPSEC_H__ */