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 (0x80000000) 44 #define BYPASS (0x40000000) 45 #define PROTECT_MASK (0x3fffffff) 46 #define PROTECT(sa_idx) (SPI2IDX(sa_idx) & PROTECT_MASK) /* SA idx 30 bits */ 47 48 #define IPSEC_XFORM_MAX 2 49 50 #define IP6_VERSION (6) 51 52 struct rte_crypto_xform; 53 struct ipsec_xform; 54 struct rte_mbuf; 55 56 struct ipsec_sa; 57 58 typedef int32_t (*ipsec_xform_fn)(struct rte_mbuf *m, struct ipsec_sa *sa, 59 struct rte_crypto_op *cop); 60 61 struct ip_addr { 62 union { 63 uint32_t ip4; 64 union { 65 uint64_t ip6[2]; 66 uint8_t ip6_b[16]; 67 } ip6; 68 } ip; 69 }; 70 71 #define MAX_KEY_SIZE 32 72 73 struct ipsec_sa { 74 uint32_t spi; 75 uint32_t cdev_id_qp; 76 uint64_t seq; 77 uint32_t salt; 78 union { 79 struct rte_cryptodev_sym_session *crypto_session; 80 struct rte_security_session *sec_session; 81 }; 82 enum rte_crypto_cipher_algorithm cipher_algo; 83 enum rte_crypto_auth_algorithm auth_algo; 84 enum rte_crypto_aead_algorithm aead_algo; 85 uint16_t digest_len; 86 uint16_t iv_len; 87 uint16_t block_size; 88 uint16_t flags; 89 #define IP4_TUNNEL (1 << 0) 90 #define IP6_TUNNEL (1 << 1) 91 #define TRANSPORT (1 << 2) 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 struct cdev_qp { 131 uint16_t id; 132 uint16_t qp; 133 uint16_t in_flight; 134 uint16_t len; 135 struct rte_crypto_op *buf[MAX_PKT_BURST] __rte_aligned(sizeof(void *)); 136 }; 137 138 struct ipsec_ctx { 139 struct rte_hash *cdev_map; 140 struct sp_ctx *sp4_ctx; 141 struct sp_ctx *sp6_ctx; 142 struct sa_ctx *sa_ctx; 143 uint16_t nb_qps; 144 uint16_t last_qp; 145 struct cdev_qp tbl[MAX_QP_PER_LCORE]; 146 struct rte_mempool *session_pool; 147 struct rte_mbuf *ol_pkts[MAX_PKT_BURST] __rte_aligned(sizeof(void *)); 148 uint16_t ol_pkts_cnt; 149 }; 150 151 struct cdev_key { 152 uint16_t lcore_id; 153 uint8_t cipher_algo; 154 uint8_t auth_algo; 155 uint8_t aead_algo; 156 }; 157 158 struct socket_ctx { 159 struct sa_ctx *sa_in; 160 struct sa_ctx *sa_out; 161 struct sp_ctx *sp_ip4_in; 162 struct sp_ctx *sp_ip4_out; 163 struct sp_ctx *sp_ip6_in; 164 struct sp_ctx *sp_ip6_out; 165 struct rt_ctx *rt_ip4; 166 struct rt_ctx *rt_ip6; 167 struct rte_mempool *mbuf_pool; 168 struct rte_mempool *session_pool; 169 }; 170 171 struct cnt_blk { 172 uint32_t salt; 173 uint64_t iv; 174 uint32_t cnt; 175 } __attribute__((packed)); 176 177 uint16_t 178 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 179 uint16_t nb_pkts, uint16_t len); 180 181 uint16_t 182 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 183 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len); 184 185 static inline uint16_t 186 ipsec_metadata_size(void) 187 { 188 return sizeof(struct ipsec_mbuf_metadata); 189 } 190 191 static inline struct ipsec_mbuf_metadata * 192 get_priv(struct rte_mbuf *m) 193 { 194 return rte_mbuf_to_priv(m); 195 } 196 197 static inline void * 198 get_cnt_blk(struct rte_mbuf *m) 199 { 200 struct ipsec_mbuf_metadata *priv = get_priv(m); 201 202 return &priv->buf[0]; 203 } 204 205 static inline void * 206 get_aad(struct rte_mbuf *m) 207 { 208 struct ipsec_mbuf_metadata *priv = get_priv(m); 209 210 return &priv->buf[16]; 211 } 212 213 static inline void * 214 get_sym_cop(struct rte_crypto_op *cop) 215 { 216 return (cop + 1); 217 } 218 219 int 220 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx); 221 222 void 223 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[], 224 struct ipsec_sa *sa[], uint16_t nb_pkts); 225 226 void 227 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[], 228 struct ipsec_sa *sa[], uint16_t nb_pkts); 229 230 void 231 sp4_init(struct socket_ctx *ctx, int32_t socket_id); 232 233 void 234 sp6_init(struct socket_ctx *ctx, int32_t socket_id); 235 236 void 237 sa_init(struct socket_ctx *ctx, int32_t socket_id); 238 239 void 240 rt_init(struct socket_ctx *ctx, int32_t socket_id); 241 242 #endif /* __IPSEC_H__ */ 243