summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--interface-definitions/dhcpv6-relay.xml92
-rwxr-xr-xsrc/conf_mode/dhcpv6_relay.py121
2 files changed, 213 insertions, 0 deletions
diff --git a/interface-definitions/dhcpv6-relay.xml b/interface-definitions/dhcpv6-relay.xml
new file mode 100644
index 000000000..d6e6daf51
--- /dev/null
+++ b/interface-definitions/dhcpv6-relay.xml
@@ -0,0 +1,92 @@
+<?xml version="1.0"?>
+<!-- DHCPv6 relay configuration -->
+<interfaceDefinition>
+ <node name="service">
+ <children>
+ <node name="dhcpv6-relay" owner="${vyos_conf_scripts_dir}/dhcpv6_relay.py">
+ <properties>
+ <help>DHCPv6 Relay Agent parameters</help>
+ <priority>900</priority>
+ </properties>
+ <children>
+ <tagNode name="listen-interface">
+ <properties>
+ <help>Interface for DHCPv6 Relay Agent to listen for requests</help>
+ <completionHelp>
+ <script>${vyos_completion_dir}/list_interfaces.py</script>
+ </completionHelp>
+ </properties>
+ <children>
+ <leafNode name="address">
+ <properties>
+ <help>IPv6 address on listen-interface listen for requests on</help>
+ <valueHelp>
+ <format>ipv6</format>
+ <description>IPv6 address on listen interface</description>
+ </valueHelp>
+ <constraint>
+ <validator name="ipv6-address"/>
+ </constraint>
+ </properties>
+ </leafNode>
+ </children>
+ </tagNode>
+ <leafNode name="listen-port">
+ <properties>
+ <help>UDP port to listen for requests on</help>
+ <valueHelp>
+ <format>1-65535</format>
+ <description>Port to listen on</description>
+ </valueHelp>
+ <constraint>
+ <validator name="numeric" argument="--range 1-65535"/>
+ </constraint>
+ <constraintErrorMessage>port must be a value between 1 and 65535</constraintErrorMessage>
+ </properties>
+ </leafNode>
+ <leafNode name="max-hop-count">
+ <properties>
+ <help>Maximum hop count for which requests will be processed</help>
+ <valueHelp>
+ <format>1-255</format>
+ <description>Hop count (default: 10)</description>
+ </valueHelp>
+ <constraint>
+ <validator name="numeric" argument="--range 1-255"/>
+ </constraint>
+ <constraintErrorMessage>max-hop-count must be a value between 1 and 255</constraintErrorMessage>
+ </properties>
+ </leafNode>
+ <tagNode name="upstream-interface">
+ <properties>
+ <help>Interface for DHCPv6 Relay Agent forward requests out</help>
+ <completionHelp>
+ <script>${vyos_completion_dir}/list_interfaces.py</script>
+ </completionHelp>
+ </properties>
+ <children>
+ <leafNode name="address">
+ <properties>
+ <help>IPv6 address to forward requests to</help>
+ <valueHelp>
+ <format>ipv6</format>
+ <description>IPv6 address of the DHCP server</description>
+ </valueHelp>
+ <constraint>
+ <validator name="ipv6-address"/>
+ </constraint>
+ </properties>
+ </leafNode>
+ </children>
+ </tagNode>
+ <leafNode name="use-interface-id-option">
+ <properties>
+ <help>Option to set DHCPv6 interface-ID option</help>
+ <valueless/>
+ </properties>
+ </leafNode>
+ </children>
+ </node>
+ </children>
+ </node>
+</interfaceDefinition>
diff --git a/src/conf_mode/dhcpv6_relay.py b/src/conf_mode/dhcpv6_relay.py
new file mode 100755
index 000000000..982320d18
--- /dev/null
+++ b/src/conf_mode/dhcpv6_relay.py
@@ -0,0 +1,121 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2018 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 jinja2
+
+from vyos.config import Config
+from vyos import ConfigError
+
+config_file = r'/etc/default/isc-dhcpv6-relay'
+
+# Please be careful if you edit the template.
+config_tmpl = """
+### Autogenerated by dhcpv6_relay.py ###
+
+# Defaults for isc-dhcpv6-relay initscript sourced by /etc/init.d/isc-dhcpv6-relay
+
+OPTIONS="-6 -l {{ listen_addr | join('-l ') }} -p {{ port }} {{ options | join(' ') }} -u {{ upstream_addr | join('-u ') }}"
+"""
+
+default_config_data = {
+ 'listen_addr': [],
+ 'upstream_addr': [],
+ 'port': '547',
+ 'options': [],
+}
+
+def get_config():
+ relay = default_config_data
+ conf = Config()
+ if not conf.exists('service dhcpv6-relay'):
+ return None
+ else:
+ conf.set_level('service dhcpv6-relay')
+
+ # Network interfaces/address to listen on for DHCPv6 query(s)
+ if conf.exists('listen-interface'):
+ interfaces = conf.list_nodes('listen-interface')
+ for intf in interfaces:
+ addr = conf.return_value('listen-interface {0} address'.format(intf))
+ listen = addr + '%' + intf
+ relay['listen_addr'].append(listen)
+
+ # Upstream interface/address for remote DHCPv6 server
+ if conf.exists('upstream-interface'):
+ interfaces = conf.list_nodes('upstream-interface')
+ for intf in interfaces:
+ addr = conf.return_value('upstream-interface {0} address'.format(intf))
+ server = addr + '%' + intf
+ relay['upstream_addr'].append(server)
+
+ # Listen and transmit on port <xy>. This is mostly useful for debugging
+ # purposes. Default is port 67 for DHCPv4/BOOTP, or port 547 for DHCPv6.
+ if conf.exists('listen-port'):
+ relay['port'] = conf.return_value('listen-port')
+
+ # Maximum hop count. When forwarding packets, dhcrelay discards packets
+ # which have reached a hop count of COUNT. Default is 10. Maximum is 255.
+ if conf.exists('max-hop-count'):
+ count = '-c ' + conf.return_value('max-hop-count')
+ relay['options'].append(count)
+
+ if conf.exists('use-interface-id-option'):
+ relay['options'].append('-I')
+
+ return relay
+
+def verify(relay):
+ # bail out early - looks like removal from running config
+ if relay is None:
+ return None
+
+ return None
+
+def generate(relay):
+ # bail out early - looks like removal from running config
+ if relay is None:
+ return None
+
+ tmpl = jinja2.Template(config_tmpl)
+ config_text = tmpl.render(relay)
+ with open(config_file, 'w') as f:
+ f.write(config_text)
+
+ return None
+
+def apply(relay):
+ if relay is not None:
+ os.system('sudo systemctl restart isc-dhcpv6-relay.service')
+ else:
+ # DHCPv6 relay support is removed in the commit
+ os.system('sudo systemctl stop isc-dhcpv6-relay.service')
+ os.unlink(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)