Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 1 | /* |
| 2 | * ipsec_tun.h : IPSEC tunnel protection |
| 3 | * |
| 4 | * Copyright (c) 2015 Cisco and/or its affiliates. |
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | * you may not use this file except in compliance with the License. |
| 7 | * You may obtain a copy of the License at: |
| 8 | * |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | * See the License for the specific language governing permissions and |
| 15 | * limitations under the License. |
| 16 | */ |
| 17 | |
| 18 | #include <vnet/ipsec/ipsec.h> |
| 19 | |
Neale Ranns | 302b25a | 2020-10-19 13:23:33 +0000 | [diff] [blame] | 20 | #define foreach_ipsec_protect_flags \ |
| 21 | _(L2, 1, "l2") \ |
| 22 | _(ENCAPED, 2, "encapped") \ |
| 23 | _(ITF, 4, "itf") \ |
| 24 | |
| 25 | typedef enum ipsec_protect_flags_t_ |
| 26 | { |
| 27 | IPSEC_PROTECT_NONE = 0, |
| 28 | #define _(a,b,c) IPSEC_PROTECT_##a = b, |
| 29 | foreach_ipsec_protect_flags |
| 30 | #undef _ |
| 31 | } __clib_packed ipsec_protect_flags_t; |
| 32 | |
| 33 | extern u8 *format_ipsec_tun_protect_flags (u8 * s, va_list * args); |
| 34 | |
Neale Ranns | 7b4e52f | 2020-05-24 16:17:50 +0000 | [diff] [blame] | 35 | /** |
| 36 | * result of a lookup in the protection bihash |
| 37 | */ |
| 38 | typedef struct ipsec_tun_lkup_result_t_ |
| 39 | { |
Neale Ranns | 302b25a | 2020-10-19 13:23:33 +0000 | [diff] [blame] | 40 | u32 tun_index; |
| 41 | u32 sa_index; |
| 42 | u32 sw_if_index; |
| 43 | ipsec_protect_flags_t flags; |
| 44 | u8 __pad[3]; |
Neale Ranns | 7b4e52f | 2020-05-24 16:17:50 +0000 | [diff] [blame] | 45 | } ipsec_tun_lkup_result_t; |
Neale Ranns | 12989b5 | 2019-09-26 16:20:19 +0000 | [diff] [blame] | 46 | |
Neale Ranns | 7b4e52f | 2020-05-24 16:17:50 +0000 | [diff] [blame] | 47 | typedef struct ipsec4_tunnel_kv_t |
| 48 | { |
Neale Ranns | 12989b5 | 2019-09-26 16:20:19 +0000 | [diff] [blame] | 49 | /* |
| 50 | * Key fields: remote ip and spi on incoming packet |
| 51 | * all fields in NET byte order |
| 52 | */ |
Neale Ranns | 7b4e52f | 2020-05-24 16:17:50 +0000 | [diff] [blame] | 53 | u64 key; |
| 54 | ipsec_tun_lkup_result_t value; |
| 55 | } __clib_packed ipsec4_tunnel_kv_t; |
Neale Ranns | 12989b5 | 2019-09-26 16:20:19 +0000 | [diff] [blame] | 56 | |
Neale Ranns | 302b25a | 2020-10-19 13:23:33 +0000 | [diff] [blame] | 57 | STATIC_ASSERT_SIZEOF (ipsec4_tunnel_kv_t, sizeof (clib_bihash_kv_8_16_t)); |
Neale Ranns | 7b4e52f | 2020-05-24 16:17:50 +0000 | [diff] [blame] | 58 | STATIC_ASSERT_OFFSET_OF (ipsec4_tunnel_kv_t, value, |
Neale Ranns | 302b25a | 2020-10-19 13:23:33 +0000 | [diff] [blame] | 59 | STRUCT_OFFSET_OF (clib_bihash_kv_8_16_t, value)); |
Neale Ranns | 7b4e52f | 2020-05-24 16:17:50 +0000 | [diff] [blame] | 60 | |
| 61 | static inline void |
| 62 | ipsec4_tunnel_mk_key (ipsec4_tunnel_kv_t * k, |
| 63 | const ip4_address_t * ip, u32 spi) |
| 64 | { |
| 65 | k->key = (((u64) ip->as_u32) << 32 | spi); |
| 66 | } |
| 67 | |
| 68 | static inline void |
| 69 | ipsec4_tunnel_extract_key (const ipsec4_tunnel_kv_t * k, |
| 70 | ip4_address_t * ip, u32 * spi) |
| 71 | { |
| 72 | *spi = (u32) k->key; |
| 73 | (*ip).as_u32 = k->key >> 32; |
| 74 | } |
| 75 | |
| 76 | typedef struct ipsec6_tunnel_kv_t_ |
| 77 | { |
| 78 | /* |
| 79 | * Key fields: remote ip and spi on incoming packet |
| 80 | * all fields in NET byte order |
| 81 | */ |
| 82 | struct |
| 83 | { |
| 84 | ip6_address_t remote_ip; |
| 85 | u32 spi; |
| 86 | u32 __pad; |
| 87 | } key; |
| 88 | ipsec_tun_lkup_result_t value; |
| 89 | } __clib_packed ipsec6_tunnel_kv_t; |
| 90 | |
Neale Ranns | 302b25a | 2020-10-19 13:23:33 +0000 | [diff] [blame] | 91 | STATIC_ASSERT_SIZEOF (ipsec6_tunnel_kv_t, sizeof (clib_bihash_kv_24_16_t)); |
Neale Ranns | 7b4e52f | 2020-05-24 16:17:50 +0000 | [diff] [blame] | 92 | STATIC_ASSERT_OFFSET_OF (ipsec6_tunnel_kv_t, value, |
Neale Ranns | 302b25a | 2020-10-19 13:23:33 +0000 | [diff] [blame] | 93 | STRUCT_OFFSET_OF (clib_bihash_kv_24_16_t, value)); |
Neale Ranns | 7b4e52f | 2020-05-24 16:17:50 +0000 | [diff] [blame] | 94 | |
| 95 | extern u8 *format_ipsec4_tunnel_kv (u8 * s, va_list * args); |
| 96 | extern u8 *format_ipsec6_tunnel_kv (u8 * s, va_list * args); |
Neale Ranns | 12989b5 | 2019-09-26 16:20:19 +0000 | [diff] [blame] | 97 | |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 98 | typedef struct ipsec_ep_t_ |
| 99 | { |
| 100 | ip46_address_t src; |
| 101 | ip46_address_t dst; |
| 102 | } ipsec_ep_t; |
| 103 | |
Matthew Smith | dc3e966 | 2020-04-10 20:27:33 -0500 | [diff] [blame] | 104 | #define ITP_MAX_N_SA_IN 4 |
| 105 | |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 106 | typedef struct ipsec_tun_protect_t_ |
| 107 | { |
| 108 | CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); |
Neale Ranns | 495d7ff | 2019-07-12 09:15:26 +0000 | [diff] [blame] | 109 | index_t itp_out_sa; |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 110 | |
| 111 | /* not using a vector since we want the memory inline |
| 112 | * with this struct */ |
| 113 | u32 itp_n_sa_in; |
Matthew Smith | dc3e966 | 2020-04-10 20:27:33 -0500 | [diff] [blame] | 114 | index_t itp_in_sas[ITP_MAX_N_SA_IN]; |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 115 | |
| 116 | u32 itp_sw_if_index; |
| 117 | |
| 118 | ipsec_ep_t itp_crypto; |
| 119 | |
| 120 | ipsec_protect_flags_t itp_flags; |
Neale Ranns | dd4ccf2 | 2020-06-30 07:47:14 +0000 | [diff] [blame] | 121 | adj_index_t itp_ai; |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 122 | |
| 123 | ipsec_ep_t itp_tun; |
| 124 | |
Neale Ranns | 2828721 | 2019-12-16 00:53:11 +0000 | [diff] [blame] | 125 | ip_address_t *itp_key; |
| 126 | |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 127 | } ipsec_tun_protect_t; |
| 128 | |
| 129 | #define FOR_EACH_IPSEC_PROTECT_INPUT_SAI(_itp, _sai, body) \ |
| 130 | { \ |
| 131 | u32 __ii; \ |
| 132 | for (__ii = 0; __ii < _itp->itp_n_sa_in; __ii++) { \ |
| 133 | _sai = itp->itp_in_sas[__ii]; \ |
| 134 | body; \ |
| 135 | } \ |
| 136 | } |
| 137 | #define FOR_EACH_IPSEC_PROTECT_INPUT_SA(_itp, _sa, body) \ |
| 138 | { \ |
| 139 | u32 __ii; \ |
| 140 | for (__ii = 0; __ii < _itp->itp_n_sa_in; __ii++) { \ |
| 141 | _sa = ipsec_sa_get(itp->itp_in_sas[__ii]); \ |
| 142 | body; \ |
| 143 | } \ |
| 144 | } |
| 145 | |
Neale Ranns | 2828721 | 2019-12-16 00:53:11 +0000 | [diff] [blame] | 146 | extern int ipsec_tun_protect_update (u32 sw_if_index, |
| 147 | const ip_address_t * nh, |
| 148 | u32 sa_out, u32 * sa_ins); |
Neale Ranns | 12989b5 | 2019-09-26 16:20:19 +0000 | [diff] [blame] | 149 | |
Neale Ranns | 2828721 | 2019-12-16 00:53:11 +0000 | [diff] [blame] | 150 | extern int ipsec_tun_protect_del (u32 sw_if_index, const ip_address_t * nh); |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 151 | |
| 152 | typedef walk_rc_t (*ipsec_tun_protect_walk_cb_t) (index_t itpi, void *arg); |
| 153 | extern void ipsec_tun_protect_walk (ipsec_tun_protect_walk_cb_t fn, |
| 154 | void *cttx); |
Neale Ranns | 2828721 | 2019-12-16 00:53:11 +0000 | [diff] [blame] | 155 | extern void ipsec_tun_protect_walk_itf (u32 sw_if_index, |
| 156 | ipsec_tun_protect_walk_cb_t fn, |
| 157 | void *cttx); |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 158 | |
| 159 | extern u8 *format_ipsec_tun_protect (u8 * s, va_list * args); |
Neale Ranns | 2828721 | 2019-12-16 00:53:11 +0000 | [diff] [blame] | 160 | extern u8 *format_ipsec_tun_protect_index (u8 * s, va_list * args); |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 161 | |
Neale Ranns | 8d6d74c | 2020-02-20 09:45:16 +0000 | [diff] [blame] | 162 | extern void ipsec_tun_register_nodes (ip_address_family_t af); |
| 163 | extern void ipsec_tun_unregister_nodes (ip_address_family_t af); |
| 164 | |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 165 | // FIXME |
| 166 | extern vlib_node_registration_t ipsec4_tun_input_node; |
| 167 | extern vlib_node_registration_t ipsec6_tun_input_node; |
| 168 | |
| 169 | /* |
| 170 | * DP API |
| 171 | */ |
Neale Ranns | 2828721 | 2019-12-16 00:53:11 +0000 | [diff] [blame] | 172 | extern ipsec_tun_protect_t *ipsec_tun_protect_pool; |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 173 | |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 174 | always_inline ipsec_tun_protect_t * |
| 175 | ipsec_tun_protect_get (u32 index) |
| 176 | { |
Neale Ranns | 2828721 | 2019-12-16 00:53:11 +0000 | [diff] [blame] | 177 | return (pool_elt_at_index (ipsec_tun_protect_pool, index)); |
| 178 | } |
| 179 | |
| 180 | extern index_t *ipsec_tun_protect_sa_by_adj_index; |
| 181 | always_inline index_t |
| 182 | ipsec_tun_protect_get_sa_out (adj_index_t ai) |
| 183 | { |
| 184 | ASSERT (vec_len (ipsec_tun_protect_sa_by_adj_index) > ai); |
| 185 | ASSERT (INDEX_INVALID != ipsec_tun_protect_sa_by_adj_index[ai]); |
| 186 | |
| 187 | return (ipsec_tun_protect_sa_by_adj_index[ai]); |
Neale Ranns | c87b66c | 2019-02-07 07:26:12 -0800 | [diff] [blame] | 188 | } |
| 189 | |
| 190 | /* |
| 191 | * fd.io coding-style-patch-verification: ON |
| 192 | * |
| 193 | * Local Variables: |
| 194 | * eval: (c-set-style "gnu") |
| 195 | * End: |
| 196 | */ |