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 15 #define RTE_LOGTYPE_IPSEC RTE_LOGTYPE_USER1 16 #define RTE_LOGTYPE_IPSEC_ESP RTE_LOGTYPE_USER2 17 #define RTE_LOGTYPE_IPSEC_IPIP RTE_LOGTYPE_USER3 18 19 #define MAX_PKT_BURST 32 20 #define MAX_INFLIGHT 128 21 #define MAX_QP_PER_LCORE 256 22 23 #define MAX_DIGEST_SIZE 32 /* Bytes -- 256 bits */ 24 25 #define IPSEC_OFFLOAD_ESN_SOFTLIMIT 0xffffff00 26 27 #define IV_OFFSET (sizeof(struct rte_crypto_op) + \ 28 sizeof(struct rte_crypto_sym_op)) 29 30 #define uint32_t_to_char(ip, a, b, c, d) do {\ 31 *a = (uint8_t)(ip >> 24 & 0xff);\ 32 *b = (uint8_t)(ip >> 16 & 0xff);\ 33 *c = (uint8_t)(ip >> 8 & 0xff);\ 34 *d = (uint8_t)(ip & 0xff);\ 35 } while (0) 36 37 #define DEFAULT_MAX_CATEGORIES 1 38 39 #define IPSEC_SA_MAX_ENTRIES (128) /* must be power of 2, max 2 power 30 */ 40 #define SPI2IDX(spi) (spi & (IPSEC_SA_MAX_ENTRIES - 1)) 41 #define INVALID_SPI (0) 42 43 #define DISCARD INVALID_SPI 44 #define BYPASS UINT32_MAX 45 46 #define IPSEC_XFORM_MAX 2 47 48 #define IP6_VERSION (6) 49 50 struct rte_crypto_xform; 51 struct ipsec_xform; 52 struct rte_mbuf; 53 54 struct ipsec_sa; 55 56 typedef int32_t (*ipsec_xform_fn)(struct rte_mbuf *m, struct ipsec_sa *sa, 57 struct rte_crypto_op *cop); 58 59 struct ip_addr { 60 union { 61 uint32_t ip4; 62 union { 63 uint64_t ip6[2]; 64 uint8_t ip6_b[16]; 65 } ip6; 66 } ip; 67 }; 68 69 #define MAX_KEY_SIZE 32 70 71 struct ipsec_sa { 72 uint32_t spi; 73 uint32_t cdev_id_qp; 74 uint64_t seq; 75 uint32_t salt; 76 union { 77 struct rte_cryptodev_sym_session *crypto_session; 78 struct rte_security_session *sec_session; 79 }; 80 enum rte_crypto_cipher_algorithm cipher_algo; 81 enum rte_crypto_auth_algorithm auth_algo; 82 enum rte_crypto_aead_algorithm aead_algo; 83 uint16_t digest_len; 84 uint16_t iv_len; 85 uint16_t block_size; 86 uint16_t flags; 87 #define IP4_TUNNEL (1 << 0) 88 #define IP6_TUNNEL (1 << 1) 89 #define TRANSPORT (1 << 2) 90 #define IP4_TRANSPORT (1 << 3) 91 #define IP6_TRANSPORT (1 << 4) 92 struct ip_addr src; 93 struct ip_addr dst; 94 uint8_t cipher_key[MAX_KEY_SIZE]; 95 uint16_t cipher_key_len; 96 uint8_t auth_key[MAX_KEY_SIZE]; 97 uint16_t auth_key_len; 98 uint16_t aad_len; 99 union { 100 struct rte_crypto_sym_xform *xforms; 101 struct rte_security_ipsec_xform *sec_xform; 102 }; 103 enum rte_security_session_action_type type; 104 enum rte_security_ipsec_sa_direction direction; 105 uint16_t portid; 106 struct rte_security_ctx *security_ctx; 107 uint32_t ol_flags; 108 109 #define MAX_RTE_FLOW_PATTERN (4) 110 #define MAX_RTE_FLOW_ACTIONS (3) 111 struct rte_flow_item pattern[MAX_RTE_FLOW_PATTERN]; 112 struct rte_flow_action action[MAX_RTE_FLOW_ACTIONS]; 113 struct rte_flow_attr attr; 114 union { 115 struct rte_flow_item_ipv4 ipv4_spec; 116 struct rte_flow_item_ipv6 ipv6_spec; 117 }; 118 struct rte_flow_item_esp esp_spec; 119 struct rte_flow *flow; 120 struct rte_security_session_conf sess_conf; 121 } __rte_cache_aligned; 122 123 struct ipsec_mbuf_metadata { 124 struct ipsec_sa *sa; 125 struct rte_crypto_op cop; 126 struct rte_crypto_sym_op sym_cop; 127 uint8_t buf[32]; 128 } __rte_cache_aligned; 129 130 #define IS_TRANSPORT(flags) ((flags) & TRANSPORT) 131 132 #define IS_TUNNEL(flags) ((flags) & (IP4_TUNNEL | IP6_TUNNEL)) 133 134 #define IS_IP4(flags) ((flags) & (IP4_TUNNEL | IP4_TRANSPORT)) 135 136 #define IS_IP6(flags) ((flags) & (IP6_TUNNEL | IP6_TRANSPORT)) 137 138 #define IS_IP4_TUNNEL(flags) ((flags) & IP4_TUNNEL) 139 140 #define IS_IP6_TUNNEL(flags) ((flags) & IP6_TUNNEL) 141 142 /* 143 * Macro for getting ipsec_sa flags statuses without version of protocol 144 * used for transport (IP4_TRANSPORT and IP6_TRANSPORT flags). 145 */ 146 #define WITHOUT_TRANSPORT_VERSION(flags) \ 147 ((flags) & (IP4_TUNNEL | \ 148 IP6_TUNNEL | \ 149 TRANSPORT)) 150 151 struct cdev_qp { 152 uint16_t id; 153 uint16_t qp; 154 uint16_t in_flight; 155 uint16_t len; 156 struct rte_crypto_op *buf[MAX_PKT_BURST] __rte_aligned(sizeof(void *)); 157 }; 158 159 struct ipsec_ctx { 160 struct rte_hash *cdev_map; 161 struct sp_ctx *sp4_ctx; 162 struct sp_ctx *sp6_ctx; 163 struct sa_ctx *sa_ctx; 164 uint16_t nb_qps; 165 uint16_t last_qp; 166 struct cdev_qp tbl[MAX_QP_PER_LCORE]; 167 struct rte_mempool *session_pool; 168 struct rte_mbuf *ol_pkts[MAX_PKT_BURST] __rte_aligned(sizeof(void *)); 169 uint16_t ol_pkts_cnt; 170 }; 171 172 struct cdev_key { 173 uint16_t lcore_id; 174 uint8_t cipher_algo; 175 uint8_t auth_algo; 176 uint8_t aead_algo; 177 }; 178 179 struct socket_ctx { 180 struct sa_ctx *sa_in; 181 struct sa_ctx *sa_out; 182 struct sp_ctx *sp_ip4_in; 183 struct sp_ctx *sp_ip4_out; 184 struct sp_ctx *sp_ip6_in; 185 struct sp_ctx *sp_ip6_out; 186 struct rt_ctx *rt_ip4; 187 struct rt_ctx *rt_ip6; 188 struct rte_mempool *mbuf_pool; 189 struct rte_mempool *session_pool; 190 }; 191 192 struct cnt_blk { 193 uint32_t salt; 194 uint64_t iv; 195 uint32_t cnt; 196 } __attribute__((packed)); 197 198 uint16_t 199 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 200 uint16_t nb_pkts, uint16_t len); 201 202 uint16_t 203 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 204 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len); 205 206 uint16_t 207 ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 208 uint16_t len); 209 210 uint16_t 211 ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 212 uint16_t len); 213 214 static inline uint16_t 215 ipsec_metadata_size(void) 216 { 217 return sizeof(struct ipsec_mbuf_metadata); 218 } 219 220 static inline struct ipsec_mbuf_metadata * 221 get_priv(struct rte_mbuf *m) 222 { 223 return rte_mbuf_to_priv(m); 224 } 225 226 static inline void * 227 get_cnt_blk(struct rte_mbuf *m) 228 { 229 struct ipsec_mbuf_metadata *priv = get_priv(m); 230 231 return &priv->buf[0]; 232 } 233 234 static inline void * 235 get_aad(struct rte_mbuf *m) 236 { 237 struct ipsec_mbuf_metadata *priv = get_priv(m); 238 239 return &priv->buf[16]; 240 } 241 242 static inline void * 243 get_sym_cop(struct rte_crypto_op *cop) 244 { 245 return (cop + 1); 246 } 247 248 int 249 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx); 250 251 void 252 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[], 253 struct ipsec_sa *sa[], uint16_t nb_pkts); 254 255 void 256 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[], 257 struct ipsec_sa *sa[], uint16_t nb_pkts); 258 259 void 260 sp4_init(struct socket_ctx *ctx, int32_t socket_id); 261 262 void 263 sp6_init(struct socket_ctx *ctx, int32_t socket_id); 264 265 /* 266 * Search through SP rules for given SPI. 267 * Returns first rule index if found(greater or equal then zero), 268 * or -ENOENT otherwise. 269 */ 270 int 271 sp4_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2], 272 uint32_t mask[2]); 273 int 274 sp6_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2], 275 uint32_t mask[2]); 276 277 /* 278 * Search through SA entries for given SPI. 279 * Returns first entry index if found(greater or equal then zero), 280 * or -ENOENT otherwise. 281 */ 282 int 283 sa_spi_present(uint32_t spi, int inbound); 284 285 void 286 sa_init(struct socket_ctx *ctx, int32_t socket_id); 287 288 void 289 rt_init(struct socket_ctx *ctx, int32_t socket_id); 290 291 void 292 enqueue_cop_burst(struct cdev_qp *cqp); 293 294 #endif /* __IPSEC_H__ */ 295