[mirror_frr.git] / bgpd / bgp_flowspec_vty.c

/* BGP FlowSpec VTY
 * Copyright (C) 2018 6WIND
 *
 * FRRouting is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * FRRouting is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include <zebra.h>
#include "command.h"

#include "bgpd/bgpd.h"
#include "bgpd/bgp_table.h"
#include "bgpd/bgp_attr.h"
#include "bgpd/bgp_ecommunity.h"
#include "bgpd/bgp_vty.h"
#include "bgpd/bgp_route.h"
#include "bgpd/bgp_aspath.h"
#include "bgpd/bgp_flowspec.h"
#include "bgpd/bgp_flowspec_util.h"
#include "bgpd/bgp_flowspec_private.h"
#include "bgpd/bgp_debug.h"
#include "bgpd/bgp_pbr.h"

/* Local Structures and variables declarations
 * This code block hosts the struct declared that host the flowspec rules
 * as well as some structure used to convert to stringx
 */

static const struct message bgp_flowspec_display_large[] = {
	{FLOWSPEC_DEST_PREFIX, "Destination Address"},
	{FLOWSPEC_SRC_PREFIX, "Source Address"},
	{FLOWSPEC_IP_PROTOCOL, "IP Protocol"},
	{FLOWSPEC_PORT, "Port"},
	{FLOWSPEC_DEST_PORT, "Destination Port"},
	{FLOWSPEC_SRC_PORT, "Source Port"},
	{FLOWSPEC_ICMP_TYPE, "ICMP Type"},
	{FLOWSPEC_ICMP_CODE, "ICMP Code"},
	{FLOWSPEC_TCP_FLAGS, "TCP Flags"},
	{FLOWSPEC_PKT_LEN, "Packet Length"},
	{FLOWSPEC_DSCP, "DSCP field"},
	{FLOWSPEC_FRAGMENT, "Packet Fragment"},
	{0}
};

static const struct message bgp_flowspec_display_min[] = {
	{FLOWSPEC_DEST_PREFIX, "to"},
	{FLOWSPEC_SRC_PREFIX, "from"},
	{FLOWSPEC_IP_PROTOCOL, "proto"},
	{FLOWSPEC_PORT, "port"},
	{FLOWSPEC_DEST_PORT, "dstp"},
	{FLOWSPEC_SRC_PORT, "srcp"},
	{FLOWSPEC_ICMP_TYPE, "type"},
	{FLOWSPEC_ICMP_CODE, "code"},
	{FLOWSPEC_TCP_FLAGS, "tcp"},
	{FLOWSPEC_PKT_LEN, "pktlen"},
	{FLOWSPEC_DSCP, "dscp"},
	{FLOWSPEC_FRAGMENT, "pktfrag"},
	{0}
};

#define	FS_STRING_UPDATE(count, ptr, format, remaining_len) do {	\
		int _len_written;					\
									\
		if (((format) == NLRI_STRING_FORMAT_DEBUG) && (count)) {\
			_len_written = snprintf((ptr), (remaining_len),	\
						", ");			\
			(remaining_len) -= _len_written;		\
			(ptr) += _len_written;				\
		} else if (((format) == NLRI_STRING_FORMAT_MIN) 	\
			   && (count)) {				\
			_len_written = snprintf((ptr), (remaining_len),	\
						" ");			\
			(remaining_len) -= _len_written;		\
			(ptr) += _len_written;				\
		}							\
		count++;						\
	} while (0)

/* Parse FLOWSPEC NLRI
 * passed return_string string has assumed length
 * BGP_FLOWSPEC_STRING_DISPLAY_MAX
 */
void bgp_fs_nlri_get_string(unsigned char *nlri_content, size_t len,
			    char *return_string, int format,
			    json_object *json_path)
{
	uint32_t offset = 0;
	int type;
	int ret = 0, error = 0;
	char *ptr = return_string;
	char local_string[BGP_FLOWSPEC_STRING_DISPLAY_MAX];
	int count = 0;
	char extra[2] = "";
	char pre_extra[2] = "";
	const struct message *bgp_flowspec_display;
	enum bgp_flowspec_util_nlri_t type_util;
	int len_string = BGP_FLOWSPEC_STRING_DISPLAY_MAX;
	int len_written;

	if (format == NLRI_STRING_FORMAT_LARGE) {
		snprintf(pre_extra, sizeof(pre_extra), "\t");
		snprintf(extra, sizeof(extra), "\n");
		bgp_flowspec_display = bgp_flowspec_display_large;
	} else
		bgp_flowspec_display = bgp_flowspec_display_min;
	/* if needed. type_util can be set to other values */
	type_util = BGP_FLOWSPEC_RETURN_STRING;
	error = 0;
	while (offset < len-1 && error >= 0) {
		type = nlri_content[offset];
		offset++;
		switch (type) {
		case FLOWSPEC_DEST_PREFIX:
		case FLOWSPEC_SRC_PREFIX:
			ret = bgp_flowspec_ip_address(
						type_util,
						nlri_content+offset,
						len - offset,
						local_string, &error);
			if (ret <= 0)
				break;
			if (json_path) {
				json_object_string_add(json_path,
				     lookup_msg(bgp_flowspec_display, type, ""),
				     local_string);
				break;
			}
			FS_STRING_UPDATE(count, ptr, format, len_string);
			len_written = snprintf(ptr, len_string, "%s%s %s%s",
					pre_extra,
					lookup_msg(bgp_flowspec_display,
						   type, ""),
					local_string, extra);
			len_string -= len_written;
			ptr += len_written;
			break;
		case FLOWSPEC_IP_PROTOCOL:
		case FLOWSPEC_PORT:
		case FLOWSPEC_DEST_PORT:
		case FLOWSPEC_SRC_PORT:
		case FLOWSPEC_ICMP_TYPE:
		case FLOWSPEC_ICMP_CODE:
			ret = bgp_flowspec_op_decode(type_util,
						     nlri_content+offset,
						     len - offset,
						     local_string, &error);
			if (ret <= 0)
				break;
			if (json_path) {
				json_object_string_add(json_path,
				     lookup_msg(bgp_flowspec_display, type, ""),
				     local_string);
				break;
			}
			FS_STRING_UPDATE(count, ptr, format, len_string);
			len_written = snprintf(ptr, len_string, "%s%s %s%s",
					pre_extra,
					lookup_msg(bgp_flowspec_display,
					type, ""),
				     local_string, extra);
			len_string -= len_written;
			ptr += len_written;
			break;
		case FLOWSPEC_TCP_FLAGS:
			ret = bgp_flowspec_bitmask_decode(
					      type_util,
					      nlri_content+offset,
					      len - offset,
					      local_string, &error);
			if (ret <= 0)
				break;
			if (json_path) {
				json_object_string_add(json_path,
				     lookup_msg(bgp_flowspec_display,
						type, ""),
				     local_string);
				break;
			}
			FS_STRING_UPDATE(count, ptr, format, len_string);
			len_written = snprintf(ptr, len_string, "%s%s %s%s",
					pre_extra,
					lookup_msg(bgp_flowspec_display,
						   type, ""),
					local_string, extra);
			len_string -= len_written;
			ptr += len_written;
			break;
		case FLOWSPEC_PKT_LEN:
		case FLOWSPEC_DSCP:
			ret = bgp_flowspec_op_decode(
						type_util,
						nlri_content + offset,
						len - offset, local_string,
						&error);
			if (ret <= 0)
				break;
			if (json_path) {
				json_object_string_add(json_path,
				    lookup_msg(bgp_flowspec_display, type, ""),
				    local_string);
				break;
			}
			FS_STRING_UPDATE(count, ptr, format, len_string);
			len_written = snprintf(ptr, len_string, "%s%s %s%s",
					pre_extra,
					lookup_msg(bgp_flowspec_display,
					type, ""),
				     local_string, extra);
			len_string -= len_written;
			ptr += len_written;
			break;
		case FLOWSPEC_FRAGMENT:
			ret = bgp_flowspec_bitmask_decode(
					      type_util,
					      nlri_content+offset,
					      len - offset,
					      local_string, &error);
			if (ret <= 0)
				break;
			if (json_path) {
				json_object_string_add(json_path,
				    lookup_msg(bgp_flowspec_display,
					       type, ""),
				    local_string);
				break;
			}
			FS_STRING_UPDATE(count, ptr, format, len_string);
			len_written = snprintf(ptr, len_string, "%s%s %s%s",
					pre_extra,
					lookup_msg(bgp_flowspec_display,
					type, ""),
					local_string, extra);
			len_string -= len_written;
			ptr += len_written;
			break;
		default:
			error = -1;
			break;
		}
		offset += ret;
	}
}

void route_vty_out_flowspec(struct vty *vty, struct prefix *p,
			    struct bgp_path_info *path, int display,
			    json_object *json_paths)
{
	struct attr *attr;
	char return_string[BGP_FLOWSPEC_STRING_DISPLAY_MAX];
	char *s;
	json_object *json_nlri_path = NULL;
	json_object *json_ecom_path = NULL;
	json_object *json_time_path = NULL;
	char timebuf[BGP_UPTIME_LEN];

	/* Print prefix */
	if (p != NULL) {
		if (p->family != AF_FLOWSPEC)
			return;
		if (json_paths) {
			if (display == NLRI_STRING_FORMAT_JSON)
				json_nlri_path = json_object_new_object();
			else
				json_nlri_path = json_paths;
		}
		if (display == NLRI_STRING_FORMAT_LARGE && path)
			vty_out(vty, "BGP flowspec entry: (flags 0x%x)\n",
				path->flags);
		bgp_fs_nlri_get_string((unsigned char *)
				       p->u.prefix_flowspec.ptr,
				       p->u.prefix_flowspec.prefixlen,
				       return_string,
				       display,
				       json_nlri_path);
		if (display == NLRI_STRING_FORMAT_LARGE)
			vty_out(vty, "%s", return_string);
		else if (display == NLRI_STRING_FORMAT_DEBUG)
			vty_out(vty, "%s", return_string);
		else if (display == NLRI_STRING_FORMAT_MIN)
			vty_out(vty, " %-30s", return_string);
		else if (json_paths && display == NLRI_STRING_FORMAT_JSON)
			json_object_array_add(json_paths, json_nlri_path);
	}
	if (!path)
		return;
	if (path->attr && path->attr->ecommunity) {
		/* Print attribute */
		attr = path->attr;
		s = ecommunity_ecom2str(attr->ecommunity,
					ECOMMUNITY_FORMAT_ROUTE_MAP, 0);
		if (!s)
			return;
		if (display == NLRI_STRING_FORMAT_LARGE)
			vty_out(vty, "\t%s\n", s);
		else if (display == NLRI_STRING_FORMAT_MIN)
			vty_out(vty, "%s", s);
		else if (json_paths) {
			json_ecom_path = json_object_new_object();
			json_object_string_add(json_ecom_path,
				       "ecomlist", s);
			if (display == NLRI_STRING_FORMAT_JSON)
				json_object_array_add(json_paths,
						      json_ecom_path);
		}
		if (attr->nexthop.s_addr != 0 &&
		    display == NLRI_STRING_FORMAT_LARGE)
			vty_out(vty, "\tNH %-16s\n", inet_ntoa(attr->nexthop));
		XFREE(MTYPE_ECOMMUNITY_STR, s);
	}
	peer_uptime(path->uptime, timebuf, BGP_UPTIME_LEN, 0, NULL);
	if (display == NLRI_STRING_FORMAT_LARGE) {
		vty_out(vty, "\treceived for %8s\n", timebuf);
	} else if (json_paths) {
		json_time_path = json_object_new_object();
		json_object_string_add(json_time_path,
				       "time", timebuf);
		if (display == NLRI_STRING_FORMAT_JSON)
			json_object_array_add(json_paths, json_time_path);
	}
	if (display == NLRI_STRING_FORMAT_LARGE) {
		struct bgp_path_info_extra *extra =
			bgp_path_info_extra_get(path);

		if (extra->bgp_fs_pbr) {
			struct listnode *node;
			struct bgp_pbr_match_entry *bpme;
			struct bgp_pbr_match *bpm;
			bool list_began = false;
			struct list *list_bpm;

			list_bpm = list_new();
			if (listcount(extra->bgp_fs_pbr))
				vty_out(vty, "\tinstalled in PBR");
			for (ALL_LIST_ELEMENTS_RO(extra->bgp_fs_pbr,
						  node, bpme)) {
				bpm = bpme->backpointer;
				if (listnode_lookup(list_bpm, bpm))
					continue;
				listnode_add(list_bpm, bpm);
				if (!list_began) {
					vty_out(vty, " (");
					list_began = true;
				} else
					vty_out(vty, ", ");
				vty_out(vty, "%s", bpm->ipset_name);
			}
			if (list_began)
				vty_out(vty, ")");
			vty_out(vty, "\n");
			list_delete(&list_bpm);
		} else
			vty_out(vty, "\tnot installed in PBR\n");
	}
}

int bgp_show_table_flowspec(struct vty *vty, struct bgp *bgp, afi_t afi,
			    struct bgp_table *table, enum bgp_show_type type,
			    void *output_arg, bool use_json, int is_last,
			    unsigned long *output_cum, unsigned long *total_cum)
{
	struct bgp_path_info *pi;
	struct bgp_node *rn;
	unsigned long total_count = 0;
	json_object *json_paths = NULL;
	int display = NLRI_STRING_FORMAT_LARGE;

	if (type != bgp_show_type_detail)
		return CMD_SUCCESS;

	for (rn = bgp_table_top(table); rn; rn = bgp_route_next(rn)) {
		if (rn->info == NULL)
			continue;
		if (use_json) {
			json_paths = json_object_new_array();
			display = NLRI_STRING_FORMAT_JSON;
		}
		for (pi = rn->info; pi; pi = pi->next) {
			total_count++;
			route_vty_out_flowspec(vty, &rn->p, pi, display,
					       json_paths);
		}
		if (use_json) {
			vty_out(vty, "%s\n",
				json_object_to_json_string_ext(
						json_paths,
						JSON_C_TO_STRING_PRETTY));
			json_object_free(json_paths);
			json_paths = NULL;
		}
	}
	if (total_count && !use_json)
		vty_out(vty,
			"\nDisplayed  %ld flowspec entries\n",
			total_count);
	return CMD_SUCCESS;
}

DEFUN (debug_bgp_flowspec,
       debug_bgp_flowspec_cmd,
       "debug bgp flowspec",
       DEBUG_STR
       BGP_STR
       "BGP allow flowspec debugging entries\n")
{
	if (vty->node == CONFIG_NODE)
		DEBUG_ON(flowspec, FLOWSPEC);
	else {
		TERM_DEBUG_ON(flowspec, FLOWSPEC);
		vty_out(vty, "BGP flowspec debugging is on\n");
	}
	return CMD_SUCCESS;
}

DEFUN (no_debug_bgp_flowspec,
       no_debug_bgp_flowspec_cmd,
       "no debug bgp flowspec",
       NO_STR
       DEBUG_STR
       BGP_STR
       "BGP allow flowspec debugging entries\n")
{
	if (vty->node == CONFIG_NODE)
		DEBUG_OFF(flowspec, FLOWSPEC);
	else {
		TERM_DEBUG_OFF(flowspec, FLOWSPEC);
		vty_out(vty, "BGP flowspec debugging is off\n");
	}
	return CMD_SUCCESS;
}

int bgp_fs_config_write_pbr(struct vty *vty, struct bgp *bgp,
			    afi_t afi, safi_t safi)
{
	struct bgp_pbr_interface *pbr_if;
	bool declare_node = false;
	struct bgp_pbr_config *bgp_pbr_cfg = bgp->bgp_pbr_cfg;
	struct bgp_pbr_interface_head *head;
	bool bgp_pbr_interface_any;

	if (!bgp_pbr_cfg || safi != SAFI_FLOWSPEC || afi != AFI_IP)
		return 0;
	head = &(bgp_pbr_cfg->ifaces_by_name_ipv4);
	bgp_pbr_interface_any = bgp_pbr_cfg->pbr_interface_any_ipv4;
	if (!RB_EMPTY(bgp_pbr_interface_head, head) ||
	     !bgp_pbr_interface_any)
		declare_node = true;
	RB_FOREACH (pbr_if, bgp_pbr_interface_head, head) {
		vty_out(vty, "  local-install %s\n", pbr_if->name);
	}
	return declare_node ? 1 : 0;
}

static int bgp_fs_local_install_interface(struct bgp *bgp,
					  const char *no, const char *ifname)
{
	struct bgp_pbr_interface *pbr_if;
	struct bgp_pbr_config *bgp_pbr_cfg = bgp->bgp_pbr_cfg;
	struct bgp_pbr_interface_head *head;
	bool *bgp_pbr_interface_any;

	if (!bgp_pbr_cfg)
		return CMD_SUCCESS;
	head = &(bgp_pbr_cfg->ifaces_by_name_ipv4);
	bgp_pbr_interface_any = &(bgp_pbr_cfg->pbr_interface_any_ipv4);
	if (no) {
		if (!ifname) {
			if (*bgp_pbr_interface_any) {
				*bgp_pbr_interface_any = false;
				/* remove all other interface list */
				bgp_pbr_reset(bgp, AFI_IP);
			}
			return CMD_SUCCESS;
		}
		pbr_if = bgp_pbr_interface_lookup(ifname, head);
		if (!pbr_if)
			return CMD_SUCCESS;
		RB_REMOVE(bgp_pbr_interface_head, head, pbr_if);
		return CMD_SUCCESS;
	}
	if (ifname) {
		pbr_if = bgp_pbr_interface_lookup(ifname, head);
		if (pbr_if)
			return CMD_SUCCESS;
		pbr_if = XCALLOC(MTYPE_TMP,
				 sizeof(struct bgp_pbr_interface));
		strlcpy(pbr_if->name, ifname, INTERFACE_NAMSIZ);
		RB_INSERT(bgp_pbr_interface_head, head, pbr_if);
		*bgp_pbr_interface_any = false;
	} else {
		/* set to default */
		if (!*bgp_pbr_interface_any) {
			/* remove all other interface list
			 */
			bgp_pbr_reset(bgp, AFI_IP);
			*bgp_pbr_interface_any = true;
		}
	}
	return CMD_SUCCESS;
}

DEFUN (bgp_fs_local_install_ifname,
	bgp_fs_local_install_ifname_cmd,
	"[no] local-install INTERFACE",
	NO_STR
	"Apply local policy routing\n"
	"Interface name\n")
{
	struct bgp *bgp = VTY_GET_CONTEXT(bgp);
	int idx = 0;
	const char *no = strmatch(argv[0]->text, "no") ? "no" : NULL;
	char *ifname = argv_find(argv, argc, "INTERFACE", &idx) ?
		argv[idx]->arg : NULL;

	return bgp_fs_local_install_interface(bgp, no, ifname);
}

extern int bgp_flowspec_display_match_per_ip(afi_t afi, struct bgp_table *rib,
					     struct prefix *match,
					     int prefix_check, struct vty *vty,
					     bool use_json,
					     json_object *json_paths)
{
	struct bgp_node *rn;
	struct prefix *prefix;
	int display = 0;

	for (rn = bgp_table_top(rib); rn; rn = bgp_route_next(rn)) {
		prefix = &rn->p;

		if (prefix->family != AF_FLOWSPEC)
			continue;

		if (bgp_flowspec_contains_prefix(prefix, match, prefix_check)) {
			route_vty_out_flowspec(vty, &rn->p,
					       rn->info, use_json ?
					       NLRI_STRING_FORMAT_JSON :
					       NLRI_STRING_FORMAT_LARGE,
					       json_paths);
			display++;
		}
	}
	return display;
}

void bgp_flowspec_vty_init(void)
{
	install_element(ENABLE_NODE, &debug_bgp_flowspec_cmd);
	install_element(CONFIG_NODE, &debug_bgp_flowspec_cmd);
	install_element(ENABLE_NODE, &no_debug_bgp_flowspec_cmd);
	install_element(CONFIG_NODE, &no_debug_bgp_flowspec_cmd);
	install_element(BGP_FLOWSPECV4_NODE, &bgp_fs_local_install_ifname_cmd);
}
Commit	Line	Data
dba3c1d3 PG	1	/* BGP FlowSpec VTY
	2	* Copyright (C) 2018 6WIND
	3	*
	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
	7	* later version.
	8	*
	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.
	13	*
	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
	17	*/
	18
	19	#include <zebra.h>
	20	#include "command.h"
	21
	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"
268e1b9b	32	#include "bgpd/bgp_debug.h"
b588b642	33	#include "bgpd/bgp_pbr.h"
dba3c1d3 PG	34
	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
	38	*/
	39
	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	{0}
	54	};
	55
	56	static const struct message bgp_flowspec_display_min[] = {
	57	{FLOWSPEC_DEST_PREFIX, "to"},
	58	{FLOWSPEC_SRC_PREFIX, "from"},
	59	{FLOWSPEC_IP_PROTOCOL, "proto"},
	60	{FLOWSPEC_PORT, "port"},
	61	{FLOWSPEC_DEST_PORT, "dstp"},
	62	{FLOWSPEC_SRC_PORT, "srcp"},
	63	{FLOWSPEC_ICMP_TYPE, "type"},
	64	{FLOWSPEC_ICMP_CODE, "code"},
01ffd28b	65	{FLOWSPEC_TCP_FLAGS, "tcp"},
dba3c1d3 PG	66	{FLOWSPEC_PKT_LEN, "pktlen"},
	67	{FLOWSPEC_DSCP, "dscp"},
	68	{FLOWSPEC_FRAGMENT, "pktfrag"},
	69	{0}
	70	};
	71
362a06e3 PG	72	#define FS_STRING_UPDATE(count, ptr, format, remaining_len) do { \
	73	int _len_written; \
	74	\
	75	if (((format) == NLRI_STRING_FORMAT_DEBUG) && (count)) {\
	76	_len_written = snprintf((ptr), (remaining_len), \
	77	", "); \
	78	(remaining_len) -= _len_written; \
	79	(ptr) += _len_written; \
	80	} else if (((format) == NLRI_STRING_FORMAT_MIN) \
	81	&& (count)) { \
	82	_len_written = snprintf((ptr), (remaining_len), \
	83	" "); \
	84	(remaining_len) -= _len_written; \
	85	(ptr) += _len_written; \
	86	} \
	87	count++; \
dba3c1d3 PG	88	} while (0)
dba3c1d3 PG	89
362a06e3 PG	90	/* Parse FLOWSPEC NLRI
	91	* passed return_string string has assumed length
	92	* BGP_FLOWSPEC_STRING_DISPLAY_MAX
	93	*/
dba3c1d3	94	void bgp_fs_nlri_get_string(unsigned char *nlri_content, size_t len,
d33fc23b PG	95	char *return_string, int format,
d33fc23b PG	96	json_object *json_path)
dba3c1d3 PG	97	{
	98	uint32_t offset = 0;
	99	int type;
	100	int ret = 0, error = 0;
	101	char *ptr = return_string;
	102	char local_string[BGP_FLOWSPEC_STRING_DISPLAY_MAX];
	103	int count = 0;
	104	char extra[2] = "";
	105	char pre_extra[2] = "";
	106	const struct message *bgp_flowspec_display;
d33fc23b	107	enum bgp_flowspec_util_nlri_t type_util;
362a06e3 PG	108	int len_string = BGP_FLOWSPEC_STRING_DISPLAY_MAX;
362a06e3 PG	109	int len_written;
dba3c1d3 PG	110
	111	if (format == NLRI_STRING_FORMAT_LARGE) {
	112	snprintf(pre_extra, sizeof(pre_extra), "\t");
	113	snprintf(extra, sizeof(extra), "\n");
	114	bgp_flowspec_display = bgp_flowspec_display_large;
	115	} else
	116	bgp_flowspec_display = bgp_flowspec_display_min;
d33fc23b PG	117	/* if needed. type_util can be set to other values */
d33fc23b PG	118	type_util = BGP_FLOWSPEC_RETURN_STRING;
dba3c1d3 PG	119	error = 0;
	120	while (offset < len-1 && error >= 0) {
	121	type = nlri_content[offset];
	122	offset++;
	123	switch (type) {
	124	case FLOWSPEC_DEST_PREFIX:
	125	case FLOWSPEC_SRC_PREFIX:
	126	ret = bgp_flowspec_ip_address(
d33fc23b	127	type_util,
dba3c1d3 PG	128	nlri_content+offset,
	129	len - offset,
	130	local_string, &error);
	131	if (ret <= 0)
	132	break;
d33fc23b PG	133	if (json_path) {
	134	json_object_string_add(json_path,
	135	lookup_msg(bgp_flowspec_display, type, ""),
	136	local_string);
	137	break;
	138	}
362a06e3 PG	139	FS_STRING_UPDATE(count, ptr, format, len_string);
	140	len_written = snprintf(ptr, len_string, "%s%s %s%s",
	141	pre_extra,
	142	lookup_msg(bgp_flowspec_display,
	143	type, ""),
	144	local_string, extra);
	145	len_string -= len_written;
	146	ptr += len_written;
dba3c1d3 PG	147	break;
	148	case FLOWSPEC_IP_PROTOCOL:
	149	case FLOWSPEC_PORT:
	150	case FLOWSPEC_DEST_PORT:
	151	case FLOWSPEC_SRC_PORT:
	152	case FLOWSPEC_ICMP_TYPE:
	153	case FLOWSPEC_ICMP_CODE:
d33fc23b	154	ret = bgp_flowspec_op_decode(type_util,
dba3c1d3 PG	155	nlri_content+offset,
	156	len - offset,
	157	local_string, &error);
	158	if (ret <= 0)
	159	break;
d33fc23b PG	160	if (json_path) {
	161	json_object_string_add(json_path,
	162	lookup_msg(bgp_flowspec_display, type, ""),
	163	local_string);
	164	break;
	165	}
362a06e3 PG	166	FS_STRING_UPDATE(count, ptr, format, len_string);
	167	len_written = snprintf(ptr, len_string, "%s%s %s%s",
	168	pre_extra,
	169	lookup_msg(bgp_flowspec_display,
	170	type, ""),
dba3c1d3	171	local_string, extra);
362a06e3 PG	172	len_string -= len_written;
362a06e3 PG	173	ptr += len_written;
dba3c1d3 PG	174	break;
dba3c1d3 PG	175	case FLOWSPEC_TCP_FLAGS:
588ec356	176	ret = bgp_flowspec_bitmask_decode(
d33fc23b	177	type_util,
dba3c1d3 PG	178	nlri_content+offset,
	179	len - offset,
	180	local_string, &error);
	181	if (ret <= 0)
	182	break;
d33fc23b PG	183	if (json_path) {
d33fc23b PG	184	json_object_string_add(json_path,
362a06e3 PG	185	lookup_msg(bgp_flowspec_display,
362a06e3 PG	186	type, ""),
d33fc23b PG	187	local_string);
	188	break;
	189	}
362a06e3 PG	190	FS_STRING_UPDATE(count, ptr, format, len_string);
	191	len_written = snprintf(ptr, len_string, "%s%s %s%s",
	192	pre_extra,
	193	lookup_msg(bgp_flowspec_display,
	194	type, ""),
	195	local_string, extra);
	196	len_string -= len_written;
	197	ptr += len_written;
dba3c1d3 PG	198	break;
	199	case FLOWSPEC_PKT_LEN:
	200	case FLOWSPEC_DSCP:
	201	ret = bgp_flowspec_op_decode(
d33fc23b	202	type_util,
dba3c1d3 PG	203	nlri_content + offset,
	204	len - offset, local_string,
	205	&error);
	206	if (ret <= 0)
	207	break;
d33fc23b PG	208	if (json_path) {
	209	json_object_string_add(json_path,
	210	lookup_msg(bgp_flowspec_display, type, ""),
	211	local_string);
	212	break;
	213	}
362a06e3 PG	214	FS_STRING_UPDATE(count, ptr, format, len_string);
	215	len_written = snprintf(ptr, len_string, "%s%s %s%s",
	216	pre_extra,
	217	lookup_msg(bgp_flowspec_display,
	218	type, ""),
dba3c1d3	219	local_string, extra);
362a06e3 PG	220	len_string -= len_written;
362a06e3 PG	221	ptr += len_written;
dba3c1d3 PG	222	break;
dba3c1d3 PG	223	case FLOWSPEC_FRAGMENT:
588ec356 PG	224	ret = bgp_flowspec_bitmask_decode(
	225	type_util,
	226	nlri_content+offset,
	227	len - offset,
	228	local_string, &error);
dba3c1d3 PG	229	if (ret <= 0)
dba3c1d3 PG	230	break;
d33fc23b PG	231	if (json_path) {
	232	json_object_string_add(json_path,
	233	lookup_msg(bgp_flowspec_display,
	234	type, ""),
	235	local_string);
	236	break;
	237	}
362a06e3 PG	238	FS_STRING_UPDATE(count, ptr, format, len_string);
	239	len_written = snprintf(ptr, len_string, "%s%s %s%s",
	240	pre_extra,
	241	lookup_msg(bgp_flowspec_display,
	242	type, ""),
	243	local_string, extra);
	244	len_string -= len_written;
	245	ptr += len_written;
dba3c1d3 PG	246	break;
	247	default:
	248	error = -1;
	249	break;
	250	}
	251	offset += ret;
	252	}
	253	}
	254
	255	void route_vty_out_flowspec(struct vty vty, struct prefix p,
9b6d8fcf	256	struct bgp_path_info *path, int display,
4b7e6066	257	json_object *json_paths)
dba3c1d3 PG	258	{
	259	struct attr *attr;
	260	char return_string[BGP_FLOWSPEC_STRING_DISPLAY_MAX];
	261	char *s;
d33fc23b PG	262	json_object *json_nlri_path = NULL;
	263	json_object *json_ecom_path = NULL;
	264	json_object *json_time_path = NULL;
	265	char timebuf[BGP_UPTIME_LEN];
dba3c1d3 PG	266
	267	/* Print prefix */
	268	if (p != NULL) {
	269	if (p->family != AF_FLOWSPEC)
	270	return;
d33fc23b PG	271	if (json_paths) {
	272	if (display == NLRI_STRING_FORMAT_JSON)
	273	json_nlri_path = json_object_new_object();
	274	else
	275	json_nlri_path = json_paths;
	276	}
9b6d8fcf	277	if (display == NLRI_STRING_FORMAT_LARGE && path)
dba3c1d3	278	vty_out(vty, "BGP flowspec entry: (flags 0x%x)\n",
9b6d8fcf	279	path->flags);
dba3c1d3 PG	280	bgp_fs_nlri_get_string((unsigned char *)
	281	p->u.prefix_flowspec.ptr,
	282	p->u.prefix_flowspec.prefixlen,
	283	return_string,
d33fc23b PG	284	display,
d33fc23b PG	285	json_nlri_path);
dba3c1d3 PG	286	if (display == NLRI_STRING_FORMAT_LARGE)
	287	vty_out(vty, "%s", return_string);
	288	else if (display == NLRI_STRING_FORMAT_DEBUG)
	289	vty_out(vty, "%s", return_string);
d33fc23b	290	else if (display == NLRI_STRING_FORMAT_MIN)
dba3c1d3	291	vty_out(vty, " %-30s", return_string);
d33fc23b PG	292	else if (json_paths && display == NLRI_STRING_FORMAT_JSON)
d33fc23b PG	293	json_object_array_add(json_paths, json_nlri_path);
dba3c1d3	294	}
9b6d8fcf	295	if (!path)
dba3c1d3	296	return;
9b6d8fcf	297	if (path->attr && path->attr->ecommunity) {
dba3c1d3	298	/* Print attribute */
9b6d8fcf	299	attr = path->attr;
dba3c1d3 PG	300	s = ecommunity_ecom2str(attr->ecommunity,
	301	ECOMMUNITY_FORMAT_ROUTE_MAP, 0);
	302	if (!s)
	303	return;
	304	if (display == NLRI_STRING_FORMAT_LARGE)
	305	vty_out(vty, "\t%s\n", s);
d33fc23b	306	else if (display == NLRI_STRING_FORMAT_MIN)
dba3c1d3	307	vty_out(vty, "%s", s);
d33fc23b PG	308	else if (json_paths) {
	309	json_ecom_path = json_object_new_object();
	310	json_object_string_add(json_ecom_path,
	311	"ecomlist", s);
	312	if (display == NLRI_STRING_FORMAT_JSON)
	313	json_object_array_add(json_paths,
	314	json_ecom_path);
	315	}
026b914a PG	316	if (attr->nexthop.s_addr != 0 &&
	317	display == NLRI_STRING_FORMAT_LARGE)
	318	vty_out(vty, "\tNH %-16s\n", inet_ntoa(attr->nexthop));
dba3c1d3 PG	319	XFREE(MTYPE_ECOMMUNITY_STR, s);
dba3c1d3 PG	320	}
9b6d8fcf	321	peer_uptime(path->uptime, timebuf, BGP_UPTIME_LEN, 0, NULL);
b588b642 PG	322	if (display == NLRI_STRING_FORMAT_LARGE) {
	323	vty_out(vty, "\treceived for %8s\n", timebuf);
	324	} else if (json_paths) {
d33fc23b PG	325	json_time_path = json_object_new_object();
	326	json_object_string_add(json_time_path,
	327	"time", timebuf);
	328	if (display == NLRI_STRING_FORMAT_JSON)
	329	json_object_array_add(json_paths, json_time_path);
dba3c1d3	330	}
b588b642	331	if (display == NLRI_STRING_FORMAT_LARGE) {
18ee8310	332	struct bgp_path_info_extra *extra =
9b6d8fcf	333	bgp_path_info_extra_get(path);
dba3c1d3	334
b588b642	335	if (extra->bgp_fs_pbr) {
c26edcda	336	struct listnode *node;
b588b642 PG	337	struct bgp_pbr_match_entry *bpme;
b588b642 PG	338	struct bgp_pbr_match *bpm;
503d1ec6	339	bool list_began = false;
c26edcda	340	struct list *list_bpm;
b588b642	341
c26edcda PG	342	list_bpm = list_new();
	343	if (listcount(extra->bgp_fs_pbr))
	344	vty_out(vty, "\tinstalled in PBR");
	345	for (ALL_LIST_ELEMENTS_RO(extra->bgp_fs_pbr,
	346	node, bpme)) {
	347	bpm = bpme->backpointer;
	348	if (listnode_lookup(list_bpm, bpm))
	349	continue;
	350	listnode_add(list_bpm, bpm);
503d1ec6	351	if (!list_began) {
c26edcda	352	vty_out(vty, " (");
503d1ec6 PG	353	list_began = true;
503d1ec6 PG	354	} else
c26edcda PG	355	vty_out(vty, ", ");
c26edcda PG	356	vty_out(vty, "%s", bpm->ipset_name);
c26edcda	357	}
503d1ec6	358	if (list_began)
c26edcda PG	359	vty_out(vty, ")");
c26edcda PG	360	vty_out(vty, "\n");
6a154c88	361	list_delete(&list_bpm);
b588b642 PG	362	} else
	363	vty_out(vty, "\tnot installed in PBR\n");
	364	}
dba3c1d3 PG	365	}
	366
	367	int bgp_show_table_flowspec(struct vty vty, struct bgp bgp, afi_t afi,
	368	struct bgp_table *table, enum bgp_show_type type,
088f1098 DS	369	void *output_arg, bool use_json, int is_last,
088f1098 DS	370	unsigned long output_cum, unsigned long total_cum)
dba3c1d3	371	{
40381db7	372	struct bgp_path_info *pi;
dba3c1d3 PG	373	struct bgp_node *rn;
	374	unsigned long total_count = 0;
	375	json_object *json_paths = NULL;
d33fc23b	376	int display = NLRI_STRING_FORMAT_LARGE;
dba3c1d3 PG	377
	378	if (type != bgp_show_type_detail)
	379	return CMD_SUCCESS;
	380
dba3c1d3 PG	381	for (rn = bgp_table_top(table); rn; rn = bgp_route_next(rn)) {
	382	if (rn->info == NULL)
	383	continue;
d33fc23b PG	384	if (use_json) {
	385	json_paths = json_object_new_array();
	386	display = NLRI_STRING_FORMAT_JSON;
	387	}
40381db7	388	for (pi = rn->info; pi; pi = pi->next) {
dba3c1d3	389	total_count++;
40381db7	390	route_vty_out_flowspec(vty, &rn->p, pi, display,
dba3c1d3	391	json_paths);
dba3c1d3	392	}
d33fc23b PG	393	if (use_json) {
	394	vty_out(vty, "%s\n",
	395	json_object_to_json_string_ext(
	396	json_paths,
	397	JSON_C_TO_STRING_PRETTY));
	398	json_object_free(json_paths);
	399	json_paths = NULL;
	400	}
dba3c1d3	401	}
d33fc23b	402	if (total_count && !use_json)
dba3c1d3 PG	403	vty_out(vty,
	404	"\nDisplayed %ld flowspec entries\n",
	405	total_count);
	406	return CMD_SUCCESS;
	407	}
	408
268e1b9b PG	409	DEFUN (debug_bgp_flowspec,
	410	debug_bgp_flowspec_cmd,
	411	"debug bgp flowspec",
	412	DEBUG_STR
	413	BGP_STR
	414	"BGP allow flowspec debugging entries\n")
	415	{
	416	if (vty->node == CONFIG_NODE)
	417	DEBUG_ON(flowspec, FLOWSPEC);
	418	else {
	419	TERM_DEBUG_ON(flowspec, FLOWSPEC);
	420	vty_out(vty, "BGP flowspec debugging is on\n");
	421	}
	422	return CMD_SUCCESS;
	423	}
	424
	425	DEFUN (no_debug_bgp_flowspec,
	426	no_debug_bgp_flowspec_cmd,
	427	"no debug bgp flowspec",
	428	NO_STR
	429	DEBUG_STR
	430	BGP_STR
	431	"BGP allow flowspec debugging entries\n")
	432	{
	433	if (vty->node == CONFIG_NODE)
	434	DEBUG_OFF(flowspec, FLOWSPEC);
	435	else {
	436	TERM_DEBUG_OFF(flowspec, FLOWSPEC);
	437	vty_out(vty, "BGP flowspec debugging is off\n");
	438	}
	439	return CMD_SUCCESS;
	440	}
	441
4762c213 PG	442	int bgp_fs_config_write_pbr(struct vty vty, struct bgp bgp,
	443	afi_t afi, safi_t safi)
	444	{
	445	struct bgp_pbr_interface *pbr_if;
	446	bool declare_node = false;
	447	struct bgp_pbr_config *bgp_pbr_cfg = bgp->bgp_pbr_cfg;
	448	struct bgp_pbr_interface_head *head;
	449	bool bgp_pbr_interface_any;
	450
	451	if (!bgp_pbr_cfg \|\| safi != SAFI_FLOWSPEC \|\| afi != AFI_IP)
	452	return 0;
	453	head = &(bgp_pbr_cfg->ifaces_by_name_ipv4);
	454	bgp_pbr_interface_any = bgp_pbr_cfg->pbr_interface_any_ipv4;
	455	if (!RB_EMPTY(bgp_pbr_interface_head, head) \|\|
	456	!bgp_pbr_interface_any)
	457	declare_node = true;
	458	RB_FOREACH (pbr_if, bgp_pbr_interface_head, head) {
	459	vty_out(vty, " local-install %s\n", pbr_if->name);
	460	}
4762c213 PG	461	return declare_node ? 1 : 0;
	462	}
	463
	464	static int bgp_fs_local_install_interface(struct bgp *bgp,
	465	const char no, const char ifname)
	466	{
	467	struct bgp_pbr_interface *pbr_if;
	468	struct bgp_pbr_config *bgp_pbr_cfg = bgp->bgp_pbr_cfg;
	469	struct bgp_pbr_interface_head *head;
	470	bool *bgp_pbr_interface_any;
	471
	472	if (!bgp_pbr_cfg)
	473	return CMD_SUCCESS;
	474	head = &(bgp_pbr_cfg->ifaces_by_name_ipv4);
	475	bgp_pbr_interface_any = &(bgp_pbr_cfg->pbr_interface_any_ipv4);
	476	if (no) {
	477	if (!ifname) {
	478	if (*bgp_pbr_interface_any) {
	479	*bgp_pbr_interface_any = false;
	480	/* remove all other interface list */
	481	bgp_pbr_reset(bgp, AFI_IP);
	482	}
	483	return CMD_SUCCESS;
	484	}
	485	pbr_if = bgp_pbr_interface_lookup(ifname, head);
	486	if (!pbr_if)
	487	return CMD_SUCCESS;
	488	RB_REMOVE(bgp_pbr_interface_head, head, pbr_if);
	489	return CMD_SUCCESS;
	490	}
	491	if (ifname) {
	492	pbr_if = bgp_pbr_interface_lookup(ifname, head);
	493	if (pbr_if)
	494	return CMD_SUCCESS;
	495	pbr_if = XCALLOC(MTYPE_TMP,
	496	sizeof(struct bgp_pbr_interface));
	497	strlcpy(pbr_if->name, ifname, INTERFACE_NAMSIZ);
	498	RB_INSERT(bgp_pbr_interface_head, head, pbr_if);
	499	*bgp_pbr_interface_any = false;
	500	} else {
	501	/* set to default */
	502	if (!*bgp_pbr_interface_any) {
	503	/* remove all other interface list
	504	*/
	505	bgp_pbr_reset(bgp, AFI_IP);
	506	*bgp_pbr_interface_any = true;
	507	}
	508	}
	509	return CMD_SUCCESS;
	510	}
	511
	512	DEFUN (bgp_fs_local_install_ifname,
	513	bgp_fs_local_install_ifname_cmd,
	514	"[no] local-install INTERFACE",
	515	NO_STR
	516	"Apply local policy routing\n"
	517	"Interface name\n")
	518	{
	519	struct bgp *bgp = VTY_GET_CONTEXT(bgp);
	520	int idx = 0;
36de6e0e	521	const char *no = strmatch(argv[0]->text, "no") ? "no" : NULL;
4762c213 PG	522	char *ifname = argv_find(argv, argc, "INTERFACE", &idx) ?
	523	argv[idx]->arg : NULL;
	524
	525	return bgp_fs_local_install_interface(bgp, no, ifname);
	526	}
	527
088f1098 DS	528	extern int bgp_flowspec_display_match_per_ip(afi_t afi, struct bgp_table *rib,
	529	struct prefix *match,
	530	int prefix_check, struct vty *vty,
	531	bool use_json,
	532	json_object *json_paths)
63a0b7a9 PG	533	{
	534	struct bgp_node *rn;
	535	struct prefix *prefix;
	536	int display = 0;
	537
	538	for (rn = bgp_table_top(rib); rn; rn = bgp_route_next(rn)) {
	539	prefix = &rn->p;
	540
	541	if (prefix->family != AF_FLOWSPEC)
	542	continue;
	543
	544	if (bgp_flowspec_contains_prefix(prefix, match, prefix_check)) {
	545	route_vty_out_flowspec(vty, &rn->p,
	546	rn->info, use_json ?
	547	NLRI_STRING_FORMAT_JSON :
	548	NLRI_STRING_FORMAT_LARGE,
	549	json_paths);
	550	display++;
	551	}
	552	}
	553	return display;
	554	}
	555
dba3c1d3 PG	556	void bgp_flowspec_vty_init(void)
dba3c1d3 PG	557	{
268e1b9b PG	558	install_element(ENABLE_NODE, &debug_bgp_flowspec_cmd);
	559	install_element(CONFIG_NODE, &debug_bgp_flowspec_cmd);
	560	install_element(ENABLE_NODE, &no_debug_bgp_flowspec_cmd);
	561	install_element(CONFIG_NODE, &no_debug_bgp_flowspec_cmd);
4762c213	562	install_element(BGP_FLOWSPECV4_NODE, &bgp_fs_local_install_ifname_cmd);
dba3c1d3	563	}