src/vnet/ip/ip4_source_check.c

   1 /*
   2  * Copyright (c) 2015 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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 /*
  16  * ip/ip4_source_check.c: IP v4 check source address (unicast RPF check)
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <vnet/ip/ip.h>
  41 #include <vnet/fib/ip4_fib.h>
  42 #include <vnet/fib/fib_urpf_list.h>
  43 #include <vnet/dpo/load_balance.h>
  44
  45 /**
  46  * @file
  47  * @brief IPv4 Unicast Source Check.
  48  *
  49  * This file contains the IPv4 interface unicast source check.
  50  */
  51
  52
  53 typedef struct
  54 {
  55   u8 packet_data[64];
  56   index_t urpf;
  57 } ip4_source_check_trace_t;
  58
  59 static u8 *
  60 format_ip4_source_check_trace (u8 * s, va_list * va)
  61 {
  62   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
  63   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
  64   ip4_source_check_trace_t *t = va_arg (*va, ip4_source_check_trace_t *);
  65
  66   s = format (s, "%U",
  67               format_ip4_header, t->packet_data, sizeof (t->packet_data));
  68
  69   return s;
  70 }
  71
  72 typedef enum
  73 {
  74   IP4_SOURCE_CHECK_NEXT_DROP,
  75   IP4_SOURCE_CHECK_N_NEXT,
  76 } ip4_source_check_next_t;
  77
  78 typedef enum
  79 {
  80   IP4_SOURCE_CHECK_REACHABLE_VIA_RX,
  81   IP4_SOURCE_CHECK_REACHABLE_VIA_ANY,
  82 } ip4_source_check_type_t;
  83
  84 typedef union
  85 {
  86   u32 fib_index;
  87 } ip4_source_check_config_t;
  88
  89 always_inline uword
  90 ip4_source_check_inline (vlib_main_t * vm,
  91                          vlib_node_runtime_t * node,
  92                          vlib_frame_t * frame,
  93                          ip4_source_check_type_t source_check_type)
  94 {
  95   u32 n_left_from, *from, *to_next;
  96   u32 next_index;
  97   vlib_node_runtime_t *error_node =
  98     vlib_node_get_runtime (vm, ip4_input_node.index);
  99
 100   from = vlib_frame_vector_args (frame);
 101   n_left_from = frame->n_vectors;
 102   next_index = node->cached_next_index;
 103
 104   if (node->flags & VLIB_NODE_FLAG_TRACE)
 105     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 106                                    /* stride */ 1,
 107                                    sizeof (ip4_source_check_trace_t));
 108
 109   while (n_left_from > 0)
 110     {
 111       u32 n_left_to_next;
 112
 113       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 114
 115       while (n_left_from >= 4 && n_left_to_next >= 2)
 116         {
 117           vlib_buffer_t *p0, *p1;
 118           ip4_header_t *ip0, *ip1;
 119           ip4_fib_mtrie_t *mtrie0, *mtrie1;
 120           ip4_fib_mtrie_leaf_t leaf0, leaf1;
 121           ip4_source_check_config_t *c0, *c1;
 122           const load_balance_t *lb0, *lb1;
 123           u32 pi0, next0, pass0, lb_index0;
 124           u32 pi1, next1, pass1, lb_index1;
 125
 126           /* Prefetch next iteration. */
 127           {
 128             vlib_buffer_t *p2, *p3;
 129
 130             p2 = vlib_get_buffer (vm, from[2]);
 131             p3 = vlib_get_buffer (vm, from[3]);
 132
 133             vlib_prefetch_buffer_header (p2, LOAD);
 134             vlib_prefetch_buffer_header (p3, LOAD);
 135
 136             CLIB_PREFETCH (p2->data, sizeof (ip0[0]), LOAD);
 137             CLIB_PREFETCH (p3->data, sizeof (ip1[0]), LOAD);
 138           }
 139
 140           pi0 = to_next[0] = from[0];
 141           pi1 = to_next[1] = from[1];
 142           from += 2;
 143           to_next += 2;
 144           n_left_from -= 2;
 145           n_left_to_next -= 2;
 146
 147           p0 = vlib_get_buffer (vm, pi0);
 148           p1 = vlib_get_buffer (vm, pi1);
 149
 150           ip0 = vlib_buffer_get_current (p0);
 151           ip1 = vlib_buffer_get_current (p1);
 152
 153           c0 =
 154             vnet_feature_next_with_data (vnet_buffer (p0)->sw_if_index
 155                                          [VLIB_RX], &next0, p0,
 156                                          sizeof (c0[0]));
 157           c1 =
 158             vnet_feature_next_with_data (vnet_buffer (p1)->sw_if_index
 159                                          [VLIB_RX], &next1, p1,
 160                                          sizeof (c1[0]));
 161
 162           mtrie0 = &ip4_fib_get (c0->fib_index)->mtrie;
 163           mtrie1 = &ip4_fib_get (c1->fib_index)->mtrie;
 164
 165           leaf0 = leaf1 = IP4_FIB_MTRIE_LEAF_ROOT;
 166
 167           leaf0 =
 168             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 0);
 169           leaf1 =
 170             ip4_fib_mtrie_lookup_step (mtrie1, leaf1, &ip1->src_address, 0);
 171
 172           leaf0 =
 173             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 1);
 174           leaf1 =
 175             ip4_fib_mtrie_lookup_step (mtrie1, leaf1, &ip1->src_address, 1);
 176
 177           leaf0 =
 178             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 2);
 179           leaf1 =
 180             ip4_fib_mtrie_lookup_step (mtrie1, leaf1, &ip1->src_address, 2);
 181
 182           leaf0 =
 183             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 3);
 184           leaf1 =
 185             ip4_fib_mtrie_lookup_step (mtrie1, leaf1, &ip1->src_address, 3);
 186
 187           lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
 188           lb_index1 = ip4_fib_mtrie_leaf_get_adj_index (leaf1);
 189
 190           lb0 = load_balance_get (lb_index0);
 191           lb1 = load_balance_get (lb_index1);
 192
 193           /* Pass multicast. */
 194           pass0 = ip4_address_is_multicast (&ip0->src_address)
 195             || ip0->src_address.as_u32 == clib_host_to_net_u32 (0xFFFFFFFF);
 196           pass1 = ip4_address_is_multicast (&ip1->src_address)
 197             || ip1->src_address.as_u32 == clib_host_to_net_u32 (0xFFFFFFFF);
 198
 199           if (IP4_SOURCE_CHECK_REACHABLE_VIA_RX == source_check_type)
 200             {
 201               pass0 |= fib_urpf_check (lb0->lb_urpf,
 202                                        vnet_buffer (p0)->sw_if_index
 203                                        [VLIB_RX]);
 204               pass1 |=
 205                 fib_urpf_check (lb1->lb_urpf,
 206                                 vnet_buffer (p1)->sw_if_index[VLIB_RX]);
 207             }
 208           else
 209             {
 210               pass0 |= fib_urpf_check_size (lb0->lb_urpf);
 211               pass1 |= fib_urpf_check_size (lb1->lb_urpf);
 212             }
 213           next0 = (pass0 ? next0 : IP4_SOURCE_CHECK_NEXT_DROP);
 214           next1 = (pass1 ? next1 : IP4_SOURCE_CHECK_NEXT_DROP);
 215
 216           p0->error =
 217             error_node->errors[IP4_ERROR_UNICAST_SOURCE_CHECK_FAILS];
 218           p1->error =
 219             error_node->errors[IP4_ERROR_UNICAST_SOURCE_CHECK_FAILS];
 220
 221           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
 222                                            to_next, n_left_to_next,
 223                                            pi0, pi1, next0, next1);
 224         }
 225
 226       while (n_left_from > 0 && n_left_to_next > 0)
 227         {
 228           vlib_buffer_t *p0;
 229           ip4_header_t *ip0;
 230           ip4_fib_mtrie_t *mtrie0;
 231           ip4_fib_mtrie_leaf_t leaf0;
 232           ip4_source_check_config_t *c0;
 233           u32 pi0, next0, pass0, lb_index0;
 234           const load_balance_t *lb0;
 235
 236           pi0 = from[0];
 237           to_next[0] = pi0;
 238           from += 1;
 239           to_next += 1;
 240           n_left_from -= 1;
 241           n_left_to_next -= 1;
 242
 243           p0 = vlib_get_buffer (vm, pi0);
 244           ip0 = vlib_buffer_get_current (p0);
 245
 246           c0 =
 247             vnet_feature_next_with_data (vnet_buffer (p0)->sw_if_index
 248                                          [VLIB_RX], &next0, p0,
 249                                          sizeof (c0[0]));
 250
 251           mtrie0 = &ip4_fib_get (c0->fib_index)->mtrie;
 252
 253           leaf0 = IP4_FIB_MTRIE_LEAF_ROOT;
 254
 255           leaf0 =
 256             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 0);
 257
 258           leaf0 =
 259             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 1);
 260
 261           leaf0 =
 262             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 2);
 263
 264           leaf0 =
 265             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 3);
 266
 267           lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
 268
 269           lb0 = load_balance_get (lb_index0);
 270
 271           /* Pass multicast. */
 272           pass0 = ip4_address_is_multicast (&ip0->src_address)
 273             || ip0->src_address.as_u32 == clib_host_to_net_u32 (0xFFFFFFFF);
 274
 275           if (IP4_SOURCE_CHECK_REACHABLE_VIA_RX == source_check_type)
 276             {
 277               pass0 |= fib_urpf_check (lb0->lb_urpf,
 278                                        vnet_buffer (p0)->sw_if_index
 279                                        [VLIB_RX]);
 280             }
 281           else
 282             {
 283               pass0 |= fib_urpf_check_size (lb0->lb_urpf);
 284             }
 285
 286           next0 = (pass0 ? next0 : IP4_SOURCE_CHECK_NEXT_DROP);
 287           p0->error =
 288             error_node->errors[IP4_ERROR_UNICAST_SOURCE_CHECK_FAILS];
 289
 290           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 291                                            to_next, n_left_to_next,
 292                                            pi0, next0);
 293         }
 294
 295       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 296     }
 297
 298   return frame->n_vectors;
 299 }
 300
 301 static uword
 302 ip4_source_check_reachable_via_any (vlib_main_t * vm,
 303                                     vlib_node_runtime_t * node,
 304                                     vlib_frame_t * frame)
 305 {
 306   return ip4_source_check_inline (vm, node, frame,
 307                                   IP4_SOURCE_CHECK_REACHABLE_VIA_ANY);
 308 }
 309
 310 static uword
 311 ip4_source_check_reachable_via_rx (vlib_main_t * vm,
 312                                    vlib_node_runtime_t * node,
 313                                    vlib_frame_t * frame)
 314 {
 315   return ip4_source_check_inline (vm, node, frame,
 316                                   IP4_SOURCE_CHECK_REACHABLE_VIA_RX);
 317 }
 318
 319 /* *INDENT-OFF* */
 320 VLIB_REGISTER_NODE (ip4_check_source_reachable_via_any) = {
 321   .function = ip4_source_check_reachable_via_any,
 322   .name = "ip4-source-check-via-any",
 323   .vector_size = sizeof (u32),
 324
 325   .n_next_nodes = IP4_SOURCE_CHECK_N_NEXT,
 326   .next_nodes = {
 327     [IP4_SOURCE_CHECK_NEXT_DROP] = "error-drop",
 328   },
 329
 330   .format_buffer = format_ip4_header,
 331   .format_trace = format_ip4_source_check_trace,
 332 };
 333 /* *INDENT-ON* */
 334
 335 VLIB_NODE_FUNCTION_MULTIARCH (ip4_check_source_reachable_via_any,
 336                               ip4_source_check_reachable_via_any);
 337
 338 /* *INDENT-OFF* */
 339 VLIB_REGISTER_NODE (ip4_check_source_reachable_via_rx) = {
 340   .function = ip4_source_check_reachable_via_rx,
 341   .name = "ip4-source-check-via-rx",
 342   .vector_size = sizeof (u32),
 343
 344   .n_next_nodes = IP4_SOURCE_CHECK_N_NEXT,
 345   .next_nodes = {
 346     [IP4_SOURCE_CHECK_NEXT_DROP] = "error-drop",
 347   },
 348
 349   .format_buffer = format_ip4_header,
 350   .format_trace = format_ip4_source_check_trace,
 351 };
 352 /* *INDENT-ON* */
 353
 354 VLIB_NODE_FUNCTION_MULTIARCH (ip4_check_source_reachable_via_rx,
 355                               ip4_source_check_reachable_via_rx);
 356
 357 static clib_error_t *
 358 set_ip_source_check (vlib_main_t * vm,
 359                      unformat_input_t * input, vlib_cli_command_t * cmd)
 360 {
 361   unformat_input_t _line_input, *line_input = &_line_input;
 362   vnet_main_t *vnm = vnet_get_main ();
 363   ip4_main_t *im = &ip4_main;
 364   clib_error_t *error = 0;
 365   u32 sw_if_index, is_del;
 366   ip4_source_check_config_t config;
 367   char *feature_name = "ip4-source-check-via-rx";
 368
 369   sw_if_index = ~0;
 370   is_del = 0;
 371
 372   if (!unformat_user (input, unformat_line_input, line_input))
 373     return 0;
 374
 375   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 376     {
 377       if (unformat_user
 378           (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 379         ;
 380       else if (unformat (line_input, "del"))
 381         is_del = 1;
 382       else if (unformat (line_input, "loose"))
 383         feature_name = "ip4-source-check-via-any";
 384       else
 385         {
 386           error = unformat_parse_error (line_input);
 387           goto done;
 388         }
 389     }
 390
 391   if (~0 == sw_if_index)
 392     {
 393       error = clib_error_return (0, "unknown interface `%U'",
 394                                  format_unformat_error, line_input);
 395       goto done;
 396     }
 397
 398   config.fib_index = im->fib_index_by_sw_if_index[sw_if_index];
 399   vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index,
 400                                is_del == 0, &config, sizeof (config));
 401 done:
 402   return error;
 403 }
 404
 405 /*?
 406  * This command adds the 'ip4-source-check-via-rx' graph node for
 407  * a given interface. By adding the IPv4 source check graph node to
 408  * an interface, the code verifies that the source address of incoming
 409  * unicast packets are reachable over the incoming interface. Two flavours
 410  * are supported (the default is strict):
 411  * - loose: accept ingress packet if there is a route to reach the source
 412  * - strict: accept ingress packet if it arrived on an interface which
 413  *          the route to the source uses. i.e. an interface that the source
 414  *          is reachable via.
 415  *
 416  * @cliexpar
 417  * @parblock
 418  * Example of graph node before range checking is enabled:
 419  * @cliexstart{show vlib graph ip4-source-check-via-rx}
 420  *            Name                      Next                    Previous
 421  * ip4-source-check-via-rx         error-drop [0]
 422  * @cliexend
 423  *
 424  * Example of how to enable unicast source checking on an interface:
 425  * @cliexcmd{set interface ip source-check GigabitEthernet2/0/0 loose}
 426  *
 427  * Example of graph node after range checking is enabled:
 428  * @cliexstart{show vlib graph ip4-source-check-via-rx}
 429  *            Name                      Next                    Previous
 430  * ip4-source-check-via-rx         error-drop [0]         ip4-input-no-checksum
 431  *                           ip4-source-and-port-range-         ip4-input
 432  * @cliexend
 433  *
 434  * Example of how to display the feature enabed on an interface:
 435  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
 436  * IP feature paths configured on GigabitEthernet2/0/0...
 437  *
 438  * ipv4 unicast:
 439  *   ip4-source-check-via-rx
 440  *   ip4-lookup
 441  *
 442  * ipv4 multicast:
 443  *   ip4-lookup-multicast
 444  *
 445  * ipv4 multicast:
 446  *   interface-output
 447  *
 448  * ipv6 unicast:
 449  *   ip6-lookup
 450  *
 451  * ipv6 multicast:
 452  *   ip6-lookup
 453  *
 454  * ipv6 multicast:
 455  *   interface-output
 456  * @cliexend
 457  *
 458  * Example of how to disable unicast source checking on an interface:
 459  * @cliexcmd{set interface ip source-check GigabitEthernet2/0/0 del}
 460  * @endparblock
 461 ?*/
 462 /* *INDENT-OFF* */
 463 VLIB_CLI_COMMAND (set_interface_ip_source_check_command, static) = {
 464   .path = "set interface ip source-check",
 465   .function = set_ip_source_check,
 466   .short_help = "set interface ip source-check <interface> [strict|loose] [del]",
 467 };
 468 /* *INDENT-ON* */
 469
 470 static clib_error_t *
 471 ip_source_check_accept (vlib_main_t * vm,
 472                         unformat_input_t * input, vlib_cli_command_t * cmd)
 473 {
 474   unformat_input_t _line_input, *line_input = &_line_input;
 475   fib_prefix_t pfx = {
 476     .fp_proto = FIB_PROTOCOL_IP4,
 477   };
 478   clib_error_t *error = NULL;
 479   u32 table_id, is_add, fib_index;
 480
 481   is_add = 1;
 482   table_id = ~0;
 483
 484   /* Get a line of input. */
 485   if (!unformat_user (input, unformat_line_input, line_input))
 486     return 0;
 487
 488   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 489     {
 490       if (unformat (line_input, "table %d", &table_id))
 491         ;
 492       else if (unformat (line_input, "del"))
 493         is_add = 0;
 494       else if (unformat (line_input, "add"))
 495         is_add = 1;
 496       else if (unformat (line_input, "%U/%d",
 497                          unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
 498         pfx.fp_proto = FIB_PROTOCOL_IP4;
 499       else
 500         {
 501           error = unformat_parse_error (line_input);
 502           goto done;
 503         }
 504     }
 505
 506   if (~0 != table_id)
 507     {
 508       fib_index = fib_table_id_find_fib_index (pfx.fp_proto, table_id);
 509       if (~0 == fib_index)
 510         {
 511           error = clib_error_return (0, "Nonexistent table id %d", table_id);
 512           goto done;
 513         }
 514     }
 515   else
 516     {
 517       fib_index = 0;
 518     }
 519
 520   if (is_add)
 521     {
 522       fib_table_entry_special_add (fib_index,
 523                                    &pfx,
 524                                    FIB_SOURCE_URPF_EXEMPT,
 525                                    FIB_ENTRY_FLAG_DROP, ADJ_INDEX_INVALID);
 526     }
 527   else
 528     {
 529       fib_table_entry_special_remove (fib_index,
 530                                       &pfx, FIB_SOURCE_URPF_EXEMPT);
 531     }
 532
 533 done:
 534   return (error);
 535 }
 536
 537 /*?
 538  * Add an exemption for a prefix to pass the Unicast Reverse Path
 539  * Forwarding (uRPF) loose check. This is for testing purposes only.
 540  * If the '<em>table</em>' is not enter it is defaulted to 0. Default
 541  * is to '<em>add</em>'. VPP always performs a loose uRPF check for
 542  * for-us traffic.
 543  *
 544  * @cliexpar
 545  * Example of how to add a uRPF exception to a FIB table to pass the
 546  * loose RPF tests:
 547  * @cliexcmd{ip urpf-accept table 7 add}
 548 ?*/
 549 /* *INDENT-OFF* */
 550 VLIB_CLI_COMMAND (ip_source_check_accept_command, static) = {
 551   .path = "ip urpf-accept",
 552   .function = ip_source_check_accept,
 553   .short_help = "ip urpf-accept [table <table-id>] [add|del]",
 554 };
 555 /* *INDENT-ON* */
 556
 557
 558 /* Dummy init function to get us linked in. */
 559 clib_error_t *
 560 ip4_source_check_init (vlib_main_t * vm)
 561 {
 562   return 0;
 563 }
 564
 565 VLIB_INIT_FUNCTION (ip4_source_check_init);
 566
 567 /*
 568  * fd.io coding-style-patch-verification: ON
 569  *
 570  * Local Variables:
 571  * eval: (c-set-style "gnu")
 572  * End:
 573  */