Merge branch 'current' into equuleus

1 files changed, 207 insertions, 164 deletions

diff --git a/src/conf_mode/host_name.py b/src/conf_mode/host_name.py
index 81a52e87f..16467c8df 100755
--- a/src/conf_mode/host_name.py
+++ b/src/conf_mode/host_name.py
@@ -23,20 +23,29 @@ conf-mode script for 'system host-name' and 'system domain-name'.
 import os
 import re
 import sys
-import subprocess
 import copy
-import jinja2
 import glob
+import subprocess
+import argparse
+import jinja2
+
+import vyos.util
 
 from vyos.config import Config
 from vyos import ConfigError
 
+
+parser = argparse.ArgumentParser()
+parser.add_argument("--dhclient", action="store_true",
+                    help="Started from dhclient-script")
+
 config_file_hosts = '/etc/hosts'
 config_file_resolv = '/etc/resolv.conf'
 
 config_tmpl_hosts = """
 ### Autogenerated by host_name.py ###
-127.0.0.1       localhost {{ hostname }}{% if domain_name %}.{{ domain_name }}{% endif %}
+127.0.0.1       localhost
+127.0.1.1       {{ hostname }}{% if domain_name %}.{{ domain_name }}{% endif %}
 
 # The following lines are desirable for IPv6 capable hosts
 ::1             localhost ip6-localhost ip6-loopback
@@ -72,32 +81,6 @@ search {{ domain_search | join(" ") }}
 
 """
 
-# borrowed from: https://github.com/donjajo/py-world/blob/master/resolvconfReader.py, THX!
-def get_resolvers(file):
-  resolvers = []
-  try:
-    with open(file, 'r') as resolvconf:
-      for line in resolvconf.readlines():
-        line = line.split('#',1)[0];
-        line = line.rstrip();
-        if 'nameserver' in line:
-          resolvers.append(line.split()[1])
-      return resolvers
-  except IOError:
-    return []
-
-def get_dhcp_search_doms(file):
-  search_doms = []
-  try:
-    with open(file, 'r') as resolvconf:
-      for line in resolvconf.readlines():
-        line = line.split('#',1)[0];
-        line = line.rstrip();
-        if 'search' in line:
-          return re.sub('^search','',line).lstrip().split()
-  except IOError:
-    return []
-
 default_config_data = {
     'hostname': 'vyos',
     'domain_name': '',
@@ -106,158 +89,218 @@ default_config_data = {
     'no_dhcp_ns': False
 }
 
-def get_config():
-  conf = Config()
-  hosts = copy.deepcopy(default_config_data)
-
-  if conf.exists("system host-name"):
-    hosts['hostname'] = conf.return_value("system host-name")
-
-  if conf.exists("system domain-name"):
-    hosts['domain_name'] = conf.return_value("system domain-name")
-    hosts['domain_search'].append(hosts['domain_name'])
-
-  for search in conf.return_values("system domain-search domain"):
-    hosts['domain_search'].append(search)
+# borrowed from: https://github.com/donjajo/py-world/blob/master/resolvconfReader.py, THX!
+def get_resolvers(file):
+    resolv = {}
+    try:
+        with open(file, 'r') as resolvconf:
+            lines = [line.split('#', 1)[0].rstrip()
+                     for line in resolvconf.readlines()]
+            resolvers = [line.split()[1]
+                         for line in lines if 'nameserver' in line]
+            domains = [line.split()[1] for line in lines if 'search' in line]
+            resolv['resolvers'] = resolvers
+            resolv['domains'] = domains
+        return resolv
+    except IOError:
+        return []
+
+
+def get_config(arguments):
+    conf = Config()
+    hosts = copy.deepcopy(default_config_data)
+
+    if arguments.dhclient:
+        conf.exists = conf.exists_effective
+        conf.return_value = conf.return_effective_value
+        conf.return_values = conf.return_effective_values
+
+    if conf.exists("system host-name"):
+        hosts['hostname'] = conf.return_value("system host-name")
+        # This may happen if the config is not loaded yet,
+        # e.g. if run by cloud-init
+        if not hosts['hostname']:
+            hosts['hostname'] = default_config_data['hostname']
+
+    if conf.exists("system domain-name"):
+        hosts['domain_name'] = conf.return_value("system domain-name")
+        hosts['domain_search'].append(hosts['domain_name'])
+
+    for search in conf.return_values("system domain-search domain"):
+        hosts['domain_search'].append(search)
+
+    if conf.exists("system name-server"):
+        hosts['nameserver'] = conf.return_values("system name-server")
+
+    if conf.exists("system disable-dhcp-nameservers"):
+        hosts['no_dhcp_ns'] = conf.exists('system disable-dhcp-nameservers')
+
+    # system static-host-mapping
+    hosts['static_host_mapping'] = {'hostnames': {}}
+
+    if conf.exists('system static-host-mapping host-name'):
+        for hn in conf.list_nodes('system static-host-mapping host-name'):
+            hosts['static_host_mapping']['hostnames'][hn] = {
+                'ipaddr': conf.return_value('system static-host-mapping host-name ' + hn + ' inet'),
+                'alias': ''
+            }
+
+            if conf.exists('system static-host-mapping host-name ' + hn + ' alias'):
+                a = conf.return_values(
+                    'system static-host-mapping host-name ' + hn + ' alias')
+                hosts['static_host_mapping']['hostnames'][hn]['alias'] = " ".join(a)
+
+    return hosts
 
-  if conf.exists("system name-server"):
-    hosts['nameserver'] = conf.return_values("system name-server")
 
-  if conf.exists("system disable-dhcp-nameservers"):
-    hosts['no_dhcp_ns'] = conf.exists('system disable-dhcp-nameservers')
+def verify(config):
+    if config is None:
+        return None
+
+    # pattern $VAR(@) "^[[:alnum:]][-.[:alnum:]]*[[:alnum:]]$" ; "invalid host name $VAR(@)"
+    hostname_regex = re.compile("^[A-Za-z0-9][-.A-Za-z0-9]*[A-Za-z0-9]$")
+    if not hostname_regex.match(config['hostname']):
+        raise ConfigError('Invalid host name ' + config["hostname"])
+
+    # pattern $VAR(@) "^.{1,63}$" ; "invalid host-name length"
+    length = len(config['hostname'])
+    if length < 1 or length > 63:
+        raise ConfigError(
+            'Invalid host-name length, must be less than 63 characters')
+
+    # The search list is currently limited to six domains with a total of 256 characters.
+    # https://linux.die.net/man/5/resolv.conf
+    if len(config['domain_search']) > 6:
+        raise ConfigError(
+            'The search list is currently limited to six domains')
+
+    tmp = ' '.join(config['domain_search'])
+    if len(tmp) > 256:
+        raise ConfigError(
+            'The search list is currently limited to 256 characters')
+
+    # static mappings alias hostname
+    if config['static_host_mapping']['hostnames']:
+        for hn in config['static_host_mapping']['hostnames']:
+            if not config['static_host_mapping']['hostnames'][hn]['ipaddr']:
+                raise ConfigError('IP address required for ' + hn)
+            for hn_alias in config['static_host_mapping']['hostnames'][hn]['alias'].split(' '):
+                if not hostname_regex.match(hn_alias) and len(hn_alias) != 0:
+                    raise ConfigError('Invalid hostname alias ' + hn_alias)
 
-  ## system static-host-mapping
-  hosts['static_host_mapping'] = { 'hostnames'  : {}}
+    return None
 
-  if conf.exists('system static-host-mapping host-name'):
-    for hn in conf.list_nodes('system static-host-mapping host-name'):
-      hosts['static_host_mapping']['hostnames'][hn] = {
-        'ipaddr'  : conf.return_value('system static-host-mapping host-name ' + hn + ' inet'),
-        'alias'   : '' 
-      }
-      
-      if conf.exists('system static-host-mapping host-name ' + hn + ' alias'):
-        a = conf.return_values('system static-host-mapping host-name ' + hn + ' alias')
-        hosts['static_host_mapping']['hostnames'][hn]['alias'] = " ".join( conf.return_values('system static-host-mapping host-name ' + hn + ' alias') )
 
-  return hosts
+def generate(config):
+    if config is None:
+        return None
+
+    # If "system disable-dhcp-nameservers" is __configured__ all DNS resolvers
+    # received via dhclient should not be added into the final 'resolv.conf'.
+    #
+    # We iterate over every resolver file and retrieve the received nameservers
+    # for later adjustment of the system nameservers
+    dhcp_ns = []
+    dhcp_sd = []
+    for file in glob.glob('/etc/resolv.conf.dhclient-new*'):
+        for key, value in get_resolvers(file).items():
+            ns = [r for r in value if key == 'resolvers']
+            dhcp_ns.extend(ns)
+            sd = [d for d in value if key == 'domains']
+            dhcp_sd.extend(sd)
+
+    if not config['no_dhcp_ns']:
+        config['nameserver'] += dhcp_ns
+        config['domain_search'] += dhcp_sd
+
+    # Prune duplicate values
+    # Not order preserving, but then when multiple DHCP clients are used,
+    # there can't be guarantees about the order anyway
+    dhcp_ns = list(set(dhcp_ns))
+    dhcp_sd = list(set(dhcp_sd))
+
+    # We have third party scripts altering /etc/hosts, too.
+    # One example are the DHCP hostname update scripts thus we need to cache in
+    # every modification first - so changing domain-name, domain-search or hostname
+    # during runtime works
+    old_hosts = ""
+    with open(config_file_hosts, 'r') as f:
+        # Skips text before the beginning of our marker.
+        # NOTE: Marker __MUST__ match the one specified in config_tmpl_hosts
+        for line in f:
+            if line.strip() == '### modifications from other scripts should be added below':
+                break
+
+        for line in f:
+            # This additional line.strip() filters empty lines
+            if line.strip():
+                old_hosts += line
+
+    # Add an additional newline
+    old_hosts += '\n'
+
+    tmpl = jinja2.Template(config_tmpl_hosts)
+    config_text = tmpl.render(config)
+
+    with open(config_file_hosts, 'w') as f:
+        f.write(config_text)
+        f.write(old_hosts)
+
+    tmpl = jinja2.Template(config_tmpl_resolv)
+    config_text = tmpl.render(config)
+    with open(config_file_resolv, 'w') as f:
+        f.write(config_text)
 
-def verify(config):
-  if config is None:
     return None
 
-  # pattern $VAR(@) "^[[:alnum:]][-.[:alnum:]]*[[:alnum:]]$" ; "invalid host name $VAR(@)"
-  hostname_regex = re.compile("^[A-Za-z0-9][-.A-Za-z0-9]*[A-Za-z0-9]$")
-  if not hostname_regex.match(config['hostname']):
-    raise ConfigError('Invalid host name ' + config["hostname"])
 
-  # pattern $VAR(@) "^.{1,63}$" ; "invalid host-name length"
-  length = len(config['hostname'])
-  if length < 1 or length > 63:
-    raise ConfigError('Invalid host-name length, must be less than 63 characters')
+def apply(config):
+    if config is None:
+        return None
 
-  # The search list is currently limited to six domains with a total of 256 characters.
-  # https://linux.die.net/man/5/resolv.conf
-  if len(config['domain_search']) > 6:
-    raise ConfigError('The search list is currently limited to six domains')
+    # No domain name -- the Debian way.
+    hostname_new = config['hostname']
 
-  tmp = ' '.join(config['domain_search'])
-  if len(tmp) > 256:
-    raise ConfigError('The search list is currently limited to 256 characters')
+    # rsyslog runs into a race condition at boot time with systemd
+    # restart rsyslog only if the hostname changed.
+    hostname_old = subprocess.check_output(['hostnamectl', '--static']).decode().strip()
 
-  # static mappings alias hostname
-  if config['static_host_mapping']['hostnames']:
-    for hn in config['static_host_mapping']['hostnames']:
-      if not config['static_host_mapping']['hostnames'][hn]['ipaddr']:
-        raise ConfigError('IP address required for ' + hn)
-      for hn_alias in config['static_host_mapping']['hostnames'][hn]['alias'].split(' '):
-        if not hostname_regex.match(hn_alias) and len (hn_alias) !=0:
-          raise ConfigError('Invalid hostname alias ' + hn_alias)
+    os.system("hostnamectl set-hostname --static {0}".format(hostname_new))
 
-  return None
+    # Restart services that use the hostname
+    if hostname_new != hostname_old:
+        os.system("systemctl restart rsyslog.service")
 
-def generate(config):
-  if config is None:
-    return None
+    # If SNMP is running, restart it too
+    if os.system("pgrep snmpd > /dev/null") == 0:
+        os.system("systemctl restart snmpd.service")
 
-  # If "system disable-dhcp-nameservers" is __configured__ all DNS resolvers
-  # received via dhclient should not be added into the final 'resolv.conf'.
-  #
-  # We iterate over every resolver file and retrieve the received nameservers
-  # for later adjustment of the system nameservers
-  dhcp_ns = []
-  for file in glob.glob('/etc/resolv.conf.dhclient-new*'):
-    for r in get_resolvers(file):
-      dhcp_ns.append(r)
-
-  if not config['no_dhcp_ns']:
-    config['nameserver'] += dhcp_ns
-    for file in glob.glob('/etc/resolv.conf.dhclient-new*'):
-      config['domain_search'] = get_dhcp_search_doms(file)
-
-  # We have third party scripts altering /etc/hosts, too.
-  # One example are the DHCP hostname update scripts thus we need to cache in
-  # every modification first - so changing domain-name, domain-search or hostname
-  # during runtime works
-  old_hosts = ""
-  with open(config_file_hosts, 'r') as f:
-    # Skips text before the beginning of our marker.
-    # NOTE: Marker __MUST__ match the one specified in config_tmpl_hosts
-    for line in f:
-      if line.strip() == '### modifications from other scripts should be added below':
-        break
-
-    for line in f:
-      # This additional line.strip() filters empty lines
-      if line.strip():
-        old_hosts += line
-
-  # Add an additional newline
-  old_hosts += '\n'
-
-  tmpl = jinja2.Template(config_tmpl_hosts)
-  config_text = tmpl.render(config)
-
-  with open(config_file_hosts, 'w') as f:
-    f.write(config_text)
-    f.write(old_hosts)
-
-  tmpl = jinja2.Template(config_tmpl_resolv)
-  config_text = tmpl.render(config)
-  with open(config_file_resolv, 'w') as f:
-    f.write(config_text)
-
-  return None
+    # restart pdns if it is used
+    if os.system("/usr/bin/rec_control ping >/dev/null 2>&1") == 0:
+        os.system("/etc/init.d/pdns-recursor restart >/dev/null")
 
-def apply(config):
-  if config is None:
     return None
 
-  fqdn = config['hostname']
-  if config['domain_name']:
-    fqdn += '.' + config['domain_name']
-
-  os.system("hostnamectl set-hostname --static {0}".format(fqdn.rstrip('.')))
-
-  # Restart services that use the hostname
-  os.system("systemctl restart rsyslog.service")
-
-  # If SNMP is running, restart it too
-  if os.system("pgrep snmpd > /dev/null") == 0:
-    os.system("systemctl restart snmpd.service")
-
-  # restart pdns if it is used
-  if os.system("/usr/bin/rec_control ping >/dev/null 2>&1") == 0:
-    os.system("/etc/init.d/pdns-recursor restart >/dev/null")
-
-  return None
 
 if __name__ == '__main__':
-  try:
-    c = get_config()
-    verify(c)
-    generate(c)
-    apply(c)
-  except ConfigError as e:
-    print(e)
-    sys.exit(1)
+    args = parser.parse_args()
+
+    if args.dhclient:
+        # There's a big chance it was triggered by a commit still in progress
+        # so we need to wait until the new values are in the running config
+        vyos.util.wait_for_commit_lock()
+
+
+    try:
+        c = get_config(args)
+        # If it's called from dhclient, then either:
+        # a) verification was already done at commit time
+        # b) it's run on an unconfigured system, e.g. by cloud-init
+        # Therefore, verification is either redundant or useless
+        if not args.dhclient:
+            verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        sys.exit(1)