7c2b7be8cf1dacf05b513cdb497ec613129953e2
[vpp.git] / 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 = ip4_fib_mtrie_lookup_step_one (mtrie0, &ip0->src_address);
166           leaf1 = ip4_fib_mtrie_lookup_step_one (mtrie1, &ip1->src_address);
167
168           leaf0 =
169             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 1);
170           leaf1 =
171             ip4_fib_mtrie_lookup_step (mtrie1, leaf1, &ip1->src_address, 1);
172
173           leaf0 =
174             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 2);
175           leaf1 =
176             ip4_fib_mtrie_lookup_step (mtrie1, leaf1, &ip1->src_address, 2);
177
178           leaf0 =
179             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 3);
180           leaf1 =
181             ip4_fib_mtrie_lookup_step (mtrie1, leaf1, &ip1->src_address, 3);
182
183           lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
184           lb_index1 = ip4_fib_mtrie_leaf_get_adj_index (leaf1);
185
186           lb0 = load_balance_get (lb_index0);
187           lb1 = load_balance_get (lb_index1);
188
189           /* Pass multicast. */
190           pass0 = ip4_address_is_multicast (&ip0->src_address)
191             || ip0->src_address.as_u32 == clib_host_to_net_u32 (0xFFFFFFFF);
192           pass1 = ip4_address_is_multicast (&ip1->src_address)
193             || ip1->src_address.as_u32 == clib_host_to_net_u32 (0xFFFFFFFF);
194
195           if (IP4_SOURCE_CHECK_REACHABLE_VIA_RX == source_check_type)
196             {
197               pass0 |= fib_urpf_check (lb0->lb_urpf,
198                                        vnet_buffer (p0)->sw_if_index
199                                        [VLIB_RX]);
200               pass1 |=
201                 fib_urpf_check (lb1->lb_urpf,
202                                 vnet_buffer (p1)->sw_if_index[VLIB_RX]);
203             }
204           else
205             {
206               pass0 |= fib_urpf_check_size (lb0->lb_urpf);
207               pass1 |= fib_urpf_check_size (lb1->lb_urpf);
208             }
209           next0 = (pass0 ? next0 : IP4_SOURCE_CHECK_NEXT_DROP);
210           next1 = (pass1 ? next1 : IP4_SOURCE_CHECK_NEXT_DROP);
211
212           p0->error =
213             error_node->errors[IP4_ERROR_UNICAST_SOURCE_CHECK_FAILS];
214           p1->error =
215             error_node->errors[IP4_ERROR_UNICAST_SOURCE_CHECK_FAILS];
216
217           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
218                                            to_next, n_left_to_next,
219                                            pi0, pi1, next0, next1);
220         }
221
222       while (n_left_from > 0 && n_left_to_next > 0)
223         {
224           vlib_buffer_t *p0;
225           ip4_header_t *ip0;
226           ip4_fib_mtrie_t *mtrie0;
227           ip4_fib_mtrie_leaf_t leaf0;
228           ip4_source_check_config_t *c0;
229           u32 pi0, next0, pass0, lb_index0;
230           const load_balance_t *lb0;
231
232           pi0 = from[0];
233           to_next[0] = pi0;
234           from += 1;
235           to_next += 1;
236           n_left_from -= 1;
237           n_left_to_next -= 1;
238
239           p0 = vlib_get_buffer (vm, pi0);
240           ip0 = vlib_buffer_get_current (p0);
241
242           c0 =
243             vnet_feature_next_with_data (vnet_buffer (p0)->sw_if_index
244                                          [VLIB_RX], &next0, p0,
245                                          sizeof (c0[0]));
246
247           mtrie0 = &ip4_fib_get (c0->fib_index)->mtrie;
248
249           leaf0 = ip4_fib_mtrie_lookup_step_one (mtrie0, &ip0->src_address);
250
251           leaf0 =
252             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 1);
253
254           leaf0 =
255             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 2);
256
257           leaf0 =
258             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 3);
259
260           lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
261
262           lb0 = load_balance_get (lb_index0);
263
264           /* Pass multicast. */
265           pass0 = ip4_address_is_multicast (&ip0->src_address)
266             || ip0->src_address.as_u32 == clib_host_to_net_u32 (0xFFFFFFFF);
267
268           if (IP4_SOURCE_CHECK_REACHABLE_VIA_RX == source_check_type)
269             {
270               pass0 |= fib_urpf_check (lb0->lb_urpf,
271                                        vnet_buffer (p0)->sw_if_index
272                                        [VLIB_RX]);
273             }
274           else
275             {
276               pass0 |= fib_urpf_check_size (lb0->lb_urpf);
277             }
278
279           next0 = (pass0 ? next0 : IP4_SOURCE_CHECK_NEXT_DROP);
280           p0->error =
281             error_node->errors[IP4_ERROR_UNICAST_SOURCE_CHECK_FAILS];
282
283           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
284                                            to_next, n_left_to_next,
285                                            pi0, next0);
286         }
287
288       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
289     }
290
291   return frame->n_vectors;
292 }
293
294 static uword
295 ip4_source_check_reachable_via_any (vlib_main_t * vm,
296                                     vlib_node_runtime_t * node,
297                                     vlib_frame_t * frame)
298 {
299   return ip4_source_check_inline (vm, node, frame,
300                                   IP4_SOURCE_CHECK_REACHABLE_VIA_ANY);
301 }
302
303 static uword
304 ip4_source_check_reachable_via_rx (vlib_main_t * vm,
305                                    vlib_node_runtime_t * node,
306                                    vlib_frame_t * frame)
307 {
308   return ip4_source_check_inline (vm, node, frame,
309                                   IP4_SOURCE_CHECK_REACHABLE_VIA_RX);
310 }
311
312 /* *INDENT-OFF* */
313 VLIB_REGISTER_NODE (ip4_check_source_reachable_via_any) = {
314   .function = ip4_source_check_reachable_via_any,
315   .name = "ip4-source-check-via-any",
316   .vector_size = sizeof (u32),
317
318   .n_next_nodes = IP4_SOURCE_CHECK_N_NEXT,
319   .next_nodes = {
320     [IP4_SOURCE_CHECK_NEXT_DROP] = "error-drop",
321   },
322
323   .format_buffer = format_ip4_header,
324   .format_trace = format_ip4_source_check_trace,
325 };
326 /* *INDENT-ON* */
327
328 VLIB_NODE_FUNCTION_MULTIARCH (ip4_check_source_reachable_via_any,
329                               ip4_source_check_reachable_via_any);
330
331 /* *INDENT-OFF* */
332 VLIB_REGISTER_NODE (ip4_check_source_reachable_via_rx) = {
333   .function = ip4_source_check_reachable_via_rx,
334   .name = "ip4-source-check-via-rx",
335   .vector_size = sizeof (u32),
336
337   .n_next_nodes = IP4_SOURCE_CHECK_N_NEXT,
338   .next_nodes = {
339     [IP4_SOURCE_CHECK_NEXT_DROP] = "error-drop",
340   },
341
342   .format_buffer = format_ip4_header,
343   .format_trace = format_ip4_source_check_trace,
344 };
345 /* *INDENT-ON* */
346
347 VLIB_NODE_FUNCTION_MULTIARCH (ip4_check_source_reachable_via_rx,
348                               ip4_source_check_reachable_via_rx);
349
350 static clib_error_t *
351 set_ip_source_check (vlib_main_t * vm,
352                      unformat_input_t * input, vlib_cli_command_t * cmd)
353 {
354   unformat_input_t _line_input, *line_input = &_line_input;
355   vnet_main_t *vnm = vnet_get_main ();
356   ip4_main_t *im = &ip4_main;
357   clib_error_t *error = 0;
358   u32 sw_if_index, is_del;
359   ip4_source_check_config_t config;
360   char *feature_name = "ip4-source-check-via-rx";
361
362   sw_if_index = ~0;
363   is_del = 0;
364
365   if (!unformat_user (input, unformat_line_input, line_input))
366     return 0;
367
368   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
369     {
370       if (unformat_user
371           (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
372         ;
373       else if (unformat (line_input, "del"))
374         is_del = 1;
375       else if (unformat (line_input, "loose"))
376         feature_name = "ip4-source-check-via-any";
377       else
378         {
379           error = unformat_parse_error (line_input);
380           goto done;
381         }
382     }
383
384   if (~0 == sw_if_index)
385     {
386       error = clib_error_return (0, "unknown interface `%U'",
387                                  format_unformat_error, line_input);
388       goto done;
389     }
390
391   config.fib_index = im->fib_index_by_sw_if_index[sw_if_index];
392   vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index,
393                                is_del == 0, &config, sizeof (config));
394 done:
395   unformat_free (line_input);
396
397   return error;
398 }
399
400 /*?
401  * This command adds the 'ip4-source-check-via-rx' graph node for
402  * a given interface. By adding the IPv4 source check graph node to
403  * an interface, the code verifies that the source address of incoming
404  * unicast packets are reachable over the incoming interface. Two flavours
405  * are supported (the default is strict):
406  * - loose: accept ingress packet if there is a route to reach the source
407  * - strict: accept ingress packet if it arrived on an interface which
408  *          the route to the source uses. i.e. an interface that the source
409  *          is reachable via.
410  *
411  * @cliexpar
412  * @parblock
413  * Example of graph node before range checking is enabled:
414  * @cliexstart{show vlib graph ip4-source-check-via-rx}
415  *            Name                      Next                    Previous
416  * ip4-source-check-via-rx         error-drop [0]
417  * @cliexend
418  *
419  * Example of how to enable unicast source checking on an interface:
420  * @cliexcmd{set interface ip source-check GigabitEthernet2/0/0 loose}
421  *
422  * Example of graph node after range checking is enabled:
423  * @cliexstart{show vlib graph ip4-source-check-via-rx}
424  *            Name                      Next                    Previous
425  * ip4-source-check-via-rx         error-drop [0]         ip4-input-no-checksum
426  *                           ip4-source-and-port-range-         ip4-input
427  * @cliexend
428  *
429  * Example of how to display the feature enabed on an interface:
430  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
431  * IP feature paths configured on GigabitEthernet2/0/0...
432  *
433  * ipv4 unicast:
434  *   ip4-source-check-via-rx
435  *   ip4-lookup
436  *
437  * ipv4 multicast:
438  *   ip4-lookup-multicast
439  *
440  * ipv4 multicast:
441  *   interface-output
442  *
443  * ipv6 unicast:
444  *   ip6-lookup
445  *
446  * ipv6 multicast:
447  *   ip6-lookup
448  *
449  * ipv6 multicast:
450  *   interface-output
451  * @cliexend
452  *
453  * Example of how to disable unicast source checking on an interface:
454  * @cliexcmd{set interface ip source-check GigabitEthernet2/0/0 del}
455  * @endparblock
456 ?*/
457 /* *INDENT-OFF* */
458 VLIB_CLI_COMMAND (set_interface_ip_source_check_command, static) = {
459   .path = "set interface ip source-check",
460   .function = set_ip_source_check,
461   .short_help = "set interface ip source-check <interface> [strict|loose] [del]",
462 };
463 /* *INDENT-ON* */
464
465 static clib_error_t *
466 ip_source_check_accept (vlib_main_t * vm,
467                         unformat_input_t * input, vlib_cli_command_t * cmd)
468 {
469   unformat_input_t _line_input, *line_input = &_line_input;
470   fib_prefix_t pfx = {
471     .fp_proto = FIB_PROTOCOL_IP4,
472   };
473   clib_error_t *error = NULL;
474   u32 table_id, is_add, fib_index;
475
476   is_add = 1;
477   table_id = ~0;
478
479   /* Get a line of input. */
480   if (!unformat_user (input, unformat_line_input, line_input))
481     return 0;
482
483   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
484     {
485       if (unformat (line_input, "table %d", &table_id))
486         ;
487       else if (unformat (line_input, "del"))
488         is_add = 0;
489       else if (unformat (line_input, "add"))
490         is_add = 1;
491       else if (unformat (line_input, "%U/%d",
492                          unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
493         pfx.fp_proto = FIB_PROTOCOL_IP4;
494       else
495         {
496           error = unformat_parse_error (line_input);
497           goto done;
498         }
499     }
500
501   if (~0 != table_id)
502     {
503       fib_index = fib_table_id_find_fib_index (pfx.fp_proto, table_id);
504       if (~0 == fib_index)
505         {
506           error = clib_error_return (0, "Nonexistent table id %d", table_id);
507           goto done;
508         }
509     }
510   else
511     {
512       fib_index = 0;
513     }
514
515   if (is_add)
516     {
517       fib_table_entry_special_add (fib_index,
518                                    &pfx,
519                                    FIB_SOURCE_URPF_EXEMPT,
520                                    FIB_ENTRY_FLAG_DROP, ADJ_INDEX_INVALID);
521     }
522   else
523     {
524       fib_table_entry_special_remove (fib_index,
525                                       &pfx, FIB_SOURCE_URPF_EXEMPT);
526     }
527
528 done:
529   unformat_free (line_input);
530
531   return error;
532 }
533
534 /*?
535  * Add an exemption for a prefix to pass the Unicast Reverse Path
536  * Forwarding (uRPF) loose check. This is for testing purposes only.
537  * If the '<em>table</em>' is not enter it is defaulted to 0. Default
538  * is to '<em>add</em>'. VPP always performs a loose uRPF check for
539  * for-us traffic.
540  *
541  * @cliexpar
542  * Example of how to add a uRPF exception to a FIB table to pass the
543  * loose RPF tests:
544  * @cliexcmd{ip urpf-accept table 7 add}
545 ?*/
546 /* *INDENT-OFF* */
547 VLIB_CLI_COMMAND (ip_source_check_accept_command, static) = {
548   .path = "ip urpf-accept",
549   .function = ip_source_check_accept,
550   .short_help = "ip urpf-accept [table <table-id>] [add|del]",
551 };
552 /* *INDENT-ON* */
553
554
555 /* Dummy init function to get us linked in. */
556 clib_error_t *
557 ip4_source_check_init (vlib_main_t * vm)
558 {
559   return 0;
560 }
561
562 VLIB_INIT_FUNCTION (ip4_source_check_init);
563
564 /*
565  * fd.io coding-style-patch-verification: ON
566  *
567  * Local Variables:
568  * eval: (c-set-style "gnu")
569  * End:
570  */