34a50a1b82
Instead of using this log (which really isn't a failure) we should instead of just return the looked up locations and then if there really is an error the caller can handle the usage of the looked up locations as they choose fit.
866 lines
31 KiB
Python
866 lines
31 KiB
Python
# vi: ts=4 expandtab
|
|
#
|
|
# Copyright (C) 2012 Canonical Ltd.
|
|
# Copyright (C) 2012, 2013 Hewlett-Packard Development Company, L.P.
|
|
# Copyright (C) 2012 Yahoo! Inc.
|
|
#
|
|
# Author: Scott Moser <scott.moser@canonical.com>
|
|
# Author: Juerg Haefliger <juerg.haefliger@hp.com>
|
|
# Author: Joshua Harlow <harlowja@yahoo-inc.com>
|
|
# Author: Ben Howard <ben.howard@canonical.com>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License version 3, 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/>.
|
|
|
|
from StringIO import StringIO
|
|
|
|
import abc
|
|
import itertools
|
|
import os
|
|
import re
|
|
|
|
from cloudinit import importer
|
|
from cloudinit import log as logging
|
|
from cloudinit import ssh_util
|
|
from cloudinit import type_utils
|
|
from cloudinit import util
|
|
|
|
from cloudinit.distros.parsers import hosts
|
|
|
|
OSFAMILIES = {
|
|
'debian': ['debian', 'ubuntu'],
|
|
'redhat': ['fedora', 'rhel'],
|
|
'gentoo': ['gentoo'],
|
|
'freebsd': ['freebsd'],
|
|
'suse': ['sles'],
|
|
'arch': ['arch'],
|
|
}
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class Distro(object):
|
|
__metaclass__ = abc.ABCMeta
|
|
|
|
hosts_fn = "/etc/hosts"
|
|
ci_sudoers_fn = "/etc/sudoers.d/90-cloud-init-users"
|
|
hostname_conf_fn = "/etc/hostname"
|
|
tz_zone_dir = "/usr/share/zoneinfo"
|
|
init_cmd = ['service'] # systemctl, service etc
|
|
|
|
def __init__(self, name, cfg, paths):
|
|
self._paths = paths
|
|
self._cfg = cfg
|
|
self.name = name
|
|
|
|
@abc.abstractmethod
|
|
def install_packages(self, pkglist):
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def _write_network(self, settings):
|
|
# In the future use the http://fedorahosted.org/netcf/
|
|
# to write this blob out in a distro format
|
|
raise NotImplementedError()
|
|
|
|
def _find_tz_file(self, tz):
|
|
tz_file = os.path.join(self.tz_zone_dir, str(tz))
|
|
if not os.path.isfile(tz_file):
|
|
raise IOError(("Invalid timezone %s,"
|
|
" no file found at %s") % (tz, tz_file))
|
|
return tz_file
|
|
|
|
def get_option(self, opt_name, default=None):
|
|
return self._cfg.get(opt_name, default)
|
|
|
|
def set_hostname(self, hostname, fqdn=None):
|
|
writeable_hostname = self._select_hostname(hostname, fqdn)
|
|
self._write_hostname(writeable_hostname, self.hostname_conf_fn)
|
|
self._apply_hostname(hostname)
|
|
|
|
@abc.abstractmethod
|
|
def package_command(self, cmd, args=None, pkgs=None):
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def update_package_sources(self):
|
|
raise NotImplementedError()
|
|
|
|
def get_primary_arch(self):
|
|
arch = os.uname[4]
|
|
if arch in ("i386", "i486", "i586", "i686"):
|
|
return "i386"
|
|
return arch
|
|
|
|
def _get_arch_package_mirror_info(self, arch=None):
|
|
mirror_info = self.get_option("package_mirrors", [])
|
|
if not arch:
|
|
arch = self.get_primary_arch()
|
|
return _get_arch_package_mirror_info(mirror_info, arch)
|
|
|
|
def get_package_mirror_info(self, arch=None,
|
|
availability_zone=None):
|
|
# This resolves the package_mirrors config option
|
|
# down to a single dict of {mirror_name: mirror_url}
|
|
arch_info = self._get_arch_package_mirror_info(arch)
|
|
return _get_package_mirror_info(availability_zone=availability_zone,
|
|
mirror_info=arch_info)
|
|
|
|
def apply_network(self, settings, bring_up=True):
|
|
# Write it out
|
|
dev_names = self._write_network(settings)
|
|
# Now try to bring them up
|
|
if bring_up:
|
|
return self._bring_up_interfaces(dev_names)
|
|
return False
|
|
|
|
@abc.abstractmethod
|
|
def apply_locale(self, locale, out_fn=None):
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def set_timezone(self, tz):
|
|
raise NotImplementedError()
|
|
|
|
def _get_localhost_ip(self):
|
|
return "127.0.0.1"
|
|
|
|
@abc.abstractmethod
|
|
def _read_hostname(self, filename, default=None):
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def _write_hostname(self, hostname, filename):
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def _read_system_hostname(self):
|
|
raise NotImplementedError()
|
|
|
|
def _apply_hostname(self, hostname):
|
|
# This really only sets the hostname
|
|
# temporarily (until reboot so it should
|
|
# not be depended on). Use the write
|
|
# hostname functions for 'permanent' adjustments.
|
|
LOG.debug("Non-persistently setting the system hostname to %s",
|
|
hostname)
|
|
try:
|
|
util.subp(['hostname', hostname])
|
|
except util.ProcessExecutionError:
|
|
util.logexc(LOG, "Failed to non-persistently adjust the system "
|
|
"hostname to %s", hostname)
|
|
|
|
@abc.abstractmethod
|
|
def _select_hostname(self, hostname, fqdn):
|
|
raise NotImplementedError()
|
|
|
|
@staticmethod
|
|
def expand_osfamily(family_list):
|
|
distros = []
|
|
for family in family_list:
|
|
if family not in OSFAMILIES:
|
|
raise ValueError("No distibutions found for osfamily %s"
|
|
% (family))
|
|
distros.extend(OSFAMILIES[family])
|
|
return distros
|
|
|
|
def update_hostname(self, hostname, fqdn, prev_hostname_fn):
|
|
applying_hostname = hostname
|
|
|
|
# Determine what the actual written hostname should be
|
|
hostname = self._select_hostname(hostname, fqdn)
|
|
|
|
# If the previous hostname file exists lets see if we
|
|
# can get a hostname from it
|
|
if prev_hostname_fn and os.path.exists(prev_hostname_fn):
|
|
prev_hostname = self._read_hostname(prev_hostname_fn)
|
|
else:
|
|
prev_hostname = None
|
|
|
|
# Lets get where we should write the system hostname
|
|
# and what the system hostname is
|
|
(sys_fn, sys_hostname) = self._read_system_hostname()
|
|
update_files = []
|
|
|
|
# If there is no previous hostname or it differs
|
|
# from what we want, lets update it or create the
|
|
# file in the first place
|
|
if not prev_hostname or prev_hostname != hostname:
|
|
update_files.append(prev_hostname_fn)
|
|
|
|
# If the system hostname is different than the previous
|
|
# one or the desired one lets update it as well
|
|
if (not sys_hostname) or (sys_hostname == prev_hostname
|
|
and sys_hostname != hostname):
|
|
update_files.append(sys_fn)
|
|
|
|
# Remove duplicates (incase the previous config filename)
|
|
# is the same as the system config filename, don't bother
|
|
# doing it twice
|
|
update_files = set([f for f in update_files if f])
|
|
LOG.debug("Attempting to update hostname to %s in %s files",
|
|
hostname, len(update_files))
|
|
|
|
for fn in update_files:
|
|
try:
|
|
self._write_hostname(hostname, fn)
|
|
except IOError:
|
|
util.logexc(LOG, "Failed to write hostname %s to %s", hostname,
|
|
fn)
|
|
|
|
if (sys_hostname and prev_hostname and
|
|
sys_hostname != prev_hostname):
|
|
LOG.debug("%s differs from %s, assuming user maintained hostname.",
|
|
prev_hostname_fn, sys_fn)
|
|
|
|
# If the system hostname file name was provided set the
|
|
# non-fqdn as the transient hostname.
|
|
if sys_fn in update_files:
|
|
self._apply_hostname(applying_hostname)
|
|
|
|
def update_etc_hosts(self, hostname, fqdn):
|
|
header = ''
|
|
if os.path.exists(self.hosts_fn):
|
|
eh = hosts.HostsConf(util.load_file(self.hosts_fn))
|
|
else:
|
|
eh = hosts.HostsConf('')
|
|
header = util.make_header(base="added")
|
|
local_ip = self._get_localhost_ip()
|
|
prev_info = eh.get_entry(local_ip)
|
|
need_change = False
|
|
if not prev_info:
|
|
eh.add_entry(local_ip, fqdn, hostname)
|
|
need_change = True
|
|
else:
|
|
need_change = True
|
|
for entry in prev_info:
|
|
entry_fqdn = None
|
|
entry_aliases = []
|
|
if len(entry) >= 1:
|
|
entry_fqdn = entry[0]
|
|
if len(entry) >= 2:
|
|
entry_aliases = entry[1:]
|
|
if entry_fqdn is not None and entry_fqdn == fqdn:
|
|
if hostname in entry_aliases:
|
|
# Exists already, leave it be
|
|
need_change = False
|
|
if need_change:
|
|
# Doesn't exist, add that entry in...
|
|
new_entries = list(prev_info)
|
|
new_entries.append([fqdn, hostname])
|
|
eh.del_entries(local_ip)
|
|
for entry in new_entries:
|
|
if len(entry) == 1:
|
|
eh.add_entry(local_ip, entry[0])
|
|
elif len(entry) >= 2:
|
|
eh.add_entry(local_ip, *entry)
|
|
if need_change:
|
|
contents = StringIO()
|
|
if header:
|
|
contents.write("%s\n" % (header))
|
|
contents.write("%s\n" % (eh))
|
|
util.write_file(self.hosts_fn, contents.getvalue(), mode=0644)
|
|
|
|
def _bring_up_interface(self, device_name):
|
|
cmd = ['ifup', device_name]
|
|
LOG.debug("Attempting to run bring up interface %s using command %s",
|
|
device_name, cmd)
|
|
try:
|
|
(_out, err) = util.subp(cmd)
|
|
if len(err):
|
|
LOG.warn("Running %s resulted in stderr output: %s", cmd, err)
|
|
return True
|
|
except util.ProcessExecutionError:
|
|
util.logexc(LOG, "Running interface command %s failed", cmd)
|
|
return False
|
|
|
|
def _bring_up_interfaces(self, device_names):
|
|
am_failed = 0
|
|
for d in device_names:
|
|
if not self._bring_up_interface(d):
|
|
am_failed += 1
|
|
if am_failed == 0:
|
|
return True
|
|
return False
|
|
|
|
def get_default_user(self):
|
|
return self.get_option('default_user')
|
|
|
|
def add_user(self, name, **kwargs):
|
|
"""
|
|
Add a user to the system using standard GNU tools
|
|
"""
|
|
if util.is_user(name):
|
|
LOG.info("User %s already exists, skipping." % name)
|
|
return
|
|
|
|
adduser_cmd = ['useradd', name]
|
|
log_adduser_cmd = ['useradd', name]
|
|
|
|
# Since we are creating users, we want to carefully validate the
|
|
# inputs. If something goes wrong, we can end up with a system
|
|
# that nobody can login to.
|
|
adduser_opts = {
|
|
"gecos": '--comment',
|
|
"homedir": '--home',
|
|
"primary_group": '--gid',
|
|
"groups": '--groups',
|
|
"passwd": '--password',
|
|
"shell": '--shell',
|
|
"expiredate": '--expiredate',
|
|
"inactive": '--inactive',
|
|
"selinux_user": '--selinux-user',
|
|
}
|
|
|
|
adduser_flags = {
|
|
"no_user_group": '--no-user-group',
|
|
"system": '--system',
|
|
"no_log_init": '--no-log-init',
|
|
}
|
|
|
|
redact_opts = ['passwd']
|
|
|
|
# Check the values and create the command
|
|
for key, val in kwargs.iteritems():
|
|
|
|
if key in adduser_opts and val and isinstance(val, str):
|
|
adduser_cmd.extend([adduser_opts[key], val])
|
|
|
|
# Redact certain fields from the logs
|
|
if key in redact_opts:
|
|
log_adduser_cmd.extend([adduser_opts[key], 'REDACTED'])
|
|
else:
|
|
log_adduser_cmd.extend([adduser_opts[key], val])
|
|
|
|
elif key in adduser_flags and val:
|
|
adduser_cmd.append(adduser_flags[key])
|
|
log_adduser_cmd.append(adduser_flags[key])
|
|
|
|
# Don't create the home directory if directed so or if the user is a
|
|
# system user
|
|
if 'no_create_home' in kwargs or 'system' in kwargs:
|
|
adduser_cmd.append('-M')
|
|
log_adduser_cmd.append('-M')
|
|
else:
|
|
adduser_cmd.append('-m')
|
|
log_adduser_cmd.append('-m')
|
|
|
|
# Run the command
|
|
LOG.debug("Adding user %s", name)
|
|
try:
|
|
util.subp(adduser_cmd, logstring=log_adduser_cmd)
|
|
except Exception as e:
|
|
util.logexc(LOG, "Failed to create user %s", name)
|
|
raise e
|
|
|
|
def create_user(self, name, **kwargs):
|
|
"""
|
|
Creates users for the system using the GNU passwd tools. This
|
|
will work on an GNU system. This should be overriden on
|
|
distros where useradd is not desirable or not available.
|
|
"""
|
|
|
|
# Add the user
|
|
self.add_user(name, **kwargs)
|
|
|
|
# Set password if plain-text password provided and non-empty
|
|
if 'plain_text_passwd' in kwargs and kwargs['plain_text_passwd']:
|
|
self.set_passwd(name, kwargs['plain_text_passwd'])
|
|
|
|
# Default locking down the account. 'lock_passwd' defaults to True.
|
|
# lock account unless lock_password is False.
|
|
if kwargs.get('lock_passwd', True):
|
|
self.lock_passwd(name)
|
|
|
|
# Configure sudo access
|
|
if 'sudo' in kwargs:
|
|
self.write_sudo_rules(name, kwargs['sudo'])
|
|
|
|
# Import SSH keys
|
|
if 'ssh_authorized_keys' in kwargs:
|
|
keys = set(kwargs['ssh_authorized_keys']) or []
|
|
ssh_util.setup_user_keys(keys, name, options=None)
|
|
|
|
return True
|
|
|
|
def lock_passwd(self, name):
|
|
"""
|
|
Lock the password of a user, i.e., disable password logins
|
|
"""
|
|
try:
|
|
# Need to use the short option name '-l' instead of '--lock'
|
|
# (which would be more descriptive) since SLES 11 doesn't know
|
|
# about long names.
|
|
util.subp(['passwd', '-l', name])
|
|
except Exception as e:
|
|
util.logexc(LOG, 'Failed to disable password for user %s', name)
|
|
raise e
|
|
|
|
def set_passwd(self, user, passwd, hashed=False):
|
|
pass_string = '%s:%s' % (user, passwd)
|
|
cmd = ['chpasswd']
|
|
|
|
if hashed:
|
|
# Need to use the short option name '-e' instead of '--encrypted'
|
|
# (which would be more descriptive) since SLES 11 doesn't know
|
|
# about long names.
|
|
cmd.append('-e')
|
|
|
|
try:
|
|
util.subp(cmd, pass_string, logstring="chpasswd for %s" % user)
|
|
except Exception as e:
|
|
util.logexc(LOG, "Failed to set password for %s", user)
|
|
raise e
|
|
|
|
return True
|
|
|
|
def ensure_sudo_dir(self, path, sudo_base='/etc/sudoers'):
|
|
# Ensure the dir is included and that
|
|
# it actually exists as a directory
|
|
sudoers_contents = ''
|
|
base_exists = False
|
|
if os.path.exists(sudo_base):
|
|
sudoers_contents = util.load_file(sudo_base)
|
|
base_exists = True
|
|
found_include = False
|
|
for line in sudoers_contents.splitlines():
|
|
line = line.strip()
|
|
include_match = re.search(r"^#includedir\s+(.*)$", line)
|
|
if not include_match:
|
|
continue
|
|
included_dir = include_match.group(1).strip()
|
|
if not included_dir:
|
|
continue
|
|
included_dir = os.path.abspath(included_dir)
|
|
if included_dir == path:
|
|
found_include = True
|
|
break
|
|
if not found_include:
|
|
try:
|
|
if not base_exists:
|
|
lines = [('# See sudoers(5) for more information'
|
|
' on "#include" directives:'), '',
|
|
util.make_header(base="added"),
|
|
"#includedir %s" % (path), '']
|
|
sudoers_contents = "\n".join(lines)
|
|
util.write_file(sudo_base, sudoers_contents, 0440)
|
|
else:
|
|
lines = ['', util.make_header(base="added"),
|
|
"#includedir %s" % (path), '']
|
|
sudoers_contents = "\n".join(lines)
|
|
util.append_file(sudo_base, sudoers_contents)
|
|
LOG.debug("Added '#includedir %s' to %s" % (path, sudo_base))
|
|
except IOError as e:
|
|
util.logexc(LOG, "Failed to write %s", sudo_base)
|
|
raise e
|
|
util.ensure_dir(path, 0750)
|
|
|
|
def write_sudo_rules(self, user, rules, sudo_file=None):
|
|
if not sudo_file:
|
|
sudo_file = self.ci_sudoers_fn
|
|
|
|
lines = [
|
|
'',
|
|
"# User rules for %s" % user,
|
|
]
|
|
if isinstance(rules, (list, tuple)):
|
|
for rule in rules:
|
|
lines.append("%s %s" % (user, rule))
|
|
elif isinstance(rules, (basestring, str)):
|
|
lines.append("%s %s" % (user, rules))
|
|
else:
|
|
msg = "Can not create sudoers rule addition with type %r"
|
|
raise TypeError(msg % (type_utils.obj_name(rules)))
|
|
content = "\n".join(lines)
|
|
content += "\n" # trailing newline
|
|
|
|
self.ensure_sudo_dir(os.path.dirname(sudo_file))
|
|
if not os.path.exists(sudo_file):
|
|
contents = [
|
|
util.make_header(),
|
|
content,
|
|
]
|
|
try:
|
|
util.write_file(sudo_file, "\n".join(contents), 0440)
|
|
except IOError as e:
|
|
util.logexc(LOG, "Failed to write sudoers file %s", sudo_file)
|
|
raise e
|
|
else:
|
|
try:
|
|
util.append_file(sudo_file, content)
|
|
except IOError as e:
|
|
util.logexc(LOG, "Failed to append sudoers file %s", sudo_file)
|
|
raise e
|
|
|
|
def create_group(self, name, members):
|
|
group_add_cmd = ['groupadd', name]
|
|
|
|
# Check if group exists, and then add it doesn't
|
|
if util.is_group(name):
|
|
LOG.warn("Skipping creation of existing group '%s'" % name)
|
|
else:
|
|
try:
|
|
util.subp(group_add_cmd)
|
|
LOG.info("Created new group %s" % name)
|
|
except Exception:
|
|
util.logexc("Failed to create group %s", name)
|
|
|
|
# Add members to the group, if so defined
|
|
if len(members) > 0:
|
|
for member in members:
|
|
if not util.is_user(member):
|
|
LOG.warn("Unable to add group member '%s' to group '%s'"
|
|
"; user does not exist.", member, name)
|
|
continue
|
|
|
|
util.subp(['usermod', '-a', '-G', name, member])
|
|
LOG.info("Added user '%s' to group '%s'" % (member, name))
|
|
|
|
|
|
def _get_package_mirror_info(mirror_info, availability_zone=None,
|
|
mirror_filter=util.search_for_mirror):
|
|
# given a arch specific 'mirror_info' entry (from package_mirrors)
|
|
# search through the 'search' entries, and fallback appropriately
|
|
# return a dict with only {name: mirror} entries.
|
|
if not mirror_info:
|
|
mirror_info = {}
|
|
|
|
ec2_az_re = ("^[a-z][a-z]-(%s)-[1-9][0-9]*[a-z]$" %
|
|
"north|northeast|east|southeast|south|southwest|west|northwest")
|
|
|
|
subst = {}
|
|
if availability_zone:
|
|
subst['availability_zone'] = availability_zone
|
|
|
|
if availability_zone and re.match(ec2_az_re, availability_zone):
|
|
subst['ec2_region'] = "%s" % availability_zone[0:-1]
|
|
|
|
results = {}
|
|
for (name, mirror) in mirror_info.get('failsafe', {}).iteritems():
|
|
results[name] = mirror
|
|
|
|
for (name, searchlist) in mirror_info.get('search', {}).iteritems():
|
|
mirrors = []
|
|
for tmpl in searchlist:
|
|
try:
|
|
mirrors.append(tmpl % subst)
|
|
except KeyError:
|
|
pass
|
|
|
|
found = mirror_filter(mirrors)
|
|
if found:
|
|
results[name] = found
|
|
|
|
LOG.debug("filtered distro mirror info: %s" % results)
|
|
|
|
return results
|
|
|
|
|
|
def _get_arch_package_mirror_info(package_mirrors, arch):
|
|
# pull out the specific arch from a 'package_mirrors' config option
|
|
default = None
|
|
for item in package_mirrors:
|
|
arches = item.get("arches")
|
|
if arch in arches:
|
|
return item
|
|
if "default" in arches:
|
|
default = item
|
|
return default
|
|
|
|
|
|
# Normalizes a input group configuration
|
|
# which can be a comma seperated list of
|
|
# group names, or a list of group names
|
|
# or a python dictionary of group names
|
|
# to a list of members of that group.
|
|
#
|
|
# The output is a dictionary of group
|
|
# names => members of that group which
|
|
# is the standard form used in the rest
|
|
# of cloud-init
|
|
def _normalize_groups(grp_cfg):
|
|
if isinstance(grp_cfg, (str, basestring)):
|
|
grp_cfg = grp_cfg.strip().split(",")
|
|
if isinstance(grp_cfg, (list)):
|
|
c_grp_cfg = {}
|
|
for i in grp_cfg:
|
|
if isinstance(i, (dict)):
|
|
for k, v in i.items():
|
|
if k not in c_grp_cfg:
|
|
if isinstance(v, (list)):
|
|
c_grp_cfg[k] = list(v)
|
|
elif isinstance(v, (basestring, str)):
|
|
c_grp_cfg[k] = [v]
|
|
else:
|
|
raise TypeError("Bad group member type %s" %
|
|
type_utils.obj_name(v))
|
|
else:
|
|
if isinstance(v, (list)):
|
|
c_grp_cfg[k].extend(v)
|
|
elif isinstance(v, (basestring, str)):
|
|
c_grp_cfg[k].append(v)
|
|
else:
|
|
raise TypeError("Bad group member type %s" %
|
|
type_utils.obj_name(v))
|
|
elif isinstance(i, (str, basestring)):
|
|
if i not in c_grp_cfg:
|
|
c_grp_cfg[i] = []
|
|
else:
|
|
raise TypeError("Unknown group name type %s" %
|
|
type_utils.obj_name(i))
|
|
grp_cfg = c_grp_cfg
|
|
groups = {}
|
|
if isinstance(grp_cfg, (dict)):
|
|
for (grp_name, grp_members) in grp_cfg.items():
|
|
groups[grp_name] = util.uniq_merge_sorted(grp_members)
|
|
else:
|
|
raise TypeError(("Group config must be list, dict "
|
|
" or string types only and not %s") %
|
|
type_utils.obj_name(grp_cfg))
|
|
return groups
|
|
|
|
|
|
# Normalizes a input group configuration
|
|
# which can be a comma seperated list of
|
|
# user names, or a list of string user names
|
|
# or a list of dictionaries with components
|
|
# that define the user config + 'name' (if
|
|
# a 'name' field does not exist then the
|
|
# default user is assumed to 'own' that
|
|
# configuration.
|
|
#
|
|
# The output is a dictionary of user
|
|
# names => user config which is the standard
|
|
# form used in the rest of cloud-init. Note
|
|
# the default user will have a special config
|
|
# entry 'default' which will be marked as true
|
|
# all other users will be marked as false.
|
|
def _normalize_users(u_cfg, def_user_cfg=None):
|
|
if isinstance(u_cfg, (dict)):
|
|
ad_ucfg = []
|
|
for (k, v) in u_cfg.items():
|
|
if isinstance(v, (bool, int, basestring, str, float)):
|
|
if util.is_true(v):
|
|
ad_ucfg.append(str(k))
|
|
elif isinstance(v, (dict)):
|
|
v['name'] = k
|
|
ad_ucfg.append(v)
|
|
else:
|
|
raise TypeError(("Unmappable user value type %s"
|
|
" for key %s") % (type_utils.obj_name(v), k))
|
|
u_cfg = ad_ucfg
|
|
elif isinstance(u_cfg, (str, basestring)):
|
|
u_cfg = util.uniq_merge_sorted(u_cfg)
|
|
|
|
users = {}
|
|
for user_config in u_cfg:
|
|
if isinstance(user_config, (str, basestring, list)):
|
|
for u in util.uniq_merge(user_config):
|
|
if u and u not in users:
|
|
users[u] = {}
|
|
elif isinstance(user_config, (dict)):
|
|
if 'name' in user_config:
|
|
n = user_config.pop('name')
|
|
prev_config = users.get(n) or {}
|
|
users[n] = util.mergemanydict([prev_config,
|
|
user_config])
|
|
else:
|
|
# Assume the default user then
|
|
prev_config = users.get('default') or {}
|
|
users['default'] = util.mergemanydict([prev_config,
|
|
user_config])
|
|
else:
|
|
raise TypeError(("User config must be dictionary/list "
|
|
" or string types only and not %s") %
|
|
type_utils.obj_name(user_config))
|
|
|
|
# Ensure user options are in the right python friendly format
|
|
if users:
|
|
c_users = {}
|
|
for (uname, uconfig) in users.items():
|
|
c_uconfig = {}
|
|
for (k, v) in uconfig.items():
|
|
k = k.replace('-', '_').strip()
|
|
if k:
|
|
c_uconfig[k] = v
|
|
c_users[uname] = c_uconfig
|
|
users = c_users
|
|
|
|
# Fixup the default user into the real
|
|
# default user name and replace it...
|
|
def_user = None
|
|
if users and 'default' in users:
|
|
def_config = users.pop('default')
|
|
if def_user_cfg:
|
|
# Pickup what the default 'real name' is
|
|
# and any groups that are provided by the
|
|
# default config
|
|
def_user_cfg = def_user_cfg.copy()
|
|
def_user = def_user_cfg.pop('name')
|
|
def_groups = def_user_cfg.pop('groups', [])
|
|
# Pickup any config + groups for that user name
|
|
# that we may have previously extracted
|
|
parsed_config = users.pop(def_user, {})
|
|
parsed_groups = parsed_config.get('groups', [])
|
|
# Now merge our extracted groups with
|
|
# anything the default config provided
|
|
users_groups = util.uniq_merge_sorted(parsed_groups, def_groups)
|
|
parsed_config['groups'] = ",".join(users_groups)
|
|
# The real config for the default user is the
|
|
# combination of the default user config provided
|
|
# by the distro, the default user config provided
|
|
# by the above merging for the user 'default' and
|
|
# then the parsed config from the user's 'real name'
|
|
# which does not have to be 'default' (but could be)
|
|
users[def_user] = util.mergemanydict([def_user_cfg,
|
|
def_config,
|
|
parsed_config])
|
|
|
|
# Ensure that only the default user that we
|
|
# found (if any) is actually marked as being
|
|
# the default user
|
|
if users:
|
|
for (uname, uconfig) in users.items():
|
|
if def_user and uname == def_user:
|
|
uconfig['default'] = True
|
|
else:
|
|
uconfig['default'] = False
|
|
|
|
return users
|
|
|
|
|
|
# Normalizes a set of user/users and group
|
|
# dictionary configuration into a useable
|
|
# format that the rest of cloud-init can
|
|
# understand using the default user
|
|
# provided by the input distrobution (if any)
|
|
# to allow for mapping of the 'default' user.
|
|
#
|
|
# Output is a dictionary of group names -> [member] (list)
|
|
# and a dictionary of user names -> user configuration (dict)
|
|
#
|
|
# If 'user' exists it will override
|
|
# the 'users'[0] entry (if a list) otherwise it will
|
|
# just become an entry in the returned dictionary (no override)
|
|
def normalize_users_groups(cfg, distro):
|
|
if not cfg:
|
|
cfg = {}
|
|
|
|
users = {}
|
|
groups = {}
|
|
if 'groups' in cfg:
|
|
groups = _normalize_groups(cfg['groups'])
|
|
|
|
# Handle the previous style of doing this where the first user
|
|
# overrides the concept of the default user if provided in the user: XYZ
|
|
# format.
|
|
old_user = {}
|
|
if 'user' in cfg and cfg['user']:
|
|
old_user = cfg['user']
|
|
# Translate it into the format that is more useful
|
|
# going forward
|
|
if isinstance(old_user, (basestring, str)):
|
|
old_user = {
|
|
'name': old_user,
|
|
}
|
|
if not isinstance(old_user, (dict)):
|
|
LOG.warn(("Format for 'user' key must be a string or "
|
|
"dictionary and not %s"), type_utils.obj_name(old_user))
|
|
old_user = {}
|
|
|
|
# If no old user format, then assume the distro
|
|
# provides what the 'default' user maps to, but notice
|
|
# that if this is provided, we won't automatically inject
|
|
# a 'default' user into the users list, while if a old user
|
|
# format is provided we will.
|
|
distro_user_config = {}
|
|
try:
|
|
distro_user_config = distro.get_default_user()
|
|
except NotImplementedError:
|
|
LOG.warn(("Distro has not implemented default user "
|
|
"access. No distribution provided default user"
|
|
" will be normalized."))
|
|
|
|
# Merge the old user (which may just be an empty dict when not
|
|
# present with the distro provided default user configuration so
|
|
# that the old user style picks up all the distribution specific
|
|
# attributes (if any)
|
|
default_user_config = util.mergemanydict([old_user, distro_user_config])
|
|
|
|
base_users = cfg.get('users', [])
|
|
if not isinstance(base_users, (list, dict, str, basestring)):
|
|
LOG.warn(("Format for 'users' key must be a comma separated string"
|
|
" or a dictionary or a list and not %s"),
|
|
type_utils.obj_name(base_users))
|
|
base_users = []
|
|
|
|
if old_user:
|
|
# Ensure that when user: is provided that this user
|
|
# always gets added (as the default user)
|
|
if isinstance(base_users, (list)):
|
|
# Just add it on at the end...
|
|
base_users.append({'name': 'default'})
|
|
elif isinstance(base_users, (dict)):
|
|
base_users['default'] = dict(base_users).get('default', True)
|
|
elif isinstance(base_users, (str, basestring)):
|
|
# Just append it on to be re-parsed later
|
|
base_users += ",default"
|
|
|
|
users = _normalize_users(base_users, default_user_config)
|
|
return (users, groups)
|
|
|
|
|
|
# Given a user dictionary config it will
|
|
# extract the default user name and user config
|
|
# from that list and return that tuple or
|
|
# return (None, None) if no default user is
|
|
# found in the given input
|
|
def extract_default(users, default_name=None, default_config=None):
|
|
if not users:
|
|
users = {}
|
|
|
|
def safe_find(entry):
|
|
config = entry[1]
|
|
if not config or 'default' not in config:
|
|
return False
|
|
else:
|
|
return config['default']
|
|
|
|
tmp_users = users.items()
|
|
tmp_users = dict(itertools.ifilter(safe_find, tmp_users))
|
|
if not tmp_users:
|
|
return (default_name, default_config)
|
|
else:
|
|
name = tmp_users.keys()[0]
|
|
config = tmp_users[name]
|
|
config.pop('default', None)
|
|
return (name, config)
|
|
|
|
|
|
def fetch(name):
|
|
locs, looked_locs = importer.find_module(name, ['', __name__], ['Distro'])
|
|
if not locs:
|
|
raise ImportError("No distribution found for distro %s (searched %s)"
|
|
% (name, looked_locs))
|
|
mod = importer.import_module(locs[0])
|
|
cls = getattr(mod, 'Distro')
|
|
return cls
|
|
|
|
|
|
def set_etc_timezone(tz, tz_file=None, tz_conf="/etc/timezone",
|
|
tz_local="/etc/localtime"):
|
|
util.write_file(tz_conf, str(tz).rstrip() + "\n")
|
|
# This ensures that the correct tz will be used for the system
|
|
if tz_local and tz_file:
|
|
util.copy(tz_file, self.tz_local_fn)
|
|
return
|