From 830688d0c523d6209091ed2fc9160e6ca70e62b9 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Thu, 4 Feb 2021 17:41:16 +0100 Subject: migrator: ospf: T3267: cleanup empty interface "ip" nodes When per interface OSPF configuration is migrated into "protocols ospf interface" we should cleanup and empty ip {} node unter the individual interface. This makes the config look more nicely. --- src/migration-scripts/interfaces/18-to-19 | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/migration-scripts/interfaces/18-to-19 b/src/migration-scripts/interfaces/18-to-19 index e24421c90..965b76a04 100755 --- a/src/migration-scripts/interfaces/18-to-19 +++ b/src/migration-scripts/interfaces/18-to-19 @@ -14,7 +14,8 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -from sys import exit, argv +from sys import argv +from sys import exit from vyos.configtree import ConfigTree if __name__ == '__main__': @@ -41,6 +42,11 @@ if __name__ == '__main__': config.copy(ip_ospf, ['protocols', 'ospf', 'interface', interface]) config.delete(ip_ospf) + # if "ip ospf" was the only setting, we can clean out the empty + # ip node afterwards + if len(config.list_nodes(ip_ospf[:-1])) == 0: + config.delete(ip_ospf[:-1]) + vif_path = ['interfaces', type, interface, 'vif'] if config.exists(vif_path): for vif in config.list_nodes(vif_path): @@ -51,6 +57,11 @@ if __name__ == '__main__': config.copy(vif_ospf_path, ['protocols', 'ospf', 'interface', f'{interface}.{vif}']) config.delete(vif_ospf_path) + # if "ip ospf" was the only setting, we can clean out the empty + # ip node afterwards + if len(config.list_nodes(vif_ospf_path[:-1])) == 0: + config.delete(vif_ospf_path[:-1]) + vif_s_path = ['interfaces', type, interface, 'vif-s'] if config.exists(vif_s_path): for vif_s in config.list_nodes(vif_s_path): @@ -70,8 +81,18 @@ if __name__ == '__main__': config.copy(vif_c_ospf_path, ['protocols', 'ospf', 'interface', f'{interface}.{vif_s}.{vif_c}']) config.delete(vif_c_ospf_path) + # if "ip ospf" was the only setting, we can clean out the empty + # ip node afterwards + if len(config.list_nodes(vif_c_ospf_path[:-1])) == 0: + config.delete(vif_c_ospf_path[:-1]) + config.delete(vif_s_ospf_path) + # if "ip ospf" was the only setting, we can clean out the empty + # ip node afterwards + if len(config.list_nodes(vif_s_ospf_path[:-1])) == 0: + config.delete(vif_s_ospf_path[:-1]) + try: with open(file_name, 'w') as f: f.write(config.to_string()) -- cgit v1.2.3 From 3dd78cddfe90851cb7a6891add8a0973d23da292 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Thu, 4 Feb 2021 00:00:41 +0100 Subject: vrf: T2450: provide full protocol support in XML and Python with new CLI --- Makefile | 1 - data/configd-include.json | 1 + data/templates/frr/vrf.frr.tmpl | 42 +++ .../include/static-route-blackhole.xml.i | 10 + .../include/static-route-disable.xml.i | 8 - .../include/static-route-next-hop-interface.xml.i | 17 + .../include/static-route-next-hop-vrf.xml.i | 12 +- interface-definitions/include/static-route.xml.i | 63 ++++ interface-definitions/include/static-route6.xml.i | 63 ++++ interface-definitions/protocols-static.xml.in | 24 +- interface-definitions/protocols-vrf.xml.in | 347 +-------------------- interface-definitions/vrf.xml.in | 2 +- smoketest/configs/vrf-basic | 231 ++++++++++++++ src/conf_mode/protocols_vrf.py | 100 ++++++ src/migration-scripts/vrf/0-to-1 | 112 +++++++ 15 files changed, 670 insertions(+), 363 deletions(-) create mode 100644 data/templates/frr/vrf.frr.tmpl create mode 100644 interface-definitions/include/static-route-blackhole.xml.i delete mode 100644 interface-definitions/include/static-route-disable.xml.i create mode 100644 interface-definitions/include/static-route-next-hop-interface.xml.i create mode 100644 interface-definitions/include/static-route.xml.i create mode 100644 interface-definitions/include/static-route6.xml.i create mode 100644 smoketest/configs/vrf-basic create mode 100755 src/conf_mode/protocols_vrf.py create mode 100755 src/migration-scripts/vrf/0-to-1 (limited to 'src') diff --git a/Makefile b/Makefile index c27380dc1..fbd5d57ce 100644 --- a/Makefile +++ b/Makefile @@ -47,7 +47,6 @@ interface_definitions: $(config_xml_obj) rm -f $(TMPL_DIR)/vpn/node.def rm -f $(TMPL_DIR)/vpn/ipsec/node.def rm -rf $(TMPL_DIR)/vpn/nipsec - rm -rf $(TMPL_DIR)/protocols/nvrf rm -rf $(TMPL_DIR)/protocols/nripng rm -rf $(TMPL_DIR)/protocols/nstatic diff --git a/data/configd-include.json b/data/configd-include.json index 751d8e012..c0263127a 100644 --- a/data/configd-include.json +++ b/data/configd-include.json @@ -40,6 +40,7 @@ "protocols_pim.py", "protocols_rip.py", "protocols_static_multicast.py", +"protocols_vrf.py", "salt-minion.py", "service_console-server.py", "service_ids_fastnetmon.py", diff --git a/data/templates/frr/vrf.frr.tmpl b/data/templates/frr/vrf.frr.tmpl new file mode 100644 index 000000000..1cb055962 --- /dev/null +++ b/data/templates/frr/vrf.frr.tmpl @@ -0,0 +1,42 @@ +! +{% if vrf is defined and vrf is not none %} +{% for vrf_name, vrf_config in vrf.items() %} +vrf {{ vrf_name }} +{% if vrf_config.static is defined and vrf_config.static is not none %} +{# IPv4 routes #} +{% if vrf_config.static.route is defined and vrf_config.static.route is not none %} +{% for route, route_config in vrf_config.static.route.items() %} +{% if route_config.blackhole is defined %} + ip route {{ route }} blackhole {{ route_config.blackhole.distance if route_config.blackhole.distance is defined }} +{% elif route_config.interface is defined and route_config.interface is not none %} +{% for interface, interface_config in route_config.interface.items() if interface_config.disable is not defined %} + ip route {{ route }} {{ interface }} {{ interface_config.distance if interface_config.distance is defined }} {{ 'nexthop-vrf ' + interface_config.vrf if interface_config.vrf is defined }} +{% endfor %} +{% elif route_config.next_hop is defined and route_config.next_hop is not none %} +{% for next_hop, next_hop_config in route_config.next_hop.items() if next_hop_config.disable is not defined %} + ip route {{ route }} {{ next_hop }} {{ next_hop_config.interface if next_hop_config.interface is defined }} {{ next_hop_config.distance if next_hop_config.distance is defined }} {{ 'nexthop-vrf ' + next_hop_config.vrf if next_hop_config.vrf is defined }} +{% endfor %} +{% endif %} +{% endfor %} +{% endif %} +{# IPv6 routes #} +{% if vrf_config.static.route6 is defined and vrf_config.static.route6 is not none %} +{% for route, route_config in vrf_config.static.route6.items() %} +{% if route_config.blackhole is defined %} + ipv6 route {{ route }} blackhole {{ route_config.blackhole.distance if route_config.blackhole.distance is defined }} +{% elif route_config.interface is defined and route_config.interface is not none %} +{% for interface, interface_config in route_config.interface.items() if interface_config.disable is not defined %} + ipv6 route {{ route }} {{ interface }} {{ interface_config.distance if interface_config.distance is defined }} {{ 'nexthop-vrf ' + interface_config.vrf if interface_config.vrf is defined }} +{% endfor %} +{% elif route_config.next_hop is defined and route_config.next_hop is not none %} +{% for next_hop, next_hop_config in route_config.next_hop.items() if next_hop_config.disable is not defined %} + ipv6 route {{ route }} {{ next_hop }} {{ next_hop_config.interface if next_hop_config.interface is defined }} {{ next_hop_config.distance if next_hop_config.distance is defined }} {{ 'nexthop-vrf ' + next_hop_config.vrf if next_hop_config.vrf is defined }} +{% endfor %} +{% endif %} + +{% endfor %} +{% endif %} +{% endif %} +{% endfor %} +{% endif %} +! diff --git a/interface-definitions/include/static-route-blackhole.xml.i b/interface-definitions/include/static-route-blackhole.xml.i new file mode 100644 index 000000000..c880ee778 --- /dev/null +++ b/interface-definitions/include/static-route-blackhole.xml.i @@ -0,0 +1,10 @@ + + + + Silently discard packets when matched + + + #include + + + diff --git a/interface-definitions/include/static-route-disable.xml.i b/interface-definitions/include/static-route-disable.xml.i deleted file mode 100644 index 100ca3cbf..000000000 --- a/interface-definitions/include/static-route-disable.xml.i +++ /dev/null @@ -1,8 +0,0 @@ - - - - Disable interface static route - - - - diff --git a/interface-definitions/include/static-route-next-hop-interface.xml.i b/interface-definitions/include/static-route-next-hop-interface.xml.i new file mode 100644 index 000000000..01c253597 --- /dev/null +++ b/interface-definitions/include/static-route-next-hop-interface.xml.i @@ -0,0 +1,17 @@ + + + + Gateway interface name + + + + + txt + Gateway interface name + + + ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ + + + + diff --git a/interface-definitions/include/static-route-next-hop-vrf.xml.i b/interface-definitions/include/static-route-next-hop-vrf.xml.i index c90140856..ae2515a12 100644 --- a/interface-definitions/include/static-route-next-hop-vrf.xml.i +++ b/interface-definitions/include/static-route-next-hop-vrf.xml.i @@ -1,16 +1,18 @@ - + VRF to leak route + + default + vrf name + txt Name of VRF to leak to - - protocols vrf - - ^[a-zA-Z0-9\-_]{1,100}$ + ^(default)$ + diff --git a/interface-definitions/include/static-route.xml.i b/interface-definitions/include/static-route.xml.i new file mode 100644 index 000000000..9ab3926da --- /dev/null +++ b/interface-definitions/include/static-route.xml.i @@ -0,0 +1,63 @@ + + + + VRF static IPv4 route + + ipv4net + VRF static IPv4 route + + + + + + + + + Silently discard pkts when matched + + + #include + + + + + Next-hop IPv4 router interface + + + + + txt + Gateway interface name + + + ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ + + + + #include + #include + #include + + + + + Next-hop IPv4 router address + + ipv4 + Next-hop router address + + + + + + + #include + #include + #include + #include + + + + + + diff --git a/interface-definitions/include/static-route6.xml.i b/interface-definitions/include/static-route6.xml.i new file mode 100644 index 000000000..d484b285c --- /dev/null +++ b/interface-definitions/include/static-route6.xml.i @@ -0,0 +1,63 @@ + + + + VRF static IPv6 route + + ipv6net + VRF static IPv6 route + + + + + + + + + Silently discard pkts when matched + + + #include + + + + + IPv6 gateway interface name + + + + + txt + Gateway interface name + + + ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ + + + + #include + #include + #include + + + + + IPv6 gateway address + + ipv6 + Next-hop IPv6 router + + + + + + + #include + #include + #include + #include + + + + + + diff --git a/interface-definitions/protocols-static.xml.in b/interface-definitions/protocols-static.xml.in index 2a9f7014f..3ad6434db 100644 --- a/interface-definitions/protocols-static.xml.in +++ b/interface-definitions/protocols-static.xml.in @@ -28,11 +28,11 @@ - #include + #include #include #include - + @@ -55,10 +55,10 @@ - #include + #include #include - + #include @@ -118,7 +118,7 @@ - #include + #include #include @@ -169,7 +169,7 @@ - #include + #include #include @@ -220,10 +220,10 @@ - #include + #include #include - + @@ -246,10 +246,10 @@ - #include + #include #include - + @@ -296,7 +296,7 @@ - #include + #include #include @@ -347,7 +347,7 @@ - #include + #include #include diff --git a/interface-definitions/protocols-vrf.xml.in b/interface-definitions/protocols-vrf.xml.in index d58f85b02..81942d124 100644 --- a/interface-definitions/protocols-vrf.xml.in +++ b/interface-definitions/protocols-vrf.xml.in @@ -1,18 +1,21 @@ - - + Name of VRF to add route for + + vrf name + txt - Name of VRF to add route for + VRF instance name - - protocols vrf - + + + + VRF instance name must be 15 characters or less and can not\nbe named as regular network interfaces.\n @@ -20,336 +23,8 @@ Static route parameters - - - Interface based static route - - ipv4net - Interface based static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - - - Disable IPv4 interface static route - - - - - - Distance for this route - - u32:1-255 - Distance for this route - - - - - - - - - VRF to leak route - - txt - Name of VRF to leak to - - - default - Name of VRF to leak to - - - default - protocols vrf - - - ^[a-zA-Z0-9\-_]{1,100}$ - - - - - - - - - - Interface based IPv6 static route - - ipv6net - Interface based IPv6 static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - - - Disable IPv6 interface static route - - - - - - Distance for this route - - u32:1-255 - Distance for this route - - - - - - - - - VRF to leak route - - txt - Name of VRF to leak to - - - default - Name of VRF to leak to - - - default - protocols vrf - - - ^[a-zA-Z0-9\-_]{1,100}$ - - - - - - - - - - VRF static IPv4 route - - ipv4net - VRF static IPv4 route - - - - - - - - - Silently discard pkts when matched - - - - - Distance value for this route - - u32:1-255 - Distance for this route - - - - - - - - - - - DHCP interface that supplies the next-hop IP address for this static route - - - - - txt - DHCP interface - - - - - - Next-hop router - - ipv4 - Next-hop router - - - - - - - - - Disable IPv4 interface static route - - - - - - Distance for this route - - u32:1-255 - Distance for this route - - - - - - - - - IPv4 gateway interface name - - - - - txt - IPv4 gateway interface name - - - - - - VRF to leak route - - txt - Name of VRF to leak to - - - default - Name of VRF to leak to - - - default - protocols vrf - - - ^[a-zA-Z0-9\-_]{1,100}$ - - - - - - - - - - VRF static IPv6 route - - ipv6net - VRF static IPv6 route - - - - - - - - - Silently discard pkts when matched - - - - - Distance value for this route - - u32:1-255 - Distance for this route - - - - - - - - - - - Next-hop IPv6 router [REQUIRED] - - ipv6 - Next-hop IPv6 router [REQUIRED] - - - - - - - - - Disable IPv6 interface static route - - - - - - Distance for this route - - u32:1-255 - Distance for this route - - - - - - - - - IPv6 gateway interface name - - - - - txt - IPv6 gateway interface name - - - - - - VRF to leak route - - txt - Name of VRF to leak to - - - default - Name of VRF to leak to - - - default - protocols vrf - - - ^[a-zA-Z0-9\-_]{1,100}$ - - - - - - - + #include + #include diff --git a/interface-definitions/vrf.xml.in b/interface-definitions/vrf.xml.in index 81c89d94b..eca9e75a7 100644 --- a/interface-definitions/vrf.xml.in +++ b/interface-definitions/vrf.xml.in @@ -21,7 +21,7 @@ VRF instance name must be 15 characters or less and can not\nbe named as regular network interfaces.\n - name + txt Instance name diff --git a/smoketest/configs/vrf-basic b/smoketest/configs/vrf-basic new file mode 100644 index 000000000..ded33f683 --- /dev/null +++ b/smoketest/configs/vrf-basic @@ -0,0 +1,231 @@ +interfaces { + ethernet eth0 { + address 192.0.2.1/24 + } + ethernet eth1 { + duplex auto + speed auto + vrf green + } + ethernet eth2 { + vrf red + } +} +protocols { + static { + route 0.0.0.0/0 { + next-hop 192.0.2.254 { + distance 10 + } + } + table 10 { + interface-route 1.0.0.0/8 { + next-hop-interface eth0 { + distance 20 + } + } + interface-route 2.0.0.0/8 { + next-hop-interface eth0 { + distance 20 + } + } + interface-route 3.0.0.0/8 { + next-hop-interface eth0 { + distance 20 + } + } + } + table 20 { + interface-route 4.0.0.0/8 { + next-hop-interface eth0 { + distance 20 + } + } + interface-route 5.0.0.0/8 { + next-hop-interface eth0 { + distance 50 + } + } + interface-route 6.0.0.0/8 { + next-hop-interface eth0 { + distance 60 + } + } + interface-route6 2001:db8:100::/40 { + next-hop-interface eth1 { + distance 20 + } + } + interface-route6 2001:db8::/40 { + next-hop-interface eth1 { + distance 10 + } + } + route 11.0.0.0/8 { + next-hop 1.1.1.1 { + next-hop-interface eth0 + } + } + route 12.0.0.0/8 { + next-hop 1.1.1.1 { + next-hop-interface eth0 + } + } + route 13.0.0.0/8 { + next-hop 1.1.1.1 { + next-hop-interface eth0 + } + } + } + table 30 { + interface-route6 2001:db8:200::/40 { + next-hop-interface eth1 { + distance 20 + } + } + route 14.0.0.0/8 { + next-hop 2.2.1.1 { + next-hop-interface eth1 + } + } + route 15.0.0.0/8 { + next-hop 2.2.1.1 { + next-hop-interface eth1 + } + } + } + } + vrf green { + static { + interface-route 100.0.0.0/8 { + next-hop-interface eth0 { + distance 200 + next-hop-vrf default + } + } + interface-route 101.0.0.0/8 { + next-hop-interface eth0 { + next-hop-vrf default + } + next-hop-interface eth1 { + } + } + interface-route6 2001:db8:300::/40 { + next-hop-interface eth1 { + distance 20 + next-hop-vrf default + } + } + route 20.0.0.0/8 { + next-hop 1.1.1.1 { + next-hop-interface eth1 + next-hop-vrf default + } + } + route 21.0.0.0/8 { + next-hop 2.2.1.1 { + next-hop-interface eth1 + next-hop-vrf default + } + } + route6 2001:db8:100::/40 { + next-hop fe80::1 { + interface eth0 + next-hop-vrf default + } + } + } + } + vrf red { + static { + interface-route 103.0.0.0/8 { + next-hop-interface eth0 { + distance 201 + next-hop-vrf default + } + } + interface-route 104.0.0.0/8 { + next-hop-interface eth0 { + next-hop-vrf default + } + next-hop-interface eth1 { + next-hop-vrf default + } + } + interface-route6 2001:db8:400::/40 { + next-hop-interface eth1 { + distance 24 + next-hop-vrf default + } + } + route 30.0.0.0/8 { + next-hop 1.1.1.1 { + next-hop-interface eth1 + } + } + route 40.0.0.0/8 { + next-hop 2.2.1.1 { + next-hop-interface eth1 + next-hop-vrf default + } + } + route6 2001:db8:100::/40 { + next-hop fe80::1 { + interface eth0 + next-hop-vrf default + } + } + } + } +} +system { + config-management { + commit-revisions 100 + } + console { + device ttyS0 { + speed 115200 + } + } + host-name vyos + login { + user vyos { + authentication { + encrypted-password $6$O5gJRlDYQpj$MtrCV9lxMnZPMbcxlU7.FI793MImNHznxGoMFgm3Q6QP3vfKJyOSRCt3Ka/GzFQyW1yZS4NS616NLHaIPPFHc0 + plaintext-password "" + } + } + } + nt + ntp { + server 0.pool.ntp.org { + } + server 1.pool.ntp.org { + } + server 2.pool.ntp.org { + } + } + syslog { + global { + facility all { + level info + } + facility protocols { + level debug + } + } + } + time-zone Europe/Berlin +} +vrf { + name green { + table 1000 + } + name red { + table 2000 + } +} + +// Warning: Do not remove the following line. +// vyos-config-version: "broadcast-relay@1:cluster@1:config-management@1:conntrack@1:conntrack-sync@1:dhcp-relay@2:dhcp-server@5:dhcpv6-server@1:dns-forwarding@3:firewall@5:https@2:interfaces@18:ipoe-server@1:ipsec@5:l2tp@3:lldp@1:mdns@1:nat@5:ntp@1:pppoe-server@5:pptp@2:qos@1:quagga@6:salt@1:snmp@2:ssh@2:sstp@3:system@20:vrrp@2:vyos-accel-ppp@2:wanloadbalance@3:webproxy@2:zone-policy@1" +// Release version: 1.3-beta-202101231023 diff --git a/src/conf_mode/protocols_vrf.py b/src/conf_mode/protocols_vrf.py new file mode 100755 index 000000000..7c32c7013 --- /dev/null +++ b/src/conf_mode/protocols_vrf.py @@ -0,0 +1,100 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2021 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program 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. If not, see . + +import os + +from sys import exit + +from vyos.config import Config +from vyos.template import render +from vyos.template import render_to_string +from vyos.util import call +from vyos import ConfigError +from vyos import frr +from vyos import airbag +airbag.enable() + +config_file = r'/tmp/vrf.frr' +frr_daemon = 'staticd' + +DEBUG = os.path.exists('/tmp/vrf.debug') +if DEBUG: + import logging + lg = logging.getLogger("vyos.frr") + lg.setLevel(logging.DEBUG) + ch = logging.StreamHandler() + lg.addHandler(ch) + +def get_config(config=None): + if config: + conf = config + else: + conf = Config() + base = ['protocols', 'vrf'] + vrf = conf.get_config_dict(base, key_mangling=('-', '_')) + return vrf + +def verify(vrf): + + return None + +def generate(vrf): + # render(config) not needed, its only for debug + render(config_file, 'frr/vrf.frr.tmpl', vrf) + vrf['new_frr_config'] = render_to_string('frr/vrf.frr.tmpl', vrf) + + return None + +def apply(vrf): + # Save original configuration prior to starting any commit actions + frr_cfg = frr.FRRConfig() + frr_cfg.load_configuration(frr_daemon) + frr_cfg.modify_section(r'vrf \S+', '') + frr_cfg.add_before(r'(ip prefix-list .*|route-map .*|line vty)', vrf['new_frr_config']) + + # Debugging + if DEBUG: + from pprint import pprint + print('') + print('--------- DEBUGGING ----------') + pprint(dir(frr_cfg)) + print('Existing config:\n') + for line in frr_cfg.original_config: + print(line) + print(f'Replacement config:\n') + print(f'{vrf["new_frr_config"]}') + print(f'Modified config:\n') + print(f'{frr_cfg}') + + frr_cfg.commit_configuration(frr_daemon) + + # If FRR config is blank, rerun the blank commit x times due to frr-reload + # behavior/bug not properly clearing out on one commit. + if vrf['new_frr_config'] == '': + for a in range(5): + frr_cfg.commit_configuration(frr_daemon) + + return None + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) diff --git a/src/migration-scripts/vrf/0-to-1 b/src/migration-scripts/vrf/0-to-1 new file mode 100755 index 000000000..29b2fab74 --- /dev/null +++ b/src/migration-scripts/vrf/0-to-1 @@ -0,0 +1,112 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2021 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program 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. If not, see . + +# - T2450: drop interface-route and interface-route6 from "protocols vrf" + +from sys import argv +from sys import exit +from vyos.configtree import ConfigTree + +if (len(argv) < 2): + print("Must specify file name!") + exit(1) + +file_name = argv[1] + +with open(file_name, 'r') as f: + config_file = f.read() + +base = ['protocols', 'vrf'] +config = ConfigTree(config_file) + +if not config.exists(base): + # Nothing to do + exit(0) + +for vrf in config.list_nodes(base): + static_base = base + [vrf, 'static'] + if not config.exists(static_base): + continue + + # + # Migrate interface-route into route + # + interface_route_path = static_base + ['interface-route'] + if config.exists(interface_route_path): + for route in config.list_nodes(interface_route_path): + interface = config.list_nodes(interface_route_path + [route, 'next-hop-interface']) + + tmp = interface_route_path + [route, 'next-hop-interface'] + for interface in config.list_nodes(tmp): + new_base = static_base + ['route', route, 'interface'] + config.set(new_base) + config.set_tag(new_base) + config.copy(tmp + [interface], new_base + [interface]) + + config.delete(interface_route_path) + + # + # Migrate interface-route6 into route6 + # + interface_route_path = static_base + ['interface-route6'] + if config.exists(interface_route_path): + for route in config.list_nodes(interface_route_path): + interface = config.list_nodes(interface_route_path + [route, 'next-hop-interface']) + + tmp = interface_route_path + [route, 'next-hop-interface'] + for interface in config.list_nodes(tmp): + new_base = static_base + ['route6', route, 'interface'] + config.set(new_base) + config.set_tag(new_base) + config.copy(tmp + [interface], new_base + [interface]) + + config.delete(interface_route_path) + + # + # Cleanup nodes inside route + # + route_path = static_base + ['route'] + if config.exists(route_path): + for route in config.list_nodes(route_path): + next_hop = route_path + [route, 'next-hop'] + if config.exists(next_hop): + for gateway in config.list_nodes(next_hop): + interface_path = next_hop + [gateway, 'next-hop-interface'] + if config.exists(interface_path): + config.rename(interface_path, 'interface') + vrf_path = next_hop + [gateway, 'next-hop-vrf'] + if config.exists(vrf_path): + config.rename(vrf_path, 'vrf') + + # + # Cleanup nodes inside route6 + # + route_path = static_base + ['route6'] + if config.exists(route_path): + for route in config.list_nodes(route_path): + next_hop = route_path + [route, 'next-hop'] + if config.exists(next_hop): + for gateway in config.list_nodes(next_hop): + vrf_path = next_hop + [gateway, 'next-hop-vrf'] + if config.exists(vrf_path): + config.rename(vrf_path, 'vrf') + +try: + with open(file_name, 'w') as f: + f.write(config.to_string()) +except OSError as e: + print("Failed to save the modified config: {}".format(e)) + exit(1) -- cgit v1.2.3 From 1f8c257f126d492a3f41eee72728b2c35b6b534e Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Thu, 4 Feb 2021 19:35:18 +0100 Subject: route: static: T2450: provide full protocol support in XML and Python with new CLI --- Makefile | 3 - data/configd-include.json | 1 + data/templates/frr/static.frr.tmpl | 38 +++ data/templates/frr/static_routes_macro.j2 | 15 + data/templates/frr/vrf.frr.tmpl | 34 +-- interface-definitions/arp.xml.in | 37 --- interface-definitions/include/static-route.xml.i | 14 +- interface-definitions/include/static-route6.xml.i | 14 +- interface-definitions/protocols-multicast.xml.in | 1 - interface-definitions/protocols-static-arp.xml.in | 37 +++ interface-definitions/protocols-static.xml.in | 341 +--------------------- src/conf_mode/protocols_static.py | 102 +++++++ src/migration-scripts/quagga/7-to-8 | 122 ++++++++ 13 files changed, 354 insertions(+), 405 deletions(-) create mode 100644 data/templates/frr/static.frr.tmpl create mode 100644 data/templates/frr/static_routes_macro.j2 delete mode 100644 interface-definitions/arp.xml.in create mode 100644 interface-definitions/protocols-static-arp.xml.in create mode 100755 src/conf_mode/protocols_static.py create mode 100755 src/migration-scripts/quagga/7-to-8 (limited to 'src') diff --git a/Makefile b/Makefile index fbd5d57ce..a984f88db 100644 --- a/Makefile +++ b/Makefile @@ -40,15 +40,12 @@ interface_definitions: $(config_xml_obj) # XXX: delete top level node.def's that now live in other packages rm -f $(TMPL_DIR)/firewall/node.def rm -f $(TMPL_DIR)/interfaces/node.def - rm -f $(TMPL_DIR)/protocols/node.def - rm -f $(TMPL_DIR)/protocols/static/node.def rm -f $(TMPL_DIR)/policy/node.def rm -f $(TMPL_DIR)/system/node.def rm -f $(TMPL_DIR)/vpn/node.def rm -f $(TMPL_DIR)/vpn/ipsec/node.def rm -rf $(TMPL_DIR)/vpn/nipsec rm -rf $(TMPL_DIR)/protocols/nripng - rm -rf $(TMPL_DIR)/protocols/nstatic # XXX: required until OSPF and RIP is migrated from vyatta-cfg-quagga to vyos-1x mkdir $(TMPL_DIR)/interfaces/loopback/node.tag/ipv6 diff --git a/data/configd-include.json b/data/configd-include.json index c0263127a..d2789e285 100644 --- a/data/configd-include.json +++ b/data/configd-include.json @@ -39,6 +39,7 @@ "protocols_ospfv3.py", "protocols_pim.py", "protocols_rip.py", +"protocols_static.py", "protocols_static_multicast.py", "protocols_vrf.py", "salt-minion.py", diff --git a/data/templates/frr/static.frr.tmpl b/data/templates/frr/static.frr.tmpl new file mode 100644 index 000000000..bb0ec80a5 --- /dev/null +++ b/data/templates/frr/static.frr.tmpl @@ -0,0 +1,38 @@ +{% from 'frr/static_routes_macro.j2' import static_routes %} +! +{# IPv4 routing #} +{% if route is defined and route is not none %} +{% for prefix, prefix_config in route.items() %} +{{ static_routes('ip', prefix, prefix_config) }} +{%- endfor -%} +{% endif %} +! +{# IPv6 routing #} +{% if route6 is defined and route6 is not none %} +{% for prefix, prefix_config in route6.items() %} +{{ static_routes('ipv6', prefix, prefix_config) }} +{%- endfor -%} +{% endif %} +! +{# Policy route tables #} +{% if table is defined and table is not none %} +{% for table_id, table_config in table.items() %} +{% if table_config.route is defined and table_config.route is not none %} +{% for prefix, prefix_config in table_config.route.items() %} +{{ static_routes('ip', prefix, prefix_config, table_id) }} +{%- endfor -%} +{% endif %} +! +{% if table_config.route6 is defined and table_config.route6 is not none %} +{% for prefix, prefix_config in table_config.route6.items() %} +{{ static_routes('ipv6', prefix, prefix_config, table_id) }} +{%- endfor -%} +{% endif %} +! +{% endfor %} +{% endif %} +! +{% if route_map is defined and route_map is not none %} +ip protocol static route-map {{ route_map }} +! +{% endif %} diff --git a/data/templates/frr/static_routes_macro.j2 b/data/templates/frr/static_routes_macro.j2 new file mode 100644 index 000000000..aadb2805e --- /dev/null +++ b/data/templates/frr/static_routes_macro.j2 @@ -0,0 +1,15 @@ +{% macro static_routes(ip_ipv6, prefix, prefix_config, table=None) %} +{% if prefix_config.blackhole is defined %} +{{ ip_ipv6 }} route {{ prefix }} blackhole {{ prefix_config.blackhole.distance if prefix_config.blackhole.distance is defined }} {{ 'tag ' + prefix_config.blackhole.tag if prefix_config.blackhole.tag is defined }} {{ 'table ' + table if table is defined and table is not none }} +{% endif %} +{% if prefix_config.interface is defined and prefix_config.interface is not none %} +{% for interface, interface_config in prefix_config.interface.items() if interface_config.disable is not defined %} +{{ ip_ipv6 }} route {{ prefix }} {{ interface }} {{ interface_config.distance if interface_config.distance is defined }} {{ 'nexthop-vrf ' + interface_config.vrf if interface_config.vrf is defined }} {{ 'table ' + table if table is defined and table is not none }} +{% endfor %} +{% endif %} +{% if prefix_config.next_hop is defined and prefix_config.next_hop is not none %} +{% for next_hop, next_hop_config in prefix_config.next_hop.items() if next_hop_config.disable is not defined %} +{{ ip_ipv6 }} route {{ prefix }} {{ next_hop }} {{ next_hop_config.interface if next_hop_config.interface is defined }} {{ next_hop_config.distance if next_hop_config.distance is defined }} {{ 'nexthop-vrf ' + next_hop_config.vrf if next_hop_config.vrf is defined }} {{ 'table ' + table if table is defined and table is not none }} +{% endfor %} +{% endif %} +{% endmacro %} diff --git a/data/templates/frr/vrf.frr.tmpl b/data/templates/frr/vrf.frr.tmpl index 1cb055962..0c8726908 100644 --- a/data/templates/frr/vrf.frr.tmpl +++ b/data/templates/frr/vrf.frr.tmpl @@ -1,3 +1,4 @@ +{% from 'frr/static_routes_macro.j2' import static_routes %} ! {% if vrf is defined and vrf is not none %} {% for vrf_name, vrf_config in vrf.items() %} @@ -5,36 +6,15 @@ vrf {{ vrf_name }} {% if vrf_config.static is defined and vrf_config.static is not none %} {# IPv4 routes #} {% if vrf_config.static.route is defined and vrf_config.static.route is not none %} -{% for route, route_config in vrf_config.static.route.items() %} -{% if route_config.blackhole is defined %} - ip route {{ route }} blackhole {{ route_config.blackhole.distance if route_config.blackhole.distance is defined }} -{% elif route_config.interface is defined and route_config.interface is not none %} -{% for interface, interface_config in route_config.interface.items() if interface_config.disable is not defined %} - ip route {{ route }} {{ interface }} {{ interface_config.distance if interface_config.distance is defined }} {{ 'nexthop-vrf ' + interface_config.vrf if interface_config.vrf is defined }} -{% endfor %} -{% elif route_config.next_hop is defined and route_config.next_hop is not none %} -{% for next_hop, next_hop_config in route_config.next_hop.items() if next_hop_config.disable is not defined %} - ip route {{ route }} {{ next_hop }} {{ next_hop_config.interface if next_hop_config.interface is defined }} {{ next_hop_config.distance if next_hop_config.distance is defined }} {{ 'nexthop-vrf ' + next_hop_config.vrf if next_hop_config.vrf is defined }} -{% endfor %} -{% endif %} -{% endfor %} +{% for prefix, prefix_config in vrf_config.static.route.items() %} + {{ static_routes('ip', prefix, prefix_config) }} +{%- endfor -%} {% endif %} {# IPv6 routes #} {% if vrf_config.static.route6 is defined and vrf_config.static.route6 is not none %} -{% for route, route_config in vrf_config.static.route6.items() %} -{% if route_config.blackhole is defined %} - ipv6 route {{ route }} blackhole {{ route_config.blackhole.distance if route_config.blackhole.distance is defined }} -{% elif route_config.interface is defined and route_config.interface is not none %} -{% for interface, interface_config in route_config.interface.items() if interface_config.disable is not defined %} - ipv6 route {{ route }} {{ interface }} {{ interface_config.distance if interface_config.distance is defined }} {{ 'nexthop-vrf ' + interface_config.vrf if interface_config.vrf is defined }} -{% endfor %} -{% elif route_config.next_hop is defined and route_config.next_hop is not none %} -{% for next_hop, next_hop_config in route_config.next_hop.items() if next_hop_config.disable is not defined %} - ipv6 route {{ route }} {{ next_hop }} {{ next_hop_config.interface if next_hop_config.interface is defined }} {{ next_hop_config.distance if next_hop_config.distance is defined }} {{ 'nexthop-vrf ' + next_hop_config.vrf if next_hop_config.vrf is defined }} -{% endfor %} -{% endif %} - -{% endfor %} +{% for prefix, prefix_config in vrf_config.static.route6.items() %} + {{ static_routes('ipv6', prefix, prefix_config) }} +{%- endfor -%} {% endif %} {% endif %} {% endfor %} diff --git a/interface-definitions/arp.xml.in b/interface-definitions/arp.xml.in deleted file mode 100644 index 082afe00f..000000000 --- a/interface-definitions/arp.xml.in +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - Static ARP translation - - ipv4 - IPv4 destination address - - - - - - - - - mac address to translate to - - macaddr - Hardware (MAC) address - - - - - - - - - - - - - diff --git a/interface-definitions/include/static-route.xml.i b/interface-definitions/include/static-route.xml.i index 9ab3926da..1f79aaca8 100644 --- a/interface-definitions/include/static-route.xml.i +++ b/interface-definitions/include/static-route.xml.i @@ -4,7 +4,7 @@ VRF static IPv4 route ipv4net - VRF static IPv4 route + IPv4 static route @@ -17,6 +17,18 @@ #include + + + Tag value for this route + + u32:1-4294967295 + Tag value for this route + + + + + + diff --git a/interface-definitions/include/static-route6.xml.i b/interface-definitions/include/static-route6.xml.i index d484b285c..1ff6bbead 100644 --- a/interface-definitions/include/static-route6.xml.i +++ b/interface-definitions/include/static-route6.xml.i @@ -4,7 +4,7 @@ VRF static IPv6 route ipv6net - VRF static IPv6 route + IPv6 static route @@ -17,6 +17,18 @@ #include + + + Tag value for this route + + u32:1-4294967295 + Tag value for this route + + + + + + diff --git a/interface-definitions/protocols-multicast.xml.in b/interface-definitions/protocols-multicast.xml.in index a06f2b287..bf0ead78f 100644 --- a/interface-definitions/protocols-multicast.xml.in +++ b/interface-definitions/protocols-multicast.xml.in @@ -1,5 +1,4 @@ - diff --git a/interface-definitions/protocols-static-arp.xml.in b/interface-definitions/protocols-static-arp.xml.in new file mode 100644 index 000000000..e5e8a9ad9 --- /dev/null +++ b/interface-definitions/protocols-static-arp.xml.in @@ -0,0 +1,37 @@ + + + + + + + + + Static ARP translation + + ipv4 + IPv4 destination address + + + + + + + + + Translation MAC address + + macaddr + Hardware (MAC) address + + + + + + + + + + + + + diff --git a/interface-definitions/protocols-static.xml.in b/interface-definitions/protocols-static.xml.in index 3ad6434db..59a7927a5 100644 --- a/interface-definitions/protocols-static.xml.in +++ b/interface-definitions/protocols-static.xml.in @@ -1,193 +1,15 @@ - - + - + Static route parameters - - - Interface based static route - - ipv4net - Interface based static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - #include - #include - #include - - - - - - - Interface based IPv6 static route - - ipv6net - Interface based IPv6 static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - #include - #include - - - - #include - - - Static route - - ipv4net - Static route - - - - - - - - - Silently discard pkts when matched - - - #include - - - Tag value for this route - - u32:1-4294967295 - Tag value for this route - - - - - - - - - - - DHCP interface that supplies the next-hop IP address for this static route - - - - - txt - DHCP interface - - - - - - Next-hop router - - ipv4 - Next-hop router - - - - - - - #include - #include - - - IPv4 gateway interface name - - - - - txt - IPv4 gateway interface name - - - - #include - - - - - - - Static IPv6 route - - ipv6net - Static IPv6 route - - - - - - - - - Silently discard pkts when matched - - - #include - - - - - Next-hop IPv6 router [REQUIRED] - - ipv6 - Next-hop IPv6 router [REQUIRED] - - - - - - - #include - #include - - - IPv6 gateway interface name - - - - - txt - IPv6 gateway interface name - - - - #include - - - - + #include + #include Policy route table number @@ -200,159 +22,8 @@ - - - Interface based static route - - ipv4net - Interface based static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - #include - #include - - - - - - - Interface based IPv6 static route - - ipv6net - Interface based IPv6 static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - #include - #include - - - - - - - Static route - - ipv4net - Static route - - - - - - - - - Silently discard pkts when matched - - - #include - - - - - DHCP interface that supplies the next-hop IP address for this static route - - - - - txt - DHCP interface - - - - - - Next-hop router - - ipv4 - Next-hop router - - - - - - - #include - #include - - - IPv4 gateway interface name - - - - - txt - IPv4 gateway interface name - - - - #include - - - - - - - Static IPv6 route - - ipv6net - Static IPv6 route - - - - - - - - - Silently discard pkts when matched - - - #include - - - - - Next-hop IPv6 router [REQUIRED] - - ipv6 - Next-hop IPv6 router [REQUIRED] - - - - - - - #include - #include - - - - + #include + #include diff --git a/src/conf_mode/protocols_static.py b/src/conf_mode/protocols_static.py new file mode 100755 index 000000000..62a3fecd7 --- /dev/null +++ b/src/conf_mode/protocols_static.py @@ -0,0 +1,102 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2021 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program 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. If not, see . + +import os + +from sys import exit + +from vyos.config import Config +from vyos.template import render +from vyos.template import render_to_string +from vyos.util import call +from vyos.configverify import verify_route_maps +from vyos import ConfigError +from vyos import frr +from vyos import airbag +airbag.enable() + +config_file = r'/tmp/static.frr' +frr_daemon = 'staticd' + +DEBUG = os.path.exists('/tmp/static.debug') +if DEBUG: + import logging + lg = logging.getLogger("vyos.frr") + lg.setLevel(logging.DEBUG) + ch = logging.StreamHandler() + lg.addHandler(ch) + +def get_config(config=None): + if config: + conf = config + else: + conf = Config() + base = ['protocols', 'static'] + static = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True) + return static + +def verify(static): + verify_route_maps(static) + return None + +def generate(static): + # render(config) not needed, its only for debug + render(config_file, 'frr/static.frr.tmpl', static) + static['new_frr_config'] = render_to_string('frr/static.frr.tmpl', static) + + return None + +def apply(static): + # Save original configuration prior to starting any commit actions + frr_cfg = frr.FRRConfig() + frr_cfg.load_configuration(frr_daemon) + frr_cfg.modify_section(r'^ip route .*', '') + frr_cfg.modify_section(r'^ipv6 route .*', '') + frr_cfg.add_before(r'(interface .*|line vty)', static['new_frr_config']) + + # Debugging + if DEBUG: + from pprint import pprint + print('') + print('--------- DEBUGGING ----------') + pprint(dir(frr_cfg)) + print('Existing config:\n') + for line in frr_cfg.original_config: + print(line) + print(f'Replacement config:\n') + print(f'{static["new_frr_config"]}') + print(f'Modified config:\n') + print(f'{frr_cfg}') + + frr_cfg.commit_configuration(frr_daemon) + + # If FRR config is blank, rerun the blank commit x times due to frr-reload + # behavior/bug not properly clearing out on one commit. + if static['new_frr_config'] == '': + for a in range(5): + frr_cfg.commit_configuration(frr_daemon) + + return None + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) diff --git a/src/migration-scripts/quagga/7-to-8 b/src/migration-scripts/quagga/7-to-8 new file mode 100755 index 000000000..9c277a6f1 --- /dev/null +++ b/src/migration-scripts/quagga/7-to-8 @@ -0,0 +1,122 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2021 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program 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. If not, see . + +# - T2450: drop interface-route and interface-route6 from "protocols static" + +from sys import argv +from sys import exit + +from vyos.configtree import ConfigTree + +def migrate_interface_route(config, base, path, route_route6): + """ Generic migration function which can be called on every instance of + interface-route, beeing it ipv4, ipv6 or nested under the "static table" nodes. + + What we do? + - Drop 'interface-route' or 'interface-route6' and migrate the route unter the + 'route' or 'route6' tag node. + """ + if config.exists(base + path): + for route in config.list_nodes(base + path): + interface = config.list_nodes(base + path + [route, 'next-hop-interface']) + + tmp = base + path + [route, 'next-hop-interface'] + for interface in config.list_nodes(tmp): + new_base = base + [route_route6, route, 'interface'] + config.set(new_base) + config.set_tag(base + [route_route6]) + config.set_tag(new_base) + config.copy(tmp + [interface], new_base + [interface]) + + config.delete(base + path) + +def migrate_route(config, base, path, route_route6): + """ Generic migration function which can be called on every instance of + route, beeing it ipv4, ipv6 or even nested under the static table nodes. + + What we do? + - for consistency reasons rename next-hop-interface to interface + - for consistency reasons rename next-hop-vrf to vrf + """ + if config.exists(base + path): + for route in config.list_nodes(base + path): + next_hop = base + path + [route, 'next-hop'] + if config.exists(next_hop): + for gateway in config.list_nodes(next_hop): + # IPv4 routes calls it next-hop-interface, rename this to + # interface instead so it's consitent with IPv6 + interface_path = next_hop + [gateway, 'next-hop-interface'] + if config.exists(interface_path): + config.rename(interface_path, 'interface') + + # When VRFs got introduced, I (c-po) named it next-hop-vrf, + # we can also call it vrf which is simply shorter. + vrf_path = next_hop + [gateway, 'next-hop-vrf'] + if config.exists(vrf_path): + config.rename(vrf_path, 'vrf') + + +if (len(argv) < 2): + print("Must specify file name!") + exit(1) + +file_name = argv[1] + +with open(file_name, 'r') as f: + config_file = f.read() + +base = ['protocols', 'static'] + +config = ConfigTree(config_file) +if not config.exists(base): + # Nothing to do + exit(0) + +# Migrate interface-route into route +migrate_interface_route(config, base, ['interface-route'], 'route') + +# Migrate interface-route6 into route6 +migrate_interface_route(config, base, ['interface-route6'], 'route6') + +# Cleanup nodes inside route +migrate_route(config, base, ['route'], 'route') + +# Cleanup nodes inside route6 +migrate_route(config, base, ['route6'], 'route6') + +# +# PBR table cleanup +table_path = base + ['table'] +if config.exists(table_path): + for table in config.list_nodes(table_path): + # Migrate interface-route into route + migrate_interface_route(config, table_path + [table], ['interface-route'], 'route') + + # Migrate interface-route6 into route6 + migrate_interface_route(config, table_path + [table], ['interface-route6'], 'route6') + + # Cleanup nodes inside route + migrate_route(config, table_path + [table], ['route'], 'route') + + # Cleanup nodes inside route6 + migrate_route(config, table_path + [table], ['route6'], 'route6') + +try: + with open(file_name, 'w') as f: + f.write(config.to_string()) +except OSError as e: + print("Failed to save the modified config: {}".format(e)) + exit(1) -- cgit v1.2.3 From 96d51fa69fbe072fe5c9e8efd4fa6a89d8a2771a Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Fri, 5 Feb 2021 21:01:31 +0100 Subject: xml: add new common "interface-name" validator --- .../include/bgp-update-source.xml.i | 2 +- .../include/static-route-interface.xml.i | 17 ++++++++++++++ .../include/static-route-next-hop-interface.xml.i | 17 -------------- .../include/static-route-next-hop-vrf.xml.i | 19 --------------- .../include/static-route-vrf.xml.i | 19 +++++++++++++++ interface-definitions/include/static-route.xml.i | 8 +++---- interface-definitions/include/static-route6.xml.i | 8 +++---- interface-definitions/protocols-bgp.xml.in | 2 +- interface-definitions/protocols-ospf.xml.in | 5 ++-- interface-definitions/protocols-ospfv3.xml.in | 2 +- src/validators/fqdn | 2 -- src/validators/interface-name | 27 ++++++++++++++++++++++ 12 files changed, 77 insertions(+), 51 deletions(-) create mode 100644 interface-definitions/include/static-route-interface.xml.i delete mode 100644 interface-definitions/include/static-route-next-hop-interface.xml.i delete mode 100644 interface-definitions/include/static-route-next-hop-vrf.xml.i create mode 100644 interface-definitions/include/static-route-vrf.xml.i create mode 100755 src/validators/interface-name (limited to 'src') diff --git a/interface-definitions/include/bgp-update-source.xml.i b/interface-definitions/include/bgp-update-source.xml.i index c1db2e2c1..a8b212720 100644 --- a/interface-definitions/include/bgp-update-source.xml.i +++ b/interface-definitions/include/bgp-update-source.xml.i @@ -21,7 +21,7 @@ - ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ + diff --git a/interface-definitions/include/static-route-interface.xml.i b/interface-definitions/include/static-route-interface.xml.i new file mode 100644 index 000000000..0f10837df --- /dev/null +++ b/interface-definitions/include/static-route-interface.xml.i @@ -0,0 +1,17 @@ + + + + Gateway interface name + + + + + txt + Gateway interface name + + + + + + + diff --git a/interface-definitions/include/static-route-next-hop-interface.xml.i b/interface-definitions/include/static-route-next-hop-interface.xml.i deleted file mode 100644 index 01c253597..000000000 --- a/interface-definitions/include/static-route-next-hop-interface.xml.i +++ /dev/null @@ -1,17 +0,0 @@ - - - - Gateway interface name - - - - - txt - Gateway interface name - - - ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ - - - - diff --git a/interface-definitions/include/static-route-next-hop-vrf.xml.i b/interface-definitions/include/static-route-next-hop-vrf.xml.i deleted file mode 100644 index ae2515a12..000000000 --- a/interface-definitions/include/static-route-next-hop-vrf.xml.i +++ /dev/null @@ -1,19 +0,0 @@ - - - - VRF to leak route - - default - vrf name - - - txt - Name of VRF to leak to - - - ^(default)$ - - - - - diff --git a/interface-definitions/include/static-route-vrf.xml.i b/interface-definitions/include/static-route-vrf.xml.i new file mode 100644 index 000000000..70f8b0be8 --- /dev/null +++ b/interface-definitions/include/static-route-vrf.xml.i @@ -0,0 +1,19 @@ + + + + VRF to leak route + + default + vrf name + + + txt + Name of VRF to leak to + + + ^(default)$ + + + + + diff --git a/interface-definitions/include/static-route.xml.i b/interface-definitions/include/static-route.xml.i index 1f79aaca8..6225025ca 100644 --- a/interface-definitions/include/static-route.xml.i +++ b/interface-definitions/include/static-route.xml.i @@ -42,13 +42,13 @@ Gateway interface name - ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ + #include #include - #include + #include @@ -65,8 +65,8 @@ #include #include - #include - #include + #include + #include diff --git a/interface-definitions/include/static-route6.xml.i b/interface-definitions/include/static-route6.xml.i index 1ff6bbead..25d4d22a2 100644 --- a/interface-definitions/include/static-route6.xml.i +++ b/interface-definitions/include/static-route6.xml.i @@ -42,13 +42,13 @@ Gateway interface name - ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ + #include #include - #include + #include @@ -65,8 +65,8 @@ #include #include - #include - #include + #include + #include diff --git a/interface-definitions/protocols-bgp.xml.in b/interface-definitions/protocols-bgp.xml.in index 3edacb0ca..e5122fe8d 100644 --- a/interface-definitions/protocols-bgp.xml.in +++ b/interface-definitions/protocols-bgp.xml.in @@ -307,7 +307,7 @@ - ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ + diff --git a/interface-definitions/protocols-ospf.xml.in b/interface-definitions/protocols-ospf.xml.in index 7a5cef6ef..ca848c289 100644 --- a/interface-definitions/protocols-ospf.xml.in +++ b/interface-definitions/protocols-ospf.xml.in @@ -697,7 +697,8 @@ Default to suppress routing updates on all interfaces - ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo|default$ + ^(default)$ + @@ -713,7 +714,7 @@ Interface to be passive (i.e. suppress routing updates) - ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ + diff --git a/interface-definitions/protocols-ospfv3.xml.in b/interface-definitions/protocols-ospfv3.xml.in index 7f80f9f9d..bd6a55b45 100644 --- a/interface-definitions/protocols-ospfv3.xml.in +++ b/interface-definitions/protocols-ospfv3.xml.in @@ -52,7 +52,7 @@ Interface used for routing information exchange - ^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$ + diff --git a/src/validators/fqdn b/src/validators/fqdn index 347ffda42..66276c093 100755 --- a/src/validators/fqdn +++ b/src/validators/fqdn @@ -17,11 +17,9 @@ import re import sys - # pattern copied from: https://www.regextester.com/103452 pattern = "(?=^.{4,253}$)(^((?!-)[a-zA-Z0-9-]{0,62}[a-zA-Z0-9]\.)+[a-zA-Z]{2,63}$)" - if __name__ == '__main__': if len(sys.argv) != 2: sys.exit(1) diff --git a/src/validators/interface-name b/src/validators/interface-name new file mode 100755 index 000000000..32cd42fbd --- /dev/null +++ b/src/validators/interface-name @@ -0,0 +1,27 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2021 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program 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. If not, see . + +import re +import sys + +pattern = '^(br|bond|dum|en|eth|gnv|peth|pppoe|tun|vti|vtun|vxlan|wg|wlan)[0-9]+|lo$' + +if __name__ == '__main__': + if len(sys.argv) != 2: + sys.exit(1) + if not re.match(pattern, sys.argv[1]): + sys.exit(1) + sys.exit(0) -- cgit v1.2.3