2 * decap.c : IPSec tunnel support
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <vnet/vnet.h>
19 #include <vnet/api_errno.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/interface.h>
22 #include <vnet/fib/fib_table.h>
24 #include <vnet/ipsec/ipsec.h>
25 #include <vnet/ipsec/ipsec_tun.h>
26 #include <vnet/ipsec/ipsec_itf.h>
29 format_ipsec_policy_action (u8 * s, va_list * args)
31 u32 i = va_arg (*args, u32);
36 #define _(v,f,str) case IPSEC_POLICY_ACTION_##f: t = str; break;
37 foreach_ipsec_policy_action
40 s = format (s, "unknown");
42 s = format (s, "%s", t);
47 format_ipsec_policy_type (u8 * s, va_list * args)
49 u32 i = va_arg (*args, u32);
54 #define _(f,str) case IPSEC_SPD_POLICY_##f: t = str; break;
55 foreach_ipsec_spd_policy_type
58 s = format (s, "unknown");
60 s = format (s, "%s", t);
65 unformat_ipsec_policy_action (unformat_input_t * input, va_list * args)
67 u32 *r = va_arg (*args, u32 *);
70 #define _(v,f,s) else if (unformat (input, s)) *r = IPSEC_POLICY_ACTION_##f;
71 foreach_ipsec_policy_action
79 format_ipsec_crypto_alg (u8 * s, va_list * args)
81 u32 i = va_arg (*args, u32);
86 #define _(v,f,str) case IPSEC_CRYPTO_ALG_##f: t = (u8 *) str; break;
87 foreach_ipsec_crypto_alg
90 s = format (s, "unknown");
92 s = format (s, "%s", t);
97 unformat_ipsec_crypto_alg (unformat_input_t * input, va_list * args)
99 u32 *r = va_arg (*args, u32 *);
102 #define _(v,f,s) else if (unformat (input, s)) *r = IPSEC_CRYPTO_ALG_##f;
103 foreach_ipsec_crypto_alg
111 format_ipsec_integ_alg (u8 * s, va_list * args)
113 u32 i = va_arg (*args, u32);
118 #define _(v,f,str) case IPSEC_INTEG_ALG_##f: t = (u8 *) str; break;
119 foreach_ipsec_integ_alg
122 s = format (s, "unknown");
124 s = format (s, "%s", t);
129 unformat_ipsec_integ_alg (unformat_input_t * input, va_list * args)
131 u32 *r = va_arg (*args, u32 *);
134 #define _(v,f,s) else if (unformat (input, s)) *r = IPSEC_INTEG_ALG_##f;
135 foreach_ipsec_integ_alg
143 format_ipsec_replay_window (u8 * s, va_list * args)
145 u64 w = va_arg (*args, u64);
148 for (i = 0; i < 64; i++)
150 s = format (s, "%u", w & (1ULL << i) ? 1 : 0);
157 format_ipsec_policy (u8 * s, va_list * args)
159 u32 pi = va_arg (*args, u32);
160 ip46_type_t ip_type = IP46_TYPE_IP4;
161 ipsec_main_t *im = &ipsec_main;
163 vlib_counter_t counts;
165 p = pool_elt_at_index (im->policies, pi);
167 s = format (s, " [%d] priority %d action %U type %U protocol ",
169 format_ipsec_policy_action, p->policy,
170 format_ipsec_policy_type, p->type);
173 s = format (s, "%U", format_ip_protocol, p->protocol);
177 s = format (s, "any");
179 if (p->policy == IPSEC_POLICY_ACTION_PROTECT)
181 s = format (s, " sa %u", p->sa_id);
185 ip_type = IP46_TYPE_IP6;
188 s = format (s, "\n local addr range %U - %U port range %u - %u",
189 format_ip46_address, &p->laddr.start, ip_type,
190 format_ip46_address, &p->laddr.stop, ip_type,
191 p->lport.start, p->lport.stop);
192 s = format (s, "\n remote addr range %U - %U port range %u - %u",
193 format_ip46_address, &p->raddr.start, ip_type,
194 format_ip46_address, &p->raddr.stop, ip_type,
195 p->rport.start, p->rport.stop);
197 vlib_get_combined_counter (&ipsec_spd_policy_counters, pi, &counts);
198 s = format (s, "\n packets %u bytes %u", counts.packets, counts.bytes);
204 format_ipsec_spd (u8 * s, va_list * args)
206 u32 si = va_arg (*args, u32);
207 ipsec_main_t *im = &ipsec_main;
211 if (pool_is_free_index (im->spds, si))
213 s = format (s, "No such SPD index: %d", si);
217 spd = pool_elt_at_index (im->spds, si);
219 s = format (s, "spd %u", spd->id);
222 s = format (s, "\n %s:", n); \
223 vec_foreach(i, spd->policies[IPSEC_SPD_POLICY_##v]) \
225 s = format (s, "\n %U", format_ipsec_policy, *i); \
227 foreach_ipsec_spd_policy_type;
235 format_ipsec_key (u8 * s, va_list * args)
237 ipsec_key_t *key = va_arg (*args, ipsec_key_t *);
239 return (format (s, "%U", format_hex_bytes, key->data, key->len));
243 unformat_ipsec_key (unformat_input_t * input, va_list * args)
245 ipsec_key_t *key = va_arg (*args, ipsec_key_t *);
248 if (unformat (input, "%U", unformat_hex_string, &data))
250 ipsec_mk_key (key, data, vec_len (data));
259 format_ipsec_sa_flags (u8 * s, va_list * args)
261 ipsec_sa_flags_t flags = va_arg (*args, int);
263 #define _(v, f, str) if (flags & IPSEC_SA_FLAG_##f) s = format(s, "%s ", str);
264 foreach_ipsec_sa_flags
270 format_ipsec_sa (u8 * s, va_list * args)
272 u32 sai = va_arg (*args, u32);
273 ipsec_format_flags_t flags = va_arg (*args, ipsec_format_flags_t);
274 ipsec_main_t *im = &ipsec_main;
275 vlib_counter_t counts;
279 if (pool_is_free_index (im->sad, sai))
281 s = format (s, "No such SA index: %d", sai);
285 sa = pool_elt_at_index (im->sad, sai);
287 s = format (s, "[%d] sa %u (0x%x) spi %u (0x%08x) protocol:%s flags:[%U]",
288 sai, sa->id, sa->id, sa->spi, sa->spi,
289 sa->protocol ? "esp" : "ah", format_ipsec_sa_flags, sa->flags);
291 if (!(flags & IPSEC_FORMAT_DETAIL))
294 s = format (s, "\n locks %d", sa->node.fn_locks);
295 s = format (s, "\n salt 0x%x", clib_net_to_host_u32 (sa->salt));
296 s = format (s, "\n thread-indices [encrypt:%d decrypt:%d]",
297 sa->encrypt_thread_index, sa->decrypt_thread_index);
298 s = format (s, "\n seq %u seq-hi %u", sa->seq, sa->seq_hi);
299 s = format (s, "\n last-seq %u last-seq-hi %u window %U",
300 sa->last_seq, sa->last_seq_hi,
301 format_ipsec_replay_window, sa->replay_window);
302 s = format (s, "\n crypto alg %U",
303 format_ipsec_crypto_alg, sa->crypto_alg);
304 if (sa->crypto_alg && (flags & IPSEC_FORMAT_INSECURE))
305 s = format (s, " key %U", format_ipsec_key, &sa->crypto_key);
307 s = format (s, " key [redacted]");
308 s = format (s, "\n integrity alg %U",
309 format_ipsec_integ_alg, sa->integ_alg);
310 if (sa->integ_alg && (flags & IPSEC_FORMAT_INSECURE))
311 s = format (s, " key %U", format_ipsec_key, &sa->integ_key);
313 s = format (s, " key [redacted]");
314 s = format (s, "\n UDP:[src:%d dst:%d]",
315 clib_host_to_net_u16 (sa->udp_hdr.src_port),
316 clib_host_to_net_u16 (sa->udp_hdr.dst_port));
318 vlib_get_combined_counter (&ipsec_sa_counters, sai, &counts);
319 s = format (s, "\n packets %u bytes %u", counts.packets, counts.bytes);
321 if (ipsec_sa_is_set_IS_TUNNEL (sa))
323 tx_table_id = fib_table_get_table_id (sa->tx_fib_index,
325 s = format (s, "\n table-ID %d tunnel %U src %U dst %U flags %U",
327 format_ip_dscp, sa->dscp,
328 format_ip46_address, &sa->tunnel_src_addr, IP46_TYPE_ANY,
329 format_ip46_address, &sa->tunnel_dst_addr, IP46_TYPE_ANY,
330 format_tunnel_encap_decap_flags, sa->tunnel_flags);
331 if (!ipsec_sa_is_set_IS_INBOUND (sa))
334 format (s, "\n resovle via fib-entry: %d",
335 sa->fib_entry_index);
336 s = format (s, "\n stacked on:");
337 s = format (s, "\n %U", format_dpo_id, &sa->dpo, 6);
346 format_ipsec_tun_protect_index (u8 * s, va_list * args)
348 u32 itpi = va_arg (*args, index_t);
349 ipsec_tun_protect_t *itp;
351 if (pool_is_free_index (ipsec_tun_protect_pool, itpi))
352 return (format (s, "No such tunnel index: %d", itpi));
354 itp = pool_elt_at_index (ipsec_tun_protect_pool, itpi);
356 return (format (s, "%U", format_ipsec_tun_protect, itp));
360 format_ipsec_tun_protect_flags (u8 * s, va_list * args)
362 ipsec_protect_flags_t flags = va_arg (*args, int);
364 if (IPSEC_PROTECT_NONE == flags)
365 s = format (s, "none");
367 else if (flags & IPSEC_PROTECT_##a) \
368 s = format (s, "%s", c); \
369 foreach_ipsec_protect_flags
376 format_ipsec_tun_protect (u8 * s, va_list * args)
378 ipsec_tun_protect_t *itp = va_arg (*args, ipsec_tun_protect_t *);
381 s = format (s, "%U flags:[%U]", format_vnet_sw_if_index_name,
382 vnet_get_main (), itp->itp_sw_if_index,
383 format_ipsec_tun_protect_flags, itp->itp_flags);
384 if (!ip_address_is_zero (itp->itp_key))
385 s = format (s, ": %U", format_ip_address, itp->itp_key);
386 s = format (s, "\n output-sa:");
387 s = format (s, "\n %U", format_ipsec_sa, itp->itp_out_sa,
390 s = format (s, "\n input-sa:");
392 FOR_EACH_IPSEC_PROTECT_INPUT_SAI(itp, sai,
394 s = format (s, "\n %U", format_ipsec_sa, sai, IPSEC_FORMAT_BRIEF);
402 format_ipsec4_tunnel_kv (u8 * s, va_list * args)
404 ipsec4_tunnel_kv_t *kv = va_arg (*args, ipsec4_tunnel_kv_t *);
408 ipsec4_tunnel_extract_key (kv, &ip, &spi);
410 s = format (s, "remote:%U spi:%u (0x%08x) sa:%d tun:%d",
411 format_ip4_address, &ip,
412 clib_net_to_host_u32 (spi),
413 clib_net_to_host_u32 (spi),
414 kv->value.sa_index, kv->value.tun_index);
420 format_ipsec6_tunnel_kv (u8 * s, va_list * args)
422 ipsec6_tunnel_kv_t *kv = va_arg (*args, ipsec6_tunnel_kv_t *);
424 s = format (s, "remote:%U spi:%u (0x%08x) sa:%d tun:%d",
425 format_ip6_address, &kv->key.remote_ip,
426 clib_net_to_host_u32 (kv->key.spi),
427 clib_net_to_host_u32 (kv->key.spi),
428 kv->value.sa_index, kv->value.tun_index);
434 format_ipsec_itf (u8 * s, va_list * a)
436 index_t ii = va_arg (*a, index_t);
439 itf = ipsec_itf_get (ii);
440 s = format (s, "[%d] %U %U",
441 ii, format_vnet_sw_if_index_name, vnet_get_main (),
442 itf->ii_sw_if_index, format_tunnel_mode, itf->ii_mode);
448 * fd.io coding-style-patch-verification: ON
451 * eval: (c-set-style "gnu")