2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 * @brief NAT64 implementation
20 #include <snat/nat64.h>
21 #include <snat/nat64_db.h>
22 #include <vnet/fib/ip4_fib.h>
25 nat64_main_t nat64_main;
29 /* Hook up input features */
30 VNET_FEATURE_INIT (nat64_in2out, static) = {
31 .arc_name = "ip6-unicast",
32 .node_name = "nat64-in2out",
33 .runs_before = VNET_FEATURES ("ip6-lookup"),
35 VNET_FEATURE_INIT (nat64_out2in, static) = {
36 .arc_name = "ip4-unicast",
37 .node_name = "nat64-out2in",
38 .runs_before = VNET_FEATURES ("ip4-lookup"),
41 static u8 well_known_prefix[] = {
42 0x00, 0x64, 0xff, 0x9b,
43 0x00, 0x00, 0x00, 0x00,
44 0x00, 0x00, 0x00, 0x00,
45 0x00, 0x00, 0x00, 0x00
51 nat64_init (vlib_main_t * vm)
53 nat64_main_t *nm = &nat64_main;
54 clib_error_t *error = 0;
55 vlib_thread_main_t *tm = vlib_get_thread_main ();
59 if (tm->n_vlib_mains > 1)
65 if (nat64_db_init (&nm->db))
67 error = clib_error_return (0, "NAT64 DB init failed");
71 /* set session timeouts to default values */
72 nm->udp_timeout = SNAT_UDP_TIMEOUT;
73 nm->icmp_timeout = SNAT_ICMP_TIMEOUT;
74 nm->tcp_trans_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
75 nm->tcp_est_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
76 nm->tcp_incoming_syn_timeout = SNAT_TCP_INCOMING_SYN;
83 nat64_add_del_pool_addr (ip4_address_t * addr, u32 vrf_id, u8 is_add)
85 nat64_main_t *nm = &nat64_main;
86 snat_address_t *a = 0;
87 snat_interface_t *interface;
90 /* Check if address already exists */
91 for (i = 0; i < vec_len (nm->addr_pool); i++)
93 if (nm->addr_pool[i].addr.as_u32 == addr->as_u32)
95 a = nm->addr_pool + i;
103 return VNET_API_ERROR_VALUE_EXIST;
105 vec_add2 (nm->addr_pool, a, 1);
110 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, vrf_id);
111 #define _(N, i, n, s) \
112 clib_bitmap_alloc (a->busy_##n##_port_bitmap, 65535);
113 foreach_snat_protocol
119 return VNET_API_ERROR_NO_SUCH_ENTRY;
122 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP6);
124 #define _(N, id, n, s) \
125 clib_bitmap_free (a->busy_##n##_port_bitmap);
126 foreach_snat_protocol
128 /* Delete sessions using address */
129 nat64_db_free_out_addr (&nm->db, &a->addr);
130 vec_del1 (nm->addr_pool, i);
133 /* Add/del external address to FIB */
135 pool_foreach (interface, nm->interfaces,
137 if (interface->is_inside)
140 snat_add_del_addr_to_fib (addr, 32, interface->sw_if_index, is_add);
149 nat64_pool_addr_walk (nat64_pool_addr_walk_fn_t fn, void *ctx)
151 nat64_main_t *nm = &nat64_main;
152 snat_address_t *a = 0;
155 vec_foreach (a, nm->addr_pool)
164 nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add)
166 nat64_main_t *nm = &nat64_main;
167 snat_interface_t *interface = 0, *i;
169 const char *feature_name, *arc_name;
171 /* Check if address already exists */
173 pool_foreach (i, nm->interfaces,
175 if (i->sw_if_index == sw_if_index)
186 return VNET_API_ERROR_VALUE_EXIST;
188 pool_get (nm->interfaces, interface);
189 interface->sw_if_index = sw_if_index;
190 interface->is_inside = is_inside;
196 return VNET_API_ERROR_NO_SUCH_ENTRY;
198 pool_put (nm->interfaces, interface);
204 vec_foreach (ap, nm->addr_pool)
205 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, is_add);
209 arc_name = is_inside ? "ip6-unicast" : "ip4-unicast";
210 feature_name = is_inside ? "nat64-in2out" : "nat64-out2in";
212 return vnet_feature_enable_disable (arc_name, feature_name, sw_if_index,
217 nat64_interfaces_walk (nat64_interface_walk_fn_t fn, void *ctx)
219 nat64_main_t *nm = &nat64_main;
220 snat_interface_t *i = 0;
223 pool_foreach (i, nm->interfaces,
232 nat64_alloc_out_addr_and_port (u32 fib_index, snat_protocol_t proto,
233 ip4_address_t * addr, u16 * port)
235 nat64_main_t *nm = &nat64_main;
236 snat_main_t *sm = &snat_main;
238 snat_address_t *a, *ga = 0;
241 for (i = 0; i < vec_len (nm->addr_pool); i++)
243 a = nm->addr_pool + i;
246 #define _(N, j, n, s) \
247 case SNAT_PROTOCOL_##N: \
248 if (a->busy_##n##_ports < (65535-1024)) \
250 if (a->fib_index == fib_index) \
254 portnum = random_u32 (&sm->random_seed); \
256 if (portnum < 1024) \
258 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
261 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
263 a->busy_##n##_ports++; \
265 addr->as_u32 = a->addr.as_u32; \
269 else if (a->fib_index == 0) \
273 foreach_snat_protocol
276 clib_warning ("unknown protocol");
285 #define _(N, j, n, s) \
286 case SNAT_PROTOCOL_##N: \
289 portnum = random_u32 (&sm->random_seed); \
291 if (portnum < 1024) \
293 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
296 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
298 a->busy_##n##_ports++; \
300 addr->as_u32 = a->addr.as_u32; \
304 foreach_snat_protocol
307 clib_warning ("unknown protocol");
312 /* Totally out of translations to use... */
318 nat64_free_out_addr_and_port (ip4_address_t * addr, u16 port,
319 snat_protocol_t proto)
321 nat64_main_t *nm = &nat64_main;
325 for (i = 0; i < vec_len (nm->addr_pool); i++)
327 a = nm->addr_pool + i;
328 if (addr->as_u32 != a->addr.as_u32)
332 #define _(N, j, n, s) \
333 case SNAT_PROTOCOL_##N: \
334 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
336 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, port, 0); \
337 a->busy_##n##_ports--; \
339 foreach_snat_protocol
342 clib_warning ("unknown protocol");
350 nat64_add_del_static_bib_entry (ip6_address_t * in_addr,
351 ip4_address_t * out_addr, u16 in_port,
352 u16 out_port, u8 proto, u32 vrf_id, u8 is_add)
354 nat64_main_t *nm = &nat64_main;
355 nat64_db_bib_entry_t *bibe;
357 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, vrf_id);
358 snat_protocol_t p = ip_proto_to_snat_proto (proto);
363 addr.as_u64[0] = in_addr->as_u64[0];
364 addr.as_u64[1] = in_addr->as_u64[1];
366 nat64_db_bib_entry_find (&nm->db, &addr, clib_host_to_net_u16 (in_port),
367 proto, fib_index, 1);
372 return VNET_API_ERROR_VALUE_EXIST;
374 for (i = 0; i < vec_len (nm->addr_pool); i++)
376 a = nm->addr_pool + i;
377 if (out_addr->as_u32 != a->addr.as_u32)
381 #define _(N, j, n, s) \
382 case SNAT_PROTOCOL_##N: \
383 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
385 return VNET_API_ERROR_INVALID_VALUE; \
386 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
388 if (out_port > 1024) \
389 a->busy_##n##_ports++; \
391 foreach_snat_protocol
394 memset (&addr, 0, sizeof (addr));
395 addr.ip4.as_u32 = out_addr->as_u32;
396 if (nat64_db_bib_entry_find
397 (&nm->db, &addr, 0, proto, fib_index, 0))
398 return VNET_API_ERROR_INVALID_VALUE;
403 nat64_db_bib_entry_create (&nm->db, in_addr, out_addr,
404 clib_host_to_net_u16 (in_port),
405 clib_host_to_net_u16 (out_port), fib_index,
408 return VNET_API_ERROR_UNSPECIFIED;
413 return VNET_API_ERROR_NO_SUCH_ENTRY;
415 nat64_free_out_addr_and_port (out_addr, out_port, p);
416 nat64_db_bib_entry_free (&nm->db, bibe);
423 nat64_set_udp_timeout (u32 timeout)
425 nat64_main_t *nm = &nat64_main;
428 nm->udp_timeout = SNAT_UDP_TIMEOUT;
429 else if (timeout < SNAT_UDP_TIMEOUT_MIN)
430 return VNET_API_ERROR_INVALID_VALUE;
432 nm->udp_timeout = timeout;
438 nat64_get_udp_timeout (void)
440 nat64_main_t *nm = &nat64_main;
442 return nm->udp_timeout;
446 nat64_set_icmp_timeout (u32 timeout)
448 nat64_main_t *nm = &nat64_main;
451 nm->icmp_timeout = SNAT_ICMP_TIMEOUT;
453 nm->icmp_timeout = timeout;
459 nat64_get_icmp_timeout (void)
461 nat64_main_t *nm = &nat64_main;
463 return nm->icmp_timeout;
467 nat64_set_tcp_timeouts (u32 trans, u32 est, u32 incoming_syn)
469 nat64_main_t *nm = &nat64_main;
472 nm->tcp_trans_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
474 nm->tcp_trans_timeout = trans;
477 nm->tcp_est_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
479 nm->tcp_est_timeout = est;
481 if (incoming_syn == 0)
482 nm->tcp_incoming_syn_timeout = SNAT_TCP_INCOMING_SYN;
484 nm->tcp_incoming_syn_timeout = incoming_syn;
490 nat64_get_tcp_trans_timeout (void)
492 nat64_main_t *nm = &nat64_main;
494 return nm->tcp_trans_timeout;
498 nat64_get_tcp_est_timeout (void)
500 nat64_main_t *nm = &nat64_main;
502 return nm->tcp_est_timeout;
506 nat64_get_tcp_incoming_syn_timeout (void)
508 nat64_main_t *nm = &nat64_main;
510 return nm->tcp_incoming_syn_timeout;
514 nat64_session_reset_timeout (nat64_db_st_entry_t * ste, vlib_main_t * vm)
516 nat64_main_t *nm = &nat64_main;
517 u32 now = (u32) vlib_time_now (vm);
519 switch (ip_proto_to_snat_proto (ste->proto))
521 case SNAT_PROTOCOL_ICMP:
522 ste->expire = now + nm->icmp_timeout;
524 case SNAT_PROTOCOL_TCP:
526 switch (ste->tcp_state)
528 case NAT64_TCP_STATE_V4_INIT:
529 case NAT64_TCP_STATE_V6_INIT:
530 case NAT64_TCP_STATE_V4_FIN_RCV:
531 case NAT64_TCP_STATE_V6_FIN_RCV:
532 case NAT64_TCP_STATE_V6_FIN_V4_FIN_RCV:
533 case NAT64_TCP_STATE_TRANS:
534 ste->expire = now + nm->tcp_trans_timeout;
536 case NAT64_TCP_STATE_ESTABLISHED:
537 ste->expire = now + nm->tcp_est_timeout;
543 case SNAT_PROTOCOL_UDP:
544 ste->expire = now + nm->udp_timeout;
547 ste->expire = now + nm->udp_timeout;
553 nat64_tcp_session_set_state (nat64_db_st_entry_t * ste, tcp_header_t * tcp,
556 switch (ste->tcp_state)
558 case NAT64_TCP_STATE_CLOSED:
560 if (tcp->flags & TCP_FLAG_SYN)
563 ste->tcp_state = NAT64_TCP_STATE_V6_INIT;
565 ste->tcp_state = NAT64_TCP_STATE_V4_INIT;
569 case NAT64_TCP_STATE_V4_INIT:
571 if (is_ip6 && (tcp->flags & TCP_FLAG_SYN))
572 ste->tcp_state = NAT64_TCP_STATE_ESTABLISHED;
575 case NAT64_TCP_STATE_V6_INIT:
577 if (!is_ip6 && (tcp->flags & TCP_FLAG_SYN))
578 ste->tcp_state = NAT64_TCP_STATE_ESTABLISHED;
581 case NAT64_TCP_STATE_ESTABLISHED:
583 if (tcp->flags & TCP_FLAG_FIN)
586 ste->tcp_state = NAT64_TCP_STATE_V6_FIN_RCV;
588 ste->tcp_state = NAT64_TCP_STATE_V4_FIN_RCV;
590 else if (tcp->flags & TCP_FLAG_RST)
592 ste->tcp_state = NAT64_TCP_STATE_TRANS;
596 case NAT64_TCP_STATE_V4_FIN_RCV:
598 if (is_ip6 && (tcp->flags & TCP_FLAG_FIN))
599 ste->tcp_state = NAT64_TCP_STATE_V6_FIN_V4_FIN_RCV;
602 case NAT64_TCP_STATE_V6_FIN_RCV:
604 if (!is_ip6 && (tcp->flags & TCP_FLAG_FIN))
605 ste->tcp_state = NAT64_TCP_STATE_V6_FIN_V4_FIN_RCV;
608 case NAT64_TCP_STATE_TRANS:
610 if (!(tcp->flags & TCP_FLAG_RST))
611 ste->tcp_state = NAT64_TCP_STATE_ESTABLISHED;
620 nat64_add_del_prefix (ip6_address_t * prefix, u8 plen, u32 vrf_id, u8 is_add)
622 nat64_main_t *nm = &nat64_main;
623 nat64_prefix_t *p = 0;
626 /* Verify prefix length */
627 if (plen != 32 && plen != 40 && plen != 48 && plen != 56 && plen != 64
629 return VNET_API_ERROR_INVALID_VALUE;
631 /* Check if tenant already have prefix */
632 for (i = 0; i < vec_len (nm->pref64); i++)
634 if (nm->pref64[i].vrf_id == vrf_id)
645 vec_add2 (nm->pref64, p, 1);
647 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, vrf_id);
651 p->prefix.as_u64[0] = prefix->as_u64[0];
652 p->prefix.as_u64[1] = prefix->as_u64[1];
658 return VNET_API_ERROR_NO_SUCH_ENTRY;
660 vec_del1 (nm->pref64, i);
667 nat64_prefix_walk (nat64_prefix_walk_fn_t fn, void *ctx)
669 nat64_main_t *nm = &nat64_main;
670 nat64_prefix_t *p = 0;
673 vec_foreach (p, nm->pref64)
682 nat64_compose_ip6 (ip6_address_t * ip6, ip4_address_t * ip4, u32 fib_index)
684 nat64_main_t *nm = &nat64_main;
685 nat64_prefix_t *p, *gp = 0, *prefix = 0;
688 vec_foreach (p, nm->pref64)
690 if (p->fib_index == fib_index)
696 if (p->fib_index == 0)
707 memcpy (ip6, &p->prefix, p->plen);
711 ip6->as_u32[1] = ip4->as_u32;
714 ip6->as_u8[5] = ip4->as_u8[0];
715 ip6->as_u8[6] = ip4->as_u8[1];
716 ip6->as_u8[7] = ip4->as_u8[2];
717 ip6->as_u8[9] = ip4->as_u8[3];
720 ip6->as_u8[6] = ip4->as_u8[0];
721 ip6->as_u8[7] = ip4->as_u8[1];
722 ip6->as_u8[9] = ip4->as_u8[2];
723 ip6->as_u8[10] = ip4->as_u8[3];
726 ip6->as_u8[7] = ip4->as_u8[0];
727 ip6->as_u8[9] = ip4->as_u8[1];
728 ip6->as_u8[10] = ip4->as_u8[2];
729 ip6->as_u8[11] = ip4->as_u8[3];
732 ip6->as_u8[9] = ip4->as_u8[0];
733 ip6->as_u8[10] = ip4->as_u8[1];
734 ip6->as_u8[11] = ip4->as_u8[2];
735 ip6->as_u8[12] = ip4->as_u8[3];
738 ip6->as_u32[3] = ip4->as_u32;
741 clib_warning ("invalid prefix length");
747 memcpy (ip6, well_known_prefix, 16);
748 ip6->as_u32[3] = ip4->as_u32;
753 nat64_extract_ip4 (ip6_address_t * ip6, ip4_address_t * ip4, u32 fib_index)
755 nat64_main_t *nm = &nat64_main;
756 nat64_prefix_t *p, *gp = 0;
760 vec_foreach (p, nm->pref64)
762 if (p->fib_index == fib_index)
784 ip4->as_u32 = ip6->as_u32[1];
787 ip4->as_u8[0] = ip6->as_u8[5];
788 ip4->as_u8[1] = ip6->as_u8[6];
789 ip4->as_u8[2] = ip6->as_u8[7];
790 ip4->as_u8[3] = ip6->as_u8[9];
793 ip4->as_u8[0] = ip6->as_u8[6];
794 ip4->as_u8[1] = ip6->as_u8[7];
795 ip4->as_u8[2] = ip6->as_u8[9];
796 ip4->as_u8[3] = ip6->as_u8[10];
799 ip4->as_u8[0] = ip6->as_u8[7];
800 ip4->as_u8[1] = ip6->as_u8[9];
801 ip4->as_u8[2] = ip6->as_u8[10];
802 ip4->as_u8[3] = ip6->as_u8[11];
805 ip4->as_u8[0] = ip6->as_u8[9];
806 ip4->as_u8[1] = ip6->as_u8[10];
807 ip4->as_u8[2] = ip6->as_u8[11];
808 ip4->as_u8[3] = ip6->as_u8[12];
811 ip4->as_u32 = ip6->as_u32[3];
814 clib_warning ("invalid prefix length");
820 * @brief The 'nat64-expire-walk' process's main loop.
822 * Check expire time for NAT64 sessions.
825 nat64_expire_walk_fn (vlib_main_t * vm, vlib_node_runtime_t * rt,
828 nat64_main_t *nm = &nat64_main;
830 while (!nm->is_disabled)
832 vlib_process_wait_for_event_or_clock (vm, 10.0);
833 vlib_process_get_events (vm, NULL);
834 u32 now = (u32) vlib_time_now (vm);
836 nad64_db_st_free_expired (&nm->db, now);
842 static vlib_node_registration_t nat64_expire_walk_node;
845 VLIB_REGISTER_NODE (nat64_expire_walk_node, static) = {
846 .function = nat64_expire_walk_fn,
847 .type = VLIB_NODE_TYPE_PROCESS,
848 .name = "nat64-expire-walk",
853 * fd.io coding-style-patch-verification: ON
856 * eval: (c-set-style "gnu")