2 * Copyright (C) 2018 6WIND
4 * FRRouting is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2, or (at your option) any
9 * FRRouting is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; see the file COPYING; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "bgpd/bgpd.h"
23 #include "bgpd/bgp_table.h"
24 #include "bgpd/bgp_attr.h"
25 #include "bgpd/bgp_ecommunity.h"
26 #include "bgpd/bgp_vty.h"
27 #include "bgpd/bgp_route.h"
28 #include "bgpd/bgp_aspath.h"
29 #include "bgpd/bgp_flowspec.h"
30 #include "bgpd/bgp_flowspec_util.h"
31 #include "bgpd/bgp_flowspec_private.h"
32 #include "bgpd/bgp_debug.h"
33 #include "bgpd/bgp_pbr.h"
35 /* Local Structures and variables declarations
36 * This code block hosts the struct declared that host the flowspec rules
37 * as well as some structure used to convert to stringx
40 static const struct message bgp_flowspec_display_large
[] = {
41 {FLOWSPEC_DEST_PREFIX
, "Destination Address"},
42 {FLOWSPEC_SRC_PREFIX
, "Source Address"},
43 {FLOWSPEC_IP_PROTOCOL
, "IP Protocol"},
44 {FLOWSPEC_PORT
, "Port"},
45 {FLOWSPEC_DEST_PORT
, "Destination Port"},
46 {FLOWSPEC_SRC_PORT
, "Source Port"},
47 {FLOWSPEC_ICMP_TYPE
, "ICMP Type"},
48 {FLOWSPEC_ICMP_CODE
, "ICMP Code"},
49 {FLOWSPEC_TCP_FLAGS
, "TCP Flags"},
50 {FLOWSPEC_PKT_LEN
, "Packet Length"},
51 {FLOWSPEC_DSCP
, "DSCP field"},
52 {FLOWSPEC_FRAGMENT
, "Packet Fragment"},
53 {FLOWSPEC_FLOW_LABEL
, "Packet Flow Label"},
57 static const struct message bgp_flowspec_display_min
[] = {
58 {FLOWSPEC_DEST_PREFIX
, "to"},
59 {FLOWSPEC_SRC_PREFIX
, "from"},
60 {FLOWSPEC_IP_PROTOCOL
, "proto"},
61 {FLOWSPEC_PORT
, "port"},
62 {FLOWSPEC_DEST_PORT
, "dstp"},
63 {FLOWSPEC_SRC_PORT
, "srcp"},
64 {FLOWSPEC_ICMP_TYPE
, "type"},
65 {FLOWSPEC_ICMP_CODE
, "code"},
66 {FLOWSPEC_TCP_FLAGS
, "tcp"},
67 {FLOWSPEC_PKT_LEN
, "pktlen"},
68 {FLOWSPEC_DSCP
, "dscp"},
69 {FLOWSPEC_FRAGMENT
, "pktfrag"},
70 {FLOWSPEC_FLOW_LABEL
, "flwlbl"},
74 #define FS_STRING_UPDATE(count, ptr, format, remaining_len) do { \
77 if (((format) == NLRI_STRING_FORMAT_DEBUG) && (count)) {\
78 _len_written = snprintf((ptr), (remaining_len), \
80 (remaining_len) -= _len_written; \
81 (ptr) += _len_written; \
82 } else if (((format) == NLRI_STRING_FORMAT_MIN) \
84 _len_written = snprintf((ptr), (remaining_len), \
86 (remaining_len) -= _len_written; \
87 (ptr) += _len_written; \
92 /* Parse FLOWSPEC NLRI
93 * passed return_string string has assumed length
94 * BGP_FLOWSPEC_STRING_DISPLAY_MAX
96 void bgp_fs_nlri_get_string(unsigned char *nlri_content
, size_t len
,
97 char *return_string
, int format
,
98 json_object
*json_path
,
103 int ret
= 0, error
= 0;
104 char *ptr
= return_string
;
105 char local_string
[BGP_FLOWSPEC_STRING_DISPLAY_MAX
];
108 char pre_extra
[2] = "";
109 const struct message
*bgp_flowspec_display
;
110 enum bgp_flowspec_util_nlri_t type_util
;
111 int len_string
= BGP_FLOWSPEC_STRING_DISPLAY_MAX
;
114 if (format
== NLRI_STRING_FORMAT_LARGE
) {
115 snprintf(pre_extra
, sizeof(pre_extra
), "\t");
116 snprintf(extra
, sizeof(extra
), "\n");
117 bgp_flowspec_display
= bgp_flowspec_display_large
;
119 bgp_flowspec_display
= bgp_flowspec_display_min
;
120 /* if needed. type_util can be set to other values */
121 type_util
= BGP_FLOWSPEC_RETURN_STRING
;
123 while (offset
< len
-1 && error
>= 0) {
124 type
= nlri_content
[offset
];
127 case FLOWSPEC_DEST_PREFIX
:
128 case FLOWSPEC_SRC_PREFIX
:
129 ret
= bgp_flowspec_ip_address(
133 local_string
, &error
,
138 json_object_string_add(json_path
,
139 lookup_msg(bgp_flowspec_display
, type
, ""),
143 FS_STRING_UPDATE(count
, ptr
, format
, len_string
);
144 len_written
= snprintf(ptr
, len_string
, "%s%s %s%s",
146 lookup_msg(bgp_flowspec_display
,
148 local_string
, extra
);
149 len_string
-= len_written
;
152 case FLOWSPEC_FLOW_LABEL
:
153 case FLOWSPEC_IP_PROTOCOL
:
155 case FLOWSPEC_DEST_PORT
:
156 case FLOWSPEC_SRC_PORT
:
157 case FLOWSPEC_ICMP_TYPE
:
158 case FLOWSPEC_ICMP_CODE
:
159 ret
= bgp_flowspec_op_decode(type_util
,
162 local_string
, &error
);
166 json_object_string_add(json_path
,
167 lookup_msg(bgp_flowspec_display
, type
, ""),
171 FS_STRING_UPDATE(count
, ptr
, format
, len_string
);
172 len_written
= snprintf(ptr
, len_string
, "%s%s %s%s",
174 lookup_msg(bgp_flowspec_display
,
176 local_string
, extra
);
177 len_string
-= len_written
;
180 case FLOWSPEC_TCP_FLAGS
:
181 ret
= bgp_flowspec_bitmask_decode(
185 local_string
, &error
);
189 json_object_string_add(json_path
,
190 lookup_msg(bgp_flowspec_display
,
195 FS_STRING_UPDATE(count
, ptr
, format
, len_string
);
196 len_written
= snprintf(ptr
, len_string
, "%s%s %s%s",
198 lookup_msg(bgp_flowspec_display
,
200 local_string
, extra
);
201 len_string
-= len_written
;
204 case FLOWSPEC_PKT_LEN
:
206 ret
= bgp_flowspec_op_decode(
208 nlri_content
+ offset
,
209 len
- offset
, local_string
,
214 json_object_string_add(json_path
,
215 lookup_msg(bgp_flowspec_display
, type
, ""),
219 FS_STRING_UPDATE(count
, ptr
, format
, len_string
);
220 len_written
= snprintf(ptr
, len_string
, "%s%s %s%s",
222 lookup_msg(bgp_flowspec_display
,
224 local_string
, extra
);
225 len_string
-= len_written
;
228 case FLOWSPEC_FRAGMENT
:
229 ret
= bgp_flowspec_bitmask_decode(
233 local_string
, &error
);
237 json_object_string_add(json_path
,
238 lookup_msg(bgp_flowspec_display
,
243 FS_STRING_UPDATE(count
, ptr
, format
, len_string
);
244 len_written
= snprintf(ptr
, len_string
, "%s%s %s%s",
246 lookup_msg(bgp_flowspec_display
,
248 local_string
, extra
);
249 len_string
-= len_written
;
260 void route_vty_out_flowspec(struct vty
*vty
, const struct prefix
*p
,
261 struct bgp_path_info
*path
, int display
,
262 json_object
*json_paths
)
265 char return_string
[BGP_FLOWSPEC_STRING_DISPLAY_MAX
];
266 char *s
= NULL
, *s2
= NULL
;
267 json_object
*json_nlri_path
= NULL
;
268 json_object
*json_ecom_path
= NULL
;
269 json_object
*json_time_path
= NULL
;
270 char timebuf
[BGP_UPTIME_LEN
];
271 struct bgp_dest
*dest
= NULL
;
276 bgp_dest_get_bgp_table_info(dest
);
279 if (p
->family
!= AF_FLOWSPEC
)
282 if (display
== NLRI_STRING_FORMAT_JSON
)
283 json_nlri_path
= json_object_new_object();
285 json_nlri_path
= json_paths
;
287 if (display
== NLRI_STRING_FORMAT_LARGE
&& path
)
288 vty_out(vty
, "BGP flowspec entry: (flags 0x%x)\n",
290 bgp_fs_nlri_get_string((unsigned char *)
291 p
->u
.prefix_flowspec
.ptr
,
292 p
->u
.prefix_flowspec
.prefixlen
,
296 family2afi(p
->u
.prefix_flowspec
298 if (display
== NLRI_STRING_FORMAT_LARGE
)
299 vty_out(vty
, "%s", return_string
);
300 else if (display
== NLRI_STRING_FORMAT_DEBUG
)
301 vty_out(vty
, "%s", return_string
);
302 else if (display
== NLRI_STRING_FORMAT_MIN
)
303 vty_out(vty
, " %-30s", return_string
);
304 else if (json_paths
&& display
== NLRI_STRING_FORMAT_JSON
)
305 json_object_array_add(json_paths
, json_nlri_path
);
310 (path
->attr
->ecommunity
|| path
->attr
->ipv6_ecommunity
)) {
311 /* Print attribute */
313 if (attr
->ecommunity
)
314 s
= ecommunity_ecom2str(attr
->ecommunity
,
315 ECOMMUNITY_FORMAT_ROUTE_MAP
, 0);
316 if (attr
->ipv6_ecommunity
)
317 s2
= ecommunity_ecom2str(attr
->ipv6_ecommunity
,
318 ECOMMUNITY_FORMAT_ROUTE_MAP
, 0);
321 if (display
== NLRI_STRING_FORMAT_LARGE
)
322 vty_out(vty
, "\t%s%s%s\n", s
? s
: "",
323 s2
&& s
? " " : "", s2
? s2
: "");
324 else if (display
== NLRI_STRING_FORMAT_MIN
)
325 vty_out(vty
, "%s%s", s
? s
: "", s2
? s2
: "");
326 else if (json_paths
) {
327 json_ecom_path
= json_object_new_object();
329 json_object_string_add(json_ecom_path
,
332 json_object_string_add(json_ecom_path
,
334 if (display
== NLRI_STRING_FORMAT_JSON
)
335 json_object_array_add(json_paths
,
338 if (display
== NLRI_STRING_FORMAT_LARGE
) {
339 char local_buff
[INET6_ADDRSTRLEN
];
341 local_buff
[0] = '\0';
342 if (p
->u
.prefix_flowspec
.family
== AF_INET
&&
343 attr
->nexthop
.s_addr
!= 0)
345 &attr
->nexthop
.s_addr
,
348 else if (p
->u
.prefix_flowspec
.family
== AF_INET6
&&
349 attr
->mp_nexthop_len
!= 0 &&
350 attr
->mp_nexthop_len
!= BGP_ATTR_NHLEN_IPV4
&&
351 attr
->mp_nexthop_len
!= BGP_ATTR_NHLEN_VPNV4
)
353 &attr
->mp_nexthop_global
,
356 if (local_buff
[0] != '\0')
357 vty_out(vty
, "\tNLRI NH %s\n",
360 XFREE(MTYPE_ECOMMUNITY_STR
, s
);
362 peer_uptime(path
->uptime
, timebuf
, BGP_UPTIME_LEN
, 0, NULL
);
363 if (display
== NLRI_STRING_FORMAT_LARGE
) {
364 vty_out(vty
, "\treceived for %8s\n", timebuf
);
365 } else if (json_paths
) {
366 json_time_path
= json_object_new_object();
367 json_object_string_add(json_time_path
,
369 if (display
== NLRI_STRING_FORMAT_JSON
)
370 json_object_array_add(json_paths
, json_time_path
);
372 if (display
== NLRI_STRING_FORMAT_LARGE
) {
373 struct bgp_path_info_extra
*extra
=
374 bgp_path_info_extra_get(path
);
375 bool list_began
= false;
377 if (extra
->bgp_fs_pbr
&& listcount(extra
->bgp_fs_pbr
)) {
378 struct listnode
*node
;
379 struct bgp_pbr_match_entry
*bpme
;
380 struct bgp_pbr_match
*bpm
;
381 struct list
*list_bpm
;
383 list_bpm
= list_new();
384 vty_out(vty
, "\tinstalled in PBR");
385 for (ALL_LIST_ELEMENTS_RO(extra
->bgp_fs_pbr
,
387 bpm
= bpme
->backpointer
;
388 if (listnode_lookup(list_bpm
, bpm
))
390 listnode_add(list_bpm
, bpm
);
396 vty_out(vty
, "%s", bpm
->ipset_name
);
398 list_delete(&list_bpm
);
400 if (extra
->bgp_fs_iprule
&& listcount(extra
->bgp_fs_iprule
)) {
401 struct listnode
*node
;
402 struct bgp_pbr_rule
*bpr
;
405 vty_out(vty
, "\tinstalled in PBR");
406 for (ALL_LIST_ELEMENTS_RO(extra
->bgp_fs_iprule
,
415 vty_out(vty
, "-ipv4-rule %d action lookup %u-",
417 bpr
->action
->table_id
);
423 vty_out(vty
, "\tnot installed in PBR\n");
427 int bgp_show_table_flowspec(struct vty
*vty
, struct bgp
*bgp
, afi_t afi
,
428 struct bgp_table
*table
, enum bgp_show_type type
,
429 void *output_arg
, bool use_json
, int is_last
,
430 unsigned long *output_cum
, unsigned long *total_cum
)
432 struct bgp_path_info
*pi
;
433 struct bgp_dest
*dest
;
434 unsigned long total_count
= 0;
435 json_object
*json_paths
= NULL
;
436 int display
= NLRI_STRING_FORMAT_LARGE
;
438 if (type
!= bgp_show_type_detail
)
441 for (dest
= bgp_table_top(table
); dest
; dest
= bgp_route_next(dest
)) {
442 pi
= bgp_dest_get_bgp_path_info(dest
);
446 json_paths
= json_object_new_array();
447 display
= NLRI_STRING_FORMAT_JSON
;
449 for (; pi
; pi
= pi
->next
) {
451 route_vty_out_flowspec(vty
, bgp_dest_get_prefix(dest
),
452 pi
, display
, json_paths
);
456 json_object_to_json_string_ext(
458 JSON_C_TO_STRING_PRETTY
));
459 json_object_free(json_paths
);
463 if (total_count
&& !use_json
)
465 "\nDisplayed %ld flowspec entries\n",
470 DEFUN (debug_bgp_flowspec
,
471 debug_bgp_flowspec_cmd
,
472 "debug bgp flowspec",
475 "BGP allow flowspec debugging entries\n")
477 if (vty
->node
== CONFIG_NODE
)
478 DEBUG_ON(flowspec
, FLOWSPEC
);
480 TERM_DEBUG_ON(flowspec
, FLOWSPEC
);
481 vty_out(vty
, "BGP flowspec debugging is on\n");
486 DEFUN (no_debug_bgp_flowspec
,
487 no_debug_bgp_flowspec_cmd
,
488 "no debug bgp flowspec",
492 "BGP allow flowspec debugging entries\n")
494 if (vty
->node
== CONFIG_NODE
)
495 DEBUG_OFF(flowspec
, FLOWSPEC
);
497 TERM_DEBUG_OFF(flowspec
, FLOWSPEC
);
498 vty_out(vty
, "BGP flowspec debugging is off\n");
503 int bgp_fs_config_write_pbr(struct vty
*vty
, struct bgp
*bgp
,
504 afi_t afi
, safi_t safi
)
506 struct bgp_pbr_interface
*pbr_if
;
507 bool declare_node
= false;
508 struct bgp_pbr_config
*bgp_pbr_cfg
= bgp
->bgp_pbr_cfg
;
509 struct bgp_pbr_interface_head
*head
;
510 bool bgp_pbr_interface_any
;
512 if (!bgp_pbr_cfg
|| safi
!= SAFI_FLOWSPEC
)
515 head
= &(bgp_pbr_cfg
->ifaces_by_name_ipv4
);
516 bgp_pbr_interface_any
= bgp_pbr_cfg
->pbr_interface_any_ipv4
;
517 } else if (afi
== AFI_IP6
) {
518 head
= &(bgp_pbr_cfg
->ifaces_by_name_ipv6
);
519 bgp_pbr_interface_any
= bgp_pbr_cfg
->pbr_interface_any_ipv6
;
523 if (!RB_EMPTY(bgp_pbr_interface_head
, head
) ||
524 !bgp_pbr_interface_any
)
526 RB_FOREACH (pbr_if
, bgp_pbr_interface_head
, head
) {
527 vty_out(vty
, " local-install %s\n", pbr_if
->name
);
529 return declare_node
? 1 : 0;
532 static int bgp_fs_local_install_interface(struct bgp
*bgp
,
533 const char *no
, const char *ifname
,
536 struct bgp_pbr_interface
*pbr_if
;
537 struct bgp_pbr_config
*bgp_pbr_cfg
= bgp
->bgp_pbr_cfg
;
538 struct bgp_pbr_interface_head
*head
;
539 bool *bgp_pbr_interface_any
;
544 head
= &(bgp_pbr_cfg
->ifaces_by_name_ipv4
);
545 bgp_pbr_interface_any
= &(bgp_pbr_cfg
->pbr_interface_any_ipv4
);
547 head
= &(bgp_pbr_cfg
->ifaces_by_name_ipv6
);
548 bgp_pbr_interface_any
= &(bgp_pbr_cfg
->pbr_interface_any_ipv6
);
552 if (*bgp_pbr_interface_any
) {
553 *bgp_pbr_interface_any
= false;
554 /* remove all other interface list */
555 bgp_pbr_reset(bgp
, afi
);
559 pbr_if
= bgp_pbr_interface_lookup(ifname
, head
);
562 RB_REMOVE(bgp_pbr_interface_head
, head
, pbr_if
);
566 pbr_if
= bgp_pbr_interface_lookup(ifname
, head
);
569 pbr_if
= XCALLOC(MTYPE_TMP
,
570 sizeof(struct bgp_pbr_interface
));
571 strlcpy(pbr_if
->name
, ifname
, INTERFACE_NAMSIZ
);
572 RB_INSERT(bgp_pbr_interface_head
, head
, pbr_if
);
573 *bgp_pbr_interface_any
= false;
576 if (!*bgp_pbr_interface_any
) {
577 /* remove all other interface list
579 bgp_pbr_reset(bgp
, afi
);
580 *bgp_pbr_interface_any
= true;
586 DEFUN (bgp_fs_local_install_ifname
,
587 bgp_fs_local_install_ifname_cmd
,
588 "[no] local-install INTERFACE",
590 "Apply local policy routing\n"
593 struct bgp
*bgp
= VTY_GET_CONTEXT(bgp
);
595 const char *no
= strmatch(argv
[0]->text
, "no") ? "no" : NULL
;
596 char *ifname
= argv_find(argv
, argc
, "INTERFACE", &idx
) ?
597 argv
[idx
]->arg
: NULL
;
599 return bgp_fs_local_install_interface(bgp
, no
, ifname
,
603 extern int bgp_flowspec_display_match_per_ip(afi_t afi
, struct bgp_table
*rib
,
604 struct prefix
*match
,
605 int prefix_check
, struct vty
*vty
,
607 json_object
*json_paths
)
609 struct bgp_dest
*dest
;
610 const struct prefix
*prefix
;
613 for (dest
= bgp_table_top(rib
); dest
; dest
= bgp_route_next(dest
)) {
614 prefix
= bgp_dest_get_prefix(dest
);
616 if (prefix
->family
!= AF_FLOWSPEC
)
619 if (bgp_flowspec_contains_prefix(prefix
, match
, prefix_check
)) {
620 route_vty_out_flowspec(
621 vty
, prefix
, bgp_dest_get_bgp_path_info(dest
),
622 use_json
? NLRI_STRING_FORMAT_JSON
623 : NLRI_STRING_FORMAT_LARGE
,
631 void bgp_flowspec_vty_init(void)
633 install_element(ENABLE_NODE
, &debug_bgp_flowspec_cmd
);
634 install_element(CONFIG_NODE
, &debug_bgp_flowspec_cmd
);
635 install_element(ENABLE_NODE
, &no_debug_bgp_flowspec_cmd
);
636 install_element(CONFIG_NODE
, &no_debug_bgp_flowspec_cmd
);
637 install_element(BGP_FLOWSPECV4_NODE
, &bgp_fs_local_install_ifname_cmd
);
638 install_element(BGP_FLOWSPECV6_NODE
, &bgp_fs_local_install_ifname_cmd
);