2 * l2tp.c : L2TPv3 tunnel support
4 * Copyright (c) 2013 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 <vppinfra/error.h>
19 #include <vppinfra/hash.h>
20 #include <vnet/vnet.h>
21 #include <vnet/ip/ip.h>
22 #include <vnet/l2/l2_input.h>
23 #include <vnet/ethernet/ethernet.h>
24 #include <vnet/l2tp/l2tp.h>
28 /* packet trace format function */
29 u8 * format_l2t_trace (u8 * s, va_list * args)
31 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
32 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
33 l2t_trace_t * t = va_arg (*args, l2t_trace_t *);
35 if (t->is_user_to_network)
36 s = format (s, "L2T: %U (client) -> %U (our) session %d",
37 format_ip6_address, &t->client_address,
38 format_ip6_address, &t->our_address,
41 s = format (s, "L2T: %U (our) -> %U (client) session %d)",
42 format_ip6_address, &t->our_address,
43 format_ip6_address, &t->client_address,
48 u8 * format_l2t_session (u8 * s, va_list * args)
50 l2t_session_t * session = va_arg (*args, l2t_session_t *);
51 l2t_main_t * lm = &l2t_main;
55 s = format (s, "[%d] %U (our) %U (client) %U (sw_if_index %d)\n",
56 session - lm->sessions,
57 format_ip6_address, &session->our_address,
58 format_ip6_address, &session->client_address,
59 format_vnet_sw_interface_name, lm->vnet_main,
60 vnet_get_sw_interface (lm->vnet_main, session->sw_if_index),
61 session->sw_if_index);
63 s = format (s, " local cookies %016llx %016llx remote cookie %016llx\n",
64 clib_net_to_host_u64 (session->local_cookie[0]),
65 clib_net_to_host_u64 (session->local_cookie[1]),
66 clib_net_to_host_u64 (session->remote_cookie));
68 s = format (s, " local session-id %d remote session-id %d\n",
69 clib_net_to_host_u32 (session->local_session_id),
70 clib_net_to_host_u32 (session->remote_session_id));
72 s = format (s, " l2 specific sublayer %s\n",
73 session->l2_sublayer_present ? "preset" : "absent");
76 session_index_to_counter_index (session - lm->sessions,
77 SESSION_COUNTER_USER_TO_NETWORK);
79 vlib_get_combined_counter (&lm->counter_main, counter_index, &v);
81 s = format (s, " user-to-net: %llu pkts %llu bytes\n",
84 vlib_get_combined_counter (&lm->counter_main, counter_index+1, &v);
87 s = format (s, " net-to-user: %llu pkts %llu bytes\n",
93 show_l2tp_command_fn (vlib_main_t * vm,
94 unformat_input_t * input,
95 vlib_cli_command_t * cmd)
97 l2t_session_t *session;
98 l2t_main_t *lm = &l2t_main;
102 if (unformat (input, "verbose") || unformat (input, "v"))
105 if (pool_elts (lm->sessions) == 0)
106 vlib_cli_output (vm, "No l2tp sessions...");
108 vlib_cli_output (vm, "%u l2tp sessions...", pool_elts (lm->sessions));
112 switch (lm->lookup_type)
114 case L2T_LOOKUP_SRC_ADDRESS:
115 keystr = "src address";
118 case L2T_LOOKUP_DST_ADDRESS:
119 keystr = "dst address";
122 case L2T_LOOKUP_SESSION_ID:
123 keystr = "session id";
131 vlib_cli_output (vm, "L2tp session lookup on %s", keystr);
133 pool_foreach (session, lm->sessions,
135 vlib_cli_output (vm, "%U", format_l2t_session, session);
142 VLIB_CLI_COMMAND (show_session_detail_command, static) = {
143 .path = "show l2tpv3",
144 .short_help = "show l2tpv3 [verbose]",
145 .function = show_l2tp_command_fn,
148 static clib_error_t *
149 test_counters_command_fn (vlib_main_t * vm,
150 unformat_input_t * input,
151 vlib_cli_command_t * cmd)
153 l2t_session_t *session;
154 l2t_main_t *lm = &l2t_main;
158 u32 cpu_index = os_get_cpu_number();
160 pool_foreach (session, lm->sessions,
162 session_index = session - lm->sessions;
164 session_index_to_counter_index (session_index,
165 SESSION_COUNTER_USER_TO_NETWORK);
166 vlib_increment_combined_counter (&lm->counter_main,
169 1/*pkt*/, 1111 /*bytes*/);
170 vlib_increment_combined_counter (&lm->counter_main,
173 1/*pkt*/, 2222 /*bytes*/);
177 vlib_cli_output (vm, "Incremented %d active counters\n", nincr);
182 VLIB_CLI_COMMAND (test_counters_command, static) = {
183 .path = "test counters",
184 .short_help = "increment all active counters",
185 .function = test_counters_command_fn,
188 static clib_error_t *
189 clear_counters_command_fn (vlib_main_t * vm,
190 unformat_input_t * input,
191 vlib_cli_command_t * cmd)
193 l2t_session_t *session;
194 l2t_main_t *lm = &l2t_main;
199 pool_foreach (session, lm->sessions,
201 session_index = session - lm->sessions;
203 session_index_to_counter_index (session_index,
204 SESSION_COUNTER_USER_TO_NETWORK);
205 vlib_zero_combined_counter (&lm->counter_main, counter_index);
206 vlib_zero_combined_counter (&lm->counter_main, counter_index+1);
210 vlib_cli_output (vm, "Cleared %d active counters\n", nincr);
215 VLIB_CLI_COMMAND (clear_counters_command, static) = {
216 .path = "clear counters",
217 .short_help = "clear all active counters",
218 .function = clear_counters_command_fn,
221 static u8 * format_l2tpv3_name (u8 * s, va_list * args)
223 l2t_main_t *lm = &l2t_main;
224 u32 i = va_arg (*args, u32);
225 u32 show_dev_instance = ~0;
227 if (i < vec_len (lm->dev_inst_by_real))
228 show_dev_instance = lm->dev_inst_by_real[i];
230 if (show_dev_instance != ~0)
231 i = show_dev_instance;
233 return format (s, "l2tpv3_tunnel%d", i);
236 static int l2tpv3_name_renumber (vnet_hw_interface_t * hi,
237 u32 new_dev_instance)
239 l2t_main_t *lm = &l2t_main;
241 vec_validate_init_empty (lm->dev_inst_by_real, hi->dev_instance, ~0);
243 lm->dev_inst_by_real [hi->dev_instance] = new_dev_instance;
248 static uword dummy_interface_tx (vlib_main_t * vm,
249 vlib_node_runtime_t * node,
250 vlib_frame_t * frame)
252 clib_warning ("you shouldn't be here, leaking buffers...");
253 return frame->n_vectors;
256 VNET_DEVICE_CLASS (l2tpv3_device_class,static) = {
258 .format_device_name = format_l2tpv3_name,
259 .name_renumber = l2tpv3_name_renumber,
260 .tx_function = dummy_interface_tx,
263 static uword dummy_set_rewrite (vnet_main_t * vnm,
268 uword max_rewrite_bytes)
271 * Conundrum: packets from tun/tap destined for the tunnel
272 * actually have this rewrite applied. Transit packets do not.
273 * To make the two cases equivalent, don't generate a
274 * rewrite here, build the entire header in the fast path.
279 static u8 * format_l2tp_header_with_length (u8 * s, va_list * args)
281 u32 dev_instance = va_arg (*args, u32);
282 s = format (s, "unimplemented dev %u", dev_instance);
286 VNET_HW_INTERFACE_CLASS (l2tpv3_hw_class) = {
288 .format_header = format_l2tp_header_with_length,
289 .set_rewrite = dummy_set_rewrite,
292 int create_l2tpv3_ipv6_tunnel (l2t_main_t * lm,
293 ip6_address_t * client_address,
294 ip6_address_t * our_address,
295 u32 local_session_id,
296 u32 remote_session_id,
299 int l2_sublayer_present,
303 l2t_session_t *s = 0;
304 vnet_main_t * vnm = lm->vnet_main;
305 vnet_hw_interface_t * hi;
306 uword * p = (uword *) ~0;
308 l2tpv3_header_t l2tp_hdr;
309 ip6_address_t * dst_address_copy, * src_address_copy;
312 remote_session_id = clib_host_to_net_u32 (remote_session_id);
313 local_session_id = clib_host_to_net_u32 (local_session_id);
315 switch (lm->lookup_type) {
316 case L2T_LOOKUP_SRC_ADDRESS:
317 p = hash_get_mem (lm->session_by_src_address, client_address);
320 case L2T_LOOKUP_DST_ADDRESS:
321 p = hash_get_mem (lm->session_by_dst_address, our_address);
324 case L2T_LOOKUP_SESSION_ID:
325 p = hash_get (lm->session_by_session_id, local_session_id);
332 /* adding a session: session must not already exist */
334 return VNET_API_ERROR_INVALID_VALUE;
336 pool_get (lm->sessions, s);
337 memset (s, 0, sizeof (*s));
338 clib_memcpy (&s->our_address, our_address, sizeof (s->our_address));
339 clib_memcpy (&s->client_address, client_address, sizeof (s->client_address));
340 s->local_cookie[0] = clib_host_to_net_u64 (local_cookie);
341 s->remote_cookie = clib_host_to_net_u64 (remote_cookie);
342 s->local_session_id = local_session_id;
343 s->remote_session_id = remote_session_id;
344 s->l2_sublayer_present = l2_sublayer_present;
345 /* precompute l2tp header size */
346 s->l2tp_hdr_size = l2_sublayer_present ?
347 sizeof (l2tpv3_header_t) :
348 sizeof (l2tpv3_header_t) - sizeof(l2tp_hdr.l2_specific_sublayer);
350 s->encap_fib_index = encap_fib_index;
352 /* Setup hash table entries */
353 switch (lm->lookup_type) {
354 case L2T_LOOKUP_SRC_ADDRESS:
355 src_address_copy = clib_mem_alloc (sizeof (*src_address_copy));
356 clib_memcpy (src_address_copy, client_address, sizeof (*src_address_copy));
357 hash_set_mem (lm->session_by_src_address, src_address_copy,
360 case L2T_LOOKUP_DST_ADDRESS:
361 dst_address_copy = clib_mem_alloc (sizeof (*dst_address_copy));
362 clib_memcpy (dst_address_copy, our_address, sizeof (*dst_address_copy));
363 hash_set_mem (lm->session_by_dst_address, dst_address_copy,
366 case L2T_LOOKUP_SESSION_ID:
367 hash_set (lm->session_by_session_id, local_session_id,
375 /* validate counters */
377 session_index_to_counter_index (s - lm->sessions,
378 SESSION_COUNTER_USER_TO_NETWORK);
379 vlib_validate_combined_counter (&lm->counter_main, counter_index);
380 vlib_validate_combined_counter (&lm->counter_main, counter_index+1);
382 if (vec_len (lm->free_l2tpv3_tunnel_hw_if_indices) > 0)
384 hw_if_index = lm->free_l2tpv3_tunnel_hw_if_indices
385 [vec_len (lm->free_l2tpv3_tunnel_hw_if_indices)-1];
386 _vec_len (lm->free_l2tpv3_tunnel_hw_if_indices) -= 1;
388 hi = vnet_get_hw_interface (vnm, hw_if_index);
389 hi->dev_instance = s - lm->sessions;
390 hi->hw_instance = hi->dev_instance;
394 hw_if_index = vnet_register_interface
395 (vnm, l2tpv3_device_class.index, s - lm->sessions,
396 l2tpv3_hw_class.index, s - lm->sessions);
397 hi = vnet_get_hw_interface (vnm, hw_if_index);
398 hi->output_node_index = l2t_encap_node.index;
399 /* $$$$ initialize custom dispositions, if needed */
402 s->hw_if_index = hw_if_index;
403 s->sw_if_index = hi->sw_if_index;
406 *sw_if_index = hi->sw_if_index;
411 static clib_error_t *
412 create_l2tpv3_tunnel_command_fn (vlib_main_t * vm,
413 unformat_input_t * input,
414 vlib_cli_command_t * cmd)
416 ip6_address_t client_address, our_address;
417 unformat_input_t _line_input, * line_input = &_line_input;
418 l2t_main_t *lm = &l2t_main;
419 u64 local_cookie = (u64)~0, remote_cookie = (u64)~0;
420 u32 local_session_id = 1, remote_session_id = 1;
421 int our_address_set = 0, client_address_set = 0;
422 int l2_sublayer_present = 0;
425 u32 encap_fib_id = ~0;
426 u32 encap_fib_index = ~0;
428 /* Get a line of input. */
429 if (! unformat_user (input, unformat_line_input, line_input))
432 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
433 if (unformat (line_input, "client %U",
434 unformat_ip6_address, &client_address))
435 client_address_set = 1;
436 else if (unformat (line_input, "our %U",
437 unformat_ip6_address, &our_address))
439 else if (unformat (line_input, "local-cookie %llx", &local_cookie))
441 else if (unformat (line_input, "remote-cookie %llx", &remote_cookie))
443 else if (unformat (line_input, "local-session-id %d",
446 else if (unformat (line_input, "remote-session-id %d",
449 else if (unformat (line_input, "fib-id %d",
452 else if (unformat (line_input, "l2-sublayer-present"))
453 l2_sublayer_present = 1;
455 return clib_error_return (0, "parse error: '%U'",
456 format_unformat_error, line_input);
459 unformat_free (line_input);
461 if (encap_fib_id != ~0) {
463 ip6_main_t *im = &ip6_main;
464 if (!(p = hash_get (im->fib_index_by_table_id, encap_fib_id)))
465 return clib_error_return (0, "No fib with id %d", encap_fib_id);
466 encap_fib_index = p[0];
468 encap_fib_index = ~0;
471 if (our_address_set == 0)
472 return clib_error_return (0, "our address not specified");
473 if (client_address_set == 0)
474 return clib_error_return (0, "client address not specified");
476 rv = create_l2tpv3_ipv6_tunnel (lm, &client_address, &our_address,
477 local_session_id, remote_session_id,
478 local_cookie, remote_cookie,
485 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main(), sw_if_index);
487 case VNET_API_ERROR_INVALID_VALUE:
488 return clib_error_return (0, "session already exists...");
490 case VNET_API_ERROR_NO_SUCH_ENTRY:
491 return clib_error_return (0, "session does not exist...");
494 return clib_error_return (0, "l2tp_session_add_del returned %d", rv);
500 VLIB_CLI_COMMAND (create_l2tpv3_tunnel_command, static) = {
501 .path = "create l2tpv3 tunnel",
503 "create l2tpv3 tunnel client <ip6> our <ip6> local-cookie <hex> remote-cookie <hex> local-session <dec> remote-session <dec>",
504 .function = create_l2tpv3_tunnel_command_fn,
507 int l2tpv3_set_tunnel_cookies (l2t_main_t * lm,
509 u64 new_local_cookie,
510 u64 new_remote_cookie)
513 vnet_hw_interface_t * hi;
514 vnet_main_t * vnm = vnet_get_main();
515 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
517 if (pool_is_free_index (lm->sessions, hi->dev_instance))
518 return VNET_API_ERROR_INVALID_VALUE;
520 s = pool_elt_at_index (lm->sessions, hi->dev_instance);
522 s->local_cookie[1] = s->local_cookie[0];
523 s->local_cookie[0] = clib_host_to_net_u64(new_local_cookie);
524 s->remote_cookie = clib_host_to_net_u64(new_remote_cookie);
530 static clib_error_t *
531 set_l2tp_tunnel_cookie_command_fn (vlib_main_t * vm,
532 unformat_input_t * input,
533 vlib_cli_command_t * cmd)
535 l2t_main_t *lm = &l2t_main;
536 vnet_main_t * vnm = vnet_get_main();
537 u32 sw_if_index = ~0;
538 u64 local_cookie = (u64)~0, remote_cookie = (u64)~0;
542 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
544 if (unformat (input, "%U", unformat_vnet_sw_interface, vnm,
547 else if (unformat (input, "local %llx", &local_cookie))
549 else if (unformat (input, "remote %llx", &remote_cookie))
554 if (sw_if_index == ~0)
555 return clib_error_return (0, "unknown interface");
556 if (local_cookie == ~0)
557 return clib_error_return (0, "local cookie required");
558 if (remote_cookie == ~0)
559 return clib_error_return (0, "remote cookie required");
561 rv = l2tpv3_set_tunnel_cookies (lm, sw_if_index,
562 local_cookie, remote_cookie);
569 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
570 return clib_error_return (0, "invalid interface");
573 return clib_error_return (0, "l2tp_session_set_cookies returned %d",
580 VLIB_CLI_COMMAND (set_l2tp_tunnel_cookie_command, static) = {
581 .path = "set l2tpv3 tunnel cookie",
583 "set l2tpv3 tunnel cookie <intfc> local <hex> remote <hex>",
584 .function = set_l2tp_tunnel_cookie_command_fn,
587 int l2tpv3_interface_enable_disable (vnet_main_t * vnm,
591 ip6_main_t * im = &ip6_main;
592 ip_lookup_main_t * lm = &im->lookup_main;
593 ip_config_main_t * rx_cm = &lm->rx_config_mains[VNET_UNICAST];
595 ip6_l2tpv3_config_t config;
598 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
599 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
601 feature_index = im->ip6_unicast_rx_feature_l2tp_decap;
603 ci = rx_cm->config_index_by_sw_if_index[sw_if_index];
605 ? vnet_config_add_feature
606 : vnet_config_del_feature)
607 (vlib_get_main(), &rx_cm->config_main,
612 rx_cm->config_index_by_sw_if_index[sw_if_index] = ci;
616 /* Enable/disable L2TPv3 intercept on IP6 fowarding path */
617 static clib_error_t *
618 set_ip6_l2tpv3 (vlib_main_t * vm,
619 unformat_input_t * input,
620 vlib_cli_command_t * cmd)
622 u32 sw_if_index = ~0;
625 vnet_main_t * vnm = vnet_get_main();
627 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
629 if (unformat (input, "%U", unformat_vnet_sw_interface, vnm,
632 else if (unformat (input, "del"))
638 if (sw_if_index == ~0)
639 return clib_error_return (0, "interface required");
641 rv = l2tpv3_interface_enable_disable (vnm, sw_if_index, is_add);
648 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
649 return clib_error_return (0, "invalid interface");
652 return clib_error_return (0, "l2tp_interface_enable_disable returned %d",
658 VLIB_CLI_COMMAND (set_interface_ip6_l2tpv3, static) = {
659 .path = "set interface ip6 l2tpv3",
660 .function = set_ip6_l2tpv3,
661 .short_help = "set interface ip6 l2tpv3 <intfc> [del]",
664 static clib_error_t *
665 l2tp_config (vlib_main_t * vm, unformat_input_t * input)
667 l2t_main_t *lm = &l2t_main;
669 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
670 if (unformat (input, "lookup-v6-src"))
671 lm->lookup_type = L2T_LOOKUP_SRC_ADDRESS;
672 else if (unformat (input, "lookup-v6-dst"))
673 lm->lookup_type = L2T_LOOKUP_DST_ADDRESS;
674 else if (unformat (input, "lookup-session-id"))
675 lm->lookup_type = L2T_LOOKUP_SESSION_ID;
676 else return clib_error_return (0, "unknown input `%U'",
677 format_unformat_error, input);
682 VLIB_CONFIG_FUNCTION (l2tp_config, "l2tp");
686 l2tp_sw_interface_up_down (vnet_main_t * vnm,
690 l2t_main_t *lm = &l2t_main;
691 vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
692 if (hi->hw_class_index != l2tpv3_hw_class.index)
695 u32 session_index = hi->dev_instance;
696 l2t_session_t *s = pool_elt_at_index (lm->sessions, session_index);
697 s->admin_up = !! (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP);
701 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (l2tp_sw_interface_up_down);
703 clib_error_t *l2tp_init (vlib_main_t *vm)
705 l2t_main_t *lm = &l2t_main;
706 ip_main_t * im = &ip_main;
707 ip_protocol_info_t * pi;
709 lm->vnet_main = vnet_get_main();
711 lm->lookup_type = L2T_LOOKUP_DST_ADDRESS;
713 lm->session_by_src_address = hash_create_mem
714 (0, sizeof (ip6_address_t) /* key bytes */,
715 sizeof (u32) /* value bytes */);
716 lm->session_by_dst_address = hash_create_mem
717 (0, sizeof (ip6_address_t) /* key bytes */,
718 sizeof (u32) /* value bytes */);
719 lm->session_by_session_id = hash_create (0, sizeof (uword));
721 pi = ip_get_protocol_info (im, IP_PROTOCOL_L2TP);
722 pi->unformat_pg_edit = unformat_pg_l2tp_header;
724 /* insure these nodes are included in build */
731 VLIB_INIT_FUNCTION(l2tp_init);