bcast-relay: Initial configuration nodes for 'service bcast-relay'

2 files changed, 188 insertions, 0 deletions

diff --git a/interface-definitions/bcast-relay.xml b/interface-definitions/bcast-relay.xml
new file mode 100644
index 000000000..0e2f26425
--- /dev/null
+++ b/interface-definitions/bcast-relay.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0"?>
+
+<!-- UDP broadcast relay configuration -->
+
+<interfaceDefinition>
+  <node name="service">
+    <children>
+      <node name="bcast-relay">
+        <properties>
+          <help>UDP Broadcast Relay parameters</help>
+        </properties>
+        <children>
+          <tagNode name="id" owner="${vyos_sbindir}/vyos-config-bcast-relay.py">
+            <properties>
+              <help>Unique ID for each UDP port to forward</help>
+              <valueHelp>
+                <format>u32:1-99</format>
+                <description>Numerical ID #</description>
+              </valueHelp>
+              <type>u32</type>
+              <priority>990</priority>
+            </properties>
+            <children>
+              <leafNode name="address">
+                <properties>
+                  <help>Set source IP of forwarded packets, otherwise original senders address is used</help>
+                  <valueHelp>
+                    <format>ipv4</format>
+                    <description>Optional source address for forwarded packets</description>
+                  </valueHelp>
+                  <type>ipv4</type>
+                </properties>
+              </leafNode>
+              <leafNode name="description">
+                <properties>
+                  <help>Description</help>
+                </properties>
+              </leafNode>
+              <leafNode name="interface">
+                <properties>
+                  <help>Interface to repeat UDP broadcasts to [REQUIRED]</help>
+                  <completionHelp>
+                    <script>${vyatta_sbindir}/vyatta-interfaces.pl --show all</script>
+                  </completionHelp>
+                  <multi/>
+                </properties>
+              </leafNode>
+              <leafNode name="port">
+                <properties>
+                  <help>Destination or source port to listen and retransmit on [REQUIRED]</help>
+                  <valueHelp>
+                    <format>u32:1-65535</format>
+                    <description>UDP port to listen on</description>
+                  </valueHelp>
+                  <type>u32</type>
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/src/conf-mode/vyos-config-bcast-relay.py b/src/conf-mode/vyos-config-bcast-relay.py
new file mode 100755
index 000000000..682cb220e
--- /dev/null
+++ b/src/conf-mode/vyos-config-bcast-relay.py
@@ -0,0 +1,124 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2017 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 os
+import fnmatch
+import time
+import subprocess
+
+from vyos.config import Config
+from vyos.util import ConfigError
+
+config_file = r'/etc/default/udp-broadcast-relay'
+
+def get_config():
+    conf = Config()
+    conf.set_level("service bcast-relay id")
+    relay_id = conf.list_nodes("")
+    relays = []
+
+    for id in relay_id:
+        interface_list = []
+        address = conf.return_value("{0} address".format(id))
+        description = conf.return_value("{0} description".format(id))
+        port = conf.return_value("{0} port".format(id))
+
+        # split the interface name listing and form a list
+        if conf.exists("{0} interface".format(id)):
+            intfs_names = conf.return_values("{0} interface".format(id))
+            intfs_names=intfs_names.replace("'", "")
+            intfs_names=intfs_names.split()
+            for name in intfs_names:
+                interface_list.append(name)
+
+        relay = {
+            "id": id,
+            "address": address,
+            "description": description,
+            "interfaces" : interface_list,
+            "port": port
+            }
+        relays.append(relay)
+
+    return relays
+
+def verify(relays):
+    for relay in relays:
+        if not relay["port"]:
+            raise ConfigError("UDP bcast relay 'id {0}' requires a port number".format(relay["id"]))
+
+        if len(relay["interfaces"]) < 2:
+            raise ConfigError("UDP bcast relay 'id {0}' requires at least 2 interfaces".format(relay["id"]))
+
+    return None
+
+def generate(relays):
+    config_header = '### Autogenerated by {0} on {tm} ###\n'.format(os.path.basename(__file__),
+                     tm=time.strftime("%a, %d %b %Y %H:%M:%S", time.localtime()))
+
+    config_dir = os.path.dirname(config_file)
+    config_filename = os.path.basename(config_file)
+    active_configs = []
+
+    for config in fnmatch.filter(os.listdir(config_dir), config_filename + '*'):
+        # determine prefix length to identify service instance
+        prefix_len = len(config_filename)
+        active_configs.append(config[prefix_len:])
+
+    # sort our list
+    active_configs.sort()
+
+    for id in active_configs[:]:
+        os.unlink(config_file + id)
+
+    for relay in relays:
+         file = config_file + str(relay["id"])
+         interfaces = ' '.join(str(intf) for intf in relay["interfaces"])
+         config_args = 'DAEMON_ARGS="{0} {1} {2}"\n'.format(relay["id"], relay["port"], interfaces)
+
+         f = open(file, 'w')
+         f.write(config_header)
+         if relay["description"]:
+             f.write('# ' + relay["description"] + '\n')
+         f.write(config_args)
+         f.close()
+
+    return None
+
+def apply(relays):
+    # first stop all running services
+    cmd = "sudo systemctl stop udp-broadcast-relay@{1..99}"
+    os.system(cmd)
+
+    # start only required service instances
+    for relay in relays:
+        cmd = "sudo systemctl start udp-broadcast-relay@{0}".format(relay["id"])
+        os.system(cmd)
+
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        sys.exit(1)