src/plugins/mactime/mactime.c

   1 /*
   2  * mactime.c - time-based src mac address filtration
   3  *
   4  * Copyright (c) 2018 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 #include <vnet/vnet.h>
  19 #include <vnet/plugin/plugin.h>
  20 #include <mactime/mactime.h>
  21
  22 #include <vlibapi/api.h>
  23 #include <vlibmemory/api.h>
  24 #include <vpp/app/version.h>
  25
  26 /* define message IDs */
  27 #include <mactime/mactime_msg_enum.h>
  28
  29 /* define message structures */
  30 #define vl_typedefs
  31 #include <mactime/mactime_all_api_h.h>
  32 #undef vl_typedefs
  33
  34 /* define generated endian-swappers */
  35 #define vl_endianfun
  36 #include <mactime/mactime_all_api_h.h>
  37 #undef vl_endianfun
  38
  39 /* instantiate all the print functions we know about */
  40 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  41 #define vl_printfun
  42 #include <mactime/mactime_all_api_h.h>
  43 #undef vl_printfun
  44
  45 /* Get the API version number */
  46 #define vl_api_version(n,v) static u32 api_version=(v);
  47 #include <mactime/mactime_all_api_h.h>
  48 #undef vl_api_version
  49
  50 #define REPLY_MSG_ID_BASE mm->msg_id_base
  51 #include <vlibapi/api_helper_macros.h>
  52
  53 mactime_main_t mactime_main;
  54
  55 /** \file time-base src-mac filter device-input feature arc implementation
  56  */
  57
  58 /* List of message types that this plugin understands */
  59
  60 #define foreach_mactime_plugin_api_msg                  \
  61 _(MACTIME_ENABLE_DISABLE, mactime_enable_disable)       \
  62 _(MACTIME_ADD_DEL_RANGE, mactime_add_del_range)
  63
  64 static void
  65 feature_init (mactime_main_t * mm)
  66 {
  67   if (mm->feature_initialized == 0)
  68     {
  69       /* Create the lookup table */
  70       clib_bihash_init_8_8 (&mm->lookup_table, "mactime lookup table",
  71                             mm->lookup_table_num_buckets,
  72                             mm->lookup_table_memory_size);
  73       clib_timebase_init (&mm->timebase, mm->timezone_offset,
  74                           CLIB_TIMEBASE_DAYLIGHT_USA);
  75       mm->allow_counters.name = "allow";
  76       mm->allow_counters.stat_segment_name = "/mactime/allow";
  77       mm->drop_counters.name = "drop";
  78       mm->drop_counters.stat_segment_name = "/mactime/drop";
  79       mm->feature_initialized = 1;
  80     }
  81 }
  82
  83 /** Action function shared between message handler and debug CLI
  84 */
  85 int
  86 mactime_enable_disable (mactime_main_t * mm, u32 sw_if_index,
  87                         int enable_disable)
  88 {
  89   vnet_sw_interface_t *sw;
  90   int rv = 0;
  91
  92   feature_init (mm);
  93
  94   /* Utterly wrong? */
  95   if (pool_is_free_index (mm->vnet_main->interface_main.sw_interfaces,
  96                           sw_if_index))
  97     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
  98
  99   /* Not a physical port? */
 100   sw = vnet_get_sw_interface (mm->vnet_main, sw_if_index);
 101   if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
 102     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 103
 104   vnet_feature_enable_disable ("device-input", "mactime",
 105                                sw_if_index, enable_disable, 0, 0);
 106   vnet_feature_enable_disable ("interface-output", "mactime-tx",
 107                                sw_if_index, enable_disable, 0, 0);
 108   return rv;
 109 }
 110
 111 static clib_error_t *
 112 mactime_enable_disable_command_fn (vlib_main_t * vm,
 113                                    unformat_input_t * input,
 114                                    vlib_cli_command_t * cmd)
 115 {
 116   mactime_main_t *mm = &mactime_main;
 117   u32 sw_if_index = ~0;
 118   int enable_disable = 1;
 119
 120   int rv;
 121
 122   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 123     {
 124       if (unformat (input, "disable"))
 125         enable_disable = 0;
 126       else if (unformat (input, "%U", unformat_vnet_sw_interface,
 127                          mm->vnet_main, &sw_if_index))
 128         ;
 129       else if (unformat (input, "sw_if_index %d", &sw_if_index))
 130         ;
 131       else
 132         break;
 133     }
 134
 135   if (sw_if_index == ~0)
 136     return clib_error_return (0, "Please specify an interface...");
 137
 138   rv = mactime_enable_disable (mm, sw_if_index, enable_disable);
 139
 140   switch (rv)
 141     {
 142     case 0:
 143       break;
 144
 145     case VNET_API_ERROR_INVALID_SW_IF_INDEX:
 146       return clib_error_return
 147         (0, "Invalid interface, only works on physical ports");
 148       break;
 149
 150     default:
 151       return clib_error_return (0, "mactime_enable_disable returned %d", rv);
 152     }
 153   return 0;
 154 }
 155
 156 /* *INDENT-OFF* */
 157 VLIB_CLI_COMMAND (mactime_enable_disable_command, static) =
 158 {
 159   .path = "mactime enable-disable",
 160   .short_help =
 161   "mactime enable-disable <interface-name> [disable]",
 162   .function = mactime_enable_disable_command_fn,
 163 };
 164 /* *INDENT-ON* */
 165
 166
 167 /** Enable / disable time-base src mac filtration on an interface
 168  */
 169
 170 static void vl_api_mactime_enable_disable_t_handler
 171   (vl_api_mactime_enable_disable_t * mp)
 172 {
 173   vl_api_mactime_enable_disable_reply_t *rmp;
 174   mactime_main_t *mm = &mactime_main;
 175   int rv;
 176
 177   VALIDATE_SW_IF_INDEX (mp);
 178
 179   rv = mactime_enable_disable (mm, ntohl (mp->sw_if_index),
 180                                (int) (mp->enable_disable));
 181   BAD_SW_IF_INDEX_LABEL;
 182   REPLY_MACRO (VL_API_MACTIME_ENABLE_DISABLE_REPLY);
 183 }
 184
 185 /** Create a lookup table entry for the indicated mac address
 186  */
 187 void
 188 mactime_send_create_entry_message (u8 * mac_address)
 189 {
 190   mactime_main_t *mm = &mactime_main;
 191   api_main_t *am;
 192   vl_shmem_hdr_t *shmem_hdr;
 193   u8 *name;
 194   vl_api_mactime_add_del_range_t *mp;
 195
 196   am = &api_main;
 197   shmem_hdr = am->shmem_hdr;
 198   mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
 199   clib_memset (mp, 0, sizeof (*mp));
 200   mp->_vl_msg_id = ntohs (VL_API_MACTIME_ADD_DEL_RANGE + mm->msg_id_base);
 201   name = format (0, "mac-%U", format_mac_address, mac_address);
 202
 203   memcpy (mp->device_name, name, vec_len (name));
 204   memcpy (mp->mac_address, mac_address, sizeof (mp->mac_address));
 205   /* $$$ config: create allow / drop / range */
 206   mp->allow = 1;
 207   mp->is_add = 1;
 208   vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
 209 }
 210
 211 /** Add or delete static / dynamic accept/drop configuration for a src mac
 212  */
 213
 214 static void vl_api_mactime_add_del_range_t_handler
 215   (vl_api_mactime_add_del_range_t * mp)
 216 {
 217   mactime_main_t *mm = &mactime_main;
 218   vl_api_mactime_add_del_range_reply_t *rmp;
 219   mactime_device_t *dp;
 220   clib_bihash_kv_8_8_t kv;
 221   int found = 1;
 222   clib_bihash_8_8_t *lut = &mm->lookup_table;
 223   int i, rv = 0;
 224
 225   feature_init (mm);
 226
 227   clib_memset (&kv, 0, sizeof (kv));
 228   memcpy (&kv.key, mp->mac_address, sizeof (mp->mac_address));
 229
 230   /* See if we have a lookup table entry for this src mac address */
 231   if (clib_bihash_search_8_8 (lut, &kv, &kv) < 0)
 232     found = 0;
 233
 234   /* Add an entry? */
 235   if (mp->is_add)
 236     {
 237       /* Create the device entry? */
 238       if (found == 0)
 239         {
 240           pool_get (mm->devices, dp);
 241           clib_memset (dp, 0, sizeof (*dp));
 242           vlib_validate_combined_counter (&mm->allow_counters,
 243                                           dp - mm->devices);
 244           vlib_zero_combined_counter (&mm->allow_counters, dp - mm->devices);
 245           vlib_validate_combined_counter (&mm->drop_counters,
 246                                           dp - mm->devices);
 247           vlib_zero_combined_counter (&mm->drop_counters, dp - mm->devices);
 248           mp->device_name[ARRAY_LEN (mp->device_name) - 1] = 0;
 249           dp->device_name = format (0, "%s%c", mp->device_name, 0);
 250           memcpy (dp->mac_address, mp->mac_address, sizeof (mp->mac_address));
 251           for (i = 0; i < clib_net_to_host_u32 (mp->count); i++)
 252             {
 253               clib_timebase_range_t _r, *r = &_r;
 254               r->start = mp->ranges[i].start;
 255               r->end = mp->ranges[i].end;
 256               vec_add1 (dp->ranges, r[0]);
 257             }
 258           /* If we found some time ranges */
 259           if (i)
 260             {
 261               /* Set allow/drop based on msg flags */
 262               if (mp->drop)
 263                 dp->flags = MACTIME_DEVICE_FLAG_DYNAMIC_DROP;
 264               if (mp->allow)
 265                 dp->flags = MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW;
 266             }
 267           else
 268             {
 269               /* no ranges, it's a static allow/drop */
 270               if (mp->drop)
 271                 dp->flags = MACTIME_DEVICE_FLAG_STATIC_DROP;
 272               if (mp->allow)
 273                 dp->flags = MACTIME_DEVICE_FLAG_STATIC_ALLOW;
 274             }
 275
 276           /* Add the hash table entry */
 277           kv.value = dp - mm->devices;
 278           clib_bihash_add_del_8_8 (lut, &kv, 1 /* is_add */ );
 279         }
 280       else                      /* add more ranges */
 281         {
 282           dp = pool_elt_at_index (mm->devices, kv.value);
 283           for (i = 0; i < clib_net_to_host_u32 (mp->count); i++)
 284             {
 285               clib_timebase_range_t _r, *r = &_r;
 286               r->start = mp->ranges[i].start;
 287               r->end = mp->ranges[i].end;
 288               vec_add1 (dp->ranges, r[0]);
 289             }
 290         }
 291     }
 292   else                          /* delete case */
 293     {
 294       if (found == 0)
 295         {
 296           rv = VNET_API_ERROR_NO_SUCH_ENTRY;
 297           goto reply;
 298         }
 299
 300       /* find the device entry */
 301       dp = pool_elt_at_index (mm->devices, kv.value);
 302
 303       /* Remove it from the lookup table */
 304       clib_bihash_add_del_8_8 (lut, &kv, 0 /* is_add */ );
 305       vec_free (dp->ranges);
 306       pool_put (mm->devices, dp);
 307     }
 308
 309 reply:
 310   REPLY_MACRO (VL_API_MACTIME_ADD_DEL_RANGE_REPLY);
 311 }
 312
 313 /* Set up the API message handling tables */
 314 static clib_error_t *
 315 mactime_plugin_api_hookup (vlib_main_t * vm)
 316 {
 317   mactime_main_t *mm = &mactime_main;
 318 #define _(N,n)                                                  \
 319     vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base),     \
 320                            #n,                                  \
 321                            vl_api_##n##_t_handler,              \
 322                            vl_noop_handler,                     \
 323                            vl_api_##n##_t_endian,               \
 324                            vl_api_##n##_t_print,                \
 325                            sizeof(vl_api_##n##_t), 1);
 326   foreach_mactime_plugin_api_msg;
 327 #undef _
 328
 329   return 0;
 330 }
 331
 332 #define vl_msg_name_crc_list
 333 #include <mactime/mactime_all_api_h.h>
 334 #undef vl_msg_name_crc_list
 335
 336 static void
 337 setup_message_id_table (mactime_main_t * mm, api_main_t * am)
 338 {
 339 #define _(id,n,crc)   vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + mm->msg_id_base);
 340   foreach_vl_msg_name_crc_mactime;
 341 #undef _
 342 }
 343
 344 static clib_error_t *
 345 mactime_init (vlib_main_t * vm)
 346 {
 347   mactime_main_t *mm = &mactime_main;
 348   clib_error_t *error = 0;
 349   u8 *name;
 350
 351   mm->vlib_main = vm;
 352   mm->vnet_main = vnet_get_main ();
 353
 354   name = format (0, "mactime_%08x%c", api_version, 0);
 355
 356   /* Ask for a correctly-sized block of API message decode slots */
 357   mm->msg_id_base = vl_msg_api_get_msg_ids
 358     ((char *) name, VL_MSG_FIRST_AVAILABLE);
 359
 360   error = mactime_plugin_api_hookup (vm);
 361
 362   /* Add our API messages to the global name_crc hash table */
 363   setup_message_id_table (mm, &api_main);
 364
 365   vec_free (name);
 366
 367   mm->lookup_table_num_buckets = MACTIME_NUM_BUCKETS;
 368   mm->lookup_table_memory_size = MACTIME_MEMORY_SIZE;
 369   mm->timezone_offset = -5;     /* US EST / EDT */
 370   return error;
 371 }
 372
 373 VLIB_INIT_FUNCTION (mactime_init);
 374
 375 static clib_error_t *
 376 mactime_config (vlib_main_t * vm, unformat_input_t * input)
 377 {
 378   mactime_main_t *mm = &mactime_main;
 379
 380   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 381     {
 382       if (unformat (input, "lookup-table-buckets %u",
 383                     &mm->lookup_table_num_buckets))
 384         ;
 385       else if (unformat (input, "lookup-table-memory %U",
 386                          unformat_memory_size, &mm->lookup_table_memory_size))
 387         ;
 388       else if (unformat (input, "timezone_offset %d", &mm->timezone_offset))
 389         ;
 390       else
 391         {
 392           return clib_error_return (0, "unknown input '%U'",
 393                                     format_unformat_error, input);
 394         }
 395     }
 396   return 0;
 397 }
 398
 399 VLIB_CONFIG_FUNCTION (mactime_config, "mactime");
 400
 401 /* *INDENT-OFF* */
 402 VNET_FEATURE_INIT (mactime, static) =
 403 {
 404   .arc_name = "device-input",
 405   .node_name = "mactime",
 406   .runs_before = VNET_FEATURES ("ethernet-input"),
 407 };
 408 /* *INDENT-ON */
 409
 410 /* *INDENT-OFF* */
 411 VNET_FEATURE_INIT (mactime_tx, static) =
 412 {
 413   .arc_name = "interface-output",
 414   .node_name = "mactime-tx",
 415   .runs_before = VNET_FEATURES ("interface-tx"),
 416 };
 417 /* *INDENT-ON */
 418
 419 /* *INDENT-OFF* */
 420 VLIB_PLUGIN_REGISTER () =
 421 {
 422   .version = VPP_BUILD_VER,
 423   .description = "Time-based MAC Source Address Filter",
 424 };
 425 /* *INDENT-ON* */
 426
 427 static clib_error_t *
 428 show_mactime_command_fn (vlib_main_t * vm,
 429                          unformat_input_t * input, vlib_cli_command_t * cmd)
 430 {
 431   mactime_main_t *mm = &mactime_main;
 432   mactime_device_t *dp;
 433   u8 *macstring = 0;
 434   char *status_string;
 435   u32 *pool_indices = 0;
 436   int verbose = 0;
 437   int current_status = 99;
 438   int i, j;
 439   f64 now;
 440   vlib_counter_t allow, drop;
 441   ethernet_arp_ip4_entry_t *n, *pool;
 442
 443   vec_reset_length (mm->arp_cache_copy);
 444   pool = ip4_neighbors_pool ();
 445
 446   /* *INDENT-OFF* */
 447   pool_foreach (n, pool,
 448   ({
 449     vec_add1 (mm->arp_cache_copy, n[0]);
 450   }));
 451   /* *INDENT-ON* */
 452
 453   now = clib_timebase_now (&mm->timebase);
 454
 455   if (PREDICT_FALSE ((now - mm->sunday_midnight) > 86400.0 * 7.0))
 456     mm->sunday_midnight = clib_timebase_find_sunday_midnight (now);
 457
 458   if (unformat (input, "verbose %d", &verbose))
 459     ;
 460
 461   if (unformat (input, "verbose"))
 462     verbose = 1;
 463
 464   if (verbose)
 465     vlib_cli_output (vm, "Time now: %U", format_clib_timebase_time, now);
 466
 467   /* *INDENT-OFF* */
 468   pool_foreach (dp, mm->devices,
 469   ({
 470     vec_add1 (pool_indices, dp - mm->devices);
 471   }));
 472   /* *INDENT-ON* */
 473
 474   vlib_cli_output (vm, "%-15s %18s %14s %10s %10s %10s",
 475                    "Device Name", "Addresses", "Status",
 476                    "AllowPkt", "AllowByte", "DropPkt");
 477
 478   for (i = 0; i < vec_len (pool_indices); i++)
 479     {
 480       dp = pool_elt_at_index (mm->devices, pool_indices[i]);
 481
 482       /* Check dynamic ranges */
 483       for (j = 0; j < vec_len (dp->ranges); j++)
 484         {
 485           clib_timebase_range_t *r = dp->ranges + j;
 486           f64 start0, end0;
 487
 488           start0 = r->start + mm->sunday_midnight;
 489           end0 = r->end + mm->sunday_midnight;
 490           if (verbose > 1)
 491             vlib_cli_output (vm, "  Range %d: %U - %U", j,
 492                              format_clib_timebase_time, start0,
 493                              format_clib_timebase_time, end0);
 494
 495           if (now >= start0 && now <= end0)
 496             {
 497               if (dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW)
 498                 current_status = 3;
 499               else
 500                 current_status = 2;
 501               if (verbose)
 502                 {
 503                   vlib_cli_output (vm, "  Time in range %d:", j);
 504                   vlib_cli_output (vm, "     %U - %U",
 505                                    format_clib_timebase_time, start0,
 506                                    format_clib_timebase_time, end0);
 507                 }
 508               goto print;
 509             }
 510         }
 511       if (verbose && j)
 512         vlib_cli_output (vm, "  No range match.");
 513       if (dp->flags & MACTIME_DEVICE_FLAG_STATIC_DROP)
 514         current_status = 0;
 515       if (dp->flags & MACTIME_DEVICE_FLAG_STATIC_ALLOW)
 516         current_status = 1;
 517       if (dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW)
 518         current_status = 2;
 519       if (dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_DROP)
 520         current_status = 3;
 521
 522     print:
 523       vec_reset_length (macstring);
 524       macstring = format (0, "%U", format_mac_address, dp->mac_address);
 525       switch (current_status)
 526         {
 527         case 0:
 528           status_string = "static drop";
 529           break;
 530         case 1:
 531           status_string = "static allow";
 532           break;
 533         case 2:
 534           status_string = "dynamic drop";
 535           break;
 536         case 3:
 537           status_string = "dynamic allow";
 538           break;
 539         default:
 540           status_string = "code bug!";
 541           break;
 542         }
 543       vlib_get_combined_counter (&mm->allow_counters, dp - mm->devices,
 544                                  &allow);
 545       vlib_get_combined_counter (&mm->drop_counters, dp - mm->devices, &drop);
 546       vlib_cli_output (vm, "%-15s %18s %14s %10lld %10lld %10lld",
 547                        dp->device_name, macstring, status_string,
 548                        allow.packets, allow.bytes, drop.packets);
 549       /* This is really only good for small N... */
 550       for (j = 0; j < vec_len (mm->arp_cache_copy); j++)
 551         {
 552           n = mm->arp_cache_copy + j;
 553           if (!memcmp (dp->mac_address, n->mac.bytes, sizeof (n->mac)))
 554             {
 555               vlib_cli_output (vm, "%17s%U", " ", format_ip4_address,
 556                                &n->ip4_address);
 557             }
 558         }
 559     }
 560   vec_free (macstring);
 561   vec_free (pool_indices);
 562
 563   return 0;
 564 }
 565
 566 /* *INDENT-OFF* */
 567 VLIB_CLI_COMMAND (show_mactime_command, static) =
 568 {
 569   .path = "show mactime",
 570   .short_help = "show mactime [verbose]",
 571   .function = show_mactime_command_fn,
 572 };
 573 /* *INDENT-ON* */
 574
 575 static clib_error_t *
 576 clear_mactime_command_fn (vlib_main_t * vm,
 577                           unformat_input_t * input, vlib_cli_command_t * cmd)
 578 {
 579   mactime_main_t *mm = &mactime_main;
 580
 581   if (mm->feature_initialized == 0)
 582     return clib_error_return (0, "feature not enabled");
 583
 584   vlib_clear_combined_counters (&mm->allow_counters);
 585   vlib_clear_combined_counters (&mm->drop_counters);
 586   vlib_cli_output (vm, "Mactime counters cleared...");
 587   return 0;
 588 }
 589
 590 /* *INDENT-OFF* */
 591 VLIB_CLI_COMMAND (clear_mactime_command, static) =
 592 {
 593   .path = "clear mactime",
 594   .short_help = "clear mactime counters",
 595   .function = clear_mactime_command_fn,
 596 };
 597 /* *INDENT-ON* */
 598
 599
 600
 601 /*
 602  * fd.io coding-style-patch-verification: ON
 603  *
 604  * Local Variables:
 605  * eval: (c-set-style "gnu")
 606  * End:
 607  */