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>
28 format_ipsec_policy_action (u8 * s, va_list * args)
30 u32 i = va_arg (*args, u32);
35 #define _(v,f,str) case IPSEC_POLICY_ACTION_##f: t = str; break;
36 foreach_ipsec_policy_action
39 s = format (s, "unknown");
41 s = format (s, "%s", t);
46 format_ipsec_policy_type (u8 * s, va_list * args)
48 u32 i = va_arg (*args, u32);
53 #define _(f,str) case IPSEC_SPD_POLICY_##f: t = str; break;
54 foreach_ipsec_spd_policy_type
57 s = format (s, "unknown");
59 s = format (s, "%s", t);
64 unformat_ipsec_policy_action (unformat_input_t * input, va_list * args)
66 u32 *r = va_arg (*args, u32 *);
69 #define _(v,f,s) else if (unformat (input, s)) *r = IPSEC_POLICY_ACTION_##f;
70 foreach_ipsec_policy_action
78 format_ipsec_crypto_alg (u8 * s, va_list * args)
80 u32 i = va_arg (*args, u32);
85 #define _(v,f,str) case IPSEC_CRYPTO_ALG_##f: t = (u8 *) str; break;
86 foreach_ipsec_crypto_alg
89 s = format (s, "unknown");
91 s = format (s, "%s", t);
96 unformat_ipsec_crypto_alg (unformat_input_t * input, va_list * args)
98 u32 *r = va_arg (*args, u32 *);
101 #define _(v,f,s) else if (unformat (input, s)) *r = IPSEC_CRYPTO_ALG_##f;
102 foreach_ipsec_crypto_alg
110 format_ipsec_integ_alg (u8 * s, va_list * args)
112 u32 i = va_arg (*args, u32);
117 #define _(v,f,str) case IPSEC_INTEG_ALG_##f: t = (u8 *) str; break;
118 foreach_ipsec_integ_alg
121 s = format (s, "unknown");
123 s = format (s, "%s", t);
128 unformat_ipsec_integ_alg (unformat_input_t * input, va_list * args)
130 u32 *r = va_arg (*args, u32 *);
133 #define _(v,f,s) else if (unformat (input, s)) *r = IPSEC_INTEG_ALG_##f;
134 foreach_ipsec_integ_alg
142 format_ipsec_replay_window (u8 * s, va_list * args)
144 u64 w = va_arg (*args, u64);
147 for (i = 0; i < 64; i++)
149 s = format (s, "%u", w & (1ULL << i) ? 1 : 0);
156 format_ipsec_policy (u8 * s, va_list * args)
158 u32 pi = va_arg (*args, u32);
159 ip46_type_t ip_type = IP46_TYPE_IP4;
160 ipsec_main_t *im = &ipsec_main;
162 vlib_counter_t counts;
164 p = pool_elt_at_index (im->policies, pi);
166 s = format (s, " [%d] priority %d action %U type %U protocol ",
168 format_ipsec_policy_action, p->policy,
169 format_ipsec_policy_type, p->type);
172 s = format (s, "%U", format_ip_protocol, p->protocol);
176 s = format (s, "any");
178 if (p->policy == IPSEC_POLICY_ACTION_PROTECT)
180 s = format (s, " sa %u", p->sa_id);
184 ip_type = IP46_TYPE_IP6;
187 s = format (s, "\n local addr range %U - %U port range %u - %u",
188 format_ip46_address, &p->laddr.start, ip_type,
189 format_ip46_address, &p->laddr.stop, ip_type,
190 clib_net_to_host_u16 (p->lport.start),
191 clib_net_to_host_u16 (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 clib_net_to_host_u16 (p->rport.start),
196 clib_net_to_host_u16 (p->rport.stop));
198 vlib_get_combined_counter (&ipsec_spd_policy_counters, pi, &counts);
199 s = format (s, "\n packets %u bytes %u", counts.packets, counts.bytes);
205 format_ipsec_spd (u8 * s, va_list * args)
207 u32 si = va_arg (*args, u32);
208 ipsec_main_t *im = &ipsec_main;
212 if (pool_is_free_index (im->spds, si))
214 s = format (s, "No such SPD index: %d", si);
218 spd = pool_elt_at_index (im->spds, si);
220 s = format (s, "spd %u", spd->id);
223 s = format (s, "\n %s:", n); \
224 vec_foreach(i, spd->policies[IPSEC_SPD_POLICY_##v]) \
226 s = format (s, "\n %U", format_ipsec_policy, *i); \
228 foreach_ipsec_spd_policy_type;
236 format_ipsec_key (u8 * s, va_list * args)
238 ipsec_key_t *key = va_arg (*args, ipsec_key_t *);
240 return (format (s, "%U", format_hex_bytes, key->data, key->len));
244 unformat_ipsec_key (unformat_input_t * input, va_list * args)
246 ipsec_key_t *key = va_arg (*args, ipsec_key_t *);
249 if (unformat (input, "%U", unformat_hex_string, &data))
251 ipsec_mk_key (key, data, vec_len (data));
260 format_ipsec_sa_flags (u8 * s, va_list * args)
262 ipsec_sa_flags_t flags = va_arg (*args, int);
266 #define _(v, f, str) else if (flags & IPSEC_SA_FLAG_##f) s = format(s, "%s ", str);
267 foreach_ipsec_sa_flags
273 format_ipsec_sa (u8 * s, va_list * args)
275 u32 sai = va_arg (*args, u32);
276 ipsec_format_flags_t flags = va_arg (*args, ipsec_format_flags_t);
277 ipsec_main_t *im = &ipsec_main;
278 vlib_counter_t counts;
282 if (pool_is_free_index (im->sad, sai))
284 s = format (s, "No such SA index: %d", sai);
288 sa = pool_elt_at_index (im->sad, sai);
290 s = format (s, "[%d] sa 0x%x spi %u mode %s%s protocol %s %U",
291 sai, sa->id, sa->spi,
292 ipsec_sa_is_set_IS_TUNNEL (sa) ? "tunnel" : "transport",
293 ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ? "-ip6" : "",
294 sa->protocol ? "esp" : "ah", format_ipsec_sa_flags, sa->flags);
296 if (!(flags & IPSEC_FORMAT_DETAIL))
299 s = format (s, "\n salt 0x%x", clib_net_to_host_u32 (sa->salt));
300 s = format (s, "\n seq %u seq-hi %u", sa->seq, sa->seq_hi);
301 s = format (s, "\n last-seq %u last-seq-hi %u window %U",
302 sa->last_seq, sa->last_seq_hi,
303 format_ipsec_replay_window, sa->replay_window);
304 s = format (s, "\n crypto alg %U",
305 format_ipsec_crypto_alg, sa->crypto_alg);
307 s = format (s, " key %U", format_ipsec_key, &sa->crypto_key);
308 s = format (s, "\n integrity alg %U",
309 format_ipsec_integ_alg, sa->integ_alg);
311 s = format (s, " key %U", format_ipsec_key, &sa->integ_key);
313 vlib_get_combined_counter (&ipsec_sa_counters, sai, &counts);
314 s = format (s, "\n packets %u bytes %u", counts.packets, counts.bytes);
316 if (ipsec_sa_is_set_IS_TUNNEL (sa))
318 tx_table_id = fib_table_get_table_id (sa->tx_fib_index,
320 s = format (s, "\n table-ID %d tunnel src %U dst %U",
322 format_ip46_address, &sa->tunnel_src_addr, IP46_TYPE_ANY,
323 format_ip46_address, &sa->tunnel_dst_addr, IP46_TYPE_ANY);
324 if (!ipsec_sa_is_set_IS_INBOUND (sa))
327 format (s, "\n resovle via fib-entry: %d",
328 sa->fib_entry_index);
329 s = format (s, "\n stacked on:");
330 s = format (s, "\n %U", format_dpo_id, &sa->dpo, 6);
339 format_ipsec_tunnel (u8 * s, va_list * args)
341 ipsec_main_t *im = &ipsec_main;
342 u32 ti = va_arg (*args, u32);
343 ipsec_tunnel_if_t *t;
345 if (pool_is_free_index (im->tunnel_interfaces, ti))
347 s = format (s, "No such tunnel index: %d", ti);
351 t = pool_elt_at_index (im->tunnel_interfaces, ti);
353 if (t->hw_if_index == ~0)
357 format (s, "%U\n", format_vnet_hw_if_index_name, im->vnet_main,
360 s = format (s, " out-bound sa: ");
361 s = format (s, "%U\n", format_ipsec_sa, t->output_sa_index,
364 s = format (s, " in-bound sa: ");
365 s = format (s, "%U\n", format_ipsec_sa, t->input_sa_index,
373 format_ipsec_tun_protect (u8 * s, va_list * args)
375 u32 itpi = va_arg (*args, u32);
376 ipsec_tun_protect_t *itp;
379 if (pool_is_free_index (ipsec_protect_pool, itpi))
381 s = format (s, "No such tunnel index: %d", itpi);
385 itp = pool_elt_at_index (ipsec_protect_pool, itpi);
387 s = format (s, "%U", format_vnet_sw_if_index_name,
388 vnet_get_main (), itp->itp_sw_if_index);
389 s = format (s, "\n output-sa:");
391 format (s, "\n %U", format_ipsec_sa, itp->itp_out_sa,
394 s = format (s, "\n input-sa:");
396 FOR_EACH_IPSEC_PROTECT_INPUT_SAI(itp, sai,
398 s = format (s, "\n %U", format_ipsec_sa, sai, IPSEC_FORMAT_BRIEF);
407 * fd.io coding-style-patch-verification: ON
410 * eval: (c-set-style "gnu")