T778: dhcpv6-server: XML and Python rewrite

2 files changed, 690 insertions, 0 deletions

diff --git a/interface-definitions/dhcpv6-server.xml b/interface-definitions/dhcpv6-server.xml
new file mode 100644
index 000000000..e63eb2242
--- /dev/null
+++ b/interface-definitions/dhcpv6-server.xml
@@ -0,0 +1,316 @@
+<?xml version="1.0"?>
+<!-- DHCPv6 server configuration -->
+<interfaceDefinition>
+  <node name="service">
+    <children>
+      <node name="dhcpv6-server" owner="${vyos_conf_scripts_dir}/dhcpv6_server.py">
+        <properties>
+          <help>DHCP for IPv6 (DHCPv6) server</help>
+          <priority>900</priority>
+        </properties>
+        <children>
+          <leafNode name="disable">
+            <properties>
+              <help>Option to disable DHCPv6 server</help>
+              <valueless/>
+            </properties>
+          </leafNode>
+          <leafNode name="preference">
+            <properties>
+              <help>Preference of this DHCPv6 server compared with others</help>
+              <valueHelp>
+                <format>0-255</format>
+                <description>DHCPv6 server preference (0-255)</description>
+              </valueHelp>
+              <constraint>
+                <validator name="numeric" argument="--range 0-255"/>
+              </constraint>
+              <constraintErrorMessage>Preference must be between 0 and 255</constraintErrorMessage>
+            </properties>
+          </leafNode>
+          <tagNode name="shared-network-name">
+            <properties>
+              <help>DHCPv6 shared network name [REQUIRED]</help>
+              <constraint>
+                <regex>^[-_a-zA-Z0-9.]+$</regex>
+              </constraint>
+              <constraintErrorMessage>Invalid DHCPv6 pool name</constraintErrorMessage>
+            </properties>
+            <children>
+              <leafNode name="disable">
+                <properties>
+                  <help>Option to disable DHCPv6 configuration for shared-network</help>
+                  <valueless/>
+                </properties>
+              </leafNode>
+              <tagNode name="subnet">
+                <properties>
+                  <help>IPv6 DHCP subnet for this shared network [REQUIRED]</help>
+                  <valueHelp>
+                    <format>ipv6net</format>
+                    <description>IPv6 address and prefix length</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="ipv6-prefix"/>
+                  </constraint>
+                </properties>
+                <children>
+                  <node name="address-range">
+                    <properties>
+                      <help>Parameters setting ranges for assigning IPv6 addresses</help>
+                    </properties>
+                    <children>
+                      <tagNode name="prefix">
+                        <properties>
+                          <help>IPv6 prefix defining range of addresses to assign</help>
+                          <valueHelp>
+                            <format>ipv6net</format>
+                            <description>IPv6 address and prefix length</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ipv6-prefix"/>
+                          </constraint>
+                        </properties>
+                        <children>
+                          <leafNode name="temporary">
+                            <properties>
+                              <help>Address range will be used for temporary addresses</help>
+                              <valueless/>
+                            </properties>
+                          </leafNode>
+                        </children>
+                      </tagNode>
+                      <tagNode name="start">
+                        <properties>
+                          <help>First in range of consecutive IPv6 addresses to assign</help>
+                          <valueHelp>
+                            <format>ipv6</format>
+                            <description>IPv6 address</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ipv6-address"/>
+                          </constraint>
+                        </properties>
+                        <children>
+                          <leafNode name="stop">
+                            <properties>
+                              <help>Last in range of consecutive IPv6 addresses</help>
+                              <valueHelp>
+                                <format>ipv6</format>
+                                <description>IPv6 address</description>
+                              </valueHelp>
+                              <constraint>
+                                <validator name="ipv6-address"/>
+                              </constraint>
+                            </properties>
+                          </leafNode>
+                        </children>
+                      </tagNode>
+                    </children>
+                  </node>
+                  <leafNode name="domain-search">
+                    <properties>
+                      <help>Domain name for client to search</help>
+                      <constraint>
+                        <regex>^[-_a-zA-Z0-9.]+$</regex>
+                      </constraint>
+                      <constraintErrorMessage>Invalid domain name syntax</constraintErrorMessage>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <node name="lease-time">
+                    <properties>
+                      <help>Parameters relating to the lease time</help>
+                    </properties>
+                    <children>
+                      <leafNode name="default">
+                        <properties>
+                          <help>Default time (in seconds) that will be assigned to a lease</help>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="maximum">
+                        <properties>
+                          <help>Maximum time (in seconds) that will be assigned to a lease</help>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="minimum">
+                        <properties>
+                          <help>Minimum time (in seconds) that will be assigned to a lease</help>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </node>
+                  <leafNode name="name-server">
+                    <properties>
+                      <help>IPv6 address of a Recursive DNS Server</help>
+                      <valueHelp>
+                        <format>ipv6</format>
+                        <description>IPv6 address of DNS name server</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv6-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="nis-domain">
+                    <properties>
+                      <help>NIS domain name for client to use</help>
+                      <constraint>
+                        <regex>^[-_a-zA-Z0-9.]+$</regex>
+                      </constraint>
+                      <constraintErrorMessage>Invalid NIS domain name syntax</constraintErrorMessage>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="nis-server">
+                    <properties>
+                      <help>IPv6 address of a NIS Server</help>
+                      <valueHelp>
+                        <format>ipv6</format>
+                        <description>IPv6 address of NIS server</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv6-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="nisplus-domain">
+                    <properties>
+                      <help>NIS+ domain name for client to use</help>
+                      <constraint>
+                        <regex>^[-_a-zA-Z0-9.]+$</regex>
+                      </constraint>
+                      <constraintErrorMessage>Invalid NIS+ domain name syntax</constraintErrorMessage>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="nisplus-server">
+                    <properties>
+                      <help>IPv6 address of a NIS+ Server</help>
+                      <valueHelp>
+                        <format>ipv6</format>
+                        <description>IPv6 address of NIS+ server</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv6-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <node name="prefix-delegation">
+                    <properties>
+                      <help>Parameters relating to IPv6 prefix delegation</help>
+                    </properties>
+                    <children>
+                      <tagNode name="start">
+                        <properties>
+                          <help>First in range of IPv6 addresses to be used in prefix delegation</help>
+                          <valueHelp>
+                            <format>ipv6</format>
+                            <description>IPv6 address used in prefix delegation</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ipv6-address"/>
+                          </constraint>
+                        </properties>
+                        <children>
+                          <leafNode name="prefix-length">
+                            <properties>
+                              <help>Length in bits of prefixes to be delegated</help>
+                              <valueHelp>
+                                <format>0-255</format>
+                                <description>DHCPv6 server preference (0-255)</description>
+                              </valueHelp>
+                              <constraint>
+                                <validator name="numeric" argument="--range 0-255"/>
+                              </constraint>
+                              <constraintErrorMessage>Preference must be between 0 and 255</constraintErrorMessage>
+                            </properties>
+                          </leafNode>
+                          <leafNode name="stop">
+                            <properties>
+                              <help>Last in range of IPv6 addresses to be used in prefix delegation</help>
+                              <valueHelp>
+                                <format>ipv6</format>
+                                <description>IPv6 address used in prefix delegation</description>
+                              </valueHelp>
+                              <constraint>
+                                <validator name="ipv6-address"/>
+                              </constraint>
+                            </properties>
+                          </leafNode>
+                        </children>
+                      </tagNode>
+                    </children>
+                  </node>
+                  <leafNode name="sip-server-address">
+                    <properties>
+                      <help>IPv6 address of SIP server</help>
+                      <valueHelp>
+                        <format>ipv6</format>
+                        <description>IPv6 address of SIP server</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv6-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="sip-server-name">
+                    <properties>
+                      <help>SIP server name</help>
+                      <constraint>
+                        <regex>^[-_a-zA-Z0-9.]+$</regex>
+                      </constraint>
+                      <constraintErrorMessage>Invalid SIP server name syntax</constraintErrorMessage>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="sntp-server">
+                    <properties>
+                      <help>IPv6 address of an SNTP Server for client to use</help>
+                      <constraint>
+                        <validator name="ipv6-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <tagNode name="static-mapping">
+                    <properties>
+                      <help>Name of static mapping</help>
+                    </properties>
+                    <children>
+                      <leafNode name="disable">
+                        <properties>
+                          <help>Option to disable static-mapping</help>
+                          <valueless/>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="identifier">
+                        <properties>
+                          <help>Client identifier for this static mapping</help>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="ipv6-address">
+                        <properties>
+                          <help>Client IPv5 address for this static mapping</help>
+                          <valueHelp>
+                            <format>ipv6</format>
+                            <description>IPv6 address for this tatic mapping</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ipv6-address"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </tagNode>
+                </children>
+              </tagNode>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/src/conf_mode/dhcpv6_server.py b/src/conf_mode/dhcpv6_server.py
new file mode 100755
index 000000000..260ccf395
--- /dev/null
+++ b/src/conf_mode/dhcpv6_server.py
@@ -0,0 +1,374 @@
+#!/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/dhcp/dhcpd6.conf'
+lease_file = r'/config/dhcpd6.leases'
+daemon_config_file = r'/etc/default/isc-dhcpv6-server'
+
+# Please be careful if you edit the template.
+config_tmpl = """
+### Autogenerated by dhcpv6_server.py ###
+
+# For options please consult the following website:
+# https://www.isc.org/wp-content/uploads/2017/08/dhcp43options.html
+
+log-facility local7;
+{%- if preference %}
+option dhcp6.preference {{ preference }};
+{%- endif %}
+
+# Shared network configration(s)
+{% for network in shared_network %}
+{%- if not network.disabled -%}
+shared-network {{ network.name }} {
+    {%- for subnet in network.subnet %}
+    subnet6 {{ subnet.network }} {
+        {%- for range in subnet.range6_temporary %}
+        range6 {{ range.prefix }}{{ " temporary" if range.temporary }};
+        {%- endfor %}
+        {%- for range in subnet.range6 %}
+        range6 {{ range.start }} {{ range.stop }};
+        {%- endfor %}
+        {%- if subnet.domain_search %}
+        option dhcp6.domain-search {{ subnet.domain_search | join(', ') }};
+        {%- endif %}
+        {%- if subnet.lease_def %}
+        default-lease-time {{ subnet.lease_def }};
+        {%- endif %}
+        {%- if subnet.lease_max %}
+        max-lease-time {{ subnet.lease_max }};
+        {%- endif %}
+        {%- if subnet.lease_min %}
+        min-lease-time {{ subnet.lease_min }};
+        {%- endif %}
+        {%- if subnet.dns_server %}
+        option dhcp6.name-servers {{ subnet.dns_server | join(', ') }};
+        {%- endif %}
+        {%- if subnet.nis_domain %}
+        option dhcp6.nis-domain-name "{{ subnet.nis_domain }}";
+        {%- endif %}
+        {%- if subnet.nis_server %}
+        option dhcp6.nis-servers {{ subnet.nis_server | join(', ') }};
+        {%- endif %}
+        {%- if subnet.nisp_domain %}
+        option dhcp6.nisp-domain-name "{{ subnet.nisp_domain }}";
+        {%- endif %}
+        {%- if subnet.nisp_server %}
+        option dhcp6.nisp-servers {{ subnet.nisp_server | join(', ') }};
+        {%- endif %}
+        {%- if subnet.sip_address %}
+        option dhcp6.sip-servers-addresses {{ subnet.sip_address | join(', ') }};
+        {%- endif %}
+        {%- if subnet.sip_hostname %}
+        option dhcp6.sip-servers-names {{ subnet.sip_hostname | join(', ') }};
+        {%- endif %}
+        {%- if subnet.sntp_server %}
+        option dhcp6.sntp-servers {{ subnet.sntp_server | join(', ') }};
+        {%- endif %}
+        {%- for host in subnet.static_mapping %}
+        {% if not host.disabled -%}
+        host {{ network.name }}_{{ host.name }} {
+            host-identifier option dhcp6.client-id "{{ host.client_identifier }}";
+            fixed-address6 {{ host.ipv6_address }};
+        }
+        {%- endif %}
+        {%- endfor %}
+    }
+    {%- endfor %}
+}
+{%- endif %}
+{% endfor %}
+
+"""
+
+daemon_tmpl = """
+### Autogenerated by dhcp_server.py ###
+
+# sourced by /etc/init.d/isc-dhcpv6-server
+
+DHCPD_CONF=/etc/dhcp/dhcpd6.conf
+DHCPD_PID=/var/run/dhcpd6.pid
+OPTIONS="-6 -lf {{ lease_file }}"
+INTERFACES=""
+"""
+
+default_config_data = {
+    'lease_file': lease_file,
+    'preference': '',
+    'disabled': False,
+    'shared_network': []
+}
+
+def get_config():
+    dhcpv6 = default_config_data
+    conf = Config()
+    if not conf.exists('service dhcpv6-server'):
+        return None
+    else:
+        conf.set_level('service dhcpv6-server')
+
+    # Check for global disable of DHCPv6 service
+    if conf.exists('disable'):
+        dhcpv6['disabled'] = True
+        return dhcpv6
+
+    # Preference of this DHCPv6 server compared with others
+    if conf.exists('preference'):
+        dhcpv6['preference'] = conf.return_value('preference')
+
+    # check for multiple, shared networks served with DHCPv6 addresses
+    if conf.exists('shared-network-name'):
+        for network in conf.list_nodes('shared-network-name'):
+            conf.set_level('service dhcpv6-server shared-network-name {0}'.format(network))
+            config = {
+                'name': network,
+                'disabled': False,
+                'subnet': []
+            }
+
+            # If disabled, the shared-network configuration becomes inactive
+            if conf.exists('disable'):
+                config['disabled'] = True
+
+            # check for multiple subnet configurations in a shared network
+            if conf.exists('subnet'):
+                for net in conf.list_nodes('subnet'):
+                    conf.set_level('service dhcpv6-server shared-network-name {0} subnet {1}'.format(network, net))
+                    subnet = {
+                        'network': net,
+                        'range6_temporary': [],
+                        'range6': [],
+                        'default_router': '',
+                        'dns_server': [],
+                        'domain_name': '',
+                        'domain_search': [],
+                        'lease_def': '',
+                        'lease_min': '',
+                        'lease_max': '',
+                        'nis_domain': '',
+                        'nis_server': [],
+                        'nisp_domain': '',
+                        'nisp_server': [],
+                        'sip_address': [],
+                        'sip_hostname': [],
+                        'sntp_server': [],
+                        'static_mapping': []
+                    }
+
+                    # For any subnet on which addresses will be assigned dynamically, there must be at
+                    # least one address range statement. The range statement gives the lowest and highest
+                    # IP addresses in a range. All IP addresses in the range should be in the subnet in
+                    # which the range statement is declared.
+                    if conf.exists('address-range prefix'):
+                        for prefix in conf.list_nodes('address-range prefix'):
+                            range = {
+                                'prefix': prefix,
+                                'temporary': False
+                            }
+
+                            # Address range will be used for temporary addresses
+                            if conf.exists('address-range prefix {0} temporary'.format(range['prefix'])):
+                                range['temporary'] = True
+
+                            # Append to subnet temporary range6 list
+                            subnet['range6_temporary'].append(range)
+
+                    if conf.exists('address-range start'):
+                        for range in conf.list_nodes('address-range start'):
+                            range = {
+                                'start': range,
+                                'stop': conf.return_value('address-range start {0} stop'.format(range))
+                            }
+
+                            # Append to subnet range6 list
+                            subnet['range6'].append(range)
+
+                    # The domain-search option specifies a 'search list' of Domain Names to be used
+                    # by the client to locate not-fully-qualified domain names.
+                    if conf.exists('domain-search'):
+                        for domain in conf.return_values('domain-search'):
+                            subnet['domain_search'].append('"' + domain + '"')
+
+                    # IPv6 address valid lifetime
+                    #  (at the end the address is no longer usable by the client)
+                    #  (set to 30 days, the usual IPv6 default)
+                    if conf.exists('lease-time default'):
+                        subnet['lease_def'] = conf.return_value('lease-time default')
+
+                    # Time should be the maximum length in seconds that will be assigned to a lease.
+                    # The only exception to this is that Dynamic BOOTP lease lengths, which are not
+                    # specified by the client, are not limited by this maximum.
+                    if conf.exists('lease-time maximum'):
+                        subnet['lease_max'] = conf.return_value('lease-time maximum')
+
+                    # Time should be the minimum length in seconds that will be assigned to a lease
+                    if conf.exists('lease-time minimum'):
+                        subnet['lease_min'] = conf.return_value('lease-time minimum')
+
+                    # Specifies a list of Domain Name System name servers available to the client.
+                    # Servers should be listed in order of preference.
+                    if conf.exists('name-server'):
+                        subnet['dns_server'] = conf.return_values('name-server')
+
+                    # Ancient NIS (Network Information Service) domain name
+                    if conf.exists('nis-domain'):
+                        subnet['nis_domain'] = conf.return_value('nis-domain')
+
+                    # Ancient NIS (Network Information Service) servers
+                    if conf.exists('nis-server'):
+                        subnet['nis_server'] = conf.return_values('nis-server')
+
+                    # Ancient NIS+ (Network Information Service) domain name
+                    if conf.exists('nisplus-domain'):
+                        subnet['nisp_domain'] = conf.return_value('nisplus-domain')
+
+                    # Ancient NIS+ (Network Information Service) servers
+                    if conf.exists('nisplus-server'):
+                        subnet['nisp_server'] = conf.return_values('nisplus-server')
+
+                    #
+                    # Prefix Delegation (RFC 3633)
+                    #
+                    if conf.exists('prefix-delegation'):
+                        print("TODO")
+
+                    # Local SIP server that is to be used for all outbound SIP requests - IPv6 address
+                    if conf.exists('sip-server-address'):
+                        subnet['sip_address'] = conf.return_values('sip-server-address')
+
+                    # Local SIP server that is to be used for all outbound SIP requests - hostname
+                    if conf.exists('sip-server-name'):
+                        for hostname in conf.return_values('sip-server-name'):
+                            subnet['sip_hostname'].append('"' + hostname + '"')
+
+                    # List of local SNTP servers available for the client to synchronize their clocks
+                    if conf.exists('sntp-server'):
+                        subnet['sntp_server'] = conf.return_values('sntp-server')
+
+                    #
+                    # Static DHCP v6 leases
+                    #
+                    if conf.exists('static-mapping'):
+                        for mapping in conf.list_nodes('static-mapping'):
+                            conf.set_level('service dhcpv6-server shared-network-name {0} subnet {1} static-mapping {2}'.format(network, net, mapping))
+                            mapping = {
+                               'name': mapping,
+                               'disabled': False,
+                               'ipv6_address': '',
+                               'client_identifier': '',
+                            }
+
+                            # This static lease is disabled
+                            if conf.exists('disable'):
+                                mapping['disabled'] = True
+
+                            # IPv6 address used for this DHCP client
+                            if conf.exists('ipv6-address'):
+                                mapping['ipv6_address'] = conf.return_value('ipv6-address')
+
+                            # This option specifies the client’s DUID identifier. DUIDs are similar but different from DHCPv4 client identifiers
+                            if conf.exists('identifier'):
+                                mapping['client_identifier'] = conf.return_value('identifier')
+
+                            # append static mapping configuration tu subnet list
+                            subnet['static_mapping'].append(mapping)
+
+                    # append subnet configuration to shared network subnet list
+                    config['subnet'].append(subnet)
+
+
+            # append shared network configuration to config dictionary
+            dhcpv6['shared_network'].append(config)
+
+    return dhcpv6
+
+def verify(dhcpv6):
+    if dhcpv6 is None:
+        return None
+
+    if dhcpv6['disabled']:
+        return None
+
+    # If DHCP is enabled we need one share-network
+    if len(dhcpv6['shared_network']) == 0:
+        raise ConfigError('No DHCPv6 shared networks configured.\n' \
+                          'At least one DHCPv6 shared network must be configured.')
+
+    # A shared-network requires a subnet definition
+    for network in dhcpv6['shared_network']:
+        if len(network['subnet']) == 0:
+            raise ConfigError('No DHCPv6 lease subnets configured for {0}. At least one\n' \
+                              'lease subnet must be configured for each shared network.'.format(network['name']))
+
+
+    return None
+
+def generate(dhcpv6):
+    if dhcpv6 is None:
+        return None
+
+    if dhcpv6['disabled']:
+        print('Warning: DHCPv6 server will be deactivated because it is disabled')
+        return None
+
+    tmpl = jinja2.Template(config_tmpl)
+    config_text = tmpl.render(dhcpv6)
+    with open(config_file, 'w') as f:
+        f.write(config_text)
+
+    tmpl = jinja2.Template(daemon_tmpl)
+    config_text = tmpl.render(dhcpv6)
+    with open(daemon_config_file, 'w') as f:
+        f.write(config_text)
+
+    return None
+
+def apply(dhcpv6):
+    if (dhcpv6 is None) or dhcpv6['disabled']:
+        # DHCP server is removed in the commit
+        os.system('sudo systemctl stop isc-dhcpv6-server.service')
+        if os.path.exists(config_file):
+            os.unlink(config_file)
+        if os.path.exists(daemon_config_file):
+            os.unlink(daemon_config_file)
+    else:
+        # If our file holding DHCPv6 leases does yet not exist - create it
+        if not os.path.exists(lease_file):
+            os.mknod(lease_file)
+
+        os.system('sudo systemctl restart isc-dhcpv6-server.service')
+
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        sys.exit(1)