src/plugins/nat/det44/det44.c

   1 /*
   2  * det44.c - deterministic NAT
   3  *
   4  * Copyright (c) 2020 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  * @file
  19  * @brief deterministic NAT (CGN)
  20  */
  21
  22 #include <vnet/vnet.h>
  23 #include <vnet/ip/ip.h>
  24 #include <vnet/ip/ip4.h>
  25 #include <vpp/app/version.h>
  26 #include <vnet/plugin/plugin.h>
  27
  28 #include <nat/det44/det44.h>
  29
  30 det44_main_t det44_main;
  31
  32 /* *INDENT-OFF* */
  33 VNET_FEATURE_INIT (ip4_det44_in2out, static) = {
  34   .arc_name = "ip4-unicast",
  35   .node_name = "det44-in2out",
  36   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
  37                                "ip4-sv-reassembly-feature"),
  38 };
  39 VNET_FEATURE_INIT (ip4_det44_out2in, static) = {
  40   .arc_name = "ip4-unicast",
  41   .node_name = "det44-out2in",
  42   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
  43                                "ip4-sv-reassembly-feature",
  44                                "ip4-dhcp-client-detect"),
  45 };
  46 VLIB_PLUGIN_REGISTER () = {
  47     .version = VPP_BUILD_VER,
  48     .description = "Deterministic NAT (CGN)",
  49 };
  50 /* *INDENT-ON* */
  51
  52 void
  53 det44_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
  54                            int is_add)
  55 {
  56   det44_main_t *dm = &det44_main;
  57   fib_prefix_t prefix = {
  58     .fp_len = p_len,
  59     .fp_proto = FIB_PROTOCOL_IP4,
  60     .fp_addr = {
  61                 .ip4.as_u32 = addr->as_u32,
  62                 },
  63   };
  64   u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
  65
  66   if (is_add)
  67     {
  68       fib_table_entry_update_one_path (fib_index,
  69                                        &prefix,
  70                                        dm->fib_src_low,
  71                                        (FIB_ENTRY_FLAG_CONNECTED |
  72                                         FIB_ENTRY_FLAG_LOCAL |
  73                                         FIB_ENTRY_FLAG_EXCLUSIVE),
  74                                        DPO_PROTO_IP4,
  75                                        NULL,
  76                                        sw_if_index,
  77                                        ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
  78     }
  79   else
  80     {
  81       fib_table_entry_delete (fib_index, &prefix, dm->fib_src_low);
  82     }
  83 }
  84
  85 /**
  86  * @brief Add/delete deterministic NAT mapping.
  87  *
  88  * Create bijective mapping of inside address to outside address and port range
  89  * pairs, with the purpose of enabling deterministic NAT to reduce logging in
  90  * CGN deployments.
  91  *
  92  * @param in_addr  Inside network address.
  93  * @param in_plen  Inside network prefix length.
  94  * @param out_addr Outside network address.
  95  * @param out_plen Outside network prefix length.
  96  * @param is_add   If 0 delete, otherwise add.
  97  */
  98 int
  99 snat_det_add_map (ip4_address_t * in_addr, u8 in_plen,
 100                   ip4_address_t * out_addr, u8 out_plen, int is_add)
 101 {
 102   static snat_det_session_t empty_snat_det_session = { 0 };
 103   det44_main_t *dm = &det44_main;
 104   ip4_address_t in_cmp, out_cmp;
 105   det44_interface_t *i;
 106   snat_det_map_t *mp;
 107   u8 found = 0;
 108
 109   in_cmp.as_u32 = in_addr->as_u32 & ip4_main.fib_masks[in_plen];
 110   out_cmp.as_u32 = out_addr->as_u32 & ip4_main.fib_masks[out_plen];
 111   vec_foreach (mp, dm->det_maps)
 112   {
 113     /* Checking for overlapping addresses to be added here */
 114     if (mp->in_addr.as_u32 == in_cmp.as_u32 &&
 115         mp->in_plen == in_plen &&
 116         mp->out_addr.as_u32 == out_cmp.as_u32 && mp->out_plen == out_plen)
 117       {
 118         found = 1;
 119         break;
 120       }
 121   }
 122
 123   /* If found, don't add again */
 124   if (found && is_add)
 125     return VNET_API_ERROR_VALUE_EXIST;
 126
 127   /* If not found, don't delete */
 128   if (!found && !is_add)
 129     return VNET_API_ERROR_NO_SUCH_ENTRY;
 130
 131   if (is_add)
 132     {
 133       pool_get (dm->det_maps, mp);
 134       clib_memset (mp, 0, sizeof (*mp));
 135       mp->in_addr.as_u32 = in_cmp.as_u32;
 136       mp->in_plen = in_plen;
 137       mp->out_addr.as_u32 = out_cmp.as_u32;
 138       mp->out_plen = out_plen;
 139       mp->sharing_ratio = (1 << (32 - in_plen)) / (1 << (32 - out_plen));
 140       mp->ports_per_host = (65535 - 1023) / mp->sharing_ratio;
 141
 142       vec_validate_init_empty (mp->sessions,
 143                                DET44_SES_PER_USER * (1 << (32 - in_plen)) -
 144                                1, empty_snat_det_session);
 145     }
 146   else
 147     {
 148       vec_free (mp->sessions);
 149       vec_del1 (dm->det_maps, mp - dm->det_maps);
 150     }
 151
 152   /* Add/del external address range to FIB */
 153   /* *INDENT-OFF* */
 154   pool_foreach (i, dm->interfaces, ({
 155     if (det44_interface_is_inside(i))
 156       continue;
 157     det44_add_del_addr_to_fib(out_addr, out_plen, i->sw_if_index, is_add);
 158     goto out;
 159   }));
 160   /* *INDENT-ON* */
 161 out:
 162   return 0;
 163 }
 164
 165 int
 166 det44_set_timeouts (nat_timeouts_t * timeouts)
 167 {
 168   det44_main_t *dm = &det44_main;
 169   if (timeouts->udp)
 170     dm->timeouts.udp = timeouts->udp;
 171   if (timeouts->tcp.established)
 172     dm->timeouts.tcp.established = timeouts->tcp.established;
 173   if (timeouts->tcp.transitory)
 174     dm->timeouts.tcp.transitory = timeouts->tcp.transitory;
 175   if (timeouts->icmp)
 176     dm->timeouts.icmp = timeouts->icmp;
 177   return 0;
 178 }
 179
 180 nat_timeouts_t
 181 det44_get_timeouts ()
 182 {
 183   det44_main_t *dm = &det44_main;
 184   return dm->timeouts;
 185 }
 186
 187 void
 188 det44_reset_timeouts ()
 189 {
 190   det44_main_t *dm = &det44_main;
 191   nat_reset_timeouts (&dm->timeouts);
 192 }
 193
 194 int
 195 det44_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
 196 {
 197   det44_main_t *dm = &det44_main;
 198   det44_interface_t *tmp, *i = 0;
 199   const char *feature_name;
 200   int rv;
 201
 202   // TODO: if plugin is not enabled do not register nodes on interfaces
 203   // rather make a structure and when enable call is used
 204   // then register nodes
 205
 206   /* *INDENT-OFF* */
 207   pool_foreach (tmp, dm->interfaces, ({
 208     if (tmp->sw_if_index == sw_if_index)
 209       {
 210         i = tmp;
 211         goto out;
 212       }
 213   }));
 214   /* *INDENT-ON* */
 215 out:
 216
 217   feature_name = is_inside ? "det44-in2out" : "det44-out2in";
 218
 219   if (is_del)
 220     {
 221       if (!i)
 222         {
 223           det44_log_err ("det44 is not enabled on this interface");
 224           return VNET_API_ERROR_INVALID_VALUE;
 225         }
 226
 227       rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
 228       if (rv)
 229         return rv;
 230
 231       rv = vnet_feature_enable_disable ("ip4-unicast", feature_name,
 232                                         sw_if_index, 1, 0, 0);
 233       if (rv)
 234         return rv;
 235
 236       pool_put (dm->interfaces, i);
 237     }
 238   else
 239     {
 240       if (i)
 241         {
 242           det44_log_err ("det44 is already enabled on this interface");
 243           return VNET_API_ERROR_INVALID_VALUE;
 244         }
 245
 246       rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
 247       if (rv)
 248         return rv;
 249
 250       rv = vnet_feature_enable_disable ("ip4-unicast", feature_name,
 251                                         sw_if_index, 1, 0, 0);
 252       if (rv)
 253         return rv;
 254
 255       pool_get (dm->interfaces, i);
 256       clib_memset (i, 0, sizeof (*i));
 257
 258       i->sw_if_index = sw_if_index;
 259
 260       if (is_inside)
 261         i->flags |= DET44_INTERFACE_FLAG_IS_INSIDE;
 262       else
 263         i->flags |= DET44_INTERFACE_FLAG_IS_OUTSIDE;
 264     }
 265
 266   if (!is_inside)
 267     {
 268       u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
 269                                                            sw_if_index);
 270       // add/del outside interface fib to registry
 271       u8 found = 0;
 272       det44_fib_t *outside_fib;
 273       /* *INDENT-OFF* */
 274       vec_foreach (outside_fib, dm->outside_fibs)
 275         {
 276           if (outside_fib->fib_index == fib_index)
 277             {
 278               if (!is_del)
 279                 {
 280                   outside_fib->refcount++;
 281                 }
 282               else
 283                 {
 284                   outside_fib->refcount--;
 285                   if (!outside_fib->refcount)
 286                     {
 287                       vec_del1 (dm->outside_fibs,
 288                                 outside_fib - dm->outside_fibs);
 289                     }
 290                 }
 291               found = 1;
 292               break;
 293             }
 294         }
 295       /* *INDENT-ON* */
 296       if (!is_del && !found)
 297         {
 298           vec_add2 (dm->outside_fibs, outside_fib, 1);
 299           outside_fib->fib_index = fib_index;
 300           outside_fib->refcount = 1;
 301         }
 302       // add/del outside address to FIB
 303       snat_det_map_t *mp;
 304       /* *INDENT-OFF* */
 305       pool_foreach (mp, dm->det_maps, ({
 306         det44_add_del_addr_to_fib(&mp->out_addr,
 307                                   mp->out_plen, sw_if_index, !is_del);
 308       }));
 309       /* *INDENT-ON* */
 310     }
 311   return 0;
 312 }
 313
 314 /**
 315  * @brief The 'det44-expire-walk' process's main loop.
 316  *
 317  * Check expire time for active sessions.
 318  */
 319 static uword
 320 det44_expire_walk_fn (vlib_main_t * vm, vlib_node_runtime_t * rt,
 321                       vlib_frame_t * f)
 322 {
 323   det44_main_t *dm = &det44_main;
 324   snat_det_session_t *ses;
 325   snat_det_map_t *mp;
 326
 327   vlib_process_wait_for_event_or_clock (vm, 10.0);
 328   vlib_process_get_events (vm, NULL);
 329   u32 now = (u32) vlib_time_now (vm);
 330   /* *INDENT-OFF* */
 331   pool_foreach (mp, dm->det_maps, ({
 332     vec_foreach(ses, mp->sessions)
 333       {
 334         /* Delete if session expired */
 335         if (ses->in_port && (ses->expire < now))
 336           snat_det_ses_close (mp, ses);
 337       }
 338   }));
 339   /* *INDENT-ON* */
 340   return 0;
 341 }
 342
 343 void
 344 det44_create_expire_walk_process ()
 345 {
 346   det44_main_t *dm = &det44_main;
 347
 348   if (dm->expire_walk_node_index)
 349     return;
 350
 351   dm->expire_walk_node_index = vlib_process_create (vlib_get_main (),
 352                                                     "det44-expire-walk",
 353                                                     det44_expire_walk_fn,
 354                                                     16 /* stack_bytes */ );
 355 }
 356
 357 int
 358 det44_plugin_enable (det44_config_t c)
 359 {
 360   det44_main_t *dm = &det44_main;
 361
 362   if (plugin_enabled () == 1)
 363     {
 364       det44_log_err ("plugin already enabled!");
 365       return 1;
 366     }
 367
 368   det44_log_err ("inside %u, outside %u", c.inside_vrf_id, c.outside_vrf_id);
 369
 370   dm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
 371                                                              c.outside_vrf_id,
 372                                                              dm->fib_src_hi);
 373   dm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
 374                                                             c.inside_vrf_id,
 375                                                             dm->fib_src_hi);
 376
 377   det44_create_expire_walk_process ();
 378   dm->mss_clamping = 0;
 379   dm->config = c;
 380   dm->enabled = 1;
 381   return 0;
 382 }
 383
 384 int
 385 det44_plugin_disable ()
 386 {
 387   det44_main_t *dm = &det44_main;
 388   det44_interface_t *i, *interfaces;
 389   snat_det_map_t *mp;
 390   int rv = 0;
 391
 392   if (plugin_enabled () == 0)
 393     {
 394       det44_log_err ("plugin already disabled!");
 395       return 1;
 396     }
 397
 398   // DET44 cleanup (order dependent)
 399   // 1) remove interfaces (det44_interface_add_del) removes map ranges from fib
 400   // 2) free sessions
 401   // 3) free maps
 402
 403   interfaces = vec_dup (dm->interfaces);
 404   vec_foreach (i, interfaces)
 405   {
 406     vnet_main_t *vnm = vnet_get_main ();
 407
 408     if (i->flags & DET44_INTERFACE_FLAG_IS_INSIDE)
 409       {
 410         rv = det44_interface_add_del (i->sw_if_index, i->flags, 1);
 411         if (rv)
 412           {
 413             det44_log_err ("inside interface %U del failed",
 414                            unformat_vnet_sw_interface, vnm, i->sw_if_index);
 415           }
 416       }
 417
 418     if (i->flags & DET44_INTERFACE_FLAG_IS_OUTSIDE)
 419       {
 420         rv = det44_interface_add_del (i->sw_if_index, i->flags, 1);
 421         if (rv)
 422           {
 423             det44_log_err ("outside interface %U del failed",
 424                            unformat_vnet_sw_interface, vnm, i->sw_if_index);
 425           }
 426
 427       }
 428   }
 429   vec_free (interfaces);
 430
 431   /* *INDENT-OFF* */
 432   pool_foreach (mp, dm->det_maps,
 433   ({
 434     vec_free (mp->sessions);
 435   }));
 436   /* *INDENT-ON* */
 437
 438   det44_reset_timeouts ();
 439   dm->enabled = 0;
 440
 441   pool_free (dm->interfaces);
 442   pool_free (dm->det_maps);
 443
 444   return rv;
 445 }
 446
 447 static void
 448 det44_update_outside_fib (ip4_main_t * im,
 449                           uword opaque,
 450                           u32 sw_if_index, u32 new_fib_index,
 451                           u32 old_fib_index)
 452 {
 453   det44_main_t *dm = &det44_main;
 454
 455   det44_fib_t *outside_fib;
 456   det44_interface_t *i;
 457
 458   u8 is_add = 1;
 459   u8 match = 0;
 460
 461   if (plugin_enabled () == 0)
 462     return;
 463
 464   if (new_fib_index == old_fib_index)
 465     return;
 466
 467   if (!vec_len (dm->outside_fibs))
 468     return;
 469
 470   /* *INDENT-OFF* */
 471   pool_foreach (i, dm->interfaces,
 472     ({
 473       if (i->sw_if_index == sw_if_index)
 474         {
 475           if (!(det44_interface_is_outside (i)))
 476             return;
 477           match = 1;
 478         }
 479     }));
 480   /* *INDENT-ON* */
 481
 482   if (!match)
 483     return;
 484
 485   vec_foreach (outside_fib, dm->outside_fibs)
 486   {
 487     if (outside_fib->fib_index == old_fib_index)
 488       {
 489         outside_fib->refcount--;
 490         if (!outside_fib->refcount)
 491           vec_del1 (dm->outside_fibs, outside_fib - dm->outside_fibs);
 492         break;
 493       }
 494   }
 495
 496   vec_foreach (outside_fib, dm->outside_fibs)
 497   {
 498     if (outside_fib->fib_index == new_fib_index)
 499       {
 500         outside_fib->refcount++;
 501         is_add = 0;
 502         break;
 503       }
 504   }
 505
 506   if (is_add)
 507     {
 508       vec_add2 (dm->outside_fibs, outside_fib, 1);
 509       outside_fib->refcount = 1;
 510       outside_fib->fib_index = new_fib_index;
 511     }
 512 }
 513
 514 static clib_error_t *
 515 det44_init (vlib_main_t * vm)
 516 {
 517   det44_main_t *dm = &det44_main;
 518   ip4_table_bind_callback_t cb;
 519   vlib_node_t *node;
 520
 521   clib_memset (dm, 0, sizeof (*dm));
 522
 523   dm->ip4_main = &ip4_main;
 524   dm->log_class = vlib_log_register_class ("det44", 0);
 525
 526   node = vlib_get_node_by_name (vm, (u8 *) "det44-in2out");
 527   dm->in2out_node_index = node->index;
 528   node = vlib_get_node_by_name (vm, (u8 *) "det44-out2in");
 529   dm->out2in_node_index = node->index;
 530
 531   dm->fib_src_hi = fib_source_allocate ("det44-hi",
 532                                         FIB_SOURCE_PRIORITY_HI,
 533                                         FIB_SOURCE_BH_SIMPLE);
 534   dm->fib_src_low = fib_source_allocate ("det44-low",
 535                                          FIB_SOURCE_PRIORITY_LOW,
 536                                          FIB_SOURCE_BH_SIMPLE);
 537
 538   cb.function = det44_update_outside_fib;
 539   cb.function_opaque = 0;
 540   vec_add1 (dm->ip4_main->table_bind_callbacks, cb);
 541
 542   det44_reset_timeouts ();
 543   return det44_api_hookup (vm);
 544 }
 545
 546 VLIB_INIT_FUNCTION (det44_init);
 547
 548 u8 *
 549 format_det44_session_state (u8 * s, va_list * args)
 550 {
 551   u32 i = va_arg (*args, u32);
 552   u8 *t = 0;
 553
 554   switch (i)
 555     {
 556 #define _(v, N, str) case DET44_SESSION_##N: t = (u8 *) str; break;
 557       foreach_det44_session_state
 558 #undef _
 559     default:
 560       t = format (t, "unknown");
 561     }
 562   s = format (s, "%s", t);
 563   return s;
 564 }
 565
 566 u8 *
 567 format_det_map_ses (u8 * s, va_list * args)
 568 {
 569   snat_det_map_t *det_map = va_arg (*args, snat_det_map_t *);
 570   ip4_address_t in_addr, out_addr;
 571   u32 in_offset, out_offset;
 572   snat_det_session_t *ses = va_arg (*args, snat_det_session_t *);
 573   u32 *i = va_arg (*args, u32 *);
 574
 575   u32 user_index = *i / DET44_SES_PER_USER;
 576   in_addr.as_u32 =
 577     clib_host_to_net_u32 (clib_net_to_host_u32 (det_map->in_addr.as_u32) +
 578                           user_index);
 579   in_offset =
 580     clib_net_to_host_u32 (in_addr.as_u32) -
 581     clib_net_to_host_u32 (det_map->in_addr.as_u32);
 582   out_offset = in_offset / det_map->sharing_ratio;
 583   out_addr.as_u32 =
 584     clib_host_to_net_u32 (clib_net_to_host_u32 (det_map->out_addr.as_u32) +
 585                           out_offset);
 586   s =
 587     format (s,
 588             "in %U:%d out %U:%d external host %U:%d state: %U expire: %d\n",
 589             format_ip4_address, &in_addr, clib_net_to_host_u16 (ses->in_port),
 590             format_ip4_address, &out_addr,
 591             clib_net_to_host_u16 (ses->out.out_port), format_ip4_address,
 592             &ses->out.ext_host_addr,
 593             clib_net_to_host_u16 (ses->out.ext_host_port),
 594             format_det44_session_state, ses->state, ses->expire);
 595
 596   return s;
 597 }
 598
 599 /*
 600  * fd.io coding-style-patch-verification: ON
 601  *
 602  * Local Variables:
 603  * eval: (c-set-style "gnu")
 604  * End:
 605  */