pim: T1729: Basic PIM implementation

4 files changed, 450 insertions, 0 deletions

diff --git a/interface-definitions/protocols-igmp.xml.in b/interface-definitions/protocols-igmp.xml.in
new file mode 100644
index 000000000..a6a2f1420
--- /dev/null
+++ b/interface-definitions/protocols-igmp.xml.in
@@ -0,0 +1,61 @@
+<?xml version="1.0"?>
+<!-- Internet Group Management Protocol (IGMP) configuration -->
+<interfaceDefinition>
+  <node name="protocols">
+    <children>
+      <node name="igmp" owner="${vyos_conf_scripts_dir}/protocols_igmp.py">
+        <properties>
+          <help>Internet Group Management Protocol (IGMP)</help>
+        </properties>
+        <children>
+          <tagNode name="interface">
+            <properties>
+              <help>IGMP interface</help>
+              <completionHelp>
+                <script>${vyos_completion_dir}/list_interfaces.py</script>
+              </completionHelp>
+            </properties>
+            <children>
+              <leafNode name="version">
+                <properties>
+                  <help>IGMP version</help>
+                  <valueHelp>
+                    <format>2-3</format>
+                    <description>IGMP version</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 2-3"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="query-interval">
+                <properties>
+                  <help>IGMP host query interval</help>
+                  <valueHelp>
+                    <format>1-1800</format>
+                    <description>Query interval in seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-1800"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="query-max-response-time">
+                <properties>
+                  <help>IGMP max query response time</help>
+                  <valueHelp>
+                    <format>10-250</format>
+                    <description>Query response value in deci-seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 10-250"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/interface-definitions/protocols-pim.xml.in b/interface-definitions/protocols-pim.xml.in
new file mode 100644
index 000000000..944224f7b
--- /dev/null
+++ b/interface-definitions/protocols-pim.xml.in
@@ -0,0 +1,84 @@
+<?xml version="1.0"?>
+<!-- Protocol Independent Multicast (PIM) configuration -->
+<interfaceDefinition>
+  <node name="protocols">
+    <children>
+      <node name="pim" owner="${vyos_conf_scripts_dir}/protocols_pim.py">
+        <properties>
+          <help>Protocol Independent Multicast (PIM)</help>
+          <priority>400</priority>
+        </properties>
+        <children>
+          <tagNode name="interface">
+            <properties>
+              <help>PIM interface</help>
+              <completionHelp>
+                <script>${vyos_completion_dir}/list_interfaces.py</script>
+              </completionHelp>
+            </properties>
+            <children>
+              <leafNode name="hello">
+                <properties>
+                  <help>Hello Interval</help>
+                  <valueHelp>
+                    <format>1-180</format>
+                    <description>Hello Interval in seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-180"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+          <node name="rp">
+            <properties>
+              <help>Rendezvous Point</help>
+            </properties>
+            <children>
+              <tagNode name="address">
+                <properties>
+                  <help>Rendezvous Point address</help>
+                  <valueHelp>
+                    <format>ipv4</format>
+                    <description>Rendezvous Point address</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="ipv4-address"/>
+                  </constraint>
+                </properties>
+                <children>
+                  <leafNode name="group">
+                    <properties>
+                      <help>Group Address range</help>
+                      <valueHelp>
+                        <format>ipv4net</format>
+                        <description>Group Address range RFC 3171</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ip-prefix"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                </children>
+              </tagNode>
+              <leafNode name="keep-alive-timer">
+                <properties>
+                  <help>Keep alive Timer</help>
+                  <valueHelp>
+                    <format>31-60000</format>
+                    <description>Keep alive Timer in seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 31-60000"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </node>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/src/conf_mode/protocols_igmp.py b/src/conf_mode/protocols_igmp.py
new file mode 100755
index 000000000..8d25fe9d5
--- /dev/null
+++ b/src/conf_mode/protocols_igmp.py
@@ -0,0 +1,130 @@
+#!/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 sys
+import jinja2
+import copy
+import os
+import vyos.validate
+
+from vyos import ConfigError
+from vyos.config import Config
+
+config_file = r'/tmp/igmp.frr'
+
+# Please be careful if you edit the template.
+config_tmpl = """
+!
+{% for iface in old_ifaces -%}
+interface {{ iface }}
+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 -%}
+!
+{% 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))
+            }
+        })
+
+    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))
+            }
+        })
+
+    return igmp_conf
+
+def verify(igmp):
+    if igmp is None:
+        return None
+
+    if igmp['igmp_conf']:
+        # Check interfaces
+        if not igmp['ifaces']:
+            raise ConfigError(f"IGMP require defined interfaces!")
+
+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)
+        sys.exit(1)
diff --git a/src/conf_mode/protocols_pim.py b/src/conf_mode/protocols_pim.py
new file mode 100755
index 000000000..dc65a59a6
--- /dev/null
+++ b/src/conf_mode/protocols_pim.py
@@ -0,0 +1,175 @@
+#!/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 sys
+import jinja2
+import copy
+import os
+import vyos.validate
+from ipaddress import IPv4Address
+
+from vyos import ConfigError
+from vyos.config import Config
+
+config_file = r'/tmp/pimd.frr'
+
+# Please be careful if you edit the template.
+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 }}
+{% if pim.ifaces[iface].hello -%}
+ip pim hello {{ pim.ifaces[iface].hello }}
+{% endif -%}
+ip pim
+!
+{% 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))
+            }
+        })
+
+    for iface in conf.list_nodes('interface'):
+        pim_conf['pim']['ifaces'].update({
+            iface : {
+                'hello' : conf.return_value('interface {0} hello'.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(f"PIM require defined interfaces!")
+
+        if not pim['pim']['rp']:
+            raise ConfigError(f"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(f"Group should be specified for RP " + rp_addr)
+            for group in pim['pim']['rp'][rp_addr]:
+                if (group in uniq_groups):
+                    raise ConfigError(f"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)
+        sys.exit(1)