pim: T1729: Add PIM and IGMPv2/v3 support

3 files changed, 477 insertions, 0 deletions

diff --git a/src/conf_mode/protocols_igmp.py b/src/conf_mode/protocols_igmp.py
new file mode 100755
index 000000000..983ca4c3a
--- /dev/null
+++ b/src/conf_mode/protocols_igmp.py
@@ -0,0 +1,158 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2020 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 <http://www.gnu.org/licenses/>.
+
+import jinja2
+import copy
+import os
+import vyos.validate
+from ipaddress import IPv4Address
+from sys import exit
+
+from vyos import ConfigError
+from vyos.config import Config
+
+config_file = r'/tmp/igmp.frr'
+
+config_tmpl = """
+!
+{% for iface in old_ifaces -%}
+interface {{ iface }}
+{% for group in old_ifaces[iface].gr_join -%}
+{% if old_ifaces[iface].gr_join[group] -%}
+{% for source in old_ifaces[iface].gr_join[group] -%}
+no ip igmp join {{ group }} {{ source }}
+{% endfor -%}
+{% else -%}
+no ip igmp join {{ group }}
+{% endif -%}
+{% endfor -%}
+no ip igmp
+!
+{% endfor -%}
+{% for iface in ifaces -%}
+interface {{ iface }}
+{% if ifaces[iface].version -%}
+ip igmp version {{ ifaces[iface].version }}
+{% else -%}
+{# IGMP default version 3 #}
+ip igmp
+{% endif -%}
+{% if ifaces[iface].query_interval -%}
+ip igmp query-interval {{ ifaces[iface].query_interval }}
+{% endif -%}
+{% if ifaces[iface].query_max_resp_time -%}
+ip igmp query-max-response-time {{ ifaces[iface].query_max_resp_time }}
+{% endif -%}
+{% for group in ifaces[iface].gr_join -%}
+{% if ifaces[iface].gr_join[group] -%}
+{% for source in ifaces[iface].gr_join[group] -%}
+ip igmp join {{ group }} {{ source }}
+{% endfor -%}
+{% else -%}
+ip igmp join {{ group }}
+{% endif -%}
+{% endfor -%}
+!
+{% endfor -%}
+!
+"""
+
+def get_config():
+    conf = Config()
+    igmp_conf = {
+        'igmp_conf'  : False,
+        'old_ifaces' : {},
+        'ifaces'     : {}
+    }
+    if not (conf.exists('protocols igmp') or conf.exists_effective('protocols igmp')):
+        return None
+
+    if conf.exists('protocols igmp'):
+        igmp_conf['igmp_conf'] = True
+
+    conf.set_level('protocols igmp')
+
+    # # Get interfaces
+    for iface in conf.list_effective_nodes('interface'):
+        igmp_conf['old_ifaces'].update({
+            iface : {
+                'version' : conf.return_effective_value('interface {0} version'.format(iface)),
+                'query_interval' : conf.return_effective_value('interface {0} query-interval'.format(iface)),
+                'query_max_resp_time' : conf.return_effective_value('interface {0} query-max-response-time'.format(iface)),
+                'gr_join' : {}
+            }
+        })
+        for gr_join in conf.list_effective_nodes('interface {0} join'.format(iface)):
+            igmp_conf['old_ifaces'][iface]['gr_join'][gr_join] = conf.return_effective_values('interface {0} join {1} source'.format(iface, gr_join))
+
+    for iface in conf.list_nodes('interface'):
+        igmp_conf['ifaces'].update({
+            iface : {
+                'version' : conf.return_value('interface {0} version'.format(iface)),
+                'query_interval' : conf.return_value('interface {0} query-interval'.format(iface)),
+                'query_max_resp_time' : conf.return_value('interface {0} query-max-response-time'.format(iface)),
+                'gr_join' : {}
+            }
+        })
+        for gr_join in conf.list_nodes('interface {0} join'.format(iface)):
+            igmp_conf['ifaces'][iface]['gr_join'][gr_join] = conf.return_values('interface {0} join {1} source'.format(iface, gr_join))
+
+    return igmp_conf
+
+def verify(igmp):
+    if igmp is None:
+        return None
+
+    if igmp['igmp_conf']:
+        # Check interfaces
+        if not igmp['ifaces']:
+            raise ConfigError("IGMP require defined interfaces!")
+        # Check, is this multicast group
+        for intfc in igmp['ifaces']:
+            for gr_addr in igmp['ifaces'][intfc]['gr_join']:
+                if IPv4Address(gr_addr) < IPv4Address('224.0.0.0'):
+                    raise ConfigError(gr_addr + " not a multicast group")
+
+def generate(igmp):
+    if igmp is None:
+        return None
+
+    tmpl = jinja2.Template(config_tmpl)
+    config_text = tmpl.render(igmp)
+    with open(config_file, 'w') as f:
+        f.write(config_text)
+
+    return None
+
+def apply(igmp):
+    if igmp is None:
+        return None
+
+    if os.path.exists(config_file):
+        os.system("sudo vtysh -d pimd -f " + config_file)
+        os.remove(config_file)
+
+    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/conf_mode/protocols_pim.py b/src/conf_mode/protocols_pim.py
new file mode 100755
index 000000000..ee5cc035f
--- /dev/null
+++ b/src/conf_mode/protocols_pim.py
@@ -0,0 +1,178 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2020 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 <http://www.gnu.org/licenses/>.
+
+import jinja2
+import copy
+import os
+import vyos.validate
+from ipaddress import IPv4Address
+from sys import exit
+
+from vyos import ConfigError
+from vyos.config import Config
+
+config_file = r'/tmp/pimd.frr'
+
+config_tmpl = """
+!
+{% for rp_addr in old_pim.rp -%}
+{% for group in old_pim.rp[rp_addr] -%}
+no ip pim rp {{ rp_addr }} {{ group }}
+{% endfor -%}
+{% endfor -%}
+{% if old_pim.rp_keep_alive -%}
+no ip pim rp keep-alive-timer {{ old_pim.rp_keep_alive }}
+{% endif -%}
+{% for iface in old_pim.ifaces -%}
+interface {{ iface }}
+no ip pim
+!
+{% endfor -%}
+{% for iface in pim.ifaces -%}
+interface {{ iface }}
+ip pim
+{% if pim.ifaces[iface].dr_prio -%}
+ip pim drpriority {{ pim.ifaces[iface].dr_prio }}
+{% endif -%}
+{% if pim.ifaces[iface].hello -%}
+ip pim hello {{ pim.ifaces[iface].hello }}
+{% endif -%}
+!
+{% endfor -%}
+{% for rp_addr in pim.rp -%}
+{% for group in pim.rp[rp_addr] -%}
+ip pim rp {{ rp_addr }} {{ group }}
+{% endfor -%}
+{% endfor -%}
+{% if pim.rp_keep_alive -%}
+ip pim rp keep-alive-timer {{ pim.rp_keep_alive }}
+{% endif -%}
+!
+"""
+
+def get_config():
+    conf = Config()
+    pim_conf = {
+        'pim_conf' : False,
+        'old_pim'  : {
+            'ifaces' : {},
+            'rp'     : {}
+        },
+        'pim' : {
+            'ifaces' : {},
+            'rp'     : {}
+        }
+    }
+    if not (conf.exists('protocols pim') or conf.exists_effective('protocols pim')):
+        return None
+
+    if conf.exists('protocols pim'):
+        pim_conf['pim_conf'] = True
+
+    conf.set_level('protocols pim')
+
+    # Get interfaces
+    for iface in conf.list_effective_nodes('interface'):
+        pim_conf['old_pim']['ifaces'].update({
+            iface : {
+                'hello' : conf.return_effective_value('interface {0} hello'.format(iface)),
+                'dr_prio' : conf.return_effective_value('interface {0} dr-priority'.format(iface))
+            }
+        })
+
+    for iface in conf.list_nodes('interface'):
+        pim_conf['pim']['ifaces'].update({
+            iface : {
+                'hello' : conf.return_value('interface {0} hello'.format(iface)),
+                'dr_prio' : conf.return_value('interface {0} dr-priority'.format(iface)),
+            }
+        })
+
+    conf.set_level('protocols pim rp')
+
+    # Get RPs addresses
+    for rp_addr in conf.list_effective_nodes('address'):
+        pim_conf['old_pim']['rp'][rp_addr] = conf.return_effective_values('address {0} group'.format(rp_addr))
+
+    for rp_addr in conf.list_nodes('address'):
+        pim_conf['pim']['rp'][rp_addr] = conf.return_values('address {0} group'.format(rp_addr))
+
+    # Get RP keep-alive-timer
+    if conf.exists_effective('rp keep-alive-timer'):
+        pim_conf['old_pim']['rp_keep_alive'] = conf.return_effective_value('rp keep-alive-timer')
+    if conf.exists('rp keep-alive-timer'):
+        pim_conf['pim']['rp_keep_alive'] = conf.return_value('rp keep-alive-timer')
+
+    return pim_conf
+
+def verify(pim):
+    if pim is None:
+        return None
+
+    if pim['pim_conf']:
+        # Check interfaces
+        if not pim['pim']['ifaces']:
+            raise ConfigError("PIM require defined interfaces!")
+
+        if not pim['pim']['rp']:
+            raise ConfigError("RP address required")
+
+        # Check unique multicast groups
+        uniq_groups = []
+        for rp_addr in pim['pim']['rp']:
+            if not pim['pim']['rp'][rp_addr]:
+                raise ConfigError("Group should be specified for RP " + rp_addr)
+            for group in pim['pim']['rp'][rp_addr]:
+                if (group in uniq_groups):
+                    raise ConfigError("Group range " + group + " specified cannot exact match another")
+
+                # Check, is this multicast group
+                gr_addr = group.split('/')
+                if IPv4Address(gr_addr[0]) < IPv4Address('224.0.0.0'):
+                    raise ConfigError(group + " not a multicast group")
+
+            uniq_groups.extend(pim['pim']['rp'][rp_addr])
+
+def generate(pim):
+    if pim is None:
+        return None
+
+    tmpl = jinja2.Template(config_tmpl)
+    config_text = tmpl.render(pim)
+    with open(config_file, 'w') as f:
+        f.write(config_text)
+
+    return None
+
+def apply(pim):
+    if pim is None:
+        return None
+
+    if os.path.exists(config_file):
+        os.system("sudo vtysh -d pimd -f " + config_file)
+        os.remove(config_file)
+
+    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/conf_mode/protocols_static_multicast.py b/src/conf_mode/protocols_static_multicast.py
new file mode 100755
index 000000000..b2522d74d
--- /dev/null
+++ b/src/conf_mode/protocols_static_multicast.py
@@ -0,0 +1,141 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2020 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 <http://www.gnu.org/licenses/>.
+
+import jinja2
+import copy
+import os
+import vyos.validate
+from ipaddress import IPv4Address
+from sys import exit
+
+from vyos import ConfigError
+from vyos.config import Config
+
+config_file = r'/tmp/static_mcast.frr'
+
+config_tmpl = """
+!
+{% for route_gr in old_mroute -%}
+{% for nh in old_mroute[route_gr] -%}
+{% if old_mroute[route_gr][nh] -%}
+no ip mroute {{ route_gr }} {{ nh }} {{ old_mroute[route_gr][nh] }}
+{% else -%}
+no ip mroute {{ route_gr }} {{ nh }}
+{% endif -%}
+{% endfor -%}
+{% endfor -%}
+{% for route_gr in mroute -%}
+{% for nh in mroute[route_gr] -%}
+{% if mroute[route_gr][nh] -%}
+ip mroute {{ route_gr }} {{ nh }} {{ mroute[route_gr][nh] }}
+{% else -%}
+ip mroute {{ route_gr }} {{ nh }}
+{% endif -%}
+{% endfor -%}
+{% endfor -%}
+!
+"""
+
+# Get configuration for static multicast route
+def get_config():
+    conf = Config()
+    mroute = {
+        'old_mroute' : {},
+        'mroute' : {}
+    }
+
+    base_path = "protocols static multicast"
+
+    if not (conf.exists(base_path) or conf.exists_effective(base_path)):
+        return None
+
+    conf.set_level(base_path)
+
+    # Get multicast effective routes
+    for route in conf.list_effective_nodes('route'):
+        mroute['old_mroute'][route] = {}
+        for next_hop in conf.list_effective_nodes('route {0} next-hop'.format(route)):
+            mroute['old_mroute'][route].update({
+                next_hop : conf.return_value('route {0} next-hop {1} distance'.format(route, next_hop))
+            })
+
+    # Get multicast effective interface-routes
+    for route in conf.list_effective_nodes('interface-route'):
+        if not route in  mroute['old_mroute']:
+            mroute['old_mroute'][route] = {}
+        for next_hop in conf.list_effective_nodes('interface-route {0} next-hop-interface'.format(route)):
+            mroute['old_mroute'][route].update({
+                next_hop : conf.return_value('interface-route {0} next-hop-interface {1} distance'.format(route, next_hop))
+            })
+
+    # Get multicast routes
+    for route in conf.list_nodes('route'):
+        mroute['mroute'][route] = {}
+        for next_hop in conf.list_nodes('route {0} next-hop'.format(route)):
+            mroute['mroute'][route].update({
+                next_hop : conf.return_value('route {0} next-hop {1} distance'.format(route, next_hop))
+            })
+
+    # Get multicast interface-routes
+    for route in conf.list_nodes('interface-route'):
+        if not route in  mroute['mroute']:
+            mroute['mroute'][route] = {}
+        for next_hop in conf.list_nodes('interface-route {0} next-hop-interface'.format(route)):
+            mroute['mroute'][route].update({
+                next_hop : conf.return_value('interface-route {0} next-hop-interface {1} distance'.format(route, next_hop))
+            })
+
+    return mroute
+
+def verify(mroute):
+    if mroute is None:
+        return None
+
+    for route in mroute['mroute']:
+        route_lst = route.split('/')
+        if IPv4Address(route_lst[0]) < IPv4Address('224.0.0.0'):
+            raise ConfigError(route + " not a multicast network")
+
+def generate(mroute):
+    if mroute is None:
+        return None
+
+    tmpl = jinja2.Template(config_tmpl)
+    config_text = tmpl.render(mroute)
+    with open(config_file, 'w') as f:
+        f.write(config_text)
+
+    return None
+
+def apply(mroute):
+    if mroute is None:
+        return None
+
+    if os.path.exists(config_file):
+        os.system("sudo vtysh -d staticd -f " + config_file)
+        os.remove(config_file)
+
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)