File manager - Edit - /home/newsbmcs.com/public_html/static/img/logo/sources.tar
Back
DataSourceSmartOS.py 0000644 00000104135 15027667240 0010436 0 ustar 00 # Copyright (C) 2013 Canonical Ltd. # Copyright 2019 Joyent, Inc. # # Author: Ben Howard <ben.howard@canonical.com> # # This file is part of cloud-init. See LICENSE file for license information. # Datasource for provisioning on SmartOS. This works on Joyent # and public/private Clouds using SmartOS. # # SmartOS hosts use a serial console (/dev/ttyS1) on KVM Linux Guests # The meta-data is transmitted via key/value pairs made by # requests on the console. For example, to get the hostname, you # would send "GET sdc:hostname" on /dev/ttyS1. # For Linux Guests running in LX-Brand Zones on SmartOS hosts # a socket (/native/.zonecontrol/metadata.sock) is used instead # of a serial console. # # Certain behavior is defined by the DataDictionary # https://eng.joyent.com/mdata/datadict.html # Comments with "@datadictionary" are snippets of the definition import base64 import binascii import errno import fcntl import json import os import random import re import socket import serial from cloudinit import dmi from cloudinit import log as logging from cloudinit import sources, subp, util from cloudinit.event import EventScope, EventType LOG = logging.getLogger(__name__) SMARTOS_ATTRIB_MAP = { # Cloud-init Key : (SmartOS Key, Strip line endings) "instance-id": ("sdc:uuid", True), "local-hostname": ("hostname", True), "public-keys": ("root_authorized_keys", True), "user-script": ("user-script", False), "legacy-user-data": ("user-data", False), "user-data": ("cloud-init:user-data", False), "iptables_disable": ("iptables_disable", True), "motd_sys_info": ("motd_sys_info", True), "availability_zone": ("sdc:datacenter_name", True), "vendor-data": ("sdc:vendor-data", False), "operator-script": ("sdc:operator-script", False), "hostname": ("sdc:hostname", True), "dns_domain": ("sdc:dns_domain", True), } SMARTOS_ATTRIB_JSON = { # Cloud-init Key : (SmartOS Key known JSON) "network-data": "sdc:nics", "dns_servers": "sdc:resolvers", "routes": "sdc:routes", } SMARTOS_ENV_LX_BRAND = "lx-brand" SMARTOS_ENV_KVM = "kvm" DS_NAME = "SmartOS" DS_CFG_PATH = ["datasource", DS_NAME] NO_BASE64_DECODE = [ "iptables_disable", "motd_sys_info", "root_authorized_keys", "sdc:datacenter_name", "sdc:uuiduser-data", "user-script", ] METADATA_SOCKFILE = "/native/.zonecontrol/metadata.sock" SERIAL_DEVICE = "/dev/ttyS1" SERIAL_TIMEOUT = 60 # BUILT-IN DATASOURCE CONFIGURATION # The following is the built-in configuration. If the values # are not set via the system configuration, then these default # will be used: # serial_device: which serial device to use for the meta-data # serial_timeout: how long to wait on the device # no_base64_decode: values which are not base64 encoded and # are fetched directly from SmartOS, not meta-data values # base64_keys: meta-data keys that are delivered in base64 # base64_all: with the exclusion of no_base64_decode values, # treat all meta-data as base64 encoded # disk_setup: describes how to partition the ephemeral drive # fs_setup: describes how to format the ephemeral drive # BUILTIN_DS_CONFIG = { "serial_device": SERIAL_DEVICE, "serial_timeout": SERIAL_TIMEOUT, "metadata_sockfile": METADATA_SOCKFILE, "no_base64_decode": NO_BASE64_DECODE, "base64_keys": [], "base64_all": False, "disk_aliases": {"ephemeral0": "/dev/vdb"}, } BUILTIN_CLOUD_CONFIG = { "disk_setup": { "ephemeral0": { "table_type": "mbr", "layout": False, "overwrite": False, } }, "fs_setup": [ {"label": "ephemeral0", "filesystem": "ext4", "device": "ephemeral0"} ], } # builtin vendor-data is a boothook that writes a script into # /var/lib/cloud/scripts/per-boot. *That* script then handles # executing the 'operator-script' and 'user-script' files # that cloud-init writes into /var/lib/cloud/instance/data/ # if they exist. # # This is all very indirect, but its done like this so that at # some point in the future, perhaps cloud-init wouldn't do it at # all, but rather the vendor actually provide vendor-data that accomplished # their desires. (That is the point of vendor-data). # # cloud-init does cheat a bit, and write the operator-script and user-script # itself. It could have the vendor-script do that, but it seems better # to not require the image to contain a tool (mdata-get) to read those # keys when we have a perfectly good one inside cloud-init. BUILTIN_VENDOR_DATA = """\ #cloud-boothook #!/bin/sh fname="%(per_boot_d)s/01_smartos_vendor_data.sh" mkdir -p "${fname%%/*}" cat > "$fname" <<"END_SCRIPT" #!/bin/sh ## # This file is written as part of the default vendor data for SmartOS. # The SmartOS datasource writes the listed file from the listed metadata key # sdc:operator-script -> %(operator_script)s # user-script -> %(user_script)s # # You can view content with 'mdata-get <key>' # for script in "%(operator_script)s" "%(user_script)s"; do [ -x "$script" ] || continue echo "executing '$script'" 1>&2 "$script" done END_SCRIPT chmod +x "$fname" """ # @datadictionary: this is legacy path for placing files from metadata # per the SmartOS location. It is not preferable, but is done for # legacy reasons LEGACY_USER_D = "/var/db" class DataSourceSmartOS(sources.DataSource): dsname = "Joyent" smartos_type = sources.UNSET md_client = sources.UNSET default_update_events = { EventScope.NETWORK: { EventType.BOOT_NEW_INSTANCE, EventType.BOOT, EventType.BOOT_LEGACY, } } def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.ds_cfg = util.mergemanydict( [ self.ds_cfg, util.get_cfg_by_path(sys_cfg, DS_CFG_PATH, {}), BUILTIN_DS_CONFIG, ] ) self.metadata = {} self.network_data = None self._network_config = None self.script_base_d = os.path.join(self.paths.get_cpath("scripts")) self._init() def __str__(self): root = sources.DataSource.__str__(self) return "%s [client=%s]" % (root, self.md_client) def _init(self): if self.smartos_type == sources.UNSET: self.smartos_type = get_smartos_environ() if self.smartos_type is None: self.md_client = None if self.md_client == sources.UNSET: self.md_client = jmc_client_factory( smartos_type=self.smartos_type, metadata_sockfile=self.ds_cfg["metadata_sockfile"], serial_device=self.ds_cfg["serial_device"], serial_timeout=self.ds_cfg["serial_timeout"], ) def _set_provisioned(self): """Mark the instance provisioning state as successful. When run in a zone, the host OS will look for /var/svc/provisioning to be renamed as /var/svc/provision_success. This should be done after meta-data is successfully retrieved and from this point the host considers the provision of the zone to be a success and keeps the zone running. """ LOG.debug("Instance provisioning state set as successful") svc_path = "/var/svc" if os.path.exists("/".join([svc_path, "provisioning"])): os.rename( "/".join([svc_path, "provisioning"]), "/".join([svc_path, "provision_success"]), ) def _get_data(self): self._init() md = {} ud = "" if not self.smartos_type: LOG.debug("Not running on smartos") return False if not self.md_client.exists(): LOG.debug( "No metadata device '%r' found for SmartOS datasource", self.md_client, ) return False # Open once for many requests, rather than once for each request self.md_client.open_transport() for ci_noun, attribute in SMARTOS_ATTRIB_MAP.items(): smartos_noun, strip = attribute md[ci_noun] = self.md_client.get(smartos_noun, strip=strip) for ci_noun, smartos_noun in SMARTOS_ATTRIB_JSON.items(): md[ci_noun] = self.md_client.get_json(smartos_noun) self.md_client.close_transport() # @datadictionary: This key may contain a program that is written # to a file in the filesystem of the guest on each boot and then # executed. It may be of any format that would be considered # executable in the guest instance. # # We write 'user-script' and 'operator-script' into the # instance/data directory. The default vendor-data then handles # executing them later. data_d = os.path.join( self.paths.get_cpath(), "instances", md["instance-id"], "data" ) user_script = os.path.join(data_d, "user-script") u_script_l = "%s/user-script" % LEGACY_USER_D write_boot_content( md.get("user-script"), content_f=user_script, link=u_script_l, shebang=True, mode=0o700, ) operator_script = os.path.join(data_d, "operator-script") write_boot_content( md.get("operator-script"), content_f=operator_script, shebang=False, mode=0o700, ) # @datadictionary: This key has no defined format, but its value # is written to the file /var/db/mdata-user-data on each boot prior # to the phase that runs user-script. This file is not to be executed. # This allows a configuration file of some kind to be injected into # the machine to be consumed by the user-script when it runs. u_data = md.get("legacy-user-data") u_data_f = "%s/mdata-user-data" % LEGACY_USER_D write_boot_content(u_data, u_data_f) # Handle the cloud-init regular meta # The hostname may or may not be qualified with the local domain name. # This follows section 3.14 of RFC 2132. if not md["local-hostname"]: if md["hostname"]: md["local-hostname"] = md["hostname"] else: md["local-hostname"] = md["instance-id"] ud = None if md["user-data"]: ud = md["user-data"] if not md["vendor-data"]: md["vendor-data"] = BUILTIN_VENDOR_DATA % { "user_script": user_script, "operator_script": operator_script, "per_boot_d": os.path.join( self.paths.get_cpath("scripts"), "per-boot" ), } self.metadata = util.mergemanydict([md, self.metadata]) self.userdata_raw = ud self.vendordata_raw = md["vendor-data"] self.network_data = md["network-data"] self.routes_data = md["routes"] self._set_provisioned() return True def _get_subplatform(self): return "serial (%s)" % SERIAL_DEVICE def device_name_to_device(self, name): return self.ds_cfg["disk_aliases"].get(name) def get_config_obj(self): if self.smartos_type == SMARTOS_ENV_KVM: return BUILTIN_CLOUD_CONFIG return {} def get_instance_id(self): return self.metadata["instance-id"] @property def network_config(self): # sources.clear_cached_data() may set _network_config to '_unset'. if self._network_config == sources.UNSET: self._network_config = None if self._network_config is None: if self.network_data is not None: self._network_config = convert_smartos_network_data( network_data=self.network_data, dns_servers=self.metadata["dns_servers"], dns_domain=self.metadata["dns_domain"], routes=self.routes_data, ) return self._network_config class JoyentMetadataFetchException(Exception): pass class JoyentMetadataTimeoutException(JoyentMetadataFetchException): pass class JoyentMetadataClient: """ A client implementing v2 of the Joyent Metadata Protocol Specification. The full specification can be found at http://eng.joyent.com/mdata/protocol.html """ line_regex = re.compile( r"V2 (?P<length>\d+) (?P<checksum>[0-9a-f]+)" r" (?P<body>(?P<request_id>[0-9a-f]+) (?P<status>SUCCESS|NOTFOUND)" r"( (?P<payload>.+))?)" ) def __init__(self, smartos_type=None, fp=None): if smartos_type is None: smartos_type = get_smartos_environ() self.smartos_type = smartos_type self.fp = fp def _checksum(self, body): return "{0:08x}".format( binascii.crc32(body.encode("utf-8")) & 0xFFFFFFFF ) def _get_value_from_frame(self, expected_request_id, frame): frame_data = self.line_regex.match(frame).groupdict() if int(frame_data["length"]) != len(frame_data["body"]): raise JoyentMetadataFetchException( "Incorrect frame length given ({0} != {1}).".format( frame_data["length"], len(frame_data["body"]) ) ) expected_checksum = self._checksum(frame_data["body"]) if frame_data["checksum"] != expected_checksum: raise JoyentMetadataFetchException( "Invalid checksum (expected: {0}; got {1}).".format( expected_checksum, frame_data["checksum"] ) ) if frame_data["request_id"] != expected_request_id: raise JoyentMetadataFetchException( "Request ID mismatch (expected: {0}; got {1}).".format( expected_request_id, frame_data["request_id"] ) ) if not frame_data.get("payload", None): LOG.debug("No value found.") return None value = util.b64d(frame_data["payload"]) LOG.debug('Value "%s" found.', value) return value def _readline(self): """ Reads a line a byte at a time until \n is encountered. Returns an ascii string with the trailing newline removed. If a timeout (per-byte) is set and it expires, a JoyentMetadataFetchException will be thrown. """ response = [] def as_ascii(): return b"".join(response).decode("ascii") msg = "Partial response: '%s'" while True: try: byte = self.fp.read(1) if len(byte) == 0: raise JoyentMetadataTimeoutException(msg % as_ascii()) if byte == b"\n": return as_ascii() response.append(byte) except OSError as exc: if exc.errno == errno.EAGAIN: raise JoyentMetadataTimeoutException( msg % as_ascii() ) from exc raise def _write(self, msg): self.fp.write(msg.encode("ascii")) self.fp.flush() def _negotiate(self): LOG.debug("Negotiating protocol V2") self._write("NEGOTIATE V2\n") response = self._readline() LOG.debug('read "%s"', response) if response != "V2_OK": raise JoyentMetadataFetchException( 'Invalid response "%s" to "NEGOTIATE V2"' % response ) LOG.debug("Negotiation complete") def request(self, rtype, param=None): request_id = "{0:08x}".format(random.randint(0, 0xFFFFFFFF)) message_body = " ".join( ( request_id, rtype, ) ) if param: message_body += " " + base64.b64encode(param.encode()).decode() msg = "V2 {0} {1} {2}\n".format( len(message_body), self._checksum(message_body), message_body ) LOG.debug('Writing "%s" to metadata transport.', msg) need_close = False if not self.fp: self.open_transport() need_close = True self._write(msg) response = self._readline() if need_close: self.close_transport() LOG.debug('Read "%s" from metadata transport.', response) if "SUCCESS" not in response: return None value = self._get_value_from_frame(request_id, response) return value def get(self, key, default=None, strip=False): result = self.request(rtype="GET", param=key) if result is None: return default if result and strip: result = result.strip() return result def get_json(self, key, default=None): result = self.get(key, default=default) if result is None: return default return json.loads(result) def list(self): result = self.request(rtype="KEYS") if not result: return [] return result.split("\n") def put(self, key, val): param = b" ".join( [base64.b64encode(i.encode()) for i in (key, val)] ).decode() return self.request(rtype="PUT", param=param) def delete(self, key): return self.request(rtype="DELETE", param=key) def close_transport(self): if self.fp: self.fp.close() self.fp = None def __enter__(self): if self.fp: return self self.open_transport() return self def __exit__(self, exc_type, exc_value, traceback): self.close_transport() return def open_transport(self): raise NotImplementedError class JoyentMetadataSocketClient(JoyentMetadataClient): def __init__(self, socketpath, smartos_type=SMARTOS_ENV_LX_BRAND): super(JoyentMetadataSocketClient, self).__init__(smartos_type) self.socketpath = socketpath def open_transport(self): sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) sock.connect(self.socketpath) self.fp = sock.makefile("rwb") self._negotiate() def exists(self): return os.path.exists(self.socketpath) def __repr__(self): return "%s(socketpath=%s)" % (self.__class__.__name__, self.socketpath) class JoyentMetadataSerialClient(JoyentMetadataClient): def __init__( self, device, timeout=10, smartos_type=SMARTOS_ENV_KVM, fp=None ): super(JoyentMetadataSerialClient, self).__init__(smartos_type, fp) self.device = device self.timeout = timeout def exists(self): return os.path.exists(self.device) def open_transport(self): if self.fp is None: ser = serial.Serial(self.device, timeout=self.timeout) if not ser.isOpen(): raise SystemError("Unable to open %s" % self.device) self.fp = ser fcntl.lockf(ser, fcntl.LOCK_EX) self._flush() self._negotiate() def _flush(self): LOG.debug("Flushing input") # Read any pending data timeout = self.fp.timeout self.fp.timeout = 0.1 while True: try: self._readline() except JoyentMetadataTimeoutException: break LOG.debug("Input empty") # Send a newline and expect "invalid command". Keep trying until # successful. Retry rather frequently so that the "Is the host # metadata service running" appears on the console soon after someone # attaches in an effort to debug. if timeout > 5: self.fp.timeout = 5 else: self.fp.timeout = timeout while True: LOG.debug('Writing newline, expecting "invalid command"') self._write("\n") try: response = self._readline() if response == "invalid command": break if response == "FAILURE": LOG.debug('Got "FAILURE". Retrying.') continue LOG.warning('Unexpected response "%s" during flush', response) except JoyentMetadataTimeoutException: LOG.warning( "Timeout while initializing metadata client. " "Is the host metadata service running?" ) LOG.debug('Got "invalid command". Flush complete.') self.fp.timeout = timeout def __repr__(self): return "%s(device=%s, timeout=%s)" % ( self.__class__.__name__, self.device, self.timeout, ) class JoyentMetadataLegacySerialClient(JoyentMetadataSerialClient): """V1 of the protocol was not safe for all values. Thus, we allowed the user to pass values in as base64 encoded. Users may still reasonably expect to be able to send base64 data and have it transparently decoded. So even though the V2 format is now used, and is safe (using base64 itself), we keep legacy support. The way for a user to do this was: a.) specify 'base64_keys' key whose value is a comma delimited list of keys that were base64 encoded. b.) base64_all: string interpreted as a boolean that indicates if all keys are base64 encoded. c.) set a key named b64-<keyname> with a boolean indicating that <keyname> is base64 encoded.""" def __init__(self, device, timeout=10, smartos_type=None): s = super(JoyentMetadataLegacySerialClient, self) s.__init__(device, timeout, smartos_type) self.base64_keys = None self.base64_all = None def _init_base64_keys(self, reset=False): if reset: self.base64_keys = None self.base64_all = None keys = None if self.base64_all is None: keys = self.list() if "base64_all" in keys: self.base64_all = util.is_true(self._get("base64_all")) else: self.base64_all = False if self.base64_all: # short circuit if base64_all is true return if self.base64_keys is None: if keys is None: keys = self.list() b64_keys = set() if "base64_keys" in keys: b64_keys = set(self._get("base64_keys").split(",")) # now add any b64-<keyname> that has a true value for key in [k[3:] for k in keys if k.startswith("b64-")]: if util.is_true(self._get(key)): b64_keys.add(key) else: if key in b64_keys: b64_keys.remove(key) self.base64_keys = b64_keys def _get(self, key, default=None, strip=False): return super(JoyentMetadataLegacySerialClient, self).get( key, default=default, strip=strip ) def is_b64_encoded(self, key, reset=False): if key in NO_BASE64_DECODE: return False self._init_base64_keys(reset=reset) if self.base64_all: return True return key in self.base64_keys def get(self, key, default=None, strip=False): mdefault = object() val = self._get(key, strip=False, default=mdefault) if val is mdefault: return default if self.is_b64_encoded(key): try: val = base64.b64decode(val.encode()).decode() except binascii.Error: LOG.warning("Failed base64 decoding key '%s': %s", key, val) if strip: val = val.strip() return val def jmc_client_factory( smartos_type=None, metadata_sockfile=METADATA_SOCKFILE, serial_device=SERIAL_DEVICE, serial_timeout=SERIAL_TIMEOUT, uname_version=None, ): if smartos_type is None: smartos_type = get_smartos_environ(uname_version) if smartos_type is None: return None elif smartos_type == SMARTOS_ENV_KVM: return JoyentMetadataLegacySerialClient( device=serial_device, timeout=serial_timeout, smartos_type=smartos_type, ) elif smartos_type == SMARTOS_ENV_LX_BRAND: return JoyentMetadataSocketClient( socketpath=metadata_sockfile, smartos_type=smartos_type ) raise ValueError("Unknown value for smartos_type: %s" % smartos_type) def identify_file(content_f): cmd = ["file", "--brief", "--mime-type", content_f] f_type = None try: (f_type, _err) = subp.subp(cmd) LOG.debug("script %s mime type is %s", content_f, f_type) except subp.ProcessExecutionError as e: util.logexc( LOG, ("Failed to identify script type for %s" % content_f, e) ) return None if f_type is None else f_type.strip() def write_boot_content( content, content_f, link=None, shebang=False, mode=0o400 ): """ Write the content to content_f. Under the following rules: 1. If no content, remove the file 2. Write the content 3. If executable and no file magic, add it 4. If there is a link, create it @param content: what to write @param content_f: the file name @param backup_d: the directory to save the backup at @param link: if defined, location to create a symlink to @param shebang: if no file magic, set shebang @param mode: file mode Becuase of the way that Cloud-init executes scripts (no shell), a script will fail to execute if does not have a magic bit (shebang) set for the file. If shebang=True, then the script will be checked for a magic bit and to the SmartOS default of assuming that bash. """ if not content and os.path.exists(content_f): os.unlink(content_f) if link and os.path.islink(link): os.unlink(link) if not content: return util.write_file(content_f, content, mode=mode) if shebang and not content.startswith("#!"): f_type = identify_file(content_f) if f_type == "text/plain": util.write_file( content_f, "\n".join(["#!/bin/bash", content]), mode=mode ) LOG.debug("added shebang to file %s", content_f) if link: try: if os.path.islink(link): os.unlink(link) if content and os.path.exists(content_f): util.ensure_dir(os.path.dirname(link)) os.symlink(content_f, link) except IOError as e: util.logexc(LOG, "failed establishing content link: %s", e) def get_smartos_environ(uname_version=None, product_name=None): uname = os.uname() # SDC LX-Brand Zones lack dmidecode (no /dev/mem) but # report 'BrandZ virtual linux' as the kernel version if uname_version is None: uname_version = uname[3] if uname_version == "BrandZ virtual linux": return SMARTOS_ENV_LX_BRAND if product_name is None: system_type = dmi.read_dmi_data("system-product-name") else: system_type = product_name if system_type and system_type.startswith("SmartDC"): return SMARTOS_ENV_KVM return None # Convert SMARTOS 'sdc:nics' data to network_config yaml def convert_smartos_network_data( network_data=None, dns_servers=None, dns_domain=None, routes=None ): """Return a dictionary of network_config by parsing provided SMARTOS sdc:nics configuration data sdc:nics data is a dictionary of properties of a nic and the ip configuration desired. Additional nic dictionaries are appended to the list. Converting the format is straightforward though it does include duplicate information as well as data which appears to be relevant to the hostOS rather than the guest. For each entry in the nics list returned from query sdc:nics, we create a type: physical entry, and extract the interface properties: 'mac' -> 'mac_address', 'mtu', 'interface' -> 'name'. The remaining keys are related to ip configuration. For each ip in the 'ips' list we create a subnet entry under 'subnets' pairing the ip to a one in the 'gateways' list. Each route in sdc:routes is mapped to a route on each interface. The sdc:routes properties 'dst' and 'gateway' map to 'network' and 'gateway'. The 'linklocal' sdc:routes property is ignored. """ valid_keys = { "physical": [ "mac_address", "mtu", "name", "params", "subnets", "type", ], "subnet": [ "address", "broadcast", "dns_nameservers", "dns_search", "metric", "pointopoint", "routes", "scope", "type", ], "route": [ "network", "gateway", ], } if dns_servers: if not isinstance(dns_servers, (list, tuple)): dns_servers = [dns_servers] else: dns_servers = [] if dns_domain: if not isinstance(dns_domain, (list, tuple)): dns_domain = [dns_domain] else: dns_domain = [] if not routes: routes = [] def is_valid_ipv4(addr): return "." in addr def is_valid_ipv6(addr): return ":" in addr pgws = { "ipv4": {"match": is_valid_ipv4, "gw": None}, "ipv6": {"match": is_valid_ipv6, "gw": None}, } config = [] for nic in network_data: cfg = dict( (k, v) for k, v in nic.items() if k in valid_keys["physical"] ) cfg.update({"type": "physical", "name": nic["interface"]}) if "mac" in nic: cfg.update({"mac_address": nic["mac"]}) subnets = [] for ip in nic.get("ips", []): if ip == "dhcp": subnet = {"type": "dhcp4"} else: routeents = [] subnet = dict( (k, v) for k, v in nic.items() if k in valid_keys["subnet"] ) subnet.update( { "type": "static", "address": ip, } ) proto = "ipv4" if is_valid_ipv4(ip) else "ipv6" # Only use gateways for 'primary' nics if "primary" in nic and nic.get("primary", False): # the ips and gateways list may be N to M, here # we map the ip index into the gateways list, # and handle the case that we could have more ips # than gateways. we only consume the first gateway if not pgws[proto]["gw"]: gateways = [ gw for gw in nic.get("gateways", []) if pgws[proto]["match"](gw) ] if len(gateways): pgws[proto]["gw"] = gateways[0] subnet.update({"gateway": pgws[proto]["gw"]}) for route in routes: rcfg = dict( (k, v) for k, v in route.items() if k in valid_keys["route"] ) # Linux uses the value of 'gateway' to determine # automatically if the route is a forward/next-hop # (non-local IP for gateway) or an interface/resolver # (local IP for gateway). So we can ignore the # 'interface' attribute of sdc:routes, because SDC # guarantees that the gateway is a local IP for # "interface=true". # # Eventually we should be smart and compare "gateway" # to see if it's in the prefix. We can then smartly # add or not-add this route. But for now, # when in doubt, use brute force! Routes for everyone! rcfg.update({"network": route["dst"]}) routeents.append(rcfg) subnet.update({"routes": routeents}) subnets.append(subnet) cfg.update({"subnets": subnets}) config.append(cfg) if dns_servers: config.append( { "type": "nameserver", "address": dns_servers, "search": dns_domain, } ) return {"version": 1, "config": config} # Used to match classes to dependencies datasources = [ (DataSourceSmartOS, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) if __name__ == "__main__": import sys jmc = jmc_client_factory() if jmc is None: print("Do not appear to be on smartos.") sys.exit(1) if len(sys.argv) == 1: keys = ( list(SMARTOS_ATTRIB_JSON.keys()) + list(SMARTOS_ATTRIB_MAP.keys()) + ["network_config"] ) else: keys = sys.argv[1:] def load_key(client, key, data): if key in data: return data[key] if key in SMARTOS_ATTRIB_JSON: keyname = SMARTOS_ATTRIB_JSON[key] data[key] = client.get_json(keyname) elif key == "network_config": for depkey in ( "network-data", "dns_servers", "dns_domain", "routes", ): load_key(client, depkey, data) data[key] = convert_smartos_network_data( network_data=data["network-data"], dns_servers=data["dns_servers"], dns_domain=data["dns_domain"], routes=data["routes"], ) else: if key in SMARTOS_ATTRIB_MAP: keyname, strip = SMARTOS_ATTRIB_MAP[key] else: keyname, strip = (key, False) data[key] = client.get(keyname, strip=strip) return data[key] data: dict = {} for key in keys: load_key(client=jmc, key=key, data=data) print(json.dumps(data, indent=1, sort_keys=True, separators=(",", ": "))) # vi: ts=4 expandtab DataSourceOpenStack.py 0000644 00000024755 15027667240 0011006 0 ustar 00 # Copyright (C) 2014 Yahoo! Inc. # # Author: Joshua Harlow <harlowja@yahoo-inc.com> # # This file is part of cloud-init. See LICENSE file for license information. import time from cloudinit import dmi from cloudinit import log as logging from cloudinit import sources, url_helper, util from cloudinit.event import EventScope, EventType from cloudinit.net.dhcp import NoDHCPLeaseError from cloudinit.net.ephemeral import EphemeralDHCPv4 from cloudinit.sources import DataSourceOracle as oracle from cloudinit.sources.helpers import openstack LOG = logging.getLogger(__name__) # Various defaults/constants... DEF_MD_URLS = ["http://[fe80::a9fe:a9fe]", "http://169.254.169.254"] DEFAULT_IID = "iid-dsopenstack" DEFAULT_METADATA = { "instance-id": DEFAULT_IID, } # OpenStack DMI constants DMI_PRODUCT_NOVA = "OpenStack Nova" DMI_PRODUCT_COMPUTE = "OpenStack Compute" VALID_DMI_PRODUCT_NAMES = [DMI_PRODUCT_NOVA, DMI_PRODUCT_COMPUTE] DMI_ASSET_TAG_OPENTELEKOM = "OpenTelekomCloud" # See github.com/sapcc/helm-charts/blob/master/openstack/nova/values.yaml # -> compute.defaults.vmware.smbios_asset_tag for this value DMI_ASSET_TAG_SAPCCLOUD = "SAP CCloud VM" DMI_ASSET_TAG_HUAWEICLOUD = "HUAWEICLOUD" VALID_DMI_ASSET_TAGS = VALID_DMI_PRODUCT_NAMES VALID_DMI_ASSET_TAGS += [ DMI_ASSET_TAG_HUAWEICLOUD, DMI_ASSET_TAG_OPENTELEKOM, DMI_ASSET_TAG_SAPCCLOUD, ] class DataSourceOpenStack(openstack.SourceMixin, sources.DataSource): dsname = "OpenStack" _network_config = sources.UNSET # Used to cache calculated network cfg v1 # Whether we want to get network configuration from the metadata service. perform_dhcp_setup = False supported_update_events = { EventScope.NETWORK: { EventType.BOOT_NEW_INSTANCE, EventType.BOOT, EventType.BOOT_LEGACY, EventType.HOTPLUG, } } def __init__(self, sys_cfg, distro, paths): super(DataSourceOpenStack, self).__init__(sys_cfg, distro, paths) self.metadata_address = None self.ssl_details = util.fetch_ssl_details(self.paths) self.version = None self.files = {} self.ec2_metadata = sources.UNSET self.network_json = sources.UNSET def __str__(self): root = sources.DataSource.__str__(self) mstr = "%s [%s,ver=%s]" % (root, self.dsmode, self.version) return mstr def wait_for_metadata_service(self): urls = self.ds_cfg.get("metadata_urls", DEF_MD_URLS) filtered = [x for x in urls if util.is_resolvable_url(x)] if set(filtered) != set(urls): LOG.debug( "Removed the following from metadata urls: %s", list((set(urls) - set(filtered))), ) if len(filtered): urls = filtered else: LOG.warning("Empty metadata url list! using default list") urls = DEF_MD_URLS md_urls = [] url2base = {} for url in urls: md_url = url_helper.combine_url(url, "openstack") md_urls.append(md_url) url2base[md_url] = url url_params = self.get_url_params() start_time = time.time() avail_url, _response = url_helper.wait_for_url( urls=md_urls, max_wait=url_params.max_wait_seconds, timeout=url_params.timeout_seconds, connect_synchronously=False, ) if avail_url: LOG.debug("Using metadata source: '%s'", url2base[avail_url]) else: LOG.debug( "Giving up on OpenStack md from %s after %s seconds", md_urls, int(time.time() - start_time), ) self.metadata_address = url2base.get(avail_url) return bool(avail_url) def check_instance_id(self, sys_cfg): # quickly (local check only) if self.instance_id is still valid return sources.instance_id_matches_system_uuid(self.get_instance_id()) @property def network_config(self): """Return a network config dict for rendering ENI or netplan files.""" if self._network_config != sources.UNSET: return self._network_config # RELEASE_BLOCKER: SRU to Xenial and Artful SRU should not provide # network_config by default unless configured in /etc/cloud/cloud.cfg*. # Patch Xenial and Artful before release to default to False. if util.is_false(self.ds_cfg.get("apply_network_config", True)): self._network_config = None return self._network_config if self.network_json == sources.UNSET: # this would happen if get_data hadn't been called. leave as UNSET LOG.warning( "Unexpected call to network_config when network_json is None." ) return None LOG.debug("network config provided via network_json") self._network_config = openstack.convert_net_json( self.network_json, known_macs=None ) return self._network_config def _get_data(self): """Crawl metadata, parse and persist that data for this instance. @return: True when metadata discovered indicates OpenStack datasource. False when unable to contact metadata service or when metadata format is invalid or disabled. """ if self.perform_dhcp_setup: # Setup networking in init-local stage. try: with EphemeralDHCPv4( self.fallback_interface, tmp_dir=self.distro.get_tmp_exec_path(), ): results = util.log_time( logfunc=LOG.debug, msg="Crawl of metadata service", func=self._crawl_metadata, ) except (NoDHCPLeaseError, sources.InvalidMetaDataException) as e: util.logexc(LOG, str(e)) return False else: try: results = self._crawl_metadata() except sources.InvalidMetaDataException as e: util.logexc(LOG, str(e)) return False self.dsmode = self._determine_dsmode([results.get("dsmode")]) if self.dsmode == sources.DSMODE_DISABLED: return False md = results.get("metadata", {}) md = util.mergemanydict([md, DEFAULT_METADATA]) self.metadata = md self.ec2_metadata = results.get("ec2-metadata") self.network_json = results.get("networkdata") self.userdata_raw = results.get("userdata") self.version = results["version"] self.files.update(results.get("files", {})) vd = results.get("vendordata") self.vendordata_pure = vd try: self.vendordata_raw = sources.convert_vendordata(vd) except ValueError as e: LOG.warning("Invalid content in vendor-data: %s", e) self.vendordata_raw = None vd2 = results.get("vendordata2") self.vendordata2_pure = vd2 try: self.vendordata2_raw = sources.convert_vendordata(vd2) except ValueError as e: LOG.warning("Invalid content in vendor-data2: %s", e) self.vendordata2_raw = None return True def _crawl_metadata(self): """Crawl metadata service when available. @returns: Dictionary with all metadata discovered for this datasource. @raise: InvalidMetaDataException on unreadable or broken metadata. """ try: if not self.wait_for_metadata_service(): raise sources.InvalidMetaDataException( "No active metadata service found" ) except IOError as e: raise sources.InvalidMetaDataException( "IOError contacting metadata service: {error}".format( error=str(e) ) ) url_params = self.get_url_params() try: result = util.log_time( LOG.debug, "Crawl of openstack metadata service", read_metadata_service, args=[self.metadata_address], kwargs={ "ssl_details": self.ssl_details, "retries": url_params.num_retries, "timeout": url_params.timeout_seconds, }, ) except openstack.NonReadable as e: raise sources.InvalidMetaDataException(str(e)) except (openstack.BrokenMetadata, IOError) as e: msg = "Broken metadata address {addr}".format( addr=self.metadata_address ) raise sources.InvalidMetaDataException(msg) from e return result def ds_detect(self): """Return True when a potential OpenStack platform is detected.""" accept_oracle = "Oracle" in self.sys_cfg.get("datasource_list") if not util.is_x86(): # Non-Intel cpus don't properly report dmi product names return True product_name = dmi.read_dmi_data("system-product-name") if product_name in VALID_DMI_PRODUCT_NAMES: return True elif dmi.read_dmi_data("chassis-asset-tag") in VALID_DMI_ASSET_TAGS: return True elif accept_oracle and oracle._is_platform_viable(): return True elif util.get_proc_env(1).get("product_name") == DMI_PRODUCT_NOVA: return True return False class DataSourceOpenStackLocal(DataSourceOpenStack): """Run in init-local using a dhcp discovery prior to metadata crawl. In init-local, no network is available. This subclass sets up minimal networking with dhclient on a viable nic so that it can talk to the metadata service. If the metadata service provides network configuration then render the network configuration for that instance based on metadata. """ perform_dhcp_setup = True # Get metadata network config if present def read_metadata_service(base_url, ssl_details=None, timeout=5, retries=5): reader = openstack.MetadataReader( base_url, ssl_details=ssl_details, timeout=timeout, retries=retries ) return reader.read_v2() # Used to match classes to dependencies datasources = [ (DataSourceOpenStackLocal, (sources.DEP_FILESYSTEM,)), (DataSourceOpenStack, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceIBMCloud.py 0000644 00000034067 15027667240 0010512 0 ustar 00 # This file is part of cloud-init. See LICENSE file for license information. """Datasource for IBMCloud. IBMCloud is also know as SoftLayer or BlueMix. IBMCloud hypervisor is xen (2018-03-10). There are 2 different api exposed launch methods. * template: This is the legacy method of launching instances. When booting from an image template, the system boots first into a "provisioning" mode. There, host <-> guest mechanisms are utilized to execute code in the guest and configure it. The configuration includes configuring the system network and possibly installing packages and other software stack. After the provisioning is finished, the system reboots. * os_code: Essentially "launch by OS Code" (Operating System Code). This is a more modern approach. There is no specific "provisioning" boot. Instead, cloud-init does all the customization. With or without user-data provided, an OpenStack ConfigDrive like disk is attached. Only disks with label 'config-2' and UUID '9796-932E' are considered. This is to avoid this datasource claiming ConfigDrive. This does mean that 1 in 8^16 (~4 billion) Xen ConfigDrive systems will be incorrectly identified as IBMCloud. The combination of these 2 launch methods and with or without user-data creates 6 boot scenarios. A. os_code with user-data B. os_code without user-data Cloud-init is fully operational in this mode. There is a block device attached with label 'config-2'. As it differs from OpenStack's config-2, we have to differentiate. We do so by requiring the UUID on the filesystem to be "9796-932E". This disk will have the following files. Specifically note, there is no versioned path to the meta-data, only 'latest': openstack/latest/meta_data.json openstack/latest/network_data.json openstack/latest/user_data [optional] openstack/latest/vendor_data.json vendor_data.json as of 2018-04 looks like this: {"cloud-init":"#!/bin/bash\necho 'root:$6$<snip>' | chpasswd -e"} The only difference between A and B in this mode is the presence of user_data on the config disk. C. template, provisioning boot with user-data D. template, provisioning boot without user-data. With ds-identify cloud-init is fully disabled in this mode. Without ds-identify, cloud-init None datasource will be used. This is currently identified by the presence of /root/provisioningConfiguration.cfg . That file is placed into the system before it is booted. The difference between C and D is the presence of the METADATA disk as described in E below. There is no METADATA disk attached unless user-data is provided. E. template, post-provisioning boot with user-data. Cloud-init is fully operational in this mode. This is identified by a block device with filesystem label "METADATA". The looks similar to a version-1 OpenStack config drive. It will have the following files: openstack/latest/user_data openstack/latest/meta_data.json openstack/content/interfaces meta.js meta.js contains something similar to user_data. cloud-init ignores it. cloud-init ignores the 'interfaces' style file here. In this mode, cloud-init has networking code disabled. It relies on the provisioning boot to have configured networking. F. template, post-provisioning boot without user-data. With ds-identify, cloud-init will be fully disabled. Without ds-identify, cloud-init None datasource will be used. There is no information available to identify this scenario. The user will be able to SSH in as as root with their public keys that have been installed into /root/ssh/.authorized_keys during the provisioning stage. TODO: * is uuid (/sys/hypervisor/uuid) stable for life of an instance? it seems it is not the same as data's uuid in the os_code case but is in the template case. """ import base64 import json import os from cloudinit import log as logging from cloudinit import sources, subp, util from cloudinit.sources.helpers import openstack LOG = logging.getLogger(__name__) IBM_CONFIG_UUID = "9796-932E" class Platforms: TEMPLATE_LIVE_METADATA = "Template/Live/Metadata" TEMPLATE_LIVE_NODATA = "UNABLE TO BE IDENTIFIED." TEMPLATE_PROVISIONING_METADATA = "Template/Provisioning/Metadata" TEMPLATE_PROVISIONING_NODATA = "Template/Provisioning/No-Metadata" OS_CODE = "OS-Code/Live" PROVISIONING = ( Platforms.TEMPLATE_PROVISIONING_METADATA, Platforms.TEMPLATE_PROVISIONING_NODATA, ) class DataSourceIBMCloud(sources.DataSource): dsname = "IBMCloud" system_uuid = None def __init__(self, sys_cfg, distro, paths): super(DataSourceIBMCloud, self).__init__(sys_cfg, distro, paths) self.source = None self._network_config = None self.network_json = None self.platform = None def __str__(self): root = super(DataSourceIBMCloud, self).__str__() mstr = "%s [%s %s]" % (root, self.platform, self.source) return mstr def _get_data(self): results = read_md() if results is None: return False self.source = results["source"] self.platform = results["platform"] self.metadata = results["metadata"] self.userdata_raw = results.get("userdata") self.network_json = results.get("networkdata") vd = results.get("vendordata") self.vendordata_pure = vd self.system_uuid = results["system-uuid"] try: self.vendordata_raw = sources.convert_vendordata(vd) except ValueError as e: LOG.warning("Invalid content in vendor-data: %s", e) self.vendordata_raw = None return True def _get_subplatform(self): """Return the subplatform metadata source details.""" return "%s (%s)" % (self.platform, self.source) def check_instance_id(self, sys_cfg): """quickly (local check only) if self.instance_id is still valid in Template mode, the system uuid (/sys/hypervisor/uuid) is the same as found in the METADATA disk. But that is not true in OS_CODE mode. So we read the system_uuid and keep that for later compare.""" if self.system_uuid is None: return False return self.system_uuid == _read_system_uuid() @property def network_config(self): if self.platform != Platforms.OS_CODE: # If deployed from template, an agent in the provisioning # environment handles networking configuration. Not cloud-init. return {"config": "disabled", "version": 1} if self._network_config is None: if self.network_json is not None: LOG.debug("network config provided via network_json") self._network_config = openstack.convert_net_json( self.network_json, known_macs=None ) else: LOG.debug("no network configuration available.") return self._network_config def _read_system_uuid(): uuid_path = "/sys/hypervisor/uuid" if not os.path.isfile(uuid_path): return None return util.load_file(uuid_path).strip().lower() def _is_xen(): return os.path.exists("/proc/xen") def _is_ibm_provisioning( prov_cfg="/root/provisioningConfiguration.cfg", inst_log="/root/swinstall.log", boot_ref="/proc/1/environ", ): """Return boolean indicating if this boot is ibm provisioning boot.""" if os.path.exists(prov_cfg): msg = "config '%s' exists." % prov_cfg result = True if os.path.exists(inst_log): if os.path.exists(boot_ref): result = ( os.stat(inst_log).st_mtime > os.stat(boot_ref).st_mtime ) msg += " log '%s' from %s boot." % ( inst_log, "current" if result else "previous", ) else: msg += " log '%s' existed, but no reference file '%s'." % ( inst_log, boot_ref, ) result = False else: msg += " log '%s' did not exist." % inst_log else: result, msg = (False, "config '%s' did not exist." % prov_cfg) LOG.debug("ibm_provisioning=%s: %s", result, msg) return result def get_ibm_platform(): """Return a tuple (Platform, path) If this is Not IBM cloud, then the return value is (None, None). An instance in provisioning mode is considered running on IBM cloud.""" label_mdata = "METADATA" label_cfg2 = "CONFIG-2" not_found = (None, None) if not _is_xen(): return not_found # fslabels contains only the first entry with a given label. fslabels = {} try: devs = util.blkid() except subp.ProcessExecutionError as e: LOG.warning("Failed to run blkid: %s", e) return (None, None) for dev in sorted(devs.keys()): data = devs[dev] label = data.get("LABEL", "").upper() uuid = data.get("UUID", "").upper() if label not in (label_mdata, label_cfg2): continue if label in fslabels: LOG.warning( "Duplicate fslabel '%s'. existing=%s current=%s", label, fslabels[label], data, ) continue if label == label_cfg2 and uuid != IBM_CONFIG_UUID: LOG.debug( "Skipping %s with LABEL=%s due to uuid != %s: %s", dev, label, uuid, data, ) continue fslabels[label] = data metadata_path = fslabels.get(label_mdata, {}).get("DEVNAME") cfg2_path = fslabels.get(label_cfg2, {}).get("DEVNAME") if cfg2_path: return (Platforms.OS_CODE, cfg2_path) elif metadata_path: if _is_ibm_provisioning(): return (Platforms.TEMPLATE_PROVISIONING_METADATA, metadata_path) else: return (Platforms.TEMPLATE_LIVE_METADATA, metadata_path) elif _is_ibm_provisioning(): return (Platforms.TEMPLATE_PROVISIONING_NODATA, None) return not_found def read_md(): """Read data from IBM Cloud. @return: None if not running on IBM Cloud. dictionary with guaranteed fields: metadata, version and optional fields: userdata, vendordata, networkdata. Also includes the system uuid from /sys/hypervisor/uuid.""" platform, path = get_ibm_platform() if platform is None: LOG.debug("This is not an IBMCloud platform.") return None elif platform in PROVISIONING: LOG.debug("Cloud-init is disabled during provisioning: %s.", platform) return None ret = { "platform": platform, "source": path, "system-uuid": _read_system_uuid(), } try: if os.path.isdir(path): results = metadata_from_dir(path) else: results = util.mount_cb(path, metadata_from_dir) except sources.BrokenMetadata as e: raise RuntimeError( "Failed reading IBM config disk (platform=%s path=%s): %s" % (platform, path, e) ) from e ret.update(results) return ret def metadata_from_dir(source_dir): """Walk source_dir extracting standardized metadata. Certain metadata keys are renamed to present a standardized set of metadata keys. This function has a lot in common with ConfigDriveReader.read_v2 but there are a number of inconsistencies, such key renames and as only presenting a 'latest' version which make it an unlikely candidate to share code. @return: Dict containing translated metadata, userdata, vendordata, networkdata as present. """ def opath(fname): return os.path.join("openstack", "latest", fname) def load_json_bytes(blob): return json.loads(blob.decode("utf-8")) files = [ # tuples of (results_name, path, translator) ("metadata_raw", opath("meta_data.json"), load_json_bytes), ("userdata", opath("user_data"), None), ("vendordata", opath("vendor_data.json"), load_json_bytes), ("networkdata", opath("network_data.json"), load_json_bytes), ] results = {} for (name, path, transl) in files: fpath = os.path.join(source_dir, path) raw = None try: raw = util.load_file(fpath, decode=False) except IOError as e: LOG.debug("Failed reading path '%s': %s", fpath, e) if raw is None or transl is None: data = raw else: try: data = transl(raw) except Exception as e: raise sources.BrokenMetadata( "Failed decoding %s: %s" % (path, e) ) results[name] = data if results.get("metadata_raw") is None: raise sources.BrokenMetadata( "%s missing required file 'meta_data.json'" % source_dir ) results["metadata"] = {} md_raw = results["metadata_raw"] md = results["metadata"] if "random_seed" in md_raw: try: md["random_seed"] = base64.b64decode(md_raw["random_seed"]) except (ValueError, TypeError) as e: raise sources.BrokenMetadata( "Badly formatted metadata random_seed entry: %s" % e ) renames = ( ("public_keys", "public-keys"), ("hostname", "local-hostname"), ("uuid", "instance-id"), ) for mdname, newname in renames: if mdname in md_raw: md[newname] = md_raw[mdname] return results # Used to match classes to dependencies datasources = [ (DataSourceIBMCloud, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) if __name__ == "__main__": import argparse parser = argparse.ArgumentParser(description="Query IBM Cloud Metadata") args = parser.parse_args() data = read_md() print(util.json_dumps(data)) # vi: ts=4 expandtab DataSourceAltCloud.py 0000644 00000020451 15027667240 0010613 0 ustar 00 # Copyright (C) 2009-2010 Canonical Ltd. # Copyright (C) 2012, 2013 Hewlett-Packard Development Company, L.P. # Copyright (C) 2012 Yahoo! Inc. # # Author: Joe VLcek <JVLcek@RedHat.com> # Author: Juerg Haefliger <juerg.haefliger@hp.com> # # This file is part of cloud-init. See LICENSE file for license information. """ This file contains code used to gather the user data passed to an instance on RHEVm and vSphere. """ import errno import os import os.path from cloudinit import dmi from cloudinit import log as logging from cloudinit import sources, subp, util LOG = logging.getLogger(__name__) # Needed file paths CLOUD_INFO_FILE = "/etc/sysconfig/cloud-info" # Shell command lists CMD_PROBE_FLOPPY = ["modprobe", "floppy"] META_DATA_NOT_SUPPORTED = { "block-device-mapping": {}, "instance-id": 455, "local-hostname": "localhost", "placement": {}, } def read_user_data_callback(mount_dir): """ Description: This callback will be applied by util.mount_cb() on the mounted file. Deltacloud file name contains deltacloud. Those not using Deltacloud but instead instrumenting the injection, could drop deltacloud from the file name. Input: mount_dir - Mount directory Returns: User Data """ deltacloud_user_data_file = mount_dir + "/deltacloud-user-data.txt" user_data_file = mount_dir + "/user-data.txt" # First try deltacloud_user_data_file. On failure try user_data_file. try: user_data = util.load_file(deltacloud_user_data_file).strip() except IOError: try: user_data = util.load_file(user_data_file).strip() except IOError: util.logexc(LOG, "Failed accessing user data file.") return None return user_data class DataSourceAltCloud(sources.DataSource): dsname = "AltCloud" def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.seed = None self.supported_seed_starts = ("/", "file://") def __str__(self): root = sources.DataSource.__str__(self) return "%s [seed=%s]" % (root, self.seed) def get_cloud_type(self): """ Description: Get the type for the cloud back end this instance is running on by examining the string returned by reading either: CLOUD_INFO_FILE or the dmi data. Input: None Returns: One of the following strings: 'RHEV', 'VSPHERE' or 'UNKNOWN' """ if os.path.exists(CLOUD_INFO_FILE): try: cloud_type = util.load_file(CLOUD_INFO_FILE).strip().upper() except IOError: util.logexc( LOG, "Unable to access cloud info file at %s.", CLOUD_INFO_FILE, ) return "UNKNOWN" return cloud_type system_name = dmi.read_dmi_data("system-product-name") if not system_name: return "UNKNOWN" sys_name = system_name.upper() if sys_name.startswith("RHEV"): return "RHEV" if sys_name.startswith("VMWARE"): return "VSPHERE" return "UNKNOWN" def _get_data(self): """ Description: User Data is passed to the launching instance which is used to perform instance configuration. Cloud providers expose the user data differently. It is necessary to determine which cloud provider the current instance is running on to determine how to access the user data. Images built with image factory will contain a CLOUD_INFO_FILE which contains a string identifying the cloud provider. Images not built with Imagefactory will try to determine what the cloud provider is based on system information. """ LOG.debug("Invoked get_data()") cloud_type = self.get_cloud_type() LOG.debug("cloud_type: %s", str(cloud_type)) if "RHEV" in cloud_type: if self.user_data_rhevm(): return True elif "VSPHERE" in cloud_type: if self.user_data_vsphere(): return True else: # there was no recognized alternate cloud type # indicating this handler should not be used. return False # No user data found util.logexc(LOG, "Failed accessing user data.") return False def _get_subplatform(self): """Return the subplatform metadata details.""" cloud_type = self.get_cloud_type() if not hasattr(self, "source"): self.source = sources.METADATA_UNKNOWN if cloud_type == "RHEV": self.source = "/dev/fd0" return "%s (%s)" % (cloud_type.lower(), self.source) def user_data_rhevm(self): """ RHEVM specific userdata read If on RHEV-M the user data will be contained on the floppy device in file <user_data_file> To access it: modprobe floppy Leverage util.mount_cb to: mkdir <tmp mount dir> mount /dev/fd0 <tmp mount dir> The call back passed to util.mount_cb will do: read <tmp mount dir>/<user_data_file> """ return_str = None # modprobe floppy try: modprobe_floppy() except subp.ProcessExecutionError as e: util.logexc(LOG, "Failed modprobe: %s", e) return False floppy_dev = "/dev/fd0" # udevadm settle for floppy device try: util.udevadm_settle(exists=floppy_dev, timeout=5) except (subp.ProcessExecutionError, OSError) as e: util.logexc(LOG, "Failed udevadm_settle: %s\n", e) return False try: return_str = util.mount_cb(floppy_dev, read_user_data_callback) except OSError as err: if err.errno != errno.ENOENT: raise except util.MountFailedError: util.logexc( LOG, "Failed to mount %s when looking for user data", floppy_dev, ) self.userdata_raw = return_str self.metadata = META_DATA_NOT_SUPPORTED if return_str: return True else: return False def user_data_vsphere(self): """ vSphere specific userdata read If on vSphere the user data will be contained on the cdrom device in file <user_data_file> To access it: Leverage util.mount_cb to: mkdir <tmp mount dir> mount /dev/fd0 <tmp mount dir> The call back passed to util.mount_cb will do: read <tmp mount dir>/<user_data_file> """ return_str = None cdrom_list = util.find_devs_with("LABEL=CDROM") for cdrom_dev in cdrom_list: try: return_str = util.mount_cb(cdrom_dev, read_user_data_callback) if return_str: self.source = cdrom_dev break except OSError as err: if err.errno != errno.ENOENT: raise except util.MountFailedError: util.logexc( LOG, "Failed to mount %s when looking for user data", cdrom_dev, ) self.userdata_raw = return_str self.metadata = META_DATA_NOT_SUPPORTED if return_str: return True else: return False def modprobe_floppy(): out, _err = subp.subp(CMD_PROBE_FLOPPY) LOG.debug("Command: %s\nOutput%s", " ".join(CMD_PROBE_FLOPPY), out) # Used to match classes to dependencies # Source DataSourceAltCloud does not really depend on networking. # In the future 'dsmode' like behavior can be added to offer user # the ability to run before networking. datasources = [ (DataSourceAltCloud, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceScaleway.py 0000644 00000022735 15027667240 0010663 0 ustar 00 # Author: Julien Castets <castets.j@gmail.com> # # This file is part of cloud-init. See LICENSE file for license information. # Scaleway API: # https://developer.scaleway.com/#metadata import json import os import socket import time import requests # Note: `urllib3` is transitively installed by `requests` from urllib3.connection import HTTPConnection from urllib3.poolmanager import PoolManager from cloudinit import dmi from cloudinit import log as logging from cloudinit import net, sources, url_helper, util from cloudinit.event import EventScope, EventType from cloudinit.net.dhcp import NoDHCPLeaseError from cloudinit.net.ephemeral import EphemeralDHCPv4 from cloudinit.sources import DataSourceHostname LOG = logging.getLogger(__name__) DS_BASE_URL = "http://169.254.42.42" BUILTIN_DS_CONFIG = { "metadata_url": DS_BASE_URL + "/conf?format=json", "userdata_url": DS_BASE_URL + "/user_data/cloud-init", "vendordata_url": DS_BASE_URL + "/vendor_data/cloud-init", } DEF_MD_RETRIES = 5 DEF_MD_TIMEOUT = 10 def on_scaleway(): """ There are three ways to detect if you are on Scaleway: * check DMI data: not yet implemented by Scaleway, but the check is made to be future-proof. * the initrd created the file /var/run/scaleway. * "scaleway" is in the kernel cmdline. """ vendor_name = dmi.read_dmi_data("system-manufacturer") if vendor_name == "Scaleway": return True if os.path.exists("/var/run/scaleway"): return True cmdline = util.get_cmdline() if "scaleway" in cmdline: return True return False class SourceAddressAdapter(requests.adapters.HTTPAdapter): """ Adapter for requests to choose the local address to bind to. """ def __init__(self, source_address, **kwargs): self.source_address = source_address super(SourceAddressAdapter, self).__init__(**kwargs) def init_poolmanager(self, connections, maxsize, block=False): socket_options = HTTPConnection.default_socket_options + [ (socket.SOL_SOCKET, socket.SO_REUSEPORT, 1) ] self.poolmanager = PoolManager( num_pools=connections, maxsize=maxsize, block=block, source_address=self.source_address, socket_options=socket_options, ) def query_data_api_once(api_address, timeout, requests_session): """ Retrieve user data or vendor data. Scaleway user/vendor data API returns HTTP/404 if user/vendor data is not set. This function calls `url_helper.readurl` but instead of considering HTTP/404 as an error that requires a retry, it considers it as empty user/vendor data. Also, be aware the user data/vendor API requires the source port to be below 1024 to ensure the client is root (since non-root users can't bind ports below 1024). If requests raises ConnectionError (EADDRINUSE), the caller should retry to call this function on an other port. """ try: resp = url_helper.readurl( api_address, data=None, timeout=timeout, # It's the caller's responsability to recall this function in case # of exception. Don't let url_helper.readurl() retry by itself. retries=0, session=requests_session, # If the error is a HTTP/404 or a ConnectionError, go into raise # block below and don't bother retrying. exception_cb=lambda _, exc: exc.code != 404 and ( not isinstance(exc.cause, requests.exceptions.ConnectionError) ), ) return util.decode_binary(resp.contents) except url_helper.UrlError as exc: # Empty user data. if exc.code == 404: return None raise def query_data_api(api_type, api_address, retries, timeout): """Get user or vendor data. Handle the retrying logic in case the source port is used. Scaleway metadata service requires the source port of the client to be a privileged port (<1024). This is done to ensure that only a privileged user on the system can access the metadata service. """ # Query user/vendor data. Try to make a request on the first privileged # port available. for port in range(1, max(retries, 2)): try: LOG.debug( "Trying to get %s data (bind on port %d)...", api_type, port ) requests_session = requests.Session() requests_session.mount( "http://", SourceAddressAdapter(source_address=("0.0.0.0", port)), ) data = query_data_api_once( api_address, timeout=timeout, requests_session=requests_session ) LOG.debug("%s-data downloaded", api_type) return data except url_helper.UrlError as exc: # Local port already in use or HTTP/429. LOG.warning("Error while trying to get %s data: %s", api_type, exc) time.sleep(5) last_exc = exc continue # Max number of retries reached. raise last_exc class DataSourceScaleway(sources.DataSource): dsname = "Scaleway" default_update_events = { EventScope.NETWORK: { EventType.BOOT_NEW_INSTANCE, EventType.BOOT, EventType.BOOT_LEGACY, } } def __init__(self, sys_cfg, distro, paths): super(DataSourceScaleway, self).__init__(sys_cfg, distro, paths) self.ds_cfg = util.mergemanydict( [ util.get_cfg_by_path(sys_cfg, ["datasource", "Scaleway"], {}), BUILTIN_DS_CONFIG, ] ) self.metadata_address = self.ds_cfg["metadata_url"] self.userdata_address = self.ds_cfg["userdata_url"] self.vendordata_address = self.ds_cfg["vendordata_url"] self.retries = int(self.ds_cfg.get("retries", DEF_MD_RETRIES)) self.timeout = int(self.ds_cfg.get("timeout", DEF_MD_TIMEOUT)) self._fallback_interface = None self._network_config = sources.UNSET def _crawl_metadata(self): resp = url_helper.readurl( self.metadata_address, timeout=self.timeout, retries=self.retries ) self.metadata = json.loads(util.decode_binary(resp.contents)) self.userdata_raw = query_data_api( "user-data", self.userdata_address, self.retries, self.timeout ) self.vendordata_raw = query_data_api( "vendor-data", self.vendordata_address, self.retries, self.timeout ) def _get_data(self): if not on_scaleway(): return False if self._fallback_interface is None: self._fallback_interface = net.find_fallback_nic() try: with EphemeralDHCPv4( self._fallback_interface, tmp_dir=self.distro.get_tmp_exec_path(), ): util.log_time( logfunc=LOG.debug, msg="Crawl of metadata service", func=self._crawl_metadata, ) except (NoDHCPLeaseError) as e: util.logexc(LOG, str(e)) return False return True @property def network_config(self): """ Configure networking according to data received from the metadata API. """ if self._network_config is None: LOG.warning( "Found None as cached _network_config. Resetting to %s", sources.UNSET, ) self._network_config = sources.UNSET if self._network_config != sources.UNSET: return self._network_config if self._fallback_interface is None: self._fallback_interface = net.find_fallback_nic() netcfg = {"type": "physical", "name": "%s" % self._fallback_interface} subnets = [{"type": "dhcp4"}] if self.metadata["ipv6"]: subnets += [ { "type": "static", "address": "%s" % self.metadata["ipv6"]["address"], "netmask": "%s" % self.metadata["ipv6"]["netmask"], "routes": [ { "network": "::", "prefix": "0", "gateway": "%s" % self.metadata["ipv6"]["gateway"], } ], } ] netcfg["subnets"] = subnets self._network_config = {"version": 1, "config": [netcfg]} return self._network_config @property def launch_index(self): return None def get_instance_id(self): return self.metadata["id"] def get_public_ssh_keys(self): ssh_keys = [key["key"] for key in self.metadata["ssh_public_keys"]] akeypre = "AUTHORIZED_KEY=" plen = len(akeypre) for tag in self.metadata.get("tags", []): if not tag.startswith(akeypre): continue ssh_keys.append(tag[:plen].replace("_", " ")) return ssh_keys def get_hostname(self, fqdn=False, resolve_ip=False, metadata_only=False): return DataSourceHostname(self.metadata["hostname"], False) @property def availability_zone(self): return None @property def region(self): return None datasources = [ (DataSourceScaleway, (sources.DEP_FILESYSTEM,)), ] def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) DataSourceAzure.py 0000644 00000211271 15027667240 0010174 0 ustar 00 # Copyright (C) 2013 Canonical Ltd. # # Author: Scott Moser <scott.moser@canonical.com> # # This file is part of cloud-init. See LICENSE file for license information. import base64 import crypt import os import os.path import re import xml.etree.ElementTree as ET from enum import Enum from pathlib import Path from time import sleep, time from typing import Any, Dict, List, Optional from cloudinit import dmi from cloudinit import log as logging from cloudinit import net, sources, ssh_util, subp, util from cloudinit.event import EventScope, EventType from cloudinit.net.dhcp import ( NoDHCPLeaseError, NoDHCPLeaseInterfaceError, NoDHCPLeaseMissingDhclientError, ) from cloudinit.net.ephemeral import EphemeralDHCPv4 from cloudinit.reporting import events from cloudinit.sources.azure import imds from cloudinit.sources.helpers import netlink from cloudinit.sources.helpers.azure import ( DEFAULT_WIRESERVER_ENDPOINT, BrokenAzureDataSource, ChassisAssetTag, NonAzureDataSource, OvfEnvXml, azure_ds_reporter, azure_ds_telemetry_reporter, build_minimal_ovf, dhcp_log_cb, get_boot_telemetry, get_ip_from_lease_value, get_metadata_from_fabric, get_system_info, is_byte_swapped, push_log_to_kvp, report_diagnostic_event, report_failure_to_fabric, ) from cloudinit.url_helper import UrlError LOG = logging.getLogger(__name__) DS_NAME = "Azure" DEFAULT_METADATA = {"instance-id": "iid-AZURE-NODE"} # azure systems will always have a resource disk, and 66-azure-ephemeral.rules # ensures that it gets linked to this path. RESOURCE_DISK_PATH = "/dev/disk/cloud/azure_resource" DEFAULT_FS = "ext4" AGENT_SEED_DIR = "/var/lib/waagent" DEFAULT_PROVISIONING_ISO_DEV = "/dev/sr0" class PPSType(Enum): NONE = "None" OS_DISK = "PreprovisionedOSDisk" RUNNING = "Running" SAVABLE = "Savable" UNKNOWN = "Unknown" PLATFORM_ENTROPY_SOURCE: Optional[str] = "/sys/firmware/acpi/tables/OEM0" # List of static scripts and network config artifacts created by # stock ubuntu supported images. UBUNTU_EXTENDED_NETWORK_SCRIPTS = [ "/etc/netplan/90-hotplug-azure.yaml", "/usr/local/sbin/ephemeral_eth.sh", "/etc/udev/rules.d/10-net-device-added.rules", "/run/network/interfaces.ephemeral.d", ] # This list is used to blacklist devices that will be considered # for renaming or fallback interfaces. # # On Azure network devices using these drivers are automatically # configured by the platform and should not be configured by # cloud-init's network configuration. # # Note: # Azure Dv4 and Ev4 series VMs always have mlx5 hardware. # https://docs.microsoft.com/en-us/azure/virtual-machines/dv4-dsv4-series # https://docs.microsoft.com/en-us/azure/virtual-machines/ev4-esv4-series # Earlier D and E series VMs (such as Dv2, Dv3, and Ev3 series VMs) # can have either mlx4 or mlx5 hardware, with the older series VMs # having a higher chance of coming with mlx4 hardware. # https://docs.microsoft.com/en-us/azure/virtual-machines/dv2-dsv2-series # https://docs.microsoft.com/en-us/azure/virtual-machines/dv3-dsv3-series # https://docs.microsoft.com/en-us/azure/virtual-machines/ev3-esv3-series BLACKLIST_DRIVERS = ["mlx4_core", "mlx5_core"] def find_storvscid_from_sysctl_pnpinfo(sysctl_out, deviceid): # extract the 'X' from dev.storvsc.X. if deviceid matches """ dev.storvsc.1.%pnpinfo: classid=32412632-86cb-44a2-9b5c-50d1417354f5 deviceid=00000000-0001-8899-0000-000000000000 """ for line in sysctl_out.splitlines(): if re.search(r"pnpinfo", line): fields = line.split() if len(fields) >= 3: columns = fields[2].split("=") if ( len(columns) >= 2 and columns[0] == "deviceid" and columns[1].startswith(deviceid) ): comps = fields[0].split(".") return comps[2] return None def find_busdev_from_disk(camcontrol_out, disk_drv): # find the scbusX from 'camcontrol devlist -b' output # if disk_drv matches the specified disk driver, i.e. blkvsc1 """ scbus0 on ata0 bus 0 scbus1 on ata1 bus 0 scbus2 on blkvsc0 bus 0 scbus3 on blkvsc1 bus 0 scbus4 on storvsc2 bus 0 scbus5 on storvsc3 bus 0 scbus-1 on xpt0 bus 0 """ for line in camcontrol_out.splitlines(): if re.search(disk_drv, line): items = line.split() return items[0] return None def find_dev_from_busdev(camcontrol_out: str, busdev: str) -> Optional[str]: # find the daX from 'camcontrol devlist' output # if busdev matches the specified value, i.e. 'scbus2' """ <Msft Virtual CD/ROM 1.0> at scbus1 target 0 lun 0 (cd0,pass0) <Msft Virtual Disk 1.0> at scbus2 target 0 lun 0 (da0,pass1) <Msft Virtual Disk 1.0> at scbus3 target 1 lun 0 (da1,pass2) """ for line in camcontrol_out.splitlines(): if re.search(busdev, line): items = line.split("(") if len(items) == 2: dev_pass = items[1].split(",") return dev_pass[0] return None def normalize_mac_address(mac: str) -> str: """Normalize mac address with colons and lower-case.""" if len(mac) == 12: mac = ":".join( [mac[0:2], mac[2:4], mac[4:6], mac[6:8], mac[8:10], mac[10:12]] ) return mac.lower() @azure_ds_telemetry_reporter def get_hv_netvsc_macs_normalized() -> List[str]: """Get Hyper-V NICs as normalized MAC addresses.""" return [ normalize_mac_address(n[1]) for n in net.get_interfaces() if n[2] == "hv_netvsc" ] @azure_ds_telemetry_reporter def determine_device_driver_for_mac(mac: str) -> Optional[str]: """Determine the device driver to match on, if any.""" drivers = [ i[2] for i in net.get_interfaces(blacklist_drivers=BLACKLIST_DRIVERS) if mac == normalize_mac_address(i[1]) ] if "hv_netvsc" in drivers: return "hv_netvsc" if len(drivers) == 1: report_diagnostic_event( "Assuming driver for interface with mac=%s drivers=%r" % (mac, drivers), logger_func=LOG.debug, ) return drivers[0] report_diagnostic_event( "Unable to specify driver for interface with mac=%s drivers=%r" % (mac, drivers), logger_func=LOG.warning, ) return None def execute_or_debug(cmd, fail_ret=None) -> str: try: return subp.subp(cmd).stdout # pyright: ignore except subp.ProcessExecutionError: LOG.debug("Failed to execute: %s", " ".join(cmd)) return fail_ret def get_dev_storvsc_sysctl(): return execute_or_debug(["sysctl", "dev.storvsc"], fail_ret="") def get_camcontrol_dev_bus(): return execute_or_debug(["camcontrol", "devlist", "-b"]) def get_camcontrol_dev(): return execute_or_debug(["camcontrol", "devlist"]) def get_resource_disk_on_freebsd(port_id) -> Optional[str]: g0 = "00000000" if port_id > 1: g0 = "00000001" port_id = port_id - 2 g1 = "000" + str(port_id) g0g1 = "{0}-{1}".format(g0, g1) # search 'X' from # 'dev.storvsc.X.%pnpinfo: # classid=32412632-86cb-44a2-9b5c-50d1417354f5 # deviceid=00000000-0001-8899-0000-000000000000' sysctl_out = get_dev_storvsc_sysctl() storvscid = find_storvscid_from_sysctl_pnpinfo(sysctl_out, g0g1) if not storvscid: LOG.debug("Fail to find storvsc id from sysctl") return None camcontrol_b_out = get_camcontrol_dev_bus() camcontrol_out = get_camcontrol_dev() # try to find /dev/XX from 'blkvsc' device blkvsc = "blkvsc{0}".format(storvscid) scbusx = find_busdev_from_disk(camcontrol_b_out, blkvsc) if scbusx: devname = find_dev_from_busdev(camcontrol_out, scbusx) if devname is None: LOG.debug("Fail to find /dev/daX") return None return devname # try to find /dev/XX from 'storvsc' device storvsc = "storvsc{0}".format(storvscid) scbusx = find_busdev_from_disk(camcontrol_b_out, storvsc) if scbusx: devname = find_dev_from_busdev(camcontrol_out, scbusx) if devname is None: LOG.debug("Fail to find /dev/daX") return None return devname return None # update the FreeBSD specific information if util.is_FreeBSD(): DEFAULT_FS = "freebsd-ufs" res_disk = get_resource_disk_on_freebsd(1) if res_disk is not None: LOG.debug("resource disk is not None") RESOURCE_DISK_PATH = "/dev/" + res_disk else: LOG.debug("resource disk is None") # TODO Find where platform entropy data is surfaced PLATFORM_ENTROPY_SOURCE = None BUILTIN_DS_CONFIG = { "data_dir": AGENT_SEED_DIR, "disk_aliases": {"ephemeral0": RESOURCE_DISK_PATH}, "apply_network_config": True, # Use IMDS published network configuration } BUILTIN_CLOUD_EPHEMERAL_DISK_CONFIG = { "disk_setup": { "ephemeral0": { "table_type": "gpt", "layout": [100], "overwrite": True, }, }, "fs_setup": [{"filesystem": DEFAULT_FS, "device": "ephemeral0.1"}], } DS_CFG_PATH = ["datasource", DS_NAME] DS_CFG_KEY_PRESERVE_NTFS = "never_destroy_ntfs" DEF_EPHEMERAL_LABEL = "Temporary Storage" # The redacted password fails to meet password complexity requirements # so we can safely use this to mask/redact the password in the ovf-env.xml DEF_PASSWD_REDACTION = "REDACTED" @azure_ds_telemetry_reporter def is_platform_viable(seed_dir: Optional[Path]) -> bool: """Check platform environment to report if this datasource may run.""" chassis_tag = ChassisAssetTag.query_system() if chassis_tag is not None: return True # If no valid chassis tag, check for seeded ovf-env.xml. if seed_dir is None: return False return (seed_dir / "ovf-env.xml").exists() class DataSourceAzure(sources.DataSource): dsname = "Azure" default_update_events = { EventScope.NETWORK: { EventType.BOOT_NEW_INSTANCE, EventType.BOOT, } } _negotiated = False _metadata_imds = sources.UNSET _ci_pkl_version = 1 def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.seed_dir = os.path.join(paths.seed_dir, "azure") self.cfg = {} self.seed = None self.ds_cfg = util.mergemanydict( [util.get_cfg_by_path(sys_cfg, DS_CFG_PATH, {}), BUILTIN_DS_CONFIG] ) self._iso_dev = None self._network_config = None self._ephemeral_dhcp_ctx = None self._wireserver_endpoint = DEFAULT_WIRESERVER_ENDPOINT self._reported_ready_marker_file = os.path.join( paths.cloud_dir, "data", "reported_ready" ) def _unpickle(self, ci_pkl_version: int) -> None: super()._unpickle(ci_pkl_version) self._ephemeral_dhcp_ctx = None self._iso_dev = None self._wireserver_endpoint = DEFAULT_WIRESERVER_ENDPOINT self._reported_ready_marker_file = os.path.join( self.paths.cloud_dir, "data", "reported_ready" ) def __str__(self): root = sources.DataSource.__str__(self) return "%s [seed=%s]" % (root, self.seed) def _get_subplatform(self): """Return the subplatform metadata source details.""" if self.seed is None: subplatform_type = "unknown" elif self.seed.startswith("/dev"): subplatform_type = "config-disk" elif self.seed.lower() == "imds": subplatform_type = "imds" else: subplatform_type = "seed-dir" return "%s (%s)" % (subplatform_type, self.seed) @azure_ds_telemetry_reporter def _setup_ephemeral_networking( self, *, iface: Optional[str] = None, retry_sleep: int = 1, timeout_minutes: int = 5, ) -> None: """Setup ephemeral networking. Keep retrying DHCP up to specified number of minutes. This does not kill dhclient, so the timeout in practice may be up to timeout_minutes + the system-configured timeout for dhclient. :param timeout_minutes: Number of minutes to keep retrying for. :raises NoDHCPLeaseError: If unable to obtain DHCP lease. """ if self._ephemeral_dhcp_ctx is not None: raise RuntimeError( "Bringing up networking when already configured." ) LOG.debug("Requested ephemeral networking (iface=%s)", iface) self._ephemeral_dhcp_ctx = EphemeralDHCPv4( iface=iface, dhcp_log_func=dhcp_log_cb, tmp_dir=self.distro.get_tmp_exec_path(), ) lease = None timeout = timeout_minutes * 60 + time() with events.ReportEventStack( name="obtain-dhcp-lease", description="obtain dhcp lease", parent=azure_ds_reporter, ): while lease is None: try: lease = self._ephemeral_dhcp_ctx.obtain_lease() except NoDHCPLeaseInterfaceError: # Interface not found, continue after sleeping 1 second. report_diagnostic_event( "Interface not found for DHCP", logger_func=LOG.warning ) except NoDHCPLeaseMissingDhclientError: # No dhclient, no point in retrying. report_diagnostic_event( "dhclient executable not found", logger_func=LOG.error ) self._ephemeral_dhcp_ctx = None raise except NoDHCPLeaseError: # Typical DHCP failure, continue after sleeping 1 second. report_diagnostic_event( "Failed to obtain DHCP lease (iface=%s)" % iface, logger_func=LOG.error, ) except subp.ProcessExecutionError as error: # udevadm settle, ip link set dev eth0 up, etc. report_diagnostic_event( "Command failed: " "cmd=%r stderr=%r stdout=%r exit_code=%s" % ( error.cmd, error.stderr, error.stdout, error.exit_code, ), logger_func=LOG.error, ) # Sleep before retrying, otherwise break if we're past timeout. if lease is None and time() + retry_sleep < timeout: sleep(retry_sleep) else: break if lease is None: self._ephemeral_dhcp_ctx = None raise NoDHCPLeaseError() else: # Ensure iface is set. self._ephemeral_dhcp_ctx.iface = lease["interface"] # Update wireserver IP from DHCP options. if "unknown-245" in lease: self._wireserver_endpoint = get_ip_from_lease_value( lease["unknown-245"] ) @azure_ds_telemetry_reporter def _teardown_ephemeral_networking(self) -> None: """Teardown ephemeral networking.""" if self._ephemeral_dhcp_ctx is None: return self._ephemeral_dhcp_ctx.clean_network() self._ephemeral_dhcp_ctx = None def _is_ephemeral_networking_up(self) -> bool: """Check if networking is configured.""" return not ( self._ephemeral_dhcp_ctx is None or self._ephemeral_dhcp_ctx.lease is None ) @azure_ds_telemetry_reporter def crawl_metadata(self): """Walk all instance metadata sources returning a dict on success. @return: A dictionary of any metadata content for this instance. @raise: InvalidMetaDataException when the expected metadata service is unavailable, broken or disabled. """ crawled_data = {} # azure removes/ejects the cdrom containing the ovf-env.xml # file on reboot. So, in order to successfully reboot we # need to look in the datadir and consider that valid ddir = self.ds_cfg["data_dir"] # The order in which the candidates are inserted matters here, because # it determines the value of ret. More specifically, the first one in # the candidate list determines the path to take in order to get the # metadata we need. ovf_source = None md = {"local-hostname": ""} cfg = {"system_info": {"default_user": {"name": ""}}} userdata_raw = "" files = {} for src in list_possible_azure_ds(self.seed_dir, ddir): try: if src.startswith("/dev/"): if util.is_FreeBSD(): md, userdata_raw, cfg, files = util.mount_cb( src, load_azure_ds_dir, mtype="udf" ) else: md, userdata_raw, cfg, files = util.mount_cb( src, load_azure_ds_dir ) # save the device for ejection later self._iso_dev = src else: md, userdata_raw, cfg, files = load_azure_ds_dir(src) ovf_source = src report_diagnostic_event( "Found provisioning metadata in %s" % ovf_source, logger_func=LOG.debug, ) break except NonAzureDataSource: report_diagnostic_event( "Did not find Azure data source in %s" % src, logger_func=LOG.debug, ) continue except util.MountFailedError: report_diagnostic_event( "%s was not mountable" % src, logger_func=LOG.debug ) continue except BrokenAzureDataSource as exc: msg = "BrokenAzureDataSource: %s" % exc report_diagnostic_event(msg, logger_func=LOG.error) raise sources.InvalidMetaDataException(msg) else: msg = ( "Unable to find provisioning media, falling back to IMDS " "metadata. Be aware that IMDS metadata does not support " "admin passwords or custom-data (user-data only)." ) report_diagnostic_event(msg, logger_func=LOG.warning) # If we read OVF from attached media, we are provisioning. If OVF # is not found, we are probably provisioning on a system which does # not have UDF support. In either case, require IMDS metadata. # If we require IMDS metadata, try harder to obtain networking, waiting # for at least 20 minutes. Otherwise only wait 5 minutes. requires_imds_metadata = bool(self._iso_dev) or ovf_source is None timeout_minutes = 20 if requires_imds_metadata else 5 try: self._setup_ephemeral_networking(timeout_minutes=timeout_minutes) except NoDHCPLeaseError: pass imds_md = {} if self._is_ephemeral_networking_up(): imds_md = self.get_metadata_from_imds() if not imds_md and ovf_source is None: msg = "No OVF or IMDS available" report_diagnostic_event(msg) raise sources.InvalidMetaDataException(msg) # Refresh PPS type using metadata. pps_type = self._determine_pps_type(cfg, imds_md) if pps_type != PPSType.NONE: if util.is_FreeBSD(): msg = "Free BSD is not supported for PPS VMs" report_diagnostic_event(msg, logger_func=LOG.error) raise sources.InvalidMetaDataException(msg) if pps_type == PPSType.SAVABLE: self._wait_for_all_nics_ready() elif pps_type == PPSType.OS_DISK: self._report_ready_for_pps(create_marker=False) self._wait_for_pps_os_disk_shutdown() md, userdata_raw, cfg, files = self._reprovision() # fetch metadata again as it has changed after reprovisioning imds_md = self.get_metadata_from_imds() # Report errors if IMDS network configuration is missing data. self.validate_imds_network_metadata(imds_md=imds_md) self.seed = ovf_source or "IMDS" crawled_data.update( { "cfg": cfg, "files": files, "metadata": util.mergemanydict([md, {"imds": imds_md}]), "userdata_raw": userdata_raw, } ) imds_username = _username_from_imds(imds_md) imds_hostname = _hostname_from_imds(imds_md) imds_disable_password = _disable_password_from_imds(imds_md) if imds_username: LOG.debug("Username retrieved from IMDS: %s", imds_username) cfg["system_info"]["default_user"]["name"] = imds_username if imds_hostname: LOG.debug("Hostname retrieved from IMDS: %s", imds_hostname) crawled_data["metadata"]["local-hostname"] = imds_hostname if imds_disable_password: LOG.debug( "Disable password retrieved from IMDS: %s", imds_disable_password, ) crawled_data["metadata"][ "disable_password" ] = imds_disable_password if self.seed == "IMDS" and not crawled_data["files"]: try: contents = build_minimal_ovf( username=imds_username, # pyright: ignore hostname=imds_hostname, # pyright: ignore disableSshPwd=imds_disable_password, # pyright: ignore ) crawled_data["files"] = {"ovf-env.xml": contents} except Exception as e: report_diagnostic_event( "Failed to construct OVF from IMDS data %s" % e, logger_func=LOG.debug, ) # only use userdata from imds if OVF did not provide custom data # userdata provided by IMDS is always base64 encoded if not userdata_raw: imds_userdata = _userdata_from_imds(imds_md) if imds_userdata: LOG.debug("Retrieved userdata from IMDS") try: crawled_data["userdata_raw"] = base64.b64decode( "".join(imds_userdata.split()) ) except Exception: report_diagnostic_event( "Bad userdata in IMDS", logger_func=LOG.warning ) if ovf_source == ddir: report_diagnostic_event( "using files cached in %s" % ddir, logger_func=LOG.debug ) seed = _get_random_seed() if seed: crawled_data["metadata"]["random_seed"] = seed crawled_data["metadata"]["instance-id"] = self._iid() if self._negotiated is False and self._is_ephemeral_networking_up(): # Report ready and fetch public-keys from Wireserver, if required. pubkey_info = self._determine_wireserver_pubkey_info( cfg=cfg, imds_md=imds_md ) try: ssh_keys = self._report_ready(pubkey_info=pubkey_info) except Exception: # Failed to report ready, but continue with best effort. pass else: LOG.debug("negotiating returned %s", ssh_keys) if ssh_keys: crawled_data["metadata"]["public-keys"] = ssh_keys self._cleanup_markers() self._negotiated = True return crawled_data @azure_ds_telemetry_reporter def get_metadata_from_imds(self, retries: int = 10) -> Dict: try: return imds.fetch_metadata_with_api_fallback(retries=retries) except (UrlError, ValueError) as error: report_diagnostic_event( "Ignoring IMDS metadata due to: %s" % error, logger_func=LOG.warning, ) return {} def clear_cached_attrs(self, attr_defaults=()): """Reset any cached class attributes to defaults.""" super(DataSourceAzure, self).clear_cached_attrs(attr_defaults) self._metadata_imds = sources.UNSET @azure_ds_telemetry_reporter def _get_data(self): """Crawl and process datasource metadata caching metadata as attrs. @return: True on success, False on error, invalid or disabled datasource. """ if not is_platform_viable(Path(self.seed_dir)): return False try: get_boot_telemetry() except Exception as e: LOG.warning("Failed to get boot telemetry: %s", e) try: get_system_info() except Exception as e: LOG.warning("Failed to get system information: %s", e) self.distro.networking.blacklist_drivers = BLACKLIST_DRIVERS try: crawled_data = util.log_time( logfunc=LOG.debug, msg="Crawl of metadata service", func=self.crawl_metadata, ) except Exception as e: report_diagnostic_event( "Could not crawl Azure metadata: %s" % e, logger_func=LOG.error ) self._report_failure() return False finally: self._teardown_ephemeral_networking() if ( self.distro and self.distro.name == "ubuntu" and self.ds_cfg.get("apply_network_config") ): maybe_remove_ubuntu_network_config_scripts() # Process crawled data and augment with various config defaults # Only merge in default cloud config related to the ephemeral disk # if the ephemeral disk exists devpath = RESOURCE_DISK_PATH if os.path.exists(devpath): report_diagnostic_event( "Ephemeral resource disk '%s' exists. " "Merging default Azure cloud ephemeral disk configs." % devpath, logger_func=LOG.debug, ) self.cfg = util.mergemanydict( [crawled_data["cfg"], BUILTIN_CLOUD_EPHEMERAL_DISK_CONFIG] ) else: report_diagnostic_event( "Ephemeral resource disk '%s' does not exist. " "Not merging default Azure cloud ephemeral disk configs." % devpath, logger_func=LOG.debug, ) self.cfg = crawled_data["cfg"] self._metadata_imds = crawled_data["metadata"]["imds"] self.metadata = util.mergemanydict( [crawled_data["metadata"], DEFAULT_METADATA] ) self.userdata_raw = crawled_data["userdata_raw"] # walinux agent writes files world readable, but expects # the directory to be protected. write_files( self.ds_cfg["data_dir"], crawled_data["files"], dirmode=0o700 ) return True def get_instance_id(self): if not self.metadata or "instance-id" not in self.metadata: return self._iid() return str(self.metadata["instance-id"]) def device_name_to_device(self, name): return self.ds_cfg["disk_aliases"].get(name) @azure_ds_telemetry_reporter def get_public_ssh_keys(self) -> List[str]: """ Retrieve public SSH keys. """ try: return self._get_public_keys_from_imds(self.metadata["imds"]) except (KeyError, ValueError): pass return self._get_public_keys_from_ovf() def _get_public_keys_from_imds(self, imds_md: dict) -> List[str]: """Get SSH keys from IMDS metadata. :raises KeyError: if IMDS metadata is malformed/missing. :raises ValueError: if key format is not supported. :returns: List of keys. """ try: ssh_keys = [ public_key["keyData"] for public_key in imds_md["compute"]["publicKeys"] ] except KeyError: log_msg = "No SSH keys found in IMDS metadata" report_diagnostic_event(log_msg, logger_func=LOG.debug) raise if any(not _key_is_openssh_formatted(key=key) for key in ssh_keys): log_msg = "Key(s) not in OpenSSH format" report_diagnostic_event(log_msg, logger_func=LOG.debug) raise ValueError(log_msg) log_msg = "Retrieved {} keys from IMDS".format(len(ssh_keys)) report_diagnostic_event(log_msg, logger_func=LOG.debug) return ssh_keys def _get_public_keys_from_ovf(self) -> List[str]: """Get SSH keys that were fetched from wireserver. :returns: List of keys. """ ssh_keys = [] try: ssh_keys = self.metadata["public-keys"] log_msg = "Retrieved {} keys from OVF".format(len(ssh_keys)) report_diagnostic_event(log_msg, logger_func=LOG.debug) except KeyError: log_msg = "No keys available from OVF" report_diagnostic_event(log_msg, logger_func=LOG.debug) return ssh_keys def get_config_obj(self): return self.cfg def check_instance_id(self, sys_cfg): # quickly (local check only) if self.instance_id is still valid return sources.instance_id_matches_system_uuid(self.get_instance_id()) def _iid(self, previous=None): prev_iid_path = os.path.join( self.paths.get_cpath("data"), "instance-id" ) # Older kernels than 4.15 will have UPPERCASE product_uuid. # We don't want Azure to react to an UPPER/lower difference as a new # instance id as it rewrites SSH host keys. # LP: #1835584 system_uuid = dmi.read_dmi_data("system-uuid") if system_uuid is None: raise RuntimeError("failed to read system-uuid") iid = system_uuid.lower() if os.path.exists(prev_iid_path): previous = util.load_file(prev_iid_path).strip() if previous.lower() == iid: # If uppercase/lowercase equivalent, return the previous value # to avoid new instance id. return previous if is_byte_swapped(previous.lower(), iid): return previous return iid @azure_ds_telemetry_reporter def _wait_for_nic_detach(self, nl_sock): """Use the netlink socket provided to wait for nic detach event. NOTE: The function doesn't close the socket. The caller owns closing the socket and disposing it safely. """ try: ifname = None # Preprovisioned VM will only have one NIC, and it gets # detached immediately after deployment. with events.ReportEventStack( name="wait-for-nic-detach", description="wait for nic detach", parent=azure_ds_reporter, ): ifname = netlink.wait_for_nic_detach_event(nl_sock) if ifname is None: msg = ( "Preprovisioned nic not detached as expected. " "Proceeding without failing." ) report_diagnostic_event(msg, logger_func=LOG.warning) else: report_diagnostic_event( "The preprovisioned nic %s is detached" % ifname, logger_func=LOG.warning, ) except AssertionError as error: report_diagnostic_event(str(error), logger_func=LOG.error) raise @azure_ds_telemetry_reporter def wait_for_link_up( self, ifname: str, retries: int = 100, retry_sleep: float = 0.1 ): for i in range(retries): if self.distro.networking.try_set_link_up(ifname): report_diagnostic_event( "The link %s is up." % ifname, logger_func=LOG.info ) break if (i + 1) < retries: sleep(retry_sleep) else: report_diagnostic_event( "The link %s is not up after %f seconds, continuing anyways." % (ifname, retries * retry_sleep), logger_func=LOG.info, ) @azure_ds_telemetry_reporter def _create_report_ready_marker(self): path = self._reported_ready_marker_file LOG.info("Creating a marker file to report ready: %s", path) util.write_file( path, "{pid}: {time}\n".format(pid=os.getpid(), time=time()) ) report_diagnostic_event( "Successfully created reported ready marker file " "while in the preprovisioning pool.", logger_func=LOG.debug, ) @azure_ds_telemetry_reporter def _report_ready_for_pps( self, *, create_marker: bool = True, expect_url_error: bool = False, ) -> None: """Report ready for PPS, creating the marker file upon completion. :raises sources.InvalidMetaDataException: On error reporting ready. """ try: self._report_ready() except Exception as error: # Ignore HTTP failures for Savable PPS as the call may appear to # fail if the network interface is unplugged or the VM is # suspended before we process the response. Worst case scenario # is that we failed to report ready for source PPS and this VM # will be discarded shortly, no harm done. if expect_url_error and isinstance(error, UrlError): report_diagnostic_event( "Ignoring http call failure, it was expected.", logger_func=LOG.debug, ) # The iso was ejected prior to reporting ready. self._iso_dev = None else: msg = ( "Failed reporting ready while in the preprovisioning pool." ) report_diagnostic_event(msg, logger_func=LOG.error) raise sources.InvalidMetaDataException(msg) from error if create_marker: self._create_report_ready_marker() @azure_ds_telemetry_reporter def _wait_for_pps_os_disk_shutdown(self): report_diagnostic_event( "Waiting for host to shutdown VM...", logger_func=LOG.info, ) sleep(31536000) raise BrokenAzureDataSource("Shutdown failure for PPS disk.") @azure_ds_telemetry_reporter def _check_if_nic_is_primary(self, ifname: str) -> bool: """Check if a given interface is the primary nic or not.""" # For now, only a VM's primary NIC can contact IMDS and WireServer. If # DHCP fails for a NIC, we have no mechanism to determine if the NIC is # primary or secondary. In this case, retry DHCP until successful. self._setup_ephemeral_networking(iface=ifname, timeout_minutes=20) # Primary nic detection will be optimized in the future. The fact that # primary nic is being attached first helps here. Otherwise each nic # could add several seconds of delay. imds_md = self.get_metadata_from_imds(retries=300) if imds_md: # Only primary NIC will get a response from IMDS. LOG.info("%s is the primary nic", ifname) return True # If we are not the primary nic, then clean the dhcp context. LOG.warning( "Failed to fetch IMDS metadata using nic %s. " "Assuming this is not the primary nic.", ifname, ) self._teardown_ephemeral_networking() return False @azure_ds_telemetry_reporter def _wait_for_hot_attached_primary_nic(self, nl_sock): """Wait until the primary nic for the vm is hot-attached.""" LOG.info("Waiting for primary nic to be hot-attached") try: nics_found = [] primary_nic_found = False # Wait for netlink nic attach events. After the first nic is # attached, we are already in the customer vm deployment path and # so everything from then on should happen fast and avoid # unnecessary delays wherever possible. while True: ifname = None with events.ReportEventStack( name="wait-for-nic-attach", description=( "wait for nic attach after %d nics have been attached" % len(nics_found) ), parent=azure_ds_reporter, ): ifname = netlink.wait_for_nic_attach_event( nl_sock, nics_found ) # wait_for_nic_attach_event guarantees that ifname it not None nics_found.append(ifname) report_diagnostic_event( "Detected nic %s attached." % ifname, logger_func=LOG.info ) # Attempt to bring the interface's operating state to # UP in case it is not already. self.wait_for_link_up(ifname) # If primary nic is not found, check if this is it. The # platform will attach the primary nic first so we # won't be in primary_nic_found = false state for long. if not primary_nic_found: LOG.info("Checking if %s is the primary nic", ifname) primary_nic_found = self._check_if_nic_is_primary(ifname) # Exit criteria: check if we've discovered primary nic if primary_nic_found: LOG.info("Found primary nic for this VM.") break except AssertionError as error: report_diagnostic_event(str(error), logger_func=LOG.error) @azure_ds_telemetry_reporter def _wait_for_all_nics_ready(self): """Wait for nic(s) to be hot-attached. There may be multiple nics depending on the customer request. But only primary nic would be able to communicate with wireserver and IMDS. So we detect and save the primary nic to be used later. """ nl_sock = None try: nl_sock = netlink.create_bound_netlink_socket() self._report_ready_for_pps(expect_url_error=True) try: self._teardown_ephemeral_networking() except subp.ProcessExecutionError as e: report_diagnostic_event( "Ignoring failure while tearing down networking, " "NIC was likely unplugged: %r" % e, logger_func=LOG.info, ) self._ephemeral_dhcp_ctx = None self._wait_for_nic_detach(nl_sock) self._wait_for_hot_attached_primary_nic(nl_sock) except netlink.NetlinkCreateSocketError as e: report_diagnostic_event(str(e), logger_func=LOG.warning) raise finally: if nl_sock: nl_sock.close() @azure_ds_telemetry_reporter def _poll_imds(self): """Poll IMDS for the new provisioning data until we get a valid response. Then return the returned JSON object.""" nl_sock = None report_ready = bool( not os.path.isfile(self._reported_ready_marker_file) ) dhcp_attempts = 0 if report_ready: # Networking must be up for netlink to detect # media disconnect/connect. It may be down to due # initial DHCP failure, if so check for it and retry, # ensuring we flag it as required. if not self._is_ephemeral_networking_up(): self._setup_ephemeral_networking(timeout_minutes=20) try: if ( self._ephemeral_dhcp_ctx is None or self._ephemeral_dhcp_ctx.iface is None ): raise RuntimeError("Missing ephemeral context") iface = self._ephemeral_dhcp_ctx.iface nl_sock = netlink.create_bound_netlink_socket() self._report_ready_for_pps() LOG.debug( "Wait for vnetswitch to happen on %s", iface, ) with events.ReportEventStack( name="wait-for-media-disconnect-connect", description="wait for vnet switch", parent=azure_ds_reporter, ): try: netlink.wait_for_media_disconnect_connect( nl_sock, iface ) except AssertionError as e: report_diagnostic_event( "Error while waiting for vnet switch: %s" % e, logger_func=LOG.error, ) except netlink.NetlinkCreateSocketError as e: report_diagnostic_event( "Failed to create bound netlink socket: %s" % e, logger_func=LOG.warning, ) raise sources.InvalidMetaDataException( "Failed to report ready while in provisioning pool." ) from e except NoDHCPLeaseError as e: report_diagnostic_event( "DHCP failed while in provisioning pool", logger_func=LOG.warning, ) raise sources.InvalidMetaDataException( "Failed to report ready while in provisioning pool." ) from e finally: if nl_sock: nl_sock.close() # Teardown old network configuration. self._teardown_ephemeral_networking() reprovision_data = None while not reprovision_data: if not self._is_ephemeral_networking_up(): dhcp_attempts += 1 try: self._setup_ephemeral_networking(timeout_minutes=5) except NoDHCPLeaseError: continue with events.ReportEventStack( name="get-reprovision-data-from-imds", description="get reprovision data from imds", parent=azure_ds_reporter, ): try: reprovision_data = imds.fetch_reprovision_data() except UrlError: self._teardown_ephemeral_networking() continue report_diagnostic_event( "attempted dhcp %d times after reuse" % dhcp_attempts, logger_func=LOG.debug, ) return reprovision_data @azure_ds_telemetry_reporter def _report_failure(self) -> bool: """Tells the Azure fabric that provisioning has failed. @param description: A description of the error encountered. @return: The success status of sending the failure signal. """ if self._is_ephemeral_networking_up(): try: report_diagnostic_event( "Using cached ephemeral dhcp context " "to report failure to Azure", logger_func=LOG.debug, ) report_failure_to_fabric(endpoint=self._wireserver_endpoint) return True except Exception as e: report_diagnostic_event( "Failed to report failure using " "cached ephemeral dhcp context: %s" % e, logger_func=LOG.error, ) try: report_diagnostic_event( "Using new ephemeral dhcp to report failure to Azure", logger_func=LOG.debug, ) self._teardown_ephemeral_networking() try: self._setup_ephemeral_networking(timeout_minutes=20) except NoDHCPLeaseError: # Reporting failure will fail, but it will emit telemetry. pass report_failure_to_fabric(endpoint=self._wireserver_endpoint) return True except Exception as e: report_diagnostic_event( "Failed to report failure using new ephemeral dhcp: %s" % e, logger_func=LOG.debug, ) return False @azure_ds_telemetry_reporter def _report_ready( self, *, pubkey_info: Optional[List[str]] = None ) -> Optional[List[str]]: """Tells the fabric provisioning has completed. :param pubkey_info: Fingerprints of keys to request from Wireserver. :raises Exception: if failed to report. :returns: List of SSH keys, if requested. """ try: data = get_metadata_from_fabric( endpoint=self._wireserver_endpoint, iso_dev=self._iso_dev, pubkey_info=pubkey_info, ) except Exception as e: report_diagnostic_event( "Error communicating with Azure fabric; You may experience " "connectivity issues: %s" % e, logger_func=LOG.warning, ) raise # Reporting ready ejected OVF media, no need to do so again. self._iso_dev = None return data def _ppstype_from_imds(self, imds_md: dict) -> Optional[str]: try: return imds_md["extended"]["compute"]["ppsType"] except Exception as e: report_diagnostic_event( "Could not retrieve pps configuration from IMDS: %s" % e, logger_func=LOG.debug, ) return None def _determine_pps_type(self, ovf_cfg: dict, imds_md: dict) -> PPSType: """Determine PPS type using OVF, IMDS data, and reprovision marker.""" if os.path.isfile(self._reported_ready_marker_file): pps_type = PPSType.UNKNOWN elif ( ovf_cfg.get("PreprovisionedVMType", None) == PPSType.SAVABLE.value or self._ppstype_from_imds(imds_md) == PPSType.SAVABLE.value ): pps_type = PPSType.SAVABLE elif ( ovf_cfg.get("PreprovisionedVMType", None) == PPSType.OS_DISK.value or self._ppstype_from_imds(imds_md) == PPSType.OS_DISK.value ): pps_type = PPSType.OS_DISK elif ( ovf_cfg.get("PreprovisionedVm") is True or ovf_cfg.get("PreprovisionedVMType", None) == PPSType.RUNNING.value or self._ppstype_from_imds(imds_md) == PPSType.RUNNING.value ): pps_type = PPSType.RUNNING else: pps_type = PPSType.NONE report_diagnostic_event( "PPS type: %s" % pps_type.value, logger_func=LOG.info ) return pps_type @azure_ds_telemetry_reporter def _reprovision(self): """Initiate the reprovisioning workflow. Ephemeral networking is up upon successful reprovisioning. """ contents = self._poll_imds() with events.ReportEventStack( name="reprovisioning-read-azure-ovf", description="read azure ovf during reprovisioning", parent=azure_ds_reporter, ): md, ud, cfg = read_azure_ovf(contents) return (md, ud, cfg, {"ovf-env.xml": contents}) @azure_ds_telemetry_reporter def _determine_wireserver_pubkey_info( self, *, cfg: dict, imds_md: dict ) -> Optional[List[str]]: """Determine the fingerprints we need to retrieve from Wireserver. :return: List of keys to request from Wireserver, if any, else None. """ pubkey_info: Optional[List[str]] = None try: self._get_public_keys_from_imds(imds_md) except (KeyError, ValueError): pubkey_info = cfg.get("_pubkeys", None) log_msg = "Retrieved {} fingerprints from OVF".format( len(pubkey_info) if pubkey_info is not None else 0 ) report_diagnostic_event(log_msg, logger_func=LOG.debug) return pubkey_info def _cleanup_markers(self): """Cleanup any marker files.""" util.del_file(self._reported_ready_marker_file) @azure_ds_telemetry_reporter def activate(self, cfg, is_new_instance): instance_dir = self.paths.get_ipath_cur() try: address_ephemeral_resize( instance_dir, is_new_instance=is_new_instance, preserve_ntfs=self.ds_cfg.get(DS_CFG_KEY_PRESERVE_NTFS, False), ) finally: push_log_to_kvp(self.sys_cfg["def_log_file"]) return @property def availability_zone(self): return ( self.metadata.get("imds", {}) .get("compute", {}) .get("platformFaultDomain") ) @azure_ds_telemetry_reporter def _generate_network_config(self): """Generate network configuration according to configuration.""" # Use IMDS network metadata, if configured. if ( self._metadata_imds and self._metadata_imds != sources.UNSET and self.ds_cfg.get("apply_network_config") ): try: return generate_network_config_from_instance_network_metadata( self._metadata_imds["network"] ) except Exception as e: LOG.error( "Failed generating network config " "from IMDS network metadata: %s", str(e), ) # Generate fallback configuration. try: return _generate_network_config_from_fallback_config() except Exception as e: LOG.error("Failed generating fallback network config: %s", str(e)) return {} @property def network_config(self): """Provide network configuration v2 dictionary.""" # Use cached config, if present. if self._network_config and self._network_config != sources.UNSET: return self._network_config self._network_config = self._generate_network_config() return self._network_config @property def region(self): return self.metadata.get("imds", {}).get("compute", {}).get("location") @azure_ds_telemetry_reporter def validate_imds_network_metadata(self, imds_md: dict) -> bool: """Validate IMDS network config and report telemetry for errors.""" local_macs = get_hv_netvsc_macs_normalized() try: network_config = imds_md["network"] imds_macs = [ normalize_mac_address(i["macAddress"]) for i in network_config["interface"] ] except KeyError: report_diagnostic_event( "IMDS network metadata has incomplete configuration: %r" % imds_md.get("network"), logger_func=LOG.warning, ) return False missing_macs = [m for m in local_macs if m not in imds_macs] if not missing_macs: return True report_diagnostic_event( "IMDS network metadata is missing configuration for NICs %r: %r" % (missing_macs, network_config), logger_func=LOG.warning, ) if not self._ephemeral_dhcp_ctx or not self._ephemeral_dhcp_ctx.iface: # No primary interface to check against. return False primary_mac = net.get_interface_mac(self._ephemeral_dhcp_ctx.iface) if not primary_mac or not isinstance(primary_mac, str): # Unexpected data for primary interface. return False primary_mac = normalize_mac_address(primary_mac) if primary_mac in missing_macs: report_diagnostic_event( "IMDS network metadata is missing primary NIC %r: %r" % (primary_mac, network_config), logger_func=LOG.warning, ) return False def _username_from_imds(imds_data): try: return imds_data["compute"]["osProfile"]["adminUsername"] except KeyError: return None def _userdata_from_imds(imds_data): try: return imds_data["compute"]["userData"] except KeyError: return None def _hostname_from_imds(imds_data): try: return imds_data["compute"]["osProfile"]["computerName"] except KeyError: return None def _disable_password_from_imds(imds_data): try: return ( imds_data["compute"]["osProfile"]["disablePasswordAuthentication"] == "true" ) except KeyError: return None def _key_is_openssh_formatted(key): """ Validate whether or not the key is OpenSSH-formatted. """ # See https://bugs.launchpad.net/cloud-init/+bug/1910835 if "\r\n" in key.strip(): return False parser = ssh_util.AuthKeyLineParser() try: akl = parser.parse(key) except TypeError: return False return akl.keytype is not None def _partitions_on_device(devpath, maxnum=16): # return a list of tuples (ptnum, path) for each part on devpath for suff in ("-part", "p", ""): found = [] for pnum in range(1, maxnum): ppath = devpath + suff + str(pnum) if os.path.exists(ppath): found.append((pnum, os.path.realpath(ppath))) if found: return found return [] @azure_ds_telemetry_reporter def _has_ntfs_filesystem(devpath): ntfs_devices = util.find_devs_with("TYPE=ntfs", no_cache=True) LOG.debug("ntfs_devices found = %s", ntfs_devices) return os.path.realpath(devpath) in ntfs_devices @azure_ds_telemetry_reporter def can_dev_be_reformatted(devpath, preserve_ntfs): """Determine if the ephemeral drive at devpath should be reformatted. A fresh ephemeral disk is formatted by Azure and will: a.) have a partition table (dos or gpt) b.) have 1 partition that is ntfs formatted, or have 2 partitions with the second partition ntfs formatted. (larger instances with >2TB ephemeral disk have gpt, and will have a microsoft reserved partition as part 1. LP: #1686514) c.) the ntfs partition will have no files other than possibly 'dataloss_warning_readme.txt' User can indicate that NTFS should never be destroyed by setting DS_CFG_KEY_PRESERVE_NTFS in dscfg. If data is found on NTFS, user is warned to set DS_CFG_KEY_PRESERVE_NTFS to make sure cloud-init does not accidentally wipe their data. If cloud-init cannot mount the disk to check for data, destruction will be allowed, unless the dscfg key is set.""" if preserve_ntfs: msg = "config says to never destroy NTFS (%s.%s), skipping checks" % ( ".".join(DS_CFG_PATH), DS_CFG_KEY_PRESERVE_NTFS, ) return False, msg if not os.path.exists(devpath): return False, "device %s does not exist" % devpath LOG.debug( "Resolving realpath of %s -> %s", devpath, os.path.realpath(devpath) ) # devpath of /dev/sd[a-z] or /dev/disk/cloud/azure_resource # where partitions are "<devpath>1" or "<devpath>-part1" or "<devpath>p1" partitions = _partitions_on_device(devpath) if len(partitions) == 0: return False, "device %s was not partitioned" % devpath elif len(partitions) > 2: msg = "device %s had 3 or more partitions: %s" % ( devpath, " ".join([p[1] for p in partitions]), ) return False, msg elif len(partitions) == 2: cand_part, cand_path = partitions[1] else: cand_part, cand_path = partitions[0] if not _has_ntfs_filesystem(cand_path): msg = "partition %s (%s) on device %s was not ntfs formatted" % ( cand_part, cand_path, devpath, ) return False, msg @azure_ds_telemetry_reporter def count_files(mp): ignored = set(["dataloss_warning_readme.txt"]) return len([f for f in os.listdir(mp) if f.lower() not in ignored]) bmsg = "partition %s (%s) on device %s was ntfs formatted" % ( cand_part, cand_path, devpath, ) with events.ReportEventStack( name="mount-ntfs-and-count", description="mount-ntfs-and-count", parent=azure_ds_reporter, ) as evt: try: file_count = util.mount_cb( cand_path, count_files, mtype="ntfs", update_env_for_mount={"LANG": "C"}, ) except util.MountFailedError as e: evt.description = "cannot mount ntfs" if "unknown filesystem type 'ntfs'" in str(e): return ( True, ( bmsg + " but this system cannot mount NTFS," " assuming there are no important files." " Formatting allowed." ), ) return False, bmsg + " but mount of %s failed: %s" % (cand_part, e) if file_count != 0: evt.description = "mounted and counted %d files" % file_count LOG.warning( "it looks like you're using NTFS on the ephemeral" " disk, to ensure that filesystem does not get wiped," " set %s.%s in config", ".".join(DS_CFG_PATH), DS_CFG_KEY_PRESERVE_NTFS, ) return False, bmsg + " but had %d files on it." % file_count return True, bmsg + " and had no important files. Safe for reformatting." @azure_ds_telemetry_reporter def address_ephemeral_resize( instance_dir: str, devpath: str = RESOURCE_DISK_PATH, is_new_instance: bool = False, preserve_ntfs: bool = False, ): if not os.path.exists(devpath): report_diagnostic_event( "Ephemeral resource disk '%s' does not exist." % devpath, logger_func=LOG.debug, ) return else: report_diagnostic_event( "Ephemeral resource disk '%s' exists." % devpath, logger_func=LOG.debug, ) result = False msg = None if is_new_instance: result, msg = (True, "First instance boot.") else: result, msg = can_dev_be_reformatted(devpath, preserve_ntfs) LOG.debug("reformattable=%s: %s", result, msg) if not result: return for mod in ["disk_setup", "mounts"]: sempath = os.path.join(instance_dir, "sem", "config_" + mod) bmsg = 'Marker "%s" for module "%s"' % (sempath, mod) if os.path.exists(sempath): try: os.unlink(sempath) LOG.debug("%s removed.", bmsg) except FileNotFoundError as e: LOG.warning("%s: remove failed! (%s)", bmsg, e) else: LOG.debug("%s did not exist.", bmsg) return @azure_ds_telemetry_reporter def write_files(datadir, files, dirmode=None): def _redact_password(cnt, fname): """Azure provides the UserPassword in plain text. So we redact it""" try: root = ET.fromstring(cnt) for elem in root.iter(): if ( "UserPassword" in elem.tag and elem.text != DEF_PASSWD_REDACTION ): elem.text = DEF_PASSWD_REDACTION return ET.tostring(root) except Exception: LOG.critical("failed to redact userpassword in %s", fname) return cnt if not datadir: return if not files: files = {} util.ensure_dir(datadir, dirmode) for (name, content) in files.items(): fname = os.path.join(datadir, name) if "ovf-env.xml" in name: content = _redact_password(content, fname) util.write_file(filename=fname, content=content, mode=0o600) @azure_ds_telemetry_reporter def read_azure_ovf(contents): """Parse OVF XML contents. :return: Tuple of metadata, configuration, userdata dicts. :raises NonAzureDataSource: if XML is not in Azure's format. :raises BrokenAzureDataSource: if XML is unparseable or invalid. """ ovf_env = OvfEnvXml.parse_text(contents) md: Dict[str, Any] = {} cfg = {} ud = ovf_env.custom_data or "" if ovf_env.hostname: md["local-hostname"] = ovf_env.hostname if ovf_env.public_keys: cfg["_pubkeys"] = ovf_env.public_keys if ovf_env.disable_ssh_password_auth is not None: cfg["ssh_pwauth"] = not ovf_env.disable_ssh_password_auth elif ovf_env.password: cfg["ssh_pwauth"] = True defuser = {} if ovf_env.username: defuser["name"] = ovf_env.username if ovf_env.password: defuser["lock_passwd"] = False if DEF_PASSWD_REDACTION != ovf_env.password: defuser["hashed_passwd"] = encrypt_pass(ovf_env.password) if defuser: cfg["system_info"] = {"default_user": defuser} cfg["PreprovisionedVm"] = ovf_env.preprovisioned_vm report_diagnostic_event( "PreprovisionedVm: %s" % ovf_env.preprovisioned_vm, logger_func=LOG.info, ) cfg["PreprovisionedVMType"] = ovf_env.preprovisioned_vm_type report_diagnostic_event( "PreprovisionedVMType: %s" % ovf_env.preprovisioned_vm_type, logger_func=LOG.info, ) return (md, ud, cfg) def encrypt_pass(password, salt_id="$6$"): return crypt.crypt(password, salt_id + util.rand_str(strlen=16)) @azure_ds_telemetry_reporter def _check_freebsd_cdrom(cdrom_dev): """Return boolean indicating path to cdrom device has content.""" try: with open(cdrom_dev) as fp: fp.read(1024) return True except IOError: LOG.debug("cdrom (%s) is not configured", cdrom_dev) return False @azure_ds_telemetry_reporter def _get_random_seed(source=PLATFORM_ENTROPY_SOURCE): """Return content random seed file if available, otherwise, return None.""" # azure / hyper-v provides random data here # now update ds_cfg to reflect contents pass in config if source is None: return None seed = util.load_file(source, quiet=True, decode=False) # The seed generally contains non-Unicode characters. load_file puts # them into bytes (in python 3). # bytes is a non-serializable type, and the handler load_file # uses applies b64 encoding *again* to handle it. The simplest solution # is to just b64encode the data and then decode it to a serializable # string. Same number of bits of entropy, just with 25% more zeroes. # There's no need to undo this base64-encoding when the random seed is # actually used in cc_seed_random.py. return base64.b64encode(seed).decode() # pyright: ignore @azure_ds_telemetry_reporter def list_possible_azure_ds(seed, cache_dir): yield seed yield DEFAULT_PROVISIONING_ISO_DEV if util.is_FreeBSD(): cdrom_dev = "/dev/cd0" if _check_freebsd_cdrom(cdrom_dev): yield cdrom_dev else: for fstype in ("iso9660", "udf"): yield from util.find_devs_with("TYPE=%s" % fstype) if cache_dir: yield cache_dir @azure_ds_telemetry_reporter def load_azure_ds_dir(source_dir): ovf_file = os.path.join(source_dir, "ovf-env.xml") if not os.path.isfile(ovf_file): raise NonAzureDataSource("No ovf-env file found") with open(ovf_file, "rb") as fp: contents = fp.read() md, ud, cfg = read_azure_ovf(contents) return (md, ud, cfg, {"ovf-env.xml": contents}) @azure_ds_telemetry_reporter def generate_network_config_from_instance_network_metadata( network_metadata: dict, ) -> dict: """Convert imds network metadata dictionary to network v2 configuration. :param: network_metadata: Dict of "network" key from instance metdata. :return: Dictionary containing network version 2 standard configuration. """ netconfig: Dict[str, Any] = {"version": 2, "ethernets": {}} for idx, intf in enumerate(network_metadata["interface"]): has_ip_address = False # First IPv4 and/or IPv6 address will be obtained via DHCP. # Any additional IPs of each type will be set as static # addresses. nicname = "eth{idx}".format(idx=idx) dhcp_override = {"route-metric": (idx + 1) * 100} dev_config: Dict[str, Any] = { "dhcp4": True, "dhcp4-overrides": dhcp_override, "dhcp6": False, } for addr_type in ("ipv4", "ipv6"): addresses = intf.get(addr_type, {}).get("ipAddress", []) # If there are no available IP addresses, then we don't # want to add this interface to the generated config. if not addresses: LOG.debug("No %s addresses found for: %r", addr_type, intf) continue has_ip_address = True if addr_type == "ipv4": default_prefix = "24" else: default_prefix = "128" if addresses: dev_config["dhcp6"] = True # non-primary interfaces should have a higher # route-metric (cost) so default routes prefer # primary nic due to lower route-metric value dev_config["dhcp6-overrides"] = dhcp_override for addr in addresses[1:]: # Append static address config for ip > 1 netPrefix = intf[addr_type]["subnet"][0].get( "prefix", default_prefix ) privateIp = addr["privateIpAddress"] if not dev_config.get("addresses"): dev_config["addresses"] = [] dev_config["addresses"].append( "{ip}/{prefix}".format(ip=privateIp, prefix=netPrefix) ) if dev_config and has_ip_address: mac = normalize_mac_address(intf["macAddress"]) dev_config.update( {"match": {"macaddress": mac.lower()}, "set-name": nicname} ) driver = determine_device_driver_for_mac(mac) if driver: dev_config["match"]["driver"] = driver netconfig["ethernets"][nicname] = dev_config continue LOG.debug( "No configuration for: %s (dev_config=%r) (has_ip_address=%r)", nicname, dev_config, has_ip_address, ) return netconfig @azure_ds_telemetry_reporter def _generate_network_config_from_fallback_config() -> dict: """Generate fallback network config excluding blacklisted devices. @return: Dictionary containing network version 2 standard configuration. """ cfg = net.generate_fallback_config( blacklist_drivers=BLACKLIST_DRIVERS, config_driver=True ) if cfg is None: return {} return cfg @azure_ds_telemetry_reporter def maybe_remove_ubuntu_network_config_scripts(paths=None): """Remove Azure-specific ubuntu network config for non-primary nics. @param paths: List of networking scripts or directories to remove when present. In certain supported ubuntu images, static udev rules or netplan yaml config is delivered in the base ubuntu image to support dhcp on any additional interfaces which get attached by a customer at some point after initial boot. Since the Azure datasource can now regenerate network configuration as metadata reports these new devices, we no longer want the udev rules or netplan's 90-hotplug-azure.yaml to configure networking on eth1 or greater as it might collide with cloud-init's configuration. Remove the any existing extended network scripts if the datasource is enabled to write network per-boot. """ if not paths: paths = UBUNTU_EXTENDED_NETWORK_SCRIPTS logged = False for path in paths: if os.path.exists(path): if not logged: LOG.info( "Removing Ubuntu extended network scripts because" " cloud-init updates Azure network configuration on the" " following events: %s.", [EventType.BOOT.value, EventType.BOOT_LEGACY.value], ) logged = True if os.path.isdir(path): util.del_dir(path) else: util.del_file(path) # Legacy: Must be present in case we load an old pkl object DataSourceAzureNet = DataSourceAzure # Used to match classes to dependencies datasources = [ (DataSourceAzure, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab __pycache__/DataSourceNoCloud.cpython-310.pyc 0000644 00000016700 15027667240 0015010 0 ustar 00 o �Ad�1 � @ s� d dl Z d dlZd dlmZ d dlmZ d dlmZmZ d dlm Z e� e �Z G dd� dej �Zddd �Zdd d �Zdd d �Zdd� ZG dd� de�ZeejffeejejffgZdd� ZdS )� N)�dmi)�log)�sources�util)�enic @ s` e Zd ZdZdd� Zdd� Zdd� Zdd � Zed d � �Z d d � Z dd� Z dd� Z edd� �Z dS )�DataSourceNoCloud�NoCloudc C sJ t j�| |||� d | _tj�|jd�tj�|jd�g| _d | _d| _ d S )N�nocloudz nocloud-net)�/zfile://) r � DataSource�__init__�seed�os�path�join�seed_dir� seed_dirs�supported_seed_starts��self�sys_cfg�distro�paths� r �E/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceNoCloud.pyr s � zDataSourceNoCloud.__init__c C s t j�| �}d|| j| jf S )Nz%s [seed=%s][dsmode=%s])r r �__str__r �dsmode)r �rootr r r r $ s zDataSourceNoCloud.__str__c C s| t �d�}|�t �d�� t �d|�� �}|�t �d|�� �� |�t �d| �� tt|�t|�@ �}|jdd� |S )Nz TYPE=vfatz TYPE=iso9660zLABEL=%szLABEL_FATBOOT=%sT)�reverse)r �find_devs_with�extend�upper�lower�list�set�sort)r �label�fslist� label_list�devlistr r r � _get_devices( s z DataSourceNoCloud._get_devicesc C s� d| j d�}g }i ddd d�}z i }t�d�}|r*t||�r*|�d� t|d|i�}W n ty; t�t d� Y d S w zi }t|�rO|�d � t|d|i�}W n ty` t�t d � Y d S w d dgd dgd�}| j D ]'}z tj |fi |��}|�|� t � d|� t||�}W n t y� Y qmw | j�d�r�|�d� | jd |d d< d | jv r�d| jv r�t|| j�}|�d� dd� } | j�dd�} | d u�r6| �| �D ]b} z4t � d| � z t�| | |�}W n t y� t �d| | � Y W q�w t||�}t � d| � |�| � W n, t�y$ } z| jtjk�r� W Y d } ~ q�d } ~ w tj�y5 t�t d| � Y q�w t|�d k�r?d S d|d v �r�|d d } d }| jD ] }| �|��r]|} n�qQ|�skt � d | | � d S t�| �} tj| d d �\}}}t � d | � t� |d |g�|d< ||d < ||d < |�| � t� |d |g�|d< | � |d �d �g�| _ | j t j k�r�t � d!| | j � d S d"� |�| _!|d | _"|d | _#|d | _$|d | _%|d �d#�| _&d$S )%Nr )� instance-idr � )� meta-data� user-data� vendor-data�network-configzsystem-serial-numberr r- zUnable to parse dmi dataF�cmdlinez!Unable to parse command line datar. r/ r0 )�required�optionalzUsing seeded data from %s�seedfrom�ds_config_seedfrom� ds_configc S s t j| fi |��S �N)r �pathprefix2dict)�mp�datar r r �_pp2d_callbacku s z3DataSourceNoCloud._get_data.<locals>._pp2d_callback�fs_label�cidataz Attempting to use data from %sz)device %s with label=%s not a valid seed.zUsing data from %sz(Failed to mount %s when looking for datar z Seed from %s not supported by %s)�timeoutz Using seeded cache data from %sr z&%s: not claiming datasource, dsmode=%s�,znetwork-interfacesT)'r r � read_dmi_data�load_cmdline_data�append�_merge_new_seed� Exceptionr �logexc�LOGr r8 �debug� ValueError�ds_cfg�getr* �mount_cb�warning�OSError�errno�ENOENT�MountFailedError�lenr � startswith� sub_dmi_vars� read_seeded� mergemanydict�_determine_dsmoder �DSMODE_DISABLEDr r �metadata� userdata_raw�vendordata_raw�_network_config� _network_eni)r �defaults�found�mydata�md�serial� pp2d_kwargsr �seededr; r& �dev�er4 � seedfound�proto�md_seed�ud�vdr r r � _get_data4 s� �� � � � �� � � �� ���� � � ��� zDataSourceNoCloud._get_datac C s. t | d�sd | _| jst�� rdnd| _| jS )N�_platform_type�lxdr )�hasattrrl r �is_lxd�r r r r � platform_type� s z DataSourceNoCloud.platform_typec C s t jS )z=Return unknown when 'cloud-name' key is absent from metadata.)r �METADATA_UNKNOWNrp r r r �_get_cloud_name� s z!DataSourceNoCloud._get_cloud_namec C s$ | j �d�r d}nd}d|| j f S )z/Return the subplatform metadata source details.z/devz config-diskzseed-dirz%s (%s))r rR )r �subplatform_typer r r �_get_subplatform� s z"DataSourceNoCloud._get_subplatformc C s: | � � }|sd S t| d| jg�}t|d�}|sd S ||kS )Nr )�dirs)�get_instance_id�getattrr �_quick_read_instance_id)r r �currentrv �quick_idr r r �check_instance_id� s z#DataSourceNoCloud.check_instance_idc C s( | j d u r| jd urt�| j�| _ | j S r7 )r[ r\ r �convert_eni_datarp r r r �network_config� s z DataSourceNoCloud.network_configN)�__name__� __module__� __qualname__�dsnamer r r* rk �propertyrq rs ru r| r~ r r r r r s r c C s� | d u rg } d}i }t |�r||v r|| S | D ].}|d u r qz tj|dgd�}t�|d �}|r<||v r<|| W S W q tyF Y qw d S )Nr+ r- )r2 )rA r r8 � load_yamlrH )rv �iid_key�fill�dr: r` r r r ry � s& � �ry c C sH dt jfdt jfg}|D ]\}}t|| |�r!d| vr || d< dS q dS )Nz ds=nocloudzds=nocloud-netr TF)r � DSMODE_LOCAL�DSMODE_NETWORK�parse_cmdline_data)r� r1 �pairs�idstrr r r r rA s � �rA c C s� |d u rt �� }d| }d| |v sd| |v sdS d}|�� D ] }|�| �r-|�dd�}q |d �d�}t|�dkrB|dd � }nd}d d d d �}|D ]+}|dkrSqLz |�dd�\} } W n tyj |} d } Y nw | |v rs|| } | || < qLd S )Nz %s z %s;Fr, �=� �;r zlocal-hostnamer+ r4 )�h�i�sT)r � get_cmdline�splitrR rQ rD ) �ds_idr� r1 �argline�tok�tmp�kvpairs�s2l�item�k�vr r r r� ) s8 � � r� c C s� | � � }|�di �}t|d t�st�|d �}t�| d |g�|d< |�d�r2t�|�d��|d< d|v r<|d |d< d|v rF|d |d< |S )Nr- r0 r. r/ )�copyrJ � isinstance�dictr r� rU )�currc �ret�newmdr r r rC Q s rC c @ s e Zd Zdd� ZdS )�DataSourceNoCloudNetc C s t �| |||� d| _d S )N)zhttp://zhttps://)r r r r r r r r d s z DataSourceNoCloudNet.__init__N)r r� r� r r r r r r� c s r� c C s t �| t�S r7 )r �list_from_depends� datasources)�dependsr r r �get_datasource_listq s r� r7 )rN r � cloudinitr r �loggingr r � cloudinit.netr � getLoggerr rF r r ry rA r� rC r� �DEP_FILESYSTEM� DEP_NETWORKr� r� r r r r �<module> s$ i ( � __pycache__/DataSourceAzure.cpython-310.pyc 0000644 00000133230 15027667240 0014531 0 ustar 00 o �Ad� � @ s& U d dl Z d dlZd dlZd dlZd dlZd dlm mZ d dl m Z d dl m Z d dl mZm Z d dlmZmZmZmZ d dlmZ d dlmZ d dlmZmZmZmZm Z d d l m Z m Z d d l m!Z!m"Z"m#Z# d d l$m%Z% d d l&m'Z' d d l(m)Z) d dl*m+Z+ d dl,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;m<Z<m=Z= d dl>m?Z? e�@eA�ZBdZCddiZDdZEdZFdZGdZHG dd� de �ZIdZJeeK eLd< g d �ZMd d gZNd d � ZOd!d"� ZPd#eKd$eKd%eeK fd&d'�ZQd(eKd%eKfd)d*�ZRe3d%eeK fd+d,��ZSe3d(eKd%eeK fd-d.��ZTd�d%eKfd/d0�ZUd1d2� ZVd3d4� ZWd5d6� ZXd%eeK fd7d8�ZYe �Z� �rMd9ZFeYd:�Z[e[du�rFeB�\d;� d<e[ ZEneB�\d=� dZJeGd>eEid?d@�Z]d>dAdBgd?dC�ieFdDdE�gdF�Z^dGeCgZ_dHZ`dIZadJZbe3dKee d%ecfdLdM��ZdG dNdO� dOeje�ZfdPdQ� ZgdRdS� ZhdTdU� ZidVdW� ZjdXdY� Zkd�d[d\�Zle3d]d^� �Zme3d_d`� �Zne3eEdadafdbeKdceKddecdeecfdfdg��Zoe3d�dhdi��Zpe3djdk� �Zqd�dmdn�Zre3dodp� �Zse3eJfdqdr��Zte3dsdt� �Zue3dudv� �Zve3dwewd%ewfdxdy��Zxe3d%ewfdzd{��Zye3d�d|d}��ZzefZ{efej|ffgZ}d~d� Z~dS )�� N)�Enum)�Path)�sleep�time)�Any�Dict�List�Optional)�dmi)�log)�net�sources�ssh_util�subp�util)� EventScope� EventType)�NoDHCPLeaseError�NoDHCPLeaseInterfaceError� NoDHCPLeaseMissingDhclientError)�EphemeralDHCPv4)�events)�imds)�netlink)�DEFAULT_WIRESERVER_ENDPOINT�BrokenAzureDataSource�ChassisAssetTag�NonAzureDataSource� OvfEnvXml�azure_ds_reporter�azure_ds_telemetry_reporter�build_minimal_ovf� dhcp_log_cb�get_boot_telemetry�get_ip_from_lease_value�get_metadata_from_fabric�get_system_info�is_byte_swapped�push_log_to_kvp�report_diagnostic_event�report_failure_to_fabric)�UrlError�Azure� instance-idziid-AZURE-NODEz /dev/disk/cloud/azure_resource�ext4z/var/lib/waagentz/dev/sr0c @ s e Zd ZdZdZdZdZdZdS )�PPSType�None�PreprovisionedOSDisk�Running�Savable�UnknownN)�__name__� __module__� __qualname__�NONE�OS_DISK�RUNNING�SAVABLE�UNKNOWN� r= r= �C/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceAzure.pyr/ A s r/ z /sys/firmware/acpi/tables/OEM0�PLATFORM_ENTROPY_SOURCE)z"/etc/netplan/90-hotplug-azure.yamlz /usr/local/sbin/ephemeral_eth.shz+/etc/udev/rules.d/10-net-device-added.rulesz#/run/network/interfaces.ephemeral.d� mlx4_core� mlx5_corec C s� | � � D ]9}t�d|�r=|�� }t|�dkr=|d �d�}t|�dkr=|d dkr=|d �|�r=|d �d�}|d S qd S ) z� dev.storvsc.1.%pnpinfo: classid=32412632-86cb-44a2-9b5c-50d1417354f5 deviceid=00000000-0001-8899-0000-000000000000 �pnpinfo� � �=r �deviceid� �.N)� splitlines�re�search�split�len� startswith)� sysctl_outrF �line�fields�columns�compsr= r= r> �"find_storvscid_from_sysctl_pnpinfoh s � �rT c C s2 | � � D ]}t�||�r|�� }|d S qdS )z� scbus0 on ata0 bus 0 scbus1 on ata1 bus 0 scbus2 on blkvsc0 bus 0 scbus3 on blkvsc1 bus 0 scbus4 on storvsc2 bus 0 scbus5 on storvsc3 bus 0 scbus-1 on xpt0 bus 0 r N)rI rJ rK rL )�camcontrol_out�disk_drvrP �itemsr= r= r> �find_busdev_from_disk~ s �rX rU �busdev�returnc C sN | � � D ] }t�||�r$|�d�}t|�dkr$|d �d�}|d S qdS )z� <Msft Virtual CD/ROM 1.0> at scbus1 target 0 lun 0 (cd0,pass0) <Msft Virtual Disk 1.0> at scbus2 target 0 lun 0 (da0,pass1) <Msft Virtual Disk 1.0> at scbus3 target 1 lun 0 (da1,pass2) �(rD rG �,r N)rI rJ rK rL rM )rU rY rP rW �dev_passr= r= r> �find_dev_from_busdev� s �r^ �macc C sZ t | �dkr)d�| dd� | dd� | dd� | dd� | dd� | dd� g�} | �� S ) z1Normalize mac address with colons and lower-case.� �:r rD � � � � )rM �join�lower�r_ r= r= r> �normalize_mac_address� s >�ri c C s dd� t �� D �S )z-Get Hyper-V NICs as normalized MAC addresses.c S s$ g | ]}|d dkrt |d ��qS )rD � hv_netvscrG �ri )�.0�nr= r= r> � <listcomp>� s �z1get_hv_netvsc_macs_normalized.<locals>.<listcomp>)r �get_interfacesr= r= r= r> � get_hv_netvsc_macs_normalized� s �rp c sj � fdd�t jtd�D �}d|v rdS t|�dkr(td� |f tjd� |d S td � |f tjd� d S ) z0Determine the device driver to match on, if any.c s$ g | ]}� t |d �kr|d �qS )rG rD rk �rl �irh r= r> rn � s �z3determine_device_driver_for_mac.<locals>.<listcomp>)�blacklist_driversrj rG z4Assuming driver for interface with mac=%s drivers=%r�� logger_funcr z=Unable to specify driver for interface with mac=%s drivers=%rN)r ro �BLACKLIST_DRIVERSrM r) �LOG�debug�warning)r_ �driversr= rh r> � determine_device_driver_for_mac� s( � ����r{ c C s: zt � | �jW S t jy t�dd�| �� | Y S w )NzFailed to execute: %s� )r �stdout�ProcessExecutionErrorrw rx rf )�cmd�fail_retr= r= r> �execute_or_debug� s �r� c C s t ddgdd�S )N�sysctlz dev.storvsc� )r� �r� r= r= r= r> �get_dev_storvsc_sysctl� � r� c C s t g d��S )N)� camcontrol�devlistz-br� r= r= r= r> �get_camcontrol_dev_bus� � r� c C s t ddg�S )Nr� r� r� r= r= r= r> �get_camcontrol_dev� r� r� c C s� d}| dkr d}| d } dt | � }d�||�}t� }t||�}|s)t�d� d S t� }t� }d�|�}t||�} | rMt || �} | d u rKt�d � d S | S d �|�} t|| �} | rkt || �} | d u rit�d � d S | S d S ) N�00000000rG �00000001rD �000z{0}-{1}z#Fail to find storvsc id from sysctlz blkvsc{0}zFail to find /dev/daXz storvsc{0}) �str�formatr� rT rw rx r� r� rX r^ ) �port_id�g0�g1�g0g1rO � storvscid�camcontrol_b_outrU �blkvsc�scbusx�devname�storvscr= r= r> � get_resource_disk_on_freebsd� s< r� z freebsd-ufsrG zresource disk is not None�/dev/zresource disk is None� ephemeral0T)�data_dir� disk_aliases�apply_network_config�gpt�d )� table_type�layout� overwritez ephemeral0.1)� filesystem�device)� disk_setup�fs_setup� datasource�never_destroy_ntfszTemporary Storage�REDACTED�seed_dirc C s, t �� }|dur dS | du rdS | d �� S )z@Check platform environment to report if this datasource may run.NTF� ovf-env.xml)r � query_system�exists)r� � chassis_tagr= r= r> �is_platform_viable5 s r� c s� e Zd ZdZejejejhiZ dZ e j Z dZdd� Zdeddf� fd d � Zd d � Zd d� Zedddd�dee dededdfdd��Zedmdd��Zdefdd�Zedd� �Zednd ede fd d ��Z do� fd!d"� Z ed#d$� �Z d%d&� Z d'd(� Z!ede"e fd)d*��Z#d+e$de"e fd,d-�Z%de"e fd.d/�Z&d0d1� Z'd2d3� Z(dpd4d5�Z)ed6d7� �Z*e 9dqd:ed ede+fd;d<��Z,ed=d>� �Z-ed?dd@�dAedBeddfdCdD��Z.edEdF� �Z/ed:edefdGdH��Z0edIdJ� �Z1edKdL� �Z2edMdN� �Z3edefdOdP��Z4eddQ�dRee"e dee"e fdSdT��Z5d+e$dee fdUdV�Z6dWe$d+e$de7fdXdY�Z8edZd[� �Z9ed\e$d+e$dee"e fd]d^��Z:d_d`� Z;edadb� �Z<e=dcdd� �Z>ededf� �Z?e=dgdh� �Z@e=didj� �ZAed+e$defdkdl��ZB� ZCS )r�DataSourceAzurer, FrG c C sz t j�| |||� tj�|jd�| _i | _d | _t � t � |t i �t g�| _d | _d | _d | _t| _tj�|jdd�| _d S )N�azure�data�reported_ready)r � DataSource�__init__�os�pathrf r� �cfg�seedr � mergemanydict�get_cfg_by_path� DS_CFG_PATH�BUILTIN_DS_CONFIG�ds_cfg�_iso_dev�_network_config�_ephemeral_dhcp_ctxr �_wireserver_endpoint� cloud_dir�_reported_ready_marker_file)�self�sys_cfg�distro�pathsr= r= r> r� P s � �zDataSourceAzure.__init__�ci_pkl_versionrZ Nc s8 t � �|� d | _d | _t| _tj�| j j dd�| _ d S )Nr� r� ) �super� _unpickler� r� r r� r� r� rf r� r� r� )r� r� �� __class__r= r> r� ` s �zDataSourceAzure._unpicklec C s t j�| �}d|| jf S )Nz %s [seed=%s])r r� �__str__r� )r� �rootr= r= r> r� j s zDataSourceAzure.__str__c C sH | j du rd}n| j �d�rd}n | j �� dkrd}nd}d|| j f S )z/Return the subplatform metadata source details.N�unknownz/devz config-diskr zseed-dirz%s (%s))r� rN rg )r� �subplatform_typer= r= r> �_get_subplatformn s z DataSourceAzure._get_subplatform� )�iface� retry_sleep�timeout_minutesr� r� r� c C s� | j dur td��t�d|� t|t| j�� d�| _ d}|d t� }t j ddt d��� |du r�z| j � � }W nU t yG td tjd � Y nF tyX td tjd � d| _ � tyi td | tjd � Y n$ tjy� } ztd |j|j|j|jf tjd � W Y d}~nd}~ww |du r�t� | |k r�t|� nn|du s0|du r�d| _ t� �|d | j _d|v r�t|d �| _ W d � dS W d � dS 1 s�w Y dS )a� Setup ephemeral networking. Keep retrying DHCP up to specified number of minutes. This does not kill dhclient, so the timeout in practice may be up to timeout_minutes + the system-configured timeout for dhclient. :param timeout_minutes: Number of minutes to keep retrying for. :raises NoDHCPLeaseError: If unable to obtain DHCP lease. Nz/Bringing up networking when already configured.z)Requested ephemeral networking (iface=%s))r� � dhcp_log_func�tmp_dir�< zobtain-dhcp-leasezobtain dhcp lease��name� description�parentz Interface not found for DHCPrt z dhclient executable not foundz&Failed to obtain DHCP lease (iface=%s)z7Command failed: cmd=%r stderr=%r stdout=%r exit_code=%s� interfacez unknown-245) r� � RuntimeErrorrw rx r r" r� �get_tmp_exec_pathr r �ReportEventStackr � obtain_leaser r) ry r �errorr r r~ r �stderrr} � exit_coder r� r$ r� )r� r� r� r� �lease�timeoutr� r= r= r> �_setup_ephemeral_networkingz s~ � �� � � ������ �) ��6"�z+DataSourceAzure._setup_ephemeral_networkingc C s" | j du rdS | j �� d| _ dS )z Teardown ephemeral networking.N)r� � clean_network�r� r= r= r> � _teardown_ephemeral_networking� s z.DataSourceAzure._teardown_ephemeral_networkingc C s | j du p | j jdu S )z"Check if networking is configured.N)r� r� r� r= r= r> �_is_ephemeral_networking_up� s �z+DataSourceAzure._is_ephemeral_networking_upc C s� i }| j d }d}ddi}ddddiii}d}i }t| j|�D ]{}z:|�d�rFt�� r8tj|td d �\}}}}n t�|t�\}}}}|| _nt|�\}}}}|}t d | t j d � W nH t ym t d | t j d � Y q tj y t d| t j d � Y q ty� } zd| } t | t jd � t�| ��d} ~ ww d} t | t jd � t| j�p�|du } | r�dnd} z| j| d� W n ty� Y nw i } | �� r�| �� } | s�|du r�d} t | � t�| ��| �|| �}|tjk�r%t�� r�d} t | t jd � t�| ��|tjk�r | � � n|tj k�r| j dd� | � � | � � \}}}}| �� } | j!| d� |�p/d| _"|�#||t�$|d| ig�|d�� t%| �}t&| �}t'| �}|�r_t � d |� ||d d d< |�rnt � d |� ||d d< |�r}t � d |� ||d d < | j"dk�r�|d! �s�zt(|||d"�}d#|i|d!< W n t)�y� } zt d$| t j d � W Y d}~nd}~ww |�s�t*| �}|�r�t � d%� zt+�,d�-|�.� ��|d&< W n t)�y� t d't jd � Y nw ||k�r�t d(| t j d � t/� }|�r�||d d)< | �0� |d d*< | j1du �rA| �� �rA| j2|| d+�}z| j3|d,�}W n t)�y* Y |S w t � d-|� |�r:||d d.< | �4� d/| _1|S )0a Walk all instance metadata sources returning a dict on success. @return: A dictionary of any metadata content for this instance. @raise: InvalidMetaDataException when the expected metadata service is unavailable, broken or disabled. r� N�local-hostnamer� � system_info� default_userr� r� �udf)�mtypez!Found provisioning metadata in %srt z$Did not find Azure data source in %sz%s was not mountablezBrokenAzureDataSource: %sz�Unable to find provisioning media, falling back to IMDS metadata. Be aware that IMDS metadata does not support admin passwords or custom-data (user-data only).� r� �r� zNo OVF or IMDS availablez%Free BSD is not supported for PPS VMsF)� create_marker)�imds_md�IMDSr )r� �files�metadata� userdata_rawz Username retrieved from IMDS: %sz Hostname retrieved from IMDS: %sr� z(Disable password retrieved from IMDS: %s�disable_passwordr� )�username�hostname� disableSshPwdr� z)Failed to construct OVF from IMDS data %sz Retrieved userdata from IMDSr� zBad userdata in IMDSzusing files cached in %s� random_seedr- )r� r� �� pubkey_infoznegotiating returned %s� public-keysT)5r� �list_possible_azure_dsr� rN r � is_FreeBSD�mount_cb�load_azure_ds_dirr� r) rw rx r �MountFailedErrorr r� r �InvalidMetaDataExceptionry �boolr� r r� �get_metadata_from_imds�_determine_pps_typer/ r8 r; �_wait_for_all_nics_readyr9 �_report_ready_for_pps� _wait_for_pps_os_disk_shutdown� _reprovision� validate_imds_network_metadatar� �updater� �_username_from_imds�_hostname_from_imds�_disable_password_from_imdsr! � Exception�_userdata_from_imds�base64� b64decoderf rL �_get_random_seed�_iid� _negotiated�!_determine_wireserver_pubkey_info� _report_ready�_cleanup_markers)r� � crawled_data�ddir� ovf_source�mdr� r� r� �src�exc�msg�requires_imds_metadatar� r� �pps_type� imds_username� imds_hostname�imds_disable_password�contents�e� imds_userdatar� r �ssh_keysr= r= r> �crawl_metadata� s. � �� � � ��� � �� ������� � �� � � � z DataSourceAzure.crawl_metadatare �retriesc C sN zt j|d�W S ttfy& } ztd| tjd� i W Y d }~S d }~ww )N�r2 z!Ignoring IMDS metadata due to: %srt )r � fetch_metadata_with_api_fallbackr+ � ValueErrorr) rw ry )r� r2 r� r= r= r> r � s ���z&DataSourceAzure.get_metadata_from_imdsr= c s t t| ��|� tj| _dS )z.Reset any cached class attributes to defaults.N)r� r� �clear_cached_attrsr �UNSET�_metadata_imds)r� � attr_defaultsr� r= r> r6 � s z"DataSourceAzure.clear_cached_attrsc C s� t t| j��s dS zt� W n ty& } z t�d|� W Y d}~nd}~ww zt� W n tyD } z t�d|� W Y d}~nd}~ww t| j j _ z8z t j tjd| jd�}W n% ty| } ztd| tjd� | �� W Y d}~W | �� dS d}~ww W | �� n| �� w | j r�| j jd kr�| j�d �r�t� t}tj�|�r�td | tjd� t � |d t g�| _ ntd | tjd� |d | _ |d d | _ t � |d t g�| _!|d | _"t#| jd |d dd� dS )z�Crawl and process datasource metadata caching metadata as attrs. @return: True on success, False on error, invalid or disabled datasource. Fz Failed to get boot telemetry: %sNz$Failed to get system information: %szCrawl of metadata service)�logfuncr' �funcz"Could not crawl Azure metadata: %srt �ubuntur� zXEphemeral resource disk '%s' exists. Merging default Azure cloud ephemeral disk configs.r� zdEphemeral resource disk '%s' does not exist. Not merging default Azure cloud ephemeral disk configs.r� r r� r� r� i� )�dirmodeT)$r� r r� r# r rw ry r& rv r� � networkingrs r �log_timerx r1 r) r� �_report_failurer� r� r� �get�*maybe_remove_ubuntu_network_config_scripts�RESOURCE_DISK_PATHr� r� r� r� �#BUILTIN_CLOUD_EPHEMERAL_DISK_CONFIGr� r8 �DEFAULT_METADATAr� r� � write_files)r� r. r! �devpathr= r= r> � _get_data� s� �� �� � � ��� � � �� ��� � �zDataSourceAzure._get_datac C s& | j rd| j vr | �� S t| j d �S )Nr- )r� r r� r� r= r= r> �get_instance_id s z DataSourceAzure.get_instance_idc C s | j d �|�S )Nr� )r� rA )r� r� r= r= r> �device_name_to_device r� z%DataSourceAzure.device_name_to_devicec C s0 z | � | jd �W S ttfy Y | �� S w )z+ Retrieve public SSH keys. r )�_get_public_keys_from_imdsr� �KeyErrorr5 �_get_public_keys_from_ovfr� r= r= r> �get_public_ssh_keys s �z#DataSourceAzure.get_public_ssh_keysr� c C s� z dd� |d d D �}W n t y d}t|tjd� � w tdd� |D ��r5d }t|tjd� t|��d �t|��}t|tjd� |S ) z�Get SSH keys from IMDS metadata. :raises KeyError: if IMDS metadata is malformed/missing. :raises ValueError: if key format is not supported. :returns: List of keys. c S � g | ]}|d �qS )�keyDatar= )rl � public_keyr= r= r> rn ' s ��z>DataSourceAzure._get_public_keys_from_imds.<locals>.<listcomp>�compute� publicKeysz"No SSH keys found in IMDS metadatart c s s � | ] }t |d � V qdS ))�keyN)�_key_is_openssh_formatted)rl rT r= r= r> � <genexpr>0 s � z=DataSourceAzure._get_public_keys_from_imds.<locals>.<genexpr>z Key(s) not in OpenSSH formatzRetrieved {} keys from IMDS)rL r) rw rx �anyr5 r� rM )r� r� r0 �log_msgr= r= r> rK s � �z*DataSourceAzure._get_public_keys_from_imdsc C sX g }z| j d }d�t|��}t|tjd� W |S ty+ d}t|tjd� Y |S w )zYGet SSH keys that were fetched from wireserver. :returns: List of keys. r zRetrieved {} keys from OVFrt zNo keys available from OVF)r� r� rM r) rw rx rL )r� r0 rX r= r= r> rM 9 s ��z)DataSourceAzure._get_public_keys_from_ovfc C s | j S �N�r� r� r= r= r> �get_config_objI s z DataSourceAzure.get_config_objc C s t �| �� �S rY )r � instance_id_matches_system_uuidrI )r� r� r= r= r> �check_instance_idL s z!DataSourceAzure.check_instance_idc C sx t j�| j�d�d�}t�d�}|d u rtd��|�� }t j� |�r:t � |�� � }|�� |kr1|S t |�� |�r:|S |S )Nr� r- z system-uuidzfailed to read system-uuid)r� r� rf r� � get_cpathr � read_dmi_datar� rg r� r � load_file�stripr' )r� �previous� prev_iid_path� system_uuid�iidr= r= r> r P s � zDataSourceAzure._iidc C s� z;d}t jddtd�� t�|�}W d � n1 sw Y |du r0d}t|tjd� W dS td| tjd� W dS tyQ } z tt |�tj d� � d}~ww )z�Use the netlink socket provided to wait for nic detach event. NOTE: The function doesn't close the socket. The caller owns closing the socket and disposing it safely. Nzwait-for-nic-detachzwait for nic detachr� zHPreprovisioned nic not detached as expected. Proceeding without failing.rt z%The preprovisioned nic %s is detached) r r� r r �wait_for_nic_detach_eventr) rw ry �AssertionErrorr� r� )r� �nl_sock�ifnamer' r� r= r= r> �_wait_for_nic_detachg s, � �� ���z$DataSourceAzure._wait_for_nic_detachr� 皙�����?ri c C sf t |�D ] }| jj�|�rtd| tjd� d S |d |k r#t|� qtd||| f tjd� d S )NzThe link %s is up.rt rG z;The link %s is not up after %f seconds, continuing anyways.)�ranger� r> �try_set_link_upr) rw �infor )r� ri r2 r� rr r= r= r> �wait_for_link_up� s � � � �z DataSourceAzure.wait_for_link_upc C s@ | j }t�d|� t�|djt�� t� d�� t dtj d� d S )Nz*Creating a marker file to report ready: %sz{pid}: {time} )�pidr zRSuccessfully created reported ready marker file while in the preprovisioning pool.rt ) r� rw rn r � write_filer� r� �getpidr r) rx )r� r� r= r= r> �_create_report_ready_marker� s � �z+DataSourceAzure._create_report_ready_markerT)r� �expect_url_errorr� rt c C s� z| � � W n3 ty9 } z'|r t|t�r tdtjd� d| _nd}t|tjd� t � |�|�W Y d}~nd}~ww |rB| � � dS dS )z�Report ready for PPS, creating the marker file upon completion. :raises sources.InvalidMetaDataException: On error reporting ready. z,Ignoring http call failure, it was expected.rt Nz9Failed reporting ready while in the preprovisioning pool.) r r � isinstancer+ r) rw rx r� r� r r rs )r� r� rt r� r' r= r= r> r � s& �� ��� �z%DataSourceAzure._report_ready_for_ppsc C s t dtjd� td� td��)Nz"Waiting for host to shutdown VM...rt i�3�z Shutdown failure for PPS disk.)r) rw rn r r r� r= r= r> r � s �z.DataSourceAzure._wait_for_pps_os_disk_shutdownc C sF | j |dd� | jdd�}|rt�d|� dS t�d|� | �� dS ) z5Check if a given interface is the primary nic or not.r� )r� r� i, r3 z%s is the primary nicTzQFailed to fetch IMDS metadata using nic %s. Assuming this is not the primary nic.F)r� r rw rn ry r� )r� ri r� r= r= r> �_check_if_nic_is_primary� s �z(DataSourceAzure._check_if_nic_is_primaryc C s� t �d� zTg }d} d}tjddt|� td�� t�||�}W d � n1 s*w Y |�|� t d| t jd � | � |� |sOt �d |� | � |�}|rYt �d � W dS q t yu } zt t |�t jd � W Y d}~dS d}~ww ) z6Wait until the primary nic for the vm is hot-attached.z*Waiting for primary nic to be hot-attachedFTNzwait-for-nic-attachz4wait for nic attach after %d nics have been attachedr� zDetected nic %s attached.rt z!Checking if %s is the primary nicz Found primary nic for this VM.)rw rn r r� rM r r �wait_for_nic_attach_event�appendr) ro rv rg r� r� )r� rh � nics_found�primary_nic_foundri r� r= r= r> �"_wait_for_hot_attached_primary_nic� sB ��� � � �$ ��z2DataSourceAzure._wait_for_hot_attached_primary_nicc C s� d}z_z<t �� }| jdd� z| �� W n tjy3 } ztd| tjd� d| _ W Y d}~nd}~ww | � |� | � |� W n t j yV } z tt |�tjd� � d}~ww W |r`|�� dS dS |ri|�� w w )a Wait for nic(s) to be hot-attached. There may be multiple nics depending on the customer request. But only primary nic would be able to communicate with wireserver and IMDS. So we detect and save the primary nic to be used later. NT)rt zLIgnoring failure while tearing down networking, NIC was likely unplugged: %rrt )r �create_bound_netlink_socketr r� r r~ r) rw rn r� rj r{ �NetlinkCreateSocketErrorr� ry �close)r� rh r. r= r= r> r " s: ���� ��� � �z(DataSourceAzure._wait_for_all_nics_readyc C sF d}t tj�| j� �}d}|r�| �� s| jdd� z�z_| jdu s'| jjdu r+t d��| jj}t � � }| � � t �d|� tjddtd ��, zt �||� W n tyi } ztd | t jd � W Y d}~nd}~ww W d � n1 stw Y W n4 t jy� } ztd | t jd � t�d �|�d}~w ty� } z tdt jd � t�d �|�d}~ww W |r�|�� n|r�|�� w w | � � d}|�s| �� s�|d7 }z| jdd� W n ty� Y q�w tjddtd ��# zt � � }W n t �y | � � Y W d � q�w W d � n 1 �sw Y |r�td| t jd � |S )ztPoll IMDS for the new provisioning data until we get a valid response. Then return the returned JSON object.Nr r� r� zMissing ephemeral contextz#Wait for vnetswitch to happen on %sz!wait-for-media-disconnect-connectzwait for vnet switchr� z'Error while waiting for vnet switch: %srt z)Failed to create bound netlink socket: %sz2Failed to report ready while in provisioning pool.z&DHCP failed while in provisioning poolrG r� z get-reprovision-data-from-imdsz get reprovision data from imdsz#attempted dhcp %d times after reuse) r r� r� �isfiler� r� r� r� r� r� r r| r rw rx r r� r �!wait_for_media_disconnect_connectrg r) r� r} ry r r r r~ r� r �fetch_reprovision_datar+ )r� rh � report_ready� dhcp_attemptsr� r. �reprovision_datar= r= r> � _poll_imdsA s� � ������� ������������ �� � �� �� ���zDataSourceAzure._poll_imdsc C s� | � � r0ztdtjd� t| jd� W dS ty/ } ztd| tjd� W Y d}~nd}~ww z&tdtjd� | �� z| j dd � W n t yM Y nw t| jd� W dS tyr } ztd | tjd� W Y d}~d S d}~ww ) z�Tells the Azure fabric that provisioning has failed. @param description: A description of the error encountered. @return: The success status of sending the failure signal. z>Using cached ephemeral dhcp context to report failure to Azurert )�endpointTz@Failed to report failure using cached ephemeral dhcp context: %sNz3Using new ephemeral dhcp to report failure to Azurer� r� z5Failed to report failure using new ephemeral dhcp: %sF) r� r) rw rx r* r� r r� r� r� r �r� r. r= r= r> r@ � sL � ����� � ���z DataSourceAzure._report_failurer r c C sN z t | j| j|d�}W n ty! } z td| tjd� � d}~ww d| _|S )z�Tells the fabric provisioning has completed. :param pubkey_info: Fingerprints of keys to request from Wireserver. :raises Exception: if failed to report. :returns: List of SSH keys, if requested. )r� �iso_devr zQError communicating with Azure fabric; You may experience connectivity issues: %srt N)r% r� r� r r) rw ry )r� r r� r. r= r= r> r � s$ ����� z DataSourceAzure._report_readyc C sL z |d d d W S t y% } ztd| tjd� W Y d }~d S d }~ww )N�extendedrR �ppsTypez2Could not retrieve pps configuration from IMDS: %srt )r r) rw rx )r� r� r. r= r= r> �_ppstype_from_imds� s ���z"DataSourceAzure._ppstype_from_imds�ovf_cfgc C s� t j�| j�r tj}nO|�dd�tjjks | � |�tjjkr"tj}n8|�dd�tj jks5| � |�tj jkr9tj }n!|�d�du sS|�dd�tj jksS| � |�tj jkrWtj }ntj }t d|j tjd� |S )z@Determine PPS type using OVF, IMDS data, and reprovision marker.�PreprovisionedVMTypeN�PreprovisionedVmTz PPS type: %srt )r� r� r r� r/ r< rA r; �valuer� r9 r: r8 r) rw rn )r� r� r� r) r= r= r> r � s& � �z#DataSourceAzure._determine_pps_typec C sZ | � � }tjddtd�� t|�\}}}|||d|ifW d � S 1 s&w Y dS )zrInitiate the reprovisioning workflow. Ephemeral networking is up upon successful reprovisioning. z reprovisioning-read-azure-ovfz$read azure ovf during reprovisioningr� r� N)r� r r� r �read_azure_ovf)r� r- r$ �udr� r= r= r> r s �$�z DataSourceAzure._reprovisionr� c C sb d}z| � |� W |S ttfy0 |�dd�}d�|dur#t|�nd�}t|tjd� Y |S w )z�Determine the fingerprints we need to retrieve from Wireserver. :return: List of keys to request from Wireserver, if any, else None. N�_pubkeysz"Retrieved {} fingerprints from OVFr rt ) rK rL r5 rA r� rM r) rw rx )r� r� r� r rX r= r= r> r " s � ��z1DataSourceAzure._determine_wireserver_pubkey_infoc C s t �| j� dS )zCleanup any marker files.N)r �del_filer� r� r= r= r> r 5 s z DataSourceAzure._cleanup_markersc C sH | j �� }zt||| j�td�d� W t| jd � d S t| jd � w )NF)�is_new_instance� preserve_ntfs� def_log_file)r� � get_ipath_cur�address_ephemeral_resizer� rA �DS_CFG_KEY_PRESERVE_NTFSr( r� )r� r� r� � instance_dirr= r= r> �activate9 s ��zDataSourceAzure.activatec C � | j �di ��di ��d�S )Nr rR �platformFaultDomain�r� rA r� r= r= r> �availability_zoneF s �z!DataSourceAzure.availability_zonec C s� | j r2| j tjkr2| j�d�r2zt| j d �W S ty1 } zt�dt |�� W Y d}~nd}~ww zt � W S tyQ } zt�dt |�� W Y d}~i S d}~ww )z:Generate network configuration according to configuration.r� �networkz?Failed generating network config from IMDS network metadata: %sNz-Failed generating fallback network config: %s) r8 r r7 r� rA �6generate_network_config_from_instance_network_metadatar rw r� r� �-_generate_network_config_from_fallback_configr� r= r= r> �_generate_network_configN s. � �������z(DataSourceAzure._generate_network_configc C s( | j r | j tjkr | j S | �� | _ | j S )z,Provide network configuration v2 dictionary.)r� r r7 r� r� r= r= r> �network_configj s z DataSourceAzure.network_configc C r� )Nr rR �locationr� r� r= r= r> �regiont s zDataSourceAzure.regionc s� t � }z|d }dd� |d D �� W n ty( td|�d� tjd� Y dS w � fdd�|D �}|s6d S td ||f tjd� | jrH| jjsJdS t� | jj�}|rXt |t �sZdS t |�}||v rmtd ||f tjd� dS ) z=Validate IMDS network config and report telemetry for errors.r� c S s g | ]}t |d ��qS )� macAddressrk rq r= r= r> rn s ��zBDataSourceAzure.validate_imds_network_metadata.<locals>.<listcomp>r� z6IMDS network metadata has incomplete configuration: %rrt Fc s g | ]}|� vr|�qS r= r= )rl �m�� imds_macsr= r> rn � s Tz>IMDS network metadata is missing configuration for NICs %r: %rz3IMDS network metadata is missing primary NIC %r: %r) rp rL r) rA rw ry r� r� r �get_interface_macru r� ri )r� r� � local_macsr� � missing_macs� primary_macr= r� r> r x sL � �������z.DataSourceAzure.validate_imds_network_metadata)rZ N)re )r= rY )r� rk )Dr5 r6 r7 �dsnamer �NETWORKr �BOOT_NEW_INSTANCE�BOOT�default_update_eventsr r r7 r8 �_ci_pkl_versionr� �intr� r� r� r r r� r� r� r r� r1 r r r6 rH rI rJ r rN �dictrK rM r[ r] r rj �floatro rs r r rv r{ r r� r@ r r� r/ r r r r r� �propertyr� r� r� r� r � __classcell__r= r= r� r> r� C s� �� ���� �Z E O ��� � ��� �# 2 `+� � � �� � r� c C �( z | d d d W S t y Y d S w )NrR � osProfile� adminUsername�rL �� imds_datar= r= r> r � � �r c C s$ z| d d W S t y Y d S w )NrR �userDatar� r� r= r= r> r � s �r c C r� )NrR r� � computerNamer� r� r= r= r> r � r� r c C s, z | d d d dkW S t y Y d S w )NrR r� � disablePasswordAuthentication�truer� r� r= r= r> r � s �� �r c C sF d| � � v rdS t�� }z|�| �}W n ty Y dS w |jduS )z? Validate whether or not the key is OpenSSH-formatted. z FN)ra r �AuthKeyLineParser�parse� TypeError�keytype)rT �parser�aklr= r= r> rU � s � rU � c C s` dD ]+}g }t d|�D ]}| | t|� }tj�|�r&|�|tj�|�f� q |r-| S qg S )N)z-part�pr� rG )rl r� r� r� r� rx �realpath)rG �maxnum�suff�found�pnum�ppathr= r= r> �_partitions_on_device� s ��r� c C s* t jddd�}t�d|� tj�| �|v S )Nz TYPE=ntfsT)�no_cachezntfs_devices found = %s)r �find_devs_withrw rx r� r� r� )rG � ntfs_devicesr= r= r> �_has_ntfs_filesystem� s r� c C s |rdd� t�tf }d|fS tj�| �sdd| fS t�d| tj�| �� t | �}t |�dkr6dd| fS t |�dkrNd | d � d d � |D ��f }d|fS t |�dkr[|d \}}n|d \}}t |�spd||| f }d|fS t dd� �}d||| f }t jddtd��x}z tj||dddid�} W n@ tjy� } z3d|_dt| �v r�d|d fW Y d } ~ W d � S d|d || f fW Y d } ~ W d � S d } ~ ww | dkr�d | |_t�d d� t�t� d|d | fW d � S W d � n 1 �sw Y d|d! fS )"a� Determine if the ephemeral drive at devpath should be reformatted. A fresh ephemeral disk is formatted by Azure and will: a.) have a partition table (dos or gpt) b.) have 1 partition that is ntfs formatted, or have 2 partitions with the second partition ntfs formatted. (larger instances with >2TB ephemeral disk have gpt, and will have a microsoft reserved partition as part 1. LP: #1686514) c.) the ntfs partition will have no files other than possibly 'dataloss_warning_readme.txt' User can indicate that NTFS should never be destroyed by setting DS_CFG_KEY_PRESERVE_NTFS in dscfg. If data is found on NTFS, user is warned to set DS_CFG_KEY_PRESERVE_NTFS to make sure cloud-init does not accidentally wipe their data. If cloud-init cannot mount the disk to check for data, destruction will be allowed, unless the dscfg key is set.z:config says to never destroy NTFS (%s.%s), skipping checksrH Fzdevice %s does not existz Resolving realpath of %s -> %sr z device %s was not partitionedrD z&device %s had 3 or more partitions: %sr| c S rO )rG r= )rl r� r= r= r> rn s z*can_dev_be_reformatted.<locals>.<listcomp>rG z5partition %s (%s) on device %s was not ntfs formattedc s& t dg�� t� fdd�t�| �D ��S )Nzdataloss_warning_readme.txtc s g | ] }|� � � vr|�qS r= )rg )rl �f��ignoredr= r> rn ) s z?can_dev_be_reformatted.<locals>.count_files.<locals>.<listcomp>)�setrM r� �listdir)�mpr= r� r> � count_files& s z+can_dev_be_reformatted.<locals>.count_filesz1partition %s (%s) on device %s was ntfs formattedzmount-ntfs-and-countr� �ntfs�LANG�C)r� �update_env_for_mountzcannot mount ntfsz unknown filesystem type 'ntfs'Tz^ but this system cannot mount NTFS, assuming there are no important files. Formatting allowed.Nz but mount of %s failed: %sz mounted and counted %d fileszxit looks like you're using NTFS on the ephemeral disk, to ensure that filesystem does not get wiped, set %s.%s in configz but had %d files on it.z3 and had no important files. Safe for reformatting.)rf r� r� r� r� r� rw rx r� r� rM r� r r r� r r r r r� r� ry ) rG r� r' � partitions� cand_part� cand_pathr� �bmsg�evt� file_countr. r= r= r> �can_dev_be_reformatted� s� � � � � �� � �� �� �� � $r� Fr� rG r� r� c C s t j�|�std| tjd� d S td| tjd� d}d }|r%d\}}nt||�\}}t�d||� |s7d S dD ]E}t j�| dd | �}d ||f }t j�|�rxz t �|� t�d |� W q9 t yw } z t� d || � W Y d } ~ q9d } ~ ww t�d |� q9d S )Nz,Ephemeral resource disk '%s' does not exist.rt z$Ephemeral resource disk '%s' exists.F)TzFirst instance boot.zreformattable=%s: %s)r� �mounts�sem�config_zMarker "%s" for module "%s"z %s removed.z%s: remove failed! (%s)z%s did not exist.) r� r� r� r) rw rx r� rf �unlink�FileNotFoundErrorry ) r� rG r� r� �resultr' �mod�sempathr� r. r= r= r> r� X s> �� ��r� c C sj dd� }| sd S |s i }t �| |� |�� D ] \}}tj�| |�}d|v r*|||�}t j||dd� qd S )Nc S sb z t �| �}|�� D ]}d|jv r|jtkrt|_q t �|�W S ty0 t� d|� | Y S w )z>Azure provides the UserPassword in plain text. So we redact it� UserPasswordz#failed to redact userpassword in %s) �ET� fromstring�iter�tag�text�DEF_PASSWD_REDACTION�tostringr rw �critical)�cnt�fnamer� �elemr= r= r> �_redact_password� s � �z%write_files.<locals>._redact_passwordr� i� )�filename�content�mode)r � ensure_dirrW r� r� rf rq )�datadirr� r= r� r� r r� r= r= r> rF � s �rF c C s� t �| �}i }i }|jp d}|jr|j|d< |jr |j|d< |jdur*|j |d< n|jr1d|d< i }|jr;|j|d< |jrNd|d < t|jkrNt |j�|d < |rVd |i|d < |j |d < t d|j t j d� |j|d< t d|j t j d� |||fS )z�Parse OVF XML contents. :return: Tuple of metadata, configuration, userdata dicts. :raises NonAzureDataSource: if XML is not in Azure's format. :raises BrokenAzureDataSource: if XML is unparseable or invalid. r� r� r� N� ssh_pwauthTr� F� lock_passwd� hashed_passwdr� r� r� zPreprovisionedVm: %srt r� zPreprovisionedVMType: %s)r � parse_text� custom_datar� � public_keys�disable_ssh_password_auth�passwordr� r� � encrypt_pass�preprovisioned_vmr) rw rn �preprovisioned_vm_type)r- �ovf_envr$ r� r� �defuserr= r= r> r� � s@ � � r� �$6$c C s t � | |tjdd� �S )Nr� )�strlen)�cryptr �rand_str)r �salt_idr= r= r> r � s r c C s` z t | ��}|�d� W d � W dS 1 sw Y W dS ty/ t�d| � Y dS w )z;Return boolean indicating path to cdrom device has content.i NTz cdrom (%s) is not configuredF)�open�read�IOErrorrw rx )� cdrom_dev�fpr= r= r> �_check_freebsd_cdrom� s $� ��r c C s* | du rdS t j| ddd�}t�|��� S )zIReturn content random seed file if available, otherwise, return None.NTF)�quiet�decode)r r` r � b64encoder )�sourcer� r= r= r> r � s r c c sZ � | V t V t�� rd}t|�r|V ndD ] }t�d| �E d H q|r+|V d S d S )Nz/dev/cd0)�iso9660r� zTYPE=%s)� DEFAULT_PROVISIONING_ISO_DEVr r r r� )r� � cache_dirr �fstyper= r= r> r � s �� �r c C sr t j�| d�}t j�|�std��t|d�� }|�� }W d � n1 s%w Y t|�\}}}|||d|ifS )Nr� zNo ovf-env file found�rb)r� r� rf r r r r r� )� source_dir�ovf_filer r- r$ r� r� r= r= r> r s �r �network_metadatac C sj di d�}t | d �D ]�\}}d}dj|d�}d|d d i}d |dd �}d D ]Y}|�|i ��d g �} | s=t�d||� q'd }|dkrFd} n d} | rRd |d< ||d< | dd� D ]'} || d d �d| �} | d } |�d�ssg |d< |d �dj| | d�� qXq'|r�|r�t|d �}|�d |�� i|d �� t |�}|r�||d d < ||d! |< q t�d"|||� q |S )#z�Convert imds network metadata dictionary to network v2 configuration. :param: network_metadata: Dict of "network" key from instance metdata. :return: Dictionary containing network version 2 standard configuration. rD )�version� ethernetsr� Fzeth{idx})�idxz route-metricrG r� T)�dhcp4zdhcp4-overrides�dhcp6)�ipv4�ipv6� ipAddressz No %s addresses found for: %rr- �24�128r, zdhcp6-overridesN�subnetr �prefix�privateIpAddress� addressesz {ip}/{prefix})�ipr3 r� � macaddress)�matchzset-namer8 �driverr) z<No configuration for: %s (dev_config=%r) (has_ip_address=%r)) � enumerater� rA rw rx rx ri r rg r{ )r' � netconfigr* �intf�has_ip_address�nicname� dhcp_override� dev_config� addr_typer5 �default_prefix�addr� netPrefix� privateIpr_ r9 r= r= r> r� sb �� �� � �r� c C s t jtdd�} | du r i S | S )z�Generate fallback network config excluding blacklisted devices. @return: Dictionary containing network version 2 standard configuration. T)rs � config_driverN)r �generate_fallback_configrv rZ r= r= r> r� ] s �r� c C sh | st } d}| D ])}tj�|�r1|s t�dtjjtj jg� d}tj� |�r,t � |� qt � |� qdS )a( Remove Azure-specific ubuntu network config for non-primary nics. @param paths: List of networking scripts or directories to remove when present. In certain supported ubuntu images, static udev rules or netplan yaml config is delivered in the base ubuntu image to support dhcp on any additional interfaces which get attached by a customer at some point after initial boot. Since the Azure datasource can now regenerate network configuration as metadata reports these new devices, we no longer want the udev rules or netplan's 90-hotplug-azure.yaml to configure networking on eth1 or greater as it might collide with cloud-init's configuration. Remove the any existing extended network scripts if the datasource is enabled to write network per-boot. Fz|Removing Ubuntu extended network scripts because cloud-init updates Azure network configuration on the following events: %s.TN)� UBUNTU_EXTENDED_NETWORK_SCRIPTSr� r� r� rw rn r r� r� � BOOT_LEGACY�isdirr �del_dirr� )r� �loggedr� r= r= r> rB k s � ��rB c C s t �| t�S rY )r �list_from_depends� datasources)�dependsr= r= r> �get_datasource_list� r� rP rY )r� )r )r r r� �os.pathrJ �xml.etree.ElementTree�etree� ElementTreer� �enumr �pathlibr r r �typingr r r r � cloudinitr r �loggingr r r r r �cloudinit.eventr r �cloudinit.net.dhcpr r r �cloudinit.net.ephemeralr �cloudinit.reportingr �cloudinit.sources.azurer �cloudinit.sources.helpersr � cloudinit.sources.helpers.azurer r r r r r r r! r" r# r$ r% r& r' r( r) r* �cloudinit.url_helperr+ � getLoggerr5 rw �DS_NAMErE rC � DEFAULT_FS�AGENT_SEED_DIRr! r/ r? r� �__annotations__rH rv rT rX r^ ri rp r{ r� r� r� r� r� r �res_diskrx r� rD r� r� �DEF_EPHEMERAL_LABELr� r r� r� r� r r r r rU r� r� r� r� rF r� r r r r r r� r� r� rB �DataSourceAzureNet�DEP_FILESYSTEMrN rP r= r= r= r> �<module> s L + ��� � n j���� �+ 1 � �G & � __pycache__/DataSourceAltCloud.cpython-310.pyc 0000644 00000015523 15027667240 0015156 0 ustar 00 o �Ad)! � @ s� d Z ddlZddlZddlZddlmZ ddlmZ ddlmZm Z m Z e� e �Z dZddgZi d d i d �Zd d � ZG dd� dej�Zdd� ZeejejffgZdd� ZdS )zb This file contains code used to gather the user data passed to an instance on RHEVm and vSphere. � N)�dmi)�log)�sources�subp�utilz/etc/sysconfig/cloud-info�modprobe�floppyi� � localhost)zblock-device-mappingz instance-idzlocal-hostname� placementc C sn | d }| d }z t �|��� }W |S ty6 z t �|��� }W Y |S ty5 t �td� Y Y dS w w )an Description: This callback will be applied by util.mount_cb() on the mounted file. Deltacloud file name contains deltacloud. Those not using Deltacloud but instead instrumenting the injection, could drop deltacloud from the file name. Input: mount_dir - Mount directory Returns: User Data z/deltacloud-user-data.txtz/user-data.txtz Failed accessing user data file.N)r � load_file�strip�IOError�logexc�LOG)� mount_dir�deltacloud_user_data_file�user_data_file� user_data� r �F/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceAltCloud.py�read_user_data_callback' s � � ��r c @ sH e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dS )�DataSourceAltCloud�AltCloudc C s" t j�| |||� d | _d| _d S )N)�/zfile://)r � DataSource�__init__�seed�supported_seed_starts)�self�sys_cfg�distro�pathsr r r r M s zDataSourceAltCloud.__init__c C s t j�| �}d|| jf S )Nz %s [seed=%s])r r �__str__r )r �rootr r r r" R s zDataSourceAltCloud.__str__c C s� t j�t�r$z t�t��� �� }W |S ty# t� t dt� Y dS w t � d�}|s-dS |�� }|� d�r8dS |� d�r?dS dS )at Description: Get the type for the cloud back end this instance is running on by examining the string returned by reading either: CLOUD_INFO_FILE or the dmi data. Input: None Returns: One of the following strings: 'RHEV', 'VSPHERE' or 'UNKNOWN' z'Unable to access cloud info file at %s.�UNKNOWNzsystem-product-name�RHEV�VMWARE�VSPHERE)�os�path�exists�CLOUD_INFO_FILEr r r �upperr r r r � read_dmi_data� startswith)r � cloud_type� system_name�sys_namer r r �get_cloud_typeV s* ��� z!DataSourceAltCloud.get_cloud_typec C sb t �d� | �� }t �dt|�� d|v r | �� rdS n d|v r'| �� r&dS ndS t�t d� dS )a� Description: User Data is passed to the launching instance which is used to perform instance configuration. Cloud providers expose the user data differently. It is necessary to determine which cloud provider the current instance is running on to determine how to access the user data. Images built with image factory will contain a CLOUD_INFO_FILE which contains a string identifying the cloud provider. Images not built with Imagefactory will try to determine what the cloud provider is based on system information. zInvoked get_data()zcloud_type: %sr% Tr' FzFailed accessing user data.)r �debugr2 �str�user_data_rhevm�user_data_vspherer r �r r/ r r r � _get_data s �� z DataSourceAltCloud._get_datac C s: | � � }t| d�s tj| _|dkrd| _d|�� | jf S )z(Return the subplatform metadata details.�sourcer% �/dev/fd0z%s (%s))r2 �hasattrr �METADATA_UNKNOWNr9 �lowerr7 r r r �_get_subplatform� s z#DataSourceAltCloud._get_subplatformc C s d}zt � W n tjy" } zt�td|� W Y d}~dS d}~ww d}z tj|dd� W n tjtfyK } zt�td|� W Y d}~dS d}~ww zt�|t �}W n) tym } z |j t j krc� W Y d}~nd}~w tj y} t�td|� Y nw || _ t| _|r�d S dS ) a� RHEVM specific userdata read If on RHEV-M the user data will be contained on the floppy device in file <user_data_file> To access it: modprobe floppy Leverage util.mount_cb to: mkdir <tmp mount dir> mount /dev/fd0 <tmp mount dir> The call back passed to util.mount_cb will do: read <tmp mount dir>/<user_data_file> NzFailed modprobe: %sFr: � )r* �timeoutzFailed udevadm_settle: %s �-Failed to mount %s when looking for user dataT)�modprobe_floppyr �ProcessExecutionErrorr r r �udevadm_settle�OSError�mount_cbr �errno�ENOENT�MountFailedError� userdata_raw�META_DATA_NOT_SUPPORTED�metadata)r � return_str�e� floppy_dev�errr r r r5 � sF ���� ����z"DataSourceAltCloud.user_data_rhevmc C s� d}t �d�}|D ];}zt �|t�}|r|| _W n+W q ty4 } z |jtjkr*� W Y d}~q d}~w t jyD t � t d|� Y q w || _ t | _ |rOdS dS )a� vSphere specific userdata read If on vSphere the user data will be contained on the cdrom device in file <user_data_file> To access it: Leverage util.mount_cb to: mkdir <tmp mount dir> mount /dev/fd0 <tmp mount dir> The call back passed to util.mount_cb will do: read <tmp mount dir>/<user_data_file> Nz LABEL=CDROMrA TF)r �find_devs_withrF r r9 rE rG rH rI r r rJ rK rL )r rM � cdrom_list� cdrom_devrP r r r r6 � s4 � ����z$DataSourceAltCloud.user_data_vsphereN) �__name__� __module__� __qualname__�dsnamer r" r2 r8 r> r5 r6 r r r r r I s )' 6r c C s& t � t�\} }t�dd�t�| � d S )NzCommand: %s Output%s� )r �CMD_PROBE_FLOPPYr r3 �join)�out�_errr r r rB s rB c C s t �| t�S )N)r �list_from_depends� datasources)�dependsr r r �get_datasource_list s r` )�__doc__rG r( �os.path� cloudinitr r �loggingr r r � getLoggerrT r r+ rY rK r r r rB �DEP_FILESYSTEM� DEP_NETWORKr^ r` r r r r �<module> s, �" F � __pycache__/DataSourceCloudSigma.cpython-310.pyc 0000644 00000007420 15027667240 0015473 0 ustar 00 o �Ad � @ s� d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dlm Z d dl m Z m Z e� e�ZG dd � d ej�ZeZeejffgZd d � ZdS ) � N)� b64decode)�dmi)�log)�sources)�DataSourceHostname)� SERIAL_PORT�Cepkoc @ sN e Zd ZdZdZdd� Zdd� Zdd� Zd d � Zdd d �Z dd� Z dd� Z dS )�DataSourceCloudSigmaz� Uses cepko in order to gather the server context from the VM. For more information about CloudSigma's Server Context: http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html � CloudSigmac C s$ t � | _d| _tj�| |||� d S )N� )r �cepko�ssh_public_keyr � DataSource�__init__)�self�sys_cfg�distro�paths� r �H/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceCloudSigma.pyr s z DataSourceCloudSigma.__init__c C s> t �d� t�d�}|st �d� dS t �d|� d|�� v S )z Uses dmi data to detect if this instance of cloud-init is running in the CloudSigma's infrastructure. z0determining hypervisor product name via dmi datazsystem-product-namez-system-product-name not available in dmi dataFzdetected hypervisor as %s� cloudsigma)�LOG�debugr � read_dmi_data�lower)r �sys_product_namer r r �is_running_in_cloudsigma" s z-DataSourceCloudSigma.is_running_in_cloudsigmac C s� d}| � � sdS z | j�� j}|d }W n ty# t�d� Y dS w | �|�d�g�| _ |t j kr5dS |�dd�� d�}|�d d�| _ d |v rOt| j �| _ d |�d i �v r^|d d | _|| _|d | _d S )zj Metadata is the whole server context and /meta/cloud-config is used as userdata. NF�metaz+CloudSigma: Unable to read from serial portzcloudinit-dsmode� base64_fieldsr �,zcloudinit-user-data� cloudinit� vendor_datar T)r r �all�result� Exceptionr r �_determine_dsmode�get�dsmoder �DSMODE_DISABLED�split� userdata_rawr �vendordata_raw�metadatar )r r' �server_context� server_metar r r r � _get_data0 s0 � � z DataSourceCloudSigma._get_datac C s dt S )z/Return the subplatform metadata source details.z cepko (%s))r �r r r r �_get_subplatformT s z%DataSourceCloudSigma._get_subplatformFc C sD t �d| jd �r| jd dd� }n | jd �d�d }t|d�S ) z� Cleans up and uses the server's name if the latter is set. Otherwise the first part from uuid is being used. z^[A-Za-z0-9 -_\.]+$�nameN�= �uuid�-r F)�re�matchr, r) r )r �fqdn� resolve_ip� metadata_only�retr r r � get_hostnameX s z!DataSourceCloudSigma.get_hostnamec C s | j gS )N)r r0 r r r �get_public_ssh_keysc s z(DataSourceCloudSigma.get_public_ssh_keysc C s | j d S )Nr4 )r, r0 r r r �get_instance_idf s z$DataSourceCloudSigma.get_instance_idN)FFF) �__name__� __module__� __qualname__�__doc__�dsnamer r r/ r1 r< r= r> r r r r r s $ r c C s t �| t�S )zK Return a list of data sources that match this set of dependencies )r �list_from_depends� datasources)�dependsr r r �get_datasource_listt s rG )r6 �base64r r r r �loggingr �cloudinit.sourcesr �$cloudinit.sources.helpers.cloudsigmar r � getLoggerr? r r r �DataSourceCloudSigmaNet�DEP_FILESYSTEMrE rG r r r r �<module> s X � __pycache__/DataSourceAliYun.cpython-310.pyc 0000644 00000004544 15027667240 0014651 0 ustar 00 o �Ad� � @ sx d dl mZ d dlmZmZ d dlmZ d dlmZ dZ G dd� dej�Z dd � Z d d � Z e ej ejffgZd d � ZdS )� )�List)�dmi�sources)� DataSourceEc2)�DataSourceHostnamezAlibaba Cloud ECSc @ sR e Zd ZU dZdgZdZg Zee e d< e dd� �Z ddd �Z d d � Z d d � ZdS )�DataSourceAliYun�AliYunzhttp://100.100.100.200z 2016-01-01�extended_metadata_versionsc C s dS )NzX-aliyun-ecs-metadata-token� ��selfr r �D/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceAliYun.py�imdsv2_token_put_header s z(DataSourceAliYun.imdsv2_token_put_headerFc C s* | j �d�}d}|d u rd}d}t||�S )N�hostnameFzlocalhost.localdomainT)�metadata�getr )r �fqdn� resolve_ip� metadata_onlyr � is_defaultr r r � get_hostname s z DataSourceAliYun.get_hostnamec C s t | j�di ��S )Nz public-keys)�parse_public_keysr r r r r r �get_public_ssh_keys" s z$DataSourceAliYun.get_public_ssh_keysc C s t � rtjjS tjjS �N)� _is_aliyun�EC2� CloudNames�ALIYUN�NO_EC2_METADATAr r r r �_get_cloud_name% s z DataSourceAliYun._get_cloud_nameN)FFF)�__name__� __module__� __qualname__�dsname� metadata_urls�min_metadata_versionr r �str�__annotations__�propertyr r r r r r r r r s r c C s t �d�tkS )Nzsystem-product-name)r � read_dmi_data�ALIYUN_PRODUCTr r r r r , s r c C s� g }| � � D ]>\}}t|t�r|�|�� � qt|t�r"|�|� qt|t�rD|�dg �}t|t�r:|�|�� � qt|t�rD|�|� q|S )Nz openssh-key) �items� isinstancer& �append�strip�list�extend�dictr )� public_keys�keys�_key_id�key_body�keyr r r r 0 s �r c C s t �| t�S r )r �list_from_depends� datasources)�dependsr r r �get_datasource_listG s r: N)�typingr � cloudinitr r �cloudinit.sourcesr r r r* r r r �DEP_FILESYSTEM� DEP_NETWORKr8 r: r r r r �<module> s � __pycache__/DataSourceHetzner.cpython-310.pyc 0000644 00000007665 15027667240 0015076 0 ustar 00 o �Ad� � @ s� d Z ddlm m mZ ddlmZ ddlmZ ddlm Z mZm Z ddl m Z ddlmZ e �e�ZdZed ed d �Zd Zd Zd ZG dd� dej�Zdd� ZeejffgZ dd� Z dS )z>Hetzner Cloud API Documentation https://docs.hetzner.cloud/� N)�dmi)�log)�net�sources�util)�NoDHCPLeaseError)�EphemeralDHCPv4z!http://169.254.169.254/hetzner/v1z /metadataz /userdata)� metadata_url� userdata_url�< � c @ s4 e Zd ZdZdd� Zdd� Zdd� Zedd � �Zd S ) �DataSourceHetzner�Hetznerc C s� t j�| |||� || _t� | _t�t�|ddgi �t g�| _ | j d | _ | j d | _ | j � dt�| _| j � dt�| _| j � dt�| _t j| _t j| _d S )N� datasourcer r r �retries�timeout� wait_retry)r � DataSource�__init__�distro�dict�metadatar � mergemanydict�get_cfg_by_path�BUILTIN_DS_CONFIG�ds_cfg�metadata_address�userdata_address�get� MD_RETRIESr � MD_TIMEOUTr � MD_WAIT_RETRYr �UNSET�_network_config�DSMODE_NETWORK�dsmode)�self�sys_cfgr �paths� r) �E/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceHetzner.pyr " s �� zDataSourceHetzner.__init__c C s* t � \}}|s dS z<tt�� dtd i| j�� d��" tj| j | j | j | j d�}tj | j| j | j | j d�}W d � n1 s?w Y W n tyX } zt�d|� � d }~ww t�|�| _|| _|d | jd< |d | jd < |�d d �| jd < |�d d �| jd < |�d d �| _| �� |kr�td ��dS )NF�urlz/metadata/instance-id)�iface�connectivity_url_data�tmp_dir)r � sec_betweenr zBailing, DHCP Exception: %sz instance-id�hostnamezlocal-hostname�network-configz public-keys� vendor_dataz6SMBIOS serial does not match instance ID from metadataT)�get_hcloud_datar r �find_fallback_nic� BASE_URL_V1r �get_tmp_exec_path� hc_helper� read_metadatar r r r � read_userdatar r �LOG�error�maybe_b64decode� userdata_raw� metadata_fullr r �vendordata_raw�get_instance_id� RuntimeError)r& � on_hetzner�serial�md�ud�er) r) r* � _get_data4 sR ���� �� �� �zDataSourceHetzner._get_datac C s t �| �� d�S )N�system-serial-number)r � instance_id_matches_system_uuidr@ )r& r' r) r) r* �check_instance_idm s �z#DataSourceHetzner.check_instance_idc C sT | j du rt�dtj� tj| _ | j tjkr| j S | jd }|s$td��|| _ | j S )z�Configure the networking. This needs to be done each boot, since the IP information may have changed due to snapshot and/or migration. Nz5Found None as cached _network_config. Resetting to %sr1 z'Unable to get meta-data from server....)r# r: �warningr r" r � Exception)r& � _net_configr) r) r* �network_configr s � z DataSourceHetzner.network_configN) �__name__� __module__� __qualname__�dsnamer rG rJ �propertyrN r) r) r) r* r s 9r c C s@ t �d�} | dkr dS t �d�}|r t�d|� d|fS td��)Nzsystem-manufacturerr )FNrH z#Running on Hetzner Cloud: serial=%sz+Hetzner Cloud detected, but no serial foundT)r � read_dmi_datar: �debugrA )� vendor_namerC r) r) r* r3 � s �r3 c C s t �| t�S )N)r �list_from_depends� datasources)�dependsr) r) r* �get_datasource_list� s rZ ) �__doc__�!cloudinit.sources.helpers.hetznerr �helpers�hetznerr7 � cloudinitr r �loggingr r �cloudinit.net.dhcpr �cloudinit.net.ephemeralr � getLoggerrO r: r5 r r r r! r r r3 �DEP_FILESYSTEMrX rZ r) r) r) r* �<module> s( �n � __pycache__/DataSourceDigitalOcean.cpython-310.pyc 0000644 00000006364 15027667240 0015775 0 ustar 00 o �Ad@ � @ s� d dl m m mZ d dlmZ d dlmZmZ e� e �Z ddiZ dZ dZdZdZG d d � d ej�ZeejffgZd d � ZdS ) � N)�log)�sources�util� metadata_urlz'http://169.254.169.254/metadata/v1.json� � Tc @ s< e Zd ZdZdd� Zdd� Zdd� Zdd � Zed d � �Z d S ) �DataSourceDigitalOcean� DigitalOceanc C s� t j�| |||� || _t� | _t�t�|ddgi �t g�| _ | j d | _ | j � dt �| _| j � dt�| _| j � dt�| _| j � dt�| _d | _d S )N� datasourcer r �retries�timeout� use_ip4LL� wait_retry)r � DataSource�__init__�distro�dict�metadatar � mergemanydict�get_cfg_by_path�BUILTIN_DS_CONFIG�ds_cfg�metadata_address�get� MD_RETRIESr � MD_TIMEOUTr � MD_USE_IPV4LLr � MD_WAIT_RETRYr �_network_config)�self�sys_cfgr �paths� r" �J/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceDigitalOcean.pyr s ��� z DataSourceDigitalOcean.__init__c C s t �� S �N)� do_helper� read_sysinfo)r r" r" r# � _get_sysinfo2 s z#DataSourceDigitalOcean._get_sysinfoc C s� | � � \}}|s dS t�d|� d }| jrt�| j�}tj| j| j | j | j d�}|| _ |� d|�| jd< |� d|�| jd< |� d�| jd< |� d �| jd < |� d d �| jd < |� dd �| _|� dd �| _|rkt�|� dS )NFz&Running on DigitalOcean. droplet_id=%s)r � sec_betweenr � droplet_idz instance-id�hostnamezlocal-hostname� interfaces� public_keysz public-keys�region�default�availability_zone� vendor_data� user_dataT)r' �LOG�infor r% �assign_ipv4_link_localr � read_metadatar r r r � metadata_fullr r �vendordata_raw� userdata_raw�del_ipv4_link_local)r �is_dor) � ipv4LL_nic�mdr" r" r# � _get_data5 s0 � z DataSourceDigitalOcean._get_datac C s t �| �� d�S )Nzsystem-serial-number)r � instance_id_matches_system_uuid�get_instance_id)r r r" r" r# �check_instance_idW s �z(DataSourceDigitalOcean.check_instance_idc C sP | j r| j S | j�d�}t�|� |std��| jd d }t�||�| _ | j S )z�Configure the networking. This needs to be done each boot, since the IP information may have changed due to snapshot and/or migration. r+ z'Unable to get meta-data from server....�dns� nameservers) r r r r2 �debug� Exceptionr6 r% � convert_network_configuration)r r+ rB r" r" r# �network_config\ s �z%DataSourceDigitalOcean.network_configN) �__name__� __module__� __qualname__�dsnamer r' r= r@ �propertyrF r" r" r" r# r s "r c C s t �| t�S r$ )r �list_from_depends� datasources)�dependsr" r" r# �get_datasource_listy s rO )�&cloudinit.sources.helpers.digitaloceanr �helpers� digitaloceanr% � cloudinitr �loggingr � getLoggerrG r2 r r r r r r r �DEP_FILESYSTEMrM rO r" r" r" r# �<module> s � Y� __pycache__/DataSourceGCE.cpython-310.pyc 0000644 00000022153 15027667240 0014042 0 ustar 00 o �Ad�/ � @ s d dl Z d dlZd dlmZ d dlmZ d dlmZ d dlm Z d dlm Z m Z m Z d dlmZ d dlmZ d d lmZ e �e�Zd Zd eiZd Zd ZdZddiZ G dd� d�Z G dd� de j �Z G dd� de �Z dd� Z!dd� Z"d8dd �Z#d9d d �Z$d d!� Z%e e j&ffe e j&e j'ffgZ(d"d#� Z)ed$k�rd dl*Z*d dl+Z+d d%lm,Z, e*j-d&d'�Z.e.j/d(d)d*ed+� e.j/d,d-d.d/d d0� e.�0� Z1e$e1j2e1j3d1�Z4d2e4v r�z e4d2 �5� e4d2< W n e6y� e+j7�8d3� e4d2= e,e4d2 ��5� e4d4< Y nw e9ej:e4d5d d6d7�� dS dS ):� N)� b64decode)�suppress)�dmi)�log)�sources� url_helper�util)�ug_util)�EphemeralDHCPv4)�DataSourceHostnamez3http://metadata.google.internal/computeMetadata/v1/� metadata_url)� instance-id�availability-zone�local-hostnamezLhttp://metadata.google.internal/computeMetadata/v1/instance/guest-attributes�hostkeyszMetadata-Flavor�Googlec @ s e Zd Zdd� Zddd�ZdS )�GoogleMetadataFetcherc C s || _ || _|| _d S �N)�metadata_address� num_retries�sec_between_retries)�selfr r r � r �A/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceGCE.py�__init__ s z GoogleMetadataFetcher.__init__Fc C s� d }z| j | }|r|d7 }tj|t| j| jd�}W n tjy7 } zd}t�|||� W Y d }~|S d }~ww |j dkrO|rGt � |j �}|S |j � d�}|S t�d||j � |S )Nz/?recursive=True)�url�headers�retries� sec_betweenzurl %s raised exception %s�� �utf-8zurl %s returned code %s)r r �readurl�HEADERSr r �UrlError�LOG�debug�coder � decode_binary�contents�decode) r �path�is_text� is_recursive�valuer �resp�exc�msgr r r � get_value$ s2 � �� ��z GoogleMetadataFetcher.get_valueN)F)�__name__� __module__� __qualname__r r1 r r r r r s r c @ sj e Zd ZdZdZdd� Zdd� Zedd� �Zd d � Z d d � Z d d� Z ddd�Z edd� �Z edd� �ZdS )� DataSourceGCE�GCEFc C sr t j�| |||� d | _|r t�||�\}}t�|�\| _}t� | _t � t � |ddgi �t g�| _ | j d | _d S )N� datasourcer6 r )r � DataSourcer � default_userr �normalize_users_groups�extract_default�dict�metadatar � mergemanydict�get_cfg_by_path�BUILTIN_DS_CONFIG�ds_cfgr )r �sys_cfg�distro�paths�users�_groups� _user_configr r r r C s ��zDataSourceGCE.__init__c C s� | � � }t� }| jrt| j| j�� d�}|� tjt j dt | j |d�d�}W d � n1 s/w Y |d sN|d rEt � |d � dS t � |d � dS |d | _|d | _d S ) N)�tmp_dirz Crawl of GCE metadata service)�address� url_params)�kwargs�success�platform_reports_gce�reasonF� meta-data� user-dataT)�get_url_params�noop�perform_dhcp_setupr �fallback_interfacerC �get_tmp_exec_pathr �log_timer$ r% �read_mdr �warningr= � userdata_raw)r rJ �network_context�retr r r � _get_dataR s4 ��� � � zDataSourceGCE._get_datac C s d S r r �r r r r � launch_indexo s zDataSourceGCE.launch_indexc C � | j d S )Nr �r= r] r r r �get_instance_idt s z DataSourceGCE.get_instance_idc C s | j d }t|| j�S )N�public-keys-data)r= �_parse_public_keysr9 )r �public_keys_datar r r �get_public_ssh_keysw s z!DataSourceGCE.get_public_ssh_keysc C s |D ]}t |� qd S r )�#_write_host_key_to_guest_attributes)r r �keyr r r �publish_host_keys{ s �z DataSourceGCE.publish_host_keysc C s t | jd �d�d d�S )Nr �.r F)r r= �split)r �fqdn� resolve_ip� metadata_onlyr r r � get_hostname s �zDataSourceGCE.get_hostnamec C r_ )Nr r` r] r r r �availability_zone� s z DataSourceGCE.availability_zonec C s | j �dd�d S )N�-� r )ro �rsplitr] r r r �region� s zDataSourceGCE.regionN)FFF)r2 r3 r4 �dsnamerS r r\ �propertyr^ ra re rh rn ro rs r r r r r5 > s r5 c @ s e Zd ZdZdS )�DataSourceGCELocalTN)r2 r3 r4 rS r r r r rv � s rv c C sT dt t| f }|�d�}tj||tddd�}|�� r"t�d| � d S t�d| � d S )Nz%s/%s/%sr �PUTF)r �datar �request_method� check_statusz&Wrote %s host key to guest attributes.z0Unable to write %s host key to guest attributes.) �GUEST_ATTRIBUTES_URL�HOSTKEY_NAMESPACE�encoder r! r" �okr$ r% )�key_type� key_valuer r. r r r rf � s �rf c C s� z| � d d�dd � \}}W n ttfy Y dS w |dkr!dS zt�|�}W n ty2 Y dS w d|vr9dS |d }d}z tj�||�}W n tyR Y dS w tj�� |kS )N� � Fz google-ssh�expireOnz%Y-%m-%dT%H:%M:%S+0000)rj � ValueError�AttributeError�json�loads�datetime�strptime�utcnow)� public_key�schema�json_str�json_obj� expire_str� format_str� expire_timer r r � _has_expired� s, � � �r� c C sr g }| s|S | D ].}|rt dd� |D ��sq|�dd�}t|�dkr#q|\}}|d|fv r6t|�s6|�|� q|S )Nc s s � | ] }t |�d k V qdS )� N)�ord)�.0�cr r r � <genexpr>� s � z%_parse_public_keys.<locals>.<genexpr>�:rq r� � cloudinit)�allrj �lenr� �append)rd r9 � public_keysr� �split_public_key�userrg r r r rc � s �rc Tc C s� | d u rt } d d dd d�}t� |d< |r |d s d|d< |S t�| �s1t�d| � d| |d< |S g d�}t| |j|j�}i }|D ]1\}}} } } d } |D ]} |� | | | �}|d ur[|} qL| rn| d u rnd }|| |d< | S | ||< qAt � |d pzd �}t � |d p�d �}|� d �|� d�g}|� dd�� � }|dkr�|� d �s�|�|� d�� |�|� d �� d�dd� |D ��}|�� |d< |d r�|d �d�d |d< d|v r�|d �d�}|� d�}|d kr�t|�}n|r�t�d |� ||d< ||d < d |d < |S )!NF)rO rP rL rN rM zNot running on GCE.rN z%s is not resolvablez address "%s" is not resolvable))r )z instance/idTTF)r )z instance/zoneTTF)r )zinstance/hostnameTTF)� instance-data)zinstance/attributesFFT)� project-data)zproject/attributesFFTz)required key %s returned nothing. not GCEr� z{}r� �sshKeyszssh-keyszblock-project-ssh-keys� �true� c S s g | ]}|r|�qS r r )r� rg r r r � <listcomp> s zread_md.<locals>.<listcomp>rb r �/���rP r zuser-data-encoding�base64z(unknown user-data-encoding: %s, ignoringrO TrL )� MD_V1_URLrM r �is_resolvable_urlr$ r% r r r r1 r� r� �get�lowerr� �join� splitlinesrj r} r rX )rI rJ �platform_checkr[ �url_map�metadata_fetcher�md�mkeyrD �requiredr+ r, r- r* � new_valuer0 � instance_data� project_data� valid_keys� block_projectrd �ud�encodingr r r rW � sl � �� rW c C sP t �d�pd} | dks| dkrdS t �d�pd}|�d�r dS t�d| |� d S ) Nzsystem-product-namezN/AzGoogle Compute Enginer Tzsystem-serial-numberz GoogleCloud-z6Not running on google cloud. product-name=%s serial=%sF)r � read_dmi_data� startswithr$ r% )�pname�serialr r r rM % s �rM c C s t �| t�S r )r �list_from_depends� datasources)�dependsr r r �get_datasource_list= s r� �__main__)� b64encodezQuery GCE Metadata Service)� descriptionz --endpoint�URLz The url of the metadata service.)�metavar�help�defaultz--no-platform-checkr� z Ignore smbios platform check� store_false)�destr� �actionr� )rI r� rP z/User-data cannot be decoded. Writing as base64 z user-data-b64rq )�,z: )�indent� sort_keys� separatorsr )NNT);r� r� r� r � contextlibr rR r� r r �loggingr r r �cloudinit.distrosr �cloudinit.net.ephemeralr �cloudinit.sourcesr � getLoggerr2 r$ r� r@ �REQUIRED_FIELDSr{ r| r" r r8 r5 rv rf r� rc rW rM �DEP_FILESYSTEM� DEP_NETWORKr� r� �argparse�sysr� �ArgumentParser�parser� add_argument� parse_args�args�endpointr� rx r) �UnicodeDecodeError�stderr�write�print�dumpsr r r r �<module> s| � P " M � �� ��� __pycache__/DataSourceIBMCloud.cpython-310.pyc 0000644 00000030776 15027667240 0015054 0 ustar 00 o �Ad78 � @ s d Z ddlZddlZddlZddlmZ ddlmZmZm Z ddl m Z e� e �ZdZG dd� d�ZejejfZG d d � d ej�Zd d � Zd d� Z d dd�Zdd� Zdd� Zdd� Zeej ffgZ dd� Z e d kr�ddl Z e j d d �Z!e!�"� Z#e� Z$e%e �&e$�� dS dS ) a, Datasource for IBMCloud. IBMCloud is also know as SoftLayer or BlueMix. IBMCloud hypervisor is xen (2018-03-10). There are 2 different api exposed launch methods. * template: This is the legacy method of launching instances. When booting from an image template, the system boots first into a "provisioning" mode. There, host <-> guest mechanisms are utilized to execute code in the guest and configure it. The configuration includes configuring the system network and possibly installing packages and other software stack. After the provisioning is finished, the system reboots. * os_code: Essentially "launch by OS Code" (Operating System Code). This is a more modern approach. There is no specific "provisioning" boot. Instead, cloud-init does all the customization. With or without user-data provided, an OpenStack ConfigDrive like disk is attached. Only disks with label 'config-2' and UUID '9796-932E' are considered. This is to avoid this datasource claiming ConfigDrive. This does mean that 1 in 8^16 (~4 billion) Xen ConfigDrive systems will be incorrectly identified as IBMCloud. The combination of these 2 launch methods and with or without user-data creates 6 boot scenarios. A. os_code with user-data B. os_code without user-data Cloud-init is fully operational in this mode. There is a block device attached with label 'config-2'. As it differs from OpenStack's config-2, we have to differentiate. We do so by requiring the UUID on the filesystem to be "9796-932E". This disk will have the following files. Specifically note, there is no versioned path to the meta-data, only 'latest': openstack/latest/meta_data.json openstack/latest/network_data.json openstack/latest/user_data [optional] openstack/latest/vendor_data.json vendor_data.json as of 2018-04 looks like this: {"cloud-init":"#!/bin/bash echo 'root:$6$<snip>' | chpasswd -e"} The only difference between A and B in this mode is the presence of user_data on the config disk. C. template, provisioning boot with user-data D. template, provisioning boot without user-data. With ds-identify cloud-init is fully disabled in this mode. Without ds-identify, cloud-init None datasource will be used. This is currently identified by the presence of /root/provisioningConfiguration.cfg . That file is placed into the system before it is booted. The difference between C and D is the presence of the METADATA disk as described in E below. There is no METADATA disk attached unless user-data is provided. E. template, post-provisioning boot with user-data. Cloud-init is fully operational in this mode. This is identified by a block device with filesystem label "METADATA". The looks similar to a version-1 OpenStack config drive. It will have the following files: openstack/latest/user_data openstack/latest/meta_data.json openstack/content/interfaces meta.js meta.js contains something similar to user_data. cloud-init ignores it. cloud-init ignores the 'interfaces' style file here. In this mode, cloud-init has networking code disabled. It relies on the provisioning boot to have configured networking. F. template, post-provisioning boot without user-data. With ds-identify, cloud-init will be fully disabled. Without ds-identify, cloud-init None datasource will be used. There is no information available to identify this scenario. The user will be able to SSH in as as root with their public keys that have been installed into /root/ssh/.authorized_keys during the provisioning stage. TODO: * is uuid (/sys/hypervisor/uuid) stable for life of an instance? it seems it is not the same as data's uuid in the os_code case but is in the template case. � N)�log)�sources�subp�util)� openstackz 9796-932Ec @ s e Zd ZdZdZdZdZdZdS )� PlatformszTemplate/Live/MetadatazUNABLE TO BE IDENTIFIED.z Template/Provisioning/Metadataz!Template/Provisioning/No-Metadataz OS-Code/LiveN)�__name__� __module__� __qualname__�TEMPLATE_LIVE_METADATA�TEMPLATE_LIVE_NODATA� TEMPLATE_PROVISIONING_METADATA� TEMPLATE_PROVISIONING_NODATA�OS_CODE� r r �F/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceIBMCloud.pyr l s r c sT e Zd ZdZdZ� fdd�Z� fdd�Zdd� Zd d � Zd d � Z e d d� �Z � Z S )�DataSourceIBMCloud�IBMCloudNc s0 t t| ��|||� d | _d | _d | _d | _d S �N)�superr �__init__�source�_network_config� network_json�platform)�self�sys_cfg�distro�paths�� __class__r r r s zDataSourceIBMCloud.__init__c s$ t t| ��� }d|| j| jf }|S )Nz %s [%s %s])r r �__str__r r )r �root�mstrr r r r! � s zDataSourceIBMCloud.__str__c C s� t � }|d u r dS |d | _|d | _|d | _|�d�| _|�d�| _|�d�}|| _|d | _z t � |�| _ W d S t yV } zt �d |� d | _ W Y d }~d S d }~ww ) NFr r �metadata�userdata� networkdata� vendordata� system-uuidz"Invalid content in vendor-data: %sT)�read_mdr r r$ �get� userdata_rawr �vendordata_pure� system_uuidr �convert_vendordata�vendordata_raw� ValueError�LOG�warning)r �results�vd�er r r � _get_data� s( � ��z DataSourceIBMCloud._get_datac C s d| j | jf S )z/Return the subplatform metadata source details.z%s (%s))r r �r r r r �_get_subplatform� s z#DataSourceIBMCloud._get_subplatformc C s | j du rdS | j t� kS )a quickly (local check only) if self.instance_id is still valid in Template mode, the system uuid (/sys/hypervisor/uuid) is the same as found in the METADATA disk. But that is not true in OS_CODE mode. So we read the system_uuid and keep that for later compare.NF)r- �_read_system_uuid)r r r r r �check_instance_id� s z$DataSourceIBMCloud.check_instance_idc C s\ | j tjkr ddd�S | jd u r+| jd ur&t�d� tj| jd d�| _| jS t�d� | jS )N�disabled� )�config�versionz(network config provided via network_json)� known_macsz#no network configuration available.) r r r r r r1 �debugr �convert_net_jsonr7 r r r �network_config� s � �z!DataSourceIBMCloud.network_config) r r r �dsnamer- r r! r6 r8 r: �propertyrB � __classcell__r r r r r z s r c C s& d} t j�| �s d S t�| ��� �� S )Nz/sys/hypervisor/uuid)�os�path�isfiler � load_file�strip�lower)� uuid_pathr r r r9 � s r9 c C s t j�d�S )Nz /proc/xen)rF rG �existsr r r r �_is_xen� � rN �#/root/provisioningConfiguration.cfg�/root/swinstall.log�/proc/1/environc C s� t j�| �rCd| }d}t j�|�r<t j�|�r1t �|�jt �|�jk}|d||r+dndf 7 }n|d||f 7 }d}n|d| 7 }ndd | }}t�d ||� |S ) z@Return boolean indicating if this boot is ibm provisioning boot.zconfig '%s' exists.Tz log '%s' from %s boot.�current�previousz. log '%s' existed, but no reference file '%s'.Fz log '%s' did not exist.zconfig '%s' did not exist.zibm_provisioning=%s: %s)rF rG rM �stat�st_mtimer1 r@ )�prov_cfg�inst_log�boot_ref�msg�resultr r r �_is_ibm_provisioning� s( � ��r\ c C sR d} d}d}t � s |S i }zt�� }W n tjy- } z t�d|� W Y d}~dS d}~ww t|�� �D ]B}|| }|� dd�� � }|� dd�� � } || |fvrQq4||v r`t�d ||| |� q4||krr| t krrt� d ||| |� q4|||< q4|� | i �� d �} |� |i �� d �} | r�t j| fS | r�t� r�t j| fS t j| fS t� r�t jdfS |S ) z�Return a tuple (Platform, path) If this is Not IBM cloud, then the return value is (None, None). An instance in provisioning mode is considered running on IBM cloud.�METADATAzCONFIG-2)NNzFailed to run blkid: %sN�LABEL� �UUIDz.Duplicate fslabel '%s'. existing=%s current=%sz/Skipping %s with LABEL=%s due to uuid != %s: %s�DEVNAME)rN r �blkidr �ProcessExecutionErrorr1 r2 �sorted�keysr* �upper�IBM_CONFIG_UUIDr@ r r r\ r r r ) � label_mdata� label_cfg2� not_found�fslabels�devsr5 �dev�data�label�uuid� metadata_path� cfg2_pathr r r �get_ibm_platform� s` �� �� rs c C s� t � \} }| du rt�d� dS | tv r t�d| � dS | |t� d�}ztj�|�r/t|�}nt � |t�}W n t j yM } z t d| ||f �|�d}~ww |�|� |S )a Read data from IBM Cloud. @return: None if not running on IBM Cloud. dictionary with guaranteed fields: metadata, version and optional fields: userdata, vendordata, networkdata. Also includes the system uuid from /sys/hypervisor/uuid.Nz!This is not an IBMCloud platform.z/Cloud-init is disabled during provisioning: %s.)r r r( z8Failed reading IBM config disk (platform=%s path=%s): %s)rs r1 r@ � PROVISIONINGr9 rF rG �isdir�metadata_from_dirr �mount_cbr �BrokenMetadata� RuntimeError�update)r rG �retr3 r5 r r r r) & s8 � ������ r) c C s� dd� }dd� }d|d�|fd|d�d fd |d �|fd |d �|fg}i }|D ]\\}}}t j�| |�}d } z tj|dd�} W n tyV } z t�d|| � W Y d } ~ nd } ~ ww | d u s_|d u rb| } n z|| �} W n ty} } z t � d|| f ��d } ~ ww | ||< q&|� d�d u r�t � d| ��i |d< |d } |d } d| v r�z t � | d �| d< W n ttfy� } zt � d| ��d } ~ ww d}|D ]\}}|| v r�| | | |< q�|S )a� Walk source_dir extracting standardized metadata. Certain metadata keys are renamed to present a standardized set of metadata keys. This function has a lot in common with ConfigDriveReader.read_v2 but there are a number of inconsistencies, such key renames and as only presenting a 'latest' version which make it an unlikely candidate to share code. @return: Dict containing translated metadata, userdata, vendordata, networkdata as present. c S s t j�dd| �S )Nr �latest)rF rG �join)�fnamer r r �opathY � z metadata_from_dir.<locals>.opathc S s t �| �d��S )Nzutf-8)�json�loads�decode)�blobr r r �load_json_bytes\ r� z*metadata_from_dir.<locals>.load_json_bytes� metadata_rawzmeta_data.jsonr% � user_dataNr' zvendor_data.jsonr& znetwork_data.jsonF)r� z Failed reading path '%s': %szFailed decoding %s: %sz)%s missing required file 'meta_data.json'r$ � random_seedz.Badly formatted metadata random_seed entry: %s))� public_keysz public-keys)�hostnamezlocal-hostname)rp z instance-id)rF rG r} r rI �IOErrorr1 r@ � Exceptionr rx r* �base64� b64decoder0 � TypeError)� source_dirr r� �filesr3 �namerG �transl�fpath�rawr5 rn �md_raw�md�renames�mdname�newnamer r r rv J sd ��� ��� ���� �rv c C s t �| t�S r )r �list_from_depends� datasources)�dependsr r r �get_datasource_list� rO r� �__main__zQuery IBM Cloud Metadata)� description)rP rQ rR )'�__doc__r� r� rF � cloudinitr �loggingr r r �cloudinit.sources.helpersr � getLoggerr r1 rg r r r rt � DataSourcer r9 rN r\ rs r) rv �DEP_FILESYSTEMr� r� �argparse�ArgumentParser�parser� parse_args�argsrn �print� json_dumpsr r r r �<module> sB ] �E � <$ Q� � __pycache__/__init__.cpython-310.pyc 0000644 00000071477 15027667240 0013245 0 ustar 00 o �Ad+� � @ s� d dl Z d dlZd dlZd dlZd dlZd dlmZ d dlmZm Z d dl m Z m Z m Z mZmZ d dlmZmZ d dlmZ d dlmZmZ d dlmZ d d lmZ d d lmZ d d l m Z d d l m Z m Z d d l!m"Z" d dl#m$Z$ d dl%m&Z& d dl'm(Z( dZ)dZ*dZ+dZ,e)e*e+gZ-dZ.dZ/dZ0dZ1dZ2dZ3dZ4d Z5e�6e7�Z8d d d � fd d!d � fd"d#d � fd$�Z9e G d%d&� d&e��Z:G d'd(� d(e;�Z<G d)d*� d*e;�Z=G d+d,� d,e;�Z>dTd/d0�Z?e2fd1d2�Z@ed3g d4��ZAed5d6d7g�ZBG d8d� de&e jCd9�ZDd:d;� ZEd<eeDeFf fd=d>�ZGd?d@� ZH AdUdBeFd<eIfdCdD�ZJdEdF� ZKdVdHdI�ZLG dJdK� dKeM�ZNdLdM� ZOdNeDdOeFd<eIfdPdQ�ZPdOeFd<eeD fdRdS�ZQdS )W� N)� namedtuple)�Enum�unique)�Any�Dict�List�Optional�Tuple)�dmi�importer)�log)�net� type_utils)� user_data)�util)� write_json)�Distro)� EventScope� EventType)� launch_index)�Paths)�CloudInitPickleMixin)�events�disabled�localr �pass� FILESYSTEM�NETWORK� DataSourcez|EXPERIMENTAL: The structure and format of content scoped under the 'ds' key may change in subsequent releases of cloud-init.zredacted for non-root user� cloud-name�_unset�unknownz aws-chinac C � | dkS �N�aws� ��cr% r% �</usr/lib/python3/dist-packages/cloudinit/sources/__init__.py�<lambda>? � r) zaws-govc C r" r# r% r& r% r% r( r) @ r* z azure-chinac C r" )N�azurer% r& r% r% r( r) A r* )zcn-zus-gov-�chinac @ s2 e Zd ZdZdZdZdZdZdZde fdd �Z d S ) �NetworkConfigSourcezb Represents the canonical list of network config sources that cloud-init knows about. �cmdline�ds� system_cfg�fallback� initramfs�returnc C � | j S �N��value��selfr% r% r( �__str__R � zNetworkConfigSource.__str__N) �__name__� __module__� __qualname__�__doc__�CMD_LINE�DS� SYSTEM_CFG�FALLBACK� INITRAMFS�strr: r% r% r% r( r- E s r- c @ � e Zd ZdZdS )� DatasourceUnpickleUserDataErrorzERaised when userdata is unable to be unpickled due to python upgradesN�r< r= r> r? r% r% r% r( rG V � rG c @ � e Zd ZdS )�DataSourceNotFoundExceptionN�r< r= r> r% r% r% r( rK Z � rK c @ rF )�InvalidMetaDataExceptionz8Raised when metadata is broken, unavailable or disabled.NrH r% r% r% r( rN ^ rI rN � r% c C s� t �| �}g }g }| �� D ]V\}}|r|d | }n|}|�� |v s(|�� |v r-|�|� t|t�rD|�d�rD|�|� |�dd�||< t|t �rct |||�} |� | � d�� |� | � d�� | ||< q t |�|d< t |�|d< |S )z�Process all instance metadata cleaning it up for persisting as json. Strip ci-b64 prefix and catalog any 'base64_encoded_keys' as a list @return Dict copy of processed metadata. �/zci-b64:rO �base64_encoded_keys�sensitive_keys)�copy�deepcopy�items�lower�append� isinstancerE � startswith�replace�dict�process_instance_metadata�extend�pop�sorted) �metadata�key_pathrR �md_copyrQ � sens_keys�key�val� sub_key_path� return_valr% r% r( r\ b s0 �� r\ c C s� | � dg �s| S t�| �}| � d�D ]+}|�d�}|}|D ]}||v r4t|| t�r4||d kr4|| }q ||v r=|||< q|S )z�Redact any sensitive keys from to provided metadata dictionary. Replace any keys values listed in 'sensitive_keys' with redact_value. rR rP ���)�getrS rT �splitrX r[ )r` � redact_valuerb ra � path_parts�obj�pathr% r% r( �redact_sensitive_keys� s" � ��ro � URLParams)�max_wait_seconds�timeout_seconds� num_retries�sec_between_retries�DataSourceHostname�hostname� is_defaultc @ s� e Zd ZU eZdZdZdZdZdZ dZ e j e j e je jfZee df ed< dZdZdZd Zejejejej ej hiZ ejejhiZ d e fd e fd i fd dddddf Z!eee"e#f df ed< dZ$dZ%ee"df ed< dZ&d Z'dzde(de)fdd�Z*de+d dfd d �Z,d d � Z-d e.fd!d"�Z/d#d$� Z0d%d&� Z1d'd(� Z2d{d*d+�Z3d e.fd,d-�Z4d|d/d0�Z5d e.fd1d2�Z6d3d4� Z7d}d5d6�Z8d7d8� Z9d9d:� Z:e;d;d<� �Z<e;d=d>� �Z=e;d?d@� �Z>dAdB� Z?e;dCdD� �Z@dEdF� ZAe;dGdH� �ZBdIdJ� ZCe;dKdL� �ZDdMdN� ZEdOdP� ZFdQdR� ZGdSdT� ZHdUdV� ZIdWdX� ZJdYdZ� ZKd[d\� ZLd]d^� ZMe;d_d`� �ZNe;dadb� �ZOdcdd� ZPd~dedf�ZQdgdh� ZRdieSe fdjdk�ZTdieSe d e.fdldm�ZUdndo� ZVeWddpdq��ZXe;drds� �ZYe;dtdu� �ZZdvdw� Z[dxdy� Z\dS )�r z en_US.UTF-8�_undefN.�network_config_sourcesrh � � � � ec2_metadata� network_jsonr` )�userdataN)� userdata_rawN)� vendordataN)�vendordata_rawN)� vendordata2N)�vendordata2_rawN�cached_attr_defaultsF)� merged_cfgzsecurity-credentialsr � user-datar r� � vendor-datazds/vendor_data�sensitive_metadata_keys�distro�pathsc C s� || _ || _|| _d | _i | _d | _d | _d | _d | _d | _ t � | j d| j fi �| _ | j s0i | _ |s;t�| j�| _d S || _d S )N� datasource)�sys_cfgr� r� r r` r� r� r� r� r� r �get_cfg_by_path�dsname�ds_cfg�ud�UserDataProcessor�ud_proc)r9 r� r� r� r� r% r% r( �__init__ s$ � zDataSource.__init__�ci_pkl_versionr3 c C s� t | d�sd| _t | d�sd| _t | d�sd| _t | d�rA| jdurCzt| j� W dS ty@ } z t�d|� t � |�d}~ww dS dS )z(Perform deserialization fixes for Paths.r� Nr� �skip_hotplug_detectFr z:Unable to unpickle datasource: %s. Ignoring current cache.) �hasattrr� r� r� r rE �AttributeError�LOG�debugrG )r9 r� �er% r% r( � _unpickle1 s$ ����zDataSource._unpicklec C s t �| �S r5 �r �obj_namer8 r% r% r( r: I s zDataSource.__str__c C � dS )z#Check if running on this datasourceTr% r8 r% r% r( � ds_detectL � zDataSource.ds_detectc C s | j �dg �| jg| jdgfv S )z�Override if either: - only a single datasource defined (nothing to fall back to) - TODO: commandline argument is used (ci.ds=OpenStack) �datasource_list�None)r� ri r� r8 r% r% r( �override_ds_detectP s �z DataSource.override_ds_detectc C sH | � � rt�d| � | �� S | �� r t�d| � | �� S t�d| � dS )z&Overrides runtime datasource detectionz5Machine is configured to run on single datasource %s.zMachine is running on %s.z#Datasource type %s is not detected.F)r� r� r� r� � _get_datar8 r% r% r( �_check_and_get_dataZ s �� �z DataSource._check_and_get_datac C s� | � � j}| �� }| j}|d }di ddg�d|�d|�dt| j| j| j��d| j�d | j�d |d d �d |d d �d|d d �d| j�d| �� �d|d �d|�d|�d|d d �d|�d|�|d d | j| j |d |d d ��iS ) z2Return a dictionary of standardized metadata keys.�sys_info�v1� _beta_keys� subplatform�availability-zone�availability_zone�cloud_idr � cloud_namer� �distr �distro_versionr| �distro_release� �platform�public_ssh_keys�python_version�python� instance-id� instance_id�kernel_release�uname�local-hostname�local_hostname� �variant)�machine�regionr� �system_platformr� ) � get_hostnamerv �get_instance_idr� �canonical_cloud_idr� r� � platform_type�get_public_ssh_keysr� )r9 � instance_datar� r� r� �sysinfor% r% r( �_get_standardized_metadatag s` ��� ���� � � � � ���� ��� ��z%DataSource._get_standardized_metadatar% c C sP | j sdS |r |}n| j}|D ]\}}t| |�r t| ||� q|s&d| _ dS dS )z�Reset any cached metadata attributes to datasource defaults. @param attr_defaults: Optional tuple of (attr, value) pairs to set instead of cached_attr_defaults. NF)� _dirty_cacher� r� �setattr)r9 � attr_defaults� attr_values� attributer7 r% r% r( �clear_cached_attrs� s � �z DataSource.clear_cached_attrsc C s" d| _ | �� }|s |S | �� |S )z�Datasources implement _get_data to setup metadata and userdata_raw. Minimally, the datasource should return a boolean True on success. T)r� r� �persist_instance_data)r9 � return_valuer% r% r( �get_data� s zDataSource.get_dataTc C s^ |rt j�| jj�rt| | j�d�� t| d�r1t� t | d��}|� dd� |� dd� d|i}n/dd| j ii}t| d�rLt | d�}|t krL||d d< t| d �r`t | d �}|t kr`||d d < t|d d < t� | j�|d < d |d d < t�� |d < |�| �|�� zt�|�}tt�|�| jd�}W n5 ty� } zt�dt |�� W Y d}~dS d}~w t y� } zt�dt |�� W Y d}~dS d}~ww | j� d�} |d � dd�} t j� | jj!d�} t�"| � d| � �| � d�� d} | � d| � �} t j�#| ��rt j�$| �} tj%| | dd� | �r| | k�rt�&| � t'| |dd� | j� d �}t'|t(|�� dS ) aP Process and write INSTANCE_JSON_FILE with all instance metadata. Replace any hyphens with underscores in key names for use in template processing. :param write_cache: boolean set True to persist obj.pkl when instance_link exists. @return True on successful write, False otherwise. �obj_pkl�_crawled_metadatar� Nr� r/ � meta_datar~ r} �_docr� zUMerged cloud-init system config from /etc/cloud/cloud.cfg and /etc/cloud/cloud.cfg.d/r� )rR z'Error persisting instance-data.json: %sF�instance_data_sensitiver� r� �nonezcloud-id�-� T)�forcei� )�moder� ))�osrn �lexistsr� � instance_link� pkl_store� get_ipath_curr� rS rT �getattrr^ r` �UNSET�EXPERIMENTAL_TEXTr� r � system_info�updater� � json_dumpsr\ �json�loadsr� � TypeErrorr� �warningrE �UnicodeDecodeError� get_runpathri �join�run_dir� write_file�exists�realpath�sym_link�del_filer ro )r9 � write_cache�crawled_metadatar� r~ r} �content�processed_datar� �json_sensitive_filer� � cloud_id_file�prev_cloud_id_file�new_cloud_id_file� json_filer% r% r( r� � sl � � ���� z DataSource.persist_instance_datac C s t d��)z@Walk metadata sources, process crawled data and save attributes.zlSubclasses of DataSource must implement _get_data which sets self.metadata, vendordata_raw and userdata_raw.)�NotImplementedErrorr8 r% r% r( r� � s �zDataSource._get_datac C sB | j }z t| j�d| j ��}W n ty$ t�td| j�d�|� Y nw | j}zt dt| j�d| j���}W n tyO | j}t�td| j�d�|� Y nw | j }z t| j�d| j ��}W n t yt t�td| j�d�|� Y nw | j }z t| j�d| j ��}W n t y� t�td | j�d�|� Y nw t ||||�S ) z�Return the Datasource's preferred url_read parameters. Subclasses may override url_max_wait, url_timeout, url_retries. @return: A URLParams object with max_wait_seconds, timeout_seconds, num_retries. �max_waitz6Config max_wait '%s' is not an int, using default '%s'r �timeoutz5Config timeout '%s' is not an int, using default '%s'�retriesz5Config retries '%s' is not an int, using default '%s'rt zAConfig sec_between_retries '%s' is not an int, using default '%s')� url_max_wait�intr� ri � ValueErrorr �logexcr� � url_timeout�max� url_retries� Exception�url_sec_between_retriesrp )r9 r� r r rt r% r% r( �get_url_params� sd �� �� ���� �� zDataSource.get_url_paramsc C s2 | j d u r| j�| �� �| _ |r| �| j �S | j S r5 )r r� �process�get_userdata_raw� _filter_xdata)r9 � apply_filterr% r% r( � get_userdata: s zDataSource.get_userdatac C �" | j d u r| j�| �� �| _ | j S r5 )r� r� r �get_vendordata_rawr8 r% r% r( �get_vendordataA � zDataSource.get_vendordatac C r r5 )r� r� r �get_vendordata2_rawr8 r% r% r( �get_vendordata2F r zDataSource.get_vendordata2c C s2 | j du rt�� | _ | j du rt�d| j� | j S )zADetermine the network interface used during local network config.Nz(Did not find a fallback interface on %s.)�_fallback_interfacer �find_fallback_nicr� r� r� r8 r% r% r( �fallback_interfaceK s �z DataSource.fallback_interfacec C s. t | d�s | j�� | _| js| j�� | _| jS )N�_platform_type)r� r� rV r r8 r% r% r( r� V s zDataSource.platform_typec C s* t | d�s | �� | _| js| �� | _| jS )a� Return a string representing subplatform details for the datasource. This should be guidance for where the metadata is sourced. Examples of this on different clouds: ec2: metadata (http://169.254.169.254) openstack: configdrive (/dev/path) openstack: metadata (http://169.254.169.254) nocloud: seed-dir (/seed/dir/path) lxd: nocloud (/seed/dir/path) � _subplatform)r� �_get_subplatformr r8 r% r% r( r� _ s zDataSource.subplatformc C s t | d�r dt| d� S tS )z?Subclasses should implement to return a "slug (detail)" string.�metadata_addressz metadata (%s))r� r� �METADATA_UNKNOWNr8 r% r% r( r r s zDataSource._get_subplatformc C s~ | j r| j S | jr5| j�t�r5| j�t�}t|t�r"|�� | _ | j S | �� �� | _ t� dtt |�� | j S | �� �� | _ | j S )z�Return lowercase cloud name as determined by the datasource. Datasource can determine or define its own cloud product name in metadata. z5Ignoring metadata provided key %s: non-string type %s) � _cloud_namer` ri �METADATA_CLOUD_NAME_KEYrX rE rV �_get_cloud_namer� r� �type)r9 r� r% r% r( r� x s ���zDataSource.cloud_namec C r4 )z�Return the datasource name as it frequently matches cloud name. Should be overridden in subclasses which can run on multiple cloud names, such as DatasourceEc2. )r� r8 r% r% r( r! � s zDataSource._get_cloud_namec C s" | j sd S d| j v r| j d S d S )Nz launch-index)r` r8 r% r% r( r � s zDataSource.launch_indexc C s0 t �t�| j ��g}|}|D ]}|�|�}q|S r5 )r �Filterr �safe_int�apply)r9 � processed_ud�filters�new_ud�fr% r% r( r � s � zDataSource._filter_xdatac C r� �NFr% r8 r% r% r( �is_disconnected� r� zDataSource.is_disconnectedc C r4 r5 )r� r8 r% r% r( r � r; zDataSource.get_userdata_rawc C r4 r5 )r� r8 r% r% r( r � r; z DataSource.get_vendordata_rawc C r4 r5 )r� r8 r% r% r( r � r; z DataSource.get_vendordata2_rawc C s i S r5 r% r8 r% r% r( �get_config_obj� s zDataSource.get_config_objc C s t | j�d��S )Nz public-keys)�normalize_pubkey_datar` ri r8 r% r% r( r� � s z DataSource.get_public_ssh_keysc C r� )a5 Publish the public SSH host keys (found in /etc/ssh/*.pub). @param hostkeys: List of host key tuples (key_type, key_value), where key_type is the first field in the public key file (e.g. 'ssh-rsa') and key_value is the key itself (e.g. 'AAAAB3NzaC1y...'). Nr% )r9 �hostkeysr% r% r( �publish_host_keys� s z DataSource.publish_host_keysc C sd ddi}|� � D ]'\}}|�|�sq|D ]}d||t|�d � f }tj�|�r.| S qqd S )N�sd)�vd�xvd�vtbz /dev/%s%s)rU rY �lenr� rn r� )r9 � short_name�mappings�nfrom�tlist�nto�candr% r% r( � _remap_device� s ��zDataSource._remap_devicec C � d S r5 r% )r9 �_namer% r% r( �device_name_to_device� s z DataSource.device_name_to_devicec C s, | j }z| j�� }W |S ty Y |S w )z<Default locale is en_US.UTF-8, but allow distros to override)�default_localer� � get_localer� )r9 �localer% r% r( r@ � s ��zDataSource.get_localec C s2 | j �d| j �d��}|r|S | j �di ��d�S )Nr� r� � placement�r` ri )r9 � top_level_azr% r% r( r� � s �z DataSource.availability_zonec C s | j �d�S )Nr� rC r8 r% r% r( r� � s zDataSource.regionc C s" | j rd| j vr dS t| j d �S )Nr� ziid-datasource)r` rE r8 r% r% r( r� � s zDataSource.get_instance_idc C sX d}d}|}d}| j r| j �d�sW|rtd|�S g }t�� } | dkr$d}t�| �} | r:| �d�dkr:t| ��d�}nI| rK| �d�dkrKt| ��d�}n8| rR| |g}n1||g}n,| j d } t � | �r~g }|rjt� | �}|rtt|��d�}nd | � dd � g}n| �d�}t |�d kr�|d } d�|d d� �}n|d } |r�||kr�d | |f } t| |�S ) a� Get hostname or fqdn from the datasource. Look it up if desired. @param fqdn: Boolean, set True to return hostname with domain. @param resolve_ip: Boolean, set True to attempt to resolve an ipv4 address provided in local-hostname meta-data. @param metadata_only: Boolean, set True to avoid looking up hostname if meta-data doesn't have local-hostname present. @return: a DataSourceHostname namedtuple <hostname or qualified hostname>, <is_default> (str, bool). is_default is a bool and it's true only if hostname is localhost and was returned by util.get_hostname() as a default. This is used to differentiate with a user-defined localhost hostname. Optionally return (None, False) when metadata_only is True and local-hostname data is not available. � localdomain� localhostFr� NT�.r zip-%sr� r| z%s.%s)r` ri ru r r� �get_fqdn_from_hosts�findrE rj r �is_ipv4_address� gethostbyaddrrZ r4 r� ) r9 �fqdn� resolve_ip� metadata_only� defdomain�defhost�domainrw �toksrv � hosts_fqdn�lhostr% r% r( r� � sF zDataSource.get_hostnamec C s | j j| d�S )N)� data_source)r� �get_package_mirror_infor8 r% r% r( rV D s z"DataSource.get_package_mirror_info�source_event_typesc C sP i }|D ]!}| j �� D ]\}}||v r$|�|�s t� ||< || �|� q q|S r5 )�supported_update_eventsrU ri �set�add)r9 rW �supported_events�event� update_scope� update_eventsr% r% r( �get_supported_eventsG s � ��z DataSource.get_supported_eventsc C s� | � |�}|�� D ] \}}t�d|jd�dd� |D ��� | �d| tff� q |r6| �� | �� }|r6dS t�d| d�dd� |D ��� d S ) a� Refresh cached metadata if the datasource supports this event. The datasource has a list of supported_update_events which trigger refreshing all cached metadata as well as refreshing the network configuration. @param source_event_types: List of EventTypes which may trigger a metadata update. @return True if the datasource did successfully update cached metadata due to source_event_type. z:Update datasource metadata and %s config due to events: %s�, c S � g | ]}|j �qS r% r6 ��.0r\ r% r% r( � <listcomp>h � z;DataSource.update_metadata_if_supported.<locals>.<listcomp>z _%s_configTz(Datasource %s not updated for events: %sc S ra r% r6 rb r% r% r( rd v re F) r_ rU r� r� r7 r� r� r� r� )r9 rW r[ �scope�matched_events�resultr% r% r( � update_metadata_if_supportedT s& ��z'DataSource.update_metadata_if_supportedc C r� r* r% )r9 r� r% r% r( �check_instance_idz r� z DataSource.check_instance_idc C sT |d u rt }|d u r t}| D ]}|d u rq||v r | S t�d||� | S |S )Nz%invalid dsmode '%s', using default=%s)�DSMODE_NETWORK� VALID_DSMODESr� r� )� candidates�default�valid� candidater% r% r( �_determine_dsmode~ s �z DataSource._determine_dsmodec C r< r5 r% r8 r% r% r( �network_config� r� zDataSource.network_configc C r< r5 r% r8 r% r% r( �first_instance_boot� r� z DataSource.first_instance_bootc C r� )a( setup(is_new_instance) This is called before user-data and vendor-data have been processed. Unless the datasource has set mode to 'local', then networking per 'fallback' or per 'network_config' will have been written and brought up the OS at this point. Nr% )r9 �is_new_instancer% r% r( �setup� s zDataSource.setupc C r� )a� activate(cfg, is_new_instance) This is called before the init_modules will be called but after the user-data and vendor-data have been fully processed. The cfg is fully up to date config, it contains a merged view of system config, datasource config, user config, vendor config. It should be used rather than the sys_cfg passed to __init__. is_new_instance is a boolean indicating if this is a new instance. Nr% )r9 �cfgrt r% r% r( �activate� s zDataSource.activater5 )r% �T)F)FFF)NN)]r< r= r> rk �dsmoder? r� r r r r r- r@ rD rB rA ry r �__annotations__r r r r r r r �BOOT_NEW_INSTANCE�BOOT� BOOT_LEGACY�HOTPLUGrX �default_update_eventsr� r� rE r r� r� r� �_ci_pkl_versionr r r� r r� r: �boolr� r� r� r� r� r� r� r� r r r r �propertyr r� r� r r� r! r r r+ r r r r, r� r/ r; r> r@ r� r� r� r� rV r r_ ri rj � staticmethodrq rr rs ru rw r% r% r% r( r � s� ��� �� � & K < H � �& )� metaclassc C s� g }| s|S t | t�r| �� S t | ttf�rt| �S t | t�rC| �� D ] \}}t |t�r/|g}t |ttf�rB|D ] }|rA|�|� q8q#|S r5 )rX rE � splitlines�listrY r[ rU rW )� pubkey_data�keys�_keyname�klist�pkeyr% r% r( r- � s" �r- r3 c C s. t |||�}dd� |D �}t|v rdnd} t�d| |� t||�D ]j\} } tjd| �dd� d | | f d | | f |d �} z?| �3 t�d | � | | ||�} | �t j g�rkd | | f | _ | t � | �fW d � W S W d � n1 suw Y W q! ty� t�td| � Y q!w dd�|� }t|��)Nc S s g | ]}t �|��qS r% r� )rc r) r% r% r( rd � s z find_source.<locals>.<listcomp>�networkr z#Searching for %s data source in: %sz search-%sr rO z searching for %s data from %szno %s data found from %s)�name� description�message�parentz%Seeing if we can get any data from %szfound %s data from %szGetting data from %s failedz4Did not find any data source, searched classes: (%s)r` )� list_sources� DEP_NETWORKr� r� �zipr �ReportEventStackrZ ri r r{ r� r r� r r r r� rK )r� r� r� �ds_deps�cfg_list�pkg_list�reporter�ds_list�ds_namesr� r� �cls�myrep�s�msgr% r% r( � find_source� s> � � � �� ��r� c C s� g }t �d| ||� | D ];}|�t�sdt|f }t�||dg�\}}|s+t �d|� |D ]}t�|�}t|d�} | |�} | rF|� | � nq-q |S )NzLLooking for data source in: %s, via packages %s that matches dependencies %sz%s%s�get_datasource_listzDCould not import %s. Does the DataSource exist and is it importable?) r� r� rY � DS_PREFIXr � find_module�error� import_moduler� r] ) r� �dependsr� �src_list�ds_name�m_locs� _looked_locs�m_loc�mod�lister�matchesr% r% r( r� � s8 � �� ��r� � system-uuid�fieldc C s* | sdS t �|�}|s dS | �� |�� kS r* )r � read_dmi_datarV )r� r� � dmi_valuer% r% r( � instance_id_matches_system_uuid s r� c C sl | st } |st }|t kr| t kr| S |S t�� D ]\}}|\}}|�|�r-|| �r-| S q| t kr4| S |S )z@Lookup the canonical cloud-id for a given cloud_name and region.)r �CLOUD_ID_REGION_PREFIX_MAPrU rY )r� r� r� �prefix� cloud_id_testr� � valid_cloudr% r% r( r� % s �r� Tc C sf | sdS t | t�r | S t | t�rt�| �S t | t�r+|du r't| �d�dd�S td��tdt | � ��)aL data: a loaded object (strings, arrays, dicts). return something suitable for cloudinit vendordata_raw. if data is: None: return None string: return string list: return data the list is then processed in UserDataProcessor dict: return convert_vendordata(data.get('cloud-init')) NTz cloud-initF)�recursez'vendordata['cloud-init'] cannot be dictz$Unknown data type for vendordata: %s) rX rE r� rS rT r[ �convert_vendordatari r r" )�datar� r% r% r( r� 8 s r� c @ rJ )�BrokenMetadataNrL r% r% r% r( r� P rM r� c C s4 g }t | �}|D ]\}}|t |�kr|�|� q|S r5 )rY rW )r� r� �ret_list�depsetr� �depsr% r% r( �list_from_depends[ s �r� rm �fnamec C sn zt �| �}W n ty t�td| � Y dS w z tj||ddd� W dS ty6 t�td|� Y dS w )z[Use pickle to serialize Datasource to a file as a cache. :return: True on success z Failed pickling datasource %sF�wb� )�omoder� z Failed pickling datasource to %sT)�pickle�dumpsr r r r� r� )rm r� � pk_contentsr% r% r( r� d s � ��r� c C s� d}z t j| dd�}W n ty* } ztj�| �r t�d| |� W Y d}~nd}~ww |s/dS zt� |�W S t y? Y dS tyO t � td| � Y dS w )zBUse pickle to deserialize a instance Datasource from a cache file.NF)�decodez failed loading pickle in %s: %sz#Failed loading pickled blob from %s) r � load_filer r� rn �isfiler� r� r� r� rG r )r� �pickle_contentsr� r% r% r( �pkl_loadv s$ �� �r� )rO r% )r� rx )R�abcrS r� r� r� � collectionsr �enumr r �typingr r r r r � cloudinitr r r �loggingr r r r� r �cloudinit.atomic_helperr �cloudinit.distrosr �cloudinit.eventr r �cloudinit.filtersr �cloudinit.helpersr �cloudinit.persistencer �cloudinit.reportingr �DSMODE_DISABLED� DSMODE_LOCALrk � DSMODE_PASSrl �DEP_FILESYSTEMr� r� r� �REDACT_SENSITIVE_VALUEr r� r � getLoggerr< r� r� r- r rG rK rN r\ ro rp ru �ABCMetar r- rE r� r� r� r� r� r� �IOErrorr� r� r� r� r% r% r% r( �<module> s� � � # � � �% �� � __pycache__/DataSourceNWCS.cpython-310.pyc 0000644 00000010113 15027667240 0014207 0 ustar 00 o �Ad� � @ s� d dl mZ d dlmZ d dlmZ d dlmZmZmZm Z m Z d dl m Z d dl mZ e�e�ZdZded iZd Zd Zd ZG d d � d ej�Zdd� Zdd� Zdd� Zddd�Z eej ffgZ dS )� )� exceptions)�dmi)�log)�net�sources�subp� url_helper�util)�NoDHCPLeaseError)�EphemeralDHCPv4z http://169.254.169.254/api/v1� metadata_urlz /metadata� � c @ s4 e Zd ZdZdd� Zdd� Zdd� Zedd � �Zd S ) �DataSourceNWCS�NWCSc C s� t j�| |||� || _t� | _t�t�|ddgi �t g�| _ | j d | _ | j � dt �| _| j � dt�| _| j � dt�| _t j| _t j| _d S )N� datasourcer r �retries�timeout� wait_retry)r � DataSource�__init__�distro�dict�metadatar � mergemanydict�get_cfg_by_path�BUILTIN_DS_CONFIG�ds_cfg�metadata_address�get� MD_RETRIESr � MD_TIMEOUTr � MD_WAIT_RETRYr �UNSET�_network_config�DSMODE_NETWORK�dsmode)�self�sys_cfgr �paths� r* �B/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceNWCS.pyr s �� zDataSourceNWCS.__init__c C s� t �d� t� }|st �d� dS t �d� | �� }|d u r"td��|| _|d | jd< |d | jd< |d | jd< |d | jd < |�d d �| _|�d d �| _ d S )Nz'Detecting if machine is a NWCS instancez Machine is not a NWCS instanceFzMachine is a NWCS instancezfailed to get metadataz instance-idz public-keys�network�hostnamezlocal-hostname�userdata� vendordataT) �LOG�info� get_nwcs_data� get_metadata� Exception� metadata_fullr r � userdata_raw�vendordata_raw)r' �on_nwcs�mdr* r* r+ � _get_data- s" zDataSourceNWCS._get_datac C s� z1t �d� tt�� dtd id�� t| j| j| j | j d�W d � W S 1 s*w Y W d S t t j ttjfyJ } zt �d|� � d }~ww )Nz#Attempting to get metadata via DHCP�urlz/metadata/instance-id)�iface�connectivity_url_data�r � sec_betweenr zDHCP failure: %s)r0 r1 r r �find_fallback_nic� BASE_URL_V1� read_metadatar r r r r r �ProcessExecutionError� RuntimeErrorr �RequestException�error)r' �er* r* r+ r3 I s0 ���(� � ��zDataSourceNWCS.get_metadatac C s� t �d� | jd u rt �dtj� tj| _| jtjkr | jS | jd d s)td��| jd d D ]}t|d �}|rGt � d|d |� ||d< q0| jd | _| jS ) Nz Attempting network configurationz5Found None as cached _network_config, resetting to %sr, �configz"Unable to get metadata from server� mac_addresszOverriding %s with %s�name) r0 �debugr$ �warningr r# r r4 �get_interface_namer1 )r' �i� iface_namer* r* r+ �network_configc s& � � z DataSourceNWCS.network_configN) �__name__� __module__� __qualname__�dsnamer r: r3 �propertyrP r* r* r* r+ r s r c C s t �d�} | dkr dS dS )Nzsystem-manufacturerr FT)r � read_dmi_data)� vendor_namer* r* r+ r2 � s r2 c C s t �� }| |vr d S |�| �S �N)r �get_interfaces_by_macr )�mac� macs_to_nicr* r* r+ rM � s rM c C s t �| t�S rX )r �list_from_depends� datasources)�dependsr* r* r+ �get_datasource_list� s r_ � c C s6 t j| |||d�}|�� std| ��t�|j�� �S )Nr> z unable to read metadata at %s)r �readurl�okrD r � load_json�contents�decode)r; r r? r �responser* r* r+ rB � s � rB N)r` r` r ) �requestsr � cloudinitr r �loggingr r r r r �cloudinit.net.dhcpr �cloudinit.net.ephemeralr � getLoggerrQ r0 rA r r r! r" r r r2 rM r_ rB �DEP_FILESYSTEMr] r* r* r* r+ �<module> s( �i � __pycache__/DataSourceMAAS.cpython-310.pyc 0000644 00000026317 15027667240 0014173 0 ustar 00 o �Ad�9 � @ s� d dl Z d dlZd dlZd dlmZ d dlmZmZmZ e� e �Z dZ g d�Z G dd� dej�Zdd � Zd d � Zd d � Zdde ddfdd�Zdd� ZG dd� de�ZG dd� de�ZeejejffgZdd� Ze dkrtdd� Z e � dS dS )� N)�log)�sources� url_helper�utilz 2012-03-01))�meta-data/instance-idr FF)�meta-data/local-hostnamer FF)�meta-data/public-keysr FT)zmeta-data/vendor-data� vendor-dataTT)� user-datar TTc @ s` e Zd ZdZdZdZdZdd� Zedd� �Z dd � Z d d � Z d d � Z dd� Z dd� Zdd� ZdS )�DataSourceMAASz� DataSourceMAAS reads instance information from MAAS. Given a config metadata_url, and oauth tokens, it expects to find files under the root named: instance-id user-data hostname vendor-data �MAASNc C s: t j�| |||� d | _tj�|jd�| _t| j �| _ d S )N�maas) r � DataSource�__init__�base_url�os�path�join�seed_dir�get_id_from_ds_cfg�ds_cfg�id_hash)�self�sys_cfg�distro�paths� r �B/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceMAAS.pyr , s zDataSourceMAAS.__init__c C s | j s t| j�| _ | j S �N)� _oauth_helper�get_oauth_helperr �r r r r � oauth_helper2 s zDataSourceMAAS.oauth_helperc C s t j�| �}d|| jf S )Nz%s [%s])r r �__str__r )r �rootr r r r# 8 s zDataSourceMAAS.__str__c C s� | j }z | �| jt| j�� W dS ty Y n ty- } z t�d| j|� � d }~ww |�dd �}|s8dS z| � |�sAW dS | �|t || j j | j dd�� W dS tyc t�td|� Y dS w )NTz%s was malformed: %s� metadata_urlF� )�read_file_or_urlr �retriesz$Failed fetching metadata from url %s)r � _set_datar �read_maas_seed_dir�MAASSeedDirNone�MAASSeedDirMalformed�LOG�warning�get�wait_for_metadata_service�read_maas_seed_urlr" �readurlr � Exceptionr �logexc)r �mcfg�exc�urlr r r � _get_data< s> �� �� �zDataSourceMAAS._get_datac C sv || _ |\}}}|| _|| _|| _|r9z t�|�| _W d S ty8 } zt� d|� d | _W Y d }~d S d }~ww d S )Nz"Invalid content in vendor-data: %s) r � userdata_raw�metadata�vendordata_purer �convert_vendordata�vendordata_raw� ValueErrorr- r. )r r7 �data�ud�md�vd�er r r r) c s ���zDataSourceMAAS._set_datac C s d| j S )z/Return the subplatform metadata source details.z seed-dir (%s))r r! r r r �_get_subplatformq s z DataSourceMAAS._get_subplatformc C s | j }d}z t|�d|��}W n ty t�td|� Y nw |dkr&dS d}z||v r5t|�d|��}W n tyE t�d|� Y nw t�� }|� d �rU|d d � }d |t f }|g}| j j |||d �\}}|rut� d |� t|�S t�d|tt�� | �� t|�S )N�x �max_waitz Failed to get max wait. using %sr F�2 �timeoutz Failed to get timeout, using %s�/���z%s/%s/meta-data/instance-id)�urlsrF rH zUsing metadata source: '%s'z(Giving up on md from %s after %i seconds)r �intr/ r3 r r4 r- r. �time�endswith� MD_VERSIONr" � wait_for_url�debug�critical�bool) r r7 r5 rF rH � starttime� check_urlrK � _responser r r r0 u sD �� � � ��z(DataSourceMAAS.wait_for_metadata_servicec C s0 | j du rdS t�|d| jfi �}| j t|�kS )a locally check if the current system is the same instance. MAAS doesn't provide a real instance-id, and if it did, it is still only available over the network. We need to check based only on local resources. So compute a hash based on Oauth tokens.NF� datasource)r r �get_cfg_by_path�dsnamer )r r �ncfgr r r �check_instance_id� s z DataSourceMAAS.check_instance_id)�__name__� __module__� __qualname__�__doc__rY r r r �propertyr" r# r8 r) rD r0 r[ r r r r r s ' &r c s* d}t � fdd�|D ��}tjdi |��S )z�Return an oauth helper instance for values in cfg. @raises ValueError from OauthUrlHelper if some required fields have true-ish values but others do not.)� consumer_key�consumer_secret� token_key� token_secretc s g | ] }|� � |�f�qS r �r/ )�.0�r��cfgr r � <listcomp>� s z$get_oauth_helper.<locals>.<listcomp>Nr )�dictr �OauthUrlHelper)ri �keys�kwargsr rh r r � s r c s4 d}d� � fdd�|D ��}dt�|�d���� S )z;Given a config, generate a unique identifier for this node.)ra rc rd � c s g | ]}� � |d ��qS )� re )rf �f�r r r rj � s z&get_id_from_ds_cfg.<locals>.<listcomp>zv1:zutf-8)r �hashlib�sha256�encode� hexdigest)r �fields�idstrr rr r r � s r c C sL | � d�r | dd � } tj�| �rtt�| ��dkr td��td| d d�S )N�file://� r z%s: not a directoryz file://%s)�version)� startswithr r �isdir�len�listdirr+ r1 )�seed_dr r r r* � s r* c C s |du rt j}| �d�r| dd� } i }tD ]n\}}} } |du r'd| |f } nd| ||f } z,t�|�} || ||| d�} | �� rQ| rH| j||< nt�| j�||< nt � d| | j � W q t j y� } z |j dkrs| sst d ||f �|�|j dkrz|�W Y d}~qd}~ww t|| �S ) a� Read the maas datasource at seed_url. read_file_or_url is a method that should provide an interface like util.read_file_or_url Expected format of seed_url is are the following files: * <seed_url>/<version>/meta-data/instance-id * <seed_url>/<version>/meta-data/local-hostname * <seed_url>/<version>/user-data If version is None, then <version>/ will not be used. NrI rJ z%s/%sz%s/%s/%s)r( rH � ssl_detailsz4Fetching from %s resulted in an invalid http code %si� zMissing required %s: %s)r r' rN � DS_FIELDSr �fetch_ssl_details�ok�contents� decode_binaryr- r. �code�UrlErrorr, �check_seed_contents)�seed_urlr' rH r{ r r( rA r � _dictname�binary�optionalr7 r� �resprC r r r r1 � sJ � �� �� ��� r1 c C s� i }g }t D ]5\}}}}|| vr|s|�|� qd|v r5|�d�\}} } ||vr,i ||< | | || | < q| | ||< qt|�dkrHtd| ��|rRtd||f ��d} |�d�rot� } tj |�d�| td�} | | u rotd��|�d �|�d �| fS ) z�Validate if dictionary content valid as a return for a datasource. Either return a (userdata, metadata, vendordata) tuple or Raise MAASSeedDirMalformed or MAASSeedDirNone rI r z%s: no data files foundz%s: missing files %sNr )�default�allowedz%vendor-data was not loadable as yaml.r � meta-data) r� �append� partitionr~ r+ r, r/ �objectr � load_yaml) �content�seed�ret�missing�spath�dpath�_binaryr� �top�_�p�vd_data�errr r r r� � s4 �r� c @ � e Zd ZdS )r+ N�r\ r] r^ r r r r r+ % � r+ c @ r� )r, Nr� r r r r r, ) r� r, c C s t �| t�S r )r �list_from_depends� datasources)�dependsr r r �get_datasource_list4 s r� �__main__c s ddl } ddl}ddl}| jdd�}|jddddd� |jd d d dd� |jd d d dd� |jddddd� |jddddd� |jdddtd� |jddd�}dD ]\}}|j||d�}|jd d d dd � qQ|�� }|j |j |j |j d �} |j du r�d!D ] } d"| d# } tj�| �r�t�| tj�r�|j�d$| � | |_ q||j r�t�|j �} d%| v r�| d% d& } | �� D ]} | | v r�| | du r�| | | | < q�|jdu r�d'| v r�| d' |_|jdu r�|j�d(� |�d)� t| ���fd*d+���fd,d-��� ��fd.d/�� |jd0k�rc|j�d1|j � �j }|jd d2k�s |j� d3��r't |j�\}}}n t |j|j |d4d5�\}}}t!d6� t!|du �r@d7n|�"� � t!d8� |�|� t!d9� |�|du �r^d7� dS |� dS |jd:k�rp�|j� dS |jd;k�r�|j�#d2��s�d<|j |_� |j� dS dS )=z� Call with single argument of directory or http or https url. If url is given additional arguments are allowed, which will be interpreted as consumer_key, token_key, token_secret, consumer_secret r NzInteract with MAAS DS)� descriptionz--config�filezspecify DS config file)�metavar�helpr� z--ckey�keyz the consumer key to auth withz--tkeyzthe token key to auth withz--csec�secretz the consumer secret (likely '')rp z--tsecz the token secret to auth withz--apiverr{ z the apiver to use ( can be used)� subcommands�subcmd)�title�dest))�crawlzcrawl the datasource)r/ z do a single GET of provided url)� check-seedzread and verify seed at url)r� r7 zthe datasource url�?)r� �nargsr� )ra rc rd rb )�91_kernel_cmdline_url� 90_dpkg_maasz/etc/cloud/cloud.cfg.d/z.cfgzUsed config in %s. rW r r% z)Must provide a url or a config with url. r& c s � j | dd�jS )Nr& )r( )r2 r� �r7 )r" r r �geturl� s zmain.<locals>.geturlc s t d| � | ��� f � d S )Nz == %s == %s )�print�decoder� )r� r r �printurl� s zmain.<locals>.printurlc sv | � d�r5�| ��� �� D ]%}|� d�r � d| |f � q |dkr*� d| df � q �d| |f � q d S �| � d S )NrI z%s%sr� z meta-data/)rN r� � splitlines)r7 �line)r� r� r� r r r� � s � zmain.<locals>.crawlr� zChecking seed at %s rI ry � )r{ r' r( z=== user-data ===zN/Az=== meta-data ===z=== vendor-data ===r/ r� z%s/)$�argparse�pprint�sys�ArgumentParser� add_argumentrO �add_subparsers� add_parser� parse_args�ckey�tkey�tsec�csec�configr r �exists�access�R_OK�stderr�writer � read_confrm r7 �exitr r� r2 r| r* r1 �apiverr� r� rN )r� r� r� �parser�subcmds�namer� r� �args�creds�fname�fpathri r� r2 �userdatar: rB r )r� r� r" r� r �main: s� ������ �� � � � " �r� ) rs r rM � cloudinitr �loggingr r r � getLoggerr\ r- rO r� r r r r r* r1 r� r3 r+ r, �DEP_FILESYSTEM� DEP_NETWORKr� r� r� r r r r �<module> s> �:'� �� __pycache__/DataSourceVMware.cpython-310.pyc 0000644 00000054444 15027667240 0014655 0 ustar 00 o �Ad͂ � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl m Z mZmZ ddlmZ ddlmZmZmZ dZe �e�Zd Zd Zd Z d Z ed �Z dZ dZ dZ!dZ"dZ#dZ$dZ%dZ&dZ'G dd� dej(�Z)dd� Z*dd � Z+d d � Z,d d � Z-d!d"� Z.d#d$� Z/d%d&� Z0d'd(� Z1d)d*� Z2d+d,� Z3e fd-d �Z4e fd.d/�Z5e fd0d1�Z6e fd2d3�Z7d4d5� Z8d6d7� Z9e)ej:ffe)ej:ej;ffgZ<d8d9� Z=d:d;� Z>dHd=d>�Z?d?d@� Z@dAdB� ZAdCdD� ZBdEdF� ZCedGkr�eC� dS dS )Ia� Cloud-Init DataSource for VMware This module provides a cloud-init datasource for VMware systems and supports multiple transports types, including: * EnvVars * GuestInfo * IMC (Guest Customization) Netifaces (https://github.com/al45tair/netifaces) Please note this module relies on the netifaces project to introspect the runtime, network configuration of the host on which this datasource is running. This is in contrast to the rest of cloud-init which uses the cloudinit/netinfo module. The reasons for using netifaces include: * Netifaces is built in C and is more portable across multiple systems and more deterministic than shell exec'ing local network commands and parsing their output. * Netifaces provides a stable way to determine the view of the host's network after DHCP has brought the network online. Unlike most other datasources, this datasource still provides support for JINJA queries based on networking information even when the network is based on a DHCP lease. While this does not tie this datasource directly to netifaces, it does mean the ability to consistently obtain the correct information is paramount. * It is currently possible to execute this datasource on macOS (which many developers use today) to print the output of the get_host_info function. This function calls netifaces to obtain the same runtime network configuration that the datasource would persist to the local system's instance data. However, the netinfo module fails on macOS. The result is either a hung operation that requires a SIGINT to return control to the user, or, if brew is used to install iproute2mac, the ip commands are used but produce output the netinfo module is unable to parse. While macOS is not a target of cloud-init, this feature is quite useful when working on this datasource. For more information about this behavior, please see the following PR comment, https://bit.ly/3fG7OVh. The authors of this datasource are not opposed to moving away from netifaces. The goal may be to eventually do just that. This proviso was added to the top of this module as a way to remind future-us and others why netifaces was used in the first place in order to either smooth the transition away from netifaces or embrace it further up the cloud-init stack. � N)�dmi)�log)�net�sources�util)�guestcust_util)�ProcessExecutionError�subp�whichz /sys/class/dmi/id/product_uuidzNo value found�envvar� guestinfo�imczvmware-rpctool�redactzcleanup-guestinfo� VMX_GUESTINFOz---z local-ipv4z local-ipv6zwait-on-network�ipv4�ipv6c @ s� e Zd ZdZdZd dd�Zdd� Zdd � Zd d � Zd d � Z dd� Z e dd� �Z dd� Z dd� Zdd� Zdd� Zdd� Zd d � ZdS ) �DataSourceVMwareau Setting the hostname: The hostname is set by way of the metadata key "local-hostname". Setting the instance ID: The instance ID may be set by way of the metadata key "instance-id". However, if this value is absent then the instance ID is read from the file /sys/class/dmi/id/product_uuid. Configuring the network: The network is configured by setting the metadata key "network" with a value consistent with Network Config Versions 1 or 2, depending on the Linux distro's version of cloud-init: Network Config Version 1 - http://bit.ly/cloudinit-net-conf-v1 Network Config Version 2 - http://bit.ly/cloudinit-net-conf-v2 For example, CentOS 7's official cloud-init package is version 0.7.9 and does not support Network Config Version 2. imc transport: Either Network Config Version 1 or Network Config Version 2 is supported which depends on the customization type. For LinuxPrep customization, Network config Version 1 data is parsed from the customization specification. For CloudinitPrep customization, Network config Version 2 data is parsed from the customization specification. envvar and guestinfo tranports: Network Config Version 2 data is supported as long as the Linux distro's cloud-init package is new enough to parse the data. The metadata key "network.encoding" may be used to indicate the format of the metadata key "network". Valid encodings are base64 and gzip+base64. �VMwareNc C sN t j�| ||||� i | _d | _t| _t| jdft | j dft | j dfg| _ d S )NFT)r � DataSource�__init__�cfg�data_access_method�VMWARE_RPCTOOL�vmware_rpctool�DATA_ACCESS_METHOD_ENVVAR�get_envvar_data_fn� DATA_ACCESS_METHOD_GUESTINFO�get_guestinfo_data_fn�DATA_ACCESS_METHOD_IMC�get_imc_data_fn� possible_data_access_method_list)�self�sys_cfg�distro�paths�ud_proc� r& �D/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceVMware.pyr � s �zDataSourceVMware.__init__c C s t j�| �}d|| jf S )Nz %s [seed=%s])r r �__str__r )r! �rootr& r& r' r( � s zDataSourceVMware.__str__c C s� d\}}}| j D ] \}}}|rt� sq|� \}}}|s |s |r$|| _ nq| js/t�d� dS t�d| �� � tt|��| _ || _ || _ | � � | j sQ| j sQ| j rSdS dS )a� _get_data loads the metadata, userdata, and vendordata from one of the following locations in the given order: * envvars * guestinfo * imc Please note when updating this function with support for new data transports, the order should match the order in the dscheck_VMware function from the file ds-identify. �NNNz)failed to find a valid data access methodFzusing data access method %sT) r �is_vmware_platformr �LOG�error�info�_get_subplatform�process_metadata�load_json_or_yaml�metadata� userdata_raw�vendordata_raw� redact_keys)r! �md�ud�vdr � get_data_fn�require_vmware_platformr& r& r' � _get_data� s0 � � zDataSourceVMware._get_datac C s< t | j�}t�d|� t|� t�| j|g�| _| �� dS )a( setup(is_new_instance) This is called before user-data and vendor-data have been processed. Unless the datasource has set mode to 'local', then networking per 'fallback' or per 'network_config' will have been written and brought up the OS at this point. zgot host-info: %sN)�wait_on_networkr2 r, r. �advertise_local_ip_addrsr � mergemanydict�persist_instance_data)r! �is_new_instance� host_infor& r& r' �setup� s zDataSourceVMware.setupc C sL d }| j tkr t}n| j tkrt}n | j tkrt}ntjS d| j |d�f S )Nz%s (%s)r2 ) r r � get_guestinfo_envvar_key_namer �get_guestinfo_key_namer �get_imc_key_namer �METADATA_UNKNOWN)r! �get_key_name_fnr& r& r' r/ � s �z!DataSourceVMware._get_subplatformc C s | j S �N)r �r! r& r& r' �get_config_obj s z DataSourceVMware.get_config_objc C sB d| j v r t�d� nt�d� d| j�� i| j d< | j d d S )N�networkz using metadata network configz using fallback network config�config)r2 r, �debugr# �generate_fallback_configrI r& r& r' �network_config s �z DataSourceVMware.network_configc C sl | j r d| j v r | j d S ttd��}t|�� ��� �� | j d< | j d W d � S 1 s/w Y d S )Nz instance-id�r)r2 �open�PRODUCT_UUID_FILE_PATH�str�read�rstrip�lower)r! �id_filer& r& r' �get_instance_id s $�z DataSourceVMware.get_instance_idc C s, dD ]}|| j v rt�| j | � S qg S )N)zpublic-keys-data�public_keys_dataz public-keys� public_keys)r2 r �normalize_pubkey_data)r! �key_namer& r& r' �get_public_ssh_keys' s �z$DataSourceVMware.get_public_ssh_keysc C sL d }t | jv r | jt }n t| jv r| jt }| jtkr$t|| j� d S d S rH )�REDACTr2 �CLEANUP_GUESTINFOr r �guestinfo_redact_keysr )r! �keys_to_redactr& r& r' r5 2 s �z DataSourceVMware.redact_keysc C s: d\}}}t j�td�rtd�}td�}td�}|||fS )z< check to see if there is data via env vars r* � r2 �userdata� vendordata)�os�environ�getr �guestinfo_envvar�r! r6 r7 r8 r& r& r' r > s z#DataSourceVMware.get_envvar_data_fnc C s> d\}}}| j rtd| j �}td| j �}td| j �}|||fS )zK check to see if there is data via the guestinfo transport r* r2 rc rd )r r ri r& r& r' r J s z&DataSourceVMware.get_guestinfo_data_fnc C s d\}}}t �| j�}t �| j�}|s |s t�d� |||fS t �� s(|||fS t �| j�}|du r7|||fS t j � |�}t � |�}t � |�\} } | rh|rht�d� t �| jj| j�d�||| j�\}}}| _n| rz|rzt�d� t �|�\}}}nt�d� t�|� |||fS )zN check to see if there is data via vmware guest customization r* z-Customization for VMware platform is disabledNz3Getting data via VMware customization configuration�scriptszFGetting data via VMware raw cloudinit data customization configurationz1No allowed customization configuration data found)r �is_vmware_cust_enabledr" �is_raw_data_cust_enabled�ds_cfgr, rM �is_cust_plugin_available�get_cust_cfg_filere �path�dirname�parse_cust_cfg�get_cust_cfg_type�get_data_from_imc_cust_cfgr$ � cloud_dir� get_cpathr# r �#get_data_from_imc_raw_data_cust_cfgr �del_dir) r! r6 r7 r8 �allow_vmware_cust�allow_raw_data_cust� cust_cfg_file� cust_cfg_dir�cust_cfg�is_vmware_cust_cfg�is_raw_data_cust_cfgr& r& r' r V sL � � �� � z DataSourceVMware.get_imc_data_fnrH )�__name__� __module__� __qualname__�__doc__�dsnamer r( r; rB r/ rJ �propertyrO rX r] r5 r r r r& r& r& r' r i s" $ 9 r c C s> t �d�} | d u rt�d� dS d| �� vr t�d� dS dS )Nzsystem-product-namez No system-product-name foundF�vmwarezNot a VMware platformT)r � read_dmi_datar, rM rV )� system_typer& r& r' r+ � s r+ c C sv t �d| |� d}|dv r t �d|| � t�t�|��}n|dv r.t �d|| � t�|�}nt �d| � |}t�|�S )z� decode returns the decoded string value of data key is a string used to identify the data being decoded in log messages z'Getting encoded data for key=%s, enc=%sN)z gzip+base64zgz+b64zDecoding %s format %s)�base64�b64zPlain-text data %s)r, rM r � decomp_gzip�b64d� decode_binary)�key�enc_type�data�raw_datar& r& r' �decode� s r� c C s. t �| �} | �� } t| �dks| tkrdS | S )a get_none_if_empty_val returns None if the provided value, once stripped of its trailing whitespace, is empty or equal to GUESTINFO_EMPTY_YAML_VAL. The return value is always a string, regardless of whether the input is a bytes class or a string. r N)r r� rU �len�GUESTINFO_EMPTY_YAML_VAL)�valr& r& r' �get_none_if_empty_val� s r� c C sX | sdS | � t�}|rtt|� t�d|� | � t�}|r*tt|� t�d|� dS dS )z� advertise_local_ip_addrs gets the local IP address information from the provided host_info map and sets the addresses in the guestinfo namespace Nz-advertised local ipv4 address %s in guestinfoz-advertised local ipv6 address %s in guestinfo)rg � LOCAL_IPV4�guestinfo_set_valuer, r. � LOCAL_IPV6)rA � local_ipv4� local_ipv6r& r& r' r= � s �r= c C s t |�}|r|S t�d| � dS )z� handle_returned_guestinfo_val returns the provided value if it is not empty or set to GUESTINFO_EMPTY_YAML_VAL, otherwise None is returned �No value found for key %sN)r� r, rM )r� r� r& r& r' � handle_returned_guestinfo_val� s r� c C s dS )Nz vmware-toolsr& �r� r& r& r' rE � s rE c C s d| S )Nz guestinfo.r& r� r& r& r' rD � s rD c C s dt | � �� �ddd�S )Nzvmx.�.�_���)rD �upper�replacer� r& r& r' rC � s rC c C s, t | �}|sd S t | d �}tt| �||�S )N� .encoding)�guestinfo_envvar_get_valuer� rC )r� r� r� r& r& r' rh � s rh c C s t | �}t| tj�|d��S )Nrb )rC r� re rf rg )r� �env_keyr& r& r' r� � s r� c C s0 t | |�}|s dS t | d |�}tt| �||�S )zj guestinfo returns the guestinfo value for the provided key, decoding the value when required Nr� )�guestinfo_get_valuer� rD )r� r r� r� r& r& r' r � s c C s� t �d| � z%t|dt| � g�\}}|tkr t �d| � n|s&t �d| � t| |�W S tyY } z"|jtkr?t �d| � nt � t d| |� W Y d}~dS W Y d}~dS d}~w t yi t � t d| � Y dS w )z: Returns a guestinfo value for the specified key. z"Getting guestinfo value for key %sz info-get r� z(Failed to get guestinfo value for key %sz,Failed to get guestinfo value for key %s: %sNz?Unexpected error while trying to get guestinfo value for key %s) r, rM r rD �NOVALr- r� r �stderrr �logexc� Exception)r� r �stdoutr� r- r& r& r' r� sB �� � �� ���r� c C s� |dkrd}t �d| |� zt|dt| �|f g� W dS ty8 } zt�t d| ||� W Y d}~dS d}~w tyI t�t d| |� Y dS w ) z| Sets a guestinfo value for the specified key. Set value to an empty string to clear an existing guestinfo key. rb � z$Setting guestinfo key=%s to value=%szinfo-set %s %sTz.Failed to set guestinfo key=%s to value=%s: %sNzAUnexpected error while trying to set guestinfo key=%s to value=%s)r, rM r rD r r r� r� )r� �valuer r- r& r& r' r� 1 s: ���� ���r� c C s� | sdS t | �ttfvr| g} | D ],}t|�}t�d|� t|t|�s)t�d|� t�d|� t|d d|�s=t�d|� qdS )z� guestinfo_redact_keys redacts guestinfo of all of the keys in the given list. each key will have its value set to "---". Since the value is valid YAML, cloud-init can still read it if it tries. Nz clearing %szfailed to clear %szclearing %s.encodingr� rb zfailed to clear %s.encoding) �type�list�tuplerD r, r. r� r� r- )�keysr r� r\ r& r& r' r` \ s � ��r` c C sF | si S t | t�r | S zt�| �W S tjtfy" t�| � Y S w )z� load first attempts to unmarshal the provided data as JSON, and if that fails then attempts to unmarshal the data as YAML. If data is None then a new dictionary is returned. )� isinstance�dictr � load_json�json�JSONDecodeError� TypeError� load_yaml)r� r& r& r' r1 r s �r1 c C s� | si S d}d| v r| d }| d= d}d| v r | d }| d= |rPt |tjj�r4t�d� dt�|�i}nt�d|� td||�}dt |�i}t�d|� || d< | S ) z_ process_metadata processes metadata and loads the optional network configuration. NrK znetwork.encodingz#network data copied to 'config' keyrL z network data to be decoded %szmetadata.networkznetwork data %s) r� � collections�abc�Mappingr, rM �copy�deepcopyr� r1 )r� rK � network_enc�dec_netr& r& r' r0 � s* � r0 c C s t �| t�S )zK Return a list of data sources that match this set of dependencies )r �list_from_depends� datasources)�dependsr& r& r' �get_datasource_list� s r� c C s� t �� } d| vr dS | d }t j|vrt j|vrdS d}d}|�t j�}|rS|\}}t �|�}|rS|�t j�}|rSt|�dkrGt�d||� n d|d v rS|d d }|�t j�} | r�| \}} t �| �} | r�| �t j�} | r�t| �dkr|t�d| | � n d| d v r�| d d }|r�|s�|�t j�} | r�t| �dkr�t�d|| � n d| d v r�| d d }|s�|r�| �t j�}|r�t|�dkr�t�d| |� ||fS d|d v r�|d d }||fS ) aI Returns the default IPv4 and IPv6 addresses based on the device(s) used for the default route. Please note that None may be returned for either address family if that family has no default route or if there are multiple addresses associated with the device used by the default route for a given address. �default)NNN� z,device %s has more than one ipv4 address: %s�addrr z,device %s has more than one ipv6 address: %s) � netifaces�gateways�AF_INET�AF_INET6rg � ifaddressesr� r, �warning) r� � default_gwr r �gw4r� �dev4� addr4_fams�af_inet4�gw6�dev6� addr6_fams�af_inet6r& r& r' �get_default_ip_addrs� s~ � � � � � r� rb c C st | � � } | r | dkrt�� } zt�| ddtjdtj�}W n tjy' Y | S w |D ] }|d r7|d } | S q*| S )zoGet fully qualified domain name from name. An empty argument is interpreted as meaning the local host. z0.0.0.0Nr � )�stripr � get_hostname�socket� getaddrinfo� SOCK_DGRAM� AI_CANONNAMEr- )�name�addrsr� r& r& r' �getfqdn s$ ���r� c C s& t �tj| �}|o|jp|jp|j S )zn Returns false if the address is loopback, link local or unspecified; otherwise true is returned. )r �maybe_get_address� ipaddress� ip_address� is_link_local� is_loopback�is_unspecified)r� r� r& r& r' �is_valid_ip_addr' s �r� c C s ddt �� t �� t �� d�ii} tt�� �}|r$|| d< || d< || d< t� \}}|r/|| t< |r5|| t< | d d d }| d d d }| d d d }t� � }|D ]�}t� |�} | � tj �} | � tj �} | � tj�} d } | r|d | d v r|| d d } | d kr�qS| r�| s�| r�| }i }| r�g }| D ]}t|d �s�q�|�|� q�||d< | r�g }| D ]}t|d �s�q�|�|� q�||d< |||< | r�| D ] }|d }t|�s�q�t�|�}|d = | r�| |d< |||< q�| �r| D ] }|d }t|�s�q�t�|�}|d = | �r| |d< |||< q�qS| S )zP Returns host information such as the host name and network interfaces. rK � interfaces)�by-mac�by-ipv4�by-ipv6�hostnamezlocal-hostname�local_hostnamer� r� r� Nr� r z00:00:00:00:00:00r r �mac)r� � OrderedDictr� r r� r� r� r� r� r� r� rg �AF_LINKr� r� r� �appendr� r� )rA r� � default_ipv4� default_ipv6�by_mac�by_ipv4�by_ipv6�ifaces�dev_name� addr_fams�af_linkr� r� r� r� r� � af_inet4_vals�ip_info� af_inet6_valsr& r& r' � get_host_info2 s� ��� �r� c C s6 d}d}t | v r6| t }t|v r!|t }t|t�r |}nt�|�}t|v r6|t }t|t�r1|}nt�|�}d\}}}|d u r�t� }|�d�pHi } | �d�pOi } | �d�pVi } | �d�p]i } |rn| rht | �dknd}|snd }|r~| rxt | �dknd}|s~d }|d u r�t � d||||� t � d � |d u s?t � d � |S ) NF)NFFrK r� r� r� r z<waiting on network: wait4=%s, ready4=%s, wait6=%s, ready6=%sr� zwaiting on network complete)�WAIT_ON_NETWORK�WAIT_ON_NETWORK_IPV4r� �boolr �translate_bool�WAIT_ON_NETWORK_IPV6r� rg r� r, rM �time�sleep) r2 � wait_on_ipv4� wait_on_ipv6r< �wait_on_ipv4_val�wait_on_ipv6_valrA � ipv4_ready� ipv6_readyrK r� r� r� r& r& r' r< � sR � � r< c C sd zt �� W n ty Y nw ttdtdiddddiii} t| �}t�| |g�} t t� | �� dS )z7 Executed when this file is used as a program. TFrK rL �dhcpN) �logging�setupBasicLoggingr� r r r r< r r> �print� json_dumps)r2 rA r& r& r' �main� s �� �r �__main__)rb )Dr� r� r� r� r� re r� r r� � cloudinitr r r r r r �$cloudinit.sources.helpers.vmware.imcr �cloudinit.subpr r r rR � getLoggerr� r, r� r r r r r^ r_ r r� r� r� r r r r r r+ r� r� r= r� rE rD rC rh r� r r� r� r` r1 r0 �DEP_FILESYSTEM� DEP_NETWORKr� r� r� r� r� r� r< r r& r& r& r' �<module> s| 7 ) ' + $� ] Y8 � __pycache__/DataSourceNone.cpython-310.pyc 0000644 00000003035 15027667240 0014341 0 ustar 00 o �Adq � @ sB d dl mZ G dd� dej�Zeejejffeg fgZdd� ZdS )� )�sourcesc @ s> e Zd ZdZd dd�Zdd� Zdd� Zd d � Zed d � �Z dS )�DataSourceNone�NoneNc C s$ t j�| ||||� i | _d| _d S )N� )r � DataSource�__init__�metadata� userdata_raw)�self�sys_cfg�distro�paths�ud_proc� r �B/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceNone.pyr s zDataSourceNone.__init__c C s0 d| j v r | j d | _d| j v r| j d | _dS )Nr r T)�ds_cfgr r �r r r r � _get_data s zDataSourceNone._get_datac C � dS )z/Return the subplatform metadata source details.�configr r r r r �_get_subplatform � z DataSourceNone._get_subplatformc C r )Nziid-datasource-noner r r r r �get_instance_id s z DataSourceNone.get_instance_idc C r )NTr r r r r �is_disconnected# r z DataSourceNone.is_disconnected�N) �__name__� __module__� __qualname__�dsnamer r r r �propertyr r r r r r s r c C s t �| t�S r )r �list_from_depends� datasources)�dependsr r r �get_datasource_list0 s r# N)� cloudinitr r r �DEP_FILESYSTEM� DEP_NETWORKr! r# r r r r �<module> s � __pycache__/DataSourceOVF.cpython-310.pyc 0000644 00000020057 15027667240 0014077 0 ustar 00 o �Ad�) � @ s� d dl Z d dlZd dlZd dlmZ d dlmZ d dlmZm Z m Z m Z e� e �ZG dd� de j�ZG dd� de�Zd d d �Zd d � Zdd� Zd dd�Zdd� Zdd� Zdd� ZG dd� de�Zee jffee je j fffZ dd � Z d d � Z dS )!� N)�minidom)�log)�safeyaml�sources�subp�utilc @ sL e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z e dd� �Z dS )� DataSourceOVF�OVFc C sF t j�| |||� d | _tj�|jd�| _d | _i | _ d| _ d | _ d S )N�ovf)�/zfile://) r � DataSource�__init__�seed�os�path�join�seed_dir� environment�cfg�supported_seed_starts�_network_config��self�sys_cfg�distro�paths� r �A/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceOVF.pyr s zDataSourceOVF.__init__c C s t j�| �}d|| jf S )Nz %s [seed=%s])r r �__str__r )r �rootr r r r # s zDataSourceOVF.__str__c C s� g }i }d}d}ddi}t | jj�\}}|r/tj�| jj|�}t|�\}}} || _|�|� n7dt fdt fg} d } | D ] \} } | � }|rF nq;|rft|d�\}}} || _d|v ra|d ra|d | _ |�| � t |�dkrnd S d |v r�|d r�|d } d }| j D ] }| �|�r�|} nq|s�t�d | | � d S tj| d d �\}}}t�d | � t�||g�}|�| � t�||g�}d�|�| _|| _|| _|| _| | _dS )N� � instance-idz iid-dsovfzcom.vmware.guestInfo�isoT�network-configr F�seedfromz Seed from %s not supported by %s)�timeoutz Using seeded cache data from %s�,)� get_ovf_envr r r r r �read_ovf_environmentr �append�transport_vmware_guestinfo�transport_iso9660r �lenr � startswith�LOG�debugr � read_seeded� mergemanydictr �metadata� userdata_raw�vendordata_rawr )r �found�md�ud�vd�defaults�seedfile�contentsr r �np�name� transfuncr$ � seedfound�proto�md_seedr r r � _get_data' sf � � � � zDataSourceOVF._get_datac C s d| j S )Nzovf (%s))r �r r r r �_get_subplatformi s z DataSourceOVF._get_subplatformc C s, d| j vrg S | j d }t|t�r|S |gS )N� public-keys)r2 � isinstance�list)r �pksr r r �get_public_ssh_keysl s z!DataSourceOVF.get_public_ssh_keysc C � | j S �N)r rC r r r �get_config_objx s z DataSourceOVF.get_config_objc C rJ rK )r rC r r r �network_config{ s z DataSourceOVF.network_configN) �__name__� __module__� __qualname__�dsnamer r rB rD rI rL �propertyrM r r r r r s B r c @ s e Zd Zdd� ZdS )�DataSourceOVFNetc C s, t �| |||� tj�|jd�| _d| _d S )Nzovf-net)zhttp://zhttps://)r r r r r r r r r r r r � s zDataSourceOVFNet.__init__N)rN rO rP r r r r r rS � s rS Fc C s� t | �}i }i }d }dg}g d�}dg}|�� D ]^\} } | dkr"d} | |v r+| || < q| |v r4| || < q| |v r[|r[zt�| �� �} t| ��d�|| < W q tyZ t� d� Y qw | dkrvz t�| �� �}W q tyu | �� }Y qw q|||fS ) N�password)r$ �local-hostnamerE r! r# �hostnamerU �networkz%Ignore network-config in wrong formatz user-data) �get_properties�items�base64� b64decode�encode�safeload_yaml_or_dict�get� Exceptionr. r/ ) r; � read_network�propsr6 r r7 � cfg_props�md_props� network_props�prop�valrM r r r r( � s: � �� r( c C sf d}|D ],}t j�| |�}t j�|�r0z t�|�}||fW S ty/ t�td|� Y qw qdS )N)z ovf-env.xmlz ovf_env.xmlz OVF_ENV.XMLz OVF-ENV.XMLzFailed loading ovf file %s)NF) r r r �isfiler � load_filer_ �logexcr. )�dirname� env_names�fname�full_fnr; r r r r' � s ��r' c C s� | sdS t | t�std| ��tj�| �} | �d�r!| �d�d } | �d�r.| �d�d } n | � d�dkr7dS | s;dS d}tj � d|�}t � |�}|�| �d uS ) z�Test if devname matches known list of devices which may contain iso9660 filesystems. Be helpful in accepting either knames (with no leading /dev/) or full path names, but do not allow paths outside of /dev/, like /dev/foo/bar/xxx. Fz Unexpected input for devname: %sz/dev/���r r z^(sr[0-9]+|hd[a-z]|xvd.*)�CLOUD_INIT_CDROM_DEV_REGEXN)rF �str� ValueErrorr r �normpathr- � partition�split�count�environr^ �re�compile�match)�devname� default_regex� devname_regex�cdmatchr r r �maybe_cdrom_device� s" r~ Tc C s� t �� }|�� D ]&\}}|d }|dkr| rqt|�s q|d }t|�\}}|dur.| S q| r4d}nd }dd� t �|rAd| nd �D �} | D ]'}z t j|t|d�\}}W n t jyf t� d |� Y qHw |duro| S qHd S ) N�fstype�iso9660� mountpointFc S s g | ]}t |�r|�qS r )r~ )�.0�devr r r � <listcomp>� s ��z%transport_iso9660.<locals>.<listcomp>zTYPE=%s)�mtypez%s not mountable as iso9660) r �mountsrY r~ r' �find_devs_with�mount_cb�MountFailedErrorr. r/ ) � require_isor� r� �infor �mp�_fnamer; r� �devsr r r r+ � s: �� ��r+ c C s� d} d }t �| �s |S | dg}zt � |�\}}|r |W S t�d||� W |S t jyR } z |jdkrGt�d| |j� t�|� W Y d }~|S W Y d }~|S d }~ww )Nzvmware-rpctoolzinfo-get guestinfo.ovfEnvz%cmd %s exited 0 with empty stdout: %s� z%s exited with code %d)r �whichr. r/ �ProcessExecutionError� exit_code�warning)�rpctool� not_found�cmd�out�_err�er r r r* s( � ���r* c C s2 g }| � � s|S | jD ] }||�r|�|� q |S rK )� hasChildNodes� childNodesr) )�node� filter_func�ret�childr r r � find_child s �r� c C s� t �| �}|jjdkrtd��|j�� std��d}t|jdd� �}t|�dkr,td��i }t|d d d� �}|D ]}|j� |d �j }|j� |d �j }|||< q9|S ) N� EnvironmentzNo Environment NodezNo Child Nodesz)http://schemas.dmtf.org/ovf/environment/1c S � | j dkS )N�PropertySection�� localName��nr r r �<lambda>/ � z get_properties.<locals>.<lambda>r zNo 'PropertySection'sc S r� )N�Propertyr� r� r r r r� 7 r� �key�value) r � parseString�documentElementr� �XmlErrorr� r� r, � attributes�getNamedItemNSr� ) r; �dom�envNsURI� propSectionsra � propElems�elemr� rf r r r rX ! s( � � rX c @ s e Zd ZdS )r� N)rN rO rP r r r r r� B s r� c C s t �| t�S rK )r �list_from_depends� datasources)�dependsr r r �get_datasource_listN s r� c C s | si S t �| �S )z� The meta data could be JSON or YAML. Since YAML is a strict superset of JSON, we will unmarshal the data as YAML. If data is None then a new dictionary is returned. )r �load)�datar r r r] R s r] )F)T) rZ r rw �xml.domr � cloudinitr �loggingr r r r � getLoggerrN r. r r rS r( r' r~ r+ r* r� rX r_ r� �DEP_FILESYSTEM� DEP_NETWORKr� r� r] r r r r �<module> s, j )' ! � __pycache__/DataSourceUpCloud.cpython-310.pyc 0000644 00000011065 15027667240 0015017 0 ustar 00 o �Ad6 � @ s� d dl mZ d dl mZ d dl mZmZ d dlmZ d dl m Z d dl m Z e�e�ZddiZd Zd Zd ZG d d � d ej�ZG d d� de�ZeejffeejejffgZdd� ZdS )� )�log)�net)�sources�util)�NoDHCPLeaseError)�EphemeralDHCPv4)�upcloud� metadata_urlz'http://169.254.169.254/metadata/v1.json� � c @ sH e Zd ZdZdZdd� Zdd� Zdd� Zd d � Zd d � Z e d d� �Z dS )�DataSourceUpCloud�UpCloudFc C s� t j�| |||� || _t� | _t�t�|ddgi �t g�| _ | j d | _ | j � dt �| _| j � dt�| _| j � dt�| _d | _d S )N� datasourcer r �retries�timeout� wait_retry)r � DataSource�__init__�distro�dict�metadatar � mergemanydict�get_cfg_by_path�BUILTIN_DS_CONFIG�ds_cfg�metadata_address�get� MD_RETRIESr � MD_TIMEOUTr � MD_WAIT_RETRYr �_network_config)�self�sys_cfgr �paths� r$ �E/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceUpCloud.pyr ! s �� zDataSourceUpCloud.__init__c C s t �� S �N)� uc_helper� read_sysinfo�r! r$ r$ r% � _get_sysinfo1 s z DataSourceUpCloud._get_sysinfoc C s t j| j| j| j| jd�S )N)r � sec_betweenr )r' � read_metadatar r r r r) r$ r$ r% �_read_metadata4 s �z DataSourceUpCloud._read_metadatac C s� | � � \}}|s dS t�d|� | jrfz4t�d� t�� }t�d|� t|| j� � d�� t j tjd| j d�}W d � n1 sAw Y W nR t tjfye } zt �tt|�� W Y d }~dS d }~ww zt�d� t j tjd| j d�}W n" tjy� } zt �tt|�� t�d |� W Y d }~dS d }~ww || _|�d |�| jd < |�d �| jd < |�d�| jd< |�d�| jd< |�dd�| jd< |�dd �| _|�dd �| _dS )NFz"Running on UpCloud. server_uuid=%szFinding a fallback NICz*Discovering metadata via DHCP interface %s)�tmp_dirz Reading from metadata service)�logfunc�msg�funcz7Discovering metadata without DHCP-configured networkingzENo DHCP-enabled interfaces available, unable to fetch metadata for %s� instance_idz instance-id�hostnamezlocal-hostname�network� public_keysz public-keys�region�default�availability_zone� vendor_data� user_dataT)r* �LOG�info�perform_dhcp_setup�debug�cloudnet�find_fallback_nicr r �get_tmp_exec_pathr �log_timer- r r �InvalidMetaDataException�logexc�str� metadata_fullr r �vendordata_raw� userdata_raw)r! � is_upcloud� server_uuid�nic�md�er$ r$ r% � _get_data< sf �� ����� ���� zDataSourceUpCloud._get_datac C s t �| �� �S r& )r � instance_id_matches_system_uuid�get_instance_id)r! r" r$ r$ r% �check_instance_ids s z#DataSourceUpCloud.check_instance_idc C s6 | j r| j S | j�d�}|std��t�|�| _ | j S )z� Configure the networking. This needs to be done each boot, since the IP and interface information might have changed due to reconfiguration. r4 z/Unable to get network meta-data from server....)r r r � Exceptionr' �convert_network_config)r! �raw_network_configr$ r$ r% �network_configv s �z DataSourceUpCloud.network_configN) �__name__� __module__� __qualname__�dsnamer= r r* r- rN rQ �propertyrU r$ r$ r$ r% r s 7r c @ s e Zd ZdZdZdS )�DataSourceUpCloudLocalaz Run in init-local using a DHCP discovery prior to metadata crawl. In init-local, no network is available. This subclass sets up minimal networking with dhclient on a viable nic so that it can talk to the metadata service. If the metadata service provides network configuration then render the network configuration for that instance based on metadata. TN)rV rW rX �__doc__r= r$ r$ r$ r% r[ � s r[ c C s t �| t�S r& )r �list_from_depends� datasources)�dependsr$ r$ r% �get_datasource_list� s r` N) � cloudinitr �loggingr r? r r �cloudinit.net.dhcpr �cloudinit.net.ephemeralr �cloudinit.sources.helpersr r' � getLoggerrV r; r r r r r r r[ �DEP_FILESYSTEM� DEP_NETWORKr^ r` r$ r$ r$ r% �<module> s" r � __pycache__/DataSourceOpenStack.cpython-310.pyc 0000644 00000020220 15027667240 0015324 0 ustar 00 o �Ad�) � @ s d dl Z d dlmZ d dlmZ d dlmZmZmZ d dlm Z m Z d dl m Z d dl mZ d dlmZ d d lmZ e�e�Zd d gZd Zd eiZdZdZeegZ dZ dZ dZ e Z e e e e g7 Z G dd� dej!ej"�Z#G dd� de#�Z$d dd�Z%e$ej&ffe#ej&ej'ffgZ(dd� Z)dS ) � N)�dmi)�log)�sources� url_helper�util)� EventScope� EventType)�NoDHCPLeaseError)�EphemeralDHCPv4)�DataSourceOracle)� openstackzhttp://[fe80::a9fe:a9fe]zhttp://169.254.169.254ziid-dsopenstackz instance-idzOpenStack NovazOpenStack Compute�OpenTelekomCloudz SAP CCloud VM� HUAWEICLOUDc s� e Zd ZdZejZdZej e j e j e j e jhiZ� fdd�Zdd� Zdd� Zd d � Zed d � �Zd d� Zdd� Zdd� Z� ZS )�DataSourceOpenStack� OpenStackFc sH t t| ��|||� d | _t�| j�| _d | _i | _ t j | _ t j | _ d S �N)�superr �__init__�metadata_addressr �fetch_ssl_details�paths� ssl_details�version�filesr �UNSET� ec2_metadata� network_json)�self�sys_cfg�distror �� __class__� �G/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceOpenStack.pyr > s z DataSourceOpenStack.__init__c C s" t j�| �}d|| j| jf }|S )Nz%s [%s,ver=%s])r � DataSource�__str__�dsmoder )r �root�mstrr" r" r# r% G s zDataSourceOpenStack.__str__c C s | j �dt�}dd� |D �}t|�t|�kr$t�dtt|�t|� �� t|�r+|}nt�d� t}g }i }|D ]}t � |d�}|� |� |||< q8| � � }t � � }t j||j|jdd�\} } | rjt�d || � n t�d |tt � � | �� |�| �| _t| �S ) N� metadata_urlsc S s g | ] }t �|�r|�qS r" )r �is_resolvable_url)�.0�xr" r" r# � <listcomp>N s zADataSourceOpenStack.wait_for_metadata_service.<locals>.<listcomp>z,Removed the following from metadata urls: %sz+Empty metadata url list! using default listr F)�urls�max_wait�timeout�connect_synchronouslyzUsing metadata source: '%s'z2Giving up on OpenStack md from %s after %s seconds)�ds_cfg�get� DEF_MD_URLS�set�LOG�debug�list�len�warningr � combine_url�append�get_url_params�time� wait_for_url�max_wait_seconds�timeout_seconds�intr �bool) r r. �filtered�md_urls�url2base�url�md_url� url_params� start_time� avail_url� _responser" r" r# �wait_for_metadata_serviceL sD � �� z-DataSourceOpenStack.wait_for_metadata_servicec C s t �| �� �S r )r � instance_id_matches_system_uuid�get_instance_id)r r r" r" r# �check_instance_idu s z%DataSourceOpenStack.check_instance_idc C sn | j tjkr | j S t�| j�dd��rd| _ | j S | jtjkr&t� d� dS t� d� t j | jdd�| _ | j S )z@Return a network config dict for rendering ENI or netplan files.�apply_network_configTNz<Unexpected call to network_config when network_json is None.z(network config provided via network_json)� known_macs) �_network_configr r r �is_falser2 r3 r r6 r: r7 r �convert_net_json)r r" r" r# �network_configy s � �z"DataSourceOpenStack.network_configc C s | j rHz&t| j| j�� d�� tjtjd| j d�}W d � n1 s#w Y W nA t t j fyG } zt� tt|�� W Y d}~dS d}~ww z| � � }W n t j yj } zt� tt|�� W Y d}~dS d}~ww | �|�d�g�| _| jt jkr}dS |�di �}t�|tg�}|| _|�d�| _|�d �| _|�d �| _|d | _| j�|�d i �� |�d �}|| _ zt � |�| _ W n t y� } zt� d|� d| _ W Y d}~nd}~ww |�d�}|| _!z t � |�| _"W dS t �y } zt� d|� d| _"W Y d}~dS d}~ww )a Crawl metadata, parse and persist that data for this instance. @return: True when metadata discovered indicates OpenStack datasource. False when unable to contact metadata service or when metadata format is invalid or disabled. )�tmp_dirzCrawl of metadata service)�logfunc�msg�funcNFr& �metadataz ec2-metadata� networkdata�userdatar r � vendordataz"Invalid content in vendor-data: %s� vendordata2z#Invalid content in vendor-data2: %sT)#�perform_dhcp_setupr �fallback_interfacer �get_tmp_exec_pathr �log_timer6 r7 �_crawl_metadatar r �InvalidMetaDataException�logexc�str�_determine_dsmoder3 r& �DSMODE_DISABLED� mergemanydict�DEFAULT_METADATAr[ r r � userdata_rawr r �update�vendordata_pure�convert_vendordata�vendordata_raw� ValueErrorr: �vendordata2_pure�vendordata2_raw)r �results�e�md�vd�vd2r" r" r# � _get_data� sp �� �� �� �� �� � ��z DataSourceOpenStack._get_datac C s� z | � � s t�d��W n ty" } z t�djt|�d���d}~ww | �� }ztjt j dt | j g| j |j|jd�d�}W |S tjyR } zt�t|���d}~w tjtfym } z dj| j d �}t�|�|�d}~ww ) z�Crawl metadata service when available. @returns: Dictionary with all metadata discovered for this datasource. @raise: InvalidMetaDataException on unreadable or broken metadata. z No active metadata service foundz,IOError contacting metadata service: {error})�errorNz#Crawl of openstack metadata service)r �retriesr0 )�args�kwargsz Broken metadata address {addr})�addr)rM r re �IOError�formatrg r= r rc r6 r7 �read_metadata_servicer r � num_retriesrA r � NonReadable�BrokenMetadata)r ru rI �resultrY r" r" r# rd � sJ ����������� ��z#DataSourceOpenStack._crawl_metadatac C sp d| j �d�v }t�� sdS t�d�}|tv rdS t�d�tv r"dS |r*t� � r*dS t� d��d�t kr6dS dS ) z<Return True when a potential OpenStack platform is detected.�Oracle�datasource_listTzsystem-product-namezchassis-asset-tag� � product_nameF) r r3 r �is_x86r � read_dmi_data�VALID_DMI_PRODUCT_NAMES�VALID_DMI_ASSET_TAGS�oracle�_is_platform_viable� get_proc_env�DMI_PRODUCT_NOVA)r � accept_oracler� r" r" r# � ds_detect� s z DataSourceOpenStack.ds_detect)�__name__� __module__� __qualname__�dsnamer r rS r` r �NETWORKr �BOOT_NEW_INSTANCE�BOOT� BOOT_LEGACY�HOTPLUG�supported_update_eventsr r% rM rP �propertyrV ry rd r� � __classcell__r" r" r r# r , s( �� ) <*r c @ s e Zd ZdZdZdS )�DataSourceOpenStackLocalau Run in init-local using a dhcp discovery prior to metadata crawl. In init-local, no network is available. This subclass sets up minimal networking with dhclient on a viable nic so that it can talk to the metadata service. If the metadata service provides network configuration then render the network configuration for that instance based on metadata. TN)r� r� r� �__doc__r` r" r" r" r# r� s r� � c C s t j| |||d�}|�� S )N)r r0 r{ )r �MetadataReader�read_v2)�base_urlr r0 r{ �readerr" r" r# r� s �r� c C s t �| t�S r )r �list_from_depends� datasources)�dependsr" r" r# �get_datasource_list& s r� )Nr� r� )*r> � cloudinitr r �loggingr r r �cloudinit.eventr r �cloudinit.net.dhcpr �cloudinit.net.ephemeralr �cloudinit.sourcesr r� �cloudinit.sources.helpersr � getLoggerr� r6 r4 � DEFAULT_IIDrk r� �DMI_PRODUCT_COMPUTEr� �DMI_ASSET_TAG_OPENTELEKOM�DMI_ASSET_TAG_SAPCCLOUD�DMI_ASSET_TAG_HUAWEICLOUDr� � SourceMixinr$ r r� r� �DEP_FILESYSTEM� DEP_NETWORKr� r� r" r" r" r# �<module> sD �� ` � __pycache__/DataSourceOpenNebula.cpython-310.pyc 0000644 00000030014 15027667240 0015467 0 ustar 00 o �Ad�? � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlmZ d dlm Z m Z m Z m Z e� e�ZdZdZdgZG dd� de j�ZG d d � d e�ZG d d � d e�ZG d d� d�Zdd� Zdd� Z ddd�Zd dd�Z dd� Z eZ ee j ffgZ dd� Z!dS ) � N)�log)�net�sources�subp�utilziid-dsopennebula�nobody� context.shc @ sF e Zd ZdZdd� Zdd� Zdd� Zdd � Zed d � �Z dd d�Z dS )�DataSourceOpenNebula� OpenNebulac C s. t j�| |||� d | _tj�|jd�| _d S )N� opennebula)r � DataSource�__init__�seed�os�path�join�seed_dir)�self�sys_cfg�distro�paths� r �H/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceOpenNebula.pyr $ s z DataSourceOpenNebula.__init__c C s t j�| �}d|| j| jf S )Nz%s [seed=%s][dsmode=%s])r r �__str__r �dsmode)r �rootr r r r ) s z DataSourceOpenNebula.__str__c C sl dt i}d }d }t}d| jv r| j�d�}| jg}|�t� � |D ]Z}z&tj� | j�r4t || j |d�}n|� d�rHt jt || j d�}t�||�}W n% tyR Y q! ty_ } z|�d }~w tjyn t�d|� Y nw |r{|}t�d|� nq!|s�dS |d } t�| |g�} | �|�d �| j�d �g�| _| jtjkr�dS || _ |�d �| _ | | _ |�d �| _ dS )Nz instance-id� parseuser��asuserz/dev)r r z%s was not mountablezfound datasource in %sF�metadata�DSMODEr �network-interfaces�userdataT) � DEFAULT_IID�DEFAULT_PARSEUSER�ds_cfg�getr �extend�find_candidate_devsr r �isdir�read_context_disk_dirr � startswith� functools�partialr �mount_cb�NonContextDiskDir�BrokenContextDiskDir�MountFailedError�LOG�warning�debug� mergemanydict�_determine_dsmoder r �DSMODE_DISABLEDr �networkr � userdata_raw) r �defaults�resultsr r � candidates�cdev�partially_applied_func�exc�mdr r r � _get_data- sb � � � �� �� z DataSourceOpenNebula._get_datac C s$ | j | jv r d}nd}d|| jf S )z/Return the subplatform metadata source details.zseed-dirz config-diskz%s (%s))r r )r �subplatform_typer r r �_get_subplatformj s z%DataSourceOpenNebula._get_subplatformc C s | j d ur| j S d S �N)r8 )r r r r �network_configr s z#DataSourceOpenNebula.network_configFc C s. |d u r| j tjkr d}nd}tj�| ||�S )NTF)r r �DSMODE_NETWORKr � get_hostname)r �fqdn� resolve_ip� metadata_onlyr r r rG y s z!DataSourceOpenNebula.get_hostnameN)FFF) �__name__� __module__� __qualname__�dsnamer r rA rC �propertyrE rG r r r r r s = r c @ � e Zd ZdS )r/ N�rK rL rM r r r r r/ � � r/ c @ rP )r0 NrQ r r r r r0 � rR r0 c @ s� e Zd Zd dd�Zdd� Zdd� Zdd � Zd d � Zd d � Zdd� Z dd� Z dd� Z dd� Z dd� Z dd� Zd dd�Zd d � ZdS ) �OpenNebulaNetworkNc C s| || _ |d u r t|�}t�dd� t|�� dd� d�D ��| _i | _|�� D ]\}}t� d|�}|r;|� d�| j|� � < q%d S )Nc S s g | ]}|�qS r r ��.0�kr r r � <listcomp>� s ��z.OpenNebulaNetwork.__init__.<locals>.<listcomp>c S s t �| d �S )N� )r �natural_sort_key)rV r r r �<lambda>� s z,OpenNebulaNetwork.__init__.<locals>.<lambda>)�keyz ^(.+)_MAC$rX ) �context�get_physical_nics_by_mac� collections� OrderedDict�sorted�items�ifaces�context_devname�re�match�group�lower)r r\ r �system_nics_by_macrV �v�mr r r r � s$ ��� ��zOpenNebulaNetwork.__init__c C s" d� dd� |�d�dd � D ��S )N�.c S s g | ] }t t|d ���qS )� )�str�int)rU �cr r r rW � s z,OpenNebulaNetwork.mac2ip.<locals>.<listcomp>�:� )r �split�r �macr r r �mac2ip� s "zOpenNebulaNetwork.mac2ipc C s | � |��d�d d S )Nrk r z.0)ru � rpartitionrs r r r � mac2network� s z OpenNebulaNetwork.mac2networkc C s\ i }| � |dd��� }|�| j�dd��� � |r ||d< | � |dd��� }|r,||d< |S )N�dns� �DNS� addresses� search_domain�search)� get_fieldrr r' r\ r& )r �dev� nameserversrx r| r r r �get_nameservers� s z!OpenNebulaNetwork.get_nameserversc C � | � |d�S )N�mtu�r~ �r r r r r �get_mtu� � zOpenNebulaNetwork.get_mtuc C � | � |d| �|��S )N�ip)r~ ru �r r rt r r r �get_ip� � zOpenNebulaNetwork.get_ipc C s< g }| � |d�}|r|�|� | � |d�}|r |�|� |S )N�ip6�ip6_ula)r~ �append)r r � addresses6r� r� r r r �get_ip6� s zOpenNebulaNetwork.get_ip6c C � | � |dd�S )N�ip6_prefix_length�64r� r� r r r �get_ip6_prefix� � z OpenNebulaNetwork.get_ip6_prefixc C r� )N�gatewayr� r� r r r � get_gateway� r� z OpenNebulaNetwork.get_gatewayc C s | � |d| � |d��S )N� ip6_gateway�gateway6r� r� r r r � get_gateway6� s �z OpenNebulaNetwork.get_gateway6c C r� )N�maskz 255.255.255.0r� r� r r r �get_mask� r� zOpenNebulaNetwork.get_maskc C r� )Nr8 )r~ rw r� r r r � get_network� r� z OpenNebulaNetwork.get_networkc C s* | j �d�||f��� �}|dv r|S |S )z�return the field name in context for device dev. context stores <dev>_<NAME> (example: eth0_DOMAIN). an empty string for value will return default.�_)Nry )r\ r& r �upper)r r �name�default�valr r r r~ � s ��� zOpenNebulaNetwork.get_fieldc s0 i }d|d< i |d< i }| j �� D ]�\}}|�� }| j�||�}i }d|i|d< g |d< | �|�}tt�|��}|d � | � ||�d | � | � |�} | ra| � |�� |d � � fdd �| D �� | �|�} | rl| |d < | �|�} | rw| |d < | �|�} | r�| |d < | �|�} | r�| |d < |||< q||d< |S )Nrq �version� ethernets� macaddressre r{ �/c s g | ]}|d � �qS )r� r )rU �i��prefix6r r rW s z.OpenNebulaNetwork.gen_conf.<locals>.<listcomp>�gateway4r� r� r� )rb ra rg rc r& r� rm r �ipv4_mask_to_net_prefixr� r� r� r� r' r� r� r� r� )r �netconfr� rt r �c_dev�devconfr� �prefixr� r� r� r� r� r r� r �gen_conf� sD � zOpenNebulaNetwork.gen_confrD )rK rL rM r ru rw r� r� r� r� r� r� r� r� r� r~ r� r r r r rS � s rS c C s@ g } dD ]}t �|�}|�� |D ] }|| vr | �|� qq| S )zE Return a list of devices that may contain the context disk. )z LABEL=CONTEXTz LABEL=CDROMz TYPE=iso9660)r �find_devs_with�sortr� )�combined�f�devs�dr r r r( s ��r( c C s dd| gS )N�sudoz-ur ��userr r r �switch_user_cmd/ s r� c C sr t |t�r |g}n|d u rddg}|d u rt}dd� tjd D �}|}|d u r+|}g }d�d�}dd � }d | ||� d | d ||� d } g } |d urR||�} | �|� tj| | d �\} } d } i }i }d }| dd� } | �d�D ]C}z&|�dd�\}}||u r�|||< n|| vr�||v s�|� |�|kr�|||< W qs t y� |dkr�� |d u r�|}n||u r�|}Y qsw |S )N�bashz-ec S s g | ]}d | �qS )z${!%s*}r )rU �xr r r rW A s z&parse_shell_config.<locals>.<listcomp>r� � )z__v="";ry c S s d� ddd� | � dddf�S )Nr� zprintf "%s\0" _start_zfor __v in %s; do� z% printf "%s=%s\0" "$__v" "${!__v}";�donery )r )�vlistr r r � varprinterO s ��z&parse_shell_config.<locals>.varprinterz unset IFS z{ %s : } > /dev/null )�data)� EPOCHREALTIME� EPOCHSECONDS�RANDOM�LINENO�SECONDSr� �SRANDOM�__vr ���� �=rX �_start_) � isinstancerm r� �string� ascii_lettersr r' r rr r& � ValueError)�content�keylistr� r �switch_user_cb�allvars� keylist_in�setupr� �bcmd�cmd�output�_error�excluded�preset�ret�target�liner[ r� r r r �parse_shell_config3 st �������� � ��r� c C sJ i }t D ]}tj�| |�}tj�|�r|||< q|s"td| df ��i }di d�}d|v r�|durNzt�|� W n tyM } z t dj |d��|�d}~ww ztj�| d�} t � | �} t | |d�}W n* tjyv } zt d | �|�d}~w ty� } ztd | �|�d}~ww td ��|s�|S ||d < d} d |v r�d } nd|v r�d} | r�|�| ��� } dd� | D �|d d< dD ]} | |v r�|| |d d< nq�d|v r�|d |d< n d|v r�|d |d< d|v �r|�d|�d��}|dk�rz t �|d �|d< W n t�y t�d� Y nw dd� |D �}|�r#t||�}|�� |d < |S ) z� read_context_disk_dir(source_dir): read source_dir and return a tuple with metadata dict and user-data string populated. If not a valid dir, raise a NonContextDiskDir z%s: %szno files foundN)r" r r z'configured user '{user}' does not existr� r z Error processing context.sh: %sz Error reading context.sh: %szMissing context.shr �SSH_KEY�SSH_PUBLIC_KEYc S s" g | ] }t |�r|�d �s|�qS )�#)�lenr+ )rU r� r r r rW � s ���z)read_context_disk_dir.<locals>.<listcomp>z public-keys)� SET_HOSTNAME�HOSTNAME� PUBLIC_IP� IP_PUBLIC�ETH0_IPzlocal-hostname� USER_DATAr" �USERDATA�USERDATA_ENCODING�USER_DATA_ENCODING�base64z"Failed base64 decoding of userdatac S s g | ] }t �d |�r|�qS )z ^ETH\d+_IP.*$)rd re rT r r r rW � s r! )�CONTEXT_DISK_FILESr r r �isfiler/ �pwd�getpwnam�KeyErrorr0 �formatr � load_filer� r �ProcessExecutionError�IOErrorr& � splitlines�b64d� TypeErrorr2 r3 rS r� )� source_dirr r �found�af�fnr\ r; �er r� � ssh_key_var�linesrV �encoding� ipaddr_keys�onetr r r r* � s� � ����� ��������� � � r* c s" t �� }t� fdd�|�� D ��S )Nc s$ g | ]\}}� j �|�r||f�qS r )� networking� is_physical)rU rj �n�r r r rW s $ z,get_physical_nics_by_mac.<locals>.<listcomp>)r �get_interfaces_by_mac�dictra )r r� r r r r] � s �r] c C s t �| t�S rD )r �list_from_depends� datasources)�dependsr r r �get_datasource_list r� r )NNNNrD )"r^ r, r r� rd r� � cloudinitr �loggingr r r r � getLoggerrK r2 r# r$ r� r r � Exceptionr/ r0 rS r( r� r� r* r] �DataSourceOpenNebulaNet�DEP_FILESYSTEMr r r r r r �<module> s6 b � k` � __pycache__/DataSourceScaleway.cpython-310.pyc 0000644 00000021044 15027667240 0015212 0 ustar 00 o �Ad�% � @ s* d dl Z d dlZd dlZd dlZd dlZd dlmZ d dlmZ d dl m Z d dl m Z d dl m Z mZmZmZ d dlmZmZ d dlmZ d d lmZ d d lmZ e �e�Z d Z e d e d e d d�Z dZ dZ dd� Z!G dd� dej"j#�Z$dd� Z%dd� Z&G dd� dej'�Z(e(ej)ffgZ*d d � Z+dS ) � N)�HTTPConnection)� PoolManager)�dmi)�log)�net�sources� url_helper�util)� EventScope� EventType)�NoDHCPLeaseError)�EphemeralDHCPv4)�DataSourceHostnamezhttp://169.254.42.42z/conf?format=jsonz/user_data/cloud-initz/vendor_data/cloud-init)� metadata_url� userdata_url�vendordata_url� � c C s> t �d�} | dkr dS tj�d�rdS t�� }d|v r dS dS )a There are three ways to detect if you are on Scaleway: * check DMI data: not yet implemented by Scaleway, but the check is made to be future-proof. * the initrd created the file /var/run/scaleway. * "scaleway" is in the kernel cmdline. zsystem-manufacturer�ScalewayTz/var/run/scaleway�scalewayF)r � read_dmi_data�os�path�existsr � get_cmdline)� vendor_name�cmdline� r �F/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceScaleway.py� on_scaleway) s r c s* e Zd ZdZ� fdd�Zddd�Z� ZS )�SourceAddressAdapterzF Adapter for requests to choose the local address to bind to. c s || _ tt| �jdi |�� d S )Nr )�source_address�superr �__init__)�selfr! �kwargs�� __class__r r r# E s z SourceAddressAdapter.__init__Fc C s0 t jtjtjdfg }t|||| j|d�| _d S )N� )� num_pools�maxsize�blockr! �socket_options)r �default_socket_options�socket� SOL_SOCKET� SO_REUSEPORTr r! � poolmanager)r$ � connectionsr* r+ r, r r r �init_poolmanagerI s � �z%SourceAddressAdapter.init_poolmanager)F)�__name__� __module__� __qualname__�__doc__r# r3 � __classcell__r r r& r r @ s r c C s^ zt j| d|d|dd� d�}t�|j�W S t jy. } z |jdkr)W Y d}~dS � d}~ww )aQ Retrieve user data or vendor data. Scaleway user/vendor data API returns HTTP/404 if user/vendor data is not set. This function calls `url_helper.readurl` but instead of considering HTTP/404 as an error that requires a retry, it considers it as empty user/vendor data. Also, be aware the user data/vendor API requires the source port to be below 1024 to ensure the client is root (since non-root users can't bind ports below 1024). If requests raises ConnectionError (EADDRINUSE), the caller should retry to call this function on an other port. Nr c S s |j dko t|jtjj� S )N� )�code� isinstance�cause�requests� exceptions�ConnectionError)�_�excr r r �<lambda>q s z%query_data_api_once.<locals>.<lambda>)�data�timeout�retries�session� exception_cbr9 )r �readurlr � decode_binary�contents�UrlErrorr: )� api_addressrD �requests_session�resprA r r r �query_data_api_onceV s � ��rO c C s� t dt|d��D ]K}z(t�d| |� t�� }|�dtd|fd�� t|||d�}t�d| � |W S t j yS } zt� d | |� t � d � |}W Y d }~qd }~ww |�) a/ Get user or vendor data. Handle the retrying logic in case the source port is used. Scaleway metadata service requires the source port of the client to be a privileged port (<1024). This is done to ensure that only a privileged user on the system can access the metadata service. r( � z*Trying to get %s data (bind on port %d)...zhttp://z0.0.0.0)r! )rD rM z%s-data downloadedz%Error while trying to get %s data: %sr N)�range�max�LOG�debugr= �Session�mountr rO r rK �warning�time�sleep) �api_typerL rE rD �portrM rC rA �last_excr r r �query_data_api~ s. � �� ��r] c s� e Zd ZdZejejejej hiZ � fdd�Z dd� Z dd� Z edd � �Zed d � �Zd d � Zdd� Zddd�Zedd� �Zedd� �Z� ZS )�DataSourceScalewayr c s� t t| ��|||� t�t�|ddgi �tg�| _| jd | _| jd | _ | jd | _ t | j� dt ��| _t | j� dt��| _d | _tj| _d S )N� datasourcer r r r rE rD )r" r^ r# r � mergemanydict�get_cfg_by_path�BUILTIN_DS_CONFIG�ds_cfg�metadata_address�userdata_address�vendordata_address�int�get�DEF_MD_RETRIESrE �DEF_MD_TIMEOUTrD �_fallback_interfacer �UNSET�_network_config)r$ �sys_cfg�distro�pathsr& r r r# � s �� zDataSourceScaleway.__init__c C sZ t j| j| j| jd�}t�t�|j ��| _ t d| j | j| j�| _ t d| j| j| j�| _d S )N)rD rE z user-dataz vendor-data)r rH rd rD rE �json�loadsr rI rJ �metadatar] re � userdata_rawrf �vendordata_raw)r$ rN r r r �_crawl_metadata� s �� �z"DataSourceScaleway._crawl_metadatac C s� t � sdS | jd u rt�� | _z)t| j| j�� d�� tjt j d| j d� W d � W dS 1 s1w Y W dS t yS } zt� t t|�� W Y d }~dS d }~ww )NF)�tmp_dirzCrawl of metadata service)�logfunc�msg�funcT)r rk r �find_fallback_nicr ro �get_tmp_exec_pathr �log_timerS rT rv r �logexc�str)r$ �er r r � _get_data� s. �� � � ���z DataSourceScaleway._get_datac C s� | j du rt�dtj� tj| _ | j tjkr| j S | jdu r#t�� | _dd| j d�}ddig}| jd rY|d d| jd d d| jd d d d d| jd d d�gd�g7 }||d< d|gd�| _ | j S )z` Configure networking according to data received from the metadata API. Nz5Found None as cached _network_config. Resetting to %s�physicalz%s)�type�namer� �dhcp4�ipv6�static�address�netmaskz::�0�gateway)�network�prefixr� )r� r� r� �routes�subnetsr( )�version�config) rm rS rW r rl rk r r{ rs )r$ �netcfgr� r r r �network_config� s6 � ����z!DataSourceScaleway.network_configc C � d S �Nr �r$ r r r � launch_index � z DataSourceScaleway.launch_indexc C s | j d S )N�id)rs r� r r r �get_instance_id s z"DataSourceScaleway.get_instance_idc C s^ dd� | j d D �}d}t|�}| j �dg �D ]}|�|�s q|�|d |� �dd�� q|S )Nc S s g | ]}|d �qS )�keyr )�.0r� r r r � <listcomp> s z:DataSourceScaleway.get_public_ssh_keys.<locals>.<listcomp>�ssh_public_keyszAUTHORIZED_KEY=�tagsr@ � )rs �lenrh � startswith�append�replace)r$ �ssh_keys�akeypre�plen�tagr r r �get_public_ssh_keys s z&DataSourceScaleway.get_public_ssh_keysFc C s t | jd d�S )N�hostnameF)r rs )r$ �fqdn� resolve_ip� metadata_onlyr r r � get_hostname s z DataSourceScaleway.get_hostnamec C r� r� r r� r r r �availability_zone! r� z$DataSourceScaleway.availability_zonec C r� r� r r� r r r �region% r� zDataSourceScaleway.region)FFF)r4 r5 r6 �dsnamer �NETWORKr �BOOT_NEW_INSTANCE�BOOT� BOOT_LEGACY�default_update_eventsr# rv r� �propertyr� r� r� r� r� r� r� r8 r r r& r r^ � s, �� ' r^ c C s t �| t�S r� )r �list_from_depends� datasources)�dependsr r r �get_datasource_list/ s r� ),rq r r. rX r= �urllib3.connectionr �urllib3.poolmanagerr � cloudinitr r �loggingr r r r �cloudinit.eventr r �cloudinit.net.dhcpr �cloudinit.net.ephemeralr �cloudinit.sourcesr � getLoggerr4 rS � DS_BASE_URLrb ri rj r �adapters� HTTPAdapterr rO r] � DataSourcer^ �DEP_FILESYSTEMr� r� r r r r �<module> s> �(& � __pycache__/DataSourceRbxCloud.cpython-310.pyc 0000644 00000016555 15027667240 0015177 0 ustar 00 o �AdU � @ s� d Z ddlZddlZddlZddlZddlmZ ddlmZ ddlm Z m Z m Z ddl mZmZ e �e�ZdZdd � Zd ed efd d �Zd eje fdd�Zdd� Zdd� Zdd� Z dd� Z dd� Z G dd� de j �Z e e j!ffgZ"d d � Z#dS ) zr This file contains code used to gather the user data passed to an instance on rootbox / hyperone cloud platforms � N)� IPv4Address)�log)�sources�subp�util)� EventScope� EventTypez /etc/hostsc C s. t jtdd�} | rt�d� dS t�d� dS )NT)�quietz5/etc/hosts exists - setting manage_etc_hosts to FalseFz=/etc/hosts does not exists - setting manage_etc_hosts to True)r � load_file� ETC_HOSTS�LOG�debug)�hosts� r �F/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceRbxCloud.py�get_manage_etc_hosts s r �inc�returnc C s t ttt| ��| ��S �N)�strr �int)�addrr r r r � increment_ip# s r c C s | t | d�t | d�gS )z�Return a list of 3 IP addresses: [addr, addr + 2, addr + 3] @param addr: an object that is passed to IPvAddress @return: list of strings � � )r )r r r r � get_three_ips' s �r c C s t � dg| �S )z� Uses the preferred cloud-init subprocess def of subp.subp and runs arping. Breaking this to a separate function for later use in mocking and unittests �arping)r )�cmdr r r �_sub_arp4 s r c C s| d}|j dv r d}| D ]0}ztdd||d |d g� W q tjy; } zt�d|d |d |� W Y d }~q d }~ww d S ) Nz-S)�fedora�centos�rhelz-sz-c�2�source� destinationz&Failed to arping from "%s" to "%s": %s)�namer r �ProcessExecutionErrorr �warning)�items�distro� source_param�item�errorr r r �gratuitous_arp= s$ �����r- c C s� t t�d�t�d� �} | sdS | D ]>}ztj|tg d�d�}|r&|W S W q ty@ } z |jtjkr6� W Y d}~qd}~w tjyP t� t d|� Y qw t � dd � | �� dS ) zAReturns False (not found or error) or a dictionary with metadata.z LABEL=CLOUDMDz LABEL=cloudmdF)�vfat�fat�msdosfs)�device�callback�mtypeNz-Failed to mount %s when looking for user dataz0Did not find RbxCloud data, searched devices: %s�,) �setr �find_devs_with�mount_cb�read_user_data_callback�OSError�errno�ENOENT�MountFailedError�logexcr r �join)�devicesr1 �rbx_data�errr r r �get_mdR s> ��� � ���� �rB c C s ddd� t | �D �d�S )z�Generate network configuration @param netadps: A list of network adapter settings @returns: A dict containing network config � c sB g | ] \}� d d� t|��� d �� � fdd�� d D �d��qS )�physicalzeth{}� macaddressc s> g | ]}d |d � d d d� d d � d d d d��qS ) �static�address�network�netmask�auto�gateway�dns� nameservers)�typerG rI �controlrK �dns_nameserversr )�.0�ip��netadpr r � <listcomp> s � ���z6generate_network_config.<locals>.<listcomp>.<listcomp>rR )rN r% � mac_address�subnets)�formatr �lower)rQ �ir rS r rU z s � ���z+generate_network_config.<locals>.<listcomp>)�version�config)� enumerate)�netadpsr r r �generate_network_configq s ��r_ c C s t jt jtj�| d�dd�d�}t jtj�| d�dd�}d|vs$d |vr,t �td � d S |�d i ��d �}|�d i ��dg �}d }|�d i ��d�rR|d d d }t |d �}||d d |d d g d�dd� |d D �ddd||dg|d|d�i|t � d�d�}t� d� t� |� |S ) a This callback will be applied by util.mount_cb() on the mounted drive. @param mount_dir: String representing path of directory where mounted drive is available @returns: A dict containing userdata, metadata and cfg based on metadata. z cloud.jsonF)�fname�decode)�textz user.dataT)r` r �vmrT z(Failed to load metadata. Invalid format.N�additionalMetadata�username�sshKeys�password�sha512�_idr% )z instance-idzlocal-hostname� public-keysc S s> g | ]}|d D ]}t |d d �D ] }|d |d��qqqS )rR rH rK rG )r# r$ )r )rQ rT rR �targetr r r rU � s �� � �z+read_user_data_callback.<locals>.<listcomp>� default_userzALL=(ALL) NOPASSWD:ALL)r% �gecos�sudo�passwd� lock_passwd�ssh_authorized_keys)� ssh_pwauth� disable_root� system_info�network_config�manage_etc_hosts)�userdata�metadatar- �cfgzreturning DATA object:) r � load_jsonr �os�pathr> r= r �getr_ r r )� mount_dir� meta_data� user_datare �ssh_keys�hashrH �datar r r r8 � sV ��� ���� �� r8 c @ sj e Zd ZdZejejejej hiZ dd� Z dd� Z dd� Z edd � �Zd d � Zd d � Zdd� Zdd� ZdS )�DataSourceRbxCloud�RbxCloudc C s t j�| |||� d | _d S r )r � DataSource�__init__�seed)�self�sys_cfgr) �pathsr r r r� � s zDataSourceRbxCloud.__init__c C s t j�| �}d|| jf S )Nz %s [seed=%s])r r� �__str__r� )r� �rootr r r r� � s zDataSourceRbxCloud.__str__c C s> t � }|du r dS |d | _|d | _|d | _|d | _dS )zw Metadata is passed to the launching instance which is used to perform instance configuration. Frw rx r- ry T)rB � userdata_rawrx r- ry )r� r@ r r r � _get_data� s z DataSourceRbxCloud._get_datac C � | j d S )Nru �ry �r� r r r ru � s z!DataSourceRbxCloud.network_configc C r� )Nrj )rx r� r r r �get_public_ssh_keys� s z&DataSourceRbxCloud.get_public_ssh_keysc C � | j S r )r� r� r r r �get_userdata_raw� � z#DataSourceRbxCloud.get_userdata_rawc C r� r r� r� r r r �get_config_obj� r� z!DataSourceRbxCloud.get_config_objc C s t | j | j� d S r )r- r) )r� ry �is_new_instancer r r �activate s zDataSourceRbxCloud.activateN)�__name__� __module__� __qualname__�dsnamer �NETWORKr �BOOT_NEW_INSTANCE�BOOT� BOOT_LEGACY�default_update_eventsr� r� r� �propertyru r� r� r� r� r r r r r� � s" �� r� c C s t �| t�S r )r �list_from_depends� datasources)�dependsr r r �get_datasource_list s r� )$�__doc__r: r{ �os.path�typing� ipaddressr � cloudinitr �loggingr r r �cloudinit.eventr r � getLoggerr� r r r r r r �Listr r r- rB r_ r8 r� r� �DEP_FILESYSTEMr� r� r r r r �<module> s. !B 3� __pycache__/DataSourceVultr.cpython-310.pyc 0000644 00000006667 15027667240 0014574 0 ustar 00 o �Ad� � @ s d dl mZ d dlm m mZ d dlmZ d dlmZmZm Z e� e �Z ddddd e � � e�� d e�� d f d �ZG d d� dej�ZeejffgZdd� Ze dkr�d dlZe�� sged� e�d� e�ed ed ed ed ed �Zed Ze� � Z dS dS )� )�TupleN)�log)�sources�util�versionzhttp://169.254.169.254� � � z"Cloud-Init/%s - OS: %s Variant: %s�system�variant)�url�retries�timeout�wait� user-agentc sv e Zd ZU dZejjd Zeedf e d< � fdd�Z dd� Z d d � Z d d � Z d d� Zedd� �Zedd� �Z� ZS )�DataSourceVultr�Vultr)zstartup-script.�sensitive_metadata_keysc s6 t t| ��|||� t�t�|ddgi �tg�| _d S )N� datasourcer )�superr �__init__r � mergemanydict�get_cfg_by_path�BUILTIN_DS_CONFIG�ds_cfg)�self�sys_cfg�distro�paths�� __class__� �C/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceVultr.pyr % s � �zDataSourceVultr.__init__c C st t �d� t�� st �d� dS t �d� | �� | _| jd | _| �| j� t �d| jd � t �d| jd � d S ) Nz(Detecting if machine is a Vultr instance� Machine is not a Vultr instanceFzMachine is a Vultr instance� user-dataz SUBID: %sz instance-idz Hostname: %s�local-hostnameT)�LOG�debug�vultr�is_vultr� get_metadata�metadata� userdata_raw�get_datasource_data�r r! r! r" � _get_data/ s zDataSourceVultr._get_datac C sv d|v rt �|d � |d | _nt �|d �| _|d | _| jd dkr*d| jd< |d | _| jdkr9d | _d S d S )N�cloud_interfaces� interfaces� vendor-datar% � �guestr$ )r( �add_interface_names�netcfg�generate_network_config�vendordata_rawr+ r, )r �mdr! r! r" r- E s �z#DataSourceVultr.get_datasource_datac C s: t j| jd | jd | jd | jd | jd | j�� d�S )Nr r r r r )�tmp_dir)r( r* r r �get_tmp_exec_pathr. r! r! r" r* Z s �z DataSourceVultr.get_metadatac C s. t �� sdS t �� r dS t �� d }t�|�S )NF�subid)r( r) � is_baremetal� get_sysinfor � instance_id_matches_system_uuid)r r r< r! r! r" �check_instance_ide s z!DataSourceVultr.check_instance_idc C s d S �Nr! r. r! r! r" � launch_indexq s z DataSourceVultr.launch_indexc C s | j S rA )r6 r. r! r! r" �network_configu s z DataSourceVultr.network_config)�__name__� __module__� __qualname__�dsnamer � DataSourcer r �str�__annotations__r r/ r- r* r@ �propertyrB rC � __classcell__r! r! r r" r s �� r c C s t �| t�S rA )r �list_from_depends� datasources)�dependsr! r! r" �get_datasource_list� s rP �__main__r# � r r r r r r2 ) �typingr � cloudinit.sources.helpers.vultrr �helpersr( � cloudinitr r r � getLoggerrD r& �version_string� system_infor rH r �DEP_FILESYSTEMrN rP �sysr) �print�exitr* r9 �configr> �sysinfor! r! r! r" �<module> sF ��� _� � � __pycache__/DataSourceLXD.cpython-310.pyc 0000644 00000032700 15027667240 0014072 0 ustar 00 o �Ad�D � @ sV d Z ddlZddlZddlZddlZddlmZmZ ddlm Z ddl m Z m Z m Z mZmZmZmZ ddlZddlmZ ddlmZ ddlmZ dd lmZ dd lm Z m Z m Z m Z dd l m!Z! e�"e#�Z$d Z%d Z&dZ'ddddddd�Z(de)fdd�Z* d<dee e) de e)e f fdd�Z+G dd� de�Z,G dd � d e�Z-G d d � d e�Z.d e)de/fd d!�Z0G d"d#� d#e j1�Z2de3fd$d%�Z4 &d=d'ej5d(e)d)e3fd*d+�Z6 &d=d'ej5d(e)d)e3dej7fd,d-�Z8G d.d/� d/e�Z9G d0d1� d1�Z:e&e9j;fd2e)d3e9de/fd4d5�Z<e2e j=ffgZ>d6d7� Z?e#d8k�r)ddl@Z@d9ZAe@jBeAd:�ZCeC�D� eEe �Fe<e9j;d;��� dS dS )>a� Datasource for LXD, reads /dev/lxd/sock representation of instance data. Notes: * This datasource replaces previous NoCloud datasource for LXD. * Older LXD images may not have updates for cloud-init so NoCloud may still be detected on those images. * Detect LXD datasource when /dev/lxd/sock is an active socket file. * Info on dev-lxd API: https://linuxcontainers.org/lxd/docs/master/dev-lxd � N)�Flag�auto)�JSONDecodeError)�Any�Dict�List�Optional�Tuple�Union�cast)� HTTPAdapter)�HTTPConnection)�HTTPConnectionPool)�log)�sources�subp� url_helper�util)�find_fallback_nicz /dev/lxd/sockz1.0z http://lxd� user-data�network-config� vendor-data)�cloud-init.user-datazcloud-init.network-config�cloud-init.vendor-data�user.user-datazuser.network-config�user.vendor-data�returnc C s� d} t �d�rIz t � dg�\}}W n t jy, } zt�d|� | W Y d }~S d }~ww |�� dv rIt�� d d }|dkrAdS |d krGd S d S | S ) N�eth0zsystemd-detect-virtzHUnable to run systemd-detect-virt: %s. Rendering default network config.)�kvm�qemu�uname� �ppc64le�enp0s5�s390x�enc9�enp5s0)r �which�ProcessExecutionError�LOG�warning�stripr � system_info)� default_name� virt_type�_�err�arch� r2 �A/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceLXD.py� _get_fallback_interface_name/ s( ��� r4 �nicsc C sF t � }|r t�d|� n t� }t�d|� dd|ddd�gd�gd �S ) zCReturn network config V1 dict representing instance network config.zCLXD datasource generating network from discovered active device: %szVLXD datasource generating network from systemd-detect-virt platform default device: %s� �physical�dhcpr )�type�control)r9 �name�subnets)�version�config)r r) �debugr4 )r5 � primary_nicr2 r2 r3 �generate_network_configI s$ �� ���rA c �$ e Zd Z� fdd�Zdd� Z� ZS )�SocketHTTPConnectionc s t � �d� || _d S �N� localhost)�super�__init__� socket_path��selfrH �� __class__r2 r3 rG p � z SocketHTTPConnection.__init__c C s$ t � t jt j�| _| j�| j� d S �N)�socket�AF_UNIX� SOCK_STREAM�sock�connectrH �rJ r2 r2 r3 rS t s z SocketHTTPConnection.connect)�__name__� __module__� __qualname__rG rS � __classcell__r2 r2 rK r3 rC o � rC c rB )�SocketConnectionPoolc s || _ t� �d� d S rD )rH rF rG rI rK r2 r3 rG z s z SocketConnectionPool.__init__c C s t | j�S rN )rC rH rT r2 r2 r3 � _new_conn~ s z SocketConnectionPool._new_conn)rU rV rW rG r[ rX r2 r2 rK r3 rZ y rY rZ c @ s e Zd Zddd�ZdS )�LXDSocketAdapterNc C s t t�S rN )rZ �LXD_SOCKET_PATH)rJ �url�proxiesr2 r2 r3 �get_connection� s z LXDSocketAdapter.get_connectionrN )rU rV rW r` r2 r2 r2 r3 r\ � s r\ � metadata_typec C sx t |t�r|S |du r i S zt�|�}W n ty+ } z t�dj| |d��|�d}~ww |du r:t�dj| |d���|S )a6 Convert raw instance data from str, bytes, YAML to dict :param metadata_type: string, one of as: meta-data, vendor-data, user-data network-config :param metadata_value: str, bytes or dict representing or instance-data. :raises: InvalidMetaDataError on invalid instance-data content. NzAInvalid {md_type}. Expected str, bytes or dict but found: {value})�md_type�valuez:Invalid {md_type} format. Expected YAML but found: {value})� isinstance�dictr � load_yaml�AttributeErrorr �InvalidMetaDataException�format)ra �metadata_value�parsed_metadata�excr2 r2 r3 �_raw_instance_data_to_dict� s. �������rm c s� e Zd ZU dZejZeee f e d< ejZ eee f e d< ej j d Z ee df e d< dZded d f� fd d � Zd efd d�Zd efdd�Zd e fdd�Zd e fdd�Zed efdd��Z� ZS )� DataSourceLXD�LXD�_network_config�_crawled_metadata)�user.meta-datar r r r .�sensitive_metadata_keysT�ci_pkl_versionr Nc s t � �|� d| _d S )NT)rF � _unpickle�skip_hotplug_detect)rJ rt rK r2 r3 ru � rM zDataSourceLXD._unpicklec C s t � S )z@Check platform environment to report if this datasource may run.)�is_platform_viablerT r2 r2 r3 �_is_platform_viable� s z!DataSourceLXD._is_platform_viablec C s� | � � s t�d� dS tjtjdtd�| _td| j�d��| _ | j�di �}|�di �}|r3td|�}t | j t �sEt� t� | j �|g�| _ d| jv rP| jd | _d | jv r^td | jd �| _d | jv ri| jd | _d S ) z=Crawl LXD socket API instance data and return True on successz+Not an LXD datasource: No LXD socket found.FzCrawl of metadata service)�logfunc�msg�func� meta-datar> rr r r r T)rx r) r? r �log_time� read_metadatarq rm �get�metadatard re � mergemanydictrf � userdata_rawrp �vendordata_raw)rJ r> � user_metadatar2 r2 r3 � _get_data� s< � � � � � zDataSourceLXD._get_datac C s dj ttd�S )z.Return subplatform details for this datasourcez"LXD socket API v. {ver} ({socket}))�verrO )ri �LXD_SOCKET_API_VERSIONr] rT r2 r2 r3 �_get_subplatform� s �z DataSourceLXD._get_subplatformc C sB t tjd�}|�di �}t|t�st�|�}|�d�| j�d�kS )z%Return True if instance_id unchanged.�� metadata_keysr| z instance-id) r~ � MetaDataKeys� META_DATAr rd re r rf r� )rJ �sys_cfg�response�mdr2 r2 r3 �check_instance_id� s z DataSourceLXD.check_instance_idc C s� | j tjkr?| jtjkr| �� t| jt�r?| j�d�r(t� d� | jd | _ n| j�d�r?dd� | jd � � D �}t |�| _ | j tjkrNt� d� t � | _ t t| j �S )z�Network config read from LXD socket config/user.network-config. If none is present, then we generate fallback configuration. r z,LXD datasource using provided network config�devicesc S s g | ] \}}|d dkr|�qS )r9 �nicr2 )�.0�k�vr2 r2 r3 � <listcomp> s �z0DataSourceLXD.network_config.<locals>.<listcomp>z8LXD datasource generating network config using fallback.) rp r �UNSETrq r� rd re r r) r? �itemsrA r )rJ r� r2 r2 r3 �network_config� s( � � � z DataSourceLXD.network_config)rU rV rW �dsnamer r� rp r r �str�__annotations__rq � DataSourcers r rv �intru �boolrx r� r� r� �propertyre r� rX r2 r2 rK r3 rn � s �� "rn c C s" t j�t�rt�t �t�j�S dS )z=Return True when this platform appears to have an LXD socket.F)�os�path�existsr] �stat�S_ISSOCK�lstat�st_moder2 r2 r2 r3 rw s rw T�sessionr^ �do_raisec C sf t | ||�}|jst�d||j|j� i S z|�� W S ty2 } z t� dj ||jd��|�d }~ww )N�Skipping %s on [HTTP:%d]:%szFUnable to process LXD config at {url}. Expected JSON but found: {resp})r^ �resp) � _do_request�okr) r? � status_code�text�jsonr r rh ri )r� r^ r� � url_responserl r2 r2 r3 �_get_json_response s, � �����r� c C s| t ddd�D ]}| �|�}d|jkr!t�d� t�d|j||� q t�d|j|� |r<|js<t � dj |j||j d ���|S ) N� r ���i� g�������?z,[GET] [HTTP:%d] %s, retrying %d more time(s)z[GET] [HTTP:%d] %sz3Invalid HTTP response [{code}] from {route}: {resp})�code�router� ) �ranger r� �time�sleepr) r* r? r� r rh ri r� )r� r^ r� �retriesr� r2 r2 r3 r� / s* � ��r� c @ s0 e Zd Ze� Ze� Ze� Ze� ZeeB eB ZdS )r� N) rU rV rW r �NONE�CONFIG�DEVICESr� �ALLr2 r2 r2 r3 r� L s r� c @ sD e Zd Zefdefdd�Zdejdefdd�Z de defd d �Z d S ) �_MetaDataReader� api_versionc C s || _ t�t| j �| _d S rN )r� r � combine_url�LXD_URL� _version_url)rJ r� r2 r2 r3 rG U s z_MetaDataReader.__init__r� r c C s� di i}t �| jd�}t||�}t|�D ]I}t �t|�}t||dd�}|js1t� d||j |j � q|� d�d }|j |d |< |t v r]t | |vrQ|j |t | < qt�d||�dd d �� q|S ) a� Iterate on LXD API config items. Promoting CONFIG_KEY_ALIASES Any CONFIG_KEY_ALIASES which affect cloud-init behavior are promoted as top-level configuration keys: user-data, network-data, vendor-data. LXD's cloud-init.* config keys override any user.* config keys. Log debug messages if any user.* keys are overridden by the related cloud-init.* key. r> F�r� r� �/r� z,Ignoring LXD config %s in favor of %s value.�userz cloud-initr6 )r r� r� r� �sortedr� r� r� r) r? r� r� � rpartition�CONFIG_KEY_ALIASESr* �replace) rJ r� r> � config_url� config_routes� config_route�config_route_url�config_route_response�cfg_keyr2 r2 r3 �_process_configY s> �� �� ��z _MetaDataReader._process_configr� c C s� t �� �Q}|�| jt� � d| ji}tj|v r&t� | jd�}t ||�j |d< tj |v r3|� | �|�� tj|v rLt� | jd�}t||dd�}|rL||d< |W d � S 1 sXw Y d S )N�_metadata_api_versionr| r� Fr� )�requests�Session�mountr� r\ r� r� r� r r� r� r� r� �updater� r� r� )rJ r� r� r� �md_router^ r� r2 r2 r3 �__call__� s" � $�z_MetaDataReader.__call__N) rU rV rW r� r� rG r� r� re r� r� r� r2 r2 r2 r3 r� T s 7r� r� r� c C s t | d�|d�S )a8 Fetch metadata from the /dev/lxd/socket routes. Perform a number of HTTP GETs on known routes on the devlxd socket API. Minimally all containers must respond to <LXD_SOCKET_API_VERSION>/meta-data when the LXD configuration setting `security.devlxd` is true. When `security.devlxd` is false, no /dev/lxd/socket file exists. This datasource will return False from `is_platform_viable` in that case. Perform a GET of <LXD_SOCKET_API_VERSION>/config` and walk all `user.*` configuration keys, storing all keys and values under a dict key LXD_SOCKET_API_VERSION: config {...}. In the presence of the following optional user config keys, create top level aliases: - user.user-data -> user-data - user.vendor-data -> vendor-data - user.network-config -> network-config :param api_version: LXD API version to operated with. :param metadata_keys: Instance of `MetaDataKeys` indicating what keys to fetch. :return: A dict with the following optional keys: meta-data, user-data, vendor-data, network-config, network_mode, devices. Below <LXD_SOCKET_API_VERSION> is a dict representation of all raw configuration keys and values provided to the container surfaced by the socket under the /1.0/config/ route. )r� r� )r� )r� r� r2 r2 r3 r~ � s #�r~ c C s t �| t�S rN )r �list_from_depends� datasources)�dependsr2 r2 r3 �get_datasource_list� s r� �__main__z*Query LXD metadata and emit a JSON object.)� descriptionr� rN )T)G�__doc__r� rO r� r� �enumr r � json.decoderr �typingr r r r r r r r� �requests.adaptersr �urllib3.connectionr �urllib3.connectionpoolr � cloudinitr �loggingr r r r � cloudinit.netr � getLoggerrU r) r] r� r� r� r� r4 rA rC rZ r\ re rm r� rn r� rw r� r� �Responser� r� r� r� r~ �DEP_FILESYSTEMr� r� �argparser� �ArgumentParser�parser� parse_args�print� json_dumpsr2 r2 r2 r3 �<module> s� $ � � � �& m��� ����� � Q��� � *� � __pycache__/DataSourceSmartOS.cpython-310.pyc 0000644 00000061353 15027667240 0015001 0 ustar 00 o �Ad]� � @ s� U d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl Z d dl m Z d dl m Z d dl mZmZmZ d dlmZmZ e �e�Zdddd d d d d dddddd� Zdddd�ZdZdZdZdegZ g d �Z d Z d Z d Z e e e e g d d!d"id#�Z!d!d$d d d%�id!d&d!d'�gd(�Z"d)Z#d*Z$G d+d,� d,ej%�Z&G d-d.� d.e'�Z(G d/d0� d0e(�Z)G d1d2� d2�Z*G d3d4� d4e*�Z+G d5d6� d6e*�Z,G d7d8� d8e,�Z-de e e dfd9d:�Z.d;d<� Z/ =dQd>d?�Z0dRd@dA�Z1 dSdBdC�Z2e&ej3ffgZ4dDdE� Z5edFk�rUd dl6Z6e.� Z7e7du �re8dG� e6�9dH� e:e6j;�dHk�r*e<e�=� �e<e�=� � dIg Z=ne6j;dHd� Z=dJdK� Z>i Z?e@eAdL< e=D ] ZBe>e7eBe?dM� �q=e8ejCe?dHdNdOdP�� dS dS )T� N)�dmi)�log)�sources�subp�util)� EventScope� EventType)zsdc:uuidT)�hostnameT)�root_authorized_keysT)� user-scriptF)� user-dataF)zcloud-init:user-dataF)�iptables_disableT)� motd_sys_infoT)�sdc:datacenter_nameT)zsdc:vendor-dataF)zsdc:operator-scriptF)z sdc:hostnameT)zsdc:dns_domainT) � instance-id�local-hostnamez public-keysr �legacy-user-datar r r �availability_zone� vendor-data�operator-scriptr � dns_domainzsdc:nicsz sdc:resolversz sdc:routes)� network-data� dns_servers�routeszlx-brand�kvm�SmartOS� datasource)r r r r zsdc:uuiduser-datar z"/native/.zonecontrol/metadata.sockz /dev/ttyS1�< F� ephemeral0z/dev/vdb)� serial_device�serial_timeout�metadata_sockfile�no_base64_decode� base64_keys� base64_all� disk_aliases�mbr)� table_type�layout� overwrite�ext4)�label� filesystem�device)� disk_setup�fs_setupaU #cloud-boothook #!/bin/sh fname="%(per_boot_d)s/01_smartos_vendor_data.sh" mkdir -p "${fname%%/*}" cat > "$fname" <<"END_SCRIPT" #!/bin/sh ## # This file is written as part of the default vendor data for SmartOS. # The SmartOS datasource writes the listed file from the listed metadata key # sdc:operator-script -> %(operator_script)s # user-script -> %(user_script)s # # You can view content with 'mdata-get <key>' # for script in "%(operator_script)s" "%(user_script)s"; do [ -x "$script" ] || continue echo "executing '$script'" 1>&2 "$script" done END_SCRIPT chmod +x "$fname" z/var/dbc @ s� e Zd ZdZejZejZej e j e j e j hiZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Zdd� Zdd� Zdd� Zedd� �ZdS )�DataSourceSmartOS�Joyentc C sd t j�| |||� t�| jt�|ti �tg�| _i | _ d | _ d | _ t j �| j�d��| _| �� d S )N�scripts)r � DataSource�__init__r � mergemanydict�ds_cfg�get_cfg_by_path� DS_CFG_PATH�BUILTIN_DS_CONFIG�metadata� network_data�_network_config�os�path�join�paths� get_cpath� script_base_d�_init)�self�sys_cfg�distror@ � rG �E/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceSmartOS.pyr4 � s �� zDataSourceSmartOS.__init__c C s t j�| �}d|| jf S )Nz%s [client=%s])r r3 �__str__� md_client)rD �rootrG rG rH rI � s zDataSourceSmartOS.__str__c C s^ | j tjkrt� | _ | j d u rd | _| jtjkr-t| j | jd | jd | jd d�| _d S d S )Nr! r r )� smartos_typer! r r )rL r �UNSET�get_smartos_environrJ �jmc_client_factoryr6 �rD rG rG rH rC � s ��zDataSourceSmartOS._initc C sL t �d� d}tj�d�|dg��r$t�d�|dg�d�|dg�� dS dS )a� Mark the instance provisioning state as successful. When run in a zone, the host OS will look for /var/svc/provisioning to be renamed as /var/svc/provision_success. This should be done after meta-data is successfully retrieved and from this point the host considers the provision of the zone to be a success and keeps the zone running. z-Instance provisioning state set as successfulz/var/svc�/� provisioning�provision_successN)�LOG�debugr= r> �existsr? �rename)rD �svc_pathrG rG rH �_set_provisioned� s ��z"DataSourceSmartOS._set_provisionedc C s� | � � i }d}| jst�d� dS | j�� s t�d| j� dS | j�� t�� D ]\}}|\}}| jj ||d�||< q)t �� D ] \}}| j� |�||< q@| j� � t j�| j�� d|d d�}t j�|d �}d t } t|� d �|| d d d � t j�|d�} t|� d�| dd d� |� d�} dt } t| | � |d s�|d r�|d |d< n|d |d< d }|d r�|d }|d s�t|| t j�| j�d�d�d� |d< t�|| jg�| _|| _|d | _|d | _|d | _| � � d S )N� zNot running on smartosFz4No metadata device '%r' found for SmartOS datasource��strip� instancesr �datar z%s/user-scriptTi� )� content_f�link�shebang�moder )r_ ra rb r z%s/mdata-user-datar r r r r2 zper-boot)� user_script�operator_script� per_boot_dr r ) rC rL rT rU rJ rV �open_transport�SMARTOS_ATTRIB_MAP�items�get�SMARTOS_ATTRIB_JSON�get_json�close_transportr= r> r? r@ rA � LEGACY_USER_D�write_boot_content�BUILTIN_VENDOR_DATAr r5 r: � userdata_raw�vendordata_rawr; � routes_datarY ) rD �md�ud�ci_noun� attribute� smartos_nounr\ �data_drc � u_script_lrd �u_data�u_data_frG rG rH � _get_data� s~ � ��� � � zDataSourceSmartOS._get_datac C s dt S )Nz serial (%s))� SERIAL_DEVICErP rG rG rH �_get_subplatformN � z"DataSourceSmartOS._get_subplatformc C s | j d �|�S )Nr% )r6 ri )rD �namerG rG rH �device_name_to_deviceQ � z'DataSourceSmartOS.device_name_to_devicec C s | j tkrtS i S �N)rL �SMARTOS_ENV_KVM�BUILTIN_CLOUD_CONFIGrP rG rG rH �get_config_objT s z DataSourceSmartOS.get_config_objc C s | j d S )Nr )r: rP rG rG rH �get_instance_idY s z!DataSourceSmartOS.get_instance_idc C sN | j tjkr d | _ | j d u r$| jd ur$t| j| jd | jd | jd�| _ | j S )Nr r �r; r r r )r< r rM r; � convert_smartos_network_datar: rr rP rG rG rH �network_config\ s �z DataSourceSmartOS.network_configN)�__name__� __module__� __qualname__�dsnamer rM rL rJ r �NETWORKr �BOOT_NEW_INSTANCE�BOOT� BOOT_LEGACY�default_update_eventsr4 rI rC rY r| r~ r� r� r� �propertyr� rG rG rG rH r0 � s* ��cr0 c @ � e Zd ZdS )� JoyentMetadataFetchExceptionN�r� r� r� rG rG rG rH r� m � r� c @ r� )� JoyentMetadataTimeoutExceptionNr� rG rG rG rH r� q r� r� c @ s� e Zd ZdZe�d�Zd%dd�Zdd� Zdd � Z d d � Z d d � Z dd� Z d&dd�Z d'dd�Zd&dd�Zdd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� ZdS )(�JoyentMetadataClientz� A client implementing v2 of the Joyent Metadata Protocol Specification. The full specification can be found at http://eng.joyent.com/mdata/protocol.html z~V2 (?P<length>\d+) (?P<checksum>[0-9a-f]+) (?P<body>(?P<request_id>[0-9a-f]+) (?P<status>SUCCESS|NOTFOUND)( (?P<payload>.+))?)Nc C s |d u rt � }|| _|| _d S r� )rN rL �fp)rD rL r� rG rG rH r4 � s z JoyentMetadataClient.__init__c C s d� t�|�d��d@ �S )N�{0:08x}zutf-8� �� )�format�binascii�crc32�encode)rD �bodyrG rG rH � _checksum� s �z JoyentMetadataClient._checksumc C s� | j �|��� }t|d �t|d �kr"td�|d t|d ����| �|d �}|d |kr9td�||d ���|d |krItd�||d ���|�dd �sVt � d � d S t � |d �}t � d |� |S ) N�lengthr� z*Incorrect frame length given ({0} != {1}).�checksumz*Invalid checksum (expected: {0}; got {1}).� request_idz-Request ID mismatch (expected: {0}; got {1}).�payloadzNo value found.zValue "%s" found.) � line_regex�match� groupdict�int�lenr� r� r� ri rT rU r �b64d)rD �expected_request_id�frame� frame_data�expected_checksum�valuerG rG rH �_get_value_from_frame� s4 �� �� �� z*JoyentMetadataClient._get_value_from_framec s� g � � fdd�}d} z"| j �d�}t|�dkr t||� ��|dkr'|� W S � �|� W n tyH } z|jtjkrCt||� �|�� d}~ww q ) z� Reads a line a byte at a time until is encountered. Returns an ascii string with the trailing newline removed. If a timeout (per-byte) is set and it expires, a JoyentMetadataFetchException will be thrown. c s d� � ��d�S )N� �ascii)r? �decoderG ��responserG rH �as_ascii� r� z0JoyentMetadataClient._readline.<locals>.as_asciizPartial response: '%s'T� r � N)r� �readr� r� �append�OSError�errno�EAGAIN)rD r� �msg�byte�excrG r� rH � _readline� s, �����z JoyentMetadataClient._readlinec C s | j �|�d�� | j �� d S )Nr� )r� �writer� �flush)rD r� rG rG rH �_write� s zJoyentMetadataClient._writec C sJ t �d� | �d� | �� }t �d|� |dkr td| ��t �d� d S )NzNegotiating protocol V2z NEGOTIATE V2 z read "%s"�V2_OKz'Invalid response "%s" to "NEGOTIATE V2"zNegotiation complete)rT rU r� r� r� )rD r� rG rG rH � _negotiate� s �z JoyentMetadataClient._negotiatec C s� d� t�dd��}d�||f�}|r |dt�|�� ��� 7 }d� t|�| � |�|�}t � d|� d}| j s<| � � d}| �|� | �� }|rK| �� t � d |� d |vrWd S | �||�}|S ) Nr� r r� � zV2 {0} {1} {2} z#Writing "%s" to metadata transport.FTz"Read "%s" from metadata transport.�SUCCESS)r� �random�randintr? �base64� b64encoder� r� r� r� rT rU r� rf r� r� rl r� ) rD �rtype�paramr� � message_bodyr� � need_closer� r� rG rG rH �request� s2 ��� z JoyentMetadataClient.requestFc C s. | j d|d�}|d u r |S |r|r|�� }|S )N�GET�r� r� )r� r\ )rD �key�defaultr\ �resultrG rG rH ri � s zJoyentMetadataClient.getc C s$ | j ||d�}|d u r |S t�|�S )N)r� )ri �json�loads)rD r� r� r� rG rG rH rk � s z JoyentMetadataClient.get_jsonc C s | j dd�}|s g S |�d�S )N�KEYS)r� � )r� �split)rD r� rG rG rH �list s zJoyentMetadataClient.listc C s* d� dd� ||fD ���� }| jd|d�S )N� c S s g | ] }t �|�� ��qS rG )r� r� r� )�.0�irG rG rH � <listcomp> s z,JoyentMetadataClient.put.<locals>.<listcomp>�PUTr� )r? r� r� )rD r� �valr� rG rG rH �put s ��zJoyentMetadataClient.putc C s | j d|d�S )N�DELETEr� )r� )rD r� rG rG rH �delete � zJoyentMetadataClient.deletec C s | j r | j �� d | _ d S d S r� )r� �closerP rG rG rH rl s �z$JoyentMetadataClient.close_transportc C s | j r| S | �� | S r� )r� rf rP rG rG rH � __enter__ s z JoyentMetadataClient.__enter__c C s | � � d S r� )rl )rD �exc_type� exc_value� tracebackrG rG rH �__exit__ s z JoyentMetadataClient.__exit__c C s t �r� )�NotImplementedErrorrP rG rG rH rf # s z#JoyentMetadataClient.open_transport�NNr� �NF)r� r� r� �__doc__�re�compiler� r4 r� r� r� r� r� r� ri rk r� r� r� rl r� r� rf rG rG rG rH r� u s* � ! r� c s8 e Zd Zef� fdd� Zdd� Zdd� Zdd� Z� ZS ) �JoyentMetadataSocketClientc s t t| ��|� || _d S r� )�superr� r4 � socketpath)rD r� rL �� __class__rG rH r4 ( s z#JoyentMetadataSocketClient.__init__c C s4 t � t jt j�}|�| j� |�d�| _| �� d S )N�rwb)�socket�AF_UNIX� SOCK_STREAM�connectr� �makefiler� r� )rD �sockrG rG rH rf , s z)JoyentMetadataSocketClient.open_transportc C � t j�| j�S r� )r= r> rV r� rP rG rG rH rV 2 r� z!JoyentMetadataSocketClient.existsc C s d| j j| jf S )Nz%s(socketpath=%s))r� r� r� rP rG rG rH �__repr__5 s z#JoyentMetadataSocketClient.__repr__) r� r� r� �SMARTOS_ENV_LX_BRANDr4 rf rV r � __classcell__rG rG r� rH r� ' s r� c sD e Zd Zdedf� fdd� Zdd� Zdd� Zd d � Zd d � Z� Z S ) �JoyentMetadataSerialClient� Nc s" t t| ��||� || _|| _d S r� )r� r r4 r- �timeout)rD r- r rL r� r� rG rH r4 : s z#JoyentMetadataSerialClient.__init__c C r r� )r= r> rV r- rP rG rG rH rV A r� z!JoyentMetadataSerialClient.existsc C sZ | j d u r#tj| j| jd�}|�� std| j ��|| _ t�|tj � | � � | � � d S )N)r zUnable to open %s) r� �serial�Serialr- r �isOpen� SystemError�fcntl�lockf�LOCK_EX�_flushr� )rD �serrG rG rH rf D s z)JoyentMetadataSerialClient.open_transportc C s� t �d� | jj}d| j_ z| �� W n ty Y nw qt �d� |dkr-d| j_n|| j_ t �d� | �d� z | �� }|dkrGW n"|d krRt �d � W q1t �d |� W n tyg t �d � Y nw q2t �d � || j_d S )NzFlushing inputg�������?Tz Input empty� z,Writing newline, expecting "invalid command"r� zinvalid command�FAILUREzGot "FAILURE". Retrying.z%Unexpected response "%s" during flushzQTimeout while initializing metadata client. Is the host metadata service running?z'Got "invalid command". Flush complete.)rT rU r� r r� r� r� �warning)rD r r� rG rG rH r N sB �� ��� z!JoyentMetadataSerialClient._flushc C s d| j j| j| jf S )Nz%s(device=%s, timeout=%s))r� r� r- r rP rG rG rH r u s �z#JoyentMetadataSerialClient.__repr__) r� r� r� r� r4 rV rf r r r rG rG r� rH r 9 s � 'r c sN e Zd ZdZd� fdd� Zddd�Zd� fd d � Zdd d �Zdd d�Z� Z S )� JoyentMetadataLegacySerialClienta� V1 of the protocol was not safe for all values. Thus, we allowed the user to pass values in as base64 encoded. Users may still reasonably expect to be able to send base64 data and have it transparently decoded. So even though the V2 format is now used, and is safe (using base64 itself), we keep legacy support. The way for a user to do this was: a.) specify 'base64_keys' key whose value is a comma delimited list of keys that were base64 encoded. b.) base64_all: string interpreted as a boolean that indicates if all keys are base64 encoded. c.) set a key named b64-<keyname> with a boolean indicating that <keyname> is base64 encoded.r Nc s( t t| �}|�|||� d | _d | _d S r� )r� r r4 r# r$ )rD r- r rL �sr� rG rH r4 � s z)JoyentMetadataLegacySerialClient.__init__Fc C s� |rd | _ d | _d }| jd u r$| �� }d|v r!t�| �d��| _nd| _| jr)d S | j d u rm|d u r6| �� }t� }d|v rGt| �d��d��}dd� |D �D ]}t�| �|��r^|�|� qN||v rg|� |� qN|| _ d S d S )Nr$ Fr# �,c S s" g | ] }|� d �r|dd� �qS )zb64-� N)� startswith)r� �krG rG rH r� � s " zFJoyentMetadataLegacySerialClient._init_base64_keys.<locals>.<listcomp>) r# r$ r� r �is_true�_get�setr� �add�remove)rD �reset�keys�b64_keysr� rG rG rH �_init_base64_keys� s2 � �z2JoyentMetadataLegacySerialClient._init_base64_keysc s t t| �j|||d�S )N)r� r\ )r� r ri )rD r� r� r\ r� rG rH r � s �z%JoyentMetadataLegacySerialClient._getc C s, |t v rdS | j|d� | jrdS || jv S )NF)r T)�NO_BASE64_DECODEr# r$ r# )rD r� r rG rG rH �is_b64_encoded� s z/JoyentMetadataLegacySerialClient.is_b64_encodedc C sv t � }| j|d|d�}||u r|S | �|�r3z t�|�� ��� }W n tjy2 t � d||� Y nw |r9|� � }|S )NF)r\ r� z#Failed base64 decoding key '%s': %s) �objectr r% r� � b64decoder� r� r� �ErrorrT r r\ )rD r� r� r\ �mdefaultr� rG rG rH ri � s �z$JoyentMetadataLegacySerialClient.get)r N)Fr� ) r� r� r� r� r4 r# r r% ri r rG rG r� rH r } s " r c C sR | d u rt |�} | d u rd S | tkrt||| d�S | tkr#t|| d�S td| ��)N)r- r rL )r� rL z"Unknown value for smartos_type: %s)rN r� r r r� � ValueError)rL r! r r � uname_versionrG rG rH rO � s �� rO c C s� ddd| g}d }zt � |�\}}t�d| |� W n t jy5 } zt�td| |f� W Y d }~nd }~ww |d u r<d S |�� S )N�filez--briefz --mime-typezscript %s mime type is %sz%Failed to identify script type for %s)r rT rU �ProcessExecutionErrorr �logexcr\ )r_ �cmd�f_type�_err�erG rG rH � identify_file� s ���r3 � c C s$ | s t j�|�r t �|� |rt j�|�rt �|� | s dS tj|| |d� |rH| �d�sHt|�}|dkrHtj|d� d| g�|d� t � d|� |r�z+t j�|�rVt �|� | rpt j�|�rst� t j� |�� t �||� W dS W dS W dS ty� } zt�t d|� W Y d}~dS d}~ww dS ) a Write the content to content_f. Under the following rules: 1. If no content, remove the file 2. Write the content 3. If executable and no file magic, add it 4. If there is a link, create it @param content: what to write @param content_f: the file name @param backup_d: the directory to save the backup at @param link: if defined, location to create a symlink to @param shebang: if no file magic, set shebang @param mode: file mode Becuase of the way that Cloud-init executes scripts (no shell), a script will fail to execute if does not have a magic bit (shebang) set for the file. If shebang=True, then the script will be checked for a magic bit and to the SmartOS default of assuming that bash. N)rb z#!z text/plainr� z #!/bin/bashzadded shebang to file %sz$failed establishing content link: %s)r= r> rV �unlink�islinkr � write_filer r3 r? rT rU � ensure_dir�dirname�symlink�IOErrorr. )�contentr_ r` ra rb r0 r2 rG rG rH rn � s6 � � ���rn c C sR t �� }| d u r |d } | dkrtS |d u r t�d�}n|}|r'|�d�r'tS d S )Nr zBrandZ virtual linuxzsystem-product-name�SmartDC)r= �unamer r � read_dmi_datar r� )r+ � product_namer> � system_typerG rG rH rN 0 s rN c s: g d�g d�ddgd��|rt |ttf�s|g}ng }|r(t |ttf�s'|g}ng }|s.g }dd� }dd � }|d d �|d d �d �� g }| D ]�}t�fd d�|�� D ��}|�d|d d�� d|v rk|�d|d i� g } |�dg �D ]�} | dkr~ddi} n{g } t�fdd�|�� D ��} | �d| d�� || �r�dnd �d |v r�|�d d �r҈ � d s҇ �fd d!�|�d"g �D �} t| �r�| d# � � d < | �d� � d i� |D ]$}t�fd$d�|�� D ��}|�d|d% i� | �|� | �d&| i� q�| �| � qs|�d'| i� |�|� qE|�r|�d(||d)�� d*|d+�S ),a Return a dictionary of network_config by parsing provided SMARTOS sdc:nics configuration data sdc:nics data is a dictionary of properties of a nic and the ip configuration desired. Additional nic dictionaries are appended to the list. Converting the format is straightforward though it does include duplicate information as well as data which appears to be relevant to the hostOS rather than the guest. For each entry in the nics list returned from query sdc:nics, we create a type: physical entry, and extract the interface properties: 'mac' -> 'mac_address', 'mtu', 'interface' -> 'name'. The remaining keys are related to ip configuration. For each ip in the 'ips' list we create a subnet entry under 'subnets' pairing the ip to a one in the 'gateways' list. Each route in sdc:routes is mapped to a route on each interface. The sdc:routes properties 'dst' and 'gateway' map to 'network' and 'gateway'. The 'linklocal' sdc:routes property is ignored. )� mac_address�mtur� �params�subnets�type) �address� broadcast�dns_nameservers� dns_search�metric� pointopointr �scoperF �network�gateway)�physical�subnet�routec S � d| v S )N�.rG ��addrrG rG rH � is_valid_ipv4� r z3convert_smartos_network_data.<locals>.is_valid_ipv4c S rS )N�:rG rU rG rG rH � is_valid_ipv6� r z3convert_smartos_network_data.<locals>.is_valid_ipv6N)r� �gw)�ipv4�ipv6c 3 �( � | ]\}}|� d v r||fV qdS )rP NrG �r� r �v�� valid_keysrG rH � <genexpr>� � � �z/convert_smartos_network_data.<locals>.<genexpr>rP � interface)rF r� �macrB �ips�dhcprF �dhcp4c 3 r] )rQ NrG r^ r` rG rH rb � rc �static)rF rG r[ r\ �primaryFrZ c s g | ] }� � d |�r|�qS )r� rG )r� rZ )�pgws�protorG rH r� � s ��z0convert_smartos_network_data.<locals>.<listcomp>�gatewaysr c 3 r] )rR NrG r^ r` rG rH rb � s � ���dstr rE � nameserver)rF rG �searchr� )�version�config) � isinstancer� �tuple�dictrh �updateri r� r� )r; r r r rW rY rr �nic�cfgrE �iprQ � routeentsrm rR �rcfgrG )rk rl ra rH r� F s� ����� � ��� � � �� r� c C s t �| t�S r� )r �list_from_depends� datasources)�dependsrG rG rH �get_datasource_list� s r �__main__z Do not appear to be on smartos.r� r� c C s� ||v r|| S |t v rt | }| �|�||< || S |dkr@dD ]}t| ||� q!t|d |d |d |d d�||< || S |tv rKt| \}}n|d}}| j||d �||< || S ) Nr� )r r r r r r r r r� Fr[ )rj rk �load_keyr� rg ri )�clientr� r^ �keyname�depkeyr\ rG rG rH r� � s* � � � r� r^ )r� r� r^ T)r z: )�indent� sort_keys� separators)NFr4 r� )NNNN)Dr� r� r� r r� r= r� r� r� r � cloudinitr r �loggingr r r �cloudinit.eventr r � getLoggerr� rT rg rj r r� �DS_NAMEr8 r$ �METADATA_SOCKFILEr} �SERIAL_TIMEOUTr9 r� ro rm r3 r0 � Exceptionr� r� r� r� r r rO r3 rn rN r� �DEP_FILESYSTEMr} r �sys�jmc�print�exitr� �argvr� r! r� r^ ru �__annotations__r� �dumpsrG rG rG rH �<module> s� �� � �� �� G 3DY � � 3 � !� ��� � __pycache__/DataSourceOracle.cpython-310.pyc 0000644 00000026336 15027667240 0014660 0 ustar 00 o �Ad�: � @ s� d Z ddlZddlZddlmZ ddlmZmZ ddlm Z ddlm Z ddlm Z m Z mZ ddlmZ dd lmZmZmZmZ dd lmZmZ e �e�Zd d iZ d Z dZ e d Z dZ ddiZ!edd�Z"G dd� dej#�Z$deddfdd�Z%G dd � d e j&�Z'dee( fd d �Z)de*fd d �Z+d1d"e,d#e(d$e,de-fd%d&�Z.d d'�d(e*de"fd)d*�Z/e'e j0ffgZ1d+d,� Z2ed-kr�ddl3Z3d.Z4e3j5e4d/�Z6e6�7� e8e�9e/� e+� d0��� dS dS )2a3 Datasource for Oracle (OCI/Oracle Cloud Infrastructure) Notes: * This datasource does not support OCI Classic. OCI Classic provides an EC2 lookalike metadata service. * The UUID provided in DMI data is not the same as the meta-data provided instance-id, but has an equivalent lifespan. * We do need to support upgrade from an instance that cloud-init identified as OpenStack. * Bare metal instances use iSCSI root, virtual machine instances do not. * Both bare metal and virtual machine instances provide a chassis-asset-tag of OracleCloud.com. � N)� namedtuple)�Optional�Tuple)�dmi)�log)�net�sources�util)� NetworkConfig)�cmdline� ephemeral�get_interfaces_by_mac�is_netfail_master)�UrlError�readurl�configure_secondary_nicsFzOracleCloud.comz&http://169.254.169.254/opc/v{version}/z{path}/i(# � Authorizationz Bearer Oracle� OpcMetadataz version instance_data vnics_datac @ s e Zd ZdZdefdd�ZdS )� KlibcOracleNetworkConfigSourcez�Override super class to lower the applicability conditions. If any `/run/net-*.cfg` files exist, then it is applicable. Even if `/run/initramfs/open-iscsi.interface` does not exist. �returnc C s t | j�S )zOverride is_applicable)�bool�_files��self� r �D/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceOracle.py� is_applicable9 � z,KlibcOracleNetworkConfigSource.is_applicableN)�__name__� __module__� __qualname__�__doc__r r r r r r r 2 s r �network_configr c C s d| vrdS | d dvrt �d| d � dS t� }| d dkrJdd� | d D �D ] }|d d krGd |v rG|d }|�|�}|s@q(t|�rG|d = q(dS | d d kr�| �d i ��� D ]/\}}d|v r�|�di ��d�}|r�|�|�}|ssqXt|�r�|d d= |d= ||d d< qXdS dS )aP Search network config physical interfaces to see if any of them are a netfailover master. If found, we prevent matching by MAC as the other failover devices have the same MAC but need to be ignored. Note: we rely on cloudinit.net changes which prevent netfailover devices from being present in the provided network config. For more details about netfailover devices, refer to cloudinit.net module. :param network_config A v1 or v2 network config dict with the primary NIC, and possibly secondary nic configured. This dict will be mutated. �versionN)� � z+Ignoring unknown network config version: %sr$ c S s g | ]}d |v r|�qS )�typer )�.0�cr r r � <listcomp>Z s z,_ensure_netfailover_safe.<locals>.<listcomp>�configr& �physical� mac_addressr% � ethernets�match� macaddresszset-name�name)�LOG�debugr �getr �items)r" � mac_to_name�cfg�mac�cur_name�_�macaddrr r r �_ensure_netfailover_safe> sH � �� ��r; c s� e Zd ZU dZdZdZejjejj ejj ejj fZ e ejdf ed< g dd�Zeed< � fdd �Zd efd d �Zd efd d�Zdd� Zd efdd�Zdd� Zd efdd�Zd efdd�Zedd� �Zd d efd d �Z � Z S ) �DataSourceOracle�OracleN.�network_config_sourcesr$ )r* r# �_network_configc sP t t| �j|g|�R i |�� d | _t�t�|d| jgi �tg�| _ t � | _ d S )N� datasource) �superr< �__init__� _vnics_datar � mergemanydict�get_cfg_by_path�dsname�BUILTIN_DS_CONFIG�ds_cfgr �_network_config_source)r �sys_cfg�args�kwargs�� __class__r r rB � s �� zDataSourceOracle.__init__r c C s t | j�dg ��S )Nr* )r r? r3 r r r r �_has_network_config� � z$DataSourceOracle._has_network_configc C s t � S )z@Check platform environment to report if this datasource may run.)�_is_platform_viabler r r r rQ � s z$DataSourceOracle._is_platform_viablec C s | � � sdS t� | _tjt�� tjddd�t d�| j � � d�}| � � }| j �dtd �}|� t|p4|d�}W d � n1 sAw Y |j }| _tj|jd �| _|j| _|d |d d |d |d d�| _d|v r�|d �d�}|r|t�|�| _|d �d�| jd< dS )NFr% �instance�r# �path)�url�headers)�iface�connectivity_url_data�tmp_dirr ��fetch_vnics_data)r# � ociAdName�idr �hostname� displayName)zavailability-zonez instance-idz launch-indexzlocal-hostnamer0 �metadata� user_data�ssh_authorized_keys� public_keysT) rQ �_read_system_uuid� system_uuidr �EphemeralDHCPv4r �find_fallback_nic�METADATA_PATTERN�format� V2_HEADERS�distro�get_tmp_exec_path�_is_iscsi_rootrH r3 rG �read_opc_metadata� instance_data�_crawled_metadata� METADATA_ROOTr# �metadata_address� vnics_datarC r` �base64� b64decode� userdata_raw)r �network_context�fetch_primary_nic�fetch_secondary_nics�fetched_metadata�datara r r r � _get_data� sN �� �� � �� �zDataSourceOracle._get_datac C s t �| j�S )z�quickly check (local only) if self.instance_id is still valid On Oracle, the dmi-provided system uuid differs from the instance-id but has the same life-span.)r � instance_id_matches_system_uuidre )r rJ r r r �check_instance_id� s z"DataSourceOracle.check_instance_idc C s t �| j�d��S )Nrc )r �normalize_pubkey_datar` r3 r r r r �get_public_ssh_keys� rP z$DataSourceOracle.get_public_ssh_keysc C � | j �� S )z)Return whether we are on a iscsi machine.)rI r r r r r rm � r z DataSourceOracle._is_iscsi_rootc C r� �N)rI � render_configr r r r �_get_iscsi_config� s z"DataSourceOracle._get_iscsi_configc C s� | � � r| jS d}| �� r| �� | _| � � s t�d� d}| j�dtd �}|s*|rAz| � |� W n t y@ t � td� Y nw t | j� | jS )z�Network config is read from initramfs provided files Priority for primary network_config selection: - iscsi - imds If none is present, then we fall back to fallback configuration. FzLCould not obtain network configuration from initramfs. Falling back to IMDS.Tr z+Failed to parse IMDS network configuration!)rO r? rm r� r1 �warningrH r3 rG �!_add_network_config_from_opc_imds� Exceptionr �logexcr; )r � set_primary� set_secondaryr r r r" � s2 �� �� z DataSourceOracle.network_configFr� c C sV | j du r t�d� dS |s d| j d v r t�d� dS t� }|r$| j n| j dd� }t|�D ]y\}}|o8|dk}|d �� }||vrJt�d|� q/|| }t�|d �} | jd dkr�|rcd d i} n d |d � d| j � �d�} |d|t | gd�} | jd � | � q/| jd dkr�t d|id|d�} |s�|d � d| j � �g| d< | | jd |< q/dS )a� Generate primary and/or secondary NIC config from IMDS and merge it. It will mutate the network config to include the secondary VNICs. :param set_primary: If True set primary interface. :raises: Exceptions are not handled within this function. Likely exceptions are KeyError/IndexError (if the IMDS returns valid JSON with unexpected contents). Nz#NIC data is UNSET but should not be�nicIndexr z\VNIC metadata indicates this is a bare metal machine; skipping secondary VNIC configuration.r$ �macAddrz)Interface with MAC %s not found; skipping�subnetCidrBlockr# r& �dhcp�static� privateIp�/)r& �addressr+ )r0 r& r, �mtu�subnetsr* r% r/ F)r� r. �dhcp6�dhcp4� addressesr- ) rC r1 r� r � enumerate�lower� ipaddress� ip_networkr? � prefixlen�MTU�append) r r� �interfaces_by_macrs �index� vnic_dict� is_primaryr, r0 �network�subnet�interface_configr r r r� s\ � � ������z2DataSourceOracle._add_network_config_from_opc_imds)F) r r r rF re �vendordata_purer �NetworkConfigSource�CMD_LINE�DS� INITRAMFS� SYSTEM_CFGr> r �__annotations__r? �dictrB r rO rQ r| r~ r� rm r� �propertyr" r� � __classcell__r r rM r r< r s* � 0 -r< c C s t �d�} | d u r d S | �� S )Nz system-uuid)r � read_dmi_datar� )�sys_uuidr r r rd Q s rd c C s t �d�} | tkS )Nzchassis-asset-tag)r r� �CHASSIS_ASSET_TAG)� asset_tagr r r rQ V s rQ r% �metadata_versionrT �retriesc C s* t tj| |d�| dkr tnd |d�j�� S )NrS r$ )rU rV r� )r rh ri rj � _response�json)r� rT r� r r r �_fetch[ s ��r� rZ r[ c C s| d}zt |dd�}W n ty d}t |dd�}Y nw d}| r8zt |dd�}W n ty7 t�td� Y nw t|||�S )aC Fetch metadata from the /opc/ routes. :return: A namedtuple containing: The metadata version as an integer The JSON-decoded value of the instance data endpoint on the IMDS The JSON-decoded value of the vnics data endpoint if `fetch_vnics_data` is True, else None r% rR )rT r$ N�vnicsz+Failed to fetch IMDS network configuration!)r� r r r� r1 r )r[ r� ro rs r r r rn c s � � rn c C s t �| t�S r� )r �list_from_depends� datasources)�dependsr r r �get_datasource_list� s r� �__main__z� Query Oracle Cloud metadata and emit a JSON object with two keys: `read_opc_metadata` and `_is_platform_viable`. The values of each are the return values of the corresponding functions defined in DataSourceOracle.py.)� description)rn rQ )r% ):r! rt r� � collectionsr �typingr r � cloudinitr r �loggingr r r � cloudinit.distros.networkingr � cloudinit.netr r r r �cloudinit.url_helperr r � getLoggerr r1 rG r� rq rh r� rj r �KlibcNetworkConfigSourcer r; � DataSourcer< �strrd r rQ �intr� r� rn �DEP_FILESYSTEMr� r� �argparser� �ArgumentParser�parser� parse_args�print� json_dumpsr r r r �<module> sX � 4 ` � ���� __pycache__/DataSourceExoscale.cpython-310.pyc 0000644 00000014133 15027667240 0015206 0 ustar 00 o �Ad�# � @ sh d dl mZmZ d dl mZ d dl mZmZmZ d dlm Z e� e �Z dZ dZdZdZd Zd ZG d d � d ej�ZeejejffgZd d� Ze eeeefdd�Ze eeeefdd�Ze dkr�d dlZej dd�Z e j ddde d� e j dd d ed� e j d d e d ed!� e j d"d e d#ed!� e j d$d%e d&ed!� e � � Z!ee!j"e!j#e!j$e!j%e!j&d'�Z'e(e�)e'�� dS dS )(� )�dmi�helpers)�log)�sources� url_helper�util)�ec2zhttp://169.254.169.254z1.0i� � � �Exoscalec sT e Zd ZdZdZ� fdd�Zdd� Zdd� Zd d � Zd d � Z d d� Z dd� Z � Z S )�DataSourceExoscaler �x c s| t t| ��|||� t�d� | j�dt�| _| j�dt �| _ t | j�dt ��| _ | j�dt�| _| j�dt�| _i | _d S )Nz$Initializing the Exoscale datasource� metadata_url� api_version�password_server_port�timeout�retries)�superr �__init__�LOG�debug�ds_cfg�get� METADATA_URLr � API_VERSIONr �int�PASSWORD_SERVER_PORTr � URL_TIMEOUT� url_timeout� URL_RETRIES� url_retries� extra_config)�self�sys_cfg�distro�paths�� __class__� �F/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceExoscale.pyr s � zDataSourceExoscale.__init__c C s< d}| j �d�}t�|�}|�d| d�r t�d� dS dS )z<Adjust set-passwords module to run 'always' during each boot� set_passwords�sem�config_Nz5Overriding module set-passwords with frequency always)r% � get_ipath_curr �FileSemaphores�clearr r )r" �cfg�is_new_instance�mod�sem_path� sem_helperr( r( r) �activate* s �zDataSourceExoscale.activatec C s6 d� | j| j�}tj|g| j| jtjd�\}}t |�S )z.Wait for the metadata service to be reachable.z{}/{}/meta-data/instance-id)�urls�max_waitr � status_cb) �formatr r r � wait_for_url� url_max_waitr r �critical�bool)r" r �url� _responser( r( r) �wait_for_metadata_service9 s � �z,DataSourceExoscale.wait_for_metadata_servicec C s6 t jtjd| jd�}|si S t| j| j| j| j | j �S )zw Crawl the metadata service when available. @returns: Dictionary of crawled metadata content. z waiting for the metadata service��logfunc�msg�func) r �log_timer �infor@ � read_metadatar r r r r )r" �metadata_readyr( r( r) �crawl_metadataI s ��z!DataSourceExoscale.crawl_metadatac C st | � � sdS tjtjd| jd�}|sdS |d | _|d | _|�d�}i }|r/d|ddid �}t� | j |g�| _ dS ) z�Fetch the user data, the metadata and the VM password from the metadata service. Please refer to the datasource documentation for details on how the metadata server and password server are crawled. FzCrawl of metadata servicerA � user-data� meta-data�passwordT�expire)� ssh_pwauthrL �chpasswd) �_is_platform_viabler rE r r rI � userdata_raw�metadatar � mergemanydictr! )r" �datarL �password_configr( r( r) � _get_data` s. � �� �z DataSourceExoscale._get_datac C s | j S �N)r! �r" r( r( r) �get_config_obj� s z!DataSourceExoscale.get_config_objc C s t �d��t�S )Nzsystem-product-name)r � read_dmi_data� startswith�EXOSCALE_DMI_NAMErX r( r( r) rP � s �z&DataSourceExoscale._is_platform_viable) �__name__� __module__� __qualname__�dsnamer; r r5 r@ rI rV rY rP � __classcell__r( r( r& r) r s .r c C s t �| t�S rW )r �list_from_depends� datasources)�dependsr( r( r) �get_datasource_list� s re c C sZ d� | ||�}tj|dddi||d�}|j�d�}|dv r dS tj|dddi||d� |S ) z�Obtain the VM's password if set. Once fetched the password is marked saved. Future calls to this method may return empty string or 'saved_password'.z {}:{}/{}/N� DomU_Request�send_my_password)� ssl_details�headersr r zutf-8)� �saved_passwordrk )r9 r �read_file_or_url�contents�decode)r r r r r � password_url�responserL r( r( r) � get_password� s* �� �rq c C s� i }||d< zt j|| ||d�|d< t j|| ||d�|d< W n ty: } zt�td| |� i W Y d}~S d}~ww zt|| |||d�|d< W |S tye } zt�td | ||� W Y d}~|S d}~ww ) z8Query the metadata server and return the retrieved data.�_metadata_api_version)r r rJ rK z(failed reading from metadata url %s (%s)N)r r r r r rL z2failed to read from password server url %s:%s (%s))r �get_instance_userdata�get_instance_metadata� Exceptionr �logexcr rq )r r r r r �crawled_metadata�er( r( r) rG � sH ����� �����rG �__main__NzQuery Exoscale Metadata)� descriptionz --endpoint�URLz The url of the metadata service.)�metavar�help�defaultz --version�VERSIONz.The version of the metadata endpoint to query.z --retries�NUMz,The number of retries querying the endpoint.)r| �typer} r~ z --timeoutz.The time in seconds to wait before timing out.z--password-port�PORTz/The port on which the password endpoint listens)r r r r r )*� cloudinitr r r �loggingr r r �cloudinit.sources.helpersr � getLoggerr] r r r r r r r\ � DataSourcer �DEP_FILESYSTEM� DEP_NETWORKrc re rq rG �argparse�ArgumentParser�parser� add_argumentr � parse_args�args�endpoint�version� password_portr r rT �print� json_dumpsr( r( r( r) �<module> s� � �' �+ ������� __pycache__/DataSourceConfigDrive.cpython-310.pyc 0000644 00000020421 15027667240 0015637 0 ustar 00 o �Ad , � @ s� d dl Z d dlmZ d dlmZmZmZ d dlmZm Z d dl m Z d dl m Z d dlmZ e�e�ZdZd Zd eiZd Zd Zd Zedd� eD ��ZG dd� dejej �Z dd� Z dd� Z d dd�Z dd� Z!d dd �Z"e Z#e ej$ffgZ%d d � Z&dS )!� N)�log)�sources�subp�util)� EventScope� EventType)�eni)�get_ibm_platform)� openstackziid-dsconfigdrive�pass� instance-id)�vfat�iso9660)zconfig-2zCONFIG-2)�sr�cdc c s, � | ]}t d d�D ] }d||f V q qdS )r � z /dev/%s%sN)�range)�.0�z�i� r �I/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceConfigDrive.py� <genexpr> s �* r c sr e Zd ZdZejejejej ej hiZ � fdd�Z dd� Z dd� Zdd � Zed d � �Zed d � �Zdd� Z� ZS )�DataSourceConfigDrive� ConfigDrivec s\ t t| ��|||� d | _tj�|jd�| _d | _d | _ d | _ t j | _ d | _d | _i | _d S )N� config_drive)�superr �__init__�source�os�path�join�seed_dir�version� ec2_metadata�_network_configr �UNSET� network_json� network_eni� known_macs�files)�self�sys_cfg�distro�paths�� __class__r r r / s z DataSourceConfigDrive.__init__c C s0 t j�| �}d|| j| jf }|d| j 7 }|S )Nz%s [%s,ver=%s]z [source=%s])r � DataSource�__str__�dsmoder# r )r+ �root�mstrr r r r2 ; s z DataSourceConfigDrive.__str__c C s� d }i }i }| j dfD ]#}tj�|�sq z t|�}|}W n tjy. t�t d|� Y q w |s�| j � d�}t |d�D ]C}d }t� � rK|�d�rKd}z tj|t|d�}|}W n# tjya Y n tjyj Y n tjyz t�t d|� Y nw |r nq<|s�d S |� d i �}t�|tg�}| �|� d �| j� d �|d d kr�tjnd g�| _| jtjkr�d S t| j�}|d } || kr�t || j | jtjkd� | jtjkr�t � d| | j� d S || _ || _ |� d�| _!|� d�| _"|d | _#| j$�%|� di �� |� d�} | | _&zt�'| �| _(W n t)�y( } zt �*d| � d | _(W Y d } ~ nd } ~ ww |� d�} | | _+zt�'| �| _,W n t)�yU } zt �*d| � d | _,W Y d } ~ nd } ~ ww |� d�| _-|� d�| _.dS )Nz /config-drivez#Failed reading config drive from %s�datasource_list)�dslistz/dev/cd�cd9660)�mtypezBroken config drive: %sF�metadatar3 r# � r )r- �networkz&%s: not claiming datasource, dsmode=%sz ec2-metadata�userdatar* � vendordataz"Invalid content in vendor-data: %s� vendordata2z#Invalid content in vendor-data2: %s�network_config� networkdataT)/r" r r �isdir�read_config_driver � NonReadabler �logexc�LOGr, �get�find_candidate_devs�is_BSD� startswith�mount_cb�MountFailedError�BrokenMetadata� mergemanydict�DEFAULT_METADATA�_determine_dsmode�ds_cfgr � DSMODE_PASSr3 �DSMODE_DISABLED�get_previous_iidr. � on_first_bootr- �debugr r: r$ � userdata_rawr# r* �update�vendordata_pure�convert_vendordata�vendordata_raw� ValueError�warning�vendordata2_pure�vendordata2_rawr( r' ) r+ �found�md�results�sdirr7 �devr9 �prev_iid�cur_iid�vd�e�vd2r r r � _get_dataA s� � ��� �� � � �� �� z DataSourceConfigDrive._get_datac C s t �| �� �S �N)r � instance_id_matches_system_uuid�get_instance_id)r+ r, r r r �check_instance_id� s z'DataSourceConfigDrive.check_instance_idc C sv | j d u r8| jd tjfvr t�d� tj| j| jd�| _ | j S | j d ur3t � | j �| _ t�d� | j S t�d� | j S )Nz(network config provided via network_json)r) z.network config provided via converted eni dataz"no network configuration available) r% r' r r& rF rV r �convert_net_jsonr) r( r �convert_eni_data�r+ r r r r@ � s � � �z$DataSourceConfigDrive.network_configc C s dS )Nr r rq r r r �platform� s z DataSourceConfigDrive.platformc C s$ | j �d�r d}nd}d|| j f S )z/Return the subplatform metadata source details.z/devz config-diskzseed-dirz%s (%s))r rJ )r+ �subplatform_typer r r �_get_subplatform� s z&DataSourceConfigDrive._get_subplatform)�__name__� __module__� __qualname__�dsnamer �NETWORKr �BOOT_NEW_INSTANCE�BOOT� BOOT_LEGACY�HOTPLUG�supported_update_eventsr r2 rj rn �propertyr@ rr rt � __classcell__r r r/ r r " s$ �� f r c C s� t �| �}|jg i f|jg i fg}g }|D ]'\}}}z ||i |��W S t jy< } z |�|� W Y d }~qd }~ww |d �)N���)r �ConfigDriveReader�read_v2�read_v1rD �append)� source_dir�reader�finders�excps�functor�args�kwargsrh r r r rC � s ���rC c C s< t j�| �d�d�}z t�|��d�W S ty Y d S w )N�datar � )r r r! � get_cpathr � load_file�rstrip�IOError)r. �fnamer r r rT � s �rT Tc C s^ t | t�s tdt| � ��|r&| �dd�}|r&|r&t�d� |�t� |�� t | �d�� dS )zDPerforms any first-boot actions using data read from a config-drive.z/Config-drive data expected to be a dict; not %sr@ � z-Updating network interfaces from config driver* N) � isinstance�dict� TypeError�typerG rF r] �apply_network_configr rp �write_injected_files)r� r- r< �net_confr r r rU � s � rU c C sx | r8t �dt| �� | �� D ]+\}}|�tj�s tj| }z tj||dd� W q t y7 t� t d|� Y qw d S d S )NzWriting %s injected filesi� )�modezFailed writing file: %s) rF rV �len�itemsrJ r �sepr � write_filer� rE )r* �filename�contentr r r r� � s ��r� c s |du rg }| r t D ]}ztj|d� W q tjy Y q w g }tD ] }|�t�d| �� q#g � tD ] }� �t�d| �� q4|jdd� � jdd� � � fdd�|D � }� fd d�|D �}t � d ||� |r�d |v r�t � \}} | |v r�|� | � t � d | |� |S ) a Return a list of devices that may contain the config drive. The returned list is sorted by search order where the first item has should be searched first (highest priority) config drive v1: Per documentation, this is "associated as the last available disk on the instance", and should be VFAT. Currently, we do not restrict search list to "last available disk" config drive v2: Disk should be: * either vfat or iso9660 formatted * labeled with 'config-2' or 'CONFIG-2' N)r zTYPE=%szLABEL=%sT)�reversec s g | ]}|� vr|�qS r r �r �d��by_labelr r � <listcomp>% s z'find_candidate_devs.<locals>.<listcomp>c s" g | ] }|� v s t �|�s|�qS r )r � is_partitionr� r� r r r� ) s zdevices=%s dslist=%s�IBMCloudz5IBMCloud device '%s' (%s) removed from candidate list) �OPTICAL_DEVICESr �find_devs_withr �ProcessExecutionError�FS_TYPES�extend� LABEL_TYPES�sortrF rV r �remove) � probe_opticalr7 �device� by_fstype�fs_type�label� candidates�devices� ibm_platform�ibm_pathr r� r rH � s@ � � �rH c C s t �| t�S rk )r �list_from_depends� datasources)�dependsr r r �get_datasource_listF s r� )NT)TN)'r � cloudinitr �loggingr r r �cloudinit.eventr r � cloudinit.netr �$cloudinit.sources.DataSourceIBMCloudr �cloudinit.sources.helpersr � getLoggerru rF � DEFAULT_IID� DEFAULT_MODErO r� r� �POSSIBLE_MOUNTS�tupler� � SourceMixinr1 r rC rT rU r� rH �DataSourceConfigDriveNet�DEP_FILESYSTEMr� r� r r r r �<module> s: � � & B � __pycache__/DataSourceEc2.cpython-310.pyc 0000644 00000057415 15027667240 0014066 0 ustar 00 o �Ad � � @ s� d dl Z d dlZd dlZd dlmZ d dlmZ d dlmZ d dlm Z m Z d dlm Z d dlm Z mZ d dlmZmZ d d lmZ d d lmZ d d lmZ e�e�Zee j g�Z d Z d Z G dd� d�Z dd� Z!e j"e j#gZ$G dd� de j%�Z&G dd� de&�Z'dd� Z(dd� Z)dd� Z*d d � Z+d d � Z,d d!� Z-d"d#� Z.d$d%� Z/d&d'� Z0d(d)� Z1d*d+� Z2 ,d5d-d.�Z3d/d0� Z4d1d2� Z5e'e j6ffe&e j6e j7ffgZ8d3d4� Z9dS )6� N)�List)�dmi)�log)�net�sources)� url_helper)�util�warnings)� EventScope� EventType)�NoDHCPLeaseError)�EphemeralIPNetwork)�ec2)� datasource�Ec2� strict_id�warnc @ s, e Zd ZdZdZdZdZdZdZdZ dZ d S ) � CloudNames�aliyun�aws� brightbox�zstack�e24cloud�outscale�unknownzno-ec2-metadataN) �__name__� __module__� __qualname__�ALIYUN�AWS� BRIGHTBOX�ZSTACK�E24CLOUD�OUTSCALE�UNKNOWN�NO_EC2_METADATA� r& r& �A/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceEc2.pyr " s r c C s | j dko d| jv S )N� zmeta-data/tags/)�code�url)� exceptionr& r& r' �skip_404_tag_errors2 s r, c sx e Zd ZU dZg d�ZdZg d�Zee e d< dZ dZ dZ e jZd ZejejejejejhiZ� fd d �Zd d � Zdd� Zdd� Z e dd� �Z e dd� �Z e dd� �Z e dd� �Z!e dd� �Z"e d d � �Z#e d d � �Z$d d!� Z%d"d#� Z&d$d%� Z'd&d'� Z(d(d)� Z)e d*d+� �Z*e d,d-� �Z+d.d/� Z,e d0d1� �Z-e � fd2d3��Z.d4d5� Z/dAd6d7�Z0d8d9� Z1d:d;� Z2dAd<d=�Z3dBd?d@�Z4� Z5S )C� DataSourceEc2r )zhttp://169.254.169.254zhttp://[fd00:ec2::254]zhttp://instance-data.:8773z 2009-04-04)z 2021-03-23z 2018-09-24z 2016-09-02�extended_metadata_versions�x �2 NFc s t t| ��|||� d | _d S �N)�superr- �__init__�metadata_address)�self�sys_cfg�distro�paths�� __class__r& r' r3 e s zDataSourceEc2.__init__c C s t � S )z5Return the cloud name as identified during _get_data.)�identify_platform�r5 r& r& r' �_get_cloud_namei s z DataSourceEc2._get_cloud_namec C sZ t t�| jtt�d�\}}t�d|| j| j � |dkr#| jt j kr#dS | jt j kr+dS | j r{t�� r9t�d� dS z7t| jdd| j�� d��!}|jrPd|j� �nd }tjtjd |� �| jd �| _W d � n1 sjw Y W n tyz Y dS w tjtjd | jd �| _| js�dS | j�d d �| _| j�d d �| _| j�di ��di ��di �| _dS )N)r Nz0strict_mode: %s, cloud_name=%s cloud_platform=%s�trueFz1FreeBSD doesn't support running dhclient with -sfT)�ipv4�ipv6�tmp_dir� � zCrawl of metadata service��logfunc�msg�func� meta-data� user-data�dynamic�instance-identity�document) �read_strict_moder �get_cfg_by_pathr6 �STRICT_ID_PATH�STRICT_ID_DEFAULT�LOG�debug� cloud_name�platformr r$ r% �perform_dhcp_setup� is_FreeBSDr �fallback_interfacer7 �get_tmp_exec_path� state_msg�log_time�crawl_metadata�_crawled_metadatar �get�metadata� userdata_raw�identity)r5 � strict_mode�_sleep�netwrY r& r& r' � _get_datam sj ��� � � �� �� �zDataSourceEc2._get_datac C sL | j sdS | j �di ��di �}|�di ��� D ] \}}d|v r# dS qdS )z6Report if this instance type is Ec2 Classic (non-vpc).F�network� interfaces�macszvpc-idT)r^ r] �items)r5 � ifaces_md�_mac�mac_datar& r& r' �is_classic_instance� s �z!DataSourceEc2.is_classic_instancec C s | j sd S | j �d�S )Nzami-launch-index)r^ r] r< r& r& r' � launch_index� s zDataSourceEc2.launch_indexc C s. t | d�s tj�� | _| jstj�� | _| jS )N�_platform_type)�hasattrr- �dsname�lowerrn r< r& r& r' rT � s zDataSourceEc2.platformc C � dS )Nzlatest/api/tokenr& r< r& r& r' �api_token_route� � z DataSourceEc2.api_token_routec C rr )N�21600r& r< r& r& r' �imdsv2_token_ttl_seconds� rt z&DataSourceEc2.imdsv2_token_ttl_secondsc C rr )NzX-aws-ec2-metadata-tokenr& r< r& r& r' �imdsv2_token_put_header� rt z%DataSourceEc2.imdsv2_token_put_headerc C s | j d S )Nz -ttl-seconds)rw r< r& r& r' �imdsv2_token_req_header� s z%DataSourceEc2.imdsv2_token_req_headerc C s | j | jgS r1 )rw rx r< r& r& r' �imdsv2_token_redact� s z!DataSourceEc2.imdsv2_token_redactc C s� d}| � � }| jD ]M}|�| j|�}z tj||| jd�}W n tjy7 } z t� d||� W Y d}~q d}~ww |j dkrGt� d|� | S |j dkrVd}t� |||j � q | j S ) aE Get the best supported api version from the metadata service. Loop through all extended support metadata versions in order and return the most-fully featured metadata api version discovered. If extended_metadata_versions aren't present, return the datasource's min_metadata_version. z {0}/{1}/meta-data/instance-id)r* �headers�headers_redactzurl %s raised exception %sN�� z#Found preferred metadata version %sr( z0Metadata api version %s not present. Headers: %s) � _get_headersr. �formatr4 �uhelp�readurlry �UrlErrorrQ rR r) rz �min_metadata_version)r5 �url_tmplrz �api_verr* �resp�erF r& r& r' �get_metadata_api_version� s, ��� �z&DataSourceEc2.get_metadata_api_versionc C sd | j tjkr-t| dd �s#| �� }tj|| j| j| j | j d�� di �| _ | j � d| j d �S | j d S )Nr` �� headers_cbr{ � exception_cbrL � instanceIdz instance-id)rS r r �getattrr� r �get_instance_identityr4 r} ry �_refresh_stale_aws_token_cbr] r` r^ )r5 � api_versionr& r& r' �get_instance_id� s �� � z DataSourceEc2.get_instance_idc C s� | j tvrdS g }i }| j}d}|D ]}d�||�}|�|� |||< qt�d� d}d}| �� } ztj || j | j tj | j | j|| jdd� \}}W n tjyS Y nw |r_|r_|| _|| S dS )a Get an API token for EC2 Instance Metadata Service. On EC2. IMDS will always answer an API token, unless the instance owner has disabled the IMDS HTTP endpoint or the network topology conflicts with the configured hop-limit. N�PUT�{0}/{1}z Fetching Ec2 IMDSv2 API TokenF) �urls�max_wait�timeout� status_cbr� r� �request_methodr{ �connect_synchronously)rS � IDMSV2_SUPPORTED_CLOUD_PLATFORMSrs r~ �appendrQ rR �get_url_paramsr � wait_for_url�max_wait_seconds�timeout_seconds�warningr} �_imds_exception_cbry r� � _api_token) r5 �mdurlsr� �url2base�url_pathr� r* �cur�response� url_paramsr& r& r' �_maybe_fetch_api_token sB � �z$DataSourceEc2._maybe_fetch_api_tokenc C st | j }| �� }|jdkrdS |�d| j�}dd� |D �}t|�t|�kr2t�dtt|�t|� �� t |�r9|}nt� d� | j}| � |�}|s�| j t vr�g }i }dj| jd �}d } |D ]} d �| |�} |�| � | || < q\t�� } tj||j|jtj | j| j| d �\} } | r�|| }|r�|| _t�d | j� t|�S | j t v r�t� d� t|�S t�d|tt�� | �� t|�S )Nr F� metadata_urlsc S s g | ] }t �|�r|�qS r& )r �is_resolvable_url)�.0�xr& r& r' � <listcomp>D s z;DataSourceEc2.wait_for_metadata_service.<locals>.<listcomp>z,Removed the following from metadata urls: %sz+Empty metadata url list! using default listz{ver}/meta-data/instance-id)�ver�GETr� )r� r� r� r� r{ r� r� zUsing metadata source: '%s'z)IMDS's HTTP endpoint is probably disabledz(Giving up on md from %s after %s seconds)�ds_cfgr� r� r] r� �setrQ rR �list�lenr� r� rS r� r~ r� r� �timer r� r� ry r} r4 �critical�int�bool)r5 �mcfgr� r� �filteredr4 r� r� r� r� r* r� � start_time�_r& r& r' �wait_for_metadata_service; sl � � � � � ��z'DataSourceEc2.wait_for_metadata_servicec C s� d| j vrd S d }| j d }t|t�st�d|� d S |�� D ]\}}||kr+|} n |dkr5|dkr5|}q |d u rBt�d|� d S |}|�d�sMd| }tj� |�rU|S | � tj� |��}|rit�d||� |S |dkrod S |S ) Nzblock-device-mappingz+block-device-mapping not a dictionary: '%s'� ephemeral� ephemeral0z Unable to convert %s to a device�/z/dev/%sz Remapped device name %s => %s) r^ � isinstance�dictrQ rR rh � startswith�os�path�exists� _remap_device�basename)r5 �name�found�bdm�entname�device�ofound�remappedr& r& r' �device_name_to_device� s: � z#DataSourceEc2.device_name_to_devicec C sL z| j tjkr| j�d| jd d �W S | jd d W S ty% Y d S w )N�availabilityZone� placementzavailability-zone)rS r r r` r] r^ �KeyErrorr< r& r& r' �availability_zone� s � �z DataSourceEc2.availability_zonec C sR | j tjkr| j�d�}| jr|s| jd d� }|S | j}|d ur'|d d� S d S )N�region���)rS r r r` r] r� )r5 r� �azr& r& r' r� � s zDataSourceEc2.regionc C s0 |sd S | j tjkrtt�|tt�|� d S d S r1 )rS r r$ �warn_if_necessaryr rN rO rP )r5 �cfg�is_new_instancer& r& r' �activate� s ��zDataSourceEc2.activatec C s� | j tjkr | j S | jdu rt�d� dS d}td| jvo"| jtj k�}|r5t� d� t j tj d| j d� | j}| j�d�}t|t�rpt||t �| jdd�d �}| �� rot�| j�| _| jtj �t j � | jtj �t j � nt�d |� || _ | j S ) z@Return a network config dict for rendering ENI or netplan files.Nz8Unexpected call to network_config when metadata is None.re zPMetadata 'network' not present: Refreshing stale metadata from prior to upgrade.z Re-crawl of metadata servicerD � apply_full_imds_network_configT)� fallback_nic�full_network_configz%Metadata 'network' key not valid: %s.) �_network_configr �UNSETr^ rQ r� r� rS r r rR r rZ �get_datarW r] r� r� �#convert_ec2_metadata_network_config�get_cfg_option_boolr� rl �copy�deepcopy�default_update_eventsr �NETWORK�addr �BOOT� BOOT_LEGACY)r5 �result�no_network_metadata_on_aws�iface�net_mdr& r& r' �network_config� sZ � ��� �� � � �� z DataSourceEc2.network_configc s> | j d u r t| dd �}|r|| _ d | _| j S tt| �jS | j S )Nr� )�_fallback_interfacer� r� r2 r- rW )r5 � _legacy_fbnicr9 r& r' rW s �z DataSourceEc2.fallback_interfacec C s | � � si S | �� }| j}i }| jtv r | j}| j}d}n| jtjkr*d }}t }nd } }}z7t j || j | j ||d�|d< t j|| j | j |||d�|d< | jtjkrft j|| j | j ||d�}d|i|d< W n tyz t�td| j � i Y S w ||d < |S ) z�Crawl metadata service when available. @returns: Dictionary of crawled metadata content containing the keys: meta-data, user-data and dynamic. Nr� rI )r� r{ r� � retrieval_exception_ignore_cbrH rK rJ z'Failed reading from metadata address %s�_metadata_api_version)r� r� ry rS r� r� �#_skip_or_refresh_stale_aws_token_cbr r# r, r �get_instance_userdatar4 r} �get_instance_metadatar r� � Exceptionr �logexcrQ )r5 r� �redact�crawled_metadata�exc_cb� exc_cb_ud�skip_cbr` r& r& r' r[ % sb � � � � ��z DataSourceEc2.crawl_metadatac C s� | j tvrdS |du r| j}t�d� | j|i}d�| j| j�}zt j ||| j dd�}W |jS t j yI } zt� d||� W Y d}~dS d}~ww )z�Request new metadata API token. @param seconds: The lifetime of the token in seconds @return: The API token or None if unavailable. Nz!Refreshing Ec2 metadata API tokenz{}/{}r� )rz r{ r� z/Unable to get API token: %s raised exception %s)rS r� rv rQ rR rx r~ r4 rs r r� ry r� r� �contents)r5 �seconds�request_header� token_urlr� r� r& r& r' �_refresh_api_token\ s, � ����z DataSourceEc2._refresh_api_tokenc C s$ t �t j||�}|s dS | �||�S )zSCallback will not retry on SKIP_USERDATA_CODES or if no token is available.F)r �skip_retry_on_codes�SKIP_USERDATA_CODESr� )r5 rF r+ �retryr& r& r' r� y s � z1DataSourceEc2._skip_or_refresh_stale_aws_token_cbc C s* t |tj�r|jdkrt�d� d| _dS )z=Exception handler for Ec2 to refresh token if token is stale.i� z+Clearing cached Ec2 API token due to expiryNT)r� r r� r) rQ rR r� �r5 rF r+ r& r& r' r� � s z)DataSourceEc2._refresh_stale_aws_token_cbc C sN t |tj�r!|jr#|jdkr%|jdkrt�d� |�t�d� |�dS dS dS )a2 Fail quickly on proper AWS if IMDSv2 rejects API token request Guidance from Amazon is that if IMDSv2 had disabled token requests by returning a 403, or cloud-init malformed requests resulting in other 40X errors, we want the datasource detection to fail quickly without retries as those symptoms will likely not be resolved by retries. Exceptions such as requests.ConnectionError due to IMDS being temporarily unroutable or unavailable will still retry due to the callsite wait_for_url. i� i� zLEc2 IMDS endpoint returned a 403 error. HTTP endpoint is disabled. Aborting.z2Fatal error while requesting Ec2 IMDSv2 API tokensN)r� r r� r) rQ r� r r& r& r' r� � s ����z DataSourceEc2._imds_exception_cbrC c C sN | j tvri S | j| ji}| j|v r|S | js!| �� | _| js!i S | j| jiS )z�Return a dict of headers for accessing a url. If _api_token is unset on AWS, attempt to refresh the token via a PUT and then return the updated token header. )rS r� rx rv rs r� r rw )r5 r* �request_token_headerr& r& r' r} � s � zDataSourceEc2._get_headersr1 )rC )6r r r rp r� r� r. r �str�__annotations__� url_max_wait� url_timeoutr� r r� r� rU r r� r �BOOT_NEW_INSTANCEr� r� �HOTPLUG�supported_update_eventsr3 r= rd rl �propertyrm rT rs rv rw rx ry r� r� r� r� r� r� r� r� r� rW r[ r r� r� r� r} � __classcell__r& r& r9 r' r- : sn �� 8 2I3 < 7 r- c s$ e Zd ZdZdZ� fdd�Z� ZS )�DataSourceEc2Localay Datasource run at init-local which sets up network to query metadata. In init-local, no network is available. This subclass sets up minimal networking with dhclient on a viable nic so that it can talk to the metadata service. If the metadata service provides network configuration then render the network configuration for that instance based on metadata. Tc s8 t jt jf}| j|vrt�d|| j� dS tt| ��� S )Nz+Local Ec2 mode only supported on %s, not %sF) r r r# rS rQ rR r2 r r� )r5 �supported_platformsr9 r& r' r� � s �zDataSourceEc2Local.get_data)r r r �__doc__rU r� r r& r& r9 r' r � s r c C s> zt | �W S ty } z t�|� |W Y d }~S d }~ww r1 )�parse_strict_mode� ValueErrorrQ r� )�cfgval�defaultr� r& r& r' rM � s ��rM c C s� | du rdS | du r dS | sdS | � d�\}}}|dvr$td|| f ��|rEz t|�}W ||fS tyD } z td || f �|�d }~ww d }||fS ) NT)r> NF)�falseN)r r �,)r> r r zUInvalid mode '%s' in strict_id setting '%s': Expected one of 'true', 'false', 'warn'.z<Invalid sleep '%s' in strict_id setting '%s': not an integer)� partitionr r� )r �moder� �sleepr� r& r& r' r � s: �� ������r c C sd zt | �\}}W n ty } z t�|� W Y d }~d S d }~ww |dkr'd S tjd|d|d� d S )Nr � non_ec2_mdT)r r )r r rQ r� r � show_warning)r r� r r r� r& r& r' r� � s ��r� c C � | d dkr t jS d S )N� product_namezAlibaba Cloud ECS)r r ��datar& r& r' �identify_aliyun � �r" c C s4 | d � d�r| d dks| d | d krtjS d S )N�uuidr � uuid_source� hypervisor�serial)r� r r r r& r& r' � identify_aws s r( c C � | d � d�r tjS d S )Nr' z.brightbox.com)�endswithr r r r& r& r' �identify_brightbox � �r+ c C r) )N� asset_tagz .zstack.io)r* r r! r r& r& r' �identify_zstack r, r. c C r )N�vendorr )r r" r r& r& r' �identify_e24cloud$ r# r0 c C s. | d d� � kr| d d� � krtjS d S d S )Nr z3DS Outscale VMr/ z 3DS Outscale)rq r r# r r& r& r' �identify_outscale) s �r1 c C sx t � } ttttttdd� f}|D ])}z || �}|r |W S W q ty9 } zt� d|| |� W Y d }~qd }~ww d S )Nc S s t jS r1 )r r$ )r� r& r& r' �<lambda>; s z#identify_platform.<locals>.<lambda>z'calling %s with %s raised exception: %s) �_collect_platform_datar( r+ r. r0 r1 r" r� rQ r� )r! �checks�checkerr� r� r& r& r' r; 1 s, � �����r; c C s� i } z t �d��� }d| d< W n ty! t�d�}d| d< Y nw |du r(d}|�� | d< t�d �}|du r9d}|�� | d < t�d �}|du rJd}|�� | d < t�d �}|rY|nd�� | d< t�d�}|rh|nd�� | d< | S )a� Returns a dictionary of platform info from dmi or /sys/hypervisor. Keys in the dictionary are as follows: uuid: system-uuid from dmi or /sys/hypervisor uuid_source: 'hypervisor' (/sys/hypervisor/uuid) or 'dmi' serial: dmi 'system-serial-number' (/sys/.../product_serial) asset_tag: 'dmidecode -s chassis-asset-tag' vendor: dmi 'system-manufacturer' (/sys/.../sys_vendor) product_name: dmi 'system-product-name' (/sys/.../system-manufacturer) On Ec2 instances experimentation is that product_serial is upper case, and product_uuid is lower case. This returns lower case values for both. z/sys/hypervisor/uuidr& r% z system-uuidr NrC r$ zsystem-serial-numberr' zchassis-asset-tagr- zsystem-manufacturerr/ zsystem-product-namer )r � load_file�stripr� r � read_dmi_datarq )r! r$ r' r- r/ r r& r& r' r3 H s0 � r3 Tc C sz di d�}|s t �� }| d d }|sC|�� D ] \}}||kr! nqddd|�� i|d�}|�|�} | �d �r;d|d < ||d |< |S d } t|�� �D ]K\}}|�|�} | sWqKt| �d | ��d } d| d i} d| dd|�� i|d�}| �d �r�d|d < | |d< t| |�|d< |d s�|�d� ||d |< qKt |d �dkr�|d � � D ]}|d | �d� |d | �dd� q�|S )a Convert ec2 metadata to network config version 2 data dict. @param: network_md: 'network' portion of EC2 metadata. generally formed as {"interfaces": {"macs": {}} where 'macs' is a dictionary with mac address as key and contents like: {"device-number": "0", "interface-id": "...", "local-ipv4s": ...} @param: macs_to_nics: Optional dict of mac addresses and nic names. If not provided, get_interfaces_by_mac is called to get it from the OS. @param: fallback_nic: Optionally provide the primary nic interface name. This nic will be guaranteed to minimally have a dhcp4 configuration. @param: full_network_config: Boolean set True to configure all networking presented by IMDS. This includes rendering secondary IPv4 and IPv6 addresses on all NICs and rendering network config on secondary NICs. If False, only the primary nic will be configured and only with dhcp (IPv4/IPv6). @return A dict of network config version 2 based on the metadata and macs. � )�version� ethernetsrf rg TF� macaddress)�dhcp4�dhcp6�match�set-name�ipv6sr> r; r z device-number� z route-metric�d )r= �dhcp4-overridesr> r? r@ zdhcp6-overrides� addressesrD N) r �get_interfaces_by_macrh rq r] �sortedr� �get_secondary_addresses�popr� �keys) � network_md� macs_to_nicsr� r� �netcfg� macs_metadata�mac�nic_name� dev_config� nic_metadata�nic_idx� dhcp_overrider& r& r' r� w sX � � � r� c C s� | � d�}| � d�}g }tt|t�ot|�dk�r$|�t| d||d�� tt|t�o/t|�dk�r<|�t| d||d�� t|�S )z�Parse interface-specific nic metadata and return any secondary IPs :return: List of secondary IPv4 or IPv6 addresses to configure on the interface z local-ipv4srA rB zsubnet-ipv4-cidr-block�24zsubnet-ipv6-cidr-block�128)r] r� r� r� r� �extend�_get_secondary_addressesrG )rR rO �ipv4srA rE r& r& r' rH � s �� ��rH c C s� g }| � |�}|}|rt|�d��dkr'd|v rdnd}t�d|||||� n|�d�d }|dd� D ] } |�dj| |d �� q4|S ) z�Return list of IP addresses as CIDRs for secondary IPs The CIDR prefix will be default_prefix if cidr_key is absent or not parseable in nic_metadata. r� r9 r? r@ zJCould not parse %s %s for mac %s. %s network config prefix defaults to /%srB Nz {ip}/{prefix})�ip�prefix)r] r� �splitrQ r� r� r~ ) rR �cidr_keyrO �ips�default_prefixrE �cidrr[ �ip_typerZ r& r& r' rX � s" � rX c C s t �| t�S r1 )r �list_from_depends� datasources)�dependsr& r& r' �get_datasource_list� s re )NNT):r� r� r� �typingr � cloudinitr r �loggingr r r r r r �cloudinit.eventr r �cloudinit.net.dhcpr �cloudinit.net.ephemeralr �cloudinit.sources.helpersr � getLoggerr rQ � frozenset� NOT_FOUND�SKIP_METADATA_URL_CODESrO rP r r, r r r� � DataSourcer- r rM r r� r" r( r+ r. r0 r1 r; r3 r� rH rX �DEP_FILESYSTEM� DEP_NETWORKrc re r& r& r& r' �<module> s\ ! 0 �I � __pycache__/DataSourceCloudStack.cpython-310.pyc 0000644 00000016143 15027667240 0015502 0 ustar 00 o �Adj' � @ s� d dl Z d dlZd dlmZmZmZ d dlmZ d dlm Z d dlm Z m Z d dlm Z d dlmZ d dlmZ d d lmZ e �e�ZG d d � d �ZG d d � d e j�Zdd� Zdd� Zdd� Z ddd�Z dd� Z ee j e j ffgZ!dd� Z"dS )� N)�gaierror� getaddrinfo� inet_ntoa)�pack)�log)�sources�subp)� url_helper)�util)�dhcp)�ec2c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) � CloudStackPasswordServerClienta� Implements password fetching from the CloudStack password server. http://cloudstack-administration.readthedocs.org/ en/latest/templates.html#adding-password-management-to-your-templates has documentation about the system. This implementation is following that found at https://github.com/shankerbalan/cloudstack-scripts/ blob/master/cloud-set-guest-password-debian c C s || _ d S �N)�virtual_router_address)�selfr � r �H/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceCloudStack.py�__init__* � z'CloudStackPasswordServerClient.__init__c C s: t � ddddddddd d �|�d �| j�g �\}}|�� S ) N�wgetz--quietz--tries�3z --timeout�20z--output-document�-z--headerzDomU_Request: {0}z{0}:8080)r �formatr �strip)r � domu_request�output�_r r r � _do_request- s ��z*CloudStackPasswordServerClient._do_requestc C s4 | � d�}|dv r d S |dkrtd��| � d� |S )N�send_my_password)� �saved_password� bad_requestz-Error when attempting to fetch root password.r! )r � RuntimeError)r �passwordr r r � get_passwordB s z+CloudStackPasswordServerClient.get_passwordN)�__name__� __module__� __qualname__�__doc__r r r% r r r r r s r c @ sL e Zd ZdZdZdZdd� Zdd� Zdd � Zd d � Z d d � Z e dd� �Z dS )�DataSourceCloudStack� CloudStack�x �2 c C sX t j�| |||� tj�|jd�| _d| _t� | _ | j s t d��d| j f | _ i | _ d S )N�cs�latestzNo virtual router found!z http://%s/) r � DataSourcer �os�path�join�seed_dir�api_ver�get_vr_address�vr_addrr# �metadata_address�cfg)r �sys_cfg�distro�pathsr r r r T s z DataSourceCloudStack.__init__c C s� | � � }|jdkr dS t�| jd�g}t�� }tj||j|jtj d�\}}|r1t� d|� t |�S t� d|t t�� | �� t |�S )Nr Fz latest/meta-data/instance-id)�urls�max_wait�timeout� status_cbzUsing metadata source: '%s'z>Giving up on waiting for the metadata from %s after %s seconds)�get_url_params�max_wait_seconds�uhelp� combine_urlr8 �time� wait_for_url�timeout_seconds�LOG�warning�debug�critical�int�bool)r � url_paramsr= � start_time�url� _responser r r �wait_for_metadata_service` s. �� � ��z.DataSourceCloudStack.wait_for_metadata_servicec C s | j S r )r9 �r r r r �get_config_obj s z#DataSourceCloudStack.get_config_objc C s i }t j|| jd d�r |d | _|d | _t�d| j� dS zV| �� s'W dS t�� }t � | j | j �| _t � | j | j �| _t�dtt�� | �� t| j�}z|�� }W n tyg t �td | j� Y W dS w |rsd|d did �| _W dS ty� t �td | j � Y dS w ) N�/)�basez user-dataz meta-dataz%Using seeded cloudstack data from: %sTFz)Crawl of metadata service took %s secondsz/Failed to fetch password from virtual router %s�expire)� ssh_pwauthr$ �chpasswdz(Failed fetching from metadata service %s)r �read_optional_seedr4 � userdata_raw�metadatarH rJ rR rE r �get_instance_userdatar5 r8 �get_instance_metadatarL r r7 r% � Exception�logexcr9 )r �seed_retrO �password_client� set_passwordr r r � _get_data� s\ ��� ���� ��z DataSourceCloudStack._get_datac C � | j d S )Nz instance-id�r\ rS r r r �get_instance_id� r z$DataSourceCloudStack.get_instance_idc C re )Nzavailability-zonerf rS r r r �availability_zone� s z&DataSourceCloudStack.availability_zoneN) r& r' r( �dsname� url_max_wait� url_timeoutr rR rT rd rg �propertyrh r r r r r* L s 0r* c C s> zt dd�} W n ty t�d� Y d S w | d d d S )Nz data-server�P z DNS Entry data-server not foundr � )r r rH rJ )�addrinfor r r �get_data_server� s �rp c C s^ t �d��� } | D ]#}|�d�}|d dkr,ttdt|d d���}t�d|� | S q d S ) Nz/proc/net/route� � �00000000z<L� � z"Found default route, gateway is %s) r � load_file� splitlines�splitr r rL rH rJ )�lines�line�items�gwr r r �get_default_gateway� s �r} c C sH g d�} | D ]}t j�|�r!tt �|��dkr!t�d|� | S qd S )N)z/var/lib/dhclientz /var/lib/dhcpz/var/lib/NetworkManagerr zUsing %s lease directory)r1 r2 �exists�len�listdirrH rJ )�supported_dirs�dr r r �get_dhclient_d� s �r� c C s� | d u rt � } | s d S t�| �}d}d }|D ](}|�d�r q|�d�s)|�d�s)qtj�| |�}tj�|�}||kr>|}|}q|S )N���� dhclient6z.leasez.leases)r� r1 r� � startswith�endswithr2 r3 �getmtime)�lease_d� lease_files� latest_mtime� latest_file�fname�abs_path�mtimer r r �get_latest_lease� s& �r� c C s� t � } | r t�d| � | S t�d�} | r t�d| � | S t� }|s)t�d� t� S t|d��+}|D ] }d|v rQ|�d�� d�}t |�d krQ|d }t�d |� |} q1W d � n1 s\w Y | skt�d � t� S | S ) Nz4Found metadata server '%s' via data-server DNS entry�SERVER_ADDRESSz-Found SERVER_ADDRESS '%s' via networkd_leasesz*No lease file found, using default gateway�rzdhcp-server-identifierz ; � rt zFound DHCP identifier %sz$No DHCP found, using default gateway) rp rH rJ r � networkd_get_option_from_leasesr� r} �openr rx r )�latest_address� lease_file�fdrz �words�dhcptokr r r r6 s@ � � �� � r6 c C s t �| t�S r )r �list_from_depends� datasources)�dependsr r r �get_datasource_list3 s r� r )#r1 rE �socketr r r �structr � cloudinitr �loggingr r r rC r � cloudinit.netr �cloudinit.sources.helpersr � getLoggerr& rH r r0 r* rp r} r� r� r6 �DEP_FILESYSTEM� DEP_NETWORKr� r� r r r r �<module> s* .n !-� __pycache__/DataSourceBigstep.cpython-310.pyc 0000644 00000003641 15027667240 0015042 0 ustar 00 o �Ad� � @ s\ d dl Z d dlZd dlZd dlmZmZmZ G dd� dej�Zeej ej ffgZ dd� Z dS )� N)�sources� url_helper�utilc sF e Zd ZdZ� fdd�Zd defdd�Zdefdd �Zd d � Z � Z S ) �DataSourceBigstep�Bigstepc s& t � �|||� i | _d| _d| _d S )N� )�super�__init__�metadata�vendordata_raw� userdata_raw)�self�sys_cfg�distro�paths�� __class__� �E/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceBigstep.pyr s zDataSourceBigstep.__init__F�returnc C sP | � � }|d u r dS t�|�}t�|j�� �}|d | _|d | _|d | _ dS )NFr r r T) �_get_url_from_filer �readurl�json�loads�contents�decoder r r )r � apply_filter�url�response�decodedr r r � _get_data s zDataSourceBigstep._get_datac C s d| � � � d�S )z/Return the subplatform metadata source details.z metadata (�))r )r r r r �_get_subplatform# s z"DataSourceBigstep._get_subplatformc C s^ t j�| jjdddd�}zt�|�}W |S ty. } z|jtj kr)W Y d }~d S � d }~ww )N�data�seed�bigstepr ) �os�path�joinr � cloud_dirr � load_file�IOError�errno�ENOENT)r �url_file�content�er r r r ' s � � ��z$DataSourceBigstep._get_url_from_file)F) �__name__� __module__� __qualname__�dsnamer �boolr �strr" r � __classcell__r r r r r s r c C s t �| t�S )N)r �list_from_depends� datasources)�dependsr r r �get_datasource_list? s r; ) r, r r& � cloudinitr r r � DataSourcer �DEP_FILESYSTEM� DEP_NETWORKr9 r; r r r r �<module> s ,� DataSourceRbxCloud.py 0000644 00000017525 15027667240 0010636 0 ustar 00 # Copyright (C) 2018 Warsaw Data Center # # Author: Malwina Leis <m.leis@rootbox.com> # Author: Grzegorz Brzeski <gregory@rootbox.io> # Author: Adam Dobrawy <a.dobrawy@hyperone.com> # # This file is part of cloud-init. See LICENSE file for license information. """ This file contains code used to gather the user data passed to an instance on rootbox / hyperone cloud platforms """ import errno import os import os.path import typing from ipaddress import IPv4Address from cloudinit import log as logging from cloudinit import sources, subp, util from cloudinit.event import EventScope, EventType LOG = logging.getLogger(__name__) ETC_HOSTS = "/etc/hosts" def get_manage_etc_hosts(): hosts = util.load_file(ETC_HOSTS, quiet=True) if hosts: LOG.debug("/etc/hosts exists - setting manage_etc_hosts to False") return False LOG.debug("/etc/hosts does not exists - setting manage_etc_hosts to True") return True def increment_ip(addr, inc: int) -> str: return str(IPv4Address(int(IPv4Address(addr)) + inc)) def get_three_ips(addr) -> typing.List[str]: """Return a list of 3 IP addresses: [addr, addr + 2, addr + 3] @param addr: an object that is passed to IPvAddress @return: list of strings """ return [ addr, increment_ip(addr, 2), increment_ip(addr, 3), ] def _sub_arp(cmd): """ Uses the preferred cloud-init subprocess def of subp.subp and runs arping. Breaking this to a separate function for later use in mocking and unittests """ return subp.subp(["arping"] + cmd) def gratuitous_arp(items, distro): source_param = "-S" if distro.name in ["fedora", "centos", "rhel"]: source_param = "-s" for item in items: try: _sub_arp( ["-c", "2", source_param, item["source"], item["destination"]] ) except subp.ProcessExecutionError as error: # warning, because the system is able to function properly # despite no success - some ARP table may be waiting for # expiration, but the system may continue LOG.warning( 'Failed to arping from "%s" to "%s": %s', item["source"], item["destination"], error, ) def get_md(): """Returns False (not found or error) or a dictionary with metadata.""" devices = set( util.find_devs_with("LABEL=CLOUDMD") + util.find_devs_with("LABEL=cloudmd") ) if not devices: return False for device in devices: try: rbx_data = util.mount_cb( device=device, callback=read_user_data_callback, mtype=["vfat", "fat", "msdosfs"], ) if rbx_data: return rbx_data except OSError as err: if err.errno != errno.ENOENT: raise except util.MountFailedError: util.logexc( LOG, "Failed to mount %s when looking for user data", device ) LOG.debug( "Did not find RbxCloud data, searched devices: %s", ",".join(devices) ) return False def generate_network_config(netadps): """Generate network configuration @param netadps: A list of network adapter settings @returns: A dict containing network config """ return { "version": 1, "config": [ { "type": "physical", "name": "eth{}".format(str(i)), "mac_address": netadp["macaddress"].lower(), "subnets": [ { "type": "static", "address": ip["address"], "netmask": netadp["network"]["netmask"], "control": "auto", "gateway": netadp["network"]["gateway"], "dns_nameservers": netadp["network"]["dns"][ "nameservers" ], } for ip in netadp["ip"] ], } for i, netadp in enumerate(netadps) ], } def read_user_data_callback(mount_dir): """This callback will be applied by util.mount_cb() on the mounted drive. @param mount_dir: String representing path of directory where mounted drive is available @returns: A dict containing userdata, metadata and cfg based on metadata. """ meta_data = util.load_json( text=util.load_file( fname=os.path.join(mount_dir, "cloud.json"), decode=False ) ) user_data = util.load_file( fname=os.path.join(mount_dir, "user.data"), quiet=True ) if "vm" not in meta_data or "netadp" not in meta_data: util.logexc(LOG, "Failed to load metadata. Invalid format.") return None username = meta_data.get("additionalMetadata", {}).get("username") ssh_keys = meta_data.get("additionalMetadata", {}).get("sshKeys", []) hash = None if meta_data.get("additionalMetadata", {}).get("password"): hash = meta_data["additionalMetadata"]["password"]["sha512"] network = generate_network_config(meta_data["netadp"]) data = { "userdata": user_data, "metadata": { "instance-id": meta_data["vm"]["_id"], "local-hostname": meta_data["vm"]["name"], "public-keys": [], }, "gratuitous_arp": [ {"source": ip["address"], "destination": target} for netadp in meta_data["netadp"] for ip in netadp["ip"] for target in get_three_ips(netadp["network"]["gateway"]) ], "cfg": { "ssh_pwauth": True, "disable_root": True, "system_info": { "default_user": { "name": username, "gecos": username, "sudo": ["ALL=(ALL) NOPASSWD:ALL"], "passwd": hash, "lock_passwd": False, "ssh_authorized_keys": ssh_keys, } }, "network_config": network, "manage_etc_hosts": get_manage_etc_hosts(), }, } LOG.debug("returning DATA object:") LOG.debug(data) return data class DataSourceRbxCloud(sources.DataSource): dsname = "RbxCloud" default_update_events = { EventScope.NETWORK: { EventType.BOOT_NEW_INSTANCE, EventType.BOOT, EventType.BOOT_LEGACY, } } def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.seed = None def __str__(self): root = sources.DataSource.__str__(self) return "%s [seed=%s]" % (root, self.seed) def _get_data(self): """ Metadata is passed to the launching instance which is used to perform instance configuration. """ rbx_data = get_md() if rbx_data is False: return False self.userdata_raw = rbx_data["userdata"] self.metadata = rbx_data["metadata"] self.gratuitous_arp = rbx_data["gratuitous_arp"] self.cfg = rbx_data["cfg"] return True @property def network_config(self): return self.cfg["network_config"] def get_public_ssh_keys(self): return self.metadata["public-keys"] def get_userdata_raw(self): return self.userdata_raw def get_config_obj(self): return self.cfg def activate(self, cfg, is_new_instance): gratuitous_arp(self.gratuitous_arp, self.distro) # Used to match classes to dependencies datasources = [ (DataSourceRbxCloud, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) DataSourceHetzner.py 0000644 00000012641 15027667240 0010525 0 ustar 00 # Author: Jonas Keidel <jonas.keidel@hetzner.com> # Author: Markus Schade <markus.schade@hetzner.com> # # This file is part of cloud-init. See LICENSE file for license information. # """Hetzner Cloud API Documentation https://docs.hetzner.cloud/""" import cloudinit.sources.helpers.hetzner as hc_helper from cloudinit import dmi from cloudinit import log as logging from cloudinit import net, sources, util from cloudinit.net.dhcp import NoDHCPLeaseError from cloudinit.net.ephemeral import EphemeralDHCPv4 LOG = logging.getLogger(__name__) BASE_URL_V1 = "http://169.254.169.254/hetzner/v1" BUILTIN_DS_CONFIG = { "metadata_url": BASE_URL_V1 + "/metadata", "userdata_url": BASE_URL_V1 + "/userdata", } MD_RETRIES = 60 MD_TIMEOUT = 2 MD_WAIT_RETRY = 2 class DataSourceHetzner(sources.DataSource): dsname = "Hetzner" def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.distro = distro self.metadata = dict() self.ds_cfg = util.mergemanydict( [ util.get_cfg_by_path(sys_cfg, ["datasource", "Hetzner"], {}), BUILTIN_DS_CONFIG, ] ) self.metadata_address = self.ds_cfg["metadata_url"] self.userdata_address = self.ds_cfg["userdata_url"] self.retries = self.ds_cfg.get("retries", MD_RETRIES) self.timeout = self.ds_cfg.get("timeout", MD_TIMEOUT) self.wait_retry = self.ds_cfg.get("wait_retry", MD_WAIT_RETRY) self._network_config = sources.UNSET self.dsmode = sources.DSMODE_NETWORK def _get_data(self): (on_hetzner, serial) = get_hcloud_data() if not on_hetzner: return False try: with EphemeralDHCPv4( iface=net.find_fallback_nic(), connectivity_url_data={ "url": BASE_URL_V1 + "/metadata/instance-id", }, tmp_dir=self.distro.get_tmp_exec_path(), ): md = hc_helper.read_metadata( self.metadata_address, timeout=self.timeout, sec_between=self.wait_retry, retries=self.retries, ) ud = hc_helper.read_userdata( self.userdata_address, timeout=self.timeout, sec_between=self.wait_retry, retries=self.retries, ) except (NoDHCPLeaseError) as e: LOG.error("Bailing, DHCP Exception: %s", e) raise # Hetzner cloud does not support binary user-data. So here, do a # base64 decode of the data if we can. The end result being that a # user can provide base64 encoded (possibly gzipped) data as user-data. # # The fallout is that in the event of b64 encoded user-data, # /var/lib/cloud-init/cloud-config.txt will not be identical to the # user-data provided. It will be decoded. self.userdata_raw = hc_helper.maybe_b64decode(ud) self.metadata_full = md # hostname is name provided by user at launch. The API enforces it is # a valid hostname, but it is not guaranteed to be resolvable in dns or # fully qualified. self.metadata["instance-id"] = md["instance-id"] self.metadata["local-hostname"] = md["hostname"] self.metadata["network-config"] = md.get("network-config", None) self.metadata["public-keys"] = md.get("public-keys", None) self.vendordata_raw = md.get("vendor_data", None) # instance-id and serial from SMBIOS should be identical if self.get_instance_id() != serial: raise RuntimeError( "SMBIOS serial does not match instance ID from metadata" ) return True def check_instance_id(self, sys_cfg): return sources.instance_id_matches_system_uuid( self.get_instance_id(), "system-serial-number" ) @property def network_config(self): """Configure the networking. This needs to be done each boot, since the IP information may have changed due to snapshot and/or migration. """ if self._network_config is None: LOG.warning( "Found None as cached _network_config. Resetting to %s", sources.UNSET, ) self._network_config = sources.UNSET if self._network_config != sources.UNSET: return self._network_config _net_config = self.metadata["network-config"] if not _net_config: raise Exception("Unable to get meta-data from server....") self._network_config = _net_config return self._network_config def get_hcloud_data(): vendor_name = dmi.read_dmi_data("system-manufacturer") if vendor_name != "Hetzner": return (False, None) serial = dmi.read_dmi_data("system-serial-number") if serial: LOG.debug("Running on Hetzner Cloud: serial=%s", serial) else: raise RuntimeError("Hetzner Cloud detected, but no serial found") return (True, serial) # Used to match classes to dependencies datasources = [ (DataSourceHetzner, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceMAAS.py 0000644 00000034617 15027667240 0007636 0 ustar 00 # Copyright (C) 2012 Canonical Ltd. # Copyright (C) 2012 Yahoo! Inc. # # Author: Scott Moser <scott.moser@canonical.com> # Author: Joshua Harlow <harlowja@yahoo-inc.com> # # This file is part of cloud-init. See LICENSE file for license information. import hashlib import os import time from cloudinit import log as logging from cloudinit import sources, url_helper, util LOG = logging.getLogger(__name__) MD_VERSION = "2012-03-01" DS_FIELDS = [ # remote path, location in dictionary, binary data?, optional? ("meta-data/instance-id", "meta-data/instance-id", False, False), ("meta-data/local-hostname", "meta-data/local-hostname", False, False), ("meta-data/public-keys", "meta-data/public-keys", False, True), ("meta-data/vendor-data", "vendor-data", True, True), ("user-data", "user-data", True, True), ] class DataSourceMAAS(sources.DataSource): """ DataSourceMAAS reads instance information from MAAS. Given a config metadata_url, and oauth tokens, it expects to find files under the root named: instance-id user-data hostname vendor-data """ dsname = "MAAS" id_hash = None _oauth_helper = None def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.base_url = None self.seed_dir = os.path.join(paths.seed_dir, "maas") self.id_hash = get_id_from_ds_cfg(self.ds_cfg) @property def oauth_helper(self): if not self._oauth_helper: self._oauth_helper = get_oauth_helper(self.ds_cfg) return self._oauth_helper def __str__(self): root = sources.DataSource.__str__(self) return "%s [%s]" % (root, self.base_url) def _get_data(self): mcfg = self.ds_cfg try: self._set_data(self.seed_dir, read_maas_seed_dir(self.seed_dir)) return True except MAASSeedDirNone: pass except MAASSeedDirMalformed as exc: LOG.warning("%s was malformed: %s", self.seed_dir, exc) raise # If there is no metadata_url, then we're not configured url = mcfg.get("metadata_url", None) if not url: return False try: # doing this here actually has a side affect of # getting oauth time-fix in place. As no where else would # retry by default, so even if we could fix the timestamp # we would not. if not self.wait_for_metadata_service(url): return False self._set_data( url, read_maas_seed_url( url, read_file_or_url=self.oauth_helper.readurl, paths=self.paths, retries=1, ), ) return True except Exception: util.logexc(LOG, "Failed fetching metadata from url %s", url) return False def _set_data(self, url, data): # takes a url for base_url and a tuple of userdata, metadata, vd. self.base_url = url ud, md, vd = data self.userdata_raw = ud self.metadata = md self.vendordata_pure = vd if vd: try: self.vendordata_raw = sources.convert_vendordata(vd) except ValueError as e: LOG.warning("Invalid content in vendor-data: %s", e) self.vendordata_raw = None def _get_subplatform(self): """Return the subplatform metadata source details.""" return "seed-dir (%s)" % self.base_url def wait_for_metadata_service(self, url): mcfg = self.ds_cfg max_wait = 120 try: max_wait = int(mcfg.get("max_wait", max_wait)) except Exception: util.logexc(LOG, "Failed to get max wait. using %s", max_wait) if max_wait == 0: return False timeout = 50 try: if timeout in mcfg: timeout = int(mcfg.get("timeout", timeout)) except Exception: LOG.warning("Failed to get timeout, using %s", timeout) starttime = time.time() if url.endswith("/"): url = url[:-1] check_url = "%s/%s/meta-data/instance-id" % (url, MD_VERSION) urls = [check_url] url, _response = self.oauth_helper.wait_for_url( urls=urls, max_wait=max_wait, timeout=timeout ) if url: LOG.debug("Using metadata source: '%s'", url) else: LOG.critical( "Giving up on md from %s after %i seconds", urls, int(time.time() - starttime), ) return bool(url) def check_instance_id(self, sys_cfg): """locally check if the current system is the same instance. MAAS doesn't provide a real instance-id, and if it did, it is still only available over the network. We need to check based only on local resources. So compute a hash based on Oauth tokens.""" if self.id_hash is None: return False ncfg = util.get_cfg_by_path(sys_cfg, ("datasource", self.dsname), {}) return self.id_hash == get_id_from_ds_cfg(ncfg) def get_oauth_helper(cfg): """Return an oauth helper instance for values in cfg. @raises ValueError from OauthUrlHelper if some required fields have true-ish values but others do not.""" keys = ("consumer_key", "consumer_secret", "token_key", "token_secret") kwargs = dict([(r, cfg.get(r)) for r in keys]) return url_helper.OauthUrlHelper(**kwargs) def get_id_from_ds_cfg(ds_cfg): """Given a config, generate a unique identifier for this node.""" fields = ("consumer_key", "token_key", "token_secret") idstr = "\0".join([ds_cfg.get(f, "") for f in fields]) # store the encoding version as part of the hash in the event # that it ever changed we can compute older versions. return "v1:" + hashlib.sha256(idstr.encode("utf-8")).hexdigest() def read_maas_seed_dir(seed_d): if seed_d.startswith("file://"): seed_d = seed_d[7:] if not os.path.isdir(seed_d) or len(os.listdir(seed_d)) == 0: raise MAASSeedDirNone("%s: not a directory") # seed_dir looks in seed_dir, not seed_dir/VERSION return read_maas_seed_url("file://%s" % seed_d, version=None) def read_maas_seed_url( seed_url, read_file_or_url=None, timeout=None, version=MD_VERSION, paths=None, retries=None, ): """ Read the maas datasource at seed_url. read_file_or_url is a method that should provide an interface like util.read_file_or_url Expected format of seed_url is are the following files: * <seed_url>/<version>/meta-data/instance-id * <seed_url>/<version>/meta-data/local-hostname * <seed_url>/<version>/user-data If version is None, then <version>/ will not be used. """ if read_file_or_url is None: read_file_or_url = url_helper.read_file_or_url if seed_url.endswith("/"): seed_url = seed_url[:-1] md = {} for path, _dictname, binary, optional in DS_FIELDS: if version is None: url = "%s/%s" % (seed_url, path) else: url = "%s/%s/%s" % (seed_url, version, path) try: ssl_details = util.fetch_ssl_details(paths) resp = read_file_or_url( url, retries=retries, timeout=timeout, ssl_details=ssl_details ) if resp.ok(): if binary: md[path] = resp.contents else: md[path] = util.decode_binary(resp.contents) else: LOG.warning( "Fetching from %s resulted in an invalid http code %s", url, resp.code, ) except url_helper.UrlError as e: if e.code == 404 and not optional: raise MAASSeedDirMalformed( "Missing required %s: %s" % (path, e) ) from e elif e.code != 404: raise e return check_seed_contents(md, seed_url) def check_seed_contents(content, seed): """Validate if dictionary content valid as a return for a datasource. Either return a (userdata, metadata, vendordata) tuple or Raise MAASSeedDirMalformed or MAASSeedDirNone """ ret = {} missing = [] for spath, dpath, _binary, optional in DS_FIELDS: if spath not in content: if not optional: missing.append(spath) continue if "/" in dpath: top, _, p = dpath.partition("/") if top not in ret: ret[top] = {} ret[top][p] = content[spath] else: ret[dpath] = content[spath] if len(ret) == 0: raise MAASSeedDirNone("%s: no data files found" % seed) if missing: raise MAASSeedDirMalformed("%s: missing files %s" % (seed, missing)) vd_data = None if ret.get("vendor-data"): err = object() vd_data = util.load_yaml( ret.get("vendor-data"), default=err, allowed=(object) ) if vd_data is err: raise MAASSeedDirMalformed("vendor-data was not loadable as yaml.") return ret.get("user-data"), ret.get("meta-data"), vd_data class MAASSeedDirNone(Exception): pass class MAASSeedDirMalformed(Exception): pass # Used to match classes to dependencies datasources = [ (DataSourceMAAS, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) if __name__ == "__main__": def main(): """ Call with single argument of directory or http or https url. If url is given additional arguments are allowed, which will be interpreted as consumer_key, token_key, token_secret, consumer_secret """ import argparse import pprint import sys parser = argparse.ArgumentParser(description="Interact with MAAS DS") parser.add_argument( "--config", metavar="file", help="specify DS config file", default=None, ) parser.add_argument( "--ckey", metavar="key", help="the consumer key to auth with", default=None, ) parser.add_argument( "--tkey", metavar="key", help="the token key to auth with", default=None, ) parser.add_argument( "--csec", metavar="secret", help="the consumer secret (likely '')", default="", ) parser.add_argument( "--tsec", metavar="secret", help="the token secret to auth with", default=None, ) parser.add_argument( "--apiver", metavar="version", help="the apiver to use ( can be used)", default=MD_VERSION, ) subcmds = parser.add_subparsers(title="subcommands", dest="subcmd") for (name, help) in ( ("crawl", "crawl the datasource"), ("get", "do a single GET of provided url"), ("check-seed", "read and verify seed at url"), ): p = subcmds.add_parser(name, help=help) p.add_argument( "url", help="the datasource url", nargs="?", default=None ) args = parser.parse_args() creds = { "consumer_key": args.ckey, "token_key": args.tkey, "token_secret": args.tsec, "consumer_secret": args.csec, } if args.config is None: for fname in ("91_kernel_cmdline_url", "90_dpkg_maas"): fpath = "/etc/cloud/cloud.cfg.d/" + fname + ".cfg" if os.path.exists(fpath) and os.access(fpath, os.R_OK): sys.stderr.write("Used config in %s.\n" % fpath) args.config = fpath if args.config: cfg = util.read_conf(args.config) if "datasource" in cfg: cfg = cfg["datasource"]["MAAS"] for key in creds.keys(): if key in cfg and creds[key] is None: creds[key] = cfg[key] if args.url is None and "metadata_url" in cfg: args.url = cfg["metadata_url"] if args.url is None: sys.stderr.write("Must provide a url or a config with url.\n") sys.exit(1) oauth_helper = get_oauth_helper(creds) def geturl(url): # the retry is to ensure that oauth timestamp gets fixed return oauth_helper.readurl(url, retries=1).contents def printurl(url): print("== %s ==\n%s\n" % (url, geturl(url).decode())) def crawl(url): if url.endswith("/"): for line in geturl(url).decode().splitlines(): if line.endswith("/"): crawl("%s%s" % (url, line)) elif line == "meta-data": # meta-data is a dir, it *should* end in a / crawl("%s%s" % (url, "meta-data/")) else: printurl("%s%s" % (url, line)) else: printurl(url) if args.subcmd == "check-seed": sys.stderr.write("Checking seed at %s\n" % args.url) readurl = oauth_helper.readurl if args.url[0] == "/" or args.url.startswith("file://"): (userdata, metadata, vd) = read_maas_seed_dir(args.url) else: (userdata, metadata, vd) = read_maas_seed_url( args.url, version=args.apiver, read_file_or_url=readurl, retries=2, ) print("=== user-data ===") print("N/A" if userdata is None else userdata.decode()) print("=== meta-data ===") pprint.pprint(metadata) print("=== vendor-data ===") pprint.pprint("N/A" if vd is None else vd) elif args.subcmd == "get": printurl(args.url) elif args.subcmd == "crawl": if not args.url.endswith("/"): args.url = "%s/" % args.url crawl(args.url) main() # vi: ts=4 expandtab DataSourceExoscale.py 0000644 00000021621 15027667240 0010647 0 ustar 00 # Author: Mathieu Corbin <mathieu.corbin@exoscale.com> # Author: Christopher Glass <christopher.glass@exoscale.com> # # This file is part of cloud-init. See LICENSE file for license information. from cloudinit import dmi, helpers from cloudinit import log as logging from cloudinit import sources, url_helper, util from cloudinit.sources.helpers import ec2 LOG = logging.getLogger(__name__) METADATA_URL = "http://169.254.169.254" API_VERSION = "1.0" PASSWORD_SERVER_PORT = 8080 URL_TIMEOUT = 10 URL_RETRIES = 6 EXOSCALE_DMI_NAME = "Exoscale" class DataSourceExoscale(sources.DataSource): dsname = "Exoscale" url_max_wait = 120 def __init__(self, sys_cfg, distro, paths): super(DataSourceExoscale, self).__init__(sys_cfg, distro, paths) LOG.debug("Initializing the Exoscale datasource") self.metadata_url = self.ds_cfg.get("metadata_url", METADATA_URL) self.api_version = self.ds_cfg.get("api_version", API_VERSION) self.password_server_port = int( self.ds_cfg.get("password_server_port", PASSWORD_SERVER_PORT) ) self.url_timeout = self.ds_cfg.get("timeout", URL_TIMEOUT) self.url_retries = self.ds_cfg.get("retries", URL_RETRIES) self.extra_config = {} def activate(self, cfg, is_new_instance): """Adjust set-passwords module to run 'always' during each boot""" # We run the set password config module on every boot in order to # enable resetting the instance's password via the exoscale console # (and a subsequent instance reboot). # Exoscale password server only provides set-passwords user-data if # a user has triggered a password reset. So calling that password # service generally results in no additional cloud-config. # TODO(Create util functions for overriding merged sys_cfg module freq) mod = "set_passwords" sem_path = self.paths.get_ipath_cur("sem") sem_helper = helpers.FileSemaphores(sem_path) if sem_helper.clear("config_" + mod, None): LOG.debug("Overriding module set-passwords with frequency always") def wait_for_metadata_service(self): """Wait for the metadata service to be reachable.""" metadata_url = "{}/{}/meta-data/instance-id".format( self.metadata_url, self.api_version ) url, _response = url_helper.wait_for_url( urls=[metadata_url], max_wait=self.url_max_wait, timeout=self.url_timeout, status_cb=LOG.critical, ) return bool(url) def crawl_metadata(self): """ Crawl the metadata service when available. @returns: Dictionary of crawled metadata content. """ metadata_ready = util.log_time( logfunc=LOG.info, msg="waiting for the metadata service", func=self.wait_for_metadata_service, ) if not metadata_ready: return {} return read_metadata( self.metadata_url, self.api_version, self.password_server_port, self.url_timeout, self.url_retries, ) def _get_data(self): """Fetch the user data, the metadata and the VM password from the metadata service. Please refer to the datasource documentation for details on how the metadata server and password server are crawled. """ if not self._is_platform_viable(): return False data = util.log_time( logfunc=LOG.debug, msg="Crawl of metadata service", func=self.crawl_metadata, ) if not data: return False self.userdata_raw = data["user-data"] self.metadata = data["meta-data"] password = data.get("password") password_config = {} if password: # Since we have a password, let's make sure we are allowed to use # it by allowing ssh_pwauth. # The password module's default behavior is to leave the # configuration as-is in this regard, so that means it will either # leave the password always disabled if no password is ever set, or # leave the password login enabled if we set it once. password_config = { "ssh_pwauth": True, "password": password, "chpasswd": { "expire": False, }, } # builtin extra_config overrides password_config self.extra_config = util.mergemanydict( [self.extra_config, password_config] ) return True def get_config_obj(self): return self.extra_config def _is_platform_viable(self): return dmi.read_dmi_data("system-product-name").startswith( EXOSCALE_DMI_NAME ) # Used to match classes to dependencies datasources = [ (DataSourceExoscale, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) def get_password( metadata_url=METADATA_URL, api_version=API_VERSION, password_server_port=PASSWORD_SERVER_PORT, url_timeout=URL_TIMEOUT, url_retries=URL_RETRIES, ): """Obtain the VM's password if set. Once fetched the password is marked saved. Future calls to this method may return empty string or 'saved_password'.""" password_url = "{}:{}/{}/".format( metadata_url, password_server_port, api_version ) response = url_helper.read_file_or_url( password_url, ssl_details=None, headers={"DomU_Request": "send_my_password"}, timeout=url_timeout, retries=url_retries, ) password = response.contents.decode("utf-8") # the password is empty or already saved # Note: the original metadata server would answer an additional # 'bad_request' status, but the Exoscale implementation does not. if password in ["", "saved_password"]: return None # save the password url_helper.read_file_or_url( password_url, ssl_details=None, headers={"DomU_Request": "saved_password"}, timeout=url_timeout, retries=url_retries, ) return password def read_metadata( metadata_url=METADATA_URL, api_version=API_VERSION, password_server_port=PASSWORD_SERVER_PORT, url_timeout=URL_TIMEOUT, url_retries=URL_RETRIES, ): """Query the metadata server and return the retrieved data.""" crawled_metadata = {} crawled_metadata["_metadata_api_version"] = api_version try: crawled_metadata["user-data"] = ec2.get_instance_userdata( api_version, metadata_url, timeout=url_timeout, retries=url_retries ) crawled_metadata["meta-data"] = ec2.get_instance_metadata( api_version, metadata_url, timeout=url_timeout, retries=url_retries ) except Exception as e: util.logexc( LOG, "failed reading from metadata url %s (%s)", metadata_url, e ) return {} try: crawled_metadata["password"] = get_password( api_version=api_version, metadata_url=metadata_url, password_server_port=password_server_port, url_retries=url_retries, url_timeout=url_timeout, ) except Exception as e: util.logexc( LOG, "failed to read from password server url %s:%s (%s)", metadata_url, password_server_port, e, ) return crawled_metadata if __name__ == "__main__": import argparse parser = argparse.ArgumentParser(description="Query Exoscale Metadata") parser.add_argument( "--endpoint", metavar="URL", help="The url of the metadata service.", default=METADATA_URL, ) parser.add_argument( "--version", metavar="VERSION", help="The version of the metadata endpoint to query.", default=API_VERSION, ) parser.add_argument( "--retries", metavar="NUM", type=int, help="The number of retries querying the endpoint.", default=URL_RETRIES, ) parser.add_argument( "--timeout", metavar="NUM", type=int, help="The time in seconds to wait before timing out.", default=URL_TIMEOUT, ) parser.add_argument( "--password-port", metavar="PORT", type=int, help="The port on which the password endpoint listens", default=PASSWORD_SERVER_PORT, ) args = parser.parse_args() data = read_metadata( metadata_url=args.endpoint, api_version=args.version, password_server_port=args.password_port, url_timeout=args.timeout, url_retries=args.retries, ) print(util.json_dumps(data)) # vi: ts=4 expandtab DataSourceNoCloud.py 0000644 00000030604 15027667240 0010450 0 ustar 00 # Copyright (C) 2009-2010 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 Hafliger <juerg.haefliger@hp.com> # Author: Joshua Harlow <harlowja@yahoo-inc.com> # # This file is part of cloud-init. See LICENSE file for license information. import errno import os from cloudinit import dmi from cloudinit import log as logging from cloudinit import sources, util from cloudinit.net import eni LOG = logging.getLogger(__name__) class DataSourceNoCloud(sources.DataSource): dsname = "NoCloud" def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.seed = None self.seed_dirs = [ os.path.join(paths.seed_dir, "nocloud"), os.path.join(paths.seed_dir, "nocloud-net"), ] self.seed_dir = None self.supported_seed_starts = ("/", "file://") def __str__(self): root = sources.DataSource.__str__(self) return "%s [seed=%s][dsmode=%s]" % (root, self.seed, self.dsmode) def _get_devices(self, label): fslist = util.find_devs_with("TYPE=vfat") fslist.extend(util.find_devs_with("TYPE=iso9660")) label_list = util.find_devs_with("LABEL=%s" % label.upper()) label_list.extend(util.find_devs_with("LABEL=%s" % label.lower())) label_list.extend(util.find_devs_with("LABEL_FATBOOT=%s" % label)) devlist = list(set(fslist) & set(label_list)) devlist.sort(reverse=True) return devlist def _get_data(self): defaults = { "instance-id": "nocloud", "dsmode": self.dsmode, } found = [] mydata = { "meta-data": {}, "user-data": "", "vendor-data": "", "network-config": None, } try: # Parse the system serial label from dmi. If not empty, try parsing # like the commandline md = {} serial = dmi.read_dmi_data("system-serial-number") if serial and load_cmdline_data(md, serial): found.append("dmi") mydata = _merge_new_seed(mydata, {"meta-data": md}) except Exception: util.logexc(LOG, "Unable to parse dmi data") return False try: # Parse the kernel command line, getting data passed in md = {} if load_cmdline_data(md): found.append("cmdline") mydata = _merge_new_seed(mydata, {"meta-data": md}) except Exception: util.logexc(LOG, "Unable to parse command line data") return False # Check to see if the seed dir has data. pp2d_kwargs = { "required": ["user-data", "meta-data"], "optional": ["vendor-data", "network-config"], } for path in self.seed_dirs: try: seeded = util.pathprefix2dict(path, **pp2d_kwargs) found.append(path) LOG.debug("Using seeded data from %s", path) mydata = _merge_new_seed(mydata, seeded) break except ValueError: pass # If the datasource config had a 'seedfrom' entry, then that takes # precedence over a 'seedfrom' that was found in a filesystem # but not over external media if self.ds_cfg.get("seedfrom"): found.append("ds_config_seedfrom") mydata["meta-data"]["seedfrom"] = self.ds_cfg["seedfrom"] # fields appropriately named can also just come from the datasource # config (ie, 'user-data', 'meta-data', 'vendor-data' there) if "user-data" in self.ds_cfg and "meta-data" in self.ds_cfg: mydata = _merge_new_seed(mydata, self.ds_cfg) found.append("ds_config") def _pp2d_callback(mp, data): return util.pathprefix2dict(mp, **data) label = self.ds_cfg.get("fs_label", "cidata") if label is not None: for dev in self._get_devices(label): try: LOG.debug("Attempting to use data from %s", dev) try: seeded = util.mount_cb( dev, _pp2d_callback, pp2d_kwargs ) except ValueError: LOG.warning( "device %s with label=%s not a valid seed.", dev, label, ) continue mydata = _merge_new_seed(mydata, seeded) LOG.debug("Using data from %s", dev) found.append(dev) break except OSError as e: if e.errno != errno.ENOENT: raise except util.MountFailedError: util.logexc( LOG, "Failed to mount %s when looking for data", dev ) # There was no indication on kernel cmdline or data # in the seeddir suggesting this handler should be used. if len(found) == 0: return False # The special argument "seedfrom" indicates we should # attempt to seed the userdata / metadata from its value # its primarily value is in allowing the user to type less # on the command line, ie: ds=nocloud;s=http://bit.ly/abcdefg/ if "seedfrom" in mydata["meta-data"]: seedfrom = mydata["meta-data"]["seedfrom"] seedfound = False for proto in self.supported_seed_starts: if seedfrom.startswith(proto): seedfound = proto break if not seedfound: LOG.debug("Seed from %s not supported by %s", seedfrom, self) return False # check and replace instances of known dmi.<dmi_keys> such as # chassis-serial-number or baseboard-product-name seedfrom = dmi.sub_dmi_vars(seedfrom) # This could throw errors, but the user told us to do it # so if errors are raised, let them raise (md_seed, ud, vd) = util.read_seeded(seedfrom, timeout=None) LOG.debug("Using seeded cache data from %s", seedfrom) # Values in the command line override those from the seed mydata["meta-data"] = util.mergemanydict( [mydata["meta-data"], md_seed] ) mydata["user-data"] = ud mydata["vendor-data"] = vd found.append(seedfrom) # Now that we have exhausted any other places merge in the defaults mydata["meta-data"] = util.mergemanydict( [mydata["meta-data"], defaults] ) self.dsmode = self._determine_dsmode( [mydata["meta-data"].get("dsmode")] ) if self.dsmode == sources.DSMODE_DISABLED: LOG.debug( "%s: not claiming datasource, dsmode=%s", self, self.dsmode ) return False self.seed = ",".join(found) self.metadata = mydata["meta-data"] self.userdata_raw = mydata["user-data"] self.vendordata_raw = mydata["vendor-data"] self._network_config = mydata["network-config"] self._network_eni = mydata["meta-data"].get("network-interfaces") return True @property def platform_type(self): # Handle upgrade path of pickled ds if not hasattr(self, "_platform_type"): self._platform_type = None if not self._platform_type: self._platform_type = "lxd" if util.is_lxd() else "nocloud" return self._platform_type def _get_cloud_name(self): """Return unknown when 'cloud-name' key is absent from metadata.""" return sources.METADATA_UNKNOWN def _get_subplatform(self): """Return the subplatform metadata source details.""" if self.seed.startswith("/dev"): subplatform_type = "config-disk" else: subplatform_type = "seed-dir" return "%s (%s)" % (subplatform_type, self.seed) def check_instance_id(self, sys_cfg): # quickly (local check only) if self.instance_id is still valid # we check kernel command line or files. current = self.get_instance_id() if not current: return None # LP: #1568150 need getattr in the case that an old class object # has been loaded from a pickled file and now executing new source. dirs = getattr(self, "seed_dirs", [self.seed_dir]) quick_id = _quick_read_instance_id(dirs=dirs) if not quick_id: return None return quick_id == current @property def network_config(self): if self._network_config is None: if self._network_eni is not None: self._network_config = eni.convert_eni_data(self._network_eni) return self._network_config def _quick_read_instance_id(dirs=None): if dirs is None: dirs = [] iid_key = "instance-id" fill = {} if load_cmdline_data(fill) and iid_key in fill: return fill[iid_key] for d in dirs: if d is None: continue try: data = util.pathprefix2dict(d, required=["meta-data"]) md = util.load_yaml(data["meta-data"]) if md and iid_key in md: return md[iid_key] except ValueError: pass return None def load_cmdline_data(fill, cmdline=None): pairs = [ ("ds=nocloud", sources.DSMODE_LOCAL), ("ds=nocloud-net", sources.DSMODE_NETWORK), ] for idstr, dsmode in pairs: if parse_cmdline_data(idstr, fill, cmdline): # if dsmode was explicitly in the command line, then # prefer it to the dsmode based on the command line id if "dsmode" not in fill: fill["dsmode"] = dsmode return True return False # Returns true or false indicating if cmdline indicated # that this module should be used. Updates dictionary 'fill' # with data that was found. # Example cmdline: # root=LABEL=uec-rootfs ro ds=nocloud def parse_cmdline_data(ds_id, fill, cmdline=None): if cmdline is None: cmdline = util.get_cmdline() cmdline = " %s " % cmdline if not (" %s " % ds_id in cmdline or " %s;" % ds_id in cmdline): return False argline = "" # cmdline can contain: # ds=nocloud[;key=val;key=val] for tok in cmdline.split(): if tok.startswith(ds_id): argline = tok.split("=", 1) # argline array is now 'nocloud' followed optionally by # a ';' and then key=value pairs also terminated with ';' tmp = argline[1].split(";") if len(tmp) > 1: kvpairs = tmp[1:] else: kvpairs = () # short2long mapping to save cmdline typing s2l = {"h": "local-hostname", "i": "instance-id", "s": "seedfrom"} for item in kvpairs: if item == "": continue try: (k, v) = item.split("=", 1) except Exception: k = item v = None if k in s2l: k = s2l[k] fill[k] = v return True def _merge_new_seed(cur, seeded): ret = cur.copy() newmd = seeded.get("meta-data", {}) if not isinstance(seeded["meta-data"], dict): newmd = util.load_yaml(seeded["meta-data"]) ret["meta-data"] = util.mergemanydict([cur["meta-data"], newmd]) if seeded.get("network-config"): ret["network-config"] = util.load_yaml(seeded.get("network-config")) if "user-data" in seeded: ret["user-data"] = seeded["user-data"] if "vendor-data" in seeded: ret["vendor-data"] = seeded["vendor-data"] return ret class DataSourceNoCloudNet(DataSourceNoCloud): def __init__(self, sys_cfg, distro, paths): DataSourceNoCloud.__init__(self, sys_cfg, distro, paths) self.supported_seed_starts = ("http://", "https://") # Used to match classes to dependencies datasources = [ (DataSourceNoCloud, (sources.DEP_FILESYSTEM,)), (DataSourceNoCloudNet, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceNone.py 0000644 00000002561 15027667240 0010005 0 ustar 00 # Copyright (C) 2012 Yahoo! Inc. # # Author: Joshua Harlow <harlowja@yahoo-inc.com> # # This file is part of cloud-init. See LICENSE file for license information. from cloudinit import sources class DataSourceNone(sources.DataSource): dsname = "None" def __init__(self, sys_cfg, distro, paths, ud_proc=None): sources.DataSource.__init__(self, sys_cfg, distro, paths, ud_proc) self.metadata = {} self.userdata_raw = "" def _get_data(self): # If the datasource config has any provided 'fallback' # userdata or metadata, use it... if "userdata_raw" in self.ds_cfg: self.userdata_raw = self.ds_cfg["userdata_raw"] if "metadata" in self.ds_cfg: self.metadata = self.ds_cfg["metadata"] return True def _get_subplatform(self): """Return the subplatform metadata source details.""" return "config" def get_instance_id(self): return "iid-datasource-none" @property def is_disconnected(self): return True # Used to match classes to dependencies datasources = [ (DataSourceNone, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), (DataSourceNone, []), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceLXD.py 0000644 00000042277 15027667240 0007545 0 ustar 00 """Datasource for LXD, reads /dev/lxd/sock representation of instance data. Notes: * This datasource replaces previous NoCloud datasource for LXD. * Older LXD images may not have updates for cloud-init so NoCloud may still be detected on those images. * Detect LXD datasource when /dev/lxd/sock is an active socket file. * Info on dev-lxd API: https://linuxcontainers.org/lxd/docs/master/dev-lxd """ import os import socket import stat import time from enum import Flag, auto from json.decoder import JSONDecodeError from typing import Any, Dict, List, Optional, Tuple, Union, cast import requests from requests.adapters import HTTPAdapter # Note: `urllib3` is transitively installed by `requests`. from urllib3.connection import HTTPConnection from urllib3.connectionpool import HTTPConnectionPool from cloudinit import log as logging from cloudinit import sources, subp, url_helper, util from cloudinit.net import find_fallback_nic LOG = logging.getLogger(__name__) LXD_SOCKET_PATH = "/dev/lxd/sock" LXD_SOCKET_API_VERSION = "1.0" LXD_URL = "http://lxd" # Config key mappings to alias as top-level instance data keys CONFIG_KEY_ALIASES = { "cloud-init.user-data": "user-data", "cloud-init.network-config": "network-config", "cloud-init.vendor-data": "vendor-data", "user.user-data": "user-data", "user.network-config": "network-config", "user.vendor-data": "vendor-data", } def _get_fallback_interface_name() -> str: default_name = "eth0" if subp.which("systemd-detect-virt"): try: virt_type, _ = subp.subp(["systemd-detect-virt"]) except subp.ProcessExecutionError as err: LOG.warning( "Unable to run systemd-detect-virt: %s." " Rendering default network config.", err, ) return default_name if virt_type.strip() in ( "kvm", "qemu", ): # instance.type VIRTUAL-MACHINE arch = util.system_info()["uname"][4] if arch == "ppc64le": return "enp0s5" elif arch == "s390x": return "enc9" else: return "enp5s0" return default_name def generate_network_config( nics: Optional[List[str]] = None, ) -> Dict[str, Any]: """Return network config V1 dict representing instance network config.""" # TODO: The original intent of this function was to use the nics retrieved # from LXD's devices endpoint to determine the primary nic and write # that out to network config. However, for LXD VMs, the device name # may differ from the interface name in the VM, so we'll instead rely # on our fallback nic code. Once LXD's devices endpoint grows the # ability to provide a MAC address, we should rely on that information # rather than just the glorified guessing that we're doing here. primary_nic = find_fallback_nic() if primary_nic: LOG.debug( "LXD datasource generating network from discovered active" " device: %s", primary_nic, ) else: primary_nic = _get_fallback_interface_name() LOG.debug( "LXD datasource generating network from systemd-detect-virt" " platform default device: %s", primary_nic, ) return { "version": 1, "config": [ { "type": "physical", "name": primary_nic, "subnets": [{"type": "dhcp", "control": "auto"}], } ], } class SocketHTTPConnection(HTTPConnection): def __init__(self, socket_path): super().__init__("localhost") self.socket_path = socket_path def connect(self): self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) self.sock.connect(self.socket_path) class SocketConnectionPool(HTTPConnectionPool): def __init__(self, socket_path): self.socket_path = socket_path super().__init__("localhost") def _new_conn(self): return SocketHTTPConnection(self.socket_path) class LXDSocketAdapter(HTTPAdapter): def get_connection(self, url, proxies=None): return SocketConnectionPool(LXD_SOCKET_PATH) def _raw_instance_data_to_dict(metadata_type: str, metadata_value) -> dict: """Convert raw instance data from str, bytes, YAML to dict :param metadata_type: string, one of as: meta-data, vendor-data, user-data network-config :param metadata_value: str, bytes or dict representing or instance-data. :raises: InvalidMetaDataError on invalid instance-data content. """ if isinstance(metadata_value, dict): return metadata_value if metadata_value is None: return {} try: parsed_metadata = util.load_yaml(metadata_value) except AttributeError as exc: # not str or bytes raise sources.InvalidMetaDataException( "Invalid {md_type}. Expected str, bytes or dict but found:" " {value}".format(md_type=metadata_type, value=metadata_value) ) from exc if parsed_metadata is None: raise sources.InvalidMetaDataException( "Invalid {md_type} format. Expected YAML but found:" " {value}".format(md_type=metadata_type, value=metadata_value) ) return parsed_metadata class DataSourceLXD(sources.DataSource): dsname = "LXD" _network_config: Union[Dict, str] = sources.UNSET _crawled_metadata: Union[Dict, str] = sources.UNSET sensitive_metadata_keys: Tuple[ str, ... ] = sources.DataSource.sensitive_metadata_keys + ( "user.meta-data", "user.vendor-data", "user.user-data", "cloud-init.user-data", "cloud-init.vendor-data", ) skip_hotplug_detect = True def _unpickle(self, ci_pkl_version: int) -> None: super()._unpickle(ci_pkl_version) self.skip_hotplug_detect = True def _is_platform_viable(self) -> bool: """Check platform environment to report if this datasource may run.""" return is_platform_viable() def _get_data(self) -> bool: """Crawl LXD socket API instance data and return True on success""" if not self._is_platform_viable(): LOG.debug("Not an LXD datasource: No LXD socket found.") return False self._crawled_metadata = util.log_time( logfunc=LOG.debug, msg="Crawl of metadata service", func=read_metadata, ) self.metadata = _raw_instance_data_to_dict( "meta-data", self._crawled_metadata.get("meta-data") ) config = self._crawled_metadata.get("config", {}) user_metadata = config.get("user.meta-data", {}) if user_metadata: user_metadata = _raw_instance_data_to_dict( "user.meta-data", user_metadata ) if not isinstance(self.metadata, dict): self.metadata = util.mergemanydict( [util.load_yaml(self.metadata), user_metadata] ) if "user-data" in self._crawled_metadata: self.userdata_raw = self._crawled_metadata["user-data"] if "network-config" in self._crawled_metadata: self._network_config = _raw_instance_data_to_dict( "network-config", self._crawled_metadata["network-config"] ) if "vendor-data" in self._crawled_metadata: self.vendordata_raw = self._crawled_metadata["vendor-data"] return True def _get_subplatform(self) -> str: """Return subplatform details for this datasource""" return "LXD socket API v. {ver} ({socket})".format( ver=LXD_SOCKET_API_VERSION, socket=LXD_SOCKET_PATH ) def check_instance_id(self, sys_cfg) -> str: """Return True if instance_id unchanged.""" response = read_metadata(metadata_keys=MetaDataKeys.META_DATA) md = response.get("meta-data", {}) if not isinstance(md, dict): md = util.load_yaml(md) return md.get("instance-id") == self.metadata.get("instance-id") @property def network_config(self) -> dict: """Network config read from LXD socket config/user.network-config. If none is present, then we generate fallback configuration. """ if self._network_config == sources.UNSET: if self._crawled_metadata == sources.UNSET: self._get_data() if isinstance(self._crawled_metadata, dict): if self._crawled_metadata.get("network-config"): LOG.debug("LXD datasource using provided network config") self._network_config = self._crawled_metadata[ "network-config" ] elif self._crawled_metadata.get("devices"): # If no explicit network config, but we have net devices # available to us, find the primary and set it up. devices: List[str] = [ k for k, v in self._crawled_metadata["devices"].items() if v["type"] == "nic" ] self._network_config = generate_network_config(devices) if self._network_config == sources.UNSET: # We know nothing about network, so setup fallback LOG.debug( "LXD datasource generating network config using fallback." ) self._network_config = generate_network_config() return cast(dict, self._network_config) def is_platform_viable() -> bool: """Return True when this platform appears to have an LXD socket.""" if os.path.exists(LXD_SOCKET_PATH): return stat.S_ISSOCK(os.lstat(LXD_SOCKET_PATH).st_mode) return False def _get_json_response( session: requests.Session, url: str, do_raise: bool = True ): url_response = _do_request(session, url, do_raise) if not url_response.ok: LOG.debug( "Skipping %s on [HTTP:%d]:%s", url, url_response.status_code, url_response.text, ) return {} try: return url_response.json() except JSONDecodeError as exc: raise sources.InvalidMetaDataException( "Unable to process LXD config at {url}." " Expected JSON but found: {resp}".format( url=url, resp=url_response.text ) ) from exc def _do_request( session: requests.Session, url: str, do_raise: bool = True ) -> requests.Response: for retries in range(30, 0, -1): response = session.get(url) if 500 == response.status_code: # retry every 0.1 seconds for 3 seconds in the case of 500 error # tis evil, but it also works around a bug time.sleep(0.1) LOG.warning( "[GET] [HTTP:%d] %s, retrying %d more time(s)", response.status_code, url, retries, ) else: break LOG.debug("[GET] [HTTP:%d] %s", response.status_code, url) if do_raise and not response.ok: raise sources.InvalidMetaDataException( "Invalid HTTP response [{code}] from {route}: {resp}".format( code=response.status_code, route=url, resp=response.text, ) ) return response class MetaDataKeys(Flag): NONE = auto() CONFIG = auto() DEVICES = auto() META_DATA = auto() ALL = CONFIG | DEVICES | META_DATA class _MetaDataReader: def __init__(self, api_version: str = LXD_SOCKET_API_VERSION): self.api_version = api_version self._version_url = url_helper.combine_url(LXD_URL, self.api_version) def _process_config(self, session: requests.Session) -> dict: """Iterate on LXD API config items. Promoting CONFIG_KEY_ALIASES Any CONFIG_KEY_ALIASES which affect cloud-init behavior are promoted as top-level configuration keys: user-data, network-data, vendor-data. LXD's cloud-init.* config keys override any user.* config keys. Log debug messages if any user.* keys are overridden by the related cloud-init.* key. """ config: dict = {"config": {}} config_url = url_helper.combine_url(self._version_url, "config") # Represent all advertized/available config routes under # the dict path {LXD_SOCKET_API_VERSION: {config: {...}}. config_routes = _get_json_response(session, config_url) # Sorting keys to ensure we always process in alphabetical order. # cloud-init.* keys will sort before user.* keys which is preferred # precedence. for config_route in sorted(config_routes): config_route_url = url_helper.combine_url(LXD_URL, config_route) config_route_response = _do_request( session, config_route_url, do_raise=False ) if not config_route_response.ok: LOG.debug( "Skipping %s on [HTTP:%d]:%s", config_route_url, config_route_response.status_code, config_route_response.text, ) continue cfg_key = config_route.rpartition("/")[-1] # Leave raw data values/format unchanged to represent it in # instance-data.json for cloud-init query or jinja template # use. config["config"][cfg_key] = config_route_response.text # Promote common CONFIG_KEY_ALIASES to top-level keys. if cfg_key in CONFIG_KEY_ALIASES: # Due to sort of config_routes, promote cloud-init.* # aliases before user.*. This allows user.* keys to act as # fallback config on old LXD, with new cloud-init images. if CONFIG_KEY_ALIASES[cfg_key] not in config: config[ CONFIG_KEY_ALIASES[cfg_key] ] = config_route_response.text else: LOG.warning( "Ignoring LXD config %s in favor of %s value.", cfg_key, cfg_key.replace("user", "cloud-init", 1), ) return config def __call__(self, *, metadata_keys: MetaDataKeys) -> dict: with requests.Session() as session: session.mount(self._version_url, LXDSocketAdapter()) # Document API version read md: dict = {"_metadata_api_version": self.api_version} if MetaDataKeys.META_DATA in metadata_keys: md_route = url_helper.combine_url( self._version_url, "meta-data" ) md["meta-data"] = _do_request(session, md_route).text if MetaDataKeys.CONFIG in metadata_keys: md.update(self._process_config(session)) if MetaDataKeys.DEVICES in metadata_keys: url = url_helper.combine_url(self._version_url, "devices") devices = _get_json_response(session, url, do_raise=False) if devices: md["devices"] = devices return md def read_metadata( api_version: str = LXD_SOCKET_API_VERSION, metadata_keys: MetaDataKeys = MetaDataKeys.ALL, ) -> dict: """Fetch metadata from the /dev/lxd/socket routes. Perform a number of HTTP GETs on known routes on the devlxd socket API. Minimally all containers must respond to <LXD_SOCKET_API_VERSION>/meta-data when the LXD configuration setting `security.devlxd` is true. When `security.devlxd` is false, no /dev/lxd/socket file exists. This datasource will return False from `is_platform_viable` in that case. Perform a GET of <LXD_SOCKET_API_VERSION>/config` and walk all `user.*` configuration keys, storing all keys and values under a dict key LXD_SOCKET_API_VERSION: config {...}. In the presence of the following optional user config keys, create top level aliases: - user.user-data -> user-data - user.vendor-data -> vendor-data - user.network-config -> network-config :param api_version: LXD API version to operated with. :param metadata_keys: Instance of `MetaDataKeys` indicating what keys to fetch. :return: A dict with the following optional keys: meta-data, user-data, vendor-data, network-config, network_mode, devices. Below <LXD_SOCKET_API_VERSION> is a dict representation of all raw configuration keys and values provided to the container surfaced by the socket under the /1.0/config/ route. """ return _MetaDataReader(api_version=api_version)( metadata_keys=metadata_keys ) # Used to match classes to dependencies datasources = [ (DataSourceLXD, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) if __name__ == "__main__": import argparse description = """Query LXD metadata and emit a JSON object.""" parser = argparse.ArgumentParser(description=description) parser.parse_args() print(util.json_dumps(read_metadata(metadata_keys=MetaDataKeys.ALL))) # vi: ts=4 expandtab DataSourceDigitalOcean.py 0000644 00000007500 15027667240 0011427 0 ustar 00 # Author: Neal Shrader <neal@digitalocean.com> # Author: Ben Howard <bh@digitalocean.com> # # This file is part of cloud-init. See LICENSE file for license information. # DigitalOcean Droplet API: # https://developers.digitalocean.com/documentation/metadata/ import cloudinit.sources.helpers.digitalocean as do_helper from cloudinit import log as logging from cloudinit import sources, util LOG = logging.getLogger(__name__) BUILTIN_DS_CONFIG = { "metadata_url": "http://169.254.169.254/metadata/v1.json", } # Wait for a up to a minute, retrying the meta-data server # every 2 seconds. MD_RETRIES = 30 MD_TIMEOUT = 2 MD_WAIT_RETRY = 2 MD_USE_IPV4LL = True class DataSourceDigitalOcean(sources.DataSource): dsname = "DigitalOcean" def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.distro = distro self.metadata = dict() self.ds_cfg = util.mergemanydict( [ util.get_cfg_by_path( sys_cfg, ["datasource", "DigitalOcean"], {} ), BUILTIN_DS_CONFIG, ] ) self.metadata_address = self.ds_cfg["metadata_url"] self.retries = self.ds_cfg.get("retries", MD_RETRIES) self.timeout = self.ds_cfg.get("timeout", MD_TIMEOUT) self.use_ip4LL = self.ds_cfg.get("use_ip4LL", MD_USE_IPV4LL) self.wait_retry = self.ds_cfg.get("wait_retry", MD_WAIT_RETRY) self._network_config = None def _get_sysinfo(self): return do_helper.read_sysinfo() def _get_data(self): (is_do, droplet_id) = self._get_sysinfo() # only proceed if we know we are on DigitalOcean if not is_do: return False LOG.info("Running on DigitalOcean. droplet_id=%s", droplet_id) ipv4LL_nic = None if self.use_ip4LL: ipv4LL_nic = do_helper.assign_ipv4_link_local(self.distro) md = do_helper.read_metadata( self.metadata_address, timeout=self.timeout, sec_between=self.wait_retry, retries=self.retries, ) self.metadata_full = md self.metadata["instance-id"] = md.get("droplet_id", droplet_id) self.metadata["local-hostname"] = md.get("hostname", droplet_id) self.metadata["interfaces"] = md.get("interfaces") self.metadata["public-keys"] = md.get("public_keys") self.metadata["availability_zone"] = md.get("region", "default") self.vendordata_raw = md.get("vendor_data", None) self.userdata_raw = md.get("user_data", None) if ipv4LL_nic: do_helper.del_ipv4_link_local(ipv4LL_nic) return True def check_instance_id(self, sys_cfg): return sources.instance_id_matches_system_uuid( self.get_instance_id(), "system-serial-number" ) @property def network_config(self): """Configure the networking. This needs to be done each boot, since the IP information may have changed due to snapshot and/or migration. """ if self._network_config: return self._network_config interfaces = self.metadata.get("interfaces") LOG.debug(interfaces) if not interfaces: raise Exception("Unable to get meta-data from server....") nameservers = self.metadata_full["dns"]["nameservers"] self._network_config = do_helper.convert_network_configuration( interfaces, nameservers ) return self._network_config # Used to match classes to dependencies datasources = [ (DataSourceDigitalOcean, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceBigstep.py 0000644 00000003654 15027667240 0010507 0 ustar 00 # Copyright (C) 2015-2016 Bigstep Cloud Ltd. # # Author: Alexandru Sirbu <alexandru.sirbu@bigstep.com> # # This file is part of cloud-init. See LICENSE file for license information. import errno import json import os from cloudinit import sources, url_helper, util class DataSourceBigstep(sources.DataSource): dsname = "Bigstep" def __init__(self, sys_cfg, distro, paths): super().__init__(sys_cfg, distro, paths) self.metadata = {} self.vendordata_raw = "" self.userdata_raw = "" def _get_data(self, apply_filter=False) -> bool: url = self._get_url_from_file() if url is None: return False response = url_helper.readurl(url) decoded = json.loads(response.contents.decode()) self.metadata = decoded["metadata"] self.vendordata_raw = decoded["vendordata_raw"] self.userdata_raw = decoded["userdata_raw"] return True def _get_subplatform(self) -> str: """Return the subplatform metadata source details.""" return f"metadata ({self._get_url_from_file()})" def _get_url_from_file(self): url_file = os.path.join( self.paths.cloud_dir, "data", "seed", "bigstep", "url" ) try: content = util.load_file(url_file) except IOError as e: # If the file doesn't exist, then the server probably isn't a # Bigstep instance; otherwise, another problem exists which needs # investigation if e.errno == errno.ENOENT: return None else: raise return content # Used to match classes to dependencies datasources = [ (DataSourceBigstep, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab helpers/__pycache__/upcloud.cpython-310.pyc 0000644 00000012677 15027667240 0014620 0 ustar 00 o �Ad � @ sh d dl Z d dlmZ d dlmZ d dlmZ d dlmZ e�e �Z dd� Z dd � Z dd d �Z dd� ZdS )� N)�dmi)�log)�net)� url_helperc C s dd� }g }t �� }t�d|� | �d�D ]U}t�d|� |�d�}||vr.td||f ��|�d�}|�|�}t�d ||||�d �� d ||d �}g } |�d �D ]} || | �d��} | �| � qQ| |d< |�|� q| �d�r�t�d| �d�� |�d| �d�d�� d|d�S )aC Convert the UpCloud network metadata description into Cloud-init's version 1 netconfig format. Example JSON: { "interfaces": [ { "index": 1, "ip_addresses": [ { "address": "94.237.105.53", "dhcp": true, "dns": [ "94.237.127.9", "94.237.40.9" ], "family": "IPv4", "floating": false, "gateway": "94.237.104.1", "network": "94.237.104.0/22" }, { "address": "94.237.105.50", "dhcp": false, "dns": [], "family": "IPv4", "floating": true, "gateway": "", "network": "94.237.105.50/32" } ], "mac": "32:d5:ba:4a:36:e7", "network_id": "031457f4-0f8c-483c-96f2-eccede02909c", "type": "public" }, { "index": 2, "ip_addresses": [ { "address": "10.6.3.27", "dhcp": true, "dns": [], "family": "IPv4", "floating": false, "gateway": "10.6.0.1", "network": "10.6.0.0/22" } ], "mac": "32:d5:ba:4a:84:cc", "network_id": "03d82553-5bea-4132-b29a-e1cf67ec2dd1", "type": "utility" }, { "index": 3, "ip_addresses": [ { "address": "2a04:3545:1000:720:38d6:baff:fe4a:63e7", "dhcp": true, "dns": [ "2a04:3540:53::1", "2a04:3544:53::1" ], "family": "IPv6", "floating": false, "gateway": "2a04:3545:1000:720::1", "network": "2a04:3545:1000:720::/64" } ], "mac": "32:d5:ba:4a:63:e7", "network_id": "03000000-0000-4000-8046-000000000000", "type": "public" }, { "index": 4, "ip_addresses": [ { "address": "172.30.1.10", "dhcp": true, "dns": [], "family": "IPv4", "floating": false, "gateway": "172.30.1.1", "network": "172.30.1.0/24" } ], "mac": "32:d5:ba:4a:8a:e1", "network_id": "035a0a4a-77b4-4de5-820d-189fc8135714", "type": "private" } ], "dns": [ "94.237.127.9", "94.237.40.9" ] } c S s� | � d�rd}| � d�dkrd}d|iS d}| � d�dkr d}|d| � d �d �}| � d �r4| � d �|d < d | � d �v rG| � d ��d �d |d< || � d�krZ| � d�rZ| � d�|d< |S )N�dhcp�family�IPv6zipv6_dhcpv6-stateless�type�static�static6�auto�address)r �controlr �gateway�/�network� �netmask�dns�dns_nameservers)�get�split)�ip_addrr � dhcp_type� static_type�subpart� r �C/usr/lib/python3/dist-packages/cloudinit/sources/helpers/upcloud.py�_get_subnet_configr s& � z8convert_to_network_config_v1.<locals>._get_subnet_configzNIC mapping: %s� interfaceszConsidering %s�maczVDid not find network interface on system with mac '%s'. Cannot apply configuration: %sr z4Found %s interface '%s' with address '%s' (index %d)�index�physical)r �name� mac_address� ip_addressesr �subnetsz Setting DNS nameservers to %s� nameserver)r r r )�version�config)�cloudnet�get_interfaces_by_mac�LOG�debugr � RuntimeError�append) r) r � nic_configs�macs_to_interfaces� raw_ifacer$ � iface_type� sysfs_name� interfacer& � ip_address�sub_partr r r � convert_to_network_config_v1 sL c �� � � � r8 c C s t | �S )N)r8 )r) r r r �convert_network_config� s r9 � � c C s6 t j| |||d�}|�� std| ��t�|j�� �S )N)�timeout� sec_between�retriesz unable to read metadata at %s)r �readurl�okr. �json�loads�contents�decode)�urlr< r= r> �responser r r � read_metadata� s � rG c C sN t �d�} | dkr dS t �d�}|r t�d|� d|fS d}t�|� t|��)Nzsystem-manufacturer�UpCloud)FNz system-uuidz2system identified via SMBIOS as UpCloud server: %sz�system identified via SMBIOS as a UpCloud server, but did not provide an ID. Please contact support viahttps://hub.upcloud.com or via email with support@upcloud.comT)r � read_dmi_datar, r- �criticalr. )� vendor_name� server_uuid�msgr r r � read_sysinfo� s � �� rN )r: r: r; )rA � cloudinitr r �loggingr r* r � getLogger�__name__r, r8 r9 rG rN r r r r �<module> s 2 helpers/__pycache__/__init__.cpython-310.pyc 0000644 00000000241 15027667240 0014664 0 ustar 00 o �Ad � @ s d S )N� r r r �D/usr/lib/python3/dist-packages/cloudinit/sources/helpers/__init__.py�<module> s helpers/__pycache__/openstack.cpython-310.pyc 0000644 00000042422 15027667240 0015123 0 ustar 00 o �Ad�e � @ s: d dl Z d dlZd dlZd dlZd dlZd dlmZ d dlmZm Z m Z m Z m Z d dl mZ d dlmZ e�e�Zddd� d fd e ji fd d d� d fd �ZdZdZdZdZdZdZdZ dZ dZ dZ eeeee e e e fZ dZ!G dd� de"�Z#G dd � d �Z$G d d � d e j%d �Z&G d d!� d!e&�Z'G d"d#� d#e&�Z(d&d$d%�Z)dS )'� N)�log)�net�sources�subp� url_helper�util)�BrokenMetadata)�ec2�network_configc C � | S �N� ��xr r �E/usr/lib/python3/dist-packages/cloudinit/sources/helpers/openstack.py�<lambda> � r � �meta_js�authorized_keysc C r r r r r r r r r )zetc/network/interfaceszmeta.jszroot/.ssh/authorized_keys))zlocal-hostname�hostnameF)� instance-id�uuidT�latestz 2012-08-10z 2013-04-04z 2013-10-17z 2015-10-15z 2016-06-30z 2016-10-06z 2017-02-22z 2018-08-27) N�bgpovs�bridge� cascading�dvs�ethernet�hw_veb�hyperv�ovs�phy�tap� vhostuser�vifc @ s e Zd ZdS )� NonReadableN)�__name__� __module__� __qualname__r r r r r& Q s r& c @ s4 e Zd Zdd� Zdd� Zdd� Zdd� Zd d � Zd S ) � SourceMixinc C s> | j sd S | j �di �}|�� D ] \}}||kr | S qd S )Nzblock-device-mapping)� ec2_metadata�get�items)�self�name�bdm�ent_name�devicer r r �_ec2_name_to_deviceV s �z SourceMixin._ec2_name_to_devicec C s$ d}| j dkr d}t�| j�|��S )N� public_keys� � public-keys)�versionr �normalize_pubkey_data�metadatar, )r. r/ r r r �get_public_ssh_keys_ s z SourceMixin.get_public_ssh_keysc C sV d }z d| }|dkrd| }t �|�}|r |d }W |S W |S tjy* Y |S w )NzLABEL=%s�swapzTYPE=%sr )r �find_devs_withr �ProcessExecutionError)r. r/ r2 �criteria� dev_entriesr r r �_os_name_to_devicee s ���z SourceMixin._os_name_to_devicec C sV |sd S |� d�s d| }tj�|�r|S | �tj�|��}|r)t�d||� |S d S )N�/z/dev/%sz Remapped device name %s => %s)� startswith�os�path�exists� _remap_device�basename�LOG�debug)r. r2 �remappedr r r �_validate_device_namer s z!SourceMixin._validate_device_namec C s� |sd S |g}|dkr|� dd� |dkr|�d� d }t�d|� |D ]}| �|�}| �|�}|r4 nq$|sPt�d|� |D ]}| �|�}| �|�}|rO nq?|sTd S t�d||� |S )N�rootr �amiz(Using ec2 style lookup to find device %sz.Using openstack style lookup to find device %szMapped %s to device %s)�insert�appendrH rI r3 rK r@ )r. r/ �namesr2 �nr r r �device_name_to_device� s6 � �z!SourceMixin.device_name_to_deviceN)r' r( r) r3 r: r@ rK rR r r r r r* U s r* c @ sh e Zd Zdd� Zejdd� �Zejddd��Zejdd � �Zejd d � �Z d d � Z ddd�Z dd� Z dS )� BaseReaderc C s || _ d S r )� base_path�r. rT r r r �__init__� s zBaseReader.__init__c G � d S r r �r. �base�add_onsr r r � _path_join� � zBaseReader._path_joinFc C rW r r �r. rD �decoder r r � _path_read� r\ zBaseReader._path_readc C rW r r �r. r r r �_fetch_available_versions� r\ z$BaseReader._fetch_available_versionsc C rW r r r` r r r �_read_ec2_metadata� r\ z BaseReader._read_ec2_metadatac C s� z| � � }W n ty" } zt�d| j|� g }W Y d }~nd }~ww dd� ttt��D �}t}|D ] }||vr9q2|} t�d||� |S )Nz4Unable to read openstack versions from %s due to: %sc S s g | ]}|�qS r r )�.0�vr r r � <listcomp>� s z4BaseReader._find_working_version.<locals>.<listcomp>z Selected version '%s' from %s) ra � ExceptionrH rI rT �reversed�list� OS_VERSIONS� OS_LATEST)r. �versions_available�e� supported�selected_version�potential_versionr r r �_find_working_version� s0 ��� �z BaseReader._find_working_versionc C s^ |� dd��d�}|�d�}dd� |D �}|s td| ��| j| jdg|�R � }| j||d�S ) N� content_pathr rA c S s g | ]}t |�r|�qS r )�len)rc �pr r r re � s z1BaseReader._read_content_path.<locals>.<listcomp>z!Item %s has no valid content path� openstack�r^ )r, �lstrip�splitr r[ rT r_ )r. �itemr^ rD � path_pieces� valid_piecesr r r �_read_content_path� s z BaseReader._read_content_pathc s� t jtjtttfd�� � �fdd�}ddd�}|��� �}|�� D ]o\}\}}}�� �j |�}d}d}z�� |�}W n# t y] } z|sLt �d || � nt �d || � W Y d} ~ nd} ~ ww d }|rj|sjtd | ��|r�|r�z||�}W n ty� } z td || f �| �d} ~ ww |r�|||< q!|d } d| v r�| d } z t�| �| d< W n ttfy� } ztd| �| �d} ~ ww i } | �dg �} | D ])}d|vr�q�|d }z ��|�| |< W q� ty� } z td|| f �| �d} ~ ww | |d< | �dd�}|�r z �j|d d�}||d< W n t �y } ztd| �| �d} ~ ww z | d d |d< W n t�y3 Y nw ��� |d< tD ] \}}}|�rO|| v�rOtd| ��|| v �r[| �|�| |< �q<|S )z�Reads a version 2 formatted location. Return a dict with metadata, userdata, ec2-metadata, dsmode, network_config, files and version (2). If not a valid location, raise a NonReadable exception. )� root_typesc s� i }�� d| d�dtjf|d< �� d| d�ddd� f|d < �� d| d �d� f|d < �� d| d �d� f|d < �� d| d�d� f|d< |S )Nrt zmeta_data.jsonTr9 � user_dataFc S r r r r r r r r � r z7BaseReader.read_v2.<locals>.datafiles.<locals>.<lambda>�userdatazvendor_data.json� vendordatazvendor_data2.json� vendordata2znetwork_data.json� networkdata)r[ r � load_json)r7 �files��load_json_anytyper. r r � datafiles� s, � � � � �z%BaseReader.read_v2.<locals>.datafilesr � )r~ r7 NFz*Failed reading optional path %s due to: %sz+Failed reading mandatory path %s due to: %sTzMissing mandatory path: %s� Failed to process path %s: %sr9 � random_seedz.Badly formatted metadata random_seed entry: %sr� rD z#Failed to read provided file %s: %sr ru z(Failed to read network configuration: %s�meta�dsmodez ec2-metadatazNo '%s' entry in metadata)� functools�partialr r� �dictrh �strrp r- r[ rT r_ �IOErrorrH rI r& rf r �base64� b64decode� ValueError� TypeErrorr, r{ �KeyErrorrb � KEY_COPIES)r. r� �results�datar/ rD �required� translator�foundrl r9 r� r� �metadata_filesrx �net_item�content� target_key� source_key� is_requiredr r� r �read_v2� s� �!� ���� ��������� ���� ���� � �zBaseReader.read_v2N�F) r' r( r) rV �abc�abstractmethodr[ r_ ra rb rp r{ r� r r r r rS � s rS )� metaclassc sF e Zd Z� fdd�Zdd� Zddd�Zdd � Zd d � Zd d � Z� Z S )�ConfigDriveReaderc s t t| ��|� d | _d S r )�superr� rV � _versionsrU �� __class__r r rV f s zConfigDriveReader.__init__c G s |gt |� }tjj|� S r )rh rC rD �join)r. rY rZ � componentsr r r r[ j s z ConfigDriveReader._path_joinFc C s t j||d�S )Nru )r � load_filer] r r r r_ n s z ConfigDriveReader._path_readc s@ | j d u r | �| jd�� � fdd�t�� �D �}t|�| _ | j S )Nrt c s$ g | ]}t j�t j�� ��r|�qS r )rC rD �isdirr� �rc �d�rD r r re t s ��z?ConfigDriveReader._fetch_available_versions.<locals>.<listcomp>)r� r[ rT rC �listdir�sorted)r. r� r r� r ra q s � z+ConfigDriveReader._fetch_available_versionsc C s` | � | jddd�}tj�|�si S z t�| �|��W S ty/ } z t d||f �|�d }~ww )Nr r zmeta-data.jsonr� ) r[ rT rC rD rE r r� r_ rf r )r. rD rl r r r rb | s � ����z$ConfigDriveReader._read_ec2_metadatac C s� i }t �� D ]}| �| j|�}tj�|�r|||< qt|�dkr'td| j ��i }t � � D ]O\}\}}}||v ru|| }z| � |�}W n t yV } zt d| �| �d} ~ ww z||�||< W q- t yt } z t d|| f �| �d} ~ ww t�|�||< q-|d } |d } | �d| �} | r�| �� } d d � | D �|d< d | v r�| d |d < d |d �} d| v r�| d | d< | �dd�| d< i | d< | S )z�Reads a version 1 formatted location. Return a dict with metadata, userdata, dsmode, files and version (1). If not a valid path, raise a NonReadable exception. r z%s: no files foundzFailed to read: %sNr� r r r6 c S s" g | ] }t |�r|�d �s|�qS )�#)rr rB )rc �liner r r re � s ���z-ConfigDriveReader.read_v1.<locals>.<listcomp>r r5 )r7 r9 r� z user-datar r~ r� )�FILES_V1�keysr[ rT rC rD rE rr r& r- r_ r� r rf �copy�deepcopyr, � splitlines)r. r� r/ rD �md�keyr� �default�contentsrl �keydatar �linesr� r r r �read_v1� s^ � �� ���� � � zConfigDriveReader.read_v1r� ) r' r( r) rV r[ r_ ra rb r� � __classcell__r r r� r r� e s r� c s@ e Zd Zd� fdd� Zdd� Zddd �Zd d � Zd d � Z� ZS )�MetadataReaderN� c s4 t t| ��|� || _t|�| _t|�| _d | _d S r ) r� r� rV � ssl_details�float�timeout�int�retriesr� )r. �base_urlr� r� r� r� r r rV � s zMetadataReader.__init__c C sb | j d ur| j S g }| �| jd�}| j|dd�}|�� D ]}|�� }|s%q |�|� q || _ | j S )Nrt Tru )r� r[ rT r_ r� �striprO )r. r� � version_pathr� r� r r r ra � s z(MetadataReader._fetch_available_versionsFc C s6 dd� }t j|| j| j| j|d�}|r|j�� S |jS )Nc S s8 zt |j�}|dkr W dS W dS ttfy Y dS w )Ni� FT)r� �coder� r� )� _request_args�causer� r r r �should_retry_cb� s ���z2MetadataReader._path_read.<locals>.should_retry_cb)r� r� r� � exception_cb)r �readurlr� r� r� r� r^ )r. rD r^ r� �responser r r r_ � s � zMetadataReader._path_readc G s t j|g|�R � S r )r � combine_urlrX r r r r[ s zMetadataReader._path_joinc C s t j| j| j| jd�S )N)r� r� r� )r �get_instance_metadatar� r� r� r` r r r rb s �z!MetadataReader._read_ec2_metadata)Nr� r� r� ) r' r( r) rV ra r_ r[ rb r� r r r� r r� � s r� c s� | du rdS g d�g d�d��| � dg �}| � dg �}| � dg �}g }i �d}d }g }|D �]��g } t�fd d ���� D ��} d �v rI�d | d < d} �� d �r]�� d ��� } | ��d < | � d �| �d �d d�} �fdd�|D �D ]�} t�fdd �| �� D ��}| d dkr�|�ddi� nH| d dkr�|�ddi� n:| d dv r�|�d| d i� n*| d dv r�|�d| � d�d �� n| d d v r�| �d d i� |�d | � d�d �� | d d!v r�| �d d"i� | d d#kr�d"|d#< | d d$kr�d"|d$< | �|� qt| �d%| i� �d d&v �rXi }| �r| |d'< ��� D ]\}}|d(k�r&�q|�d)��r3|�||i� �q|| }|d*7 }|�| d+d,t��d( �f� | �||d-�� || d < nZ�d d.v �r�d/�d0 �d1 f }| �|�d1 �d2 d3�� |�| d0d,�d0 f� |�| d d4�d1 �d0 f� | ��d2 |d5�� n�d t v�r�t � d6�d � | �d7| d8�� |�| � | �| d < q-d9d� |D �}|�s�|�rE|du �r�t � � }��� D ] \}}|� d ��r�q�|� d:�|v �r�||d: |d < �q�|D ]"}|� d'�}|�std;| ��||v�rtd<| ��|| |d < �q�|D ]'\} }� }t|ttf��r9� �fd=d�|D �| |< �q � �| d | |< �q t �� }|�re|D ]} | d |v �rc|| d | d'< d>| d< �qN|D ]} | } | �dd?i� |�| � �qgd*|d@�S )Aa) Return a dictionary of network_config by parsing provided OpenStack ConfigDrive NetworkData json format OpenStack network_data.json provides a 3 element dictionary - "links" (links are network devices, physical or virtual) - "networks" (networks are ip network configurations for one or more links) - services (non-ip services, like dns) networks and links are combined via network items referencing specific links via a 'link_id' which maps to a links 'id' field. To convert this format to network_config yaml, we first iterate over the links and then walk the network list to determine if any of the networks utilize the current link; if so we generate a subnet entry for the device We also need to map network_data.json fields to network_config fields. For example, the network_data links 'id' field is equivalent to network_config 'name' field for devices. We apply more of this mapping to the various link types that we encounter. There are additional fields that are populated in the network_data.json from OpenStack that are not relevant to network_config yaml, so we enumerate a dictionary of valid keys for network_yaml and apply filtering to drop these superflous keys from the network_config yaml. N)r/ �type� mac_address�subnets�params�mtu) r� �address�netmask� broadcast�metric�gateway� pointopoint�scope�dns_nameservers� dns_search�routes)�physical�subnet�links�networks�serviceszbond%dr c 3 �( � | ]\}}|� d v r||fV qdS )r� Nr �rc �krd �� valid_keysr r � <genexpr>P � � �z#convert_net_json.<locals>.<genexpr>r/ �ethernet_mac_address�idr� )r/ �macr� r� c s g | ] }|d � d kr|�qS )�linkr� r )rc rQ )r� r r re f s z$convert_net_json.<locals>.<listcomp>c 3 r� )r� Nr r� r� r r r� g r� � ipv4_dhcp�dhcp4� ipv6_dhcp�dhcp6)� ipv6_slaaczipv6_dhcpv6-stateless�ipv6_dhcpv6-stateful)�ipv4�staticr� � ip_address)r� r� )�ipv6�static6z accept-raFr )r� r� Tr� r� r� )�bondr� � bond_linksr r5 �bond_interfacesz%s)r� r/ )�vlanz%s.%s� vlan_link�vlan_id�vlan_mac_address)r/ r r� z%%s.%s)r� r/ z9Unknown network_data link type (%s); treating as physicalr� )r� r� c S s& g | ]}|� d �dkrd|vr|�qS )r� r� r/ )r, r� r r r re � s r� z#No mac_address or name entry for %sz"Unable to find a system nic for %sc s g | ] }� �| d �qS )r/ r )rc �target)�fmt� link_id_infor r re � s �� infiniband� nameserver)r7 �config)r, r� r- �lower�updaterO rB r� r� �KNOWN_PHYSICAL_TYPESrH �warningr �get_interfaces_by_macr� � isinstancerh �tuple�get_ib_hwaddrs_by_interface) � network_json� known_macsr� r� r� � link_updates� bond_name_fmt� bond_numberr r� �cfg� link_mac_addr�curinfo�networkr� r� r� rd � link_namer/ � need_names�_link_id�infor� r� r� �targets�ib_known_hwaddrs�servicer )r r� r r� r �convert_net_json s � � � � �� �� � �� ���� � � �� r& )NN)*r� r� r� r� rC � cloudinitr �loggingr r r r r �cloudinit.sourcesr �cloudinit.sources.helpersr � getLoggerr' rH r� r� r� rj � OS_FOLSOM� OS_GRIZZLY� OS_HAVANA� OS_LIBERTY� OS_NEWTON_ONE� OS_NEWTON_TWO�OS_OCATA�OS_ROCKYri r r� r& r* �ABCMetarS r� r� r& r r r r �<module> sR �� L Eo: helpers/__pycache__/ec2.cpython-310.pyc 0000644 00000013727 15027667240 0013613 0 ustar 00 o �Ad�" � @ s� d dl Z d dlZd dlmZ d dlmZmZ e�e�Z e ej g�Z G dd� d�Z G dd� d�Zdd � Z dd d�Z ddd�Z ddd�Z ddd�ZdS )� N)�log)� url_helper�utilc @ s e Zd ZdZdd� Zdd� ZdS )�MetadataLeafDecoderz.Decodes a leaf blob into something meaningful.c C s, |sdS |� � }|�d�r|�d�rdS dS )NF�{�}T)�strip� startswith�endswith)�self�text� r �?/usr/lib/python3/dist-packages/cloudinit/sources/helpers/ec2.py�_maybe_json_object s z&MetadataLeafDecoder._maybe_json_objectc C s� |sdS zt �|�}W n ty | Y S w | �|�r>zt�|�W S ttfy= } z t� d||� W Y d }~nd }~ww |� d�dkrI|� � S |S )N� z6Field %s looked like a json object, but it was not: %s� ���) r � decode_binary�UnicodeDecodeErrorr �json�loads� ValueError� TypeError�LOG�warning�find� splitlines)r �field�blob�er r r �__call__ s* � ���z MetadataLeafDecoder.__call__N)�__name__� __module__� __qualname__�__doc__r r r r r r r s r c @ s. e Zd Zd dd�Zdd� Zdd� Zdd � ZdS ) �MetadataMaterializerNc C s6 || _ d | _|| _|| _|d u rt� | _d S || _d S �N)�_blob�_md� _base_url�_callerr � _leaf_decoder)r r �base_url�caller� leaf_decoderr r r �__init__7 s z MetadataMaterializer.__init__c C s� i }g }t �|�}|s||fS dd� }dd� }|�� D ]G}|�� }||�}|r)|s*q|dkr/q||�r=||vr<|�|� q|�dd�}|} t|�dkr^|\} } t �| �} | d ur^d| } | }| ||< q||fS ) Nc S s | � d�rdS dS )N�/TF)r ��itemr r r � has_childrenI s z1MetadataMaterializer._parse.<locals>.has_childrenc S s | � d�r | �d�S | S )Nr0 )r �rstripr1 r r r �get_nameO s z-MetadataMaterializer._parse.<locals>.get_namezsecurity-credentials�=� z%s/openssh-key)r r r r �append�split�len�safe_int) r r �leaves�childrenr3 r5 r � field_name�contents�resource�ident� sub_contentsr r r �_parseA s8 � zMetadataMaterializer._parsec C s( | j d ur| j S | �| j| j�| _ | j S r& )r( � _materializer' r) )r r r r � materializel s z MetadataMaterializer.materializec C s� | � |�\}}i }|D ] }t�||�}|�d�s |d7 }| �|�}| �||�||< q i } |�� D ]\} } t�|| �} | �| �} | �| | �| | < q0i }|�|� | � � D ]} | |v r`t � d|� qS| | || < qS|S )Nr0 z&Duplicate key found in results from %s) rC r � combine_urlr r* rD �itemsr+ �update�keysr r )r r r, r< r= �child_contents�c� child_url� child_blob� leaf_contentsr r@ �leaf_url� leaf_blob�joinedr r r rD r s( z!MetadataMaterializer._materializer& )r! r" r# r/ rC rE rD r r r r r% 6 s + r% c C s |j | vS )z/Returns False if cause.code is in status_codes.)�code)� status_codes� _request_args�causer r r �skip_retry_on_codes� s rV �latest�http://169.254.169.254� c C s� t �|| �}t �|d�}d} z|st�tt�}t j|||||||d�} | j} W | S t jyO } z| j tvrDt � t d|� W Y d } ~ | S W Y d } ~ | S d } ~ w t y_ t � t d|� Y | S w )Nz user-datar )� ssl_details�timeout�retries� exception_cb� headers_cb�headers_redactz$Failed fetching userdata from url %s)r rF � functools�partialrV �SKIP_USERDATA_CODES�read_file_or_urlr? �UrlErrorrR r �logexcr � Exception) � api_version�metadata_addressrZ r[ r\ r^ r_ r] �ud_url� user_data�responser r r r �get_instance_userdata� s< �� � �� ��rl c s� t �||| �} tjt j|||||| d�� � �fdd�} z� | �} t| j| | |d�}|�� }t|t �s4i }|W S t yI t � t d| | � i Y S w )N)rZ r[ r\ r^ r_ r] c sP z� | �j W S tjy' } z�r�|�s� t�d| � W Y d }~dS d }~ww )Nz&Skipped retrieval of the content of %sz (skipped))r? r rd r r )�urlr �r- � retrieval_exception_ignore_cbr r �mcaller� s �� ��z'_get_instance_metadata.<locals>.mcaller)r. z Failed fetching %s from url %s)r rF r` ra rc r% r? rE � isinstance�dictrf r re r )�treerg rh rZ r[ r\ r. r^ r_ r] ro �md_urlrp rk � materializer�mdr rn r �_get_instance_metadata� s0 � � �rw c C s t d| ||||||||| d� S )Nz meta-data/) rs rg rh rZ r[ r\ r. r_ r^ r] ro �rw ) rg rh rZ r[ r\ r. r^ r_ r] ro r r r �get_instance_metadata� s �ry c C s t d| ||||||||d� S )Nzdynamic/instance-identity) rs rg rh rZ r[ r\ r. r_ r^ r] rx ) rg rh rZ r[ r\ r. r^ r_ r] r r r �get_instance_identity s �rz )rW rX NrY rY NNN) rW rX NrY rY NNNNN) rW rX NrY rY NNNN)r` r � cloudinitr �loggingr r � getLoggerr! r � frozenset� NOT_FOUNDrb r r% rV rl rw ry rz r r r r �<module> sd #T �) �4 � � helpers/__pycache__/hetzner.cpython-310.pyc 0000644 00000002470 15027667240 0014612 0 ustar 00 o �Ad1 � @ sJ d dl Z d dlZd dlmZmZ d dd�Zd dd�Zd ed efd d �ZdS )� N)� url_helper�util� � c C s6 t j| |||d�}|�� std| ��t�|j�� �S )N��timeout� sec_between�retriesz unable to read metadata at %s)r �readurl�ok� RuntimeErrorr � load_yaml�contents�decode��urlr r r �response� r �C/usr/lib/python3/dist-packages/cloudinit/sources/helpers/hetzner.py� read_metadata s � r c C s, t j| |||d�}|�� std| ��|jS )Nr z unable to read userdata at %s)r r r r r r r r r � read_userdata s � r �data�returnc C sD t | t�s tdt| � ��ztj| dd�W S tjy! | Y S w )z�base64 decode data If data is base64 encoded bytes, return b64decode(data). If not, return data unmodified. @param data: data as bytes. TypeError is raised if not bytes. z data is '%s', expected bytesT)�validate)� isinstance�bytes� TypeError�type�base64� b64decode�binascii�Error)r r r r �maybe_b64decode s �r" )r r r ) r r � cloudinitr r r r r r" r r r r �<module> s helpers/__pycache__/digitalocean.cpython-310.pyc 0000644 00000014067 15027667240 0015563 0 ustar 00 o �Adr � @ s� d dl Z d dlZd dlmZ d dlmZ d dlmZ d dlmZm Z m Z ddd�Z e� e �Zdd d �Zd d � Zdd d�Zdd� Zddd�Zdd� ZdS )� N)�dmi)�log)�net)�subp� url_helper�util�eth0�eth1)�public�privatec C s� |s t | �}t�d|� |std��d�t�dd�t�dd��}dd d |d |g}dd d d |dg}t�d�s9td��zt�|� t�d||� t�|� t�d|� W |S t yc t � td||� � w )z�Bring up NIC using an address using link-local (ip4LL) IPs. On DigitalOcean, the link-local domain is per-droplet routed, so there is no risk of collisions. However, to be more safe, the ip4LL address is random. z,selected interface '%s' for reading metadatazPunable to find interfaces to access themeta-data server. This droplet is broken.z169.254.{0}.{1}/16� � r � �ip�addr�add�dev�link�set�upz4No 'ip' command available to configure ip4LL addressz#assigned ip4LL address '%s' to '%s'zbrought device '%s' upzRip4LL address assignment of '%s' to '%s' failed. Droplet networking will be broken) �get_link_local_nic�LOG�debug� RuntimeError�format�random�randintr �which� Exceptionr �logexc)�distro�nicr � ip_addr_cmd� ip_link_cmd� r$ �H/usr/lib/python3/dist-packages/cloudinit/sources/helpers/digitalocean.py�assign_ipv4_link_local s> �� � ���r& c s. � fdd�t �� D �}|sd S t|dd� d�S )Nc s g | ] }� j �|�r|�qS r$ )� networking� is_physical)�.0�f�r r$ r% � <listcomp>B s ��z&get_link_local_nic.<locals>.<listcomp>c S s t �| d�S )N�ifindex)�cloudnet�read_sys_net_int)�dr$ r$ r% �<lambda>I s z$get_link_local_nic.<locals>.<lambda>)�key)r. �get_devicelist�min)r �nicsr$ r+ r% r A s �r c C s~ | s t �d� dS t �d� dddd| g}zt�|� t �d| � W dS ty> } zt�t d | |� W Y d}~dS d}~ww ) zwRemove the ip4LL address. While this is not necessary, the ip4LL address is extraneous and confusing to users. zLno link_local address interface defined, skipping link local address cleanupNzcleaning up ipv4LL addressr r �flushr z removed ip4LL addresses from %sz)failed to remove ip4LL address from '%s'.)r r r r r r )r! r" �er$ r$ r% �del_ipv4_link_localL s � ��r8 c C sR dd� }g }t �� }t�d|� | D ]�}| | d }t�d|� |�d�}||vr1td||f ��|�|�}|�dd �} t�| |�} | |krPt�d | ||| � n d } t�| ||� d || d �} g } dD ] }|�|d�}|snqc||�}| dkszd|v r}|d= | �|� qc| | d< |�| � t�d| | � q|r�t�d|� |�d|d�� d|d�S )a} Convert the DigitalOcean Network description into Cloud-init's netconfig format. Example JSON: {'public': [ {'mac': '04:01:58:27:7f:01', 'ipv4': {'gateway': '45.55.32.1', 'netmask': '255.255.224.0', 'ip_address': '45.55.50.93'}, 'anchor_ipv4': { 'gateway': '10.17.0.1', 'netmask': '255.255.0.0', 'ip_address': '10.17.0.9'}, 'type': 'public', 'ipv6': {'gateway': '....', 'ip_address': '....', 'cidr': 64}} ], 'private': [ {'mac': '04:01:58:27:7f:02', 'ipv4': {'gateway': '10.132.0.1', 'netmask': '255.255.0.0', 'ip_address': '10.132.75.35'}, 'type': 'private'} ] } c S sZ dd| � d�| � d�d�}d| � d�v r$d�| � d�| � d��|d < |S | � d �|d < |S ) N�static�auto� ip_address�gateway)�type�control�addressr< �:z{0}/{1}�cidrr? �netmask)�getr )�pcfg�subpartr$ r$ r% �_get_subnet_part� s ���z7convert_network_configuration.<locals>._get_subnet_partznic mapping: %sr zconsidering %s�maczVDid not find network interface on system with mac '%s'. Cannot apply configuration: %sr= �unknownz6Found %s interface '%s' on '%s', assigned name of '%s'zfFound interface '%s' on '%s', which is not a public or private interface. Using default system naming.�physical)r= � mac_address�name)�ipv4�ipv6� anchor_ipv4� anchor_ipv6Nr �anchorr< �subnetsznic '%s' configuration: %szadded dns servers: %s� nameserver)r= r? r )�version�config)r. �get_interfaces_by_macr r rC r �NIC_MAP�append)rT � dns_serversrF � nic_configs� macs_to_nics�nr! rJ � sysfs_name�nic_type�if_name�msg�ncfgrQ �netdef� raw_subnet�sub_partr$ r$ r% � convert_network_configurationc s` �� � �� rd � � c C s6 t j| |||d�}|�� std| ��t�|j�� �S )N)�timeout� sec_between�retriesz unable to read metadata at %s)r �readurl�okr �json�loads�contents�decode)�urlrg rh ri �responser$ r$ r% � read_metadata� s � rr c C sN t �d�} | dkr dS t �d�}|r t�d|� d|fS d}t�|� t|��)Nzsystem-manufacturer� DigitalOcean)FNzsystem-serial-numberz8system identified via SMBIOS as DigitalOcean Droplet: %sz�system identified via SMBIOS as a DigitalOcean Droplet, but did not provide an ID. Please file a support ticket at: https://cloud.digitalocean.com/support/tickets/newT)r � read_dmi_datar r �criticalr )� vendor_name� droplet_idr_ r$ r$ r% � read_sysinfo� s ��� rx )N)re re rf )rl r � cloudinitr r �loggingr r. r r r rV � getLogger�__name__r r& r r8 rd rr rx r$ r$ r$ r% �<module> s / n helpers/__pycache__/netlink.cpython-310.pyc 0000644 00000023134 15027667240 0014577 0 ustar 00 o �Ad/ � @ sV d dl Z d dlZd dlZd dlZd dlmZ d dlmZ d dlm Z e� e �Z dZ dZdZdZdZd Zd Zd Zd Zd ZdZdZdZdZe�e�Z e�e�Z e e Z dZ dZ dZ!dZ"d Z#dZ$dZ%dZ&dZ'dZ(dZ)edg d��Z*edddg�Z+edg d��Z,G dd � d e-�Z.d d � Z/d d � Z0d/d!d"�Z1d#d$� Z2d%d&� Z3d'd(� Z4d)d*� Z5d+d,� Z6d-d.� Z7dS )0� N)� namedtuple)�log)�util� � � � � � � i�� � �< �IHHII�BHiII� � � �RTAAttr)�length�rta_type�data�InterfaceOperstate�ifname� operstate� NetlinkHeader)r �type�flags�seq�pidc @ s e Zd ZdZdS )�NetlinkCreateSocketErrorz5Raised if netlink socket fails during create or bind.N)�__name__� __module__� __qualname__�__doc__� r$ r$ �C/usr/lib/python3/dist-packages/cloudinit/sources/helpers/netlink.pyr 9 s r c C sp zt � t jt jt j�} | �t�� tf� | �d� W n t j y0 } z d| }t |�|�d}~ww t � d� | S )au Creates netlink socket and bind on netlink group to catch interface down/up events. The socket will bound only on RTMGRP_LINK (which only includes RTM_NEWLINK/RTM_DELLINK/RTM_GETLINK events). The socket is set to non-blocking mode since we're only receiving messages. :returns: netlink socket in non-blocking mode :raises: NetlinkCreateSocketError r z*Exception during netlink socket create: %sNzCreated netlink socket) �socket� AF_NETLINK�SOCK_RAW� NETLINK_ROUTE�bind�os�getpid� RTMGRP_LINK� setblocking�errorr �LOG�debug)�netlink_socket�e�msgr$ r$ r% �create_bound_netlink_socket= s � �� r5 c C s^ | dusJ d��t | �tksJ d��t�t| dt� �\}}}}}t�d|� t|||||�S )a Gets netlink message type and length :param: data read from netlink socket :returns: netlink message type :raises: AssertionError if data is None or data is not >= NLMSGHDR_SIZE struct nlmsghdr { __u32 nlmsg_len; /* Length of message including header */ __u16 nlmsg_type; /* Type of message content */ __u16 nlmsg_flags; /* Additional flags */ __u32 nlmsg_seq; /* Sequence number */ __u32 nlmsg_pid; /* Sender port ID */ }; N� data is nonez+data is smaller than netlink message headerzGot netlink msg of type %d) �len� NLMSGHDR_SIZE�struct�unpack� NLMSGHDR_FMT�MSG_TYPE_OFFSETr0 r1 r )r �msg_len�msg_typer r r r$ r$ r% �get_netlink_msg_headerS s � � r? c C s^ | dusJ d��t � | gg g |�\}}}| |vrdS t�d� | �t�}|du r-t�d� |S )a� Select and read from the netlink socket if ready. :param: netlink_socket: specify which socket object to read from :param: timeout: specify a timeout value (integer) to wait while reading, if none, it will block indefinitely until socket ready for read :returns: string of data read (max length = <MAX_SIZE>) from socket, if no data read, returns None :raises: AssertionError if netlink_socket is None N�netlink socket is nonez netlink socket ready for readz,Reading from Netlink socket returned no data)�selectr0 r1 �recv�MAX_SIZEr/ )r2 �timeout�read_set�_r r$ r$ r% �read_netlink_socketl s rG c C s� | dusJ d��t |�tksJ d��|tksJ d��d }}d}ztjd| |d�d }tjd| |d d�d }W n tjyC Y dS w | |t || � }t|||�S ) a( Unpack a single rta attribute. :param: data: string of data read from netlink socket :param: offset: starting offset of RTA Attribute :return: RTAAttr object with length, type and data. On error, return None. :raises: AssertionError if data is None or offset is not integer. Nr6 zoffset is not integerz'rta offset is less than expected lengthr �H)�offsetr )r �int�RTATTR_START_OFFSETr9 � unpack_fromr/ �RTA_DATA_START_OFFSETr )r rI r r � attr_datar$ r$ r% �unpack_rta_attr� s � � rO c C s� | dusJ d��t | �tksJ d��d }}t}|t | �kr]t| |�}|r*|jdkr+n2t|jt t }||j| 7 }|jtkrFt|j�}n|jt krWt � |jd�}|� d�}|t | �ks |rc|du redS t �d||� t||�S )a� Reads Interface name and operational state from RTA Data. :param: data: string of data read from netlink socket :returns: InterfaceOperstate object containing if_name and oper_state. None if data does not contain valid IFLA_OPERSTATE and IFLA_IFNAME messages. :raises: AssertionError if data is None or length of data is smaller than RTATTR_START_OFFSET. Nr6 z2length of data is smaller than RTATTR_START_OFFSETr zutf-8� z!rta attrs: ifname %s operstate %d)r7 rK rO r � PAD_ALIGNMENTr �IFLA_OPERSTATE�ordr � IFLA_IFNAMEr � decode_binary�stripr0 r1 r )r r r rI �attr�padlen�interface_namer$ r$ r% �read_rta_oper_state� s0 � � � rZ c s6 t �d� d�� �fdd�}t| dtgttg|� �S )z�Block until a single nic is attached. :param: netlink_socket: netlink_socket to receive events :param: existing_nics: List of existing nics so that we can skip them. :raises: AssertionError if netlink_socket is none. z!Preparing to wait for nic attach.Nc s | � v rdS | �dS )NTFr$ ��iname�carrier� prevCarrier�� existing_nicsr r$ r% �should_continue_cb� s z5wait_for_nic_attach_event.<locals>.should_continue_cb)r0 r1 �read_netlink_messages� RTM_NEWLINK�OPER_UP� OPER_DOWN)r2 r` ra r$ r_ r% �wait_for_nic_attach_event� s �rf c s2 t �d� d� � fdd�}t| dtgtg|� � S )z�Block until a single nic is detached and its operational state is down. :param: netlink_socket: netlink_socket to receive events. z!Preparing to wait for nic detach.Nc s | � dS )NFr$ r[ �r r$ r% ra � s z5wait_for_nic_detach_event.<locals>.should_continue_cb)r0 r1 rb � RTM_DELLINKre )r2 ra r$ rg r% �wait_for_nic_detach_event� s �ri c sf | dusJ d��� dusJ d��t � �dksJ d��� fdd�}t�d� t| � ttgttg|� dS ) a� Block until media disconnect and connect has happened on an interface. Listens on netlink socket to receive netlink events and when the carrier changes from 0 to 1, it considers event has happened and return from this function :param: netlink_socket: netlink_socket to receive events :param: ifname: Interface name to lookout for netlink events :raises: AssertionError if netlink_socket is None or ifname is None. Nr@ zinterface name is noner z interface name cannot be emptyc s( |t ko|tk}|rt�d� � dS dS )Nz Media switch happened on %s.FT)re rd r0 r1 )r\ r] r^ � isVnetSwitchrg r$ r% ra s z=wait_for_media_disconnect_connect.<locals>.should_continue_cbz1Wait for media disconnect and reconnect to happen)r7 r0 r1 rb rc rh rd re )r2 r ra r$ rg r% �!wait_for_media_disconnect_connect� s �rk c C sn | du rt d��t� }t}t} t| t�}|du rqt�dt|�� ||7 }t�dt|�� d} t|�} | | k r�|| d� } t| �tk rJt�d� nft | �} t| �| j k r[t�d� nU| j t d t d @ } | | } t�d | � | j |vrwq4t | �}|du r�t�d |� q4|dur�|j|kr�t�d |j|� q4|j|vr�q4|}|j}||j||�s�dS | | k s8|| d� }q) a� Reads from the netlink socket until the condition specified by the continuation callback is met. :param: netlink_socket: netlink_socket to receive events. :param: ifname_filter: if not None, will only listen for this interface. :param: rtm_types: Type of netlink events to listen for. :param: operstates: Operational states to listen. :param: should_continue_callback: Specifies when to stop listening. NzNetlink socket is noneTzread %d bytes from socketz Length of data after concat %dr z#Data is smaller than netlink headerz*Partial data. Smaller than netlink messager z"offset to next netlink message: %dz!Failed to read rta attributes: %sz6Ignored netlink event on interface %s. Waiting for %s.)� RuntimeError�bytesrd rG �SELECT_TIMEOUTr0 r1 r7 r8 r? r rQ r rZ r r )r2 � ifname_filter� rtm_types� operstates�should_continue_callbackr r] r^ � recv_datarI �datalen�nl_msg�nlheaderrX �interface_stater$ r$ r% rb sj � � �� '�rb )N)8r+ rA r& r9 � collectionsr � cloudinitr �loggingr � getLoggerr r0 r- � NLMSG_NOOP� NLMSG_ERROR� NLMSG_DONErc rh � RTM_GETLINK� RTM_SETLINKrC �RTA_DATA_OFFSETr< rn r; � IFINFOMSG_FMT�calcsizer8 �IFINFOMSG_SIZErK rM rQ rT rR � OPER_UNKNOWN�OPER_NOTPRESENTre �OPER_LOWERLAYERDOWN� OPER_TESTING� OPER_DORMANTrd r r r rl r r5 r? rG rO rZ rf ri rk rb r$ r$ r$ r% �<module> sf � % helpers/__pycache__/cloudsigma.cpython-310.pyc 0000644 00000007006 15027667240 0015262 0 ustar 00 o �Ad� � @ sX d Z ddlZddlZddlZdZdZdZe�� dkr dZG dd � d �ZG d d � d �Z dS ) a cepko implements easy-to-use communication with CloudSigma's VMs through a virtual serial port without bothering with formatting the messages properly nor parsing the output with the specific and sometimes confusing shell tools for that purpose. Having the server definition accessible by the VM can ve useful in various ways. For example it is possible to easily determine from within the VM, which network interfaces are connected to public and which to private network. Another use is to pass some data to initial VM setup scripts, like setting the hostname to the VM name or passing SSH public keys through server meta. For more information take a look at the Server Context section of CloudSigma API Docs: http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html � N�< � z /dev/ttyS1�Windows�COM2c @ s: e Zd ZdZdZd dd�Zdd� Zdd d �Zdd d �ZdS )�Cepkozb One instance of that object could be use for one or more queries to the serial port. z< {} >� Nc C s |d u r| j }t|�|��S �N)�request_pattern� CepkoResult�format��self�keyr � r �F/usr/lib/python3/dist-packages/cloudinit/sources/helpers/cloudsigma.py�get, s z Cepko.getc C s | � � S r )r �r r r r �all1 s z Cepko.allc C � | j �d�}| �||�S )Nz/meta/{}�r r r r r r r �meta4 � z Cepko.metac C r )Nz/global_context/{}r r r r r �global_context8 r zCepko.global_context)r N)r ) �__name__� __module__� __qualname__�__doc__r r r r r r r r r r $ s r c @ sH e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dS )r z� CepkoResult executes the request to the virtual serial port as soon as the instance is initialized and stores the result in both raw and marshalled format. c C s" || _ | �� | _| �| j�| _d S r )�request�_execute� raw_result�_marshal�result)r r r r r �__init__D s zCepkoResult.__init__c C s6 t jtttd�}|�| j�d�� |�� � d�� d�S )N)�port�timeout� writeTimeout�asciis ) �serial�Serial� SERIAL_PORT� READ_TIMEOUT� WRITE_TIMEOUT�writer �encode�readline�strip�decode)r � connectionr r r r I s �zCepkoResult._executec C s$ zt �|�W S ty | Y S w r )�json�loads� ValueError)r r r r r r P s �zCepkoResult._marshalc C � | j �� S r )r! �__len__r r r r r6 V � zCepkoResult.__len__c C � | j �|�S r )r! � __getitem__)r r r r r r9 Y � zCepkoResult.__getitem__c C r8 r )r! � __contains__)r �itemr r r r; \ r: zCepkoResult.__contains__c C r5 r )r! �__iter__r r r r r= _ r7 zCepkoResult.__iter__N) r r r r r" r r r6 r9 r; r= r r r r r = s r ) r r2 �platformr' r* r+ r) �systemr r r r r r �<module> s helpers/__pycache__/vultr.cpython-310.pyc 0000644 00000012314 15027667240 0014305 0 ustar 00 o �AdK � @ s d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dlmZm Z m Z m Z m Z d dl mZ d dlmZ e�e�Ze� d(d d ��Zd d � Zd d� Zdd� Zdd� Zdd� Zdd� Zdd� Ze� dd� �Z dd � Z d d � Z d)d d!�Z d"d#� Z d$d%� Z!d&d'� Z"dS )*� N)� lru_cache)� exceptions)�dmi)�log)�net�netinfo�subp� url_helper�util)�NoDHCPLeaseError)�EphemeralDHCPv4c C s� t d�}t� D ]`}z>t|d| i|d��+ t| �s! W d � W qt| ||||�}t�|�} t| � | W d � W S 1 sAw Y W q tt j t t j fyg } zt �d| � | }W Y d } ~ qd } ~ ww |�)NzFailed to DHCP�url)�iface�connectivity_url_data�tmp_dirzDHCP Exception: %s)� RuntimeError�get_interface_listr � check_route� read_metadata�json�loads�refactor_metadatar r �ProcessExecutionErrorr �RequestException�LOG�error) r �timeout�retries� sec_between�agentr � exceptionr �v1�metadata�exc� r$ �A/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vultr.py� get_metadata s6 �� *� � ��r& c C sL | d | d< | d | d< | d d }d| d v r | d d }|� � | d< d S )Nzinstance-v2-idz instance-id�hostnamezlocal-hostname�region� regioncode� countrycode)�lower)r" r( r$ r$ r% r 7 s r c C s* g } t �� D ] }d|v r q| �|� q| S )N�dummy)r �find_candidate_nics�append)�ifacesr r$ r$ r% r A s r c C s< t �� }d|vr dS |d D ] }|�dd �| v r dS qdS )N�ipv4F� destinationT)r � route_info�get)r �routes�router$ r$ r% r N s �r c C s t �d�t �d�d�S )Nzsystem-manufacturerzsystem-serial-number)� manufacturer�subid)r � read_dmi_datar$ r$ r$ r% � get_sysinfo_ s �r9 c C s t � d dkr dS dS )Nr6 �VultrTF)r9 r$ r$ r$ r% � is_baremetalg s r; c C s. t � } | d dkr dS dt�� �� v rdS dS )Nr6 r: T�vultrF)r9 r � get_cmdline�split)�sysinfor$ r$ r% �is_vultrn s r@ c C sH d| } d|d�}t j| ||||d�}|�� s td| |j��|j�� S )Nz %s/v1.json� cloudinit)zMetadata-Tokenz User-Agent)r r �headersr z!Failed to connect to %s: Code: %s)r �readurl�okr �code�contents�decode)r r r r r rB �responser$ r$ r% r } s � � r c C s t �� S �N)r �get_interfaces_by_macr$ r$ r$ r% �get_interface_map� s rK c C s t � }| |vr d S |�| �S rI )rK r3 )�mac� macs_to_nicr$ r$ r% �get_interface_name� s rN c C s� ddddgd�gd�}t | �dkr t| d dd �}|d �|� tdt | ��D ]}| | }|�d �r3q't|�}|d �|� q'|S ) N� � nameserverz 108.61.10.10z2001:19f0:300:1704::6)�type�address)�version�configr T)�primaryrT � unconfigured)�len�generate_interfacer. �ranger3 )� interfaces�network�public�i� interface�privater$ r$ r% �generate_network_config� s ��� r` Fc C s� t | d �}|std| d ��|d| d d�}|r*d|d< ddd �d dd �g|d < |s>d d| d d | d d d�g|d < t| |� t| |� |S )NrL �.Interface: %s could not be found on the system�physical)�namerQ � mac_addressrO � accept-ra�dhcp�auto)rQ �control� ipv6_slaac�subnets�staticr0 rR �netmask�rQ rh rR rl )rN r �generate_interface_routes�'generate_interface_additional_addresses)r^ rU �interface_name�netcfgr$ r$ r% rX � s0 ��� �� rX c C sL d| v r | d |d< d| v r| d |d< d| v r$| d |d d d< d S d S )N�mture r4 rj r r$ )r^ rq r$ r$ r% rn � s �rn c C s� t | d d �}d| v r5|dkr5| d d D ] }dd|d |d d�}d |v r-|d |d < |d �|� qt | d d �}d | v rm|dkro| d d D ]%}d dd |d |d f d�}d |v re|d |d < |d �|� qKd S d S d S )Nr0 � additionalr rk rg rR rl rm r4 rj �ipv6�static6z%s/%sr[ �prefix)rQ rh rR )rW r. )r^ rq �additional_countrs �addr$ r$ r% ro � s2 � �� �ro c C sH | d D ] }|d dkr qt |d �}|s td|d ��||d< qd S )NrT rQ rb rd ra rc )rN r )rq r^ rp r$ r$ r% �add_interface_names s �� �ry rI )F)#r � functoolsr �requestsr rA r r r r r r r �cloudinit.net.dhcpr �cloudinit.net.ephemeralr � getLogger�__name__r r& r r r r9 r; r@ r rK rN r` rX rn ro ry r$ r$ r$ r% �<module> s4 " % # helpers/__pycache__/azure.cpython-310.pyc 0000644 00000107471 15027667240 0014270 0 ustar 00 o �Ad(� � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl Z d dl m Z d dl m Z d dl mZ d dlmZmZ d dlmZmZmZmZmZ d dlmZ d dlmZ d d lm Z m Z m Z m Z m Z m!Z!m"Z" d d l#m$Z$ d d l%m&Z& e�'e(�Z)d Z*d Z+dZ,dZ-dZ.dZ/dZ0e$j1dddd�Z2dZ3ed�Z4dede4f dede4f fd d �Z5d d � Z6e5d d!� �Z7e5d"d#� �Z8dd$�d%e9de$j:fd&d'�Z;d(d)� Z<e5e&d* fd+d,��Z=e5d-d.� �Z>e d/d0� �Z?d1d2� Z@e5dd3d4d5�d6e9d7eAd8eeB d9eCd:eCde jDf d;d<��ZEd=e9d>e9d?e9deBfd@dA�ZFG dBdC� dC�ZGG dDdE� dEeH�ZIG dFdG� dG�ZJG dHdI� dI�ZKG dJdK� dK�ZLG dLdM� dM�ZMe5 d_dNe9dOeee9 dPee9 fdQdR��ZNe5dNe9fdSdT��ZOdUdV� ZPG dWdX� dXeH�ZQG dYdZ� dZeH�ZRG d[d\� d\ejS�ZTG d]d^� d^�ZUdS )`� N)�contextmanager)�datetime)�ENOENT)�sleep�time)�Callable�List�Optional�TypeVar�Union)� ElementTree)�escape)�distros�dmi�subp� temp_utils� url_helper�util�version)�events)� CFG_BUILTINz 168.63.129.16�boot-telemetryz system-info� diagnostic� compressedi � z'/run/cloud-init/log_pushed_to_kvp_indexzazure-dsz initialize reporter for azure dsT)�name� description�reporting_enabledz�The VM encountered an error during deployment. Please visit https://aka.ms/linuxprovisioningerror for more information on remediation.�T�func.�returnc s � fdd�}|S )Nc sF t j� j� jtd�� � | i |��W d � S 1 s w Y d S )N�r r �parent)r �ReportEventStack�__name__�azure_ds_reporter)�args�kwargs�r � �A/usr/lib/python3/dist-packages/cloudinit/sources/helpers/azure.py�impl9 s � $�z)azure_ds_telemetry_reporter.<locals>.implr( )r r* r( r' r) �azure_ds_telemetry_reporter8 s r+ c C s\ | |krdS d dd�}|� d�}d�||d �||d �||d �|d |d g�}| |kS ) z� Azure stores the instance ID with an incorrect byte ordering for the first parts. This corrects the byte order such that it is consistent with that returned by the metadata service. F� c S s( dd� t �| d�D �}|�� d�|�S )Nc S s g | ]}|�qS r( r( )�.0�byter( r( r) � <listcomp>N s z<is_byte_swapped.<locals>.swap_bytestring.<locals>.<listcomp>r, � )�textwrap�wrap�reverse�join)�s�width�ddr( r( r) �swap_bytestringM s z(is_byte_swapped.<locals>.swap_bytestring�-r � � � N)r, )�splitr4 )� previous_id� current_idr8 �parts� swapped_idr( r( r) �is_byte_swappedD s �� rB c C s� t �� std��t�d� z tt� �tt�� � } W n t y+ } ztd�|�d}~ww z*t j g d�dd�\}}d}|rGd|v rG|� d�d }|sMtd ��| t|�d }W n& t j yj } ztd | �|�d}~w t y| } ztd | �|�d}~ww z*t j g d�dd�\}}d}|r�d|v r�|� d�d }|s�td��| t|�d }W n& t j y� } ztd| �|�d}~w t y� } ztd| �|�d}~ww t �tddt�| ��� d t�|��� d t�|��� d f t j�}t �|� |S )z[Report timestamps related to kernel initialization and systemd activation of cloud-initz1distro not using systemd, skipping boot telemetryzCollecting boot telemetryz*Failed to determine kernel start timestampN)� systemctl�show�-p�UserspaceTimestampMonotonicT)�capture�=r: z8Failed to parse UserspaceTimestampMonotonic from systemdi@B z-Failed to get UserspaceTimestampMonotonic: %sz<Failed to parse UserspaceTimestampMonotonic from systemd: %s)rC rD zcloud-init-localrE � InactiveExitTimestampMonotonicz;Failed to parse InactiveExitTimestampMonotonic from systemdz0Failed to get InactiveExitTimestampMonotonic: %sz?Failed to parse InactiveExitTimestampMonotonic from systemd: %sr z5kernel_start=%s user_start=%s cloudinit_activation=%s�Z)r � uses_systemd� RuntimeError�LOG�debug�floatr r �uptime� ValueErrorr r= �ProcessExecutionErrorr �ReportingEvent�BOOT_EVENT_TYPEr �utcfromtimestamp� isoformat�DEFAULT_EVENT_ORIGIN� report_event)� kernel_start�e�out�_�tsm� user_start�cloudinit_activation�evtr( r( r) �get_boot_telemetry` s� �� � �������� � ������������ ra c C sb t �� } t�tddt�� | d | d | d d | d d | d d | d f tj�}t�|� |S ) z%Collect and report system informationzsystem informationztcloudinit_version=%s, kernel_version=%s, variant=%s, distro_name=%s, distro_version=%s, flavor=%s, python_version=%s�release�variant�distr r: r, �python) r � system_infor rS �SYSTEMINFO_EVENT_TYPEr �version_stringrW rX )�infor` r( r( r) �get_system_info� s$ �� � rj �� logger_func�msgc C s6 t |�r|| � t�td| tj�}tj|dhd� |S )zReport a diagnostic eventzdiagnostic message�log��excluded_handler_types)�callabler rS �DIAGNOSTIC_EVENT_TYPErW rX )rm rl r` r( r( r) �report_diagnostic_event� s �rs c C sN t �t�|��}d|�d�d�}t�t| t� |�tj �}tj |h d�d� |S )zReport a compressed eventzgz+b64�ascii)�encoding�data> rn �print�webhookro ) �base64� encodebytes�zlib�compress�decoder rS �COMPRESSED_EVENT_TYPE�json�dumpsrW rX )� event_name� event_content�compressed_data� event_datar` r( r( r) �report_compressed_event� s ���r� � def_log_filec C sV t � }t�d� zNt| d��?}|�dtj� t|�� t |�}t d� |�� | |�tjd� |�|tj � t d|�� � t�tt|�� �� W d � n1 sPw Y W n tys } zt dt|� tjd� W Y d}~nd}~ww t�d � ztjd gd d d �\}}t d |� W dS ty� } zt dt|� tjd� W Y d}~dS d}~ww )az Push a portion of cloud-init.log file or the whole file to KVP based on the file size. The first time this function is called after VM boot, It will push the last n bytes of the log file such that n < MAX_LOG_TO_KVP_LENGTH If called again on the same boot, it continues from where it left off. In addition to cloud-init.log, dmesg log will also be collected.z"Dumping cloud-init.log file to KVP�rbr zMDumping last {0} bytes of cloud-init.log file to KVP starting from index: {1}rk zcloud-init.logNz#Exception when dumping log file: %szDumping dmesg log to KVP�dmesgFT)r} rG z$Exception when dumping dmesg log: %s)�%get_last_log_byte_pushed_to_kvp_indexrM rN �open�seek�os�SEEK_END�max�tell�MAX_LOG_TO_KVP_LENGTHrs �format�SEEK_SETr� �readr � write_file� LOG_PUSHED_TO_KVP_INDEX_FILE�str� Exception�repr�warningr )� file_name� start_index�f� seek_index�exr[ r\ r( r( r) �push_log_to_kvp� sD � �� ��� ���r� c C s z t td��} t| �� �W d � W S 1 sw Y W dS tyI } z |jtkr>tdt|� t j d� W Y d }~dS W Y d }~dS d }~w t yf } ztdt|� t j d� W Y d }~dS d }~w t y� } ztdt|� t j d� W Y d }~dS d }~ww )N�rz0Reading LOG_PUSHED_TO_KVP_INDEX_FILE failed: %s.rk z2Invalid value in LOG_PUSHED_TO_KVP_INDEX_FILE: %s.z2Failed to get the last log byte pushed to KVP: %s.r ) r� r� �intr� �IOError�errnor rs r� rM r� rQ r� )r� rZ r( r( r) r� s< $�� � ��� � �� ���r� c c s@ � t �� }t �t j�| �� z d V W t �|� d S t �|� w �N)r� �getcwd�chdir�path� expanduser)�newdir�prevdirr( r( r) �cd7 s �r� c C sx | � dd�}t|�dkr2d}|�d�D ]}t|�dkr d| }||7 }qt�dt|� dd�d��}n|�d �}t�|�S ) N�\r0 r< �:r: �0z>L� �utf-8) �replace�lenr= �struct�packr� �encode�socket� inet_ntoa)�fallback_lease_value�unescaped_value� hex_string�hex_pair� packed_bytesr( r( r) �get_ip_from_lease_valueA s r� � � )rv � retry_sleep�timeout_minutes�url�headersrv r� r� c C s� |d t � }d}d}|sT|d7 }z tj| ||dd�}W n7 tjyM } z$td| |||j|jf tjd� t � | |ksBd t |�v rC� W Y d}~nd}~ww t |� |r td | |f tjd� |S ) z�Readurl wrapper for querying wireserver. :param retry_sleep: Time to sleep before retrying. :param timeout_minutes: Retry up to specified number of minutes. :raises UrlError: on error fetching data. �< r Nr: )r� r� )r� rv �timeoutzdFailed HTTP request with Azure endpoint %s during attempt %d with exception: %s (code=%r headers=%r)rk zNetwork is unreachablez@Successful HTTP request with Azure endpoint %s after %d attempts) r r �readurl�UrlErrorrs �coder� rM rN r� r ) r� r� rv r� r� r� �attempt�responserZ r( r( r) �http_with_retriesO s@ ��� ���� ��r� �username�hostname� disableSshPwdc C s$ t �d�}|j| ||d�}|�d�S )Na. <ns0:Environment xmlns:ns0="http://schemas.dmtf.org/ovf/environment/1" xmlns:ns1="http://schemas.microsoft.com/windowsazure" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ns1:ProvisioningSection> <ns1:Version>1.0</ns1:Version> <ns1:LinuxProvisioningConfigurationSet> <ns1:ConfigurationSetType>LinuxProvisioningConfiguration </ns1:ConfigurationSetType> <ns1:UserName>{username}</ns1:UserName> <ns1:DisableSshPasswordAuthentication>{disableSshPwd} </ns1:DisableSshPasswordAuthentication> <ns1:HostName>{hostname}</ns1:HostName> </ns1:LinuxProvisioningConfigurationSet> </ns1:ProvisioningSection> <ns1:PlatformSettingsSection> <ns1:Version>1.0</ns1:Version> <ns1:PlatformSettings> <ns1:ProvisionGuestAgent>true</ns1:ProvisionGuestAgent> </ns1:PlatformSettings> </ns1:PlatformSettingsSection> </ns0:Environment> )r� r� r� r� )r1 �dedentr� r� )r� r� r� �OVF_ENV_TEMPLATE�retr( r( r) �build_minimal_ovf� s �� r� c @ sL e Zd Zddd�Zdd� Zddejfdd �Z dd ee dejfd d �Z d S )�AzureEndpointHttpClient� WALinuxAgentz 2012-11-30)zx-ms-agent-namez x-ms-versionc C s d|d�| _ d S )N� DES_EDE3_CBC)zx-ms-cipher-namez!x-ms-guest-agent-public-x509-cert)�extra_secure_headers)�self� certificater( r( r) �__init__� s �z AzureEndpointHttpClient.__init__Fr c C s, | j }|r| j �� }|�| j� t||d�S )N)r� )r� �copy�updater� r� )r� r� �securer� r( r( r) �get� s zAzureEndpointHttpClient.getNrv c C s0 | j }|d ur| j �� }|�|� t|||d�S )N)rv r� )r� r� r� r� )r� r� rv � extra_headersr� r( r( r) �post� s z AzureEndpointHttpClient.post)F�NN) r# � __module__� __qualname__r� r� r � UrlResponser� r �bytesr� r( r( r( r) r� � s ����r� c @ s e Zd ZdZdS )� InvalidGoalStateXMLExceptionz9Raised when GoalState XML is invalid or has missing data.N)r# r� r� �__doc__r( r( r( r) r� � s r� c @ s: e Zd Z d deeef dededdfdd�Zd d � Z dS ) � GoalStateT� unparsed_xml�azure_endpoint_client�need_certificater Nc C s || _ zt�|�| _W n tjy" } z td| tjd� � d}~ww | �d�| _ | �d�| _ | �d�| _ dD ]}t | |�du rOd| }t|tjd� t |��q7d| _| �d �}|dur�|r�tjd d td �� | j j|d d�j| _| jdu rzt d��W d � dS 1 s�w Y dS dS dS )ah Parses a GoalState XML string and returns a GoalState object. @param unparsed_xml: string representing a GoalState XML. @param azure_endpoint_client: instance of AzureEndpointHttpClient. @param need_certificate: switch to know if certificates is needed. @return: GoalState object representing the GoalState XML string. z!Failed to parse GoalState XML: %srk Nz./Container/ContainerIdz4./Container/RoleInstanceList/RoleInstance/InstanceIdz ./Incarnation)� container_id� instance_id� incarnationzMissing %s in GoalState XMLzD./Container/RoleInstanceList/RoleInstance/Configuration/Certificateszget-certificates-xmlzget certificates xmlr T)r� z/Azure endpoint returned empty certificates xml.)r� r � fromstring�root� ParseErrorrs rM r� �_text_from_xpathr� r� r� �getattrr� �certificates_xmlr r" r$ r� �contents)r� r� r� r� rZ �attrrm r� r( r( r) r� � sX ��� � �� ��� ��"��zGoalState.__init__c C s | j �|�}|d ur |jS d S r� )r� �find�text)r� �xpath�elementr( r( r) r� s zGoalState._text_from_xpath)T) r# r� r� r r� r� r� �boolr� r� r( r( r( r) r� � s � ��� � 7r� c @ s� e Zd Zddd�Zdd� Zdd� Zedd � �Zejd d � �Ze d d � �Z e e d d� ��Z e dd� �Z e dd� �Ze dd� �Ze dd� �ZdS )�OpenSSLManagerzTransportPrivate.pemzTransportCert.pem)� private_keyr� c C s t �� | _d | _| �� d S r� )r �mkdtemp�tmpdir� _certificate�generate_certificate�r� r( r( r) r� s zOpenSSLManager.__init__c C s t �| j� d S r� )r �del_dirr� r r( r( r) �clean_up s zOpenSSLManager.clean_upc C s | j S r� �r� r r( r( r) r� s zOpenSSLManager.certificatec C s || _ d S r� r )r� �valuer( r( r) r� s c C s� t �d� | jd urt �d� d S t| j��: t�ddddddd d d d d | jd d| jd g� d}t| jd �D ] }d|vrE||�� 7 }q9|| _W d � n1 sSw Y t �d� d S )Nz7Generating certificate for communication with fabric...z Certificate already generated.�openssl�reqz-x509z-nodesz-subjz/CN=LinuxTransportz-days�32768z-newkeyzrsa:2048z-keyoutr� z-outr� r0 � CERTIFICATEzNew certificate generated.) rM rN r� r� r� r �certificate_namesr� �rstrip)r� r� �liner( r( r) r s< �� � �z#OpenSSLManager.generate_certificatec C s" ddd| g}t j ||d�\}}|S )Nr �x509z-noout�rv )r )�action�cert�cmd�resultr\ r( r( r) �_run_x509_action@ s z OpenSSLManager._run_x509_actionc C s* | � d|�}g d�}tj||d�\}}|S )Nz-pubkey)z ssh-keygenz-iz-m�PKCS8z-fz /dev/stdinr )r r )r� r� �pub_key� keygen_cmd�ssh_keyr\ r( r( r) �_get_ssh_key_from_certG s z%OpenSSLManager._get_ssh_key_from_certc C s6 | � d|�}|�d�}||d d� �d�}d�|�S )a openssl x509 formats fingerprints as so: 'SHA1 Fingerprint=07:3E:19:D1:4D:1C:79:92:24:C6:A0:FD:8D:DA: B6:A8:BF:27:D4:73 ' Azure control plane passes that fingerprint as so: '073E19D14D1C799224C6A0FD8DDAB6A8BF27D473' z -fingerprintrH r: ���r� r0 )r r� r= r4 )r� r� �raw_fp�eq�octetsr( r( r) �_get_fingerprint_from_certN s z)OpenSSLManager._get_fingerprint_from_certc C s� t �|��d�}|j}ddddd|�d�g}t| j�� tjdjd i | j ��d d � |�d �\}}W d � |S 1 s;w Y |S )z�Decrypt the certificates XML document using the our private key; return the list of certs and private keys contained in the doc. z.//Datas MIME-Version: 1.0s< Content-Disposition: attachment; filename="Certificates.p7m"s? Content-Type: application/x-pkcs7-mime; name="Certificates.p7m"s! Content-Transfer-Encoding: base64� r� zuopenssl cms -decrypt -in /dev/stdin -inkey {private_key} -recip {certificate} | openssl pkcs12 -nodes -password pass:T� )�shellrv Nr( ) r r� r� r� r� r� r� r r� r r4 )r� r� �tag�certificates_content�linesr[ r\ r( r( r) �_decrypt_certs_from_xml\ s. � �� � ��z&OpenSSLManager._decrypt_certs_from_xmlc C sv | � |�}g }i }|�� D ]+}|�|� t�d|�r g }q t�d|�r8d�|�}| �|�}| �|�}|||< g }q |S )z�Given the Certificates XML document, return a dictionary of fingerprints and associated SSH keys derived from the certs.z[-]+END .*?KEY[-]+$z[-]+END .*?CERTIFICATE[-]+$� )r$ � splitlines�append�re�matchr4 r r ) r� r� r[ �current�keysr r� r � fingerprintr( r( r) �parse_certificatesu s �z!OpenSSLManager.parse_certificatesN)r# r� r� r r� r �propertyr� �setterr+ r � staticmethodr r r r$ r- r( r( r( r) r� s. � r� c @ s� e Zd Ze�d�Ze�d�ZdZdZdZ dZ de de d e d d fd d �Zed dd��Zede d d fdd��Z d de de de de d ef dd�Zeded d fdd��Zd S ) �GoalStateHealthReportera� <?xml version="1.0" encoding="utf-8"?> <Health xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <GoalStateIncarnation>{incarnation}</GoalStateIncarnation> <Container> <ContainerId>{container_id}</ContainerId> <RoleInstanceList> <Role> <InstanceId>{instance_id}</InstanceId> <Health> <State>{health_status}</State> {health_detail_subsection} </Health> </Role> </RoleInstanceList> </Container> </Health> z� <Details> <SubStatus>{health_substatus}</SubStatus> <Description>{health_description}</Description> </Details> �Ready�NotReady�ProvisioningFailedi � goal_stater� �endpointr Nc C s || _ || _|| _dS )a? Creates instance that will report provisioning status to an endpoint @param goal_state: An instance of class GoalState that contains goal state info such as incarnation, container id, and instance id. These 3 values are needed when reporting the provisioning status to Azure @param azure_endpoint_client: Instance of class AzureEndpointHttpClient @param endpoint: Endpoint (string) where the provisioning status report will be sent to @return: Instance of class GoalStateHealthReporter N)� _goal_state�_azure_endpoint_client� _endpoint)r� r5 r� r6 r( r( r) r� � s z GoalStateHealthReporter.__init__c C sv | j | jj| jj| jj| jd�}t�d� z| j|d� W n t y3 } z t d| tj d� � d }~ww t� d� d S )N)r� r� r� �statusz Reporting ready to Azure fabric.��documentz#exception while reporting ready: %srk z Reported ready to Azure fabric.) � build_reportr7 r� r� r� �PROVISIONING_SUCCESS_STATUSrM rN �_post_health_reportr� rs �errorri )r� r< rZ r( r( r) �send_ready_signal� s$ � ���z)GoalStateHealthReporter.send_ready_signalr c C sv | j | jj| jj| jj| j| j|d�}z| j|d� W n ty3 } z d| }t |t j d� � d }~ww t � d� d S )N)r� r� r� r: � substatusr r; z%exception while reporting failure: %srk z!Reported failure to Azure fabric.) r= r7 r� r� r� � PROVISIONING_NOT_READY_STATUS� PROVISIONING_FAILURE_SUBSTATUSr? r� rs rM r@ r� )r� r r< rZ rm r( r( r) �send_failure_signal� s" ���z+GoalStateHealthReporter.send_failure_signalr� r� r� r: c C sb d}|d ur| j jt|�t|d | j� �d�}| jjtt|��t|�t|�t|�|d�}|�d�S )Nr0 )�health_substatus�health_description)r� r� r� � health_status�health_detail_subsectionr� )�%HEALTH_DETAIL_SUBSECTION_XML_TEMPLATEr� r �"HEALTH_REPORT_DESCRIPTION_TRIM_LEN�HEALTH_REPORT_XML_TEMPLATEr� r� ) r� r� r� r� r: rB r � health_detail� health_reportr( r( r) r= � s �� � z$GoalStateHealthReporter.build_reportr< c C sH t � td� t�d� d�| j�}| jj||ddid� t�d� d S )Nr z&Sending health report to Azure fabric.z http://{}/machine?comp=healthz Content-Typeztext/xml; charset=utf-8)rv r� z/Successfully sent health report to Azure fabric)r� r rM rN r� r9 r8 r� )r� r< r� r( r( r) r? s �z+GoalStateHealthReporter._post_health_report�r Nr� )r# r� r� r1 r� rL rJ r> rC rD rK r� r� r� r� r+ rA rE r� r= r? r( r( r( r) r1 � sN �� ��� � ����� � r1 c @ s� e Zd Zdefdd�Zdd� Zed dd ��Ze d dee e fd d ��Z ed eddfd d��Z ede de fdd��Zedefdd��Zedeeef de de fdd��Zede dedefdd��Zedededefd d ��ZdS ) �WALinuxAgentShimr6 c C s || _ d | _d | _d S r� )r6 �openssl_managerr� )r� r6 r( r( r) r� , s zWALinuxAgentShim.__init__c C s | j d ur | j �� d S d S r� )rQ r r r( r( r) r 1 s �zWALinuxAgentShim.clean_upr Nc C sX zt �d� t�d|g� W d S ty+ } ztd| t jd� W Y d }~d S d }~ww )Nz Ejecting the provisioning iso�ejectz(Failed ejecting the provisioning iso: %srk )rM rN r r� rs )r� �iso_devrZ r( r( r) � eject_iso5 s ���zWALinuxAgentShim.eject_isoc C s� d}| j du r|durt� | _ | j j}| jdu r t|�| _| j|dud�}d}|dur1| �||�}t|| j| j�}|durB| � |� |� � |S )a� Gets the VM's GoalState from Azure, uses the GoalState information to report ready/send the ready signal/provisioning complete signal to Azure, and then uses pubkey_info to filter and obtain the user's pubkeys from the GoalState. @param pubkey_info: List of pubkey values and fingerprints which are used to filter and obtain the user's pubkey values from the GoalState. @return: The list of user's authorized pubkey values. N�r� ) rQ r� r� r� r� � _fetch_goal_state_from_azure�_get_user_pubkeysr1 r6 rT rA )r� � pubkey_inforS �http_client_certificater5 �ssh_keys�health_reporterr( r( r) �"register_with_azure_and_fetch_data@ s* �� � z3WALinuxAgentShim.register_with_azure_and_fetch_datar c C s@ | j du r td�| _ | jdd�}t|| j | j�}|j|d� dS )z�Gets the VM's GoalState from Azure, uses the GoalState information to report failure/send provisioning failure signal to Azure. @param: user visible error description of provisioning failure. NFrU �r )r� r� rV r1 r6 rE )r� r r5 r[ r( r( r) �®ister_with_azure_and_report_failuref s �z7WALinuxAgentShim.register_with_azure_and_report_failurer� c C s | � � }| �||�S )a Fetches the GoalState XML from the Azure endpoint, parses the XML, and returns a GoalState object. @param need_certificate: switch to know if certificates is needed. @return: GoalState object representing the GoalState XML )�"_get_raw_goal_state_xml_from_azure�_parse_raw_goal_state_xml)r� r� �unparsed_goal_state_xmlr( r( r) rV u s �z-WALinuxAgentShim._fetch_goal_state_from_azurec C s� t �d� d�| j�}z tjddtd�� | j�|�}W d � n1 s%w Y W n t yA } z t d| t j d� � d}~ww t � d � |j S ) z�Fetches the GoalState XML from the Azure endpoint and returns the XML as a string. @return: GoalState XML string zRegistering with Azure...z!http://{}/machine/?comp=goalstatezgoalstate-retrievalzretrieve goalstater Nz9failed to register with Azure and fetch GoalState XML: %srk z#Successfully fetched GoalState XML.)rM ri r� r6 r r" r$ r� r� r� rs r� rN r� )r� r� r� rZ r( r( r) r_ � s. � ������ z3WALinuxAgentShim._get_raw_goal_state_xml_from_azurera c C st z t || j|�}W n ty } z td| tjd� � d}~ww d�d|j d|j d|j g�}t|tj d� |S )a Parses a GoalState XML string and returns a GoalState object. @param unparsed_goal_state_xml: GoalState XML string @param need_certificate: switch to know if certificates is needed. @return: GoalState object representing the GoalState XML z"Error processing GoalState XML: %srk Nz, z GoalState XML container id: %sz GoalState XML instance id: %sz GoalState XML incarnation: %s) r� r� r� rs rM r� r4 r� r� r� rN )r� ra r� r5 rZ rm r( r( r) r` � s, ������z*WALinuxAgentShim._parse_raw_goal_state_xmlr5 rX c C sH g }|j dur"|dur"| jdur"t�d� | j�|j �}| �||�}|S )a� Gets and filters the VM admin user's authorized pubkeys. The admin user in this case is the username specified as "admin" when deploying VMs on Azure. See https://docs.microsoft.com/en-us/cli/azure/vm#az-vm-create. cloud-init expects a straightforward array of keys to be dropped into the admin user's authorized_keys file. Azure control plane exposes multiple public keys to the VM via wireserver. Select just the admin user's key(s) and return them, ignoring any other certs. @param goal_state: GoalState object. The GoalState object contains a certificate XML, which contains both the VM user's authorized pubkeys and other non-user pubkeys, which are used for MSI and protected extension handling. @param pubkey_info: List of VM user pubkey dicts that were previously obtained from provisioning data. Each pubkey dict in this list can either have the format pubkey['value'] or pubkey['fingerprint']. Each pubkey['fingerprint'] in the list is used to filter and obtain the actual pubkey value from the GoalState certificates XML. Each pubkey['value'] requires no further processing and is immediately added to the return list. @return: A list of the VM user's authorized pubkey values. Nz/Certificate XML found; parsing out public keys.)r� rQ rM rN r- �_filter_pubkeys)r� r5 rX rZ �keys_by_fingerprintr( r( r) rW � s � z"WALinuxAgentShim._get_user_pubkeysrc c C s| g }|D ]7}d|v r|d r|� |d � qd|v r5|d r5|d }|| v r.|� | | � qt�d|� qt�d|� q|S )a8 Filter and return only the user's actual pubkeys. @param keys_by_fingerprint: pubkey fingerprint -> pubkey value dict that was obtained from GoalState Certificates XML. May contain non-user pubkeys. @param pubkey_info: List of VM user pubkeys. Pubkey values are added to the return list without further processing. Pubkey fingerprints are used to filter and obtain the actual pubkey values from keys_by_fingerprint. @return: A list of the VM user's authorized pubkey values. r r, zIovf-env.xml specified PublicKey fingerprint %s not found in goalstate XMLzFovf-env.xml specified PublicKey with neither value nor fingerprint: %s)r' rM r� )rc rX r+ �pubkeyr, r( r( r) rb � s" ��z WALinuxAgentShim._filter_pubkeysrO r� )r# r� r� r� r� r r+ rT r r r\ r^ r� r� rV r� r_ r r` �listrW r0 �dictrb r( r( r( r) rP + sL � �%� � �� �!�� �) rP r6 rX rS c C s. t | d�}z |j||d�W |�� S |�� w )N�r6 )rX rS )rP r\ r )r6 rX rS �shimr( r( r) �get_metadata_from_fabric s �ri c C s4 t | d�}t}z |j|d� W |�� d S |�� w )Nrg r] )rP �+DEFAULT_REPORT_FAILURE_USER_VISIBLE_MESSAGEr^ r )r6 rh r r( r( r) �report_failure_to_fabric s rk c C s( t d| tjd� t d| tjd� d S )Nzdhclient output stream: %srk zdhclient error stream: %s)rs rM rN )r[ �errr( r( r) � dhcp_log_cb) s � �rm c @ � e Zd ZdS )�BrokenAzureDataSourceN�r# r� r� r( r( r( r) ro 2 � ro c @ rn )�NonAzureDataSourceNrp r( r( r( r) rr 6 rq rr c @ s& e Zd ZdZeded fdd��ZdS )�ChassisAssetTagz 7783-7084-3265-9085-8269-3286-77r c C sZ t �d�}z| |�}W n ty td| tjd� Y dS w td||jf tjd� |S )z�Check platform environment to report if this datasource may run. :returns: ChassisAssetTag if matching tag found, else None. zchassis-asset-tagz Non-Azure chassis asset tag: %rrk Nz Azure chassis asset tag: %r (%s))r � read_dmi_datarQ rs rM rN r )�cls� asset_tagr! r( r( r) � query_system= s �� �z ChassisAssetTag.query_systemN)r# r� r� � AZURE_CLOUD� classmethodr rw r( r( r( r) rs : s rs c @ s� e Zd Zddd�Zddddddddd�dee dee d ee d ee d ee d eee d edee ddfdd�Z defdd�Z e dedd fdd��Z d'dededefdd �Z d(deded ed efd d �Zd!d"� Zd#d$� Zd%d&� ZdS ))� OvfEnvXmlz)http://schemas.dmtf.org/ovf/environment/1z)http://schemas.microsoft.com/windowsazure)�ovf�waNF�r� �passwordr� � custom_data�disable_ssh_password_auth� public_keys�preprovisioned_vm�preprovisioned_vm_typer� r~ r� r r� r� r� r� r c C s8 || _ || _|| _|| _|| _|pg | _|| _|| _d S r� r} ) r� r� r~ r� r r� r� r� r� r( r( r) r� Z s zOvfEnvXml.__init__c C s | j |j kS r� )�__dict__)r� �otherr( r( r) �__eq__o s zOvfEnvXml.__eq__� ovf_env_xmlc C sp zt �|�}W n t jy } z d| }t|�|�d}~ww |�d| j�s)td��t� }|�|� |� |� |S )z�Parser for ovf-env.xml data. :raises NonAzureDataSource: if XML is not in Azure's format. :raises BrokenAzureDataSource: if XML is unparseable or invalid. zInvalid ovf-env.xml: %sNz./wa:ProvisioningSectionz=Ignoring non-Azure ovf-env.xml: ProvisioningSection not found) r r� r� ro r� � NAMESPACESrr rz �&_parse_linux_configuration_set_section� _parse_platform_settings_section)ru r� r� rZ � error_str�instancer( r( r) � parse_textr s ��� zOvfEnvXml.parse_textr| r �required� namespacec C sl |� d||f tj�}t|�dkr"d| }t�|� |r t|��d S t|�dkr2td|t|�f ��|d S )Nz./%s:%sr �#No ovf-env.xml configuration for %rr: �:Multiple configuration matches in ovf-exml.xml for %r (%d))�findallrz r� r� rM rN ro )r� �noder r� r� �matchesrm r( r( r) �_find� s � ��zOvfEnvXml._find� decode_base64� parse_boolc C s� |� d| tj�}t|�dkr d| }t�|� |r t|��|S t|�dkr0td|t|�f ��|d j} | d u r;|} |rK| d urKt� d� | � � ��} |rRt � | �} | S )Nz./wa:r r� r: r� r0 )r� rz r� r� rM rN ro r� ry � b64decoder4 r= r �translate_bool) r� r� r r� r� r� �defaultr� rm r r( r( r) �_parse_property� s* �� zOvfEnvXml._parse_propertyc C s� | j |ddd�}| j |ddd�}| j|dddd�| _| j|ddd�| _| j|d dd�| _| j|d dd�| _| j|d ddd �| _| �|� d S ) N�ProvisioningSectionT�r� �!LinuxProvisioningConfigurationSet� CustomDataF)r� r� �UserName� UserPassword�HostName� DisableSshPasswordAuthentication)r� r� )r� r� r r� r~ r� r� �_parse_ssh_section)r� r� �provisioning_section� config_setr( r( r) r� � s< �������z0OvfEnvXml._parse_linux_configuration_set_sectionc C sL | j |ddd�}| j |ddd�}| j|ddddd�| _| j|ddd�| _d S ) N�PlatformSettingsSectionTr� �PlatformSettings�PreprovisionedVmF)r� r� r� �PreprovisionedVMType)r� r� r� r� )r� r� �platform_settings_section�platform_settingsr( r( r) r� � s$ ��� �z*OvfEnvXml._parse_platform_settings_sectionc C s� g | _ | j|ddd�}|d u rd S | j|ddd�}|d u r d S |�dtj�D ]'}| j|ddd�}| j|ddd�}| j|dd dd �}|||d �}| j �|� q&d S ) N�SSHFr� � PublicKeysz./wa:PublicKey� Fingerprint�Path�Valuer0 )r� r� )r, r� r )r� r� r� rz r� r� r' ) r� r� � ssh_section�public_keys_section� public_keyr, r� r r r( r( r) r� � s2 ������z OvfEnvXml._parse_ssh_section)r| )FFN)r# r� r� r� r r� r� r� r rf r� r� ry r� r� r� r� r� r� r( r( r( r) rz T sr ������� � � � � ��� � ���� �$" rz r� )Vry �enumr �loggingr� r( r� r� r1 r{ � contextlibr r r� r r r �typingr r r r r � xml.etreer �xml.sax.saxutilsr � cloudinitr r r r r r r �cloudinit.reportingr �cloudinit.settingsr � getLoggerr# rM �DEFAULT_WIRESERVER_ENDPOINTrT rg rr r~ r� r� r" r$ rj r r+ rB ra rj r� rS rs r� r� r� r� r� rf r� r� r� r� r� r� r� r� r� r� r1 rP ri rk rm ro rr �Enumrs rz r( r( r( r) �<module> s� $ ��" S �� �( ������ �6��� �" ? " f�� � � helpers/ec2.py 0000644 00000021203 15027667240 0007240 0 ustar 00 # Copyright (C) 2012 Yahoo! Inc. # Copyright (C) 2014 Amazon.com, Inc. or its affiliates. # # Author: Joshua Harlow <harlowja@yahoo-inc.com> # Author: Andrew Jorgensen <ajorgens@amazon.com> # # This file is part of cloud-init. See LICENSE file for license information. import functools import json from cloudinit import log as logging from cloudinit import url_helper, util LOG = logging.getLogger(__name__) SKIP_USERDATA_CODES = frozenset([url_helper.NOT_FOUND]) class MetadataLeafDecoder: """Decodes a leaf blob into something meaningful.""" def _maybe_json_object(self, text): if not text: return False text = text.strip() if text.startswith("{") and text.endswith("}"): return True return False def __call__(self, field, blob): if not blob: return "" try: blob = util.decode_binary(blob) except UnicodeDecodeError: return blob if self._maybe_json_object(blob): try: # Assume it's json, unless it fails parsing... return json.loads(blob) except (ValueError, TypeError) as e: LOG.warning( "Field %s looked like a json object, but it was not: %s", field, e, ) if blob.find("\n") != -1: return blob.splitlines() return blob # See: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ # ec2-instance-metadata.html class MetadataMaterializer: def __init__(self, blob, base_url, caller, leaf_decoder=None): self._blob = blob self._md = None self._base_url = base_url self._caller = caller if leaf_decoder is None: self._leaf_decoder = MetadataLeafDecoder() else: self._leaf_decoder = leaf_decoder def _parse(self, blob): leaves = {} children = [] blob = util.decode_binary(blob) if not blob: return (leaves, children) def has_children(item): if item.endswith("/"): return True else: return False def get_name(item): if item.endswith("/"): return item.rstrip("/") return item for field in blob.splitlines(): field = field.strip() field_name = get_name(field) if not field or not field_name: continue # Don't materialize credentials if field_name == "security-credentials": continue if has_children(field): if field_name not in children: children.append(field_name) else: contents = field.split("=", 1) resource = field_name if len(contents) > 1: # What a PITA... (ident, sub_contents) = contents ident = util.safe_int(ident) if ident is not None: resource = "%s/openssh-key" % (ident) field_name = sub_contents leaves[field_name] = resource return (leaves, children) def materialize(self): if self._md is not None: return self._md self._md = self._materialize(self._blob, self._base_url) return self._md def _materialize(self, blob, base_url): (leaves, children) = self._parse(blob) child_contents = {} for c in children: child_url = url_helper.combine_url(base_url, c) if not child_url.endswith("/"): child_url += "/" child_blob = self._caller(child_url) child_contents[c] = self._materialize(child_blob, child_url) leaf_contents = {} for (field, resource) in leaves.items(): leaf_url = url_helper.combine_url(base_url, resource) leaf_blob = self._caller(leaf_url) leaf_contents[field] = self._leaf_decoder(field, leaf_blob) joined = {} joined.update(child_contents) for field in leaf_contents.keys(): if field in joined: LOG.warning("Duplicate key found in results from %s", base_url) else: joined[field] = leaf_contents[field] return joined def skip_retry_on_codes(status_codes, _request_args, cause): """Returns False if cause.code is in status_codes.""" return cause.code not in status_codes def get_instance_userdata( api_version="latest", metadata_address="http://169.254.169.254", ssl_details=None, timeout=5, retries=5, headers_cb=None, headers_redact=None, exception_cb=None, ): ud_url = url_helper.combine_url(metadata_address, api_version) ud_url = url_helper.combine_url(ud_url, "user-data") user_data = "" try: if not exception_cb: # It is ok for userdata to not exist (thats why we are stopping if # NOT_FOUND occurs) and just in that case returning an empty # string. exception_cb = functools.partial( skip_retry_on_codes, SKIP_USERDATA_CODES ) response = url_helper.read_file_or_url( ud_url, ssl_details=ssl_details, timeout=timeout, retries=retries, exception_cb=exception_cb, headers_cb=headers_cb, headers_redact=headers_redact, ) user_data = response.contents except url_helper.UrlError as e: if e.code not in SKIP_USERDATA_CODES: util.logexc(LOG, "Failed fetching userdata from url %s", ud_url) except Exception: util.logexc(LOG, "Failed fetching userdata from url %s", ud_url) return user_data def _get_instance_metadata( tree, api_version="latest", metadata_address="http://169.254.169.254", ssl_details=None, timeout=5, retries=5, leaf_decoder=None, headers_cb=None, headers_redact=None, exception_cb=None, retrieval_exception_ignore_cb=None, ): md_url = url_helper.combine_url(metadata_address, api_version, tree) caller = functools.partial( url_helper.read_file_or_url, ssl_details=ssl_details, timeout=timeout, retries=retries, headers_cb=headers_cb, headers_redact=headers_redact, exception_cb=exception_cb, ) def mcaller(url): try: return caller(url).contents except url_helper.UrlError as e: if ( not retrieval_exception_ignore_cb or not retrieval_exception_ignore_cb(e) ): raise else: LOG.warning("Skipped retrieval of the content of %s", url) return "(skipped)" try: response = caller(md_url) materializer = MetadataMaterializer( response.contents, md_url, mcaller, leaf_decoder=leaf_decoder ) md = materializer.materialize() if not isinstance(md, (dict)): md = {} return md except Exception: util.logexc(LOG, "Failed fetching %s from url %s", tree, md_url) return {} def get_instance_metadata( api_version="latest", metadata_address="http://169.254.169.254", ssl_details=None, timeout=5, retries=5, leaf_decoder=None, headers_cb=None, headers_redact=None, exception_cb=None, retrieval_exception_ignore_cb=None, ): # Note, 'meta-data' explicitly has trailing /. # this is required for CloudStack (LP: #1356855) return _get_instance_metadata( tree="meta-data/", api_version=api_version, metadata_address=metadata_address, ssl_details=ssl_details, timeout=timeout, retries=retries, leaf_decoder=leaf_decoder, headers_redact=headers_redact, headers_cb=headers_cb, exception_cb=exception_cb, retrieval_exception_ignore_cb=retrieval_exception_ignore_cb, ) def get_instance_identity( api_version="latest", metadata_address="http://169.254.169.254", ssl_details=None, timeout=5, retries=5, leaf_decoder=None, headers_cb=None, headers_redact=None, exception_cb=None, ): return _get_instance_metadata( tree="dynamic/instance-identity", api_version=api_version, metadata_address=metadata_address, ssl_details=ssl_details, timeout=timeout, retries=retries, leaf_decoder=leaf_decoder, headers_redact=headers_redact, headers_cb=headers_cb, exception_cb=exception_cb, ) # vi: ts=4 expandtab helpers/vultr.py 0000644 00000017513 15027667240 0007754 0 ustar 00 # Author: Eric Benner <ebenner@vultr.com> # # This file is part of cloud-init. See LICENSE file for license information. import json from functools import lru_cache from requests import exceptions from cloudinit import dmi from cloudinit import log as log from cloudinit import net, netinfo, subp, url_helper, util from cloudinit.net.dhcp import NoDHCPLeaseError from cloudinit.net.ephemeral import EphemeralDHCPv4 # Get LOG LOG = log.getLogger(__name__) @lru_cache() def get_metadata(url, timeout, retries, sec_between, agent, tmp_dir=None): # Bring up interface (and try untill one works) exception = RuntimeError("Failed to DHCP") # Seek iface with DHCP for iface in get_interface_list(): try: with EphemeralDHCPv4( iface=iface, connectivity_url_data={"url": url}, tmp_dir=tmp_dir, ): # Check for the metadata route, skip if not there if not check_route(url): continue # Fetch the metadata v1 = read_metadata(url, timeout, retries, sec_between, agent) metadata = json.loads(v1) refactor_metadata(metadata) return metadata except ( NoDHCPLeaseError, subp.ProcessExecutionError, RuntimeError, exceptions.RequestException, ) as exc: LOG.error("DHCP Exception: %s", exc) exception = exc raise exception # Refactor metadata into acceptable format def refactor_metadata(metadata): metadata["instance-id"] = metadata["instance-v2-id"] metadata["local-hostname"] = metadata["hostname"] region = metadata["region"]["regioncode"] if "countrycode" in metadata["region"]: region = metadata["region"]["countrycode"] metadata["region"] = region.lower() # Get interface list, sort, and clean def get_interface_list(): ifaces = [] for iface in net.find_candidate_nics(): # Skip dummy if "dummy" in iface: continue ifaces.append(iface) return ifaces # Check for /32 route that our dhcp servers inject # in order to determine if this a customer-run dhcp server def check_route(url): # Get routes, confirm entry exists routes = netinfo.route_info() # If no tools exist and empty dict is returned if "ipv4" not in routes: return False # Parse each route into a more searchable format for route in routes["ipv4"]: if route.get("destination", None) in url: return True return False # Read the system information from SMBIOS def get_sysinfo(): return { "manufacturer": dmi.read_dmi_data("system-manufacturer"), "subid": dmi.read_dmi_data("system-serial-number"), } # Assumes is Vultr is already checked def is_baremetal(): if get_sysinfo()["manufacturer"] != "Vultr": return True return False # Confirm is Vultr def is_vultr(): # VC2, VDC, and HFC use DMI sysinfo = get_sysinfo() if sysinfo["manufacturer"] == "Vultr": return True # Baremetal requires a kernel parameter if "vultr" in util.get_cmdline().split(): return True return False # Read Metadata endpoint def read_metadata(url, timeout, retries, sec_between, agent): url = "%s/v1.json" % url # Announce os details so we can handle non Vultr origin # images and provide correct vendordata generation. headers = {"Metadata-Token": "cloudinit", "User-Agent": agent} response = url_helper.readurl( url, timeout=timeout, retries=retries, headers=headers, sec_between=sec_between, ) if not response.ok(): raise RuntimeError( "Failed to connect to %s: Code: %s" % url, response.code ) return response.contents.decode() # Wrapped for caching @lru_cache() def get_interface_map(): return net.get_interfaces_by_mac() # Convert macs to nics def get_interface_name(mac): macs_to_nic = get_interface_map() if mac not in macs_to_nic: return None return macs_to_nic.get(mac) # Generate network configs def generate_network_config(interfaces): network = { "version": 1, "config": [ { "type": "nameserver", "address": ["108.61.10.10", "2001:19f0:300:1704::6"], } ], } # Prepare interface 0, public if len(interfaces) > 0: public = generate_interface(interfaces[0], primary=True) network["config"].append(public) # Prepare additional interfaces, private for i in range(1, len(interfaces)): interface = interfaces[i] # Skip interfaces set not to be configured if interface.get("unconfigured"): continue private = generate_interface(interface) network["config"].append(private) return network def generate_interface(interface, primary=False): interface_name = get_interface_name(interface["mac"]) if not interface_name: raise RuntimeError( "Interface: %s could not be found on the system" % interface["mac"] ) netcfg = { "name": interface_name, "type": "physical", "mac_address": interface["mac"], } if primary: netcfg["accept-ra"] = 1 netcfg["subnets"] = [ {"type": "dhcp", "control": "auto"}, {"type": "ipv6_slaac", "control": "auto"}, ] if not primary: netcfg["subnets"] = [ { "type": "static", "control": "auto", "address": interface["ipv4"]["address"], "netmask": interface["ipv4"]["netmask"], } ] generate_interface_routes(interface, netcfg) generate_interface_additional_addresses(interface, netcfg) # Add config to template return netcfg def generate_interface_routes(interface, netcfg): # Options that may or may not be used if "mtu" in interface: netcfg["mtu"] = interface["mtu"] if "accept-ra" in interface: netcfg["accept-ra"] = interface["accept-ra"] if "routes" in interface: netcfg["subnets"][0]["routes"] = interface["routes"] def generate_interface_additional_addresses(interface, netcfg): # Check for additional IP's additional_count = len(interface["ipv4"]["additional"]) if "ipv4" in interface and additional_count > 0: for additional in interface["ipv4"]["additional"]: add = { "type": "static", "control": "auto", "address": additional["address"], "netmask": additional["netmask"], } if "routes" in additional: add["routes"] = additional["routes"] netcfg["subnets"].append(add) # Check for additional IPv6's additional_count = len(interface["ipv6"]["additional"]) if "ipv6" in interface and additional_count > 0: for additional in interface["ipv6"]["additional"]: add = { "type": "static6", "control": "auto", "address": "%s/%s" % (additional["network"], additional["prefix"]), } if "routes" in additional: add["routes"] = additional["routes"] netcfg["subnets"].append(add) # Make required adjustments to the network configs provided def add_interface_names(netcfg): for interface in netcfg["config"]: if interface["type"] != "physical": continue interface_name = get_interface_name(interface["mac_address"]) if not interface_name: raise RuntimeError( "Interface: %s could not be found on the system" % interface["mac_address"] ) interface["name"] = interface_name # vi: ts=4 expandtab helpers/upcloud.py 0000644 00000015000 15027667240 0010240 0 ustar 00 # Author: Antti Myyrä <antti.myyra@upcloud.com> # # This file is part of cloud-init. See LICENSE file for license information. import json from cloudinit import dmi from cloudinit import log as logging from cloudinit import net as cloudnet from cloudinit import url_helper LOG = logging.getLogger(__name__) def convert_to_network_config_v1(config): """ Convert the UpCloud network metadata description into Cloud-init's version 1 netconfig format. Example JSON: { "interfaces": [ { "index": 1, "ip_addresses": [ { "address": "94.237.105.53", "dhcp": true, "dns": [ "94.237.127.9", "94.237.40.9" ], "family": "IPv4", "floating": false, "gateway": "94.237.104.1", "network": "94.237.104.0/22" }, { "address": "94.237.105.50", "dhcp": false, "dns": [], "family": "IPv4", "floating": true, "gateway": "", "network": "94.237.105.50/32" } ], "mac": "32:d5:ba:4a:36:e7", "network_id": "031457f4-0f8c-483c-96f2-eccede02909c", "type": "public" }, { "index": 2, "ip_addresses": [ { "address": "10.6.3.27", "dhcp": true, "dns": [], "family": "IPv4", "floating": false, "gateway": "10.6.0.1", "network": "10.6.0.0/22" } ], "mac": "32:d5:ba:4a:84:cc", "network_id": "03d82553-5bea-4132-b29a-e1cf67ec2dd1", "type": "utility" }, { "index": 3, "ip_addresses": [ { "address": "2a04:3545:1000:720:38d6:baff:fe4a:63e7", "dhcp": true, "dns": [ "2a04:3540:53::1", "2a04:3544:53::1" ], "family": "IPv6", "floating": false, "gateway": "2a04:3545:1000:720::1", "network": "2a04:3545:1000:720::/64" } ], "mac": "32:d5:ba:4a:63:e7", "network_id": "03000000-0000-4000-8046-000000000000", "type": "public" }, { "index": 4, "ip_addresses": [ { "address": "172.30.1.10", "dhcp": true, "dns": [], "family": "IPv4", "floating": false, "gateway": "172.30.1.1", "network": "172.30.1.0/24" } ], "mac": "32:d5:ba:4a:8a:e1", "network_id": "035a0a4a-77b4-4de5-820d-189fc8135714", "type": "private" } ], "dns": [ "94.237.127.9", "94.237.40.9" ] } """ def _get_subnet_config(ip_addr, dns): if ip_addr.get("dhcp"): dhcp_type = "dhcp" if ip_addr.get("family") == "IPv6": # UpCloud currently passes IPv6 addresses via # StateLess Address Auto Configuration (SLAAC) dhcp_type = "ipv6_dhcpv6-stateless" return {"type": dhcp_type} static_type = "static" if ip_addr.get("family") == "IPv6": static_type = "static6" subpart = { "type": static_type, "control": "auto", "address": ip_addr.get("address"), } if ip_addr.get("gateway"): subpart["gateway"] = ip_addr.get("gateway") if "/" in ip_addr.get("network"): subpart["netmask"] = ip_addr.get("network").split("/")[1] if dns != ip_addr.get("dns") and ip_addr.get("dns"): subpart["dns_nameservers"] = ip_addr.get("dns") return subpart nic_configs = [] macs_to_interfaces = cloudnet.get_interfaces_by_mac() LOG.debug("NIC mapping: %s", macs_to_interfaces) for raw_iface in config.get("interfaces"): LOG.debug("Considering %s", raw_iface) mac_address = raw_iface.get("mac") if mac_address not in macs_to_interfaces: raise RuntimeError( "Did not find network interface on system " "with mac '%s'. Cannot apply configuration: %s" % (mac_address, raw_iface) ) iface_type = raw_iface.get("type") sysfs_name = macs_to_interfaces.get(mac_address) LOG.debug( "Found %s interface '%s' with address '%s' (index %d)", iface_type, sysfs_name, mac_address, raw_iface.get("index"), ) interface = { "type": "physical", "name": sysfs_name, "mac_address": mac_address, } subnets = [] for ip_address in raw_iface.get("ip_addresses"): sub_part = _get_subnet_config(ip_address, config.get("dns")) subnets.append(sub_part) interface["subnets"] = subnets nic_configs.append(interface) if config.get("dns"): LOG.debug("Setting DNS nameservers to %s", config.get("dns")) nic_configs.append( {"type": "nameserver", "address": config.get("dns")} ) return {"version": 1, "config": nic_configs} def convert_network_config(config): return convert_to_network_config_v1(config) def read_metadata(url, timeout=2, sec_between=2, retries=30): response = url_helper.readurl( url, timeout=timeout, sec_between=sec_between, retries=retries ) if not response.ok(): raise RuntimeError("unable to read metadata at %s" % url) return json.loads(response.contents.decode()) def read_sysinfo(): # UpCloud embeds vendor ID and server UUID in the # SMBIOS information # Detect if we are on UpCloud and return the UUID vendor_name = dmi.read_dmi_data("system-manufacturer") if vendor_name != "UpCloud": return False, None server_uuid = dmi.read_dmi_data("system-uuid") if server_uuid: LOG.debug( "system identified via SMBIOS as UpCloud server: %s", server_uuid ) else: msg = ( "system identified via SMBIOS as a UpCloud server, but " "did not provide an ID. Please contact support via" "https://hub.upcloud.com or via email with support@upcloud.com" ) LOG.critical(msg) raise RuntimeError(msg) return True, server_uuid helpers/cloudsigma.py 0000644 00000005665 15027667240 0010734 0 ustar 00 # Copyright (C) 2014 CloudSigma # # Author: Kiril Vladimiroff <kiril.vladimiroff@cloudsigma.com> # # This file is part of cloud-init. See LICENSE file for license information. """ cepko implements easy-to-use communication with CloudSigma's VMs through a virtual serial port without bothering with formatting the messages properly nor parsing the output with the specific and sometimes confusing shell tools for that purpose. Having the server definition accessible by the VM can ve useful in various ways. For example it is possible to easily determine from within the VM, which network interfaces are connected to public and which to private network. Another use is to pass some data to initial VM setup scripts, like setting the hostname to the VM name or passing SSH public keys through server meta. For more information take a look at the Server Context section of CloudSigma API Docs: http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html """ import json import platform import serial # these high timeouts are necessary as read may read a lot of data. READ_TIMEOUT = 60 WRITE_TIMEOUT = 10 SERIAL_PORT = "/dev/ttyS1" if platform.system() == "Windows": SERIAL_PORT = "COM2" class Cepko: """ One instance of that object could be use for one or more queries to the serial port. """ request_pattern = "<\n{}\n>" def get(self, key="", request_pattern=None): if request_pattern is None: request_pattern = self.request_pattern return CepkoResult(request_pattern.format(key)) def all(self): return self.get() def meta(self, key=""): request_pattern = self.request_pattern.format("/meta/{}") return self.get(key, request_pattern) def global_context(self, key=""): request_pattern = self.request_pattern.format("/global_context/{}") return self.get(key, request_pattern) class CepkoResult: """ CepkoResult executes the request to the virtual serial port as soon as the instance is initialized and stores the result in both raw and marshalled format. """ def __init__(self, request): self.request = request self.raw_result = self._execute() self.result = self._marshal(self.raw_result) def _execute(self): connection = serial.Serial( port=SERIAL_PORT, timeout=READ_TIMEOUT, writeTimeout=WRITE_TIMEOUT ) connection.write(self.request.encode("ascii")) return connection.readline().strip(b"\x04\n").decode("ascii") def _marshal(self, raw_result): try: return json.loads(raw_result) except ValueError: return raw_result def __len__(self): return self.result.__len__() def __getitem__(self, key): return self.result.__getitem__(key) def __contains__(self, item): return self.result.__contains__(item) def __iter__(self): return self.result.__iter__() # vi: ts=4 expandtab helpers/digitalocean.py 0000644 00000016162 15027667240 0011222 0 ustar 00 # Author: Ben Howard <bh@digitalocean.com> # # This file is part of cloud-init. See LICENSE file for license information. import json import random from cloudinit import dmi from cloudinit import log as logging from cloudinit import net as cloudnet from cloudinit import subp, url_helper, util NIC_MAP = {"public": "eth0", "private": "eth1"} LOG = logging.getLogger(__name__) def assign_ipv4_link_local(distro, nic=None): """Bring up NIC using an address using link-local (ip4LL) IPs. On DigitalOcean, the link-local domain is per-droplet routed, so there is no risk of collisions. However, to be more safe, the ip4LL address is random. """ if not nic: nic = get_link_local_nic(distro) LOG.debug("selected interface '%s' for reading metadata", nic) if not nic: raise RuntimeError( "unable to find interfaces to access the" "meta-data server. This droplet is broken." ) addr = "169.254.{0}.{1}/16".format( random.randint(1, 168), random.randint(0, 255) ) ip_addr_cmd = ["ip", "addr", "add", addr, "dev", nic] ip_link_cmd = ["ip", "link", "set", "dev", nic, "up"] if not subp.which("ip"): raise RuntimeError( "No 'ip' command available to configure ip4LL address" ) try: subp.subp(ip_addr_cmd) LOG.debug("assigned ip4LL address '%s' to '%s'", addr, nic) subp.subp(ip_link_cmd) LOG.debug("brought device '%s' up", nic) except Exception: util.logexc( LOG, "ip4LL address assignment of '%s' to '%s' failed." " Droplet networking will be broken", addr, nic, ) raise return nic def get_link_local_nic(distro): nics = [ f for f in cloudnet.get_devicelist() if distro.networking.is_physical(f) ] if not nics: return None return min(nics, key=lambda d: cloudnet.read_sys_net_int(d, "ifindex")) def del_ipv4_link_local(nic=None): """Remove the ip4LL address. While this is not necessary, the ip4LL address is extraneous and confusing to users. """ if not nic: LOG.debug( "no link_local address interface defined, skipping link " "local address cleanup" ) return LOG.debug("cleaning up ipv4LL address") ip_addr_cmd = ["ip", "addr", "flush", "dev", nic] try: subp.subp(ip_addr_cmd) LOG.debug("removed ip4LL addresses from %s", nic) except Exception as e: util.logexc(LOG, "failed to remove ip4LL address from '%s'.", nic, e) def convert_network_configuration(config, dns_servers): """Convert the DigitalOcean Network description into Cloud-init's netconfig format. Example JSON: {'public': [ {'mac': '04:01:58:27:7f:01', 'ipv4': {'gateway': '45.55.32.1', 'netmask': '255.255.224.0', 'ip_address': '45.55.50.93'}, 'anchor_ipv4': { 'gateway': '10.17.0.1', 'netmask': '255.255.0.0', 'ip_address': '10.17.0.9'}, 'type': 'public', 'ipv6': {'gateway': '....', 'ip_address': '....', 'cidr': 64}} ], 'private': [ {'mac': '04:01:58:27:7f:02', 'ipv4': {'gateway': '10.132.0.1', 'netmask': '255.255.0.0', 'ip_address': '10.132.75.35'}, 'type': 'private'} ] } """ def _get_subnet_part(pcfg): subpart = { "type": "static", "control": "auto", "address": pcfg.get("ip_address"), "gateway": pcfg.get("gateway"), } if ":" in pcfg.get("ip_address"): subpart["address"] = "{0}/{1}".format( pcfg.get("ip_address"), pcfg.get("cidr") ) else: subpart["netmask"] = pcfg.get("netmask") return subpart nic_configs = [] macs_to_nics = cloudnet.get_interfaces_by_mac() LOG.debug("nic mapping: %s", macs_to_nics) for n in config: nic = config[n][0] LOG.debug("considering %s", nic) mac_address = nic.get("mac") if mac_address not in macs_to_nics: raise RuntimeError( "Did not find network interface on system " "with mac '%s'. Cannot apply configuration: %s" % (mac_address, nic) ) sysfs_name = macs_to_nics.get(mac_address) nic_type = nic.get("type", "unknown") if_name = NIC_MAP.get(nic_type, sysfs_name) if if_name != sysfs_name: LOG.debug( "Found %s interface '%s' on '%s', assigned name of '%s'", nic_type, mac_address, sysfs_name, if_name, ) else: msg = ( "Found interface '%s' on '%s', which is not a public " "or private interface. Using default system naming." ) LOG.debug(msg, mac_address, sysfs_name) ncfg = { "type": "physical", "mac_address": mac_address, "name": if_name, } subnets = [] for netdef in ("ipv4", "ipv6", "anchor_ipv4", "anchor_ipv6"): raw_subnet = nic.get(netdef, None) if not raw_subnet: continue sub_part = _get_subnet_part(raw_subnet) if nic_type != "public" or "anchor" in netdef: del sub_part["gateway"] subnets.append(sub_part) ncfg["subnets"] = subnets nic_configs.append(ncfg) LOG.debug("nic '%s' configuration: %s", if_name, ncfg) if dns_servers: LOG.debug("added dns servers: %s", dns_servers) nic_configs.append({"type": "nameserver", "address": dns_servers}) return {"version": 1, "config": nic_configs} def read_metadata(url, timeout=2, sec_between=2, retries=30): response = url_helper.readurl( url, timeout=timeout, sec_between=sec_between, retries=retries ) if not response.ok(): raise RuntimeError("unable to read metadata at %s" % url) return json.loads(response.contents.decode()) def read_sysinfo(): # DigitalOcean embeds vendor ID and instance/droplet_id in the # SMBIOS information # Detect if we are on DigitalOcean and return the Droplet's ID vendor_name = dmi.read_dmi_data("system-manufacturer") if vendor_name != "DigitalOcean": return (False, None) droplet_id = dmi.read_dmi_data("system-serial-number") if droplet_id: LOG.debug( "system identified via SMBIOS as DigitalOcean Droplet: %s", droplet_id, ) else: msg = ( "system identified via SMBIOS as a DigitalOcean " "Droplet, but did not provide an ID. Please file a " "support ticket at: " "https://cloud.digitalocean.com/support/tickets/new" ) LOG.critical(msg) raise RuntimeError(msg) return (True, droplet_id) # vi: ts=4 expandtab helpers/netlink.py 0000644 00000027407 15027667240 0010247 0 ustar 00 # Author: Tamilmani Manoharan <tamanoha@microsoft.com> # # This file is part of cloud-init. See LICENSE file for license information. import os import select import socket import struct from collections import namedtuple from cloudinit import log as logging from cloudinit import util LOG = logging.getLogger(__name__) # http://man7.org/linux/man-pages/man7/netlink.7.html RTMGRP_LINK = 1 NLMSG_NOOP = 1 NLMSG_ERROR = 2 NLMSG_DONE = 3 RTM_NEWLINK = 16 RTM_DELLINK = 17 RTM_GETLINK = 18 RTM_SETLINK = 19 MAX_SIZE = 65535 RTA_DATA_OFFSET = 32 MSG_TYPE_OFFSET = 16 SELECT_TIMEOUT = 60 NLMSGHDR_FMT = "IHHII" IFINFOMSG_FMT = "BHiII" NLMSGHDR_SIZE = struct.calcsize(NLMSGHDR_FMT) IFINFOMSG_SIZE = struct.calcsize(IFINFOMSG_FMT) RTATTR_START_OFFSET = NLMSGHDR_SIZE + IFINFOMSG_SIZE RTA_DATA_START_OFFSET = 4 PAD_ALIGNMENT = 4 IFLA_IFNAME = 3 IFLA_OPERSTATE = 16 # https://www.kernel.org/doc/Documentation/networking/operstates.txt OPER_UNKNOWN = 0 OPER_NOTPRESENT = 1 OPER_DOWN = 2 OPER_LOWERLAYERDOWN = 3 OPER_TESTING = 4 OPER_DORMANT = 5 OPER_UP = 6 RTAAttr = namedtuple("RTAAttr", ["length", "rta_type", "data"]) InterfaceOperstate = namedtuple("InterfaceOperstate", ["ifname", "operstate"]) NetlinkHeader = namedtuple( "NetlinkHeader", ["length", "type", "flags", "seq", "pid"] ) class NetlinkCreateSocketError(RuntimeError): """Raised if netlink socket fails during create or bind.""" def create_bound_netlink_socket(): """Creates netlink socket and bind on netlink group to catch interface down/up events. The socket will bound only on RTMGRP_LINK (which only includes RTM_NEWLINK/RTM_DELLINK/RTM_GETLINK events). The socket is set to non-blocking mode since we're only receiving messages. :returns: netlink socket in non-blocking mode :raises: NetlinkCreateSocketError """ try: netlink_socket = socket.socket( socket.AF_NETLINK, socket.SOCK_RAW, socket.NETLINK_ROUTE ) netlink_socket.bind((os.getpid(), RTMGRP_LINK)) netlink_socket.setblocking(0) except socket.error as e: msg = "Exception during netlink socket create: %s" % e raise NetlinkCreateSocketError(msg) from e LOG.debug("Created netlink socket") return netlink_socket def get_netlink_msg_header(data): """Gets netlink message type and length :param: data read from netlink socket :returns: netlink message type :raises: AssertionError if data is None or data is not >= NLMSGHDR_SIZE struct nlmsghdr { __u32 nlmsg_len; /* Length of message including header */ __u16 nlmsg_type; /* Type of message content */ __u16 nlmsg_flags; /* Additional flags */ __u32 nlmsg_seq; /* Sequence number */ __u32 nlmsg_pid; /* Sender port ID */ }; """ assert data is not None, "data is none" assert ( len(data) >= NLMSGHDR_SIZE ), "data is smaller than netlink message header" msg_len, msg_type, flags, seq, pid = struct.unpack( NLMSGHDR_FMT, data[:MSG_TYPE_OFFSET] ) LOG.debug("Got netlink msg of type %d", msg_type) return NetlinkHeader(msg_len, msg_type, flags, seq, pid) def read_netlink_socket(netlink_socket, timeout=None): """Select and read from the netlink socket if ready. :param: netlink_socket: specify which socket object to read from :param: timeout: specify a timeout value (integer) to wait while reading, if none, it will block indefinitely until socket ready for read :returns: string of data read (max length = <MAX_SIZE>) from socket, if no data read, returns None :raises: AssertionError if netlink_socket is None """ assert netlink_socket is not None, "netlink socket is none" read_set, _, _ = select.select([netlink_socket], [], [], timeout) # Incase of timeout,read_set doesn't contain netlink socket. # just return from this function if netlink_socket not in read_set: return None LOG.debug("netlink socket ready for read") data = netlink_socket.recv(MAX_SIZE) if data is None: LOG.error("Reading from Netlink socket returned no data") return data def unpack_rta_attr(data, offset): """Unpack a single rta attribute. :param: data: string of data read from netlink socket :param: offset: starting offset of RTA Attribute :return: RTAAttr object with length, type and data. On error, return None. :raises: AssertionError if data is None or offset is not integer. """ assert data is not None, "data is none" assert type(offset) == int, "offset is not integer" assert ( offset >= RTATTR_START_OFFSET ), "rta offset is less than expected length" length = rta_type = 0 attr_data = None try: length = struct.unpack_from("H", data, offset=offset)[0] rta_type = struct.unpack_from("H", data, offset=offset + 2)[0] except struct.error: return None # Should mean our offset is >= remaining data # Unpack just the attribute's data. Offset by 4 to skip length/type header attr_data = data[offset + RTA_DATA_START_OFFSET : offset + length] return RTAAttr(length, rta_type, attr_data) def read_rta_oper_state(data): """Reads Interface name and operational state from RTA Data. :param: data: string of data read from netlink socket :returns: InterfaceOperstate object containing if_name and oper_state. None if data does not contain valid IFLA_OPERSTATE and IFLA_IFNAME messages. :raises: AssertionError if data is None or length of data is smaller than RTATTR_START_OFFSET. """ assert data is not None, "data is none" assert ( len(data) > RTATTR_START_OFFSET ), "length of data is smaller than RTATTR_START_OFFSET" ifname = operstate = None offset = RTATTR_START_OFFSET while offset <= len(data): attr = unpack_rta_attr(data, offset) if not attr or attr.length == 0: break # Each attribute is 4-byte aligned. Determine pad length. padlen = ( PAD_ALIGNMENT - (attr.length % PAD_ALIGNMENT) ) % PAD_ALIGNMENT offset += attr.length + padlen if attr.rta_type == IFLA_OPERSTATE: operstate = ord(attr.data) elif attr.rta_type == IFLA_IFNAME: interface_name = util.decode_binary(attr.data, "utf-8") ifname = interface_name.strip("\0") if not ifname or operstate is None: return None LOG.debug("rta attrs: ifname %s operstate %d", ifname, operstate) return InterfaceOperstate(ifname, operstate) def wait_for_nic_attach_event(netlink_socket, existing_nics): """Block until a single nic is attached. :param: netlink_socket: netlink_socket to receive events :param: existing_nics: List of existing nics so that we can skip them. :raises: AssertionError if netlink_socket is none. """ LOG.debug("Preparing to wait for nic attach.") ifname = None def should_continue_cb(iname, carrier, prevCarrier): if iname in existing_nics: return True nonlocal ifname ifname = iname return False # We can return even if the operational state of the new nic is DOWN # because we set it to UP before doing dhcp. read_netlink_messages( netlink_socket, None, [RTM_NEWLINK], [OPER_UP, OPER_DOWN], should_continue_cb, ) return ifname def wait_for_nic_detach_event(netlink_socket): """Block until a single nic is detached and its operational state is down. :param: netlink_socket: netlink_socket to receive events. """ LOG.debug("Preparing to wait for nic detach.") ifname = None def should_continue_cb(iname, carrier, prevCarrier): nonlocal ifname ifname = iname return False read_netlink_messages( netlink_socket, None, [RTM_DELLINK], [OPER_DOWN], should_continue_cb ) return ifname def wait_for_media_disconnect_connect(netlink_socket, ifname): """Block until media disconnect and connect has happened on an interface. Listens on netlink socket to receive netlink events and when the carrier changes from 0 to 1, it considers event has happened and return from this function :param: netlink_socket: netlink_socket to receive events :param: ifname: Interface name to lookout for netlink events :raises: AssertionError if netlink_socket is None or ifname is None. """ assert netlink_socket is not None, "netlink socket is none" assert ifname is not None, "interface name is none" assert len(ifname) > 0, "interface name cannot be empty" def should_continue_cb(iname, carrier, prevCarrier): # check for carrier down, up sequence isVnetSwitch = (prevCarrier == OPER_DOWN) and (carrier == OPER_UP) if isVnetSwitch: LOG.debug("Media switch happened on %s.", ifname) return False return True LOG.debug("Wait for media disconnect and reconnect to happen") read_netlink_messages( netlink_socket, ifname, [RTM_NEWLINK, RTM_DELLINK], [OPER_UP, OPER_DOWN], should_continue_cb, ) def read_netlink_messages( netlink_socket, ifname_filter, rtm_types, operstates, should_continue_callback, ): """Reads from the netlink socket until the condition specified by the continuation callback is met. :param: netlink_socket: netlink_socket to receive events. :param: ifname_filter: if not None, will only listen for this interface. :param: rtm_types: Type of netlink events to listen for. :param: operstates: Operational states to listen. :param: should_continue_callback: Specifies when to stop listening. """ if netlink_socket is None: raise RuntimeError("Netlink socket is none") data = bytes() carrier = OPER_UP prevCarrier = OPER_UP while True: recv_data = read_netlink_socket(netlink_socket, SELECT_TIMEOUT) if recv_data is None: continue LOG.debug("read %d bytes from socket", len(recv_data)) data += recv_data LOG.debug("Length of data after concat %d", len(data)) offset = 0 datalen = len(data) while offset < datalen: nl_msg = data[offset:] if len(nl_msg) < NLMSGHDR_SIZE: LOG.debug("Data is smaller than netlink header") break nlheader = get_netlink_msg_header(nl_msg) if len(nl_msg) < nlheader.length: LOG.debug("Partial data. Smaller than netlink message") break padlen = (nlheader.length + PAD_ALIGNMENT - 1) & ~( PAD_ALIGNMENT - 1 ) offset = offset + padlen LOG.debug("offset to next netlink message: %d", offset) # Continue if we are not interested in this message. if nlheader.type not in rtm_types: continue interface_state = read_rta_oper_state(nl_msg) if interface_state is None: LOG.debug("Failed to read rta attributes: %s", interface_state) continue if ( ifname_filter is not None and interface_state.ifname != ifname_filter ): LOG.debug( "Ignored netlink event on interface %s. Waiting for %s.", interface_state.ifname, ifname_filter, ) continue if interface_state.operstate not in operstates: continue prevCarrier = carrier carrier = interface_state.operstate if not should_continue_callback( interface_state.ifname, carrier, prevCarrier ): return data = data[offset:] # vi: ts=4 expandtab helpers/hetzner.py 0000644 00000002461 15027667240 0010253 0 ustar 00 # Author: Jonas Keidel <jonas.keidel@hetzner.com> # Author: Markus Schade <markus.schade@hetzner.com> # # This file is part of cloud-init. See LICENSE file for license information. import base64 import binascii from cloudinit import url_helper, util def read_metadata(url, timeout=2, sec_between=2, retries=30): response = url_helper.readurl( url, timeout=timeout, sec_between=sec_between, retries=retries ) if not response.ok(): raise RuntimeError("unable to read metadata at %s" % url) return util.load_yaml(response.contents.decode()) def read_userdata(url, timeout=2, sec_between=2, retries=30): response = url_helper.readurl( url, timeout=timeout, sec_between=sec_between, retries=retries ) if not response.ok(): raise RuntimeError("unable to read userdata at %s" % url) return response.contents def maybe_b64decode(data: bytes) -> bytes: """base64 decode data If data is base64 encoded bytes, return b64decode(data). If not, return data unmodified. @param data: data as bytes. TypeError is raised if not bytes. """ if not isinstance(data, bytes): raise TypeError("data is '%s', expected bytes" % type(data)) try: return base64.b64decode(data, validate=True) except binascii.Error: return data helpers/openstack.py 0000644 00000062611 15027667240 0010566 0 ustar 00 # Copyright (C) 2012 Canonical Ltd. # Copyright (C) 2012 Yahoo! Inc. # # Author: Scott Moser <scott.moser@canonical.com> # Author: Joshua Harlow <harlowja@yahoo-inc.com> # # This file is part of cloud-init. See LICENSE file for license information. import abc import base64 import copy import functools import os from cloudinit import log as logging from cloudinit import net, sources, subp, url_helper, util from cloudinit.sources import BrokenMetadata from cloudinit.sources.helpers import ec2 # See https://docs.openstack.org/user-guide/cli-config-drive.html LOG = logging.getLogger(__name__) FILES_V1 = { # Path <-> (metadata key name, translator function, default value) "etc/network/interfaces": ("network_config", lambda x: x, ""), "meta.js": ("meta_js", util.load_json, {}), "root/.ssh/authorized_keys": ("authorized_keys", lambda x: x, ""), } KEY_COPIES = ( # Cloud-init metadata names <-> (metadata key, is required) ("local-hostname", "hostname", False), ("instance-id", "uuid", True), ) # Versions and names taken from nova source nova/api/metadata/base.py OS_LATEST = "latest" OS_FOLSOM = "2012-08-10" OS_GRIZZLY = "2013-04-04" OS_HAVANA = "2013-10-17" OS_LIBERTY = "2015-10-15" # NEWTON_ONE adds 'devices' to md (sriov-pf-passthrough-neutron-port-vlan) OS_NEWTON_ONE = "2016-06-30" # NEWTON_TWO adds vendor_data2.json (vendordata-reboot) OS_NEWTON_TWO = "2016-10-06" # OS_OCATA adds 'vif' field to devices (sriov-pf-passthrough-neutron-port-vlan) OS_OCATA = "2017-02-22" # OS_ROCKY adds a vf_trusted field to devices (sriov-trusted-vfs) OS_ROCKY = "2018-08-27" # keep this in chronological order. new supported versions go at the end. OS_VERSIONS = ( OS_FOLSOM, OS_GRIZZLY, OS_HAVANA, OS_LIBERTY, OS_NEWTON_ONE, OS_NEWTON_TWO, OS_OCATA, OS_ROCKY, ) KNOWN_PHYSICAL_TYPES = ( None, "bgpovs", # not present in OpenStack upstream but used on OVH cloud. "bridge", "cascading", # not present in OpenStack upstream, used on OpenTelekomCloud "dvs", "ethernet", "hw_veb", "hyperv", "ovs", "phy", "tap", "vhostuser", "vif", ) class NonReadable(IOError): pass class SourceMixin: def _ec2_name_to_device(self, name): if not self.ec2_metadata: return None bdm = self.ec2_metadata.get("block-device-mapping", {}) for (ent_name, device) in bdm.items(): if name == ent_name: return device return None def get_public_ssh_keys(self): name = "public_keys" if self.version == 1: name = "public-keys" return sources.normalize_pubkey_data(self.metadata.get(name)) def _os_name_to_device(self, name): device = None try: criteria = "LABEL=%s" % (name) if name == "swap": criteria = "TYPE=%s" % (name) dev_entries = util.find_devs_with(criteria) if dev_entries: device = dev_entries[0] except subp.ProcessExecutionError: pass return device def _validate_device_name(self, device): if not device: return None if not device.startswith("/"): device = "/dev/%s" % device if os.path.exists(device): return device # Durn, try adjusting the mapping remapped = self._remap_device(os.path.basename(device)) if remapped: LOG.debug("Remapped device name %s => %s", device, remapped) return remapped return None def device_name_to_device(self, name): # Translate a 'name' to a 'physical' device if not name: return None # Try the ec2 mapping first names = [name] if name == "root": names.insert(0, "ami") if name == "ami": names.append("root") device = None LOG.debug("Using ec2 style lookup to find device %s", names) for n in names: device = self._ec2_name_to_device(n) device = self._validate_device_name(device) if device: break # Try the openstack way second if not device: LOG.debug("Using openstack style lookup to find device %s", names) for n in names: device = self._os_name_to_device(n) device = self._validate_device_name(device) if device: break # Ok give up... if not device: return None else: LOG.debug("Mapped %s to device %s", name, device) return device class BaseReader(metaclass=abc.ABCMeta): def __init__(self, base_path): self.base_path = base_path @abc.abstractmethod def _path_join(self, base, *add_ons): pass @abc.abstractmethod def _path_read(self, path, decode=False): pass @abc.abstractmethod def _fetch_available_versions(self): pass @abc.abstractmethod def _read_ec2_metadata(self): pass def _find_working_version(self): try: versions_available = self._fetch_available_versions() except Exception as e: LOG.debug( "Unable to read openstack versions from %s due to: %s", self.base_path, e, ) versions_available = [] # openstack.OS_VERSIONS is stored in chronological order, so # reverse it to check newest first. supported = [v for v in reversed(list(OS_VERSIONS))] selected_version = OS_LATEST for potential_version in supported: if potential_version not in versions_available: continue selected_version = potential_version break LOG.debug( "Selected version '%s' from %s", selected_version, versions_available, ) return selected_version def _read_content_path(self, item, decode=False): path = item.get("content_path", "").lstrip("/") path_pieces = path.split("/") valid_pieces = [p for p in path_pieces if len(p)] if not valid_pieces: raise BrokenMetadata("Item %s has no valid content path" % (item)) path = self._path_join(self.base_path, "openstack", *path_pieces) return self._path_read(path, decode=decode) def read_v2(self): """Reads a version 2 formatted location. Return a dict with metadata, userdata, ec2-metadata, dsmode, network_config, files and version (2). If not a valid location, raise a NonReadable exception. """ load_json_anytype = functools.partial( util.load_json, root_types=(dict, list, str) ) def datafiles(version): files = {} files["metadata"] = ( # File path to read self._path_join("openstack", version, "meta_data.json"), # Is it required? True, # Translator function (applied after loading) util.load_json, ) files["userdata"] = ( self._path_join("openstack", version, "user_data"), False, lambda x: x, ) files["vendordata"] = ( self._path_join("openstack", version, "vendor_data.json"), False, load_json_anytype, ) files["vendordata2"] = ( self._path_join("openstack", version, "vendor_data2.json"), False, load_json_anytype, ) files["networkdata"] = ( self._path_join("openstack", version, "network_data.json"), False, load_json_anytype, ) return files results = { "userdata": "", "version": 2, } data = datafiles(self._find_working_version()) for (name, (path, required, translator)) in data.items(): path = self._path_join(self.base_path, path) data = None found = False try: data = self._path_read(path) except IOError as e: if not required: LOG.debug( "Failed reading optional path %s due to: %s", path, e ) else: LOG.debug( "Failed reading mandatory path %s due to: %s", path, e ) else: found = True if required and not found: raise NonReadable("Missing mandatory path: %s" % path) if found and translator: try: data = translator(data) except Exception as e: raise BrokenMetadata( "Failed to process path %s: %s" % (path, e) ) from e if found: results[name] = data metadata = results["metadata"] if "random_seed" in metadata: random_seed = metadata["random_seed"] try: metadata["random_seed"] = base64.b64decode(random_seed) except (ValueError, TypeError) as e: raise BrokenMetadata( "Badly formatted metadata random_seed entry: %s" % e ) from e # load any files that were provided files = {} metadata_files = metadata.get("files", []) for item in metadata_files: if "path" not in item: continue path = item["path"] try: files[path] = self._read_content_path(item) except Exception as e: raise BrokenMetadata( "Failed to read provided file %s: %s" % (path, e) ) from e results["files"] = files # The 'network_config' item in metadata is a content pointer # to the network config that should be applied. It is just a # ubuntu/debian '/etc/network/interfaces' file. net_item = metadata.get("network_config", None) if net_item: try: content = self._read_content_path(net_item, decode=True) results["network_config"] = content except IOError as e: raise BrokenMetadata( "Failed to read network configuration: %s" % (e) ) from e # To openstack, user can specify meta ('nova boot --meta=key=value') # and those will appear under metadata['meta']. # if they specify 'dsmode' they're indicating the mode that they intend # for this datasource to operate in. try: results["dsmode"] = metadata["meta"]["dsmode"] except KeyError: pass # Read any ec2-metadata (if applicable) results["ec2-metadata"] = self._read_ec2_metadata() # Perform some misc. metadata key renames... for (target_key, source_key, is_required) in KEY_COPIES: if is_required and source_key not in metadata: raise BrokenMetadata("No '%s' entry in metadata" % source_key) if source_key in metadata: metadata[target_key] = metadata.get(source_key) return results class ConfigDriveReader(BaseReader): def __init__(self, base_path): super(ConfigDriveReader, self).__init__(base_path) self._versions = None def _path_join(self, base, *add_ons): components = [base] + list(add_ons) return os.path.join(*components) def _path_read(self, path, decode=False): return util.load_file(path, decode=decode) def _fetch_available_versions(self): if self._versions is None: path = self._path_join(self.base_path, "openstack") found = [ d for d in os.listdir(path) if os.path.isdir(os.path.join(path)) ] self._versions = sorted(found) return self._versions def _read_ec2_metadata(self): path = self._path_join( self.base_path, "ec2", "latest", "meta-data.json" ) if not os.path.exists(path): return {} else: try: return util.load_json(self._path_read(path)) except Exception as e: raise BrokenMetadata( "Failed to process path %s: %s" % (path, e) ) from e def read_v1(self): """Reads a version 1 formatted location. Return a dict with metadata, userdata, dsmode, files and version (1). If not a valid path, raise a NonReadable exception. """ found = {} for name in FILES_V1.keys(): path = self._path_join(self.base_path, name) if os.path.exists(path): found[name] = path if len(found) == 0: raise NonReadable("%s: no files found" % (self.base_path)) md = {} for (name, (key, translator, default)) in FILES_V1.items(): if name in found: path = found[name] try: contents = self._path_read(path) except IOError as e: raise BrokenMetadata("Failed to read: %s" % path) from e try: # Disable not-callable pylint check; pylint isn't able to # determine that every member of FILES_V1 has a callable in # the appropriate position md[key] = translator(contents) # pylint: disable=E1102 except Exception as e: raise BrokenMetadata( "Failed to process path %s: %s" % (path, e) ) from e else: md[key] = copy.deepcopy(default) keydata = md["authorized_keys"] meta_js = md["meta_js"] # keydata in meta_js is preferred over "injected" keydata = meta_js.get("public-keys", keydata) if keydata: lines = keydata.splitlines() md["public-keys"] = [ line for line in lines if len(line) and not line.startswith("#") ] # config-drive-v1 has no way for openstack to provide the instance-id # so we copy that into metadata from the user input if "instance-id" in meta_js: md["instance-id"] = meta_js["instance-id"] results = { "version": 1, "metadata": md, } # allow the user to specify 'dsmode' in a meta tag if "dsmode" in meta_js: results["dsmode"] = meta_js["dsmode"] # config-drive-v1 has no way of specifying user-data, so the user has # to cheat and stuff it in a meta tag also. results["userdata"] = meta_js.get("user-data", "") # this implementation does not support files other than # network/interfaces and authorized_keys... results["files"] = {} return results class MetadataReader(BaseReader): def __init__(self, base_url, ssl_details=None, timeout=5, retries=5): super(MetadataReader, self).__init__(base_url) self.ssl_details = ssl_details self.timeout = float(timeout) self.retries = int(retries) self._versions = None def _fetch_available_versions(self): # <baseurl>/openstack/ returns a newline separated list of versions if self._versions is not None: return self._versions found = [] version_path = self._path_join(self.base_path, "openstack") content = self._path_read(version_path, decode=True) for line in content.splitlines(): line = line.strip() if not line: continue found.append(line) self._versions = found return self._versions def _path_read(self, path, decode=False): def should_retry_cb(_request_args, cause): try: code = int(cause.code) if code >= 400: return False except (TypeError, ValueError): # Older versions of requests didn't have a code. pass return True response = url_helper.readurl( path, retries=self.retries, ssl_details=self.ssl_details, timeout=self.timeout, exception_cb=should_retry_cb, ) if decode: return response.contents.decode() else: return response.contents def _path_join(self, base, *add_ons): return url_helper.combine_url(base, *add_ons) def _read_ec2_metadata(self): return ec2.get_instance_metadata( ssl_details=self.ssl_details, timeout=self.timeout, retries=self.retries, ) # Convert OpenStack ConfigDrive NetworkData json to network_config yaml def convert_net_json(network_json=None, known_macs=None): """Return a dictionary of network_config by parsing provided OpenStack ConfigDrive NetworkData json format OpenStack network_data.json provides a 3 element dictionary - "links" (links are network devices, physical or virtual) - "networks" (networks are ip network configurations for one or more links) - services (non-ip services, like dns) networks and links are combined via network items referencing specific links via a 'link_id' which maps to a links 'id' field. To convert this format to network_config yaml, we first iterate over the links and then walk the network list to determine if any of the networks utilize the current link; if so we generate a subnet entry for the device We also need to map network_data.json fields to network_config fields. For example, the network_data links 'id' field is equivalent to network_config 'name' field for devices. We apply more of this mapping to the various link types that we encounter. There are additional fields that are populated in the network_data.json from OpenStack that are not relevant to network_config yaml, so we enumerate a dictionary of valid keys for network_yaml and apply filtering to drop these superflous keys from the network_config yaml. """ if network_json is None: return None # dict of network_config key for filtering network_json valid_keys = { "physical": [ "name", "type", "mac_address", "subnets", "params", "mtu", ], "subnet": [ "type", "address", "netmask", "broadcast", "metric", "gateway", "pointopoint", "scope", "dns_nameservers", "dns_search", "routes", ], } links = network_json.get("links", []) networks = network_json.get("networks", []) services = network_json.get("services", []) link_updates = [] link_id_info = {} bond_name_fmt = "bond%d" bond_number = 0 config = [] for link in links: subnets = [] cfg = dict( (k, v) for k, v in link.items() if k in valid_keys["physical"] ) # 'name' is not in openstack spec yet, but we will support it if it is # present. The 'id' in the spec is currently implemented as the host # nic's name, meaning something like 'tap-adfasdffd'. We do not want # to name guest devices with such ugly names. if "name" in link: cfg["name"] = link["name"] link_mac_addr = None if link.get("ethernet_mac_address"): link_mac_addr = link.get("ethernet_mac_address").lower() link_id_info[link["id"]] = link_mac_addr curinfo = { "name": cfg.get("name"), "mac": link_mac_addr, "id": link["id"], "type": link["type"], } for network in [n for n in networks if n["link"] == link["id"]]: subnet = dict( (k, v) for k, v in network.items() if k in valid_keys["subnet"] ) if network["type"] == "ipv4_dhcp": subnet.update({"type": "dhcp4"}) elif network["type"] == "ipv6_dhcp": subnet.update({"type": "dhcp6"}) elif network["type"] in [ "ipv6_slaac", "ipv6_dhcpv6-stateless", "ipv6_dhcpv6-stateful", ]: subnet.update({"type": network["type"]}) elif network["type"] in ["ipv4", "static"]: subnet.update( { "type": "static", "address": network.get("ip_address"), } ) elif network["type"] in ["ipv6", "static6"]: cfg.update({"accept-ra": False}) subnet.update( { "type": "static6", "address": network.get("ip_address"), } ) # Enable accept_ra for stateful and legacy ipv6_dhcp types if network["type"] in ["ipv6_dhcpv6-stateful", "ipv6_dhcp"]: cfg.update({"accept-ra": True}) if network["type"] == "ipv4": subnet["ipv4"] = True if network["type"] == "ipv6": subnet["ipv6"] = True subnets.append(subnet) cfg.update({"subnets": subnets}) if link["type"] in ["bond"]: params = {} if link_mac_addr: params["mac_address"] = link_mac_addr for k, v in link.items(): if k == "bond_links": continue elif k.startswith("bond"): params.update({k: v}) # openstack does not provide a name for the bond. # they do provide an 'id', but that is possibly non-sensical. # so we just create our own name. link_name = bond_name_fmt % bond_number bond_number += 1 # bond_links reference links by their id, but we need to add # to the network config by their nic name. # store that in bond_links_needed, and update these later. link_updates.append( ( cfg, "bond_interfaces", "%s", copy.deepcopy(link["bond_links"]), ) ) cfg.update({"params": params, "name": link_name}) curinfo["name"] = link_name elif link["type"] in ["vlan"]: name = "%s.%s" % (link["vlan_link"], link["vlan_id"]) cfg.update( { "name": name, "vlan_id": link["vlan_id"], "mac_address": link["vlan_mac_address"], } ) link_updates.append((cfg, "vlan_link", "%s", link["vlan_link"])) link_updates.append( (cfg, "name", "%%s.%s" % link["vlan_id"], link["vlan_link"]) ) curinfo.update({"mac": link["vlan_mac_address"], "name": name}) else: if link["type"] not in KNOWN_PHYSICAL_TYPES: LOG.warning( "Unknown network_data link type (%s); treating as" " physical", link["type"], ) cfg.update({"type": "physical", "mac_address": link_mac_addr}) config.append(cfg) link_id_info[curinfo["id"]] = curinfo need_names = [ d for d in config if d.get("type") == "physical" and "name" not in d ] if need_names or link_updates: if known_macs is None: known_macs = net.get_interfaces_by_mac() # go through and fill out the link_id_info with names for _link_id, info in link_id_info.items(): if info.get("name"): continue if info.get("mac") in known_macs: info["name"] = known_macs[info["mac"]] for d in need_names: mac = d.get("mac_address") if not mac: raise ValueError("No mac_address or name entry for %s" % d) if mac not in known_macs: raise ValueError("Unable to find a system nic for %s" % d) d["name"] = known_macs[mac] for cfg, key, fmt, targets in link_updates: if isinstance(targets, (list, tuple)): cfg[key] = [ fmt % link_id_info[target]["name"] for target in targets ] else: cfg[key] = fmt % link_id_info[targets]["name"] # Infiniband interfaces may be referenced in network_data.json by a 6 byte # Ethernet MAC-style address, and we use that address to look up the # interface name above. Now ensure that the hardware address is set to the # full 20 byte address. ib_known_hwaddrs = net.get_ib_hwaddrs_by_interface() if ib_known_hwaddrs: for cfg in config: if cfg["name"] in ib_known_hwaddrs: cfg["mac_address"] = ib_known_hwaddrs[cfg["name"]] cfg["type"] = "infiniband" for service in services: cfg = service cfg.update({"type": "nameserver"}) config.append(cfg) return {"version": 1, "config": config} # vi: ts=4 expandtab helpers/azure.py 0000644 00000131050 15027667240 0007717 0 ustar 00 # This file is part of cloud-init. See LICENSE file for license information. import base64 import enum import json import logging import os import re import socket import struct import textwrap import zlib from contextlib import contextmanager from datetime import datetime from errno import ENOENT from time import sleep, time from typing import Callable, List, Optional, TypeVar, Union from xml.etree import ElementTree from xml.sax.saxutils import escape from cloudinit import distros, dmi, subp, temp_utils, url_helper, util, version from cloudinit.reporting import events from cloudinit.settings import CFG_BUILTIN LOG = logging.getLogger(__name__) # Default Wireserver endpoint (if not found in DHCP option 245). DEFAULT_WIRESERVER_ENDPOINT = "168.63.129.16" BOOT_EVENT_TYPE = "boot-telemetry" SYSTEMINFO_EVENT_TYPE = "system-info" DIAGNOSTIC_EVENT_TYPE = "diagnostic" COMPRESSED_EVENT_TYPE = "compressed" # Maximum number of bytes of the cloud-init.log file that can be dumped to KVP # at once. This number is based on the analysis done on a large sample of # cloud-init.log files where the P95 of the file sizes was 537KB and the time # consumed to dump 500KB file was (P95:76, P99:233, P99.9:1170) in ms MAX_LOG_TO_KVP_LENGTH = 512000 # File to store the last byte of cloud-init.log that was pushed to KVP. This # file will be deleted with every VM reboot. LOG_PUSHED_TO_KVP_INDEX_FILE = "/run/cloud-init/log_pushed_to_kvp_index" azure_ds_reporter = events.ReportEventStack( name="azure-ds", description="initialize reporter for azure ds", reporting_enabled=True, ) DEFAULT_REPORT_FAILURE_USER_VISIBLE_MESSAGE = ( "The VM encountered an error during deployment. " "Please visit https://aka.ms/linuxprovisioningerror " "for more information on remediation." ) T = TypeVar("T") def azure_ds_telemetry_reporter(func: Callable[..., T]) -> Callable[..., T]: def impl(*args, **kwargs): with events.ReportEventStack( name=func.__name__, description=func.__name__, parent=azure_ds_reporter, ): return func(*args, **kwargs) return impl def is_byte_swapped(previous_id, current_id): """ Azure stores the instance ID with an incorrect byte ordering for the first parts. This corrects the byte order such that it is consistent with that returned by the metadata service. """ if previous_id == current_id: return False def swap_bytestring(s, width=2): dd = [byte for byte in textwrap.wrap(s, 2)] dd.reverse() return "".join(dd) parts = current_id.split("-") swapped_id = "-".join( [ swap_bytestring(parts[0]), swap_bytestring(parts[1]), swap_bytestring(parts[2]), parts[3], parts[4], ] ) return previous_id == swapped_id @azure_ds_telemetry_reporter def get_boot_telemetry(): """Report timestamps related to kernel initialization and systemd activation of cloud-init""" if not distros.uses_systemd(): raise RuntimeError("distro not using systemd, skipping boot telemetry") LOG.debug("Collecting boot telemetry") try: kernel_start = float(time()) - float(util.uptime()) except ValueError as e: raise RuntimeError("Failed to determine kernel start timestamp") from e try: out, _ = subp.subp( ["systemctl", "show", "-p", "UserspaceTimestampMonotonic"], capture=True, ) tsm = None if out and "=" in out: tsm = out.split("=")[1] if not tsm: raise RuntimeError( "Failed to parse UserspaceTimestampMonotonic from systemd" ) user_start = kernel_start + (float(tsm) / 1000000) except subp.ProcessExecutionError as e: raise RuntimeError( "Failed to get UserspaceTimestampMonotonic: %s" % e ) from e except ValueError as e: raise RuntimeError( "Failed to parse UserspaceTimestampMonotonic from systemd: %s" % e ) from e try: out, _ = subp.subp( [ "systemctl", "show", "cloud-init-local", "-p", "InactiveExitTimestampMonotonic", ], capture=True, ) tsm = None if out and "=" in out: tsm = out.split("=")[1] if not tsm: raise RuntimeError( "Failed to parse InactiveExitTimestampMonotonic from systemd" ) cloudinit_activation = kernel_start + (float(tsm) / 1000000) except subp.ProcessExecutionError as e: raise RuntimeError( "Failed to get InactiveExitTimestampMonotonic: %s" % e ) from e except ValueError as e: raise RuntimeError( "Failed to parse InactiveExitTimestampMonotonic from systemd: %s" % e ) from e evt = events.ReportingEvent( BOOT_EVENT_TYPE, "boot-telemetry", "kernel_start=%s user_start=%s cloudinit_activation=%s" % ( datetime.utcfromtimestamp(kernel_start).isoformat() + "Z", datetime.utcfromtimestamp(user_start).isoformat() + "Z", datetime.utcfromtimestamp(cloudinit_activation).isoformat() + "Z", ), events.DEFAULT_EVENT_ORIGIN, ) events.report_event(evt) # return the event for unit testing purpose return evt @azure_ds_telemetry_reporter def get_system_info(): """Collect and report system information""" info = util.system_info() evt = events.ReportingEvent( SYSTEMINFO_EVENT_TYPE, "system information", "cloudinit_version=%s, kernel_version=%s, variant=%s, " "distro_name=%s, distro_version=%s, flavor=%s, " "python_version=%s" % ( version.version_string(), info["release"], info["variant"], info["dist"][0], info["dist"][1], info["dist"][2], info["python"], ), events.DEFAULT_EVENT_ORIGIN, ) events.report_event(evt) # return the event for unit testing purpose return evt def report_diagnostic_event( msg: str, *, logger_func=None ) -> events.ReportingEvent: """Report a diagnostic event""" if callable(logger_func): logger_func(msg) evt = events.ReportingEvent( DIAGNOSTIC_EVENT_TYPE, "diagnostic message", msg, events.DEFAULT_EVENT_ORIGIN, ) events.report_event(evt, excluded_handler_types={"log"}) # return the event for unit testing purpose return evt def report_compressed_event(event_name, event_content): """Report a compressed event""" compressed_data = base64.encodebytes(zlib.compress(event_content)) event_data = { "encoding": "gz+b64", "data": compressed_data.decode("ascii"), } evt = events.ReportingEvent( COMPRESSED_EVENT_TYPE, event_name, json.dumps(event_data), events.DEFAULT_EVENT_ORIGIN, ) events.report_event( evt, excluded_handler_types={"log", "print", "webhook"} ) # return the event for unit testing purpose return evt @azure_ds_telemetry_reporter def push_log_to_kvp(file_name=CFG_BUILTIN["def_log_file"]): """Push a portion of cloud-init.log file or the whole file to KVP based on the file size. The first time this function is called after VM boot, It will push the last n bytes of the log file such that n < MAX_LOG_TO_KVP_LENGTH If called again on the same boot, it continues from where it left off. In addition to cloud-init.log, dmesg log will also be collected.""" start_index = get_last_log_byte_pushed_to_kvp_index() LOG.debug("Dumping cloud-init.log file to KVP") try: with open(file_name, "rb") as f: f.seek(0, os.SEEK_END) seek_index = max(f.tell() - MAX_LOG_TO_KVP_LENGTH, start_index) report_diagnostic_event( "Dumping last {0} bytes of cloud-init.log file to KVP starting" " from index: {1}".format(f.tell() - seek_index, seek_index), logger_func=LOG.debug, ) f.seek(seek_index, os.SEEK_SET) report_compressed_event("cloud-init.log", f.read()) util.write_file(LOG_PUSHED_TO_KVP_INDEX_FILE, str(f.tell())) except Exception as ex: report_diagnostic_event( "Exception when dumping log file: %s" % repr(ex), logger_func=LOG.warning, ) LOG.debug("Dumping dmesg log to KVP") try: out, _ = subp.subp(["dmesg"], decode=False, capture=True) report_compressed_event("dmesg", out) except Exception as ex: report_diagnostic_event( "Exception when dumping dmesg log: %s" % repr(ex), logger_func=LOG.warning, ) @azure_ds_telemetry_reporter def get_last_log_byte_pushed_to_kvp_index(): try: with open(LOG_PUSHED_TO_KVP_INDEX_FILE, "r") as f: return int(f.read()) except IOError as e: if e.errno != ENOENT: report_diagnostic_event( "Reading LOG_PUSHED_TO_KVP_INDEX_FILE failed: %s." % repr(e), logger_func=LOG.warning, ) except ValueError as e: report_diagnostic_event( "Invalid value in LOG_PUSHED_TO_KVP_INDEX_FILE: %s." % repr(e), logger_func=LOG.warning, ) except Exception as e: report_diagnostic_event( "Failed to get the last log byte pushed to KVP: %s." % repr(e), logger_func=LOG.warning, ) return 0 @contextmanager def cd(newdir): prevdir = os.getcwd() os.chdir(os.path.expanduser(newdir)) try: yield finally: os.chdir(prevdir) def get_ip_from_lease_value(fallback_lease_value): unescaped_value = fallback_lease_value.replace("\\", "") if len(unescaped_value) > 4: hex_string = "" for hex_pair in unescaped_value.split(":"): if len(hex_pair) == 1: hex_pair = "0" + hex_pair hex_string += hex_pair packed_bytes = struct.pack(">L", int(hex_string.replace(":", ""), 16)) else: packed_bytes = unescaped_value.encode("utf-8") return socket.inet_ntoa(packed_bytes) @azure_ds_telemetry_reporter def http_with_retries( url: str, *, headers: dict, data: Optional[bytes] = None, retry_sleep: int = 5, timeout_minutes: int = 20, ) -> url_helper.UrlResponse: """Readurl wrapper for querying wireserver. :param retry_sleep: Time to sleep before retrying. :param timeout_minutes: Retry up to specified number of minutes. :raises UrlError: on error fetching data. """ timeout = timeout_minutes * 60 + time() attempt = 0 response = None while not response: attempt += 1 try: response = url_helper.readurl( url, headers=headers, data=data, timeout=(5, 60) ) break except url_helper.UrlError as e: report_diagnostic_event( "Failed HTTP request with Azure endpoint %s during " "attempt %d with exception: %s (code=%r headers=%r)" % (url, attempt, e, e.code, e.headers), logger_func=LOG.debug, ) # Raise exception if we're out of time or network is unreachable. # If network is unreachable: # - retries will not resolve the situation # - for reporting ready for PPS, this generally means VM was put # to sleep or network interface was unplugged before we see # the call complete successfully. if ( time() + retry_sleep >= timeout or "Network is unreachable" in str(e) ): raise sleep(retry_sleep) report_diagnostic_event( "Successful HTTP request with Azure endpoint %s after " "%d attempts" % (url, attempt), logger_func=LOG.debug, ) return response def build_minimal_ovf( username: str, hostname: str, disableSshPwd: str ) -> bytes: OVF_ENV_TEMPLATE = textwrap.dedent( """\ <ns0:Environment xmlns:ns0="http://schemas.dmtf.org/ovf/environment/1" xmlns:ns1="http://schemas.microsoft.com/windowsazure" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ns1:ProvisioningSection> <ns1:Version>1.0</ns1:Version> <ns1:LinuxProvisioningConfigurationSet> <ns1:ConfigurationSetType>LinuxProvisioningConfiguration </ns1:ConfigurationSetType> <ns1:UserName>{username}</ns1:UserName> <ns1:DisableSshPasswordAuthentication>{disableSshPwd} </ns1:DisableSshPasswordAuthentication> <ns1:HostName>{hostname}</ns1:HostName> </ns1:LinuxProvisioningConfigurationSet> </ns1:ProvisioningSection> <ns1:PlatformSettingsSection> <ns1:Version>1.0</ns1:Version> <ns1:PlatformSettings> <ns1:ProvisionGuestAgent>true</ns1:ProvisionGuestAgent> </ns1:PlatformSettings> </ns1:PlatformSettingsSection> </ns0:Environment> """ ) ret = OVF_ENV_TEMPLATE.format( username=username, hostname=hostname, disableSshPwd=disableSshPwd ) return ret.encode("utf-8") class AzureEndpointHttpClient: headers = { "x-ms-agent-name": "WALinuxAgent", "x-ms-version": "2012-11-30", } def __init__(self, certificate): self.extra_secure_headers = { "x-ms-cipher-name": "DES_EDE3_CBC", "x-ms-guest-agent-public-x509-cert": certificate, } def get(self, url, secure=False) -> url_helper.UrlResponse: headers = self.headers if secure: headers = self.headers.copy() headers.update(self.extra_secure_headers) return http_with_retries(url, headers=headers) def post( self, url, data: Optional[bytes] = None, extra_headers=None ) -> url_helper.UrlResponse: headers = self.headers if extra_headers is not None: headers = self.headers.copy() headers.update(extra_headers) return http_with_retries(url, data=data, headers=headers) class InvalidGoalStateXMLException(Exception): """Raised when GoalState XML is invalid or has missing data.""" class GoalState: def __init__( self, unparsed_xml: Union[str, bytes], azure_endpoint_client: AzureEndpointHttpClient, need_certificate: bool = True, ) -> None: """Parses a GoalState XML string and returns a GoalState object. @param unparsed_xml: string representing a GoalState XML. @param azure_endpoint_client: instance of AzureEndpointHttpClient. @param need_certificate: switch to know if certificates is needed. @return: GoalState object representing the GoalState XML string. """ self.azure_endpoint_client = azure_endpoint_client try: self.root = ElementTree.fromstring(unparsed_xml) except ElementTree.ParseError as e: report_diagnostic_event( "Failed to parse GoalState XML: %s" % e, logger_func=LOG.warning, ) raise self.container_id = self._text_from_xpath("./Container/ContainerId") self.instance_id = self._text_from_xpath( "./Container/RoleInstanceList/RoleInstance/InstanceId" ) self.incarnation = self._text_from_xpath("./Incarnation") for attr in ("container_id", "instance_id", "incarnation"): if getattr(self, attr) is None: msg = "Missing %s in GoalState XML" % attr report_diagnostic_event(msg, logger_func=LOG.warning) raise InvalidGoalStateXMLException(msg) self.certificates_xml = None url = self._text_from_xpath( "./Container/RoleInstanceList/RoleInstance" "/Configuration/Certificates" ) if url is not None and need_certificate: with events.ReportEventStack( name="get-certificates-xml", description="get certificates xml", parent=azure_ds_reporter, ): self.certificates_xml = self.azure_endpoint_client.get( url, secure=True ).contents if self.certificates_xml is None: raise InvalidGoalStateXMLException( "Azure endpoint returned empty certificates xml." ) def _text_from_xpath(self, xpath): element = self.root.find(xpath) if element is not None: return element.text return None class OpenSSLManager: certificate_names = { "private_key": "TransportPrivate.pem", "certificate": "TransportCert.pem", } def __init__(self): self.tmpdir = temp_utils.mkdtemp() self._certificate = None self.generate_certificate() def clean_up(self): util.del_dir(self.tmpdir) @property def certificate(self): return self._certificate @certificate.setter def certificate(self, value): self._certificate = value @azure_ds_telemetry_reporter def generate_certificate(self): LOG.debug("Generating certificate for communication with fabric...") if self.certificate is not None: LOG.debug("Certificate already generated.") return with cd(self.tmpdir): subp.subp( [ "openssl", "req", "-x509", "-nodes", "-subj", "/CN=LinuxTransport", "-days", "32768", "-newkey", "rsa:2048", "-keyout", self.certificate_names["private_key"], "-out", self.certificate_names["certificate"], ] ) certificate = "" for line in open(self.certificate_names["certificate"]): if "CERTIFICATE" not in line: certificate += line.rstrip() self.certificate = certificate LOG.debug("New certificate generated.") @staticmethod @azure_ds_telemetry_reporter def _run_x509_action(action, cert): cmd = ["openssl", "x509", "-noout", action] result, _ = subp.subp(cmd, data=cert) return result @azure_ds_telemetry_reporter def _get_ssh_key_from_cert(self, certificate): pub_key = self._run_x509_action("-pubkey", certificate) keygen_cmd = ["ssh-keygen", "-i", "-m", "PKCS8", "-f", "/dev/stdin"] ssh_key, _ = subp.subp(keygen_cmd, data=pub_key) return ssh_key @azure_ds_telemetry_reporter def _get_fingerprint_from_cert(self, certificate): """openssl x509 formats fingerprints as so: 'SHA1 Fingerprint=07:3E:19:D1:4D:1C:79:92:24:C6:A0:FD:8D:DA:\ B6:A8:BF:27:D4:73\n' Azure control plane passes that fingerprint as so: '073E19D14D1C799224C6A0FD8DDAB6A8BF27D473' """ raw_fp = self._run_x509_action("-fingerprint", certificate) eq = raw_fp.find("=") octets = raw_fp[eq + 1 : -1].split(":") return "".join(octets) @azure_ds_telemetry_reporter def _decrypt_certs_from_xml(self, certificates_xml): """Decrypt the certificates XML document using the our private key; return the list of certs and private keys contained in the doc. """ tag = ElementTree.fromstring(certificates_xml).find(".//Data") certificates_content = tag.text lines = [ b"MIME-Version: 1.0", b'Content-Disposition: attachment; filename="Certificates.p7m"', b'Content-Type: application/x-pkcs7-mime; name="Certificates.p7m"', b"Content-Transfer-Encoding: base64", b"", certificates_content.encode("utf-8"), ] with cd(self.tmpdir): out, _ = subp.subp( "openssl cms -decrypt -in /dev/stdin -inkey" " {private_key} -recip {certificate} | openssl pkcs12 -nodes" " -password pass:".format(**self.certificate_names), shell=True, data=b"\n".join(lines), ) return out @azure_ds_telemetry_reporter def parse_certificates(self, certificates_xml): """Given the Certificates XML document, return a dictionary of fingerprints and associated SSH keys derived from the certs.""" out = self._decrypt_certs_from_xml(certificates_xml) current = [] keys = {} for line in out.splitlines(): current.append(line) if re.match(r"[-]+END .*?KEY[-]+$", line): # ignore private_keys current = [] elif re.match(r"[-]+END .*?CERTIFICATE[-]+$", line): certificate = "\n".join(current) ssh_key = self._get_ssh_key_from_cert(certificate) fingerprint = self._get_fingerprint_from_cert(certificate) keys[fingerprint] = ssh_key current = [] return keys class GoalStateHealthReporter: HEALTH_REPORT_XML_TEMPLATE = textwrap.dedent( """\ <?xml version="1.0" encoding="utf-8"?> <Health xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <GoalStateIncarnation>{incarnation}</GoalStateIncarnation> <Container> <ContainerId>{container_id}</ContainerId> <RoleInstanceList> <Role> <InstanceId>{instance_id}</InstanceId> <Health> <State>{health_status}</State> {health_detail_subsection} </Health> </Role> </RoleInstanceList> </Container> </Health> """ ) HEALTH_DETAIL_SUBSECTION_XML_TEMPLATE = textwrap.dedent( """\ <Details> <SubStatus>{health_substatus}</SubStatus> <Description>{health_description}</Description> </Details> """ ) PROVISIONING_SUCCESS_STATUS = "Ready" PROVISIONING_NOT_READY_STATUS = "NotReady" PROVISIONING_FAILURE_SUBSTATUS = "ProvisioningFailed" HEALTH_REPORT_DESCRIPTION_TRIM_LEN = 512 def __init__( self, goal_state: GoalState, azure_endpoint_client: AzureEndpointHttpClient, endpoint: str, ) -> None: """Creates instance that will report provisioning status to an endpoint @param goal_state: An instance of class GoalState that contains goal state info such as incarnation, container id, and instance id. These 3 values are needed when reporting the provisioning status to Azure @param azure_endpoint_client: Instance of class AzureEndpointHttpClient @param endpoint: Endpoint (string) where the provisioning status report will be sent to @return: Instance of class GoalStateHealthReporter """ self._goal_state = goal_state self._azure_endpoint_client = azure_endpoint_client self._endpoint = endpoint @azure_ds_telemetry_reporter def send_ready_signal(self) -> None: document = self.build_report( incarnation=self._goal_state.incarnation, container_id=self._goal_state.container_id, instance_id=self._goal_state.instance_id, status=self.PROVISIONING_SUCCESS_STATUS, ) LOG.debug("Reporting ready to Azure fabric.") try: self._post_health_report(document=document) except Exception as e: report_diagnostic_event( "exception while reporting ready: %s" % e, logger_func=LOG.error, ) raise LOG.info("Reported ready to Azure fabric.") @azure_ds_telemetry_reporter def send_failure_signal(self, description: str) -> None: document = self.build_report( incarnation=self._goal_state.incarnation, container_id=self._goal_state.container_id, instance_id=self._goal_state.instance_id, status=self.PROVISIONING_NOT_READY_STATUS, substatus=self.PROVISIONING_FAILURE_SUBSTATUS, description=description, ) try: self._post_health_report(document=document) except Exception as e: msg = "exception while reporting failure: %s" % e report_diagnostic_event(msg, logger_func=LOG.error) raise LOG.warning("Reported failure to Azure fabric.") def build_report( self, incarnation: str, container_id: str, instance_id: str, status: str, substatus=None, description=None, ) -> bytes: health_detail = "" if substatus is not None: health_detail = self.HEALTH_DETAIL_SUBSECTION_XML_TEMPLATE.format( health_substatus=escape(substatus), health_description=escape( description[: self.HEALTH_REPORT_DESCRIPTION_TRIM_LEN] ), ) health_report = self.HEALTH_REPORT_XML_TEMPLATE.format( incarnation=escape(str(incarnation)), container_id=escape(container_id), instance_id=escape(instance_id), health_status=escape(status), health_detail_subsection=health_detail, ) return health_report.encode("utf-8") @azure_ds_telemetry_reporter def _post_health_report(self, document: bytes) -> None: push_log_to_kvp() # Whenever report_diagnostic_event(diagnostic_msg) is invoked in code, # the diagnostic messages are written to special files # (/var/opt/hyperv/.kvp_pool_*) as Hyper-V KVP messages. # Hyper-V KVP message communication is done through these files, # and KVP functionality is used to communicate and share diagnostic # info with the Azure Host. # The Azure Host will collect the VM's Hyper-V KVP diagnostic messages # when cloud-init reports to fabric. # When the Azure Host receives the health report signal, it will only # collect and process whatever KVP diagnostic messages have been # written to the KVP files. # KVP messages that are published after the Azure Host receives the # signal are ignored and unprocessed, so yield this thread to the # Hyper-V KVP Reporting thread so that they are written. # sleep(0) is a low-cost and proven method to yield the scheduler # and ensure that events are flushed. # See HyperVKvpReportingHandler class, which is a multi-threaded # reporting handler that writes to the special KVP files. sleep(0) LOG.debug("Sending health report to Azure fabric.") url = "http://{}/machine?comp=health".format(self._endpoint) self._azure_endpoint_client.post( url, data=document, extra_headers={"Content-Type": "text/xml; charset=utf-8"}, ) LOG.debug("Successfully sent health report to Azure fabric") class WALinuxAgentShim: def __init__(self, endpoint: str): self.endpoint = endpoint self.openssl_manager: Optional[OpenSSLManager] = None self.azure_endpoint_client: Optional[AzureEndpointHttpClient] = None def clean_up(self): if self.openssl_manager is not None: self.openssl_manager.clean_up() @azure_ds_telemetry_reporter def eject_iso(self, iso_dev) -> None: try: LOG.debug("Ejecting the provisioning iso") subp.subp(["eject", iso_dev]) except Exception as e: report_diagnostic_event( "Failed ejecting the provisioning iso: %s" % e, logger_func=LOG.debug, ) @azure_ds_telemetry_reporter def register_with_azure_and_fetch_data( self, pubkey_info=None, iso_dev=None ) -> Optional[List[str]]: """Gets the VM's GoalState from Azure, uses the GoalState information to report ready/send the ready signal/provisioning complete signal to Azure, and then uses pubkey_info to filter and obtain the user's pubkeys from the GoalState. @param pubkey_info: List of pubkey values and fingerprints which are used to filter and obtain the user's pubkey values from the GoalState. @return: The list of user's authorized pubkey values. """ http_client_certificate = None if self.openssl_manager is None and pubkey_info is not None: self.openssl_manager = OpenSSLManager() http_client_certificate = self.openssl_manager.certificate if self.azure_endpoint_client is None: self.azure_endpoint_client = AzureEndpointHttpClient( http_client_certificate ) goal_state = self._fetch_goal_state_from_azure( need_certificate=http_client_certificate is not None ) ssh_keys = None if pubkey_info is not None: ssh_keys = self._get_user_pubkeys(goal_state, pubkey_info) health_reporter = GoalStateHealthReporter( goal_state, self.azure_endpoint_client, self.endpoint ) if iso_dev is not None: self.eject_iso(iso_dev) health_reporter.send_ready_signal() return ssh_keys @azure_ds_telemetry_reporter def register_with_azure_and_report_failure(self, description: str) -> None: """Gets the VM's GoalState from Azure, uses the GoalState information to report failure/send provisioning failure signal to Azure. @param: user visible error description of provisioning failure. """ if self.azure_endpoint_client is None: self.azure_endpoint_client = AzureEndpointHttpClient(None) goal_state = self._fetch_goal_state_from_azure(need_certificate=False) health_reporter = GoalStateHealthReporter( goal_state, self.azure_endpoint_client, self.endpoint ) health_reporter.send_failure_signal(description=description) @azure_ds_telemetry_reporter def _fetch_goal_state_from_azure( self, need_certificate: bool ) -> GoalState: """Fetches the GoalState XML from the Azure endpoint, parses the XML, and returns a GoalState object. @param need_certificate: switch to know if certificates is needed. @return: GoalState object representing the GoalState XML """ unparsed_goal_state_xml = self._get_raw_goal_state_xml_from_azure() return self._parse_raw_goal_state_xml( unparsed_goal_state_xml, need_certificate ) @azure_ds_telemetry_reporter def _get_raw_goal_state_xml_from_azure(self) -> bytes: """Fetches the GoalState XML from the Azure endpoint and returns the XML as a string. @return: GoalState XML string """ LOG.info("Registering with Azure...") url = "http://{}/machine/?comp=goalstate".format(self.endpoint) try: with events.ReportEventStack( name="goalstate-retrieval", description="retrieve goalstate", parent=azure_ds_reporter, ): response = self.azure_endpoint_client.get(url) # type: ignore except Exception as e: report_diagnostic_event( "failed to register with Azure and fetch GoalState XML: %s" % e, logger_func=LOG.warning, ) raise LOG.debug("Successfully fetched GoalState XML.") return response.contents @azure_ds_telemetry_reporter def _parse_raw_goal_state_xml( self, unparsed_goal_state_xml: Union[str, bytes], need_certificate: bool, ) -> GoalState: """Parses a GoalState XML string and returns a GoalState object. @param unparsed_goal_state_xml: GoalState XML string @param need_certificate: switch to know if certificates is needed. @return: GoalState object representing the GoalState XML """ try: goal_state = GoalState( unparsed_goal_state_xml, self.azure_endpoint_client, # type: ignore need_certificate, ) except Exception as e: report_diagnostic_event( "Error processing GoalState XML: %s" % e, logger_func=LOG.warning, ) raise msg = ", ".join( [ "GoalState XML container id: %s" % goal_state.container_id, "GoalState XML instance id: %s" % goal_state.instance_id, "GoalState XML incarnation: %s" % goal_state.incarnation, ] ) report_diagnostic_event(msg, logger_func=LOG.debug) return goal_state @azure_ds_telemetry_reporter def _get_user_pubkeys( self, goal_state: GoalState, pubkey_info: list ) -> list: """Gets and filters the VM admin user's authorized pubkeys. The admin user in this case is the username specified as "admin" when deploying VMs on Azure. See https://docs.microsoft.com/en-us/cli/azure/vm#az-vm-create. cloud-init expects a straightforward array of keys to be dropped into the admin user's authorized_keys file. Azure control plane exposes multiple public keys to the VM via wireserver. Select just the admin user's key(s) and return them, ignoring any other certs. @param goal_state: GoalState object. The GoalState object contains a certificate XML, which contains both the VM user's authorized pubkeys and other non-user pubkeys, which are used for MSI and protected extension handling. @param pubkey_info: List of VM user pubkey dicts that were previously obtained from provisioning data. Each pubkey dict in this list can either have the format pubkey['value'] or pubkey['fingerprint']. Each pubkey['fingerprint'] in the list is used to filter and obtain the actual pubkey value from the GoalState certificates XML. Each pubkey['value'] requires no further processing and is immediately added to the return list. @return: A list of the VM user's authorized pubkey values. """ ssh_keys = [] if ( goal_state.certificates_xml is not None and pubkey_info is not None and self.openssl_manager is not None ): LOG.debug("Certificate XML found; parsing out public keys.") keys_by_fingerprint = self.openssl_manager.parse_certificates( goal_state.certificates_xml ) ssh_keys = self._filter_pubkeys(keys_by_fingerprint, pubkey_info) return ssh_keys @staticmethod def _filter_pubkeys(keys_by_fingerprint: dict, pubkey_info: list) -> list: """Filter and return only the user's actual pubkeys. @param keys_by_fingerprint: pubkey fingerprint -> pubkey value dict that was obtained from GoalState Certificates XML. May contain non-user pubkeys. @param pubkey_info: List of VM user pubkeys. Pubkey values are added to the return list without further processing. Pubkey fingerprints are used to filter and obtain the actual pubkey values from keys_by_fingerprint. @return: A list of the VM user's authorized pubkey values. """ keys = [] for pubkey in pubkey_info: if "value" in pubkey and pubkey["value"]: keys.append(pubkey["value"]) elif "fingerprint" in pubkey and pubkey["fingerprint"]: fingerprint = pubkey["fingerprint"] if fingerprint in keys_by_fingerprint: keys.append(keys_by_fingerprint[fingerprint]) else: LOG.warning( "ovf-env.xml specified PublicKey fingerprint " "%s not found in goalstate XML", fingerprint, ) else: LOG.warning( "ovf-env.xml specified PublicKey with neither " "value nor fingerprint: %s", pubkey, ) return keys @azure_ds_telemetry_reporter def get_metadata_from_fabric( endpoint: str, pubkey_info: Optional[List[str]] = None, iso_dev: Optional[str] = None, ): shim = WALinuxAgentShim(endpoint=endpoint) try: return shim.register_with_azure_and_fetch_data( pubkey_info=pubkey_info, iso_dev=iso_dev ) finally: shim.clean_up() @azure_ds_telemetry_reporter def report_failure_to_fabric(endpoint: str): shim = WALinuxAgentShim(endpoint=endpoint) description = DEFAULT_REPORT_FAILURE_USER_VISIBLE_MESSAGE try: shim.register_with_azure_and_report_failure(description=description) finally: shim.clean_up() def dhcp_log_cb(out, err): report_diagnostic_event( "dhclient output stream: %s" % out, logger_func=LOG.debug ) report_diagnostic_event( "dhclient error stream: %s" % err, logger_func=LOG.debug ) class BrokenAzureDataSource(Exception): pass class NonAzureDataSource(Exception): pass class ChassisAssetTag(enum.Enum): AZURE_CLOUD = "7783-7084-3265-9085-8269-3286-77" @classmethod def query_system(cls) -> Optional["ChassisAssetTag"]: """Check platform environment to report if this datasource may run. :returns: ChassisAssetTag if matching tag found, else None. """ asset_tag = dmi.read_dmi_data("chassis-asset-tag") try: tag = cls(asset_tag) except ValueError: report_diagnostic_event( "Non-Azure chassis asset tag: %r" % asset_tag, logger_func=LOG.debug, ) return None report_diagnostic_event( "Azure chassis asset tag: %r (%s)" % (asset_tag, tag.name), logger_func=LOG.debug, ) return tag class OvfEnvXml: NAMESPACES = { "ovf": "http://schemas.dmtf.org/ovf/environment/1", "wa": "http://schemas.microsoft.com/windowsazure", } def __init__( self, *, username: Optional[str] = None, password: Optional[str] = None, hostname: Optional[str] = None, custom_data: Optional[bytes] = None, disable_ssh_password_auth: Optional[bool] = None, public_keys: Optional[List[dict]] = None, preprovisioned_vm: bool = False, preprovisioned_vm_type: Optional[str] = None, ) -> None: self.username = username self.password = password self.hostname = hostname self.custom_data = custom_data self.disable_ssh_password_auth = disable_ssh_password_auth self.public_keys: List[dict] = public_keys or [] self.preprovisioned_vm = preprovisioned_vm self.preprovisioned_vm_type = preprovisioned_vm_type def __eq__(self, other) -> bool: return self.__dict__ == other.__dict__ @classmethod def parse_text(cls, ovf_env_xml: str) -> "OvfEnvXml": """Parser for ovf-env.xml data. :raises NonAzureDataSource: if XML is not in Azure's format. :raises BrokenAzureDataSource: if XML is unparseable or invalid. """ try: root = ElementTree.fromstring(ovf_env_xml) except ElementTree.ParseError as e: error_str = "Invalid ovf-env.xml: %s" % e raise BrokenAzureDataSource(error_str) from e # If there's no provisioning section, it's not Azure ovf-env.xml. if not root.find("./wa:ProvisioningSection", cls.NAMESPACES): raise NonAzureDataSource( "Ignoring non-Azure ovf-env.xml: ProvisioningSection not found" ) instance = OvfEnvXml() instance._parse_linux_configuration_set_section(root) instance._parse_platform_settings_section(root) return instance def _find( self, node, name: str, required: bool, namespace: str = "wa", ): matches = node.findall( "./%s:%s" % (namespace, name), OvfEnvXml.NAMESPACES ) if len(matches) == 0: msg = "No ovf-env.xml configuration for %r" % name LOG.debug(msg) if required: raise BrokenAzureDataSource(msg) return None elif len(matches) > 1: raise BrokenAzureDataSource( "Multiple configuration matches in ovf-exml.xml for %r (%d)" % (name, len(matches)) ) return matches[0] def _parse_property( self, node, name: str, required: bool, decode_base64: bool = False, parse_bool: bool = False, default=None, ): matches = node.findall("./wa:" + name, OvfEnvXml.NAMESPACES) if len(matches) == 0: msg = "No ovf-env.xml configuration for %r" % name LOG.debug(msg) if required: raise BrokenAzureDataSource(msg) return default elif len(matches) > 1: raise BrokenAzureDataSource( "Multiple configuration matches in ovf-exml.xml for %r (%d)" % (name, len(matches)) ) value = matches[0].text # Empty string may be None. if value is None: value = default if decode_base64 and value is not None: value = base64.b64decode("".join(value.split())) if parse_bool: value = util.translate_bool(value) return value def _parse_linux_configuration_set_section(self, root): provisioning_section = self._find( root, "ProvisioningSection", required=True ) config_set = self._find( provisioning_section, "LinuxProvisioningConfigurationSet", required=True, ) self.custom_data = self._parse_property( config_set, "CustomData", decode_base64=True, required=False, ) self.username = self._parse_property( config_set, "UserName", required=True ) self.password = self._parse_property( config_set, "UserPassword", required=False ) self.hostname = self._parse_property( config_set, "HostName", required=True ) self.disable_ssh_password_auth = self._parse_property( config_set, "DisableSshPasswordAuthentication", parse_bool=True, required=False, ) self._parse_ssh_section(config_set) def _parse_platform_settings_section(self, root): platform_settings_section = self._find( root, "PlatformSettingsSection", required=True ) platform_settings = self._find( platform_settings_section, "PlatformSettings", required=True ) self.preprovisioned_vm = self._parse_property( platform_settings, "PreprovisionedVm", parse_bool=True, default=False, required=False, ) self.preprovisioned_vm_type = self._parse_property( platform_settings, "PreprovisionedVMType", required=False, ) def _parse_ssh_section(self, config_set): self.public_keys = [] ssh_section = self._find(config_set, "SSH", required=False) if ssh_section is None: return public_keys_section = self._find( ssh_section, "PublicKeys", required=False ) if public_keys_section is None: return for public_key in public_keys_section.findall( "./wa:PublicKey", OvfEnvXml.NAMESPACES ): fingerprint = self._parse_property( public_key, "Fingerprint", required=False ) path = self._parse_property(public_key, "Path", required=False) value = self._parse_property( public_key, "Value", default="", required=False ) ssh_key = { "fingerprint": fingerprint, "path": path, "value": value, } self.public_keys.append(ssh_key) # vi: ts=4 expandtab helpers/vmware/__pycache__/__init__.cpython-310.pyc 0000644 00000000250 15027667240 0016165 0 ustar 00 o �Ad � @ s d S )N� r r r �K/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/__init__.py�<module> s helpers/vmware/imc/config_custom_script.py 0000644 00000006064 15027667240 0015073 0 ustar 00 # Copyright (C) 2017 Canonical Ltd. # Copyright (C) 2017-2019 VMware Inc. # # Author: Maitreyee Saikia <msaikia@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. import logging import os import stat from cloudinit import subp, util LOG = logging.getLogger(__name__) class CustomScriptNotFound(Exception): pass class CustomScriptConstant: CUSTOM_TMP_DIR = "/root/.customization" # The user defined custom script CUSTOM_SCRIPT_NAME = "customize.sh" CUSTOM_SCRIPT = os.path.join(CUSTOM_TMP_DIR, CUSTOM_SCRIPT_NAME) POST_CUSTOM_PENDING_MARKER = "/.guest-customization-post-reboot-pending" # The cc_scripts_per_instance script to launch custom script POST_CUSTOM_SCRIPT_NAME = "post-customize-guest.sh" class RunCustomScript: def __init__(self, scriptname, directory): self.scriptname = scriptname self.directory = directory self.scriptpath = os.path.join(directory, scriptname) def prepare_script(self): if not os.path.exists(self.scriptpath): raise CustomScriptNotFound( "Script %s not found!! Cannot execute custom script!" % self.scriptpath ) util.ensure_dir(CustomScriptConstant.CUSTOM_TMP_DIR) LOG.debug( "Copying custom script to %s", CustomScriptConstant.CUSTOM_SCRIPT ) util.copy(self.scriptpath, CustomScriptConstant.CUSTOM_SCRIPT) # Strip any CR characters from the decoded script content = util.load_file(CustomScriptConstant.CUSTOM_SCRIPT).replace( "\r", "" ) util.write_file( CustomScriptConstant.CUSTOM_SCRIPT, content, mode=0o544 ) class PreCustomScript(RunCustomScript): def execute(self): """Executing custom script with precustomization argument.""" LOG.debug("Executing pre-customization script") self.prepare_script() subp.subp([CustomScriptConstant.CUSTOM_SCRIPT, "precustomization"]) class PostCustomScript(RunCustomScript): def __init__(self, scriptname, directory, ccScriptsDir): super(PostCustomScript, self).__init__(scriptname, directory) self.ccScriptsDir = ccScriptsDir self.ccScriptPath = os.path.join( ccScriptsDir, CustomScriptConstant.POST_CUSTOM_SCRIPT_NAME ) def execute(self): """ This method copy the post customize run script to cc_scripts_per_instance directory and let this module to run post custom script. """ self.prepare_script() LOG.debug("Copying post customize run script to %s", self.ccScriptPath) util.copy( os.path.join( self.directory, CustomScriptConstant.POST_CUSTOM_SCRIPT_NAME ), self.ccScriptPath, ) st = os.stat(self.ccScriptPath) os.chmod(self.ccScriptPath, st.st_mode | stat.S_IEXEC) LOG.info("Creating post customization pending marker") util.ensure_file(CustomScriptConstant.POST_CUSTOM_PENDING_MARKER) # vi: ts=4 expandtab helpers/vmware/imc/boot_proto.py 0000644 00000000513 15027667240 0013027 0 ustar 00 # Copyright (C) 2015 Canonical Ltd. # Copyright (C) 2015 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. class BootProtoEnum: """Specifies the NIC Boot Settings.""" DHCP = "dhcp" STATIC = "static" # vi: ts=4 expandtab helpers/vmware/imc/nic.py 0000644 00000006357 15027667240 0011426 0 ustar 00 # Copyright (C) 2015 Canonical Ltd. # Copyright (C) 2015 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. from cloudinit.sources.helpers.vmware.imc.boot_proto import BootProtoEnum from cloudinit.sources.helpers.vmware.imc.nic_base import ( NicBase, StaticIpv4Base, StaticIpv6Base, ) class Nic(NicBase): """ Holds the information about each NIC specified in the customization specification file """ def __init__(self, name, configFile): self._name = name self._configFile = configFile def _get(self, what): return self._configFile.get(self.name + "|" + what, None) def _get_count_with_prefix(self, prefix): return self._configFile.get_count_with_prefix(self.name + prefix) @property def name(self): return self._name @property def mac(self): return self._get("MACADDR").lower() @property def primary(self): value = self._get("PRIMARY") if value: value = value.lower() return value == "yes" or value == "true" else: return False @property def onboot(self): value = self._get("ONBOOT") if value: value = value.lower() return value == "yes" or value == "true" else: return False @property def bootProto(self): value = self._get("BOOTPROTO") if value: return value.lower() else: return "" @property def ipv4_mode(self): value = self._get("IPv4_MODE") if value: return value.lower() else: return "" @property def staticIpv4(self): """ Checks the BOOTPROTO property and returns StaticIPv4Addr configuration object if STATIC configuration is set. """ if self.bootProto == BootProtoEnum.STATIC: return [StaticIpv4Addr(self)] else: return None @property def staticIpv6(self): cnt = self._get_count_with_prefix("|IPv6ADDR|") if not cnt: return None result = [] for index in range(1, cnt + 1): result.append(StaticIpv6Addr(self, index)) return result class StaticIpv4Addr(StaticIpv4Base): """Static IPV4 Setting.""" def __init__(self, nic): self._nic = nic @property def ip(self): return self._nic._get("IPADDR") @property def netmask(self): return self._nic._get("NETMASK") @property def gateways(self): value = self._nic._get("GATEWAY") if value: return [x.strip() for x in value.split(",")] else: return None class StaticIpv6Addr(StaticIpv6Base): """Static IPV6 Address.""" def __init__(self, nic, index): self._nic = nic self._index = index @property def ip(self): return self._nic._get("IPv6ADDR|" + str(self._index)) @property def netmask(self): return self._nic._get("IPv6NETMASK|" + str(self._index)) @property def gateway(self): return self._nic._get("IPv6GATEWAY|" + str(self._index)) # vi: ts=4 expandtab helpers/vmware/imc/__pycache__/guestcust_event.cpython-310.pyc 0000644 00000001110 15027667240 0020421 0 ustar 00 o �Ad� � @ s G d d� d�Z dS )c @ s e Zd ZdZdZdZdZdZdS )�GuestCustEventEnumz7Specifies different types of Guest Customization Events�d �e �g �h N)�__name__� __module__� __qualname__�__doc__� GUESTCUST_EVENT_CUSTOMIZE_FAILED�$GUESTCUST_EVENT_NETWORK_SETUP_FAILED�GUESTCUST_EVENT_ENABLE_NICS�GUESTCUST_EVENT_QUERY_NICS� r r �V/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/guestcust_event.pyr s r N)r r r r r �<module> s helpers/vmware/imc/__pycache__/ipv4_mode.cpython-310.pyc 0000644 00000001564 15027667240 0017075 0 ustar 00 o �Ad` � @ s G d d� d�Z dS )c @ s$ e Zd ZdZdZdZdZdZdZdS )� Ipv4ModeEnuma_ The IPv4 configuration mode which directly represents the user's goal. This mode effectively acts as a contract of the in-guest customization engine. It must be set based on what the user has requested and should not be changed by those layers. It's up to the in-guest engine to interpret and materialize the user's request. �BACKWARDS_COMPATIBLE�STATIC�DHCP�DISABLED�AS_ISN) �__name__� __module__� __qualname__�__doc__� IPV4_MODE_BACKWARDS_COMPATIBLE�IPV4_MODE_STATIC�IPV4_MODE_DHCP�IPV4_MODE_DISABLED�IPV4_MODE_AS_IS� r r �P/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/ipv4_mode.pyr s r N)r r r r r �<module> s helpers/vmware/imc/__pycache__/__init__.cpython-310.pyc 0000644 00000000254 15027667240 0016741 0 ustar 00 o �Ad � @ s d S )N� r r r �O/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/__init__.py�<module> s helpers/vmware/imc/__pycache__/guestcust_state.cpython-310.pyc 0000644 00000000741 15027667240 0020431 0 ustar 00 o �Ad} � @ s G d d� d�Z dS )c @ s e Zd ZdZdZdZdS )�GuestCustStateEnumz8Specifies different states of Guest Customization engine� � N)�__name__� __module__� __qualname__�__doc__�GUESTCUST_STATE_RUNNING�GUESTCUST_STATE_DONE� r r �V/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/guestcust_state.pyr s r N)r r r r r �<module> s helpers/vmware/imc/__pycache__/guestcust_error.cpython-310.pyc 0000644 00000001032 15027667240 0020434 0 ustar 00 o �Ad� � @ s G d d� d�Z dS )c @ s e Zd ZdZdZdZdZdS )�GuestCustErrorEnumz8Specifies different errors of Guest Customization engine� � � N)�__name__� __module__� __qualname__�__doc__�GUESTCUST_ERROR_SUCCESS� GUESTCUST_ERROR_SCRIPT_DISABLED�!GUESTCUST_ERROR_WRONG_META_FORMAT� r r �V/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/guestcust_error.pyr s r N)r r r r r �<module> s helpers/vmware/imc/__pycache__/nic_base.cpython-310.pyc 0000644 00000011026 15027667240 0016744 0 ustar 00 o �Ad6 � @ s. G d d� d�Z G dd� d�ZG dd� d�ZdS )c @ sl e Zd ZdZedd� �Zedd� �Zedd� �Zedd � �Zed d � �Z ed d � �Z edd� �Z dd� Z dS )�NicBasez{ Define what are expected of each nic. The following properties should be provided in an implementation class. c C � t d��)zb Retrieves the mac address of the nic @return (str) : the MACADDR setting �MACADDR��NotImplementedError��self� r �O/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/nic_base.py�mac � z NicBase.macc C r )a Retrieves whether the nic is the primary nic Indicates whether NIC will be used to define the default gateway. If none of the NICs is configured to be primary, default gateway won't be set. @return (bool): the PRIMARY setting �PRIMARYr r r r r �primary s zNicBase.primaryc C r )zu Retrieves whether the nic should be up at the boot time @return (bool) : the ONBOOT setting �ONBOOTr r r r r �onboot" r zNicBase.onbootc C r )z� Retrieves the boot protocol of the nic @return (str): the BOOTPROTO setting, valid values: dhcp and static. � BOOTPROTOr r r r r � bootProto* r zNicBase.bootProtoc C r )z� Retrieves the IPv4_MODE @return (str): the IPv4_MODE setting, valid values: backwards_compatible, static, dhcp, disabled, as_is � IPv4_MODEr r r r r � ipv4_mode2 s zNicBase.ipv4_modec C r )z� Retrieves the static IPv4 configuration of the nic @return (StaticIpv4Base list): the static ipv4 setting z Static IPv4r r r r r � staticIpv4; r zNicBase.staticIpv4c C r )z| Retrieves the IPv6 configuration of the nic @return (StaticIpv6Base list): the static ipv6 setting z Static Ipv6r r r r r � staticIpv6C r zNicBase.staticIpv6c C r )z� Validate the object For example, the staticIpv4 property is required and should not be empty when ipv4Mode is STATIC z Check constraints on propertiesr r r r r �validateK r zNicBase.validateN) �__name__� __module__� __qualname__�__doc__�propertyr r r r r r r r r r r r r s" r c @ �4 e Zd ZdZedd� �Zedd� �Zedd� �ZdS ) �StaticIpv4Basez� Define what are expected of a static IPv4 setting The following properties should be provided in an implementation class. c C r )zV Retrieves the Ipv4 address @return (str): the IPADDR setting z Ipv4 Addressr r r r r �ipZ r zStaticIpv4Base.ipc C r )z_ Retrieves the Ipv4 NETMASK setting @return (str): the NETMASK setting z Ipv4 NETMASKr r r r r �netmaskb r zStaticIpv4Base.netmaskc C r )zl Retrieves the gateways on this Ipv4 subnet @return (str list): the GATEWAY setting z Ipv4 GATEWAYr r r r r �gatewaysj r zStaticIpv4Base.gatewaysN)r r r r r r r r r r r r r T s r c @ r ) �StaticIpv6Basez�Define what are expected of a static IPv6 setting The following properties should be provided in an implementation class. c C r )zX Retrieves the Ipv6 address @return (str): the IPv6ADDR setting z Ipv6 Addressr r r r r r x r zStaticIpv6Base.ipc C r )zc Retrieves the Ipv6 NETMASK setting @return (str): the IPv6NETMASK setting z Ipv6 NETMASKr r r r r r � r zStaticIpv6Base.netmaskc C r )zc Retrieves the Ipv6 GATEWAY setting @return (str): the IPv6GATEWAY setting z Ipv6 GATEWAYr r r r r �gateway� r zStaticIpv6Base.gatewayN)r r r r r r r r" r r r r r! s s r! N)r r r! r r r r �<module> s K helpers/vmware/imc/__pycache__/boot_proto.cpython-310.pyc 0000644 00000000642 15027667240 0017371 0 ustar 00 o �AdK � @ s G d d� d�Z dS )c @ s e Zd ZdZdZdZdS )� BootProtoEnumz Specifies the NIC Boot Settings.�dhcp�staticN)�__name__� __module__� __qualname__�__doc__�DHCP�STATIC� r r �Q/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/boot_proto.pyr s r N)r r r r r �<module> s helpers/vmware/imc/__pycache__/config_file.cpython-310.pyc 0000644 00000006471 15027667240 0017455 0 ustar 00 o �Ad� � @ s< d dl Z d dlZd dlmZ e�e�ZG dd� dee�ZdS )� N)� ConfigSourcec @ s@ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dS )� ConfigFilez>ConfigFile module to load the content from a specified source.c C s | � |� d S )N)�_loadConfigFile)�self�filename� r �R/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/config_file.py�__init__ s zConfigFile.__init__c C sX |� � }|� � }|�d�sd|v rd}nd}|r t�d||� nt�d|� || |< dS )z� Inserts a Key Value pair. Keyword arguments: key -- The key to insert val -- The value to insert for the key �-z|-FTz ADDED KEY-VAL :: '%s' = '%s'z+ADDED KEY-VAL :: '%s' = '*****************'N)�strip� startswith�logger�debug)r �key�val�canLogr r r � _insertKey s zConfigFile._insertKeyc C sr t �d|� t�� }t|_|�|� | �� |�� D ] }t � d|� |� |�D ]\}}| � |d | |� q'qdS )a% Parses properties from the specified config file. Any previously available properties will be removed. Sensitive data will not be logged in case the key starts from '-'. Keyword arguments: filename - The full path to the config file. zParsing the config file %s.zFOUND CATEGORY = '%s'�|N) r �info� configparser� ConfigParser�str� optionxform�read�clear�sectionsr �itemsr )r r �config�categoryr �valuer r r r / s ��zConfigFile._loadConfigFilec C s || vS )z� Determines whether a value for a property must be kept. If the propery is missing, it is treated as it should be not changed by the engine. Keyword arguments: key -- The key to search for. r �r r r r r �should_keep_current_valueH s z$ConfigFile.should_keep_current_valuec C s || v r t | | � S dS )a8 Determines whether a value for the property must be removed. If the specified key is empty, it is treated as it should be removed by the engine. Return true if the value can be removed, false otherwise. Keyword arguments: key -- The key to search for. F)�boolr r r r �should_remove_current_valueV s z&ConfigFile.should_remove_current_valuec s t � fdd�| D ��S )z� Return the total count of keys that start with the specified prefix. Keyword arguments: prefix -- prefix of the key c s g | ] }|� � �r|�qS r )r )�.0r ��prefixr r � <listcomp>p s z4ConfigFile.get_count_with_prefix.<locals>.<listcomp>)�len)r r& r r% r �get_count_with_prefixi s z ConfigFile.get_count_with_prefixN) �__name__� __module__� __qualname__�__doc__r r r r! r# r) r r r r r s r ) r �logging�2cloudinit.sources.helpers.vmware.imc.config_sourcer � getLoggerr* r �dictr r r r r �<module> s helpers/vmware/imc/__pycache__/config_nic.cpython-310.pyc 0000644 00000016610 15027667240 0017303 0 ustar 00 o �Ad�" � @ sX d dl Z d dlZd dlZd dlmZmZ d dlmZ e �e �Z dd� Z G dd� d�Z dS )� N)�subp�util)�ipv4_mask_to_net_prefixc C s\ | � d�}|� d�}g }ttd��D ]}|�t|| �t|| �@ � qd�dd� |D ��S )z� Return the subnet for a given ip address and a netmask @return (str): the subnet @param ip: ip address @param netmask: netmask �.� c S s g | ]}t |��qS � )�str)�.0�xr r �Q/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/config_nic.py� <listcomp> s z gen_subnet.<locals>.<listcomp>)�split�list�range�append�int�join)�ip�netmask�ip_array� mask_array�result�indexr r r � gen_subnet s r c @ sj e Zd Zddd�Zdd� Zdd� Zdd � Zd d � Zd d � Zdd� Z dd� Z ddd�Z dd� Z d dd�Z dS ) �NicConfiguratorTc C sR || _ i | _d| _d| _|r| �� n| j D ] }|j| j|j�� < q| �� | _ dS )a Initialize the Nic Configurator @param nics (list) an array of nics to configure @param use_system_devices (Bool) Get the MAC names from the system if this is True. If False, then mac names will be retrieved from the specified nics. N) �nics�mac2Name�ipv4PrimaryGateway�ipv6PrimaryGateway� find_devices�name�mac�lower�get_primary_nic� _primaryNic)�selfr �use_system_devices�nicr r r �__init__# s zNicConfigurator.__init__c C s@ dd� | j D �}|s dS t|�dkr tddd� |D ���|d S )z| Retrieve the primary nic if it exists @return (NicBase): the primary nic if exists, None otherwise c S s g | ]}|j r|�qS r )�primary�r r' r r r r = s z3NicConfigurator.get_primary_nic.<locals>.<listcomp>N� z!There can only be one primary nicc S s g | ]}|j �qS r )r! r* r r r r C s r )r �len� Exception)r% � primary_nicsr r r r# 8 s �z NicConfigurator.get_primary_nicc C sz g d�}t � |�\}}t�dd| �dd� }d}|D ] }t�||�}|s&q|�d��� }|�dd�d } | | j|< qdS ) zb Create the mac2Name dictionary The mac address(es) are in the lower case )r �addr�showz\n\d+: � r+ Nz3link/ether (([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2}))�:r )r �rer �search�groupr" r ) r% �cmd�output�_err�sections�macPat�section�matchr! r r r r r H s �z NicConfigurator.find_devicesc C s� |j �� }| j�|�}|std|j ��g }d||d�}g }g }| �||�\}} |�|� |�| � | �||�\}} |�|� |�| � |�d|i� |� |� |rW|�|� |S )z� Return the config list needed to configure a nic @return (list): the subnets and routes list to configure the nic @param nic (NicBase): the nic to configure z No known device has MACADDR: %s�physical)�typer � mac_address�subnets) r! r" r �get� ValueError�gen_ipv4�extend�gen_ipv6�updater ) r% r' r! r � nics_cfg_list�cfg� subnet_list� route_listr@ �routesr r r � gen_one_nicZ s& zNicConfigurator.gen_one_nicc C s i }g }|j r|�ddi� |j�� }|j�� dkr d}|dkr,|�ddi� |g|fS |�ddi� |j}|s=|g|fS |d }|jrL|�d |ji� |jrW|�d |ji� |jrp|j rp|j d | _ |�d | j i� |g|fS | j s�|j r�|�d | � ||j |j�i� |g|fS ) a+ Return the set of subnets and routes needed to configure the IPv4 settings of a nic @return (set): the set of subnet and routes to configure the gateways @param name (str): subnet and route list for the nic @param nic (NicBase): the nic to configure �control�auto�disabled�manual�staticr> �dhcpr �addressr �gatewayrK ) �onbootrF � bootProtor" � ipv4_mode� staticIpv4r r r) �gatewaysr r$ �gen_ipv4_route)r% r r' �subnetrJ � bootproto�addrs�v4r r r rC ~ s8 � zNicConfigurator.gen_ipv4c C s@ g }t |�}|D ]}dt||�|f }|�|d|dd�� q|S )z� Return the routes list needed to configure additional Ipv4 route @return (list): the route list to configure the gateways @param nic (NicBase): the nic to configure @param gateways (str list): the list of gateways z%s/%d�route�' )� destinationr> rT �metric)r r r )r% r' rY r rJ �cidrrT ra r r r rZ � s �� z NicConfigurator.gen_ipv4_routec C sH |j sg g fS g }|j }|D ]}d|j|jd�}|�|� qg }||fS )a Return the set of subnets and routes needed to configure the gateways for a nic @return (set): the set of subnets and routes to configure the gateways @param name (str): name of the nic @param nic (NicBase): the nic to configure �static6)r> rS r )� staticIpv6r r r )r% r r' rI r] r/ r[ rJ r r r rE � s � zNicConfigurator.gen_ipv6c C s& g }|D ] }|� d|jdd�� q|S )Nr_ r` )r> rT rb )r rT )r% r r' r] rJ r/ r r r � _genIpv6Route� s �z NicConfigurator._genIpv6RouteFNc C s< |r t �d� | �|� g }| jD ] }|�| �|�� q|S )z@Return the config elements that are needed to configure the nicsz Configuring the interfaces file)�logger�info� configurer rD rL )r% ri �osfamilyrG r' r r r �generate� s zNicConfigurator.generatec C s2 t �d� tjddgddgd� t�g d�� d S )NzClearing DHCP leases�pkill�dhclientr r+ )�rcs)�rmz-fz/var/lib/dhcp/*)rg rh r )r% r r r � clear_dhcp s zNicConfigurator.clear_dhcpc C s� |r|dkr t �d� dS d}tj�|d�}tj�|d�}tj�|�s/tj�|�r/t�||� g d�}tj|d�|�d � | � � dS ) z^ Configure the /etc/network/interfaces Make a back up of the original �debianz3Debian OS not detected. Skipping the configure stepNz /etc/network� interfacesz&interfaces.before_vmware_customization)zH# DO NOT EDIT THIS FILE BY HAND -- AUTOMATICALLY GENERATED BY cloud-initz"source /etc/network/interfaces.d/*z*source-directory /etc/network/interfaces.dr1 )�content) rg rh �os�pathr �exists�renamer � write_filerp )r% rj � containingDir� interfaceFile� originalFile�linesr r r ri s � zNicConfigurator.configure)T)FN)N)�__name__� __module__� __qualname__r( r# r rL rC rZ rE rf rk rp ri r r r r r " s $2! r ) �loggingrt r3 � cloudinitr r �cloudinit.net.network_stater � getLoggerr} rg r r r r r r �<module> s helpers/vmware/imc/__pycache__/config_source.cpython-310.pyc 0000644 00000000606 15027667240 0020030 0 ustar 00 o �Ad+ � @ s G d d� d�Z dS )c @ s e Zd ZdZdS )� ConfigSourcez*Specifies a source for the Config Content.N)�__name__� __module__� __qualname__�__doc__� r r �T/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/config_source.pyr s r N)r r r r r �<module> s helpers/vmware/imc/__pycache__/config_namespace.cpython-310.pyc 0000644 00000000737 15027667240 0020471 0 ustar 00 o �Ad~ � @ s d dl mZ G dd� de�ZdS )� )� ConfigSourcec @ s e Zd ZdZdS )�ConfigNamespacez Specifies the Config Namespace.N)�__name__� __module__� __qualname__�__doc__� r r �W/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/config_namespace.pyr s r N)�2cloudinit.sources.helpers.vmware.imc.config_sourcer r r r r r �<module> s helpers/vmware/imc/__pycache__/config_custom_script.cpython-310.pyc 0000644 00000006263 15027667240 0021433 0 ustar 00 o �Ad4 � @ s� d dl Z d dlZd dlZd dlmZmZ e �e�ZG dd� de �Z G dd� d�Z G dd� d�Z G d d � d e �Z G d d � d e �ZdS ) � N)�subp�utilc @ s e Zd ZdS )�CustomScriptNotFoundN)�__name__� __module__� __qualname__� r r �[/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/config_custom_script.pyr s r c @ s* e Zd ZdZdZej�ee�ZdZ dZ dS )�CustomScriptConstantz/root/.customizationz customize.shz)/.guest-customization-post-reboot-pendingzpost-customize-guest.shN) r r r �CUSTOM_TMP_DIR�CUSTOM_SCRIPT_NAME�os�path�join� CUSTOM_SCRIPT�POST_CUSTOM_PENDING_MARKER�POST_CUSTOM_SCRIPT_NAMEr r r r r s r c @ s e Zd Zdd� Zdd� ZdS )�RunCustomScriptc C s || _ || _tj�||�| _d S �N)� scriptname� directoryr r r � scriptpath)�selfr r r r r �__init__! s zRunCustomScript.__init__c C sp t j�| j�std| j ��t�tj� t � dtj � t� | jtj � t� tj ��dd�}tjtj |dd� d S )Nz3Script %s not found!! Cannot execute custom script!zCopying custom script to %s� � id )�mode)r r �existsr r r � ensure_dirr r �LOG�debugr �copy� load_file�replace� write_file)r �contentr r r �prepare_script& s" �� � � �z RunCustomScript.prepare_scriptN)r r r r r& r r r r r s r c @ s e Zd Zdd� ZdS )�PreCustomScriptc C s& t �d� | �� t�tjdg� dS )z7Executing custom script with precustomization argument.z"Executing pre-customization script�precustomizationN)r r r& r r r )r r r r �execute> s zPreCustomScript.executeN)r r r r) r r r r r' = s r' c s$ e Zd Z� fdd�Zdd� Z� ZS )�PostCustomScriptc s. t t| ��||� || _tj�|tj�| _ d S r ) �superr* r � ccScriptsDirr r r r r � ccScriptPath)r r r r, �� __class__r r r F s �zPostCustomScript.__init__c C sn | � � t�d| j� t�tj�| j t j �| j� t� | j�}t� | j|jt jB � t�d� t�t j� dS )z� This method copy the post customize run script to cc_scripts_per_instance directory and let this module to run post custom script. z'Copying post customize run script to %sz*Creating post customization pending markerN)r& r r r- r r! r r r r r r �stat�chmod�st_mode�S_IEXEC�info� ensure_filer )r �str r r r) M s �� zPostCustomScript.execute)r r r r r) � __classcell__r r r. r r* E s r* )�loggingr r0 � cloudinitr r � getLoggerr r � Exceptionr r r r' r* r r r r �<module> s helpers/vmware/imc/__pycache__/config.cpython-310.pyc 0000644 00000011220 15027667240 0016442 0 ustar 00 o �Adw � @ s d dl mZ G dd� d�ZdS )� )�Nicc @ s e Zd ZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdd� Zedd� �Zedd� �Zedd� �Zedd� �Zedd � �Zed d � �Zed d � �Zed!d"� �Z ed#d$� �Z ed%d&� �Z ed'd(� �Z ed)d*� �Z ed+d,� �Z!ed-d.� �Z"ed/d0� �Z#ed1d2� �Z$d3S )4�ConfigzT Stores the Contents specified in the Customization Specification file. zCUSTOM-SCRIPT|SCRIPT-NAMEzDNS|NAMESERVER|zNETWORK|DOMAINNAMEzNETWORK|HOSTNAMEzMISC|MARKER-IDzPASSWORD|-PASSzPASSWORD|RESETz DNS|SUFFIX|zDATETIME|TIMEZONEz DATETIME|UTCzMISC|POST-GC-STATUSz!MISC|DEFAULT-RUN-POST-CUST-SCRIPTzCLOUDINIT|METADATAzCLOUDINIT|USERDATAzCLOUDINIT|INSTANCE-IDc C s || _ d S )N)� _configFile)�self� configFile� r �M/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/config.py�__init__" s zConfig.__init__c C � | j �tjd�S )zReturn the hostname.N)r �getr �HOSTNAME�r r r r � host_name% � zConfig.host_namec C r )zReturn the domain name.N)r r r � DOMAINNAMEr r r r � domain_name* r zConfig.domain_namec C r )zReturn the timezone.N)r r r �TIMEZONEr r r r �timezone/ r zConfig.timezonec C r )z.Retrieves whether to set time to UTC or Local.N)r r r �UTCr r r r �utc4 r z Config.utcc C r )z#Return the root password to be set.N)r r r �PASSr r r r �admin_password9 r zConfig.admin_passwordc C �H g }| j �tj�}td|d �D ]}tjt|� }|�| j | � q|S )z Return the list of DNS servers.� )r �get_count_with_prefixr �DNS�range�str�append�r �res�cnt�i�keyr r r � name_servers> � zConfig.name_serversc C r )z Return the list of DNS Suffixes.r )r r r �SUFFIXr r r r r r r � dns_suffixesI r% zConfig.dns_suffixesc C s4 g }| j d }|�d�D ] }|�t|| j �� q |S )z#Return the list of associated NICs.zNIC-CONFIG|NICS�,)r �splitr r )r r �nics�nicr r r r* T s z Config.nicsc C �0 | j �tjd�}|�� }|dvrtd��|dkS )z1Retreives if the root password needs to be reset.�no��yesr- z$ResetPassword value should be yes/nor/ )r r r � RESETPASS�lower� ValueError)r � resetPassr r r �reset_password^ � zConfig.reset_passwordc C r )zReturns marker id.N)r r r �MARKERIDr r r r � marker_idg r zConfig.marker_idc C r )z,Return the name of custom (pre/post) script.N)r r r � CUSTOM_SCRIPTr r r r �custom_script_namel r zConfig.custom_script_namec C r, )z8Return whether to post guestinfo.gc.status VMX property.r- r. z#PostGcStatus value should be yes/nor/ )r r r �POST_GC_STATUSr1 r2 )r � postGcStatusr r r �post_gc_statusq r5 zConfig.post_gc_statusc C r, )z� Return enable-custom-scripts default value if enable-custom-scripts is absent in VM Tools configuration r- r. z+defaultRunPostScript value should be yes/nor/ )r r r �DEFAULT_RUN_POST_SCRIPTr1 r2 )r �defaultRunPostScriptr r r �default_run_post_scriptz s �z Config.default_run_post_scriptc C r )z(Return the name of cloud-init meta data.N)r r r �CLOUDINIT_META_DATAr r r r �meta_data_name� r zConfig.meta_data_namec C r )z(Return the name of cloud-init user data.N)r r r �CLOUDINIT_USER_DATAr r r r �user_data_name� r zConfig.user_data_namec C r )zReturn instance idN)r r r �CLOUDINIT_INSTANCE_IDr r r r � instance_id� r zConfig.instance_idN)%�__name__� __module__� __qualname__�__doc__r8 r r r r6 r r0 r& r r r: r= r@ rB rD r �propertyr r r r r r$ r' r* r4 r7 r9 r< r? rA rC rE r r r r r sd r N)�(cloudinit.sources.helpers.vmware.imc.nicr r r r r r �<module> s helpers/vmware/imc/__pycache__/guestcust_util.cpython-310.pyc 0000644 00000035077 15027667240 0020300 0 ustar 00 o �AdnN � @ s� d dl Z d dlZd dlZd dlZd dlmZmZ ddlmZ ddl m Z m Z m Z ddl mZ ddlmZ ddlmZ dd lmZ dd lmZ dd lmZ e �e�Zd Z d Z dZ dZ dZ dZ!dd� Z"dXdd�Z#dd� Z$dd� Z%dd� Z&d d � Z'd d � Z(d d!� Z)d"d#� Z*d$d%� Z+ dYd(d)�Z,dZd*d+�Z-d,d-� Z.d.d/� Z/d0d1� Z0d2d3� Z1 d[d6d7�Z2d8d9� Z3d:d;� Z4d<d=� Z5d>d?� Z6d@dA� Z7dBdC� Z8dDdE� Z9dFdG� Z:dHdI� Z;dJdK� Z<dLdM� Z=dNdO� Z>dPdQ� Z?dRdS� Z@dTdU� ZAdVdW� ZBdS )\� N)�subp�util� )�Config)�CustomScriptNotFound�PostCustomScript�PreCustomScript)� ConfigFile)�NicConfigurator)�PasswordConfigurator)�GuestCustErrorEnum)�GuestCustEventEnum)�GuestCustStateEnumz/var/log/cloud-init.log�queryNicsSupported� connected�/var/run/vmware-imc� deployPkgzenable-custom-scriptsc C s� | sd S d}d}z"t �d| � tjd| gdgd�\}}|r&|�� }W ||fS W ||fS tyI } zt �d� t �|� W Y d }~||fS d }~ww )N� z Error sending the RPC commandzSending RPC command: %szvmware-rpctoolr )�rcszFailed to send RPC command)�logger�debugr �rstrip� Exception� exception)�rpc�out�err�e� r �U/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/guestcust_util.py�send_rpc, s$ �� ��r c C s< d}|r t d | }nt }d| ||f }t|�\}}||fS )Nr �@z deployPkg.update.state %d %d %s)�CLOUDINIT_LOG_FILEr )� custstate� custerror� errormessage�messager r r r r r �set_customization_statusB s r' c C sV | sdS d}t j�| �sdS t| d��}|�|�}W d � |S 1 s$w Y |S )z�Reads the NICS from the specified file path and returns the content @param nicsfilepath: Absolute file path to the NICS.txt file. Ni �r)�os�path�exists�open�read)� nicsfilepath� NICS_SIZE�fp�nicsr r r �get_nics_to_enableO s ��r2 c C s� | s t �d� d S d}d}d}td|�D ]O}t �d|� ttjtj| �\}}|s0t � || � q|t kr<t �d� d S td|�D ]!}ttjtj | �\}}|r]|t kr]t �d|� d S t � |� qAqt �d|� d S ) Nz No Nics found� r r z(Trying to connect interfaces, attempt %dz-NICS connection status query is not supportedz NICS are connected on %d secondz2Can't connect network interfaces after %d attempts)r �warning�ranger r' r �GUESTCUST_STATE_RUNNINGr �GUESTCUST_EVENT_ENABLE_NICS�time�sleep�QUERY_NICS_SUPPORTED�GUESTCUST_EVENT_QUERY_NICS�NICS_STATUS_CONNECTED�info)r1 �enableNicsWaitRetries�enableNicsWaitCount�enableNicsWaitSeconds�attemptr �_err�countr r r � enable_nicsd sD � � � �rD c C s� t �d�s t�d� |S ddd| |g}zt � |�}W n2 t jyL } z%|jdkr3t�dd�|�|� n t�d||j� t�|� |W Y d }~S d }~ww |}t � d |j �}|ri|� d �� � }t�d | ||� |S t�d | ||� |S )a$ Return the value of [section] key from VMTools configuration. @param section: String of section to read from VMTools config @returns: String value from key in [section] or defaultVal if [section] is not present or vmware-toolbox-cmd is not installed. zvmware-toolbox-cmdz9vmware-toolbox-cmd not installed, returning default value�config�get�E zRvmware-toolbox-cmd returned 69 (unavailable) for cmd: %s. Return default value: %s� zFailed running %s[%s]Nz ([^=]+)=(.*)� z Get tools config: [%s] %s = %sz<Tools config: [%s] %s is not found, return default value: %s)r �whichr r �ProcessExecutionError� exit_code�join�errorr �re�match�stdout�group�strip)�section�key� defaultVal�cmdr r �retValue�mr r r �get_tools_config� sB � � �� ��rZ c C s | r | j r d| }t|�S d S )Nz info-set guestinfo.gc.status %s)�post_gc_statusr )rE �gcMsgr r r r � set_gc_status� s r] c C s t S �N)� IMC_DIR_PATHr r r r �get_imc_dir_path� s r` c C s� i d d i f\}}}}t |d� t|�\}}t| |�} | r%t||||�s%dS t| |�s,dS zt�d� t|dd|j�|d< W n t yZ } zt dt | �t j |� W Y d } ~ dS d } ~ ww t|� ttjtj� t |d� ||||fS )N�Started)NNNNz#Preparing the Network configurationT�networkz%Error preparing Network Configuration� Successful)r] �)get_non_network_data_from_vmware_cust_cfg� check_markers�do_special_customization�recheck_markersr r �%get_network_data_from_vmware_cust_cfg�osfamilyr �set_cust_error_status�strr �$GUESTCUST_EVENT_NETWORK_SETUP_FAILED� connect_nicsr' r �GUESTCUST_STATE_DONEr �GUESTCUST_ERROR_SUCCESS) � cloud_dir� scripts_cpath�cust_cfg� cust_cfg_dir�distro�md�ud�vd�cfg�is_special_customizationr r r r �get_data_from_imc_cust_cfg� sB � ����� rz c C sN t | d� d\}}}| j}|r�tj�t� |�}tj�|�s)tdd| tj | � dS zt � |�}W n t yM } ztdt |�tj | � W Y d }~dS d }~ww | j}|r�tj�t� |�}tj�|�smtdd| tj | � dS z t � |��dd �}W n t y� } ztd t |�tj | � W Y d }~dS d }~ww ttjtj� t | d � |||fS ) Nra �NNNz,Error locating the cloud-init meta data filez Meta data file is not found: %sz'Error loading cloud-init meta data filez+Error locating the cloud-init userdata filez Userdata file is not found: %s� r z&Error loading cloud-init userdata filerc )r] �meta_data_namer) r* rM r` r+ rj r � GUESTCUST_EVENT_CUSTOMIZE_FAILEDr � load_filer rk �user_data_name�replacer' r rn r ro ) rr ru rv rw �md_file�md_pathr �ud_file�ud_pathr r r �#get_data_from_imc_raw_data_cust_cfg� sl ���� ���� � r� c C s^ i i }}| j r| jr| j d | j |d< n| j |d< | jr#| j|d< | jr+| j|d< ||fS )N�.zlocal-hostname�timezonez instance-id)� host_name� domain_namer� � instance_id)rr ru rx r r r rd * s � rd TFc C s( t | j|�}|�||�}t|| j| j�S r^ )r r1 �generate�get_v1_network_config� name_servers� dns_suffixes)rr �use_system_devices� configureri �nicConfigurator� nics_cfg_listr r r rh : s �rh c C s( | }|s|r|� d||d�� d|d�S )N� nameserver)�type�address�searchr )�versionrE )�append)r� � nameserversr� � config_listr r r r� E s � r� c C s: t j�| d�}t j�|�rt�d|� tt|�� d S d S )Nznics.txtz %s file found, to connect nics)r) r* rM r+ r r rD r2 )rs � nics_filer r r rm P s �rm c C s t �| dd� S )N� disable_vmware_customizationT�r �get_cfg_option_bool)�sys_cfgr r r �is_vmware_cust_enabledW s �r� c C s t �| dd�S )N�allow_raw_dataTr� )�ds_cfgr r r �is_raw_data_cust_enabled] s r� c C sB t | �}tjtjdtd|fd�}|rt�d|� |S t�d� d S )N�3Waiting for VMware customization configuration filezcust.cfg)�logfunc�msg�func�argsz3Found VMware customization configuration file at %sz0No VMware customization configuration file found)�get_max_wait_from_cfgr �log_timer r �wait_for_cust_cfg_file)r� �max_wait�cust_cfg_file_pathr r r �get_cust_cfg_filea s �� r� � r3 c C s^ d}||krd}||k r-t j�|| �}t j�|�r|S t�d� t�|� ||7 }||k s d S )Nr r r� )r) r* rM �isfiler r r8 r9 )�filename�maxwait�naplen�dirpath�waited� fileFullPathr r r r� z s �r� c C sj d}d}|}| s |S z t | �||��}W n ty$ t�d||� Y nw |dk r3t�d|||� |}|S )N� �vmware_cust_file_max_waitz Failed to get '%s', using %sr z/Invalid value '%s' for '%s', using '%s' instead)�intrF � ValueErrorr r4 )r� �default_max_wait�max_wait_cfg_optionr� r r r r� � s. ���r� c C s$ |j }t|tj�| d��}|o| S )N�data)� marker_id�check_marker_existsr) r* rM )rp rr �product_marker�has_marker_filer r r re � s � re c C s2 | sdS t j�|d| d �}t j�|�rdS dS )ag Check the existence of a marker file. Presence of marker file determines whether a certain code path is to be executed. It is needed for partial guest customization in VMware. @param markerid: is an unique string representing a particular product marker. @param: marker_dir: The directory in which markers exist. F� .markerfile-�.txtT)r) r* rM r+ )�markerid� marker_dir� markerfiler r r r� � s r� c C s |j }|r t| |�s dS dS )NFT)r� �create_marker_file)rp rr r� r r r rg � s rg c C sX zt |jtj�| d�� W dS ty+ } ztdt|�tj |� W Y d }~dS d }~ww )Nr� zError creating marker filesFT) �setup_marker_filesr� r) r* rM r rj rk r r~ )rp rr r r r r r� � s ����r� c C s` t �d� tj�|d| d �}t�|�D ]}|�d�r&t�tj�||�� qt |d�� � dS )a# Create a new marker file. Marker files are unique to a full customization workflow in VMware environment. @param marker_id: is an unique string representing a particular product marker. @param: marker_dir: The directory in which markers exist. zHandle marker creationr� r� z .markerfile�wN) r r r) r* rM �listdir� startswithr �del_filer, �close)r� r� � marker_file�fnamer r r r� � s �r� c C st d}d}d}d}|j }|rt|�}|rt|||�}t||�}|r0|r0tj�| d�} t|||| �}|r8|o7|o7|S |S )NFz per-instance)�custom_script_name� check_custom_script_enablement�do_pre_custom_script�do_password_customizationr) r* rM �do_post_custom_script) rq rr rs rt �is_pre_custom_successful� is_password_custom_successful�is_post_custom_successful�is_custom_script_enabled� custom_script� ccScriptsDirr r r rf � s0 � ���rf c C sT z t ||�}|�� W dS ty) } ztdt|�tj| � W Y d }~dS d }~ww )Nz(Error executing pre-customization scriptFT)r �executer rj rk r r~ )rr r� rs �precustr r r r r� � s ����r� c C sV z t |||�}|�� W dS ty* } ztdt|�tj| � W Y d }~dS d }~ww )Nz)Error executing post-customization scriptFT)r r� r rj rk r r~ )rr r� rs r� �postcustr r r r r� s ����r� c C sP d}d}| j rt�d� d}ttt|�}|�� dkr$tddtj | � |S d}|S )NF�falsez=Set default value to true due to customization configuration.�truez-Custom script is disabled by VM Administratorz'Error checking custom script enablementT) �default_run_post_scriptr r rZ �IMC_TOOLS_CONF_GROUPNAME�"IMC_TOOLS_CONF_ENABLE_CUST_SCRIPTS�lowerrj r � GUESTCUST_ERROR_SCRIPT_DISABLED)rr r� � default_value�custom_script_enablementr r r r� s, �� ��r� c C s� t �d� t� }| j}z| j}|s|r |�|||� W dS t �d� W dS tyA } ztdt|�t j | � W Y d }~dS d }~ww )Nz Applying password customizationz Changing password is not neededz%Error applying password configurationFT) r r r �admin_password�reset_passwordr� r rj rk r r~ )rr rt �pwdConfigurator� admin_pwd� reset_pwdr r r r r� 6 s( � ����r� c C s t t| ��S r^ )r r )�cfg_filer r r �parse_cust_cfgK s r� c C s: d\}}| j rd}t�d� ||fS d}t�d� ||fS )N)FFTz!raw cloudinit data cust cfg foundzvmware cust cfg found)r} r r )rr �is_vmware_cust_cfg�is_raw_data_cust_cfgr r r �get_cust_cfg_typeO s � r� c C s6 d} d}| D ]}t ||�}|rt�d|� dS qdS )N)z/usr/lib/vmware-toolsz/usr/lib64/vmware-toolsz/usr/lib/open-vm-toolsz/usr/lib64/open-vm-toolsz'/usr/lib/x86_64-linux-gnu/open-vm-toolsz(/usr/lib/aarch64-linux-gnu/open-vm-toolszlibdeployPkgPlugin.soz$Found the customization plugin at %sTF)� search_filer r )� search_paths� cust_pluginr* �cust_plugin_pathr r r �is_cust_plugin_availableZ s ��r� c C s@ | r|sd S t �| �D ]\}}}||v r t j�||� S q d S r^ )r) �walkr* rM )r� r� �root�_dirs�filesr r r r� n s �r� c C s* t �td| |� ttj|� t|| � dS )zS Set customization status to the underlying VMware Virtualization Platform z%s: %sN)r �logexcr r' r r6 r] )�prefixrN �eventrr r r r rj y s rj r^ )TFNr{ )r� r3 r )C�loggingr) rO r8 � cloudinitr r rE r �config_custom_scriptr r r � config_filer � config_nicr � config_passwdr �guestcust_errorr �guestcust_eventr �guestcust_stater � getLogger�__name__r r" r: r< r_ r� r� r r' r2 rD rZ r] r` rz r� rd rh r� rm r� r� r� r� r� re r� rg r� r� rf r� r� r� r� r� r� r� r� rj r r r r �<module> sn *2(7 � � helpers/vmware/imc/__pycache__/nic.cpython-310.pyc 0000644 00000010164 15027667240 0015754 0 ustar 00 o �Ad� � @ sT d dl mZ d dlmZmZmZ G dd� de�ZG dd� de�ZG dd� de�Zd S ) � )� BootProtoEnum)�NicBase�StaticIpv4Base�StaticIpv6Basec @ s� e Zd ZdZdd� Zdd� Zdd� Zedd � �Zed d � �Z ed d � �Z edd� �Z edd� �Z edd� �Z edd� �Zedd� �ZdS )�Niczd Holds the information about each NIC specified in the customization specification file c C � || _ || _d S �N)�_name� _configFile)�self�name� configFile� r �J/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/nic.py�__init__ � z Nic.__init__c C s | j �| jd | d �S )N�|)r �getr )r �whatr r r �_get s zNic._getc C s | j �| j| �S r )r �get_count_with_prefixr )r �prefixr r r �_get_count_with_prefix s zNic._get_count_with_prefixc C s | j S r )r �r r r r r s zNic.namec C s | � d��� S )N�MACADDR�r �lowerr r r r �mac$ s zNic.macc C �* | � d�}|r|�� }|dkp|dkS dS )N�PRIMARY�yes�trueFr �r �valuer r r �primary( � z Nic.primaryc C r )N�ONBOOTr r! Fr r" r r r �onboot1 r% z Nic.onbootc C � | � d�}|r |�� S dS )N� BOOTPROTO� r r" r r r � bootProto: � z Nic.bootProtoc C r( )N� IPv4_MODEr* r r" r r r � ipv4_modeB r, z Nic.ipv4_modec C s | j tjkr t| �gS dS )z� Checks the BOOTPROTO property and returns StaticIPv4Addr configuration object if STATIC configuration is set. N)r+ r �STATIC�StaticIpv4Addrr r r r � staticIpv4J s zNic.staticIpv4c C s> | � d�}|s d S g }td|d �D ] }|�t| |�� q|S )Nz |IPv6ADDR|� )r �range�append�StaticIpv6Addr)r �cnt�result�indexr r r � staticIpv6U s zNic.staticIpv6N)�__name__� __module__� __qualname__�__doc__r r r �propertyr r r$ r' r+ r. r1 r9 r r r r r s* r c @ �< e Zd ZdZdd� Zedd� �Zedd� �Zedd � �Zd S ) r0 zStatic IPV4 Setting.c C s || _ d S r )�_nic)r �nicr r r r f s zStaticIpv4Addr.__init__c C � | j �d�S )N�IPADDR�r@ r r r r r �ipi � zStaticIpv4Addr.ipc C rB )N�NETMASKrD r r r r �netmaskm rF zStaticIpv4Addr.netmaskc C s( | j �d�}|rdd� |�d�D �S d S )N�GATEWAYc S s g | ]}|� � �qS r )�strip)�.0�xr r r � <listcomp>u s z+StaticIpv4Addr.gateways.<locals>.<listcomp>�,)r@ r �splitr" r r r �gatewaysq s zStaticIpv4Addr.gatewaysN) r: r; r< r= r r> rE rH rP r r r r r0 c s r0 c @ r? ) r5 zStatic IPV6 Address.c C r r )r@ �_index)r rA r8 r r r r } r zStaticIpv6Addr.__init__c C � | j �dt| j� �S )Nz IPv6ADDR|�r@ r �strrQ r r r r rE � � zStaticIpv6Addr.ipc C rR )Nz IPv6NETMASK|rS r r r r rH � rU zStaticIpv6Addr.netmaskc C rR )Nz IPv6GATEWAY|rS r r r r �gateway� rU zStaticIpv6Addr.gatewayN) r: r; r< r= r r> rE rH rV r r r r r5 z s r5 N) �/cloudinit.sources.helpers.vmware.imc.boot_protor �-cloudinit.sources.helpers.vmware.imc.nic_baser r r r r0 r5 r r r r �<module> s S helpers/vmware/imc/__pycache__/config_passwd.cpython-310.pyc 0000644 00000004300 15027667240 0020024 0 ustar 00 o �Ad{ � @ s< d dl Z d dlZd dlmZmZ e �e�ZG dd� d�ZdS )� N)�subp�utilc @ s e Zd ZdZdd� Zdd� ZdS )�PasswordConfiguratorzv Class for changing configurations related to passwords in a VM. Includes setting and expiring passwords. c C s� t �d� |r t�|�}g }tdd�D ]}|�d�d dkr(|�|�d�d � qg }tdd�D ]}|�d�d }||v rB|�|� q0|rPt �d � |�d |� |rW| �|� t �d � d S ) a+ Main method to perform all functionalities based on configuration file inputs. @param passwd: encoded admin password. @param resetPasswd: boolean to determine if password needs to be reset. @return cfg: dict to be used by cloud-init set_passwd code. z Starting password configurationz /etc/passwd�r�:� �0r z /etc/shadowzSetting admin password�rootz Configure Password completed!N) �LOG�infor �b64d�open�split�append� set_passwd�reset_password)�self�passwd� resetPasswd�distro� allRootUsers�line� uidUsersList�user� r �T/usr/lib/python3/dist-packages/cloudinit/sources/helpers/vmware/imc/config_passwd.py� configure s( � � z PasswordConfigurator.configurec C s� t �d� |D ]6}z t�dd|g� W q tjy= } z tj�d�r,t�ddd|g� nt �d||� W Y d }~qd }~ww d S ) z� Method to reset password. Use passwd --expire command. Use chage if not succeeded using passwd command. Log failure message otherwise. @param: list of users for which to expire password. zExpiring password.r z--expirez/usr/bin/chage�chagez-dr z/Failed to expire password for %s with error: %sN)r r r �ProcessExecutionError�os�path�exists�warning)r � uidUserListr �er r r r 3 s ����z#PasswordConfigurator.reset_passwordN)�__name__� __module__� __qualname__�__doc__r r r r r r r s r ) �loggingr � cloudinitr r � getLoggerr% r r r r r r �<module> s helpers/vmware/imc/nic_base.py 0000644 00000007466 15027667240 0012422 0 ustar 00 # Copyright (C) 2015 Canonical Ltd. # Copyright (C) 2015 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. class NicBase: """ Define what are expected of each nic. The following properties should be provided in an implementation class. """ @property def mac(self): """ Retrieves the mac address of the nic @return (str) : the MACADDR setting """ raise NotImplementedError("MACADDR") @property def primary(self): """ Retrieves whether the nic is the primary nic Indicates whether NIC will be used to define the default gateway. If none of the NICs is configured to be primary, default gateway won't be set. @return (bool): the PRIMARY setting """ raise NotImplementedError("PRIMARY") @property def onboot(self): """ Retrieves whether the nic should be up at the boot time @return (bool) : the ONBOOT setting """ raise NotImplementedError("ONBOOT") @property def bootProto(self): """ Retrieves the boot protocol of the nic @return (str): the BOOTPROTO setting, valid values: dhcp and static. """ raise NotImplementedError("BOOTPROTO") @property def ipv4_mode(self): """ Retrieves the IPv4_MODE @return (str): the IPv4_MODE setting, valid values: backwards_compatible, static, dhcp, disabled, as_is """ raise NotImplementedError("IPv4_MODE") @property def staticIpv4(self): """ Retrieves the static IPv4 configuration of the nic @return (StaticIpv4Base list): the static ipv4 setting """ raise NotImplementedError("Static IPv4") @property def staticIpv6(self): """ Retrieves the IPv6 configuration of the nic @return (StaticIpv6Base list): the static ipv6 setting """ raise NotImplementedError("Static Ipv6") def validate(self): """ Validate the object For example, the staticIpv4 property is required and should not be empty when ipv4Mode is STATIC """ raise NotImplementedError("Check constraints on properties") class StaticIpv4Base: """ Define what are expected of a static IPv4 setting The following properties should be provided in an implementation class. """ @property def ip(self): """ Retrieves the Ipv4 address @return (str): the IPADDR setting """ raise NotImplementedError("Ipv4 Address") @property def netmask(self): """ Retrieves the Ipv4 NETMASK setting @return (str): the NETMASK setting """ raise NotImplementedError("Ipv4 NETMASK") @property def gateways(self): """ Retrieves the gateways on this Ipv4 subnet @return (str list): the GATEWAY setting """ raise NotImplementedError("Ipv4 GATEWAY") class StaticIpv6Base: """Define what are expected of a static IPv6 setting The following properties should be provided in an implementation class. """ @property def ip(self): """ Retrieves the Ipv6 address @return (str): the IPv6ADDR setting """ raise NotImplementedError("Ipv6 Address") @property def netmask(self): """ Retrieves the Ipv6 NETMASK setting @return (str): the IPv6NETMASK setting """ raise NotImplementedError("Ipv6 NETMASK") @property def gateway(self): """ Retrieves the Ipv6 GATEWAY setting @return (str): the IPv6GATEWAY setting """ raise NotImplementedError("Ipv6 GATEWAY") # vi: ts=4 expandtab helpers/vmware/imc/guestcust_util.py 0000644 00000047156 15027667240 0013742 0 ustar 00 # Copyright (C) 2016 Canonical Ltd. # Copyright (C) 2016-2022 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # Pengpeng Sun <pegnpengs@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. import logging import os import re import time from cloudinit import subp, util from .config import Config from .config_custom_script import ( CustomScriptNotFound, PostCustomScript, PreCustomScript, ) from .config_file import ConfigFile from .config_nic import NicConfigurator from .config_passwd import PasswordConfigurator from .guestcust_error import GuestCustErrorEnum from .guestcust_event import GuestCustEventEnum from .guestcust_state import GuestCustStateEnum logger = logging.getLogger(__name__) CLOUDINIT_LOG_FILE = "/var/log/cloud-init.log" QUERY_NICS_SUPPORTED = "queryNicsSupported" NICS_STATUS_CONNECTED = "connected" # Path to the VMware IMC directory IMC_DIR_PATH = "/var/run/vmware-imc" # Customization script configuration in tools conf IMC_TOOLS_CONF_GROUPNAME = "deployPkg" IMC_TOOLS_CONF_ENABLE_CUST_SCRIPTS = "enable-custom-scripts" # This will send a RPC command to the underlying # VMware Virtualization Platform. def send_rpc(rpc): if not rpc: return None out = "" err = "Error sending the RPC command" try: logger.debug("Sending RPC command: %s", rpc) (out, err) = subp.subp(["vmware-rpctool", rpc], rcs=[0]) # Remove the trailing newline in the output. if out: out = out.rstrip() except Exception as e: logger.debug("Failed to send RPC command") logger.exception(e) return (out, err) # This will send the customization status to the # underlying VMware Virtualization Platform. def set_customization_status(custstate, custerror, errormessage=None): message = "" if errormessage: message = CLOUDINIT_LOG_FILE + "@" + errormessage else: message = CLOUDINIT_LOG_FILE rpc = "deployPkg.update.state %d %d %s" % (custstate, custerror, message) (out, err) = send_rpc(rpc) return (out, err) def get_nics_to_enable(nicsfilepath): """Reads the NICS from the specified file path and returns the content @param nicsfilepath: Absolute file path to the NICS.txt file. """ if not nicsfilepath: return None NICS_SIZE = 1024 if not os.path.exists(nicsfilepath): return None with open(nicsfilepath, "r") as fp: nics = fp.read(NICS_SIZE) return nics # This will send a RPC command to the underlying VMware Virtualization platform # and enable nics. def enable_nics(nics): if not nics: logger.warning("No Nics found") return enableNicsWaitRetries = 5 enableNicsWaitCount = 5 enableNicsWaitSeconds = 1 for attempt in range(0, enableNicsWaitRetries): logger.debug("Trying to connect interfaces, attempt %d", attempt) (out, _err) = set_customization_status( GuestCustStateEnum.GUESTCUST_STATE_RUNNING, GuestCustEventEnum.GUESTCUST_EVENT_ENABLE_NICS, nics, ) if not out: time.sleep(enableNicsWaitCount * enableNicsWaitSeconds) continue if out != QUERY_NICS_SUPPORTED: logger.warning("NICS connection status query is not supported") return for count in range(0, enableNicsWaitCount): (out, _err) = set_customization_status( GuestCustStateEnum.GUESTCUST_STATE_RUNNING, GuestCustEventEnum.GUESTCUST_EVENT_QUERY_NICS, nics, ) if out and out == NICS_STATUS_CONNECTED: logger.info("NICS are connected on %d second", count) return time.sleep(enableNicsWaitSeconds) logger.warning( "Can't connect network interfaces after %d attempts", enableNicsWaitRetries, ) def get_tools_config(section, key, defaultVal): """Return the value of [section] key from VMTools configuration. @param section: String of section to read from VMTools config @returns: String value from key in [section] or defaultVal if [section] is not present or vmware-toolbox-cmd is not installed. """ if not subp.which("vmware-toolbox-cmd"): logger.debug( "vmware-toolbox-cmd not installed, returning default value" ) return defaultVal cmd = ["vmware-toolbox-cmd", "config", "get", section, key] try: out = subp.subp(cmd) except subp.ProcessExecutionError as e: if e.exit_code == 69: logger.debug( "vmware-toolbox-cmd returned 69 (unavailable) for cmd: %s." " Return default value: %s", " ".join(cmd), defaultVal, ) else: logger.error("Failed running %s[%s]", cmd, e.exit_code) logger.exception(e) return defaultVal retValue = defaultVal m = re.match(r"([^=]+)=(.*)", out.stdout) if m: retValue = m.group(2).strip() logger.debug("Get tools config: [%s] %s = %s", section, key, retValue) else: logger.debug( "Tools config: [%s] %s is not found, return default value: %s", section, key, retValue, ) return retValue # Sets message to the VMX guestinfo.gc.status property to the # underlying VMware Virtualization Platform. def set_gc_status(config, gcMsg): if config and config.post_gc_status: rpc = "info-set guestinfo.gc.status %s" % gcMsg return send_rpc(rpc) return None def get_imc_dir_path(): return IMC_DIR_PATH def get_data_from_imc_cust_cfg( cloud_dir, scripts_cpath, cust_cfg, cust_cfg_dir, distro, ): md, ud, vd, cfg = {}, None, None, {} set_gc_status(cust_cfg, "Started") (md, cfg) = get_non_network_data_from_vmware_cust_cfg(cust_cfg) is_special_customization = check_markers(cloud_dir, cust_cfg) if is_special_customization: if not do_special_customization( scripts_cpath, cust_cfg, cust_cfg_dir, distro ): return (None, None, None, None) if not recheck_markers(cloud_dir, cust_cfg): return (None, None, None, None) try: logger.debug("Preparing the Network configuration") md["network"] = get_network_data_from_vmware_cust_cfg( cust_cfg, True, True, distro.osfamily ) except Exception as e: set_cust_error_status( "Error preparing Network Configuration", str(e), GuestCustEventEnum.GUESTCUST_EVENT_NETWORK_SETUP_FAILED, cust_cfg, ) return (None, None, None, None) connect_nics(cust_cfg_dir) set_customization_status( GuestCustStateEnum.GUESTCUST_STATE_DONE, GuestCustErrorEnum.GUESTCUST_ERROR_SUCCESS, ) set_gc_status(cust_cfg, "Successful") return (md, ud, vd, cfg) def get_data_from_imc_raw_data_cust_cfg(cust_cfg): set_gc_status(cust_cfg, "Started") md, ud, vd = None, None, None md_file = cust_cfg.meta_data_name if md_file: md_path = os.path.join(get_imc_dir_path(), md_file) if not os.path.exists(md_path): set_cust_error_status( "Error locating the cloud-init meta data file", "Meta data file is not found: %s" % md_path, GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED, cust_cfg, ) return (None, None, None) try: md = util.load_file(md_path) except Exception as e: set_cust_error_status( "Error loading cloud-init meta data file", str(e), GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED, cust_cfg, ) return (None, None, None) ud_file = cust_cfg.user_data_name if ud_file: ud_path = os.path.join(get_imc_dir_path(), ud_file) if not os.path.exists(ud_path): set_cust_error_status( "Error locating the cloud-init userdata file", "Userdata file is not found: %s" % ud_path, GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED, cust_cfg, ) return (None, None, None) try: ud = util.load_file(ud_path).replace("\r", "") except Exception as e: set_cust_error_status( "Error loading cloud-init userdata file", str(e), GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED, cust_cfg, ) return (None, None, None) set_customization_status( GuestCustStateEnum.GUESTCUST_STATE_DONE, GuestCustErrorEnum.GUESTCUST_ERROR_SUCCESS, ) set_gc_status(cust_cfg, "Successful") return (md, ud, vd) def get_non_network_data_from_vmware_cust_cfg(cust_cfg): md, cfg = {}, {} if cust_cfg.host_name: if cust_cfg.domain_name: md["local-hostname"] = ( cust_cfg.host_name + "." + cust_cfg.domain_name ) else: md["local-hostname"] = cust_cfg.host_name if cust_cfg.timezone: cfg["timezone"] = cust_cfg.timezone if cust_cfg.instance_id: md["instance-id"] = cust_cfg.instance_id return (md, cfg) def get_network_data_from_vmware_cust_cfg( cust_cfg, use_system_devices=True, configure=False, osfamily=None ): nicConfigurator = NicConfigurator(cust_cfg.nics, use_system_devices) nics_cfg_list = nicConfigurator.generate(configure, osfamily) return get_v1_network_config( nics_cfg_list, cust_cfg.name_servers, cust_cfg.dns_suffixes ) def get_v1_network_config(nics_cfg_list=None, nameservers=None, search=None): config_list = nics_cfg_list if nameservers or search: config_list.append( {"type": "nameserver", "address": nameservers, "search": search} ) return {"version": 1, "config": config_list} def connect_nics(cust_cfg_dir): nics_file = os.path.join(cust_cfg_dir, "nics.txt") if os.path.exists(nics_file): logger.debug("%s file found, to connect nics", nics_file) enable_nics(get_nics_to_enable(nics_file)) def is_vmware_cust_enabled(sys_cfg): return not util.get_cfg_option_bool( sys_cfg, "disable_vmware_customization", True ) def is_raw_data_cust_enabled(ds_cfg): return util.get_cfg_option_bool(ds_cfg, "allow_raw_data", True) def get_cust_cfg_file(ds_cfg): # When the VM is powered on, the "VMware Tools" daemon # copies the customization specification file to # /var/run/vmware-imc directory. cloud-init code needs # to search for the file in that directory which indicates # that required metadata and userdata files are now # present. max_wait = get_max_wait_from_cfg(ds_cfg) cust_cfg_file_path = util.log_time( logfunc=logger.debug, msg="Waiting for VMware customization configuration file", func=wait_for_cust_cfg_file, args=("cust.cfg", max_wait), ) if cust_cfg_file_path: logger.debug( "Found VMware customization configuration file at %s", cust_cfg_file_path, ) return cust_cfg_file_path else: logger.debug("No VMware customization configuration file found") return None def wait_for_cust_cfg_file( filename, maxwait=180, naplen=5, dirpath="/var/run/vmware-imc" ): waited = 0 if maxwait <= naplen: naplen = 1 while waited < maxwait: fileFullPath = os.path.join(dirpath, filename) if os.path.isfile(fileFullPath): return fileFullPath logger.debug("Waiting for VMware customization configuration file") time.sleep(naplen) waited += naplen return None def get_max_wait_from_cfg(ds_cfg): default_max_wait = 15 max_wait_cfg_option = "vmware_cust_file_max_wait" max_wait = default_max_wait if not ds_cfg: return max_wait try: max_wait = int(ds_cfg.get(max_wait_cfg_option, default_max_wait)) except ValueError: logger.warning( "Failed to get '%s', using %s", max_wait_cfg_option, default_max_wait, ) if max_wait < 0: logger.warning( "Invalid value '%s' for '%s', using '%s' instead", max_wait, max_wait_cfg_option, default_max_wait, ) max_wait = default_max_wait return max_wait def check_markers(cloud_dir, cust_cfg): product_marker = cust_cfg.marker_id has_marker_file = check_marker_exists( product_marker, os.path.join(cloud_dir, "data") ) return product_marker and not has_marker_file def check_marker_exists(markerid, marker_dir): """ Check the existence of a marker file. Presence of marker file determines whether a certain code path is to be executed. It is needed for partial guest customization in VMware. @param markerid: is an unique string representing a particular product marker. @param: marker_dir: The directory in which markers exist. """ if not markerid: return False markerfile = os.path.join(marker_dir, ".markerfile-" + markerid + ".txt") if os.path.exists(markerfile): return True return False def recheck_markers(cloud_dir, cust_cfg): product_marker = cust_cfg.marker_id if product_marker: if not create_marker_file(cloud_dir, cust_cfg): return False return True def create_marker_file(cloud_dir, cust_cfg): try: setup_marker_files(cust_cfg.marker_id, os.path.join(cloud_dir, "data")) except Exception as e: set_cust_error_status( "Error creating marker files", str(e), GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED, cust_cfg, ) return False return True def setup_marker_files(marker_id, marker_dir): """ Create a new marker file. Marker files are unique to a full customization workflow in VMware environment. @param marker_id: is an unique string representing a particular product marker. @param: marker_dir: The directory in which markers exist. """ logger.debug("Handle marker creation") marker_file = os.path.join(marker_dir, ".markerfile-" + marker_id + ".txt") for fname in os.listdir(marker_dir): if fname.startswith(".markerfile"): util.del_file(os.path.join(marker_dir, fname)) open(marker_file, "w").close() def do_special_customization(scripts_cpath, cust_cfg, cust_cfg_dir, distro): is_pre_custom_successful = False is_password_custom_successful = False is_post_custom_successful = False is_custom_script_enabled = False custom_script = cust_cfg.custom_script_name if custom_script: is_custom_script_enabled = check_custom_script_enablement(cust_cfg) if is_custom_script_enabled: is_pre_custom_successful = do_pre_custom_script( cust_cfg, custom_script, cust_cfg_dir ) is_password_custom_successful = do_password_customization(cust_cfg, distro) if custom_script and is_custom_script_enabled: ccScriptsDir = os.path.join(scripts_cpath, "per-instance") is_post_custom_successful = do_post_custom_script( cust_cfg, custom_script, cust_cfg_dir, ccScriptsDir ) if custom_script: return ( is_pre_custom_successful and is_password_custom_successful and is_post_custom_successful ) return is_password_custom_successful def do_pre_custom_script(cust_cfg, custom_script, cust_cfg_dir): try: precust = PreCustomScript(custom_script, cust_cfg_dir) precust.execute() except CustomScriptNotFound as e: set_cust_error_status( "Error executing pre-customization script", str(e), GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED, cust_cfg, ) return False return True def do_post_custom_script(cust_cfg, custom_script, cust_cfg_dir, ccScriptsDir): try: postcust = PostCustomScript(custom_script, cust_cfg_dir, ccScriptsDir) postcust.execute() except CustomScriptNotFound as e: set_cust_error_status( "Error executing post-customization script", str(e), GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED, cust_cfg, ) return False return True def check_custom_script_enablement(cust_cfg): is_custom_script_enabled = False default_value = "false" if cust_cfg.default_run_post_script: logger.debug( "Set default value to true due to customization configuration." ) default_value = "true" custom_script_enablement = get_tools_config( IMC_TOOLS_CONF_GROUPNAME, IMC_TOOLS_CONF_ENABLE_CUST_SCRIPTS, default_value, ) if custom_script_enablement.lower() != "true": set_cust_error_status( "Custom script is disabled by VM Administrator", "Error checking custom script enablement", GuestCustErrorEnum.GUESTCUST_ERROR_SCRIPT_DISABLED, cust_cfg, ) else: is_custom_script_enabled = True return is_custom_script_enabled def do_password_customization(cust_cfg, distro): logger.debug("Applying password customization") pwdConfigurator = PasswordConfigurator() admin_pwd = cust_cfg.admin_password try: reset_pwd = cust_cfg.reset_password if admin_pwd or reset_pwd: pwdConfigurator.configure(admin_pwd, reset_pwd, distro) else: logger.debug("Changing password is not needed") except Exception as e: set_cust_error_status( "Error applying password configuration", str(e), GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED, cust_cfg, ) return False return True def parse_cust_cfg(cfg_file): return Config(ConfigFile(cfg_file)) def get_cust_cfg_type(cust_cfg): is_vmware_cust_cfg, is_raw_data_cust_cfg = False, False if cust_cfg.meta_data_name: is_raw_data_cust_cfg = True logger.debug("raw cloudinit data cust cfg found") else: is_vmware_cust_cfg = True logger.debug("vmware cust cfg found") return (is_vmware_cust_cfg, is_raw_data_cust_cfg) def is_cust_plugin_available(): search_paths = ( "/usr/lib/vmware-tools", "/usr/lib64/vmware-tools", "/usr/lib/open-vm-tools", "/usr/lib64/open-vm-tools", "/usr/lib/x86_64-linux-gnu/open-vm-tools", "/usr/lib/aarch64-linux-gnu/open-vm-tools", ) cust_plugin = "libdeployPkgPlugin.so" for path in search_paths: cust_plugin_path = search_file(path, cust_plugin) if cust_plugin_path: logger.debug( "Found the customization plugin at %s", cust_plugin_path ) return True return False def search_file(dirpath, filename): if not dirpath or not filename: return None for root, _dirs, files in os.walk(dirpath): if filename in files: return os.path.join(root, filename) return None def set_cust_error_status(prefix, error, event, cust_cfg): """ Set customization status to the underlying VMware Virtualization Platform """ util.logexc(logger, "%s: %s", prefix, error) set_customization_status(GuestCustStateEnum.GUESTCUST_STATE_RUNNING, event) set_gc_status(cust_cfg, prefix) # vi: ts=4 expandtab helpers/vmware/imc/config_file.py 0000644 00000006255 15027667240 0013116 0 ustar 00 # Copyright (C) 2015 Canonical Ltd. # Copyright (C) 2015 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. import configparser import logging from cloudinit.sources.helpers.vmware.imc.config_source import ConfigSource logger = logging.getLogger(__name__) class ConfigFile(ConfigSource, dict): """ConfigFile module to load the content from a specified source.""" def __init__(self, filename): self._loadConfigFile(filename) def _insertKey(self, key, val): """ Inserts a Key Value pair. Keyword arguments: key -- The key to insert val -- The value to insert for the key """ key = key.strip() val = val.strip() if key.startswith("-") or "|-" in key: canLog = False else: canLog = True # "sensitive" settings shall not be logged if canLog: logger.debug("ADDED KEY-VAL :: '%s' = '%s'", key, val) else: logger.debug("ADDED KEY-VAL :: '%s' = '*****************'", key) self[key] = val def _loadConfigFile(self, filename): """ Parses properties from the specified config file. Any previously available properties will be removed. Sensitive data will not be logged in case the key starts from '-'. Keyword arguments: filename - The full path to the config file. """ logger.info("Parsing the config file %s.", filename) config = configparser.ConfigParser() config.optionxform = str config.read(filename) self.clear() for category in config.sections(): logger.debug("FOUND CATEGORY = '%s'", category) for (key, value) in config.items(category): self._insertKey(category + "|" + key, value) def should_keep_current_value(self, key): """ Determines whether a value for a property must be kept. If the propery is missing, it is treated as it should be not changed by the engine. Keyword arguments: key -- The key to search for. """ # helps to distinguish from "empty" value which is used to indicate # "removal" return key not in self def should_remove_current_value(self, key): """ Determines whether a value for the property must be removed. If the specified key is empty, it is treated as it should be removed by the engine. Return true if the value can be removed, false otherwise. Keyword arguments: key -- The key to search for. """ # helps to distinguish from "missing" value which is used to indicate # "keeping unchanged" if key in self: return not bool(self[key]) else: return False def get_count_with_prefix(self, prefix): """ Return the total count of keys that start with the specified prefix. Keyword arguments: prefix -- prefix of the key """ return len([key for key in self if key.startswith(prefix)]) # vi: ts=4 expandtab helpers/vmware/imc/config_namespace.py 0000644 00000000576 15027667240 0014133 0 ustar 00 # Copyright (C) 2015 Canonical Ltd. # Copyright (C) 2015 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. from cloudinit.sources.helpers.vmware.imc.config_source import ConfigSource class ConfigNamespace(ConfigSource): """Specifies the Config Namespace.""" # vi: ts=4 expandtab helpers/vmware/imc/config.py 0000644 00000011167 15027667240 0012115 0 ustar 00 # Copyright (C) 2015 Canonical Ltd. # Copyright (C) 2015 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. from cloudinit.sources.helpers.vmware.imc.nic import Nic class Config: """ Stores the Contents specified in the Customization Specification file. """ CUSTOM_SCRIPT = "CUSTOM-SCRIPT|SCRIPT-NAME" DNS = "DNS|NAMESERVER|" DOMAINNAME = "NETWORK|DOMAINNAME" HOSTNAME = "NETWORK|HOSTNAME" MARKERID = "MISC|MARKER-ID" PASS = "PASSWORD|-PASS" RESETPASS = "PASSWORD|RESET" SUFFIX = "DNS|SUFFIX|" TIMEZONE = "DATETIME|TIMEZONE" UTC = "DATETIME|UTC" POST_GC_STATUS = "MISC|POST-GC-STATUS" DEFAULT_RUN_POST_SCRIPT = "MISC|DEFAULT-RUN-POST-CUST-SCRIPT" CLOUDINIT_META_DATA = "CLOUDINIT|METADATA" CLOUDINIT_USER_DATA = "CLOUDINIT|USERDATA" CLOUDINIT_INSTANCE_ID = "CLOUDINIT|INSTANCE-ID" def __init__(self, configFile): self._configFile = configFile @property def host_name(self): """Return the hostname.""" return self._configFile.get(Config.HOSTNAME, None) @property def domain_name(self): """Return the domain name.""" return self._configFile.get(Config.DOMAINNAME, None) @property def timezone(self): """Return the timezone.""" return self._configFile.get(Config.TIMEZONE, None) @property def utc(self): """Retrieves whether to set time to UTC or Local.""" return self._configFile.get(Config.UTC, None) @property def admin_password(self): """Return the root password to be set.""" return self._configFile.get(Config.PASS, None) @property def name_servers(self): """Return the list of DNS servers.""" res = [] cnt = self._configFile.get_count_with_prefix(Config.DNS) for i in range(1, cnt + 1): key = Config.DNS + str(i) res.append(self._configFile[key]) return res @property def dns_suffixes(self): """Return the list of DNS Suffixes.""" res = [] cnt = self._configFile.get_count_with_prefix(Config.SUFFIX) for i in range(1, cnt + 1): key = Config.SUFFIX + str(i) res.append(self._configFile[key]) return res @property def nics(self): """Return the list of associated NICs.""" res = [] nics = self._configFile["NIC-CONFIG|NICS"] for nic in nics.split(","): res.append(Nic(nic, self._configFile)) return res @property def reset_password(self): """Retreives if the root password needs to be reset.""" resetPass = self._configFile.get(Config.RESETPASS, "no") resetPass = resetPass.lower() if resetPass not in ("yes", "no"): raise ValueError("ResetPassword value should be yes/no") return resetPass == "yes" @property def marker_id(self): """Returns marker id.""" return self._configFile.get(Config.MARKERID, None) @property def custom_script_name(self): """Return the name of custom (pre/post) script.""" return self._configFile.get(Config.CUSTOM_SCRIPT, None) @property def post_gc_status(self): """Return whether to post guestinfo.gc.status VMX property.""" postGcStatus = self._configFile.get(Config.POST_GC_STATUS, "no") postGcStatus = postGcStatus.lower() if postGcStatus not in ("yes", "no"): raise ValueError("PostGcStatus value should be yes/no") return postGcStatus == "yes" @property def default_run_post_script(self): """ Return enable-custom-scripts default value if enable-custom-scripts is absent in VM Tools configuration """ defaultRunPostScript = self._configFile.get( Config.DEFAULT_RUN_POST_SCRIPT, "no" ) defaultRunPostScript = defaultRunPostScript.lower() if defaultRunPostScript not in ("yes", "no"): raise ValueError("defaultRunPostScript value should be yes/no") return defaultRunPostScript == "yes" @property def meta_data_name(self): """Return the name of cloud-init meta data.""" return self._configFile.get(Config.CLOUDINIT_META_DATA, None) @property def user_data_name(self): """Return the name of cloud-init user data.""" return self._configFile.get(Config.CLOUDINIT_USER_DATA, None) @property def instance_id(self): """Return instance id""" return self._configFile.get(Config.CLOUDINIT_INSTANCE_ID, None) # vi: ts=4 expandtab helpers/vmware/imc/ipv4_mode.py 0000644 00000002140 15027667240 0012525 0 ustar 00 # Copyright (C) 2015 Canonical Ltd. # Copyright (C) 2015 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. class Ipv4ModeEnum: """ The IPv4 configuration mode which directly represents the user's goal. This mode effectively acts as a contract of the in-guest customization engine. It must be set based on what the user has requested and should not be changed by those layers. It's up to the in-guest engine to interpret and materialize the user's request. """ # The legacy mode which only allows dhcp/static based on whether IPv4 # addresses list is empty or not IPV4_MODE_BACKWARDS_COMPATIBLE = "BACKWARDS_COMPATIBLE" # IPv4 must use static address. Reserved for future use IPV4_MODE_STATIC = "STATIC" # IPv4 must use DHCPv4. Reserved for future use IPV4_MODE_DHCP = "DHCP" # IPv4 must be disabled IPV4_MODE_DISABLED = "DISABLED" # IPv4 settings should be left untouched. Reserved for future use IPV4_MODE_AS_IS = "AS_IS" # vi: ts=4 expandtab helpers/vmware/imc/config_passwd.py 0000644 00000004573 15027667240 0013501 0 ustar 00 # Copyright (C) 2016 Canonical Ltd. # Copyright (C) 2016 VMware INC. # # Author: Maitreyee Saikia <msaikia@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. import logging import os from cloudinit import subp, util LOG = logging.getLogger(__name__) class PasswordConfigurator: """ Class for changing configurations related to passwords in a VM. Includes setting and expiring passwords. """ def configure(self, passwd, resetPasswd, distro): """ Main method to perform all functionalities based on configuration file inputs. @param passwd: encoded admin password. @param resetPasswd: boolean to determine if password needs to be reset. @return cfg: dict to be used by cloud-init set_passwd code. """ LOG.info("Starting password configuration") if passwd: passwd = util.b64d(passwd) allRootUsers = [] for line in open("/etc/passwd", "r"): if line.split(":")[2] == "0": allRootUsers.append(line.split(":")[0]) # read shadow file and check for each user, if its uid0 or root. uidUsersList = [] for line in open("/etc/shadow", "r"): user = line.split(":")[0] if user in allRootUsers: uidUsersList.append(user) if passwd: LOG.info("Setting admin password") distro.set_passwd("root", passwd) if resetPasswd: self.reset_password(uidUsersList) LOG.info("Configure Password completed!") def reset_password(self, uidUserList): """ Method to reset password. Use passwd --expire command. Use chage if not succeeded using passwd command. Log failure message otherwise. @param: list of users for which to expire password. """ LOG.info("Expiring password.") for user in uidUserList: try: subp.subp(["passwd", "--expire", user]) except subp.ProcessExecutionError as e: if os.path.exists("/usr/bin/chage"): subp.subp(["chage", "-d", "0", user]) else: LOG.warning( "Failed to expire password for %s with error: %s", user, e, ) # vi: ts=4 expandtab helpers/vmware/imc/config_source.py 0000644 00000000453 15027667240 0013471 0 ustar 00 # Copyright (C) 2015 Canonical Ltd. # Copyright (C) 2015 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. class ConfigSource: """Specifies a source for the Config Content.""" # vi: ts=4 expandtab helpers/vmware/imc/guestcust_event.py 0000644 00000000744 15027667240 0014076 0 ustar 00 # Copyright (C) 2016 Canonical Ltd. # Copyright (C) 2016 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. class GuestCustEventEnum: """Specifies different types of Guest Customization Events""" GUESTCUST_EVENT_CUSTOMIZE_FAILED = 100 GUESTCUST_EVENT_NETWORK_SETUP_FAILED = 101 GUESTCUST_EVENT_ENABLE_NICS = 103 GUESTCUST_EVENT_QUERY_NICS = 104 # vi: ts=4 expandtab helpers/vmware/imc/guestcust_error.py 0000644 00000000662 15027667240 0014105 0 ustar 00 # Copyright (C) 2016 Canonical Ltd. # Copyright (C) 2016 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. class GuestCustErrorEnum: """Specifies different errors of Guest Customization engine""" GUESTCUST_ERROR_SUCCESS = 0 GUESTCUST_ERROR_SCRIPT_DISABLED = 6 GUESTCUST_ERROR_WRONG_META_FORMAT = 9 # vi: ts=4 expandtab helpers/vmware/imc/config_nic.py 0000644 00000021200 15027667240 0012733 0 ustar 00 # Copyright (C) 2015 Canonical Ltd. # Copyright (C) 2016 VMware INC. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. import logging import os import re from cloudinit import subp, util from cloudinit.net.network_state import ipv4_mask_to_net_prefix logger = logging.getLogger(__name__) def gen_subnet(ip, netmask): """ Return the subnet for a given ip address and a netmask @return (str): the subnet @param ip: ip address @param netmask: netmask """ ip_array = ip.split(".") mask_array = netmask.split(".") result = [] for index in list(range(4)): result.append(int(ip_array[index]) & int(mask_array[index])) return ".".join([str(x) for x in result]) class NicConfigurator: def __init__(self, nics, use_system_devices=True): """ Initialize the Nic Configurator @param nics (list) an array of nics to configure @param use_system_devices (Bool) Get the MAC names from the system if this is True. If False, then mac names will be retrieved from the specified nics. """ self.nics = nics self.mac2Name = {} self.ipv4PrimaryGateway = None self.ipv6PrimaryGateway = None if use_system_devices: self.find_devices() else: for nic in self.nics: self.mac2Name[nic.mac.lower()] = nic.name self._primaryNic = self.get_primary_nic() def get_primary_nic(self): """ Retrieve the primary nic if it exists @return (NicBase): the primary nic if exists, None otherwise """ primary_nics = [nic for nic in self.nics if nic.primary] if not primary_nics: return None elif len(primary_nics) > 1: raise Exception( "There can only be one primary nic", [nic.mac for nic in primary_nics], ) else: return primary_nics[0] def find_devices(self): """ Create the mac2Name dictionary The mac address(es) are in the lower case """ cmd = ["ip", "addr", "show"] output, _err = subp.subp(cmd) sections = re.split(r"\n\d+: ", "\n" + output)[1:] macPat = r"link/ether (([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2}))" for section in sections: match = re.search(macPat, section) if not match: # Only keep info about nics continue mac = match.group(1).lower() name = section.split(":", 1)[0] self.mac2Name[mac] = name def gen_one_nic(self, nic): """ Return the config list needed to configure a nic @return (list): the subnets and routes list to configure the nic @param nic (NicBase): the nic to configure """ mac = nic.mac.lower() name = self.mac2Name.get(mac) if not name: raise ValueError("No known device has MACADDR: %s" % nic.mac) nics_cfg_list = [] cfg = {"type": "physical", "name": name, "mac_address": mac} subnet_list = [] route_list = [] # Customize IPv4 (subnets, routes) = self.gen_ipv4(name, nic) subnet_list.extend(subnets) route_list.extend(routes) # Customize IPv6 (subnets, routes) = self.gen_ipv6(name, nic) subnet_list.extend(subnets) route_list.extend(routes) cfg.update({"subnets": subnet_list}) nics_cfg_list.append(cfg) if route_list: nics_cfg_list.extend(route_list) return nics_cfg_list def gen_ipv4(self, name, nic): """ Return the set of subnets and routes needed to configure the IPv4 settings of a nic @return (set): the set of subnet and routes to configure the gateways @param name (str): subnet and route list for the nic @param nic (NicBase): the nic to configure """ subnet = {} route_list = [] if nic.onboot: subnet.update({"control": "auto"}) bootproto = nic.bootProto.lower() if nic.ipv4_mode.lower() == "disabled": bootproto = "manual" if bootproto != "static": subnet.update({"type": "dhcp"}) return ([subnet], route_list) else: subnet.update({"type": "static"}) # Static Ipv4 addrs = nic.staticIpv4 if not addrs: return ([subnet], route_list) v4 = addrs[0] if v4.ip: subnet.update({"address": v4.ip}) if v4.netmask: subnet.update({"netmask": v4.netmask}) # Add the primary gateway if nic.primary and v4.gateways: self.ipv4PrimaryGateway = v4.gateways[0] subnet.update({"gateway": self.ipv4PrimaryGateway}) return ([subnet], route_list) # Add routes if there is no primary nic if not self._primaryNic and v4.gateways: subnet.update( {"routes": self.gen_ipv4_route(nic, v4.gateways, v4.netmask)} ) return ([subnet], route_list) def gen_ipv4_route(self, nic, gateways, netmask): """ Return the routes list needed to configure additional Ipv4 route @return (list): the route list to configure the gateways @param nic (NicBase): the nic to configure @param gateways (str list): the list of gateways """ route_list = [] cidr = ipv4_mask_to_net_prefix(netmask) for gateway in gateways: destination = "%s/%d" % (gen_subnet(gateway, netmask), cidr) route_list.append( { "destination": destination, "type": "route", "gateway": gateway, "metric": 10000, } ) return route_list def gen_ipv6(self, name, nic): """ Return the set of subnets and routes needed to configure the gateways for a nic @return (set): the set of subnets and routes to configure the gateways @param name (str): name of the nic @param nic (NicBase): the nic to configure """ if not nic.staticIpv6: return ([], []) subnet_list = [] # Static Ipv6 addrs = nic.staticIpv6 for addr in addrs: subnet = { "type": "static6", "address": addr.ip, "netmask": addr.netmask, } subnet_list.append(subnet) # TODO: Add the primary gateway route_list = [] # TODO: Add routes if there is no primary nic # if not self._primaryNic: # route_list.extend(self._genIpv6Route(name, nic, addrs)) return (subnet_list, route_list) def _genIpv6Route(self, name, nic, addrs): route_list = [] for addr in addrs: route_list.append( {"type": "route", "gateway": addr.gateway, "metric": 10000} ) return route_list def generate(self, configure=False, osfamily=None): """Return the config elements that are needed to configure the nics""" if configure: logger.info("Configuring the interfaces file") self.configure(osfamily) nics_cfg_list = [] for nic in self.nics: nics_cfg_list.extend(self.gen_one_nic(nic)) return nics_cfg_list def clear_dhcp(self): logger.info("Clearing DHCP leases") # Ignore the return code 1. subp.subp(["pkill", "dhclient"], rcs=[0, 1]) subp.subp(["rm", "-f", "/var/lib/dhcp/*"]) def configure(self, osfamily=None): """ Configure the /etc/network/interfaces Make a back up of the original """ if not osfamily or osfamily != "debian": logger.info("Debian OS not detected. Skipping the configure step") return containingDir = "/etc/network" interfaceFile = os.path.join(containingDir, "interfaces") originalFile = os.path.join( containingDir, "interfaces.before_vmware_customization" ) if not os.path.exists(originalFile) and os.path.exists(interfaceFile): os.rename(interfaceFile, originalFile) lines = [ "# DO NOT EDIT THIS FILE BY HAND --" " AUTOMATICALLY GENERATED BY cloud-init", "source /etc/network/interfaces.d/*", "source-directory /etc/network/interfaces.d", ] util.write_file(interfaceFile, content="\n".join(lines)) self.clear_dhcp() # vi: ts=4 expandtab helpers/vmware/imc/__init__.py 0000644 00000000000 15027667240 0012367 0 ustar 00 helpers/vmware/imc/guestcust_state.py 0000644 00000000575 15027667240 0014077 0 ustar 00 # Copyright (C) 2016 Canonical Ltd. # Copyright (C) 2016 VMware Inc. # # Author: Sankar Tanguturi <stanguturi@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. class GuestCustStateEnum: """Specifies different states of Guest Customization engine""" GUESTCUST_STATE_RUNNING = 4 GUESTCUST_STATE_DONE = 5 # vi: ts=4 expandtab helpers/vmware/__init__.py 0000644 00000000000 15027667240 0011617 0 ustar 00 helpers/__init__.py 0000644 00000000000 15027667240 0010316 0 ustar 00 DataSourceOracle.py 0000644 00000035335 15027667240 0010320 0 ustar 00 # This file is part of cloud-init. See LICENSE file for license information. """Datasource for Oracle (OCI/Oracle Cloud Infrastructure) Notes: * This datasource does not support OCI Classic. OCI Classic provides an EC2 lookalike metadata service. * The UUID provided in DMI data is not the same as the meta-data provided instance-id, but has an equivalent lifespan. * We do need to support upgrade from an instance that cloud-init identified as OpenStack. * Bare metal instances use iSCSI root, virtual machine instances do not. * Both bare metal and virtual machine instances provide a chassis-asset-tag of OracleCloud.com. """ import base64 import ipaddress from collections import namedtuple from typing import Optional, Tuple from cloudinit import dmi from cloudinit import log as logging from cloudinit import net, sources, util from cloudinit.distros.networking import NetworkConfig from cloudinit.net import ( cmdline, ephemeral, get_interfaces_by_mac, is_netfail_master, ) from cloudinit.url_helper import UrlError, readurl LOG = logging.getLogger(__name__) BUILTIN_DS_CONFIG = { # Don't use IMDS to configure secondary NICs by default "configure_secondary_nics": False, } CHASSIS_ASSET_TAG = "OracleCloud.com" METADATA_ROOT = "http://169.254.169.254/opc/v{version}/" METADATA_PATTERN = METADATA_ROOT + "{path}/" # https://docs.cloud.oracle.com/iaas/Content/Network/Troubleshoot/connectionhang.htm#Overview, # indicates that an MTU of 9000 is used within OCI MTU = 9000 V2_HEADERS = {"Authorization": "Bearer Oracle"} OpcMetadata = namedtuple("OpcMetadata", "version instance_data vnics_data") class KlibcOracleNetworkConfigSource(cmdline.KlibcNetworkConfigSource): """Override super class to lower the applicability conditions. If any `/run/net-*.cfg` files exist, then it is applicable. Even if `/run/initramfs/open-iscsi.interface` does not exist. """ def is_applicable(self) -> bool: """Override is_applicable""" return bool(self._files) def _ensure_netfailover_safe(network_config: NetworkConfig) -> None: """ Search network config physical interfaces to see if any of them are a netfailover master. If found, we prevent matching by MAC as the other failover devices have the same MAC but need to be ignored. Note: we rely on cloudinit.net changes which prevent netfailover devices from being present in the provided network config. For more details about netfailover devices, refer to cloudinit.net module. :param network_config A v1 or v2 network config dict with the primary NIC, and possibly secondary nic configured. This dict will be mutated. """ # ignore anything that's not an actual network-config if "version" not in network_config: return if network_config["version"] not in [1, 2]: LOG.debug( "Ignoring unknown network config version: %s", network_config["version"], ) return mac_to_name = get_interfaces_by_mac() if network_config["version"] == 1: for cfg in [c for c in network_config["config"] if "type" in c]: if cfg["type"] == "physical": if "mac_address" in cfg: mac = cfg["mac_address"] cur_name = mac_to_name.get(mac) if not cur_name: continue elif is_netfail_master(cur_name): del cfg["mac_address"] elif network_config["version"] == 2: for _, cfg in network_config.get("ethernets", {}).items(): if "match" in cfg: macaddr = cfg.get("match", {}).get("macaddress") if macaddr: cur_name = mac_to_name.get(macaddr) if not cur_name: continue elif is_netfail_master(cur_name): del cfg["match"]["macaddress"] del cfg["set-name"] cfg["match"]["name"] = cur_name class DataSourceOracle(sources.DataSource): dsname = "Oracle" system_uuid = None vendordata_pure = None network_config_sources: Tuple[sources.NetworkConfigSource, ...] = ( sources.NetworkConfigSource.CMD_LINE, sources.NetworkConfigSource.DS, sources.NetworkConfigSource.INITRAMFS, sources.NetworkConfigSource.SYSTEM_CFG, ) _network_config: dict = {"config": [], "version": 1} def __init__(self, sys_cfg, *args, **kwargs): super(DataSourceOracle, self).__init__(sys_cfg, *args, **kwargs) self._vnics_data = None self.ds_cfg = util.mergemanydict( [ util.get_cfg_by_path(sys_cfg, ["datasource", self.dsname], {}), BUILTIN_DS_CONFIG, ] ) self._network_config_source = KlibcOracleNetworkConfigSource() def _has_network_config(self) -> bool: return bool(self._network_config.get("config", [])) def _is_platform_viable(self) -> bool: """Check platform environment to report if this datasource may run.""" return _is_platform_viable() def _get_data(self): if not self._is_platform_viable(): return False self.system_uuid = _read_system_uuid() network_context = ephemeral.EphemeralDHCPv4( iface=net.find_fallback_nic(), connectivity_url_data={ "url": METADATA_PATTERN.format(version=2, path="instance"), "headers": V2_HEADERS, }, tmp_dir=self.distro.get_tmp_exec_path(), ) fetch_primary_nic = not self._is_iscsi_root() fetch_secondary_nics = self.ds_cfg.get( "configure_secondary_nics", BUILTIN_DS_CONFIG["configure_secondary_nics"], ) with network_context: fetched_metadata = read_opc_metadata( fetch_vnics_data=fetch_primary_nic or fetch_secondary_nics ) data = self._crawled_metadata = fetched_metadata.instance_data self.metadata_address = METADATA_ROOT.format( version=fetched_metadata.version ) self._vnics_data = fetched_metadata.vnics_data self.metadata = { "availability-zone": data["ociAdName"], "instance-id": data["id"], "launch-index": 0, "local-hostname": data["hostname"], "name": data["displayName"], } if "metadata" in data: user_data = data["metadata"].get("user_data") if user_data: self.userdata_raw = base64.b64decode(user_data) self.metadata["public_keys"] = data["metadata"].get( "ssh_authorized_keys" ) return True def check_instance_id(self, sys_cfg) -> bool: """quickly check (local only) if self.instance_id is still valid On Oracle, the dmi-provided system uuid differs from the instance-id but has the same life-span.""" return sources.instance_id_matches_system_uuid(self.system_uuid) def get_public_ssh_keys(self): return sources.normalize_pubkey_data(self.metadata.get("public_keys")) def _is_iscsi_root(self) -> bool: """Return whether we are on a iscsi machine.""" return self._network_config_source.is_applicable() def _get_iscsi_config(self) -> dict: return self._network_config_source.render_config() @property def network_config(self): """Network config is read from initramfs provided files Priority for primary network_config selection: - iscsi - imds If none is present, then we fall back to fallback configuration. """ if self._has_network_config(): return self._network_config set_primary = False # this is v1 if self._is_iscsi_root(): self._network_config = self._get_iscsi_config() if not self._has_network_config(): LOG.warning( "Could not obtain network configuration from initramfs. " "Falling back to IMDS." ) set_primary = True set_secondary = self.ds_cfg.get( "configure_secondary_nics", BUILTIN_DS_CONFIG["configure_secondary_nics"], ) if set_primary or set_secondary: try: # Mutate self._network_config to include primary and/or # secondary VNICs self._add_network_config_from_opc_imds(set_primary) except Exception: util.logexc( LOG, "Failed to parse IMDS network configuration!", ) # we need to verify that the nic selected is not a netfail over # device and, if it is a netfail master, then we need to avoid # emitting any match by mac _ensure_netfailover_safe(self._network_config) return self._network_config def _add_network_config_from_opc_imds(self, set_primary: bool = False): """Generate primary and/or secondary NIC config from IMDS and merge it. It will mutate the network config to include the secondary VNICs. :param set_primary: If True set primary interface. :raises: Exceptions are not handled within this function. Likely exceptions are KeyError/IndexError (if the IMDS returns valid JSON with unexpected contents). """ if self._vnics_data is None: LOG.warning("NIC data is UNSET but should not be") return if not set_primary and ("nicIndex" in self._vnics_data[0]): # TODO: Once configure_secondary_nics defaults to True, lower the # level of this log message. (Currently, if we're running this # code at all, someone has explicitly opted-in to secondary # VNIC configuration, so we should warn them that it didn't # happen. Once it's default, this would be emitted on every Bare # Metal Machine launch, which means INFO or DEBUG would be more # appropriate.) LOG.warning( "VNIC metadata indicates this is a bare metal machine; " "skipping secondary VNIC configuration." ) return interfaces_by_mac = get_interfaces_by_mac() vnics_data = self._vnics_data if set_primary else self._vnics_data[1:] for index, vnic_dict in enumerate(vnics_data): is_primary = set_primary and index == 0 mac_address = vnic_dict["macAddr"].lower() if mac_address not in interfaces_by_mac: LOG.warning( "Interface with MAC %s not found; skipping", mac_address, ) continue name = interfaces_by_mac[mac_address] network = ipaddress.ip_network(vnic_dict["subnetCidrBlock"]) if self._network_config["version"] == 1: if is_primary: subnet = {"type": "dhcp"} else: subnet = { "type": "static", "address": ( f"{vnic_dict['privateIp']}/{network.prefixlen}" ), } interface_config = { "name": name, "type": "physical", "mac_address": mac_address, "mtu": MTU, "subnets": [subnet], } self._network_config["config"].append(interface_config) elif self._network_config["version"] == 2: # Why does this elif exist??? # Are there plans to switch to v2? interface_config = { "mtu": MTU, "match": {"macaddress": mac_address}, "dhcp6": False, "dhcp4": is_primary, } if not is_primary: interface_config["addresses"] = [ f"{vnic_dict['privateIp']}/{network.prefixlen}" ] self._network_config["ethernets"][name] = interface_config def _read_system_uuid() -> Optional[str]: sys_uuid = dmi.read_dmi_data("system-uuid") return None if sys_uuid is None else sys_uuid.lower() def _is_platform_viable() -> bool: asset_tag = dmi.read_dmi_data("chassis-asset-tag") return asset_tag == CHASSIS_ASSET_TAG def _fetch(metadata_version: int, path: str, retries: int = 2) -> dict: return readurl( url=METADATA_PATTERN.format(version=metadata_version, path=path), headers=V2_HEADERS if metadata_version > 1 else None, retries=retries, )._response.json() def read_opc_metadata(*, fetch_vnics_data: bool = False) -> OpcMetadata: """Fetch metadata from the /opc/ routes. :return: A namedtuple containing: The metadata version as an integer The JSON-decoded value of the instance data endpoint on the IMDS The JSON-decoded value of the vnics data endpoint if `fetch_vnics_data` is True, else None """ # Per Oracle, there are short windows (measured in milliseconds) throughout # an instance's lifetime where the IMDS is being updated and may 404 as a # result. To work around these windows, we retry a couple of times. metadata_version = 2 try: instance_data = _fetch(metadata_version, path="instance") except UrlError: metadata_version = 1 instance_data = _fetch(metadata_version, path="instance") vnics_data = None if fetch_vnics_data: try: vnics_data = _fetch(metadata_version, path="vnics") except UrlError: util.logexc(LOG, "Failed to fetch IMDS network configuration!") return OpcMetadata(metadata_version, instance_data, vnics_data) # Used to match classes to dependencies datasources = [ (DataSourceOracle, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) if __name__ == "__main__": import argparse description = """ Query Oracle Cloud metadata and emit a JSON object with two keys: `read_opc_metadata` and `_is_platform_viable`. The values of each are the return values of the corresponding functions defined in DataSourceOracle.py.""" parser = argparse.ArgumentParser(description=description) parser.parse_args() print( util.json_dumps( { "read_opc_metadata": read_opc_metadata(), "_is_platform_viable": _is_platform_viable(), } ) ) # vi: ts=4 expandtab DataSourceCloudSigma.py 0000644 00000010000 15027667240 0011120 0 ustar 00 # Copyright (C) 2014 CloudSigma # # Author: Kiril Vladimiroff <kiril.vladimiroff@cloudsigma.com> # # This file is part of cloud-init. See LICENSE file for license information. import re from base64 import b64decode from cloudinit import dmi from cloudinit import log as logging from cloudinit import sources from cloudinit.sources import DataSourceHostname from cloudinit.sources.helpers.cloudsigma import SERIAL_PORT, Cepko LOG = logging.getLogger(__name__) class DataSourceCloudSigma(sources.DataSource): """ Uses cepko in order to gather the server context from the VM. For more information about CloudSigma's Server Context: http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html """ dsname = "CloudSigma" def __init__(self, sys_cfg, distro, paths): self.cepko = Cepko() self.ssh_public_key = "" sources.DataSource.__init__(self, sys_cfg, distro, paths) def is_running_in_cloudsigma(self): """ Uses dmi data to detect if this instance of cloud-init is running in the CloudSigma's infrastructure. """ LOG.debug("determining hypervisor product name via dmi data") sys_product_name = dmi.read_dmi_data("system-product-name") if not sys_product_name: LOG.debug("system-product-name not available in dmi data") return False LOG.debug("detected hypervisor as %s", sys_product_name) return "cloudsigma" in sys_product_name.lower() def _get_data(self): """ Metadata is the whole server context and /meta/cloud-config is used as userdata. """ dsmode = None if not self.is_running_in_cloudsigma(): return False try: server_context = self.cepko.all().result server_meta = server_context["meta"] except Exception: # TODO: check for explicit "config on", and then warn # but since no explicit config is available now, just debug. LOG.debug("CloudSigma: Unable to read from serial port") return False self.dsmode = self._determine_dsmode( [server_meta.get("cloudinit-dsmode")] ) if dsmode == sources.DSMODE_DISABLED: return False base64_fields = server_meta.get("base64_fields", "").split(",") self.userdata_raw = server_meta.get("cloudinit-user-data", "") if "cloudinit-user-data" in base64_fields: self.userdata_raw = b64decode(self.userdata_raw) if "cloudinit" in server_context.get("vendor_data", {}): self.vendordata_raw = server_context["vendor_data"]["cloudinit"] self.metadata = server_context self.ssh_public_key = server_meta["ssh_public_key"] return True def _get_subplatform(self): """Return the subplatform metadata source details.""" return "cepko (%s)" % SERIAL_PORT def get_hostname(self, fqdn=False, resolve_ip=False, metadata_only=False): """ Cleans up and uses the server's name if the latter is set. Otherwise the first part from uuid is being used. """ if re.match(r"^[A-Za-z0-9 -_\.]+$", self.metadata["name"]): ret = self.metadata["name"][:61] else: ret = self.metadata["uuid"].split("-")[0] return DataSourceHostname(ret, False) def get_public_ssh_keys(self): return [self.ssh_public_key] def get_instance_id(self): return self.metadata["uuid"] # Legacy: Must be present in case we load an old pkl object DataSourceCloudSigmaNet = DataSourceCloudSigma # Used to match classes to dependencies. Since this datasource uses the serial # port network is not really required, so it's okay to load without it, too. datasources = [ (DataSourceCloudSigma, (sources.DEP_FILESYSTEM,)), ] def get_datasource_list(depends): """ Return a list of data sources that match this set of dependencies """ return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceUpCloud.py 0000644 00000013066 15027667240 0010463 0 ustar 00 # Author: Antti Myyrä <antti.myyra@upcloud.com> # # This file is part of cloud-init. See LICENSE file for license information. # UpCloud server metadata API: # https://developers.upcloud.com/1.3/8-servers/#metadata-service from cloudinit import log as logging from cloudinit import net as cloudnet from cloudinit import sources, util from cloudinit.net.dhcp import NoDHCPLeaseError from cloudinit.net.ephemeral import EphemeralDHCPv4 from cloudinit.sources.helpers import upcloud as uc_helper LOG = logging.getLogger(__name__) BUILTIN_DS_CONFIG = {"metadata_url": "http://169.254.169.254/metadata/v1.json"} # Wait for a up to a minute, retrying the meta-data server # every 2 seconds. MD_RETRIES = 30 MD_TIMEOUT = 2 MD_WAIT_RETRY = 2 class DataSourceUpCloud(sources.DataSource): dsname = "UpCloud" # We'll perform DHCP setup only in init-local, see DataSourceUpCloudLocal perform_dhcp_setup = False def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.distro = distro self.metadata = dict() self.ds_cfg = util.mergemanydict( [ util.get_cfg_by_path(sys_cfg, ["datasource", "UpCloud"], {}), BUILTIN_DS_CONFIG, ] ) self.metadata_address = self.ds_cfg["metadata_url"] self.retries = self.ds_cfg.get("retries", MD_RETRIES) self.timeout = self.ds_cfg.get("timeout", MD_TIMEOUT) self.wait_retry = self.ds_cfg.get("wait_retry", MD_WAIT_RETRY) self._network_config = None def _get_sysinfo(self): return uc_helper.read_sysinfo() def _read_metadata(self): return uc_helper.read_metadata( self.metadata_address, timeout=self.timeout, sec_between=self.wait_retry, retries=self.retries, ) def _get_data(self): (is_upcloud, server_uuid) = self._get_sysinfo() # only proceed if we know we are on UpCloud if not is_upcloud: return False LOG.info("Running on UpCloud. server_uuid=%s", server_uuid) if self.perform_dhcp_setup: # Setup networking in init-local stage. try: LOG.debug("Finding a fallback NIC") nic = cloudnet.find_fallback_nic() LOG.debug("Discovering metadata via DHCP interface %s", nic) with EphemeralDHCPv4( nic, tmp_dir=self.distro.get_tmp_exec_path() ): md = util.log_time( logfunc=LOG.debug, msg="Reading from metadata service", func=self._read_metadata, ) except (NoDHCPLeaseError, sources.InvalidMetaDataException) as e: util.logexc(LOG, str(e)) return False else: try: LOG.debug( "Discovering metadata without DHCP-configured networking" ) md = util.log_time( logfunc=LOG.debug, msg="Reading from metadata service", func=self._read_metadata, ) except sources.InvalidMetaDataException as e: util.logexc(LOG, str(e)) LOG.info( "No DHCP-enabled interfaces available, " "unable to fetch metadata for %s", server_uuid, ) return False self.metadata_full = md self.metadata["instance-id"] = md.get("instance_id", server_uuid) self.metadata["local-hostname"] = md.get("hostname") self.metadata["network"] = md.get("network") self.metadata["public-keys"] = md.get("public_keys") self.metadata["availability_zone"] = md.get("region", "default") self.vendordata_raw = md.get("vendor_data", None) self.userdata_raw = md.get("user_data", None) return True def check_instance_id(self, sys_cfg): return sources.instance_id_matches_system_uuid(self.get_instance_id()) @property def network_config(self): """ Configure the networking. This needs to be done each boot, since the IP and interface information might have changed due to reconfiguration. """ if self._network_config: return self._network_config raw_network_config = self.metadata.get("network") if not raw_network_config: raise Exception("Unable to get network meta-data from server....") self._network_config = uc_helper.convert_network_config( raw_network_config, ) return self._network_config class DataSourceUpCloudLocal(DataSourceUpCloud): """ Run in init-local using a DHCP discovery prior to metadata crawl. In init-local, no network is available. This subclass sets up minimal networking with dhclient on a viable nic so that it can talk to the metadata service. If the metadata service provides network configuration then render the network configuration for that instance based on metadata. """ perform_dhcp_setup = True # Get metadata network config if present # Used to match classes to dependencies datasources = [ (DataSourceUpCloudLocal, (sources.DEP_FILESYSTEM,)), (DataSourceUpCloud, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceOVF.py 0000644 00000024744 15027667240 0007547 0 ustar 00 # Copyright (C) 2011 Canonical Ltd. # Copyright (C) 2012 Hewlett-Packard Development Company, L.P. # Copyright (C) 2012 Yahoo! Inc. # # Author: Scott Moser <scott.moser@canonical.com> # Author: Juerg Hafliger <juerg.haefliger@hp.com> # Author: Joshua Harlow <harlowja@yahoo-inc.com> # # This file is part of cloud-init. See LICENSE file for license information. import base64 import os import re from xml.dom import minidom from cloudinit import log as logging from cloudinit import safeyaml, sources, subp, util LOG = logging.getLogger(__name__) class DataSourceOVF(sources.DataSource): dsname = "OVF" def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.seed = None self.seed_dir = os.path.join(paths.seed_dir, "ovf") self.environment = None self.cfg = {} self.supported_seed_starts = ("/", "file://") self._network_config = None def __str__(self): root = sources.DataSource.__str__(self) return "%s [seed=%s]" % (root, self.seed) def _get_data(self): found = [] md = {} ud = "" vd = "" defaults = { "instance-id": "iid-dsovf", } (seedfile, contents) = get_ovf_env(self.paths.seed_dir) if seedfile: # Found a seed dir seed = os.path.join(self.paths.seed_dir, seedfile) (md, ud, cfg) = read_ovf_environment(contents) self.environment = contents found.append(seed) else: np = [ ("com.vmware.guestInfo", transport_vmware_guestinfo), ("iso", transport_iso9660), ] name = None for name, transfunc in np: contents = transfunc() if contents: break if contents: (md, ud, cfg) = read_ovf_environment(contents, True) self.environment = contents if "network-config" in md and md["network-config"]: self._network_config = md["network-config"] found.append(name) # There was no OVF transports found if len(found) == 0: return False if "seedfrom" in md and md["seedfrom"]: seedfrom = md["seedfrom"] seedfound = False for proto in self.supported_seed_starts: if seedfrom.startswith(proto): seedfound = proto break if not seedfound: LOG.debug("Seed from %s not supported by %s", seedfrom, self) return False (md_seed, ud, vd) = util.read_seeded(seedfrom, timeout=None) LOG.debug("Using seeded cache data from %s", seedfrom) md = util.mergemanydict([md, md_seed]) found.append(seedfrom) # Now that we have exhausted any other places merge in the defaults md = util.mergemanydict([md, defaults]) self.seed = ",".join(found) self.metadata = md self.userdata_raw = ud self.vendordata_raw = vd self.cfg = cfg return True def _get_subplatform(self): return "ovf (%s)" % self.seed def get_public_ssh_keys(self): if "public-keys" not in self.metadata: return [] pks = self.metadata["public-keys"] if isinstance(pks, (list)): return pks else: return [pks] # The data sources' config_obj is a cloud-config formatted # object that came to it from ways other than cloud-config # because cloud-config content would be handled elsewhere def get_config_obj(self): return self.cfg @property def network_config(self): return self._network_config class DataSourceOVFNet(DataSourceOVF): def __init__(self, sys_cfg, distro, paths): DataSourceOVF.__init__(self, sys_cfg, distro, paths) self.seed_dir = os.path.join(paths.seed_dir, "ovf-net") self.supported_seed_starts = ("http://", "https://") # This will return a dict with some content # meta-data, user-data, some config def read_ovf_environment(contents, read_network=False): props = get_properties(contents) md = {} cfg = {} ud = None cfg_props = ["password"] md_props = ["seedfrom", "local-hostname", "public-keys", "instance-id"] network_props = ["network-config"] for (prop, val) in props.items(): if prop == "hostname": prop = "local-hostname" if prop in md_props: md[prop] = val elif prop in cfg_props: cfg[prop] = val elif prop in network_props and read_network: try: network_config = base64.b64decode(val.encode()) md[prop] = safeload_yaml_or_dict(network_config).get("network") except Exception: LOG.debug("Ignore network-config in wrong format") elif prop == "user-data": try: ud = base64.b64decode(val.encode()) except Exception: ud = val.encode() return (md, ud, cfg) # Returns tuple of filename (in 'dirname', and the contents of the file) # on "not found", returns 'None' for filename and False for contents def get_ovf_env(dirname): env_names = ("ovf-env.xml", "ovf_env.xml", "OVF_ENV.XML", "OVF-ENV.XML") for fname in env_names: full_fn = os.path.join(dirname, fname) if os.path.isfile(full_fn): try: contents = util.load_file(full_fn) return (fname, contents) except Exception: util.logexc(LOG, "Failed loading ovf file %s", full_fn) return (None, False) def maybe_cdrom_device(devname): """Test if devname matches known list of devices which may contain iso9660 filesystems. Be helpful in accepting either knames (with no leading /dev/) or full path names, but do not allow paths outside of /dev/, like /dev/foo/bar/xxx. """ if not devname: return False elif not isinstance(devname, str): raise ValueError("Unexpected input for devname: %s" % devname) # resolve '..' and multi '/' elements devname = os.path.normpath(devname) # drop leading '/dev/' if devname.startswith("/dev/"): # partition returns tuple (before, partition, after) devname = devname.partition("/dev/")[-1] # ignore leading slash (/sr0), else fail on / in name (foo/bar/xvdc) if devname.startswith("/"): devname = devname.split("/")[-1] elif devname.count("/") > 0: return False # if empty string if not devname: return False # default_regex matches values in /lib/udev/rules.d/60-cdrom_id.rules # KERNEL!="sr[0-9]*|hd[a-z]|xvd*", GOTO="cdrom_end" default_regex = r"^(sr[0-9]+|hd[a-z]|xvd.*)" devname_regex = os.environ.get("CLOUD_INIT_CDROM_DEV_REGEX", default_regex) cdmatch = re.compile(devname_regex) return cdmatch.match(devname) is not None # Transport functions are called with no arguments and return # either None (indicating not present) or string content of an ovf-env.xml def transport_iso9660(require_iso=True): # Go through mounts to see if it was already mounted mounts = util.mounts() for (dev, info) in mounts.items(): fstype = info["fstype"] if fstype != "iso9660" and require_iso: continue if not maybe_cdrom_device(dev): continue mp = info["mountpoint"] (_fname, contents) = get_ovf_env(mp) if contents is not False: return contents if require_iso: mtype = "iso9660" else: mtype = None # generate a list of devices with mtype filesystem, filter by regex devs = [ dev for dev in util.find_devs_with("TYPE=%s" % mtype if mtype else None) if maybe_cdrom_device(dev) ] for dev in devs: try: (_fname, contents) = util.mount_cb(dev, get_ovf_env, mtype=mtype) except util.MountFailedError: LOG.debug("%s not mountable as iso9660", dev) continue if contents is not False: return contents return None def transport_vmware_guestinfo(): rpctool = "vmware-rpctool" not_found = None if not subp.which(rpctool): return not_found cmd = [rpctool, "info-get guestinfo.ovfEnv"] try: out, _err = subp.subp(cmd) if out: return out LOG.debug("cmd %s exited 0 with empty stdout: %s", cmd, out) except subp.ProcessExecutionError as e: if e.exit_code != 1: LOG.warning("%s exited with code %d", rpctool, e.exit_code) LOG.debug(e) return not_found def find_child(node, filter_func): ret = [] if not node.hasChildNodes(): return ret for child in node.childNodes: if filter_func(child): ret.append(child) return ret def get_properties(contents): dom = minidom.parseString(contents) if dom.documentElement.localName != "Environment": raise XmlError("No Environment Node") if not dom.documentElement.hasChildNodes(): raise XmlError("No Child Nodes") envNsURI = "http://schemas.dmtf.org/ovf/environment/1" # could also check here that elem.namespaceURI == # "http://schemas.dmtf.org/ovf/environment/1" propSections = find_child( dom.documentElement, lambda n: n.localName == "PropertySection" ) if len(propSections) == 0: raise XmlError("No 'PropertySection's") props = {} propElems = find_child( propSections[0], (lambda n: n.localName == "Property") ) for elem in propElems: key = elem.attributes.getNamedItemNS(envNsURI, "key").value val = elem.attributes.getNamedItemNS(envNsURI, "value").value props[key] = val return props class XmlError(Exception): pass # Used to match classes to dependencies datasources = ( (DataSourceOVF, (sources.DEP_FILESYSTEM,)), (DataSourceOVFNet, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ) # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) def safeload_yaml_or_dict(data): """ The meta data could be JSON or YAML. Since YAML is a strict superset of JSON, we will unmarshal the data as YAML. If data is None then a new dictionary is returned. """ if not data: return {} return safeyaml.load(data) # vi: ts=4 expandtab DataSourceEc2.py 0000644 00000107440 15027667240 0007521 0 ustar 00 # Copyright (C) 2009-2010 Canonical Ltd. # Copyright (C) 2012 Hewlett-Packard Development Company, L.P. # Copyright (C) 2012 Yahoo! Inc. # # Author: Scott Moser <scott.moser@canonical.com> # Author: Juerg Hafliger <juerg.haefliger@hp.com> # Author: Joshua Harlow <harlowja@yahoo-inc.com> # # This file is part of cloud-init. See LICENSE file for license information. import copy import os import time from typing import List from cloudinit import dmi from cloudinit import log as logging from cloudinit import net, sources from cloudinit import url_helper as uhelp from cloudinit import util, warnings from cloudinit.event import EventScope, EventType from cloudinit.net.dhcp import NoDHCPLeaseError from cloudinit.net.ephemeral import EphemeralIPNetwork from cloudinit.sources.helpers import ec2 LOG = logging.getLogger(__name__) SKIP_METADATA_URL_CODES = frozenset([uhelp.NOT_FOUND]) STRICT_ID_PATH = ("datasource", "Ec2", "strict_id") STRICT_ID_DEFAULT = "warn" class CloudNames: ALIYUN = "aliyun" AWS = "aws" BRIGHTBOX = "brightbox" ZSTACK = "zstack" E24CLOUD = "e24cloud" OUTSCALE = "outscale" # UNKNOWN indicates no positive id. If strict_id is 'warn' or 'false', # then an attempt at the Ec2 Metadata service will be made. UNKNOWN = "unknown" # NO_EC2_METADATA indicates this platform does not have a Ec2 metadata # service available. No attempt at the Ec2 Metadata service will be made. NO_EC2_METADATA = "no-ec2-metadata" # Drop when LP: #1988157 tag handling is fixed def skip_404_tag_errors(exception): return exception.code == 404 and "meta-data/tags/" in exception.url # Cloud platforms that support IMDSv2 style metadata server IDMSV2_SUPPORTED_CLOUD_PLATFORMS = [CloudNames.AWS, CloudNames.ALIYUN] class DataSourceEc2(sources.DataSource): dsname = "Ec2" # Default metadata urls that will be used if none are provided # They will be checked for 'resolveability' and some of the # following may be discarded if they do not resolve metadata_urls = [ "http://169.254.169.254", "http://[fd00:ec2::254]", "http://instance-data.:8773", ] # The minimum supported metadata_version from the ec2 metadata apis min_metadata_version = "2009-04-04" # Priority ordered list of additional metadata versions which will be tried # for extended metadata content. IPv6 support comes in 2016-09-02. # Tags support comes in 2021-03-23. extended_metadata_versions: List[str] = [ "2021-03-23", "2018-09-24", "2016-09-02", ] # Setup read_url parameters per get_url_params. url_max_wait = 120 url_timeout = 50 _api_token = None # API token for accessing the metadata service _network_config = sources.UNSET # Used to cache calculated network cfg v1 # Whether we want to get network configuration from the metadata service. perform_dhcp_setup = False supported_update_events = { EventScope.NETWORK: { EventType.BOOT_NEW_INSTANCE, EventType.BOOT, EventType.BOOT_LEGACY, EventType.HOTPLUG, } } def __init__(self, sys_cfg, distro, paths): super(DataSourceEc2, self).__init__(sys_cfg, distro, paths) self.metadata_address = None def _get_cloud_name(self): """Return the cloud name as identified during _get_data.""" return identify_platform() def _get_data(self): strict_mode, _sleep = read_strict_mode( util.get_cfg_by_path( self.sys_cfg, STRICT_ID_PATH, STRICT_ID_DEFAULT ), ("warn", None), ) LOG.debug( "strict_mode: %s, cloud_name=%s cloud_platform=%s", strict_mode, self.cloud_name, self.platform, ) if strict_mode == "true" and self.cloud_name == CloudNames.UNKNOWN: return False elif self.cloud_name == CloudNames.NO_EC2_METADATA: return False if self.perform_dhcp_setup: # Setup networking in init-local stage. if util.is_FreeBSD(): LOG.debug("FreeBSD doesn't support running dhclient with -sf") return False try: with EphemeralIPNetwork( self.fallback_interface, ipv4=True, ipv6=True, tmp_dir=self.distro.get_tmp_exec_path(), ) as netw: state_msg = f" {netw.state_msg}" if netw.state_msg else "" self._crawled_metadata = util.log_time( logfunc=LOG.debug, msg=f"Crawl of metadata service{state_msg}", func=self.crawl_metadata, ) except NoDHCPLeaseError: return False else: self._crawled_metadata = util.log_time( logfunc=LOG.debug, msg="Crawl of metadata service", func=self.crawl_metadata, ) if not self._crawled_metadata: return False self.metadata = self._crawled_metadata.get("meta-data", None) self.userdata_raw = self._crawled_metadata.get("user-data", None) self.identity = ( self._crawled_metadata.get("dynamic", {}) .get("instance-identity", {}) .get("document", {}) ) return True def is_classic_instance(self): """Report if this instance type is Ec2 Classic (non-vpc).""" if not self.metadata: # Can return False on inconclusive as we are also called in # network_config where metadata will be present. # Secondary call site is in packaging postinst script. return False ifaces_md = self.metadata.get("network", {}).get("interfaces", {}) for _mac, mac_data in ifaces_md.get("macs", {}).items(): if "vpc-id" in mac_data: return False return True @property def launch_index(self): if not self.metadata: return None return self.metadata.get("ami-launch-index") @property def platform(self): # Handle upgrade path of pickled ds if not hasattr(self, "_platform_type"): self._platform_type = DataSourceEc2.dsname.lower() if not self._platform_type: self._platform_type = DataSourceEc2.dsname.lower() return self._platform_type # IMDSv2 related parameters from the ec2 metadata api document @property def api_token_route(self): return "latest/api/token" @property def imdsv2_token_ttl_seconds(self): return "21600" @property def imdsv2_token_put_header(self): return "X-aws-ec2-metadata-token" @property def imdsv2_token_req_header(self): return self.imdsv2_token_put_header + "-ttl-seconds" @property def imdsv2_token_redact(self): return [self.imdsv2_token_put_header, self.imdsv2_token_req_header] def get_metadata_api_version(self): """Get the best supported api version from the metadata service. Loop through all extended support metadata versions in order and return the most-fully featured metadata api version discovered. If extended_metadata_versions aren't present, return the datasource's min_metadata_version. """ # Assumes metadata service is already up url_tmpl = "{0}/{1}/meta-data/instance-id" headers = self._get_headers() for api_ver in self.extended_metadata_versions: url = url_tmpl.format(self.metadata_address, api_ver) try: resp = uhelp.readurl( url=url, headers=headers, headers_redact=self.imdsv2_token_redact, ) except uhelp.UrlError as e: LOG.debug("url %s raised exception %s", url, e) else: if resp.code == 200: LOG.debug("Found preferred metadata version %s", api_ver) return api_ver elif resp.code == 404: msg = "Metadata api version %s not present. Headers: %s" LOG.debug(msg, api_ver, resp.headers) return self.min_metadata_version def get_instance_id(self): if self.cloud_name == CloudNames.AWS: # Prefer the ID from the instance identity document, but fall back if not getattr(self, "identity", None): # If re-using cached datasource, it's get_data run didn't # setup self.identity. So we need to do that now. api_version = self.get_metadata_api_version() self.identity = ec2.get_instance_identity( api_version, self.metadata_address, headers_cb=self._get_headers, headers_redact=self.imdsv2_token_redact, exception_cb=self._refresh_stale_aws_token_cb, ).get("document", {}) return self.identity.get( "instanceId", self.metadata["instance-id"] ) else: return self.metadata["instance-id"] def _maybe_fetch_api_token(self, mdurls): """Get an API token for EC2 Instance Metadata Service. On EC2. IMDS will always answer an API token, unless the instance owner has disabled the IMDS HTTP endpoint or the network topology conflicts with the configured hop-limit. """ if self.cloud_name not in IDMSV2_SUPPORTED_CLOUD_PLATFORMS: return urls = [] url2base = {} url_path = self.api_token_route request_method = "PUT" for url in mdurls: cur = "{0}/{1}".format(url, url_path) urls.append(cur) url2base[cur] = url # use the self._imds_exception_cb to check for Read errors LOG.debug("Fetching Ec2 IMDSv2 API Token") response = None url = None url_params = self.get_url_params() try: url, response = uhelp.wait_for_url( urls=urls, max_wait=url_params.max_wait_seconds, timeout=url_params.timeout_seconds, status_cb=LOG.warning, headers_cb=self._get_headers, exception_cb=self._imds_exception_cb, request_method=request_method, headers_redact=self.imdsv2_token_redact, connect_synchronously=False, ) except uhelp.UrlError: # We use the raised exception to interupt the retry loop. # Nothing else to do here. pass if url and response: self._api_token = response return url2base[url] # If we get here, then wait_for_url timed out, waiting for IMDS # or the IMDS HTTP endpoint is disabled return None def wait_for_metadata_service(self): mcfg = self.ds_cfg url_params = self.get_url_params() if url_params.max_wait_seconds <= 0: return False # Remove addresses from the list that wont resolve. mdurls = mcfg.get("metadata_urls", self.metadata_urls) filtered = [x for x in mdurls if util.is_resolvable_url(x)] if set(filtered) != set(mdurls): LOG.debug( "Removed the following from metadata urls: %s", list((set(mdurls) - set(filtered))), ) if len(filtered): mdurls = filtered else: LOG.warning("Empty metadata url list! using default list") mdurls = self.metadata_urls # try the api token path first metadata_address = self._maybe_fetch_api_token(mdurls) # When running on EC2, we always access IMDS with an API token. # If we could not get an API token, then we assume the IMDS # endpoint was disabled and we move on without a data source. # Fallback to IMDSv1 if not running on EC2 if ( not metadata_address and self.cloud_name not in IDMSV2_SUPPORTED_CLOUD_PLATFORMS ): # if we can't get a token, use instance-id path urls = [] url2base = {} url_path = "{ver}/meta-data/instance-id".format( ver=self.min_metadata_version ) request_method = "GET" for url in mdurls: cur = "{0}/{1}".format(url, url_path) urls.append(cur) url2base[cur] = url start_time = time.time() url, _ = uhelp.wait_for_url( urls=urls, max_wait=url_params.max_wait_seconds, timeout=url_params.timeout_seconds, status_cb=LOG.warning, headers_redact=self.imdsv2_token_redact, headers_cb=self._get_headers, request_method=request_method, ) if url: metadata_address = url2base[url] if metadata_address: self.metadata_address = metadata_address LOG.debug("Using metadata source: '%s'", self.metadata_address) elif self.cloud_name in IDMSV2_SUPPORTED_CLOUD_PLATFORMS: LOG.warning("IMDS's HTTP endpoint is probably disabled") else: LOG.critical( "Giving up on md from %s after %s seconds", urls, int(time.time() - start_time), ) return bool(metadata_address) def device_name_to_device(self, name): # Consult metadata service, that has # ephemeral0: sdb # and return 'sdb' for input 'ephemeral0' if "block-device-mapping" not in self.metadata: return None # Example: # 'block-device-mapping': # {'ami': '/dev/sda1', # 'ephemeral0': '/dev/sdb', # 'root': '/dev/sda1'} found = None bdm = self.metadata["block-device-mapping"] if not isinstance(bdm, dict): LOG.debug("block-device-mapping not a dictionary: '%s'", bdm) return None for (entname, device) in bdm.items(): if entname == name: found = device break # LP: #513842 mapping in Euca has 'ephemeral' not 'ephemeral0' if entname == "ephemeral" and name == "ephemeral0": found = device if found is None: LOG.debug("Unable to convert %s to a device", name) return None ofound = found if not found.startswith("/"): found = "/dev/%s" % found if os.path.exists(found): return found remapped = self._remap_device(os.path.basename(found)) if remapped: LOG.debug("Remapped device name %s => %s", found, remapped) return remapped # On t1.micro, ephemeral0 will appear in block-device-mapping from # metadata, but it will not exist on disk (and never will) # at this point, we've verified that the path did not exist # in the special case of 'ephemeral0' return None to avoid bogus # fstab entry (LP: #744019) if name == "ephemeral0": return None return ofound @property def availability_zone(self): try: if self.cloud_name == CloudNames.AWS: return self.identity.get( "availabilityZone", self.metadata["placement"]["availability-zone"], ) else: return self.metadata["placement"]["availability-zone"] except KeyError: return None @property def region(self): if self.cloud_name == CloudNames.AWS: region = self.identity.get("region") # Fallback to trimming the availability zone if region is missing if self.availability_zone and not region: region = self.availability_zone[:-1] return region else: az = self.availability_zone if az is not None: return az[:-1] return None def activate(self, cfg, is_new_instance): if not is_new_instance: return if self.cloud_name == CloudNames.UNKNOWN: warn_if_necessary( util.get_cfg_by_path(cfg, STRICT_ID_PATH, STRICT_ID_DEFAULT), cfg, ) @property def network_config(self): """Return a network config dict for rendering ENI or netplan files.""" if self._network_config != sources.UNSET: return self._network_config if self.metadata is None: # this would happen if get_data hadn't been called. leave as UNSET LOG.warning( "Unexpected call to network_config when metadata is None." ) return None result = None no_network_metadata_on_aws = bool( "network" not in self.metadata and self.cloud_name == CloudNames.AWS ) if no_network_metadata_on_aws: LOG.debug( "Metadata 'network' not present:" " Refreshing stale metadata from prior to upgrade." ) util.log_time( logfunc=LOG.debug, msg="Re-crawl of metadata service", func=self.get_data, ) iface = self.fallback_interface net_md = self.metadata.get("network") if isinstance(net_md, dict): # SRU_BLOCKER: xenial, bionic and eoan should default # apply_full_imds_network_config to False to retain original # behavior on those releases. result = convert_ec2_metadata_network_config( net_md, fallback_nic=iface, full_network_config=util.get_cfg_option_bool( self.ds_cfg, "apply_full_imds_network_config", True ), ) # Non-VPC (aka Classic) Ec2 instances need to rewrite the # network config file every boot due to MAC address change. if self.is_classic_instance(): self.default_update_events = copy.deepcopy( self.default_update_events ) self.default_update_events[EventScope.NETWORK].add( EventType.BOOT ) self.default_update_events[EventScope.NETWORK].add( EventType.BOOT_LEGACY ) else: LOG.warning("Metadata 'network' key not valid: %s.", net_md) self._network_config = result return self._network_config @property def fallback_interface(self): if self._fallback_interface is None: # fallback_nic was used at one point, so restored objects may # have an attribute there. respect that if found. _legacy_fbnic = getattr(self, "fallback_nic", None) if _legacy_fbnic: self._fallback_interface = _legacy_fbnic self.fallback_nic = None else: return super(DataSourceEc2, self).fallback_interface return self._fallback_interface def crawl_metadata(self): """Crawl metadata service when available. @returns: Dictionary of crawled metadata content containing the keys: meta-data, user-data and dynamic. """ if not self.wait_for_metadata_service(): return {} api_version = self.get_metadata_api_version() redact = self.imdsv2_token_redact crawled_metadata = {} if self.cloud_name in IDMSV2_SUPPORTED_CLOUD_PLATFORMS: exc_cb = self._refresh_stale_aws_token_cb exc_cb_ud = self._skip_or_refresh_stale_aws_token_cb skip_cb = None elif self.cloud_name == CloudNames.OUTSCALE: exc_cb = exc_cb_ud = None skip_cb = skip_404_tag_errors else: exc_cb = exc_cb_ud = skip_cb = None try: crawled_metadata["user-data"] = ec2.get_instance_userdata( api_version, self.metadata_address, headers_cb=self._get_headers, headers_redact=redact, exception_cb=exc_cb_ud, ) crawled_metadata["meta-data"] = ec2.get_instance_metadata( api_version, self.metadata_address, headers_cb=self._get_headers, headers_redact=redact, exception_cb=exc_cb, retrieval_exception_ignore_cb=skip_cb, ) if self.cloud_name == CloudNames.AWS: identity = ec2.get_instance_identity( api_version, self.metadata_address, headers_cb=self._get_headers, headers_redact=redact, exception_cb=exc_cb, ) crawled_metadata["dynamic"] = {"instance-identity": identity} except Exception: util.logexc( LOG, "Failed reading from metadata address %s", self.metadata_address, ) return {} crawled_metadata["_metadata_api_version"] = api_version return crawled_metadata def _refresh_api_token(self, seconds=None): """Request new metadata API token. @param seconds: The lifetime of the token in seconds @return: The API token or None if unavailable. """ if self.cloud_name not in IDMSV2_SUPPORTED_CLOUD_PLATFORMS: return None if seconds is None: seconds = self.imdsv2_token_ttl_seconds LOG.debug("Refreshing Ec2 metadata API token") request_header = {self.imdsv2_token_req_header: seconds} token_url = "{}/{}".format(self.metadata_address, self.api_token_route) try: response = uhelp.readurl( token_url, headers=request_header, headers_redact=self.imdsv2_token_redact, request_method="PUT", ) except uhelp.UrlError as e: LOG.warning( "Unable to get API token: %s raised exception %s", token_url, e ) return None return response.contents def _skip_or_refresh_stale_aws_token_cb(self, msg, exception): """Callback will not retry on SKIP_USERDATA_CODES or if no token is available.""" retry = ec2.skip_retry_on_codes( ec2.SKIP_USERDATA_CODES, msg, exception ) if not retry: return False # False raises exception return self._refresh_stale_aws_token_cb(msg, exception) def _refresh_stale_aws_token_cb(self, msg, exception): """Exception handler for Ec2 to refresh token if token is stale.""" if isinstance(exception, uhelp.UrlError) and exception.code == 401: # With _api_token as None, _get_headers will _refresh_api_token. LOG.debug("Clearing cached Ec2 API token due to expiry") self._api_token = None return True # always retry def _imds_exception_cb(self, msg, exception=None): """Fail quickly on proper AWS if IMDSv2 rejects API token request Guidance from Amazon is that if IMDSv2 had disabled token requests by returning a 403, or cloud-init malformed requests resulting in other 40X errors, we want the datasource detection to fail quickly without retries as those symptoms will likely not be resolved by retries. Exceptions such as requests.ConnectionError due to IMDS being temporarily unroutable or unavailable will still retry due to the callsite wait_for_url. """ if isinstance(exception, uhelp.UrlError): # requests.ConnectionError will have exception.code == None if exception.code and exception.code >= 400: if exception.code == 403: LOG.warning( "Ec2 IMDS endpoint returned a 403 error. " "HTTP endpoint is disabled. Aborting." ) else: LOG.warning( "Fatal error while requesting Ec2 IMDSv2 API tokens" ) raise exception def _get_headers(self, url=""): """Return a dict of headers for accessing a url. If _api_token is unset on AWS, attempt to refresh the token via a PUT and then return the updated token header. """ if self.cloud_name not in IDMSV2_SUPPORTED_CLOUD_PLATFORMS: return {} # Request a 6 hour token if URL is api_token_route request_token_header = { self.imdsv2_token_req_header: self.imdsv2_token_ttl_seconds } if self.api_token_route in url: return request_token_header if not self._api_token: # If we don't yet have an API token, get one via a PUT against # api_token_route. This _api_token may get unset by a 403 due # to an invalid or expired token self._api_token = self._refresh_api_token() if not self._api_token: return {} return {self.imdsv2_token_put_header: self._api_token} class DataSourceEc2Local(DataSourceEc2): """Datasource run at init-local which sets up network to query metadata. In init-local, no network is available. This subclass sets up minimal networking with dhclient on a viable nic so that it can talk to the metadata service. If the metadata service provides network configuration then render the network configuration for that instance based on metadata. """ perform_dhcp_setup = True # Use dhcp before querying metadata def get_data(self): supported_platforms = (CloudNames.AWS, CloudNames.OUTSCALE) if self.cloud_name not in supported_platforms: LOG.debug( "Local Ec2 mode only supported on %s, not %s", supported_platforms, self.cloud_name, ) return False return super(DataSourceEc2Local, self).get_data() def read_strict_mode(cfgval, default): try: return parse_strict_mode(cfgval) except ValueError as e: LOG.warning(e) return default def parse_strict_mode(cfgval): # given a mode like: # true, false, warn,[sleep] # return tuple with string mode (true|false|warn) and sleep. if cfgval is True: return "true", None if cfgval is False: return "false", None if not cfgval: return "warn", 0 mode, _, sleep = cfgval.partition(",") if mode not in ("true", "false", "warn"): raise ValueError( "Invalid mode '%s' in strict_id setting '%s': " "Expected one of 'true', 'false', 'warn'." % (mode, cfgval) ) if sleep: try: sleep = int(sleep) except ValueError as e: raise ValueError( "Invalid sleep '%s' in strict_id setting '%s': not an integer" % (sleep, cfgval) ) from e else: sleep = None return mode, sleep def warn_if_necessary(cfgval, cfg): try: mode, sleep = parse_strict_mode(cfgval) except ValueError as e: LOG.warning(e) return if mode == "false": return warnings.show_warning("non_ec2_md", cfg, mode=True, sleep=sleep) def identify_aliyun(data): if data["product_name"] == "Alibaba Cloud ECS": return CloudNames.ALIYUN def identify_aws(data): # data is a dictionary returned by _collect_platform_data. if data["uuid"].startswith("ec2") and ( data["uuid_source"] == "hypervisor" or data["uuid"] == data["serial"] ): return CloudNames.AWS return None def identify_brightbox(data): if data["serial"].endswith(".brightbox.com"): return CloudNames.BRIGHTBOX def identify_zstack(data): if data["asset_tag"].endswith(".zstack.io"): return CloudNames.ZSTACK def identify_e24cloud(data): if data["vendor"] == "e24cloud": return CloudNames.E24CLOUD def identify_outscale(data): if ( data["product_name"] == "3DS Outscale VM".lower() and data["vendor"] == "3DS Outscale".lower() ): return CloudNames.OUTSCALE def identify_platform(): # identify the platform and return an entry in CloudNames. data = _collect_platform_data() checks = ( identify_aws, identify_brightbox, identify_zstack, identify_e24cloud, identify_outscale, identify_aliyun, lambda x: CloudNames.UNKNOWN, ) for checker in checks: try: result = checker(data) if result: return result except Exception as e: LOG.warning( "calling %s with %s raised exception: %s", checker, data, e ) def _collect_platform_data(): """Returns a dictionary of platform info from dmi or /sys/hypervisor. Keys in the dictionary are as follows: uuid: system-uuid from dmi or /sys/hypervisor uuid_source: 'hypervisor' (/sys/hypervisor/uuid) or 'dmi' serial: dmi 'system-serial-number' (/sys/.../product_serial) asset_tag: 'dmidecode -s chassis-asset-tag' vendor: dmi 'system-manufacturer' (/sys/.../sys_vendor) product_name: dmi 'system-product-name' (/sys/.../system-manufacturer) On Ec2 instances experimentation is that product_serial is upper case, and product_uuid is lower case. This returns lower case values for both. """ data = {} try: uuid = util.load_file("/sys/hypervisor/uuid").strip() data["uuid_source"] = "hypervisor" except Exception: uuid = dmi.read_dmi_data("system-uuid") data["uuid_source"] = "dmi" if uuid is None: uuid = "" data["uuid"] = uuid.lower() serial = dmi.read_dmi_data("system-serial-number") if serial is None: serial = "" data["serial"] = serial.lower() asset_tag = dmi.read_dmi_data("chassis-asset-tag") if asset_tag is None: asset_tag = "" data["asset_tag"] = asset_tag.lower() vendor = dmi.read_dmi_data("system-manufacturer") data["vendor"] = (vendor if vendor else "").lower() product_name = dmi.read_dmi_data("system-product-name") data["product_name"] = (product_name if product_name else "").lower() return data def convert_ec2_metadata_network_config( network_md, macs_to_nics=None, fallback_nic=None, full_network_config=True ): """Convert ec2 metadata to network config version 2 data dict. @param: network_md: 'network' portion of EC2 metadata. generally formed as {"interfaces": {"macs": {}} where 'macs' is a dictionary with mac address as key and contents like: {"device-number": "0", "interface-id": "...", "local-ipv4s": ...} @param: macs_to_nics: Optional dict of mac addresses and nic names. If not provided, get_interfaces_by_mac is called to get it from the OS. @param: fallback_nic: Optionally provide the primary nic interface name. This nic will be guaranteed to minimally have a dhcp4 configuration. @param: full_network_config: Boolean set True to configure all networking presented by IMDS. This includes rendering secondary IPv4 and IPv6 addresses on all NICs and rendering network config on secondary NICs. If False, only the primary nic will be configured and only with dhcp (IPv4/IPv6). @return A dict of network config version 2 based on the metadata and macs. """ netcfg = {"version": 2, "ethernets": {}} if not macs_to_nics: macs_to_nics = net.get_interfaces_by_mac() macs_metadata = network_md["interfaces"]["macs"] if not full_network_config: for mac, nic_name in macs_to_nics.items(): if nic_name == fallback_nic: break dev_config = { "dhcp4": True, "dhcp6": False, "match": {"macaddress": mac.lower()}, "set-name": nic_name, } nic_metadata = macs_metadata.get(mac) if nic_metadata.get("ipv6s"): # Any IPv6 addresses configured dev_config["dhcp6"] = True netcfg["ethernets"][nic_name] = dev_config return netcfg # Apply network config for all nics and any secondary IPv4/v6 addresses nic_idx = 0 for mac, nic_name in sorted(macs_to_nics.items()): nic_metadata = macs_metadata.get(mac) if not nic_metadata: continue # Not a physical nic represented in metadata # device-number is zero-indexed, we want it 1-indexed for the # multiplication on the following line nic_idx = int(nic_metadata.get("device-number", nic_idx)) + 1 dhcp_override = {"route-metric": nic_idx * 100} dev_config = { "dhcp4": True, "dhcp4-overrides": dhcp_override, "dhcp6": False, "match": {"macaddress": mac.lower()}, "set-name": nic_name, } if nic_metadata.get("ipv6s"): # Any IPv6 addresses configured dev_config["dhcp6"] = True dev_config["dhcp6-overrides"] = dhcp_override dev_config["addresses"] = get_secondary_addresses(nic_metadata, mac) if not dev_config["addresses"]: dev_config.pop("addresses") # Since we found none configured netcfg["ethernets"][nic_name] = dev_config # Remove route-metric dhcp overrides if only one nic configured if len(netcfg["ethernets"]) == 1: for nic_name in netcfg["ethernets"].keys(): netcfg["ethernets"][nic_name].pop("dhcp4-overrides") netcfg["ethernets"][nic_name].pop("dhcp6-overrides", None) return netcfg def get_secondary_addresses(nic_metadata, mac): """Parse interface-specific nic metadata and return any secondary IPs :return: List of secondary IPv4 or IPv6 addresses to configure on the interface """ ipv4s = nic_metadata.get("local-ipv4s") ipv6s = nic_metadata.get("ipv6s") addresses = [] # In version < 2018-09-24 local_ipv4s or ipv6s is a str with one IP if bool(isinstance(ipv4s, list) and len(ipv4s) > 1): addresses.extend( _get_secondary_addresses( nic_metadata, "subnet-ipv4-cidr-block", mac, ipv4s, "24" ) ) if bool(isinstance(ipv6s, list) and len(ipv6s) > 1): addresses.extend( _get_secondary_addresses( nic_metadata, "subnet-ipv6-cidr-block", mac, ipv6s, "128" ) ) return sorted(addresses) def _get_secondary_addresses(nic_metadata, cidr_key, mac, ips, default_prefix): """Return list of IP addresses as CIDRs for secondary IPs The CIDR prefix will be default_prefix if cidr_key is absent or not parseable in nic_metadata. """ addresses = [] cidr = nic_metadata.get(cidr_key) prefix = default_prefix if not cidr or len(cidr.split("/")) != 2: ip_type = "ipv4" if "ipv4" in cidr_key else "ipv6" LOG.warning( "Could not parse %s %s for mac %s. %s network" " config prefix defaults to /%s", cidr_key, cidr, mac, ip_type, prefix, ) else: prefix = cidr.split("/")[1] # We know we have > 1 ips for in metadata for this IP type for ip in ips[1:]: addresses.append("{ip}/{prefix}".format(ip=ip, prefix=prefix)) return addresses # Used to match classes to dependencies datasources = [ (DataSourceEc2Local, (sources.DEP_FILESYSTEM,)), # Run at init-local (DataSourceEc2, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceCloudStack.py 0000644 00000023552 15027667240 0011145 0 ustar 00 # Copyright (C) 2012 Canonical Ltd. # Copyright (C) 2012 Cosmin Luta # Copyright (C) 2012 Yahoo! Inc. # Copyright (C) 2012 Gerard Dethier # Copyright (C) 2013 Hewlett-Packard Development Company, L.P. # # Author: Cosmin Luta <q4break@gmail.com> # Author: Scott Moser <scott.moser@canonical.com> # Author: Joshua Harlow <harlowja@yahoo-inc.com> # Author: Gerard Dethier <g.dethier@gmail.com> # Author: Juerg Haefliger <juerg.haefliger@hp.com> # # This file is part of cloud-init. See LICENSE file for license information. import os import time from socket import gaierror, getaddrinfo, inet_ntoa from struct import pack from cloudinit import log as logging from cloudinit import sources, subp from cloudinit import url_helper as uhelp from cloudinit import util from cloudinit.net import dhcp from cloudinit.sources.helpers import ec2 LOG = logging.getLogger(__name__) class CloudStackPasswordServerClient: """ Implements password fetching from the CloudStack password server. http://cloudstack-administration.readthedocs.org/ en/latest/templates.html#adding-password-management-to-your-templates has documentation about the system. This implementation is following that found at https://github.com/shankerbalan/cloudstack-scripts/ blob/master/cloud-set-guest-password-debian """ def __init__(self, virtual_router_address): self.virtual_router_address = virtual_router_address def _do_request(self, domu_request): # The password server was in the past, a broken HTTP server, but is now # fixed. wget handles this seamlessly, so it's easier to shell out to # that rather than write our own handling code. output, _ = subp.subp( [ "wget", "--quiet", "--tries", "3", "--timeout", "20", "--output-document", "-", "--header", "DomU_Request: {0}".format(domu_request), "{0}:8080".format(self.virtual_router_address), ] ) return output.strip() def get_password(self): password = self._do_request("send_my_password") if password in ["", "saved_password"]: return None if password == "bad_request": raise RuntimeError("Error when attempting to fetch root password.") self._do_request("saved_password") return password class DataSourceCloudStack(sources.DataSource): dsname = "CloudStack" # Setup read_url parameters per get_url_params. url_max_wait = 120 url_timeout = 50 def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.seed_dir = os.path.join(paths.seed_dir, "cs") # Cloudstack has its metadata/userdata URLs located at # http://<virtual-router-ip>/latest/ self.api_ver = "latest" self.vr_addr = get_vr_address() if not self.vr_addr: raise RuntimeError("No virtual router found!") self.metadata_address = "http://%s/" % (self.vr_addr,) self.cfg = {} def wait_for_metadata_service(self): url_params = self.get_url_params() if url_params.max_wait_seconds <= 0: return False urls = [ uhelp.combine_url( self.metadata_address, "latest/meta-data/instance-id" ) ] start_time = time.time() url, _response = uhelp.wait_for_url( urls=urls, max_wait=url_params.max_wait_seconds, timeout=url_params.timeout_seconds, status_cb=LOG.warning, ) if url: LOG.debug("Using metadata source: '%s'", url) else: LOG.critical( "Giving up on waiting for the metadata from %s" " after %s seconds", urls, int(time.time() - start_time), ) return bool(url) def get_config_obj(self): return self.cfg def _get_data(self): seed_ret = {} if util.read_optional_seed(seed_ret, base=(self.seed_dir + "/")): self.userdata_raw = seed_ret["user-data"] self.metadata = seed_ret["meta-data"] LOG.debug("Using seeded cloudstack data from: %s", self.seed_dir) return True try: if not self.wait_for_metadata_service(): return False start_time = time.time() self.userdata_raw = ec2.get_instance_userdata( self.api_ver, self.metadata_address ) self.metadata = ec2.get_instance_metadata( self.api_ver, self.metadata_address ) LOG.debug( "Crawl of metadata service took %s seconds", int(time.time() - start_time), ) password_client = CloudStackPasswordServerClient(self.vr_addr) try: set_password = password_client.get_password() except Exception: util.logexc( LOG, "Failed to fetch password from virtual router %s", self.vr_addr, ) else: if set_password: self.cfg = { "ssh_pwauth": True, "password": set_password, "chpasswd": { "expire": False, }, } return True except Exception: util.logexc( LOG, "Failed fetching from metadata service %s", self.metadata_address, ) return False def get_instance_id(self): return self.metadata["instance-id"] @property def availability_zone(self): return self.metadata["availability-zone"] def get_data_server(): # Returns the metadataserver from dns try: addrinfo = getaddrinfo("data-server", 80) except gaierror: LOG.debug("DNS Entry data-server not found") return None else: return addrinfo[0][4][0] # return IP def get_default_gateway(): # Returns the default gateway ip address in the dotted format. lines = util.load_file("/proc/net/route").splitlines() for line in lines: items = line.split("\t") if items[1] == "00000000": # Found the default route, get the gateway gw = inet_ntoa(pack("<L", int(items[2], 16))) LOG.debug("Found default route, gateway is %s", gw) return gw return None def get_dhclient_d(): # find lease files directory supported_dirs = [ "/var/lib/dhclient", "/var/lib/dhcp", "/var/lib/NetworkManager", ] for d in supported_dirs: if os.path.exists(d) and len(os.listdir(d)) > 0: LOG.debug("Using %s lease directory", d) return d return None def get_latest_lease(lease_d=None): # find latest lease file if lease_d is None: lease_d = get_dhclient_d() if not lease_d: return None lease_files = os.listdir(lease_d) latest_mtime = -1 latest_file = None # lease files are named inconsistently across distros. # We assume that 'dhclient6' indicates ipv6 and ignore it. # ubuntu: # dhclient.<iface>.leases, dhclient.leases, dhclient6.leases # centos6: # dhclient-<iface>.leases, dhclient6.leases # centos7: ('--' is not a typo) # dhclient--<iface>.lease, dhclient6.leases for fname in lease_files: if fname.startswith("dhclient6"): # avoid files that start with dhclient6 assuming dhcpv6. continue if not (fname.endswith(".lease") or fname.endswith(".leases")): continue abs_path = os.path.join(lease_d, fname) mtime = os.path.getmtime(abs_path) if mtime > latest_mtime: latest_mtime = mtime latest_file = abs_path return latest_file def get_vr_address(): # Get the address of the virtual router via dhcp leases # If no virtual router is detected, fallback on default gateway. # See http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/4.8/virtual_machines/user-data.html # noqa # Try data-server DNS entry first latest_address = get_data_server() if latest_address: LOG.debug( "Found metadata server '%s' via data-server DNS entry", latest_address, ) return latest_address # Try networkd second... latest_address = dhcp.networkd_get_option_from_leases("SERVER_ADDRESS") if latest_address: LOG.debug( "Found SERVER_ADDRESS '%s' via networkd_leases", latest_address ) return latest_address # Try dhcp lease files next... lease_file = get_latest_lease() if not lease_file: LOG.debug("No lease file found, using default gateway") return get_default_gateway() with open(lease_file, "r") as fd: for line in fd: if "dhcp-server-identifier" in line: words = line.strip(" ;\r\n").split(" ") if len(words) > 2: dhcptok = words[2] LOG.debug("Found DHCP identifier %s", dhcptok) latest_address = dhcptok if not latest_address: # No virtual router found, fallback on default gateway LOG.debug("No DHCP found, using default gateway") return get_default_gateway() return latest_address # Used to match classes to dependencies datasources = [ (DataSourceCloudStack, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceVultr.py 0000644 00000010267 15027667240 0010224 0 ustar 00 # Author: Eric Benner <ebenner@vultr.com> # # This file is part of cloud-init. See LICENSE file for license information. # Vultr Metadata API: # https://www.vultr.com/metadata/ from typing import Tuple import cloudinit.sources.helpers.vultr as vultr from cloudinit import log as log from cloudinit import sources, util, version LOG = log.getLogger(__name__) BUILTIN_DS_CONFIG = { "url": "http://169.254.169.254", "retries": 30, "timeout": 10, "wait": 5, "user-agent": "Cloud-Init/%s - OS: %s Variant: %s" % ( version.version_string(), util.system_info()["system"], util.system_info()["variant"], ), } class DataSourceVultr(sources.DataSource): dsname = "Vultr" sensitive_metadata_keys: Tuple[ str, ... ] = sources.DataSource.sensitive_metadata_keys + ("startup-script",) def __init__(self, sys_cfg, distro, paths): super(DataSourceVultr, self).__init__(sys_cfg, distro, paths) self.ds_cfg = util.mergemanydict( [ util.get_cfg_by_path(sys_cfg, ["datasource", "Vultr"], {}), BUILTIN_DS_CONFIG, ] ) # Initiate data and check if Vultr def _get_data(self): LOG.debug("Detecting if machine is a Vultr instance") if not vultr.is_vultr(): LOG.debug("Machine is not a Vultr instance") return False LOG.debug("Machine is a Vultr instance") # Fetch metadata self.metadata = self.get_metadata() self.userdata_raw = self.metadata["user-data"] # Generate config and process data self.get_datasource_data(self.metadata) # Dump some data so diagnosing failures is manageable LOG.debug("SUBID: %s", self.metadata["instance-id"]) LOG.debug("Hostname: %s", self.metadata["local-hostname"]) return True # Process metadata def get_datasource_data(self, md): # Generate network config if "cloud_interfaces" in md: # In the future we will just drop pre-configured # network configs into the array. They need names though. vultr.add_interface_names(md["cloud_interfaces"]) self.netcfg = md["cloud_interfaces"] else: self.netcfg = vultr.generate_network_config(md["interfaces"]) # Grab vendordata self.vendordata_raw = md["vendor-data"] # Default hostname is "guest" for whitelabel if self.metadata["local-hostname"] == "": self.metadata["local-hostname"] = "guest" self.userdata_raw = md["user-data"] if self.userdata_raw == "": self.userdata_raw = None # Get the metadata by flag def get_metadata(self): return vultr.get_metadata( self.ds_cfg["url"], self.ds_cfg["timeout"], self.ds_cfg["retries"], self.ds_cfg["wait"], self.ds_cfg["user-agent"], tmp_dir=self.distro.get_tmp_exec_path(), ) # Compare subid as instance id def check_instance_id(self, sys_cfg): if not vultr.is_vultr(): return False # Baremetal has no way to implement this in local if vultr.is_baremetal(): return False subid = vultr.get_sysinfo()["subid"] return sources.instance_id_matches_system_uuid(subid) # Currently unsupported @property def launch_index(self): return None @property def network_config(self): return self.netcfg # Used to match classes to dependencies datasources = [ (DataSourceVultr, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) if __name__ == "__main__": import sys if not vultr.is_vultr(): print("Machine is not a Vultr instance") sys.exit(1) md = vultr.get_metadata( BUILTIN_DS_CONFIG["url"], BUILTIN_DS_CONFIG["timeout"], BUILTIN_DS_CONFIG["retries"], BUILTIN_DS_CONFIG["wait"], BUILTIN_DS_CONFIG["user-agent"], ) config = md["vendor-data"] sysinfo = vultr.get_sysinfo() # vi: ts=4 expandtab DataSourceAliYun.py 0000644 00000004255 15027667240 0010311 0 ustar 00 # This file is part of cloud-init. See LICENSE file for license information. from typing import List from cloudinit import dmi, sources from cloudinit.sources import DataSourceEc2 as EC2 from cloudinit.sources import DataSourceHostname ALIYUN_PRODUCT = "Alibaba Cloud ECS" class DataSourceAliYun(EC2.DataSourceEc2): dsname = "AliYun" metadata_urls = ["http://100.100.100.200"] # The minimum supported metadata_version from the ec2 metadata apis min_metadata_version = "2016-01-01" extended_metadata_versions: List[str] = [] # Aliyun metadata server security enhanced mode overwrite @property def imdsv2_token_put_header(self): return "X-aliyun-ecs-metadata-token" def get_hostname(self, fqdn=False, resolve_ip=False, metadata_only=False): hostname = self.metadata.get("hostname") is_default = False if hostname is None: hostname = "localhost.localdomain" is_default = True return DataSourceHostname(hostname, is_default) def get_public_ssh_keys(self): return parse_public_keys(self.metadata.get("public-keys", {})) def _get_cloud_name(self): if _is_aliyun(): return EC2.CloudNames.ALIYUN else: return EC2.CloudNames.NO_EC2_METADATA def _is_aliyun(): return dmi.read_dmi_data("system-product-name") == ALIYUN_PRODUCT def parse_public_keys(public_keys): keys = [] for _key_id, key_body in public_keys.items(): if isinstance(key_body, str): keys.append(key_body.strip()) elif isinstance(key_body, list): keys.extend(key_body) elif isinstance(key_body, dict): key = key_body.get("openssh-key", []) if isinstance(key, str): keys.append(key.strip()) elif isinstance(key, list): keys.extend(key) return keys # Used to match classes to dependencies datasources = [ (DataSourceAliYun, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceNWCS.py 0000644 00000011240 15027667240 0007652 0 ustar 00 # This file is part of cloud-init. See LICENSE file for license information. from requests import exceptions from cloudinit import dmi from cloudinit import log as logging from cloudinit import net, sources, subp, url_helper, util from cloudinit.net.dhcp import NoDHCPLeaseError from cloudinit.net.ephemeral import EphemeralDHCPv4 LOG = logging.getLogger(__name__) BASE_URL_V1 = "http://169.254.169.254/api/v1" BUILTIN_DS_CONFIG = { "metadata_url": BASE_URL_V1 + "/metadata", } MD_RETRIES = 30 MD_TIMEOUT = 5 MD_WAIT_RETRY = 5 class DataSourceNWCS(sources.DataSource): dsname = "NWCS" def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.distro = distro self.metadata = dict() self.ds_cfg = util.mergemanydict( [ util.get_cfg_by_path(sys_cfg, ["datasource", "NWCS"], {}), BUILTIN_DS_CONFIG, ] ) self.metadata_address = self.ds_cfg["metadata_url"] self.retries = self.ds_cfg.get("retries", MD_RETRIES) self.timeout = self.ds_cfg.get("timeout", MD_TIMEOUT) self.wait_retry = self.ds_cfg.get("wait_retry", MD_WAIT_RETRY) self._network_config = sources.UNSET self.dsmode = sources.DSMODE_NETWORK def _get_data(self): LOG.info("Detecting if machine is a NWCS instance") on_nwcs = get_nwcs_data() if not on_nwcs: LOG.info("Machine is not a NWCS instance") return False LOG.info("Machine is a NWCS instance") md = self.get_metadata() if md is None: raise Exception("failed to get metadata") self.metadata_full = md self.metadata["instance-id"] = md["instance-id"] self.metadata["public-keys"] = md["public-keys"] self.metadata["network"] = md["network"] self.metadata["local-hostname"] = md["hostname"] self.userdata_raw = md.get("userdata", None) self.vendordata_raw = md.get("vendordata", None) return True def get_metadata(self): try: LOG.info("Attempting to get metadata via DHCP") with EphemeralDHCPv4( iface=net.find_fallback_nic(), connectivity_url_data={ "url": BASE_URL_V1 + "/metadata/instance-id", }, ): return read_metadata( self.metadata_address, timeout=self.timeout, sec_between=self.wait_retry, retries=self.retries, ) except ( NoDHCPLeaseError, subp.ProcessExecutionError, RuntimeError, exceptions.RequestException, ) as e: LOG.error("DHCP failure: %s", e) raise @property def network_config(self): LOG.debug("Attempting network configuration") if self._network_config is None: LOG.warning( "Found None as cached _network_config, resetting to %s", sources.UNSET, ) self._network_config = sources.UNSET if self._network_config != sources.UNSET: return self._network_config if not self.metadata["network"]["config"]: raise Exception("Unable to get metadata from server") # metadata sends interface names, but we dont want to use them for i in self.metadata["network"]["config"]: iface_name = get_interface_name(i["mac_address"]) if iface_name: LOG.info("Overriding %s with %s", i["name"], iface_name) i["name"] = iface_name self._network_config = self.metadata["network"] return self._network_config def get_nwcs_data(): vendor_name = dmi.read_dmi_data("system-manufacturer") if vendor_name != "NWCS": return False return True def get_interface_name(mac): macs_to_nic = net.get_interfaces_by_mac() if mac not in macs_to_nic: return None return macs_to_nic.get(mac) # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) def read_metadata(url, timeout=2, sec_between=2, retries=30): response = url_helper.readurl( url, timeout=timeout, sec_between=sec_between, retries=retries ) if not response.ok(): raise RuntimeError("unable to read metadata at %s" % url) return util.load_json(response.contents.decode()) # Used to match classes to dependencies datasources = [ (DataSourceNWCS, (sources.DEP_FILESYSTEM,)), ] # vi: ts=4 expandtab azure/__pycache__/__init__.cpython-310.pyc 0000644 00000000237 15027667240 0014355 0 ustar 00 o �Ad � @ s d S )N� r r r �B/usr/lib/python3/dist-packages/cloudinit/sources/azure/__init__.py�<module> s azure/__pycache__/imds.cpython-310.pyc 0000644 00000007775 15027667240 0013570 0 ustar 00 o �Ad� � @ s� d dl mZ d dlZd dlmZ d dlmZ d dlmZ d dl m Z m Z e� e �ZdZG dd � d �Zd d d d �dededededef dd�Z ddededefdd�Zddedefdd�Zdefdd�ZdS ) � )�DictN)�log)�util)�report_diagnostic_event)�UrlError�readurlz http://169.254.169.254/metadatac @ s: e Zd Zdddd�dededdfd d �Zdefd d �ZdS ) �ReadUrlRetryHandler)� � i� i� � � �?)� retry_codes�max_connection_errors�logging_backoffr r �returnNc C s" || _ || _|| _d| _d| _d S )Nr r )r r r �_logging_threshold�_request_count)�selfr r r � r �>/usr/lib/python3/dist-packages/cloudinit/sources/azure/imds.py�__init__ s z ReadUrlRetryHandler.__init__c C s� | j d7 _ t|t�std| tjd� dS d}d}t|jtjtj f�r4| j d8 _ | j dk r3d}n|j | j vr<d}| j | j krK| j | j9 _ nd}|sQ|s]td| j |f tjd� |S )N� z1Polling IMDS failed with unexpected exception: %r�� logger_funcFTr z1Polling IMDS failed attempt %d with exception: %r)r � isinstancer r �LOG�warning�cause�requests�ConnectionError�Timeoutr �coder r r �info)r �req_args� exceptionr �retryr r r �exception_callback& s> ��� � ��z&ReadUrlRetryHandler.exception_callback)�__name__� __module__� __qualname__�int�floatr �boolr& r r r r r s � � � �r Tr � )� log_response�retries�timeout�urlr. r/ r0 r c C sX t � }zt| |jddid|||d�}W |jS ty+ } z td| tjd� � d}~ww )zLFetch URL from IMDS. :raises UrlError: on error fetching metadata. �Metadata�trueF)� exception_cb�headers�infinite� log_req_respr/ r0 z&Failed to fetch metadata from IMDS: %sr N)r r r& r r r r �contents)r1 r. r/ r0 �handler�response�errorr r r � _fetch_urlM s( �����r< c C sF t | |d�}zt�|�W S ty" } z td| tjd� � d}~ww )zFetch IMDS metadata. :raises UrlError: on error fetching metadata. :raises ValueError: on error parsing metadata. �r/ z&Failed to parse metadata from IMDS: %sr N)r< r � load_json� ValueErrorr r r )r1 r/ �metadatar; r r r �_fetch_metadataj s ���rA c C sj z t d }t|| d�W S ty4 } z |jdkr/tdtjd� t d }t|| d�W Y d}~S � d}~ww )z�Fetch extended metadata, falling back to non-extended as required. :raises UrlError: on error fetching metadata. :raises ValueError: on error parsing metadata. z./instance?api-version=2021-08-01&extended=truer= i� z,Falling back to IMDS api-version: 2019-06-01r z /instance?api-version=2019-06-01N)�IMDS_URLrA r r! r r r )r/ r1 r; r r r � fetch_metadata_with_api_fallback s ���rC c C sR t d } tdddd�}t| |jddidd d d �}td |jd � d�tjd� |jS )zhFetch extended metadata, falling back to non-extended as required. :raises UrlError: on error. z'/reprovisiondata?api-version=2019-06-01g @r )r r )r r r r2 r3 TFr- )r4 r5 r6 r7 r0 z Polled IMDS r z time(s)r ) rB r r r& r r r �debugr8 )r1 r9 r: r r r �fetch_reprovision_data� s& �� �rE )r )�typingr r � cloudinitr �loggingr � cloudinit.sources.helpers.azurer �cloudinit.url_helperr r � getLoggerr' r rB r �strr, r* �bytesr< rA rC rE r r r r �<module> s> ;����� � ��� � azure/imds.py 0000644 00000011616 15027667240 0007216 0 ustar 00 # Copyright (C) 2022 Microsoft Corporation. # # This file is part of cloud-init. See LICENSE file for license information. from typing import Dict import requests from cloudinit import log as logging from cloudinit import util from cloudinit.sources.helpers.azure import report_diagnostic_event from cloudinit.url_helper import UrlError, readurl LOG = logging.getLogger(__name__) IMDS_URL = "http://169.254.169.254/metadata" class ReadUrlRetryHandler: def __init__( self, *, retry_codes=( 404, # not found (yet) 410, # gone / unavailable (yet) 429, # rate-limited/throttled 500, # server error ), max_connection_errors: int = 10, logging_backoff: float = 1.0, ) -> None: self.logging_backoff = logging_backoff self.max_connection_errors = max_connection_errors self.retry_codes = retry_codes self._logging_threshold = 1.0 self._request_count = 0 def exception_callback(self, req_args, exception) -> bool: self._request_count += 1 if not isinstance(exception, UrlError): report_diagnostic_event( "Polling IMDS failed with unexpected exception: %r" % (exception), logger_func=LOG.warning, ) return False log = True retry = True # Check for connection errors which may occur early boot, but # are otherwise indicative that we are not connecting with the # primary NIC. if isinstance( exception.cause, (requests.ConnectionError, requests.Timeout) ): self.max_connection_errors -= 1 if self.max_connection_errors < 0: retry = False elif exception.code not in self.retry_codes: retry = False if self._request_count >= self._logging_threshold: self._logging_threshold *= self.logging_backoff else: log = False if log or not retry: report_diagnostic_event( "Polling IMDS failed attempt %d with exception: %r" % (self._request_count, exception), logger_func=LOG.info, ) return retry def _fetch_url( url: str, *, log_response: bool = True, retries: int = 10, timeout: int = 2 ) -> bytes: """Fetch URL from IMDS. :raises UrlError: on error fetching metadata. """ handler = ReadUrlRetryHandler() try: response = readurl( url, exception_cb=handler.exception_callback, headers={"Metadata": "true"}, infinite=False, log_req_resp=log_response, retries=retries, timeout=timeout, ) except UrlError as error: report_diagnostic_event( "Failed to fetch metadata from IMDS: %s" % error, logger_func=LOG.warning, ) raise return response.contents def _fetch_metadata( url: str, retries: int = 10, ) -> Dict: """Fetch IMDS metadata. :raises UrlError: on error fetching metadata. :raises ValueError: on error parsing metadata. """ metadata = _fetch_url(url, retries=retries) try: return util.load_json(metadata) except ValueError as error: report_diagnostic_event( "Failed to parse metadata from IMDS: %s" % error, logger_func=LOG.warning, ) raise def fetch_metadata_with_api_fallback(retries: int = 10) -> Dict: """Fetch extended metadata, falling back to non-extended as required. :raises UrlError: on error fetching metadata. :raises ValueError: on error parsing metadata. """ try: url = IMDS_URL + "/instance?api-version=2021-08-01&extended=true" return _fetch_metadata(url, retries=retries) except UrlError as error: if error.code == 400: report_diagnostic_event( "Falling back to IMDS api-version: 2019-06-01", logger_func=LOG.warning, ) url = IMDS_URL + "/instance?api-version=2019-06-01" return _fetch_metadata(url, retries=retries) raise def fetch_reprovision_data() -> bytes: """Fetch extended metadata, falling back to non-extended as required. :raises UrlError: on error. """ url = IMDS_URL + "/reprovisiondata?api-version=2019-06-01" handler = ReadUrlRetryHandler( logging_backoff=2.0, max_connection_errors=0, retry_codes=( 404, 410, ), ) response = readurl( url, exception_cb=handler.exception_callback, headers={"Metadata": "true"}, infinite=True, log_req_resp=False, timeout=2, ) report_diagnostic_event( f"Polled IMDS {handler._request_count+1} time(s)", logger_func=LOG.debug, ) return response.contents azure/__init__.py 0000644 00000000000 15027667240 0010002 0 ustar 00 DataSourceConfigDrive.py 0000644 00000026013 15027667240 0011303 0 ustar 00 # Copyright (C) 2012 Canonical Ltd. # Copyright (C) 2012 Yahoo! Inc. # # Author: Scott Moser <scott.moser@canonical.com> # Author: Joshua Harlow <harlowja@yahoo-inc.com> # # This file is part of cloud-init. See LICENSE file for license information. import os from cloudinit import log as logging from cloudinit import sources, subp, util from cloudinit.event import EventScope, EventType from cloudinit.net import eni from cloudinit.sources.DataSourceIBMCloud import get_ibm_platform from cloudinit.sources.helpers import openstack LOG = logging.getLogger(__name__) # Various defaults/constants... DEFAULT_IID = "iid-dsconfigdrive" DEFAULT_MODE = "pass" DEFAULT_METADATA = { "instance-id": DEFAULT_IID, } FS_TYPES = ("vfat", "iso9660") LABEL_TYPES = ("config-2", "CONFIG-2") POSSIBLE_MOUNTS = ("sr", "cd") OPTICAL_DEVICES = tuple( ("/dev/%s%s" % (z, i) for z in POSSIBLE_MOUNTS for i in range(0, 2)) ) class DataSourceConfigDrive(openstack.SourceMixin, sources.DataSource): dsname = "ConfigDrive" supported_update_events = { EventScope.NETWORK: { EventType.BOOT_NEW_INSTANCE, EventType.BOOT, EventType.BOOT_LEGACY, EventType.HOTPLUG, } } def __init__(self, sys_cfg, distro, paths): super(DataSourceConfigDrive, self).__init__(sys_cfg, distro, paths) self.source = None self.seed_dir = os.path.join(paths.seed_dir, "config_drive") self.version = None self.ec2_metadata = None self._network_config = None self.network_json = sources.UNSET self.network_eni = None self.known_macs = None self.files = {} def __str__(self): root = sources.DataSource.__str__(self) mstr = "%s [%s,ver=%s]" % (root, self.dsmode, self.version) mstr += "[source=%s]" % (self.source) return mstr def _get_data(self): found = None md = {} results = {} for sdir in (self.seed_dir, "/config-drive"): if not os.path.isdir(sdir): continue try: results = read_config_drive(sdir) found = sdir break except openstack.NonReadable: util.logexc(LOG, "Failed reading config drive from %s", sdir) if not found: dslist = self.sys_cfg.get("datasource_list") for dev in find_candidate_devs(dslist=dslist): mtype = None if util.is_BSD(): if dev.startswith("/dev/cd"): mtype = "cd9660" try: results = util.mount_cb( dev, read_config_drive, mtype=mtype ) found = dev except openstack.NonReadable: pass except util.MountFailedError: pass except openstack.BrokenMetadata: util.logexc(LOG, "Broken config drive: %s", dev) if found: break if not found: return False md = results.get("metadata", {}) md = util.mergemanydict([md, DEFAULT_METADATA]) self.dsmode = self._determine_dsmode( [ results.get("dsmode"), self.ds_cfg.get("dsmode"), sources.DSMODE_PASS if results["version"] == 1 else None, ] ) if self.dsmode == sources.DSMODE_DISABLED: return False prev_iid = get_previous_iid(self.paths) cur_iid = md["instance-id"] if prev_iid != cur_iid: # better would be to handle this centrally, allowing # the datasource to do something on new instance id # note, networking is only rendered here if dsmode is DSMODE_PASS # which means "DISABLED, but render files and networking" on_first_boot( results, distro=self.distro, network=self.dsmode == sources.DSMODE_PASS, ) # This is legacy and sneaky. If dsmode is 'pass' then do not claim # the datasource was used, even though we did run on_first_boot above. if self.dsmode == sources.DSMODE_PASS: LOG.debug( "%s: not claiming datasource, dsmode=%s", self, self.dsmode ) return False self.source = found self.metadata = md self.ec2_metadata = results.get("ec2-metadata") self.userdata_raw = results.get("userdata") self.version = results["version"] self.files.update(results.get("files", {})) vd = results.get("vendordata") self.vendordata_pure = vd try: self.vendordata_raw = sources.convert_vendordata(vd) except ValueError as e: LOG.warning("Invalid content in vendor-data: %s", e) self.vendordata_raw = None vd2 = results.get("vendordata2") self.vendordata2_pure = vd2 try: self.vendordata2_raw = sources.convert_vendordata(vd2) except ValueError as e: LOG.warning("Invalid content in vendor-data2: %s", e) self.vendordata2_raw = None # network_config is an /etc/network/interfaces formated file and is # obsolete compared to networkdata (from network_data.json) but both # might be present. self.network_eni = results.get("network_config") self.network_json = results.get("networkdata") return True def check_instance_id(self, sys_cfg): # quickly (local check only) if self.instance_id is still valid return sources.instance_id_matches_system_uuid(self.get_instance_id()) @property def network_config(self): if self._network_config is None: if self.network_json not in (None, sources.UNSET): LOG.debug("network config provided via network_json") self._network_config = openstack.convert_net_json( self.network_json, known_macs=self.known_macs ) elif self.network_eni is not None: self._network_config = eni.convert_eni_data(self.network_eni) LOG.debug("network config provided via converted eni data") else: LOG.debug("no network configuration available") return self._network_config @property def platform(self): return "openstack" def _get_subplatform(self): """Return the subplatform metadata source details.""" if self.source.startswith("/dev"): subplatform_type = "config-disk" else: subplatform_type = "seed-dir" return "%s (%s)" % (subplatform_type, self.source) def read_config_drive(source_dir): reader = openstack.ConfigDriveReader(source_dir) finders = [ (reader.read_v2, [], {}), (reader.read_v1, [], {}), ] excps = [] for (functor, args, kwargs) in finders: try: return functor(*args, **kwargs) except openstack.NonReadable as e: excps.append(e) raise excps[-1] def get_previous_iid(paths): # interestingly, for this purpose the "previous" instance-id is the current # instance-id. cloud-init hasn't moved them over yet as this datasource # hasn't declared itself found. fname = os.path.join(paths.get_cpath("data"), "instance-id") try: return util.load_file(fname).rstrip("\n") except IOError: return None def on_first_boot(data, distro=None, network=True): """Performs any first-boot actions using data read from a config-drive.""" if not isinstance(data, dict): raise TypeError( "Config-drive data expected to be a dict; not %s" % (type(data)) ) if network: net_conf = data.get("network_config", "") if net_conf and distro: LOG.warning("Updating network interfaces from config drive") distro.apply_network_config(eni.convert_eni_data(net_conf)) write_injected_files(data.get("files")) def write_injected_files(files): if files: LOG.debug("Writing %s injected files", len(files)) for (filename, content) in files.items(): if not filename.startswith(os.sep): filename = os.sep + filename try: util.write_file(filename, content, mode=0o660) except IOError: util.logexc(LOG, "Failed writing file: %s", filename) def find_candidate_devs(probe_optical=True, dslist=None): """Return a list of devices that may contain the config drive. The returned list is sorted by search order where the first item has should be searched first (highest priority) config drive v1: Per documentation, this is "associated as the last available disk on the instance", and should be VFAT. Currently, we do not restrict search list to "last available disk" config drive v2: Disk should be: * either vfat or iso9660 formatted * labeled with 'config-2' or 'CONFIG-2' """ if dslist is None: dslist = [] # query optical drive to get it in blkid cache for 2.6 kernels if probe_optical: for device in OPTICAL_DEVICES: try: util.find_devs_with(path=device) except subp.ProcessExecutionError: pass by_fstype = [] for fs_type in FS_TYPES: by_fstype.extend(util.find_devs_with("TYPE=%s" % (fs_type))) by_label = [] for label in LABEL_TYPES: by_label.extend(util.find_devs_with("LABEL=%s" % (label))) # give preference to "last available disk" (vdb over vda) # note, this is not a perfect rendition of that. by_fstype.sort(reverse=True) by_label.sort(reverse=True) # combine list of items by putting by-label items first # followed by fstype items, but with dupes removed candidates = by_label + [d for d in by_fstype if d not in by_label] # We are looking for a block device or partition with necessary label or # an unpartitioned block device (ex sda, not sda1) devices = [ d for d in candidates if d in by_label or not util.is_partition(d) ] LOG.debug("devices=%s dslist=%s", devices, dslist) if devices and "IBMCloud" in dslist: # IBMCloud uses config-2 label, but limited to a single UUID. ibm_platform, ibm_path = get_ibm_platform() if ibm_path in devices: devices.remove(ibm_path) LOG.debug( "IBMCloud device '%s' (%s) removed from candidate list", ibm_path, ibm_platform, ) return devices # Legacy: Must be present in case we load an old pkl object DataSourceConfigDriveNet = DataSourceConfigDrive # Used to match classes to dependencies datasources = [ (DataSourceConfigDrive, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceOpenNebula.py 0000644 00000037752 15027667240 0011150 0 ustar 00 # Copyright (C) 2012 Canonical Ltd. # Copyright (C) 2012 Yahoo! Inc. # Copyright (C) 2012-2013 CERIT Scientific Cloud # Copyright (C) 2012-2013 OpenNebula.org # Copyright (C) 2014 Consejo Superior de Investigaciones Cientificas # # Author: Scott Moser <scott.moser@canonical.com> # Author: Joshua Harlow <harlowja@yahoo-inc.com> # Author: Vlastimil Holer <xholer@mail.muni.cz> # Author: Javier Fontan <jfontan@opennebula.org> # Author: Enol Fernandez <enolfc@ifca.unican.es> # # This file is part of cloud-init. See LICENSE file for license information. import collections import functools import os import pwd import re import string from cloudinit import log as logging from cloudinit import net, sources, subp, util LOG = logging.getLogger(__name__) DEFAULT_IID = "iid-dsopennebula" DEFAULT_PARSEUSER = "nobody" CONTEXT_DISK_FILES = ["context.sh"] class DataSourceOpenNebula(sources.DataSource): dsname = "OpenNebula" def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.seed = None self.seed_dir = os.path.join(paths.seed_dir, "opennebula") def __str__(self): root = sources.DataSource.__str__(self) return "%s [seed=%s][dsmode=%s]" % (root, self.seed, self.dsmode) def _get_data(self): defaults = {"instance-id": DEFAULT_IID} results = None seed = None # decide parseuser for context.sh shell reader parseuser = DEFAULT_PARSEUSER if "parseuser" in self.ds_cfg: parseuser = self.ds_cfg.get("parseuser") candidates = [self.seed_dir] candidates.extend(find_candidate_devs()) for cdev in candidates: try: if os.path.isdir(self.seed_dir): results = read_context_disk_dir( cdev, self.distro, asuser=parseuser ) elif cdev.startswith("/dev"): # util.mount_cb only handles passing a single argument # through to the wrapped function, so we have to partially # apply the function to pass in `distro`. See LP: #1884979 partially_applied_func = functools.partial( read_context_disk_dir, asuser=parseuser, distro=self.distro, ) results = util.mount_cb(cdev, partially_applied_func) except NonContextDiskDir: continue except BrokenContextDiskDir as exc: raise exc except util.MountFailedError: LOG.warning("%s was not mountable", cdev) if results: seed = cdev LOG.debug("found datasource in %s", cdev) break if not seed: return False # merge fetched metadata with datasource defaults md = results["metadata"] md = util.mergemanydict([md, defaults]) # check for valid user specified dsmode self.dsmode = self._determine_dsmode( [results.get("DSMODE"), self.ds_cfg.get("dsmode")] ) if self.dsmode == sources.DSMODE_DISABLED: return False self.seed = seed self.network = results.get("network-interfaces") self.metadata = md self.userdata_raw = results.get("userdata") return True def _get_subplatform(self): """Return the subplatform metadata source details.""" if self.seed_dir in self.seed: subplatform_type = "seed-dir" else: subplatform_type = "config-disk" return "%s (%s)" % (subplatform_type, self.seed) @property def network_config(self): if self.network is not None: return self.network else: return None def get_hostname(self, fqdn=False, resolve_ip=False, metadata_only=False): if resolve_ip is None: if self.dsmode == sources.DSMODE_NETWORK: resolve_ip = True else: resolve_ip = False return sources.DataSource.get_hostname(self, fqdn, resolve_ip) class NonContextDiskDir(Exception): pass class BrokenContextDiskDir(Exception): pass class OpenNebulaNetwork: def __init__(self, context, distro, system_nics_by_mac=None): self.context = context if system_nics_by_mac is None: system_nics_by_mac = get_physical_nics_by_mac(distro) self.ifaces = collections.OrderedDict( [ k for k in sorted( system_nics_by_mac.items(), key=lambda k: net.natural_sort_key(k[1]), ) ] ) # OpenNebula 4.14+ provide macaddr for ETHX in variable ETH_MAC. # context_devname provides {mac.lower():ETHX, mac2.lower():ETHX} self.context_devname = {} for k, v in context.items(): m = re.match(r"^(.+)_MAC$", k) if m: self.context_devname[v.lower()] = m.group(1) def mac2ip(self, mac): return ".".join([str(int(c, 16)) for c in mac.split(":")[2:]]) def mac2network(self, mac): return self.mac2ip(mac).rpartition(".")[0] + ".0" def get_nameservers(self, dev): nameservers = {} dns = self.get_field(dev, "dns", "").split() dns.extend(self.context.get("DNS", "").split()) if dns: nameservers["addresses"] = dns search_domain = self.get_field(dev, "search_domain", "").split() if search_domain: nameservers["search"] = search_domain return nameservers def get_mtu(self, dev): return self.get_field(dev, "mtu") def get_ip(self, dev, mac): return self.get_field(dev, "ip", self.mac2ip(mac)) def get_ip6(self, dev): addresses6 = [] ip6 = self.get_field(dev, "ip6") if ip6: addresses6.append(ip6) ip6_ula = self.get_field(dev, "ip6_ula") if ip6_ula: addresses6.append(ip6_ula) return addresses6 def get_ip6_prefix(self, dev): return self.get_field(dev, "ip6_prefix_length", "64") def get_gateway(self, dev): return self.get_field(dev, "gateway") def get_gateway6(self, dev): # OpenNebula 6.1.80 introduced new context parameter ETHx_IP6_GATEWAY # to replace old ETHx_GATEWAY6. Old ETHx_GATEWAY6 will be removed in # OpenNebula 6.4.0 (https://github.com/OpenNebula/one/issues/5536). return self.get_field( dev, "ip6_gateway", self.get_field(dev, "gateway6") ) def get_mask(self, dev): return self.get_field(dev, "mask", "255.255.255.0") def get_network(self, dev, mac): return self.get_field(dev, "network", self.mac2network(mac)) def get_field(self, dev, name, default=None): """return the field name in context for device dev. context stores <dev>_<NAME> (example: eth0_DOMAIN). an empty string for value will return default.""" val = self.context.get( "_".join( ( dev, name, ) ).upper() ) # allow empty string to return the default. return default if val in (None, "") else val def gen_conf(self): netconf = {} netconf["version"] = 2 netconf["ethernets"] = {} ethernets = {} for mac, dev in self.ifaces.items(): mac = mac.lower() # c_dev stores name in context 'ETHX' for this device. # dev stores the current system name. c_dev = self.context_devname.get(mac, dev) devconf = {} # Set MAC address devconf["match"] = {"macaddress": mac} # Set IPv4 address devconf["addresses"] = [] mask = self.get_mask(c_dev) prefix = str(net.ipv4_mask_to_net_prefix(mask)) devconf["addresses"].append(self.get_ip(c_dev, mac) + "/" + prefix) # Set IPv6 Global and ULA address addresses6 = self.get_ip6(c_dev) if addresses6: prefix6 = self.get_ip6_prefix(c_dev) devconf["addresses"].extend( [i + "/" + prefix6 for i in addresses6] ) # Set IPv4 default gateway gateway = self.get_gateway(c_dev) if gateway: devconf["gateway4"] = gateway # Set IPv6 default gateway gateway6 = self.get_gateway6(c_dev) if gateway6: devconf["gateway6"] = gateway6 # Set DNS servers and search domains nameservers = self.get_nameservers(c_dev) if nameservers: devconf["nameservers"] = nameservers # Set MTU size mtu = self.get_mtu(c_dev) if mtu: devconf["mtu"] = mtu ethernets[dev] = devconf netconf["ethernets"] = ethernets return netconf def find_candidate_devs(): """ Return a list of devices that may contain the context disk. """ combined = [] for f in ("LABEL=CONTEXT", "LABEL=CDROM", "TYPE=iso9660"): devs = util.find_devs_with(f) devs.sort() for d in devs: if d not in combined: combined.append(d) return combined def switch_user_cmd(user): return ["sudo", "-u", user] def parse_shell_config( content, keylist=None, bash=None, asuser=None, switch_user_cb=None ): if isinstance(bash, str): bash = [bash] elif bash is None: bash = ["bash", "-e"] if switch_user_cb is None: switch_user_cb = switch_user_cmd # allvars expands to all existing variables by using '${!x*}' notation # where x is lower or upper case letters or '_' allvars = ["${!%s*}" % x for x in string.ascii_letters + "_"] keylist_in = keylist if keylist is None: keylist = allvars keylist_in = [] setup = "\n".join( ( '__v="";', "", ) ) def varprinter(vlist): # output '\0'.join(['_start_', key=value NULL for vars in vlist] return "\n".join( ( 'printf "%s\\0" _start_', "for __v in %s; do" % " ".join(vlist), ' printf "%s=%s\\0" "$__v" "${!__v}";', "done", "", ) ) # the rendered 'bcmd' is bash syntax that does # setup: declare variables we use (so they show up in 'all') # varprinter(allvars): print all variables known at beginning # content: execute the provided content # varprinter(keylist): print all variables known after content # # output is then a null terminated array of: # literal '_start_' # key=value (for each preset variable) # literal '_start_' # key=value (for each post set variable) bcmd = ( "unset IFS\n" + setup + varprinter(allvars) + "{\n%s\n\n:\n} > /dev/null\n" % content + "unset IFS\n" + varprinter(keylist) + "\n" ) cmd = [] if asuser is not None: cmd = switch_user_cb(asuser) cmd.extend(bash) (output, _error) = subp.subp(cmd, data=bcmd) # exclude vars in bash that change on their own or that we used excluded = ( "EPOCHREALTIME", "EPOCHSECONDS", "RANDOM", "LINENO", "SECONDS", "_", "SRANDOM", "__v", ) preset = {} ret = {} target = None output = output[0:-1] # remove trailing null # go through output. First _start_ is for 'preset', second for 'target'. # Add to ret only things were changed and not in excluded. for line in output.split("\x00"): try: (key, val) = line.split("=", 1) if target is preset: preset[key] = val elif key not in excluded and ( key in keylist_in or preset.get(key) != val ): ret[key] = val except ValueError: if line != "_start_": raise if target is None: target = preset elif target is preset: target = ret return ret def read_context_disk_dir(source_dir, distro, asuser=None): """ read_context_disk_dir(source_dir): read source_dir and return a tuple with metadata dict and user-data string populated. If not a valid dir, raise a NonContextDiskDir """ found = {} for af in CONTEXT_DISK_FILES: fn = os.path.join(source_dir, af) if os.path.isfile(fn): found[af] = fn if not found: raise NonContextDiskDir("%s: %s" % (source_dir, "no files found")) context = {} results = {"userdata": None, "metadata": {}} if "context.sh" in found: if asuser is not None: try: pwd.getpwnam(asuser) except KeyError as e: raise BrokenContextDiskDir( "configured user '{user}' does not exist".format( user=asuser ) ) from e try: path = os.path.join(source_dir, "context.sh") content = util.load_file(path) context = parse_shell_config(content, asuser=asuser) except subp.ProcessExecutionError as e: raise BrokenContextDiskDir( "Error processing context.sh: %s" % (e) ) from e except IOError as e: raise NonContextDiskDir( "Error reading context.sh: %s" % (e) ) from e else: raise NonContextDiskDir("Missing context.sh") if not context: return results results["metadata"] = context # process single or multiple SSH keys ssh_key_var = None if "SSH_KEY" in context: ssh_key_var = "SSH_KEY" elif "SSH_PUBLIC_KEY" in context: ssh_key_var = "SSH_PUBLIC_KEY" if ssh_key_var: lines = context.get(ssh_key_var).splitlines() results["metadata"]["public-keys"] = [ line for line in lines if len(line) and not line.startswith("#") ] # custom hostname -- try hostname or leave cloud-init # itself create hostname from IP address later for k in ("SET_HOSTNAME", "HOSTNAME", "PUBLIC_IP", "IP_PUBLIC", "ETH0_IP"): if k in context: results["metadata"]["local-hostname"] = context[k] break # raw user data if "USER_DATA" in context: results["userdata"] = context["USER_DATA"] elif "USERDATA" in context: results["userdata"] = context["USERDATA"] # b64decode user data if necessary (default) if "userdata" in results: encoding = context.get( "USERDATA_ENCODING", context.get("USER_DATA_ENCODING") ) if encoding == "base64": try: results["userdata"] = util.b64d(results["userdata"]) except TypeError: LOG.warning("Failed base64 decoding of userdata") # generate Network Configuration v2 # only if there are any required context variables # http://docs.opennebula.org/5.4/operation/references/template.html#context-section ipaddr_keys = [k for k in context if re.match(r"^ETH\d+_IP.*$", k)] if ipaddr_keys: onet = OpenNebulaNetwork(context, distro) results["network-interfaces"] = onet.gen_conf() return results def get_physical_nics_by_mac(distro): devs = net.get_interfaces_by_mac() return dict( [(m, n) for m, n in devs.items() if distro.networking.is_physical(n)] ) # Legacy: Must be present in case we load an old pkl object DataSourceOpenNebulaNet = DataSourceOpenNebula # Used to match classes to dependencies datasources = [ (DataSourceOpenNebula, (sources.DEP_FILESYSTEM,)), ] # Return a list of data sources that match this set of dependencies def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) # vi: ts=4 expandtab DataSourceGCE.py 0000644 00000027733 15027667240 0007514 0 ustar 00 # Author: Vaidas Jablonskis <jablonskis@gmail.com> # # This file is part of cloud-init. See LICENSE file for license information. import datetime import json from base64 import b64decode from contextlib import suppress as noop from cloudinit import dmi from cloudinit import log as logging from cloudinit import sources, url_helper, util from cloudinit.distros import ug_util from cloudinit.net.ephemeral import EphemeralDHCPv4 from cloudinit.sources import DataSourceHostname LOG = logging.getLogger(__name__) MD_V1_URL = "http://metadata.google.internal/computeMetadata/v1/" BUILTIN_DS_CONFIG = {"metadata_url": MD_V1_URL} REQUIRED_FIELDS = ("instance-id", "availability-zone", "local-hostname") GUEST_ATTRIBUTES_URL = ( "http://metadata.google.internal/computeMetadata/" "v1/instance/guest-attributes" ) HOSTKEY_NAMESPACE = "hostkeys" HEADERS = {"Metadata-Flavor": "Google"} class GoogleMetadataFetcher: def __init__(self, metadata_address, num_retries, sec_between_retries): self.metadata_address = metadata_address self.num_retries = num_retries self.sec_between_retries = sec_between_retries def get_value(self, path, is_text, is_recursive=False): value = None try: url = self.metadata_address + path if is_recursive: url += "/?recursive=True" resp = url_helper.readurl( url=url, headers=HEADERS, retries=self.num_retries, sec_between=self.sec_between_retries, ) except url_helper.UrlError as exc: msg = "url %s raised exception %s" LOG.debug(msg, path, exc) else: if resp.code == 200: if is_text: value = util.decode_binary(resp.contents) else: value = resp.contents.decode("utf-8") else: LOG.debug("url %s returned code %s", path, resp.code) return value class DataSourceGCE(sources.DataSource): dsname = "GCE" perform_dhcp_setup = False def __init__(self, sys_cfg, distro, paths): sources.DataSource.__init__(self, sys_cfg, distro, paths) self.default_user = None if distro: (users, _groups) = ug_util.normalize_users_groups(sys_cfg, distro) (self.default_user, _user_config) = ug_util.extract_default(users) self.metadata = dict() self.ds_cfg = util.mergemanydict( [ util.get_cfg_by_path(sys_cfg, ["datasource", "GCE"], {}), BUILTIN_DS_CONFIG, ] ) self.metadata_address = self.ds_cfg["metadata_url"] def _get_data(self): url_params = self.get_url_params() network_context = noop() if self.perform_dhcp_setup: network_context = EphemeralDHCPv4( self.fallback_interface, tmp_dir=self.distro.get_tmp_exec_path(), ) with network_context: ret = util.log_time( LOG.debug, "Crawl of GCE metadata service", read_md, kwargs={ "address": self.metadata_address, "url_params": url_params, }, ) if not ret["success"]: if ret["platform_reports_gce"]: LOG.warning(ret["reason"]) else: LOG.debug(ret["reason"]) return False self.metadata = ret["meta-data"] self.userdata_raw = ret["user-data"] return True @property def launch_index(self): # GCE does not provide lauch_index property. return None def get_instance_id(self): return self.metadata["instance-id"] def get_public_ssh_keys(self): public_keys_data = self.metadata["public-keys-data"] return _parse_public_keys(public_keys_data, self.default_user) def publish_host_keys(self, hostkeys): for key in hostkeys: _write_host_key_to_guest_attributes(*key) def get_hostname(self, fqdn=False, resolve_ip=False, metadata_only=False): # GCE has long FDQN's and has asked for short hostnames. return DataSourceHostname( self.metadata["local-hostname"].split(".")[0], False ) @property def availability_zone(self): return self.metadata["availability-zone"] @property def region(self): return self.availability_zone.rsplit("-", 1)[0] class DataSourceGCELocal(DataSourceGCE): perform_dhcp_setup = True def _write_host_key_to_guest_attributes(key_type, key_value): url = "%s/%s/%s" % (GUEST_ATTRIBUTES_URL, HOSTKEY_NAMESPACE, key_type) key_value = key_value.encode("utf-8") resp = url_helper.readurl( url=url, data=key_value, headers=HEADERS, request_method="PUT", check_status=False, ) if resp.ok(): LOG.debug("Wrote %s host key to guest attributes.", key_type) else: LOG.debug("Unable to write %s host key to guest attributes.", key_type) def _has_expired(public_key): # Check whether an SSH key is expired. Public key input is a single SSH # public key in the GCE specific key format documented here: # https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys#sshkeyformat try: # Check for the Google-specific schema identifier. schema, json_str = public_key.split(None, 3)[2:] except (ValueError, AttributeError): return False # Do not expire keys if they do not have the expected schema identifier. if schema != "google-ssh": return False try: json_obj = json.loads(json_str) except ValueError: return False # Do not expire keys if there is no expriation timestamp. if "expireOn" not in json_obj: return False expire_str = json_obj["expireOn"] format_str = "%Y-%m-%dT%H:%M:%S+0000" try: expire_time = datetime.datetime.strptime(expire_str, format_str) except ValueError: return False # Expire the key if and only if we have exceeded the expiration timestamp. return datetime.datetime.utcnow() > expire_time def _parse_public_keys(public_keys_data, default_user=None): # Parse the SSH key data for the default user account. Public keys input is # a list containing SSH public keys in the GCE specific key format # documented here: # https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys#sshkeyformat public_keys = [] if not public_keys_data: return public_keys for public_key in public_keys_data: if not public_key or not all(ord(c) < 128 for c in public_key): continue split_public_key = public_key.split(":", 1) if len(split_public_key) != 2: continue user, key = split_public_key if user in ("cloudinit", default_user) and not _has_expired(key): public_keys.append(key) return public_keys def read_md(address=None, url_params=None, platform_check=True): if address is None: address = MD_V1_URL ret = { "meta-data": None, "user-data": None, "success": False, "reason": None, } ret["platform_reports_gce"] = platform_reports_gce() if platform_check and not ret["platform_reports_gce"]: ret["reason"] = "Not running on GCE." return ret # If we cannot resolve the metadata server, then no point in trying. if not util.is_resolvable_url(address): LOG.debug("%s is not resolvable", address) ret["reason"] = 'address "%s" is not resolvable' % address return ret # url_map: (our-key, path, required, is_text, is_recursive) url_map = [ ("instance-id", ("instance/id",), True, True, False), ("availability-zone", ("instance/zone",), True, True, False), ("local-hostname", ("instance/hostname",), True, True, False), ("instance-data", ("instance/attributes",), False, False, True), ("project-data", ("project/attributes",), False, False, True), ] metadata_fetcher = GoogleMetadataFetcher( address, url_params.num_retries, url_params.sec_between_retries ) md = {} # Iterate over url_map keys to get metadata items. for (mkey, paths, required, is_text, is_recursive) in url_map: value = None for path in paths: new_value = metadata_fetcher.get_value(path, is_text, is_recursive) if new_value is not None: value = new_value if required and value is None: msg = "required key %s returned nothing. not GCE" ret["reason"] = msg % mkey return ret md[mkey] = value instance_data = json.loads(md["instance-data"] or "{}") project_data = json.loads(md["project-data"] or "{}") valid_keys = [instance_data.get("sshKeys"), instance_data.get("ssh-keys")] block_project = instance_data.get("block-project-ssh-keys", "").lower() if block_project != "true" and not instance_data.get("sshKeys"): valid_keys.append(project_data.get("ssh-keys")) valid_keys.append(project_data.get("sshKeys")) public_keys_data = "\n".join([key for key in valid_keys if key]) md["public-keys-data"] = public_keys_data.splitlines() if md["availability-zone"]: md["availability-zone"] = md["availability-zone"].split("/")[-1] if "user-data" in instance_data: # instance_data was json, so values are all utf-8 strings. ud = instance_data["user-data"].encode("utf-8") encoding = instance_data.get("user-data-encoding") if encoding == "base64": ud = b64decode(ud) elif encoding: LOG.warning("unknown user-data-encoding: %s, ignoring", encoding) ret["user-data"] = ud ret["meta-data"] = md ret["success"] = True return ret def platform_reports_gce(): pname = dmi.read_dmi_data("system-product-name") or "N/A" if pname == "Google Compute Engine" or pname == "Google": return True # system-product-name is not always guaranteed (LP: #1674861) serial = dmi.read_dmi_data("system-serial-number") or "N/A" if serial.startswith("GoogleCloud-"): return True LOG.debug( "Not running on google cloud. product-name=%s serial=%s", pname, serial ) return False # Used to match classes to dependencies. datasources = [ (DataSourceGCELocal, (sources.DEP_FILESYSTEM,)), (DataSourceGCE, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] # Return a list of data sources that match this set of dependencies. def get_datasource_list(depends): return sources.list_from_depends(depends, datasources) if __name__ == "__main__": import argparse import sys from base64 import b64encode parser = argparse.ArgumentParser(description="Query GCE Metadata Service") parser.add_argument( "--endpoint", metavar="URL", help="The url of the metadata service.", default=MD_V1_URL, ) parser.add_argument( "--no-platform-check", dest="platform_check", help="Ignore smbios platform check", action="store_false", default=True, ) args = parser.parse_args() data = read_md(address=args.endpoint, platform_check=args.platform_check) if "user-data" in data: # user-data is bytes not string like other things. Handle it specially. # If it can be represented as utf-8 then do so. Otherwise print base64 # encoded value in the key user-data-b64. try: data["user-data"] = data["user-data"].decode() except UnicodeDecodeError: sys.stderr.write( "User-data cannot be decoded. Writing as base64\n" ) del data["user-data"] # b64encode returns a bytes value. Decode to get the string. data["user-data-b64"] = b64encode(data["user-data"]).decode() print(json.dumps(data, indent=1, sort_keys=True, separators=(",", ": "))) # vi: ts=4 expandtab __init__.py 0000644 00000121453 15027667240 0006674 0 ustar 00 # Copyright (C) 2012 Canonical Ltd. # Copyright (C) 2012 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> # # This file is part of cloud-init. See LICENSE file for license information. import abc import copy import json import os import pickle from collections import namedtuple from enum import Enum, unique from typing import Any, Dict, List, Optional, Tuple from cloudinit import dmi, importer from cloudinit import log as logging from cloudinit import net, type_utils from cloudinit import user_data as ud from cloudinit import util from cloudinit.atomic_helper import write_json from cloudinit.distros import Distro from cloudinit.event import EventScope, EventType from cloudinit.filters import launch_index from cloudinit.helpers import Paths from cloudinit.persistence import CloudInitPickleMixin from cloudinit.reporting import events DSMODE_DISABLED = "disabled" DSMODE_LOCAL = "local" DSMODE_NETWORK = "net" DSMODE_PASS = "pass" VALID_DSMODES = [DSMODE_DISABLED, DSMODE_LOCAL, DSMODE_NETWORK] DEP_FILESYSTEM = "FILESYSTEM" DEP_NETWORK = "NETWORK" DS_PREFIX = "DataSource" EXPERIMENTAL_TEXT = ( "EXPERIMENTAL: The structure and format of content scoped under the 'ds'" " key may change in subsequent releases of cloud-init." ) REDACT_SENSITIVE_VALUE = "redacted for non-root user" # Key which can be provide a cloud's official product name to cloud-init METADATA_CLOUD_NAME_KEY = "cloud-name" UNSET = "_unset" METADATA_UNKNOWN = "unknown" LOG = logging.getLogger(__name__) # CLOUD_ID_REGION_PREFIX_MAP format is: # <region-match-prefix>: (<new-cloud-id>: <test_allowed_cloud_callable>) CLOUD_ID_REGION_PREFIX_MAP = { "cn-": ("aws-china", lambda c: c == "aws"), # only change aws regions "us-gov-": ("aws-gov", lambda c: c == "aws"), # only change aws regions "china": ("azure-china", lambda c: c == "azure"), # only change azure } @unique class NetworkConfigSource(Enum): """ Represents the canonical list of network config sources that cloud-init knows about. """ CMD_LINE = "cmdline" DS = "ds" SYSTEM_CFG = "system_cfg" FALLBACK = "fallback" INITRAMFS = "initramfs" def __str__(self) -> str: return self.value class DatasourceUnpickleUserDataError(Exception): """Raised when userdata is unable to be unpickled due to python upgrades""" class DataSourceNotFoundException(Exception): pass class InvalidMetaDataException(Exception): """Raised when metadata is broken, unavailable or disabled.""" def process_instance_metadata(metadata, key_path="", sensitive_keys=()): """Process all instance metadata cleaning it up for persisting as json. Strip ci-b64 prefix and catalog any 'base64_encoded_keys' as a list @return Dict copy of processed metadata. """ md_copy = copy.deepcopy(metadata) base64_encoded_keys = [] sens_keys = [] for key, val in metadata.items(): if key_path: sub_key_path = key_path + "/" + key else: sub_key_path = key if ( key.lower() in sensitive_keys or sub_key_path.lower() in sensitive_keys ): sens_keys.append(sub_key_path) if isinstance(val, str) and val.startswith("ci-b64:"): base64_encoded_keys.append(sub_key_path) md_copy[key] = val.replace("ci-b64:", "") if isinstance(val, dict): return_val = process_instance_metadata( val, sub_key_path, sensitive_keys ) base64_encoded_keys.extend(return_val.pop("base64_encoded_keys")) sens_keys.extend(return_val.pop("sensitive_keys")) md_copy[key] = return_val md_copy["base64_encoded_keys"] = sorted(base64_encoded_keys) md_copy["sensitive_keys"] = sorted(sens_keys) return md_copy def redact_sensitive_keys(metadata, redact_value=REDACT_SENSITIVE_VALUE): """Redact any sensitive keys from to provided metadata dictionary. Replace any keys values listed in 'sensitive_keys' with redact_value. """ # While 'sensitive_keys' should already sanitized to only include what # is in metadata, it is possible keys will overlap. For example, if # "merged_cfg" and "merged_cfg/ds/userdata" both match, it's possible that # "merged_cfg" will get replaced first, meaning "merged_cfg/ds/userdata" # no longer represents a valid key. # Thus, we still need to do membership checks in this function. if not metadata.get("sensitive_keys", []): return metadata md_copy = copy.deepcopy(metadata) for key_path in metadata.get("sensitive_keys"): path_parts = key_path.split("/") obj = md_copy for path in path_parts: if ( path in obj and isinstance(obj[path], dict) and path != path_parts[-1] ): obj = obj[path] if path in obj: obj[path] = redact_value return md_copy URLParams = namedtuple( "URLParams", [ "max_wait_seconds", "timeout_seconds", "num_retries", "sec_between_retries", ], ) DataSourceHostname = namedtuple( "DataSourceHostname", ["hostname", "is_default"], ) class DataSource(CloudInitPickleMixin, metaclass=abc.ABCMeta): dsmode = DSMODE_NETWORK default_locale = "en_US.UTF-8" # Datasource name needs to be set by subclasses to determine which # cloud-config datasource key is loaded dsname = "_undef" # Cached cloud_name as determined by _get_cloud_name _cloud_name = None # Cached cloud platform api type: e.g. ec2, openstack, kvm, lxd, azure etc. _platform_type = None # More details about the cloud platform: # - metadata (http://169.254.169.254/) # - seed-dir (<dirname>) _subplatform = None # Track the discovered fallback nic for use in configuration generation. _fallback_interface = None # The network configuration sources that should be considered for this data # source. (The first source in this list that provides network # configuration will be used without considering any that follow.) This # should always be a subset of the members of NetworkConfigSource with no # duplicate entries. network_config_sources: Tuple[NetworkConfigSource, ...] = ( NetworkConfigSource.CMD_LINE, NetworkConfigSource.INITRAMFS, NetworkConfigSource.SYSTEM_CFG, NetworkConfigSource.DS, ) # read_url_params url_max_wait = -1 # max_wait < 0 means do not wait url_timeout = 10 # timeout for each metadata url read attempt url_retries = 5 # number of times to retry url upon 404 url_sec_between_retries = 1 # amount of seconds to wait between retries # The datasource defines a set of supported EventTypes during which # the datasource can react to changes in metadata and regenerate # network configuration on metadata changes. These are defined in # `supported_network_events`. # The datasource also defines a set of default EventTypes that the # datasource can react to. These are the event types that will be used # if not overridden by the user. # A datasource requiring to write network config on each system boot # would call default_update_events['network'].add(EventType.BOOT). # Default: generate network config on new instance id (first boot). supported_update_events = { EventScope.NETWORK: { EventType.BOOT_NEW_INSTANCE, EventType.BOOT, EventType.BOOT_LEGACY, EventType.HOTPLUG, } } default_update_events = { EventScope.NETWORK: { EventType.BOOT_NEW_INSTANCE, } } # N-tuple listing default values for any metadata-related class # attributes cached on an instance by a process_data runs. These attribute # values are reset via clear_cached_attrs during any update_metadata call. cached_attr_defaults: Tuple[Tuple[str, Any], ...] = ( ("ec2_metadata", UNSET), ("network_json", UNSET), ("metadata", {}), ("userdata", None), ("userdata_raw", None), ("vendordata", None), ("vendordata_raw", None), ("vendordata2", None), ("vendordata2_raw", None), ) _dirty_cache = False # N-tuple of keypaths or keynames redact from instance-data.json for # non-root users sensitive_metadata_keys: Tuple[str, ...] = ( "merged_cfg", "security-credentials", "userdata", "user-data", "user_data", "vendordata", "vendor-data", # Provide ds/vendor_data to avoid redacting top-level # "vendor_data": {enabled: True} "ds/vendor_data", ) # True on datasources that may not see hotplugged devices reflected # in the updated metadata skip_hotplug_detect = False _ci_pkl_version = 1 def __init__(self, sys_cfg, distro: Distro, paths: Paths, ud_proc=None): self.sys_cfg = sys_cfg self.distro = distro self.paths = paths self.userdata = None self.metadata: dict = {} self.userdata_raw = None self.vendordata = None self.vendordata2 = None self.vendordata_raw = None self.vendordata2_raw = None self.ds_cfg = util.get_cfg_by_path( self.sys_cfg, ("datasource", self.dsname), {} ) if not self.ds_cfg: self.ds_cfg = {} if not ud_proc: self.ud_proc = ud.UserDataProcessor(self.paths) else: self.ud_proc = ud_proc def _unpickle(self, ci_pkl_version: int) -> None: """Perform deserialization fixes for Paths.""" if not hasattr(self, "vendordata2"): self.vendordata2 = None if not hasattr(self, "vendordata2_raw"): self.vendordata2_raw = None if not hasattr(self, "skip_hotplug_detect"): self.skip_hotplug_detect = False if hasattr(self, "userdata") and self.userdata is not None: # If userdata stores MIME data, on < python3.6 it will be # missing the 'policy' attribute that exists on >=python3.6. # Calling str() on the userdata will attempt to access this # policy attribute. This will raise an exception, causing # the pickle load to fail, so cloud-init will discard the cache try: str(self.userdata) except AttributeError as e: LOG.debug( "Unable to unpickle datasource: %s." " Ignoring current cache.", e, ) raise DatasourceUnpickleUserDataError() from e def __str__(self): return type_utils.obj_name(self) def ds_detect(self) -> bool: """Check if running on this datasource""" return True def override_ds_detect(self): """Override if either: - only a single datasource defined (nothing to fall back to) - TODO: commandline argument is used (ci.ds=OpenStack) """ return self.sys_cfg.get("datasource_list", []) in ( [self.dsname], [self.dsname, "None"], ) def _check_and_get_data(self): """Overrides runtime datasource detection""" if self.override_ds_detect(): LOG.debug( "Machine is configured to run on single datasource %s.", self ) elif self.ds_detect(): LOG.debug("Machine is running on %s.", self) else: LOG.debug("Datasource type %s is not detected.", self) return False return self._get_data() def _get_standardized_metadata(self, instance_data): """Return a dictionary of standardized metadata keys.""" local_hostname = self.get_hostname().hostname instance_id = self.get_instance_id() availability_zone = self.availability_zone # In the event of upgrade from existing cloudinit, pickled datasource # will not contain these new class attributes. So we need to recrawl # metadata to discover that content sysinfo = instance_data["sys_info"] return { "v1": { "_beta_keys": ["subplatform"], "availability-zone": availability_zone, "availability_zone": availability_zone, "cloud_id": canonical_cloud_id( self.cloud_name, self.region, self.platform_type ), "cloud-name": self.cloud_name, "cloud_name": self.cloud_name, "distro": sysinfo["dist"][0], "distro_version": sysinfo["dist"][1], "distro_release": sysinfo["dist"][2], "platform": self.platform_type, "public_ssh_keys": self.get_public_ssh_keys(), "python_version": sysinfo["python"], "instance-id": instance_id, "instance_id": instance_id, "kernel_release": sysinfo["uname"][2], "local-hostname": local_hostname, "local_hostname": local_hostname, "machine": sysinfo["uname"][4], "region": self.region, "subplatform": self.subplatform, "system_platform": sysinfo["platform"], "variant": sysinfo["variant"], } } def clear_cached_attrs(self, attr_defaults=()): """Reset any cached metadata attributes to datasource defaults. @param attr_defaults: Optional tuple of (attr, value) pairs to set instead of cached_attr_defaults. """ if not self._dirty_cache: return if attr_defaults: attr_values = attr_defaults else: attr_values = self.cached_attr_defaults for attribute, value in attr_values: if hasattr(self, attribute): setattr(self, attribute, value) if not attr_defaults: self._dirty_cache = False def get_data(self) -> bool: """Datasources implement _get_data to setup metadata and userdata_raw. Minimally, the datasource should return a boolean True on success. """ self._dirty_cache = True return_value = self._check_and_get_data() if not return_value: return return_value self.persist_instance_data() return return_value def persist_instance_data(self, write_cache=True): """Process and write INSTANCE_JSON_FILE with all instance metadata. Replace any hyphens with underscores in key names for use in template processing. :param write_cache: boolean set True to persist obj.pkl when instance_link exists. @return True on successful write, False otherwise. """ if write_cache and os.path.lexists(self.paths.instance_link): pkl_store(self, self.paths.get_ipath_cur("obj_pkl")) if hasattr(self, "_crawled_metadata"): # Any datasource with _crawled_metadata will best represent # most recent, 'raw' metadata crawled_metadata = copy.deepcopy( getattr(self, "_crawled_metadata") ) crawled_metadata.pop("user-data", None) crawled_metadata.pop("vendor-data", None) instance_data = {"ds": crawled_metadata} else: instance_data = {"ds": {"meta_data": self.metadata}} if hasattr(self, "network_json"): network_json = getattr(self, "network_json") if network_json != UNSET: instance_data["ds"]["network_json"] = network_json if hasattr(self, "ec2_metadata"): ec2_metadata = getattr(self, "ec2_metadata") if ec2_metadata != UNSET: instance_data["ds"]["ec2_metadata"] = ec2_metadata instance_data["ds"]["_doc"] = EXPERIMENTAL_TEXT # Add merged cloud.cfg and sys info for jinja templates and cli query instance_data["merged_cfg"] = copy.deepcopy(self.sys_cfg) instance_data["merged_cfg"]["_doc"] = ( "Merged cloud-init system config from /etc/cloud/cloud.cfg and" " /etc/cloud/cloud.cfg.d/" ) instance_data["sys_info"] = util.system_info() instance_data.update(self._get_standardized_metadata(instance_data)) try: # Process content base64encoding unserializable values content = util.json_dumps(instance_data) # Strip base64: prefix and set base64_encoded_keys list. processed_data = process_instance_metadata( json.loads(content), sensitive_keys=self.sensitive_metadata_keys, ) except TypeError as e: LOG.warning("Error persisting instance-data.json: %s", str(e)) return False except UnicodeDecodeError as e: LOG.warning("Error persisting instance-data.json: %s", str(e)) return False json_sensitive_file = self.paths.get_runpath("instance_data_sensitive") cloud_id = instance_data["v1"].get("cloud_id", "none") cloud_id_file = os.path.join(self.paths.run_dir, "cloud-id") util.write_file(f"{cloud_id_file}-{cloud_id}", f"{cloud_id}\n") # cloud-id not found, then no previous cloud-id fle prev_cloud_id_file = None new_cloud_id_file = f"{cloud_id_file}-{cloud_id}" # cloud-id found, then the prev cloud-id file is source of symlink if os.path.exists(cloud_id_file): prev_cloud_id_file = os.path.realpath(cloud_id_file) util.sym_link(new_cloud_id_file, cloud_id_file, force=True) if prev_cloud_id_file and prev_cloud_id_file != new_cloud_id_file: util.del_file(prev_cloud_id_file) write_json(json_sensitive_file, processed_data, mode=0o600) json_file = self.paths.get_runpath("instance_data") # World readable write_json(json_file, redact_sensitive_keys(processed_data)) return True def _get_data(self) -> bool: """Walk metadata sources, process crawled data and save attributes.""" raise NotImplementedError( "Subclasses of DataSource must implement _get_data which" " sets self.metadata, vendordata_raw and userdata_raw." ) def get_url_params(self): """Return the Datasource's preferred url_read parameters. Subclasses may override url_max_wait, url_timeout, url_retries. @return: A URLParams object with max_wait_seconds, timeout_seconds, num_retries. """ max_wait = self.url_max_wait try: max_wait = int(self.ds_cfg.get("max_wait", self.url_max_wait)) except ValueError: util.logexc( LOG, "Config max_wait '%s' is not an int, using default '%s'", self.ds_cfg.get("max_wait"), max_wait, ) timeout = self.url_timeout try: timeout = max(0, int(self.ds_cfg.get("timeout", self.url_timeout))) except ValueError: timeout = self.url_timeout util.logexc( LOG, "Config timeout '%s' is not an int, using default '%s'", self.ds_cfg.get("timeout"), timeout, ) retries = self.url_retries try: retries = int(self.ds_cfg.get("retries", self.url_retries)) except Exception: util.logexc( LOG, "Config retries '%s' is not an int, using default '%s'", self.ds_cfg.get("retries"), retries, ) sec_between_retries = self.url_sec_between_retries try: sec_between_retries = int( self.ds_cfg.get( "sec_between_retries", self.url_sec_between_retries ) ) except Exception: util.logexc( LOG, "Config sec_between_retries '%s' is not an int," " using default '%s'", self.ds_cfg.get("sec_between_retries"), sec_between_retries, ) return URLParams(max_wait, timeout, retries, sec_between_retries) def get_userdata(self, apply_filter=False): if self.userdata is None: self.userdata = self.ud_proc.process(self.get_userdata_raw()) if apply_filter: return self._filter_xdata(self.userdata) return self.userdata def get_vendordata(self): if self.vendordata is None: self.vendordata = self.ud_proc.process(self.get_vendordata_raw()) return self.vendordata def get_vendordata2(self): if self.vendordata2 is None: self.vendordata2 = self.ud_proc.process(self.get_vendordata2_raw()) return self.vendordata2 @property def fallback_interface(self): """Determine the network interface used during local network config.""" if self._fallback_interface is None: self._fallback_interface = net.find_fallback_nic() if self._fallback_interface is None: LOG.warning( "Did not find a fallback interface on %s.", self.cloud_name ) return self._fallback_interface @property def platform_type(self): if not hasattr(self, "_platform_type"): # Handle upgrade path where pickled datasource has no _platform. self._platform_type = self.dsname.lower() if not self._platform_type: self._platform_type = self.dsname.lower() return self._platform_type @property def subplatform(self): """Return a string representing subplatform details for the datasource. This should be guidance for where the metadata is sourced. Examples of this on different clouds: ec2: metadata (http://169.254.169.254) openstack: configdrive (/dev/path) openstack: metadata (http://169.254.169.254) nocloud: seed-dir (/seed/dir/path) lxd: nocloud (/seed/dir/path) """ if not hasattr(self, "_subplatform"): # Handle upgrade path where pickled datasource has no _platform. self._subplatform = self._get_subplatform() if not self._subplatform: self._subplatform = self._get_subplatform() return self._subplatform def _get_subplatform(self): """Subclasses should implement to return a "slug (detail)" string.""" if hasattr(self, "metadata_address"): return "metadata (%s)" % getattr(self, "metadata_address") return METADATA_UNKNOWN @property def cloud_name(self): """Return lowercase cloud name as determined by the datasource. Datasource can determine or define its own cloud product name in metadata. """ if self._cloud_name: return self._cloud_name if self.metadata and self.metadata.get(METADATA_CLOUD_NAME_KEY): cloud_name = self.metadata.get(METADATA_CLOUD_NAME_KEY) if isinstance(cloud_name, str): self._cloud_name = cloud_name.lower() else: self._cloud_name = self._get_cloud_name().lower() LOG.debug( "Ignoring metadata provided key %s: non-string type %s", METADATA_CLOUD_NAME_KEY, type(cloud_name), ) else: self._cloud_name = self._get_cloud_name().lower() return self._cloud_name def _get_cloud_name(self): """Return the datasource name as it frequently matches cloud name. Should be overridden in subclasses which can run on multiple cloud names, such as DatasourceEc2. """ return self.dsname @property def launch_index(self): if not self.metadata: return None if "launch-index" in self.metadata: return self.metadata["launch-index"] return None def _filter_xdata(self, processed_ud): filters = [ launch_index.Filter(util.safe_int(self.launch_index)), ] new_ud = processed_ud for f in filters: new_ud = f.apply(new_ud) return new_ud @property def is_disconnected(self): return False def get_userdata_raw(self): return self.userdata_raw def get_vendordata_raw(self): return self.vendordata_raw def get_vendordata2_raw(self): return self.vendordata2_raw # the data sources' config_obj is a cloud-config formated # object that came to it from ways other than cloud-config # because cloud-config content would be handled elsewhere def get_config_obj(self): return {} def get_public_ssh_keys(self): return normalize_pubkey_data(self.metadata.get("public-keys")) def publish_host_keys(self, hostkeys): """Publish the public SSH host keys (found in /etc/ssh/*.pub). @param hostkeys: List of host key tuples (key_type, key_value), where key_type is the first field in the public key file (e.g. 'ssh-rsa') and key_value is the key itself (e.g. 'AAAAB3NzaC1y...'). """ def _remap_device(self, short_name): # LP: #611137 # the metadata service may believe that devices are named 'sda' # when the kernel named them 'vda' or 'xvda' # we want to return the correct value for what will actually # exist in this instance mappings = {"sd": ("vd", "xvd", "vtb")} for (nfrom, tlist) in mappings.items(): if not short_name.startswith(nfrom): continue for nto in tlist: cand = "/dev/%s%s" % (nto, short_name[len(nfrom) :]) if os.path.exists(cand): return cand return None def device_name_to_device(self, _name): # translate a 'name' to a device # the primary function at this point is on ec2 # to consult metadata service, that has # ephemeral0: sdb # and return 'sdb' for input 'ephemeral0' return None def get_locale(self): """Default locale is en_US.UTF-8, but allow distros to override""" locale = self.default_locale try: locale = self.distro.get_locale() except NotImplementedError: pass return locale @property def availability_zone(self): top_level_az = self.metadata.get( "availability-zone", self.metadata.get("availability_zone") ) if top_level_az: return top_level_az return self.metadata.get("placement", {}).get("availability-zone") @property def region(self): return self.metadata.get("region") def get_instance_id(self): if not self.metadata or "instance-id" not in self.metadata: # Return a magic not really instance id string return "iid-datasource" return str(self.metadata["instance-id"]) def get_hostname(self, fqdn=False, resolve_ip=False, metadata_only=False): """Get hostname or fqdn from the datasource. Look it up if desired. @param fqdn: Boolean, set True to return hostname with domain. @param resolve_ip: Boolean, set True to attempt to resolve an ipv4 address provided in local-hostname meta-data. @param metadata_only: Boolean, set True to avoid looking up hostname if meta-data doesn't have local-hostname present. @return: a DataSourceHostname namedtuple <hostname or qualified hostname>, <is_default> (str, bool). is_default is a bool and it's true only if hostname is localhost and was returned by util.get_hostname() as a default. This is used to differentiate with a user-defined localhost hostname. Optionally return (None, False) when metadata_only is True and local-hostname data is not available. """ defdomain = "localdomain" defhost = "localhost" domain = defdomain is_default = False if not self.metadata or not self.metadata.get("local-hostname"): if metadata_only: return DataSourceHostname(None, is_default) # this is somewhat questionable really. # the cloud datasource was asked for a hostname # and didn't have one. raising error might be more appropriate # but instead, basically look up the existing hostname toks = [] hostname = util.get_hostname() if hostname == "localhost": # default hostname provided by socket.gethostname() is_default = True hosts_fqdn = util.get_fqdn_from_hosts(hostname) if hosts_fqdn and hosts_fqdn.find(".") > 0: toks = str(hosts_fqdn).split(".") elif hostname and hostname.find(".") > 0: toks = str(hostname).split(".") elif hostname: toks = [hostname, defdomain] else: toks = [defhost, defdomain] else: # if there is an ipv4 address in 'local-hostname', then # make up a hostname (LP: #475354) in format ip-xx.xx.xx.xx lhost = self.metadata["local-hostname"] if net.is_ipv4_address(lhost): toks = [] if resolve_ip: toks = util.gethostbyaddr(lhost) if toks: toks = str(toks).split(".") else: toks = ["ip-%s" % lhost.replace(".", "-")] else: toks = lhost.split(".") if len(toks) > 1: hostname = toks[0] domain = ".".join(toks[1:]) else: hostname = toks[0] if fqdn and domain != defdomain: hostname = "%s.%s" % (hostname, domain) return DataSourceHostname(hostname, is_default) def get_package_mirror_info(self): return self.distro.get_package_mirror_info(data_source=self) def get_supported_events(self, source_event_types: List[EventType]): supported_events: Dict[EventScope, set] = {} for event in source_event_types: for ( update_scope, update_events, ) in self.supported_update_events.items(): if event in update_events: if not supported_events.get(update_scope): supported_events[update_scope] = set() supported_events[update_scope].add(event) return supported_events def update_metadata_if_supported( self, source_event_types: List[EventType] ) -> bool: """Refresh cached metadata if the datasource supports this event. The datasource has a list of supported_update_events which trigger refreshing all cached metadata as well as refreshing the network configuration. @param source_event_types: List of EventTypes which may trigger a metadata update. @return True if the datasource did successfully update cached metadata due to source_event_type. """ supported_events = self.get_supported_events(source_event_types) for scope, matched_events in supported_events.items(): LOG.debug( "Update datasource metadata and %s config due to events: %s", scope.value, ", ".join([event.value for event in matched_events]), ) # Each datasource has a cached config property which needs clearing # Once cleared that config property will be regenerated from # current metadata. self.clear_cached_attrs((("_%s_config" % scope, UNSET),)) if supported_events: self.clear_cached_attrs() result = self.get_data() if result: return True LOG.debug( "Datasource %s not updated for events: %s", self, ", ".join([event.value for event in source_event_types]), ) return False def check_instance_id(self, sys_cfg): # quickly (local check only) if self.instance_id is still return False @staticmethod def _determine_dsmode(candidates, default=None, valid=None): # return the first candidate that is non None, warn if not valid if default is None: default = DSMODE_NETWORK if valid is None: valid = VALID_DSMODES for candidate in candidates: if candidate is None: continue if candidate in valid: return candidate else: LOG.warning( "invalid dsmode '%s', using default=%s", candidate, default ) return default return default @property def network_config(self): return None @property def first_instance_boot(self): return def setup(self, is_new_instance): """setup(is_new_instance) This is called before user-data and vendor-data have been processed. Unless the datasource has set mode to 'local', then networking per 'fallback' or per 'network_config' will have been written and brought up the OS at this point. """ return def activate(self, cfg, is_new_instance): """activate(cfg, is_new_instance) This is called before the init_modules will be called but after the user-data and vendor-data have been fully processed. The cfg is fully up to date config, it contains a merged view of system config, datasource config, user config, vendor config. It should be used rather than the sys_cfg passed to __init__. is_new_instance is a boolean indicating if this is a new instance. """ return def normalize_pubkey_data(pubkey_data): keys = [] if not pubkey_data: return keys if isinstance(pubkey_data, str): return pubkey_data.splitlines() if isinstance(pubkey_data, (list, set)): return list(pubkey_data) if isinstance(pubkey_data, (dict)): for (_keyname, klist) in pubkey_data.items(): # lp:506332 uec metadata service responds with # data that makes boto populate a string for 'klist' rather # than a list. if isinstance(klist, str): klist = [klist] if isinstance(klist, (list, set)): for pkey in klist: # There is an empty string at # the end of the keylist, trim it if pkey: keys.append(pkey) return keys def find_source( sys_cfg, distro, paths, ds_deps, cfg_list, pkg_list, reporter ) -> Tuple[DataSource, str]: ds_list = list_sources(cfg_list, ds_deps, pkg_list) ds_names = [type_utils.obj_name(f) for f in ds_list] mode = "network" if DEP_NETWORK in ds_deps else "local" LOG.debug("Searching for %s data source in: %s", mode, ds_names) for name, cls in zip(ds_names, ds_list): myrep = events.ReportEventStack( name="search-%s" % name.replace("DataSource", ""), description="searching for %s data from %s" % (mode, name), message="no %s data found from %s" % (mode, name), parent=reporter, ) try: with myrep: LOG.debug("Seeing if we can get any data from %s", cls) s = cls(sys_cfg, distro, paths) if s.update_metadata_if_supported( [EventType.BOOT_NEW_INSTANCE] ): myrep.message = "found %s data from %s" % (mode, name) return (s, type_utils.obj_name(cls)) except Exception: util.logexc(LOG, "Getting data from %s failed", cls) msg = "Did not find any data source, searched classes: (%s)" % ", ".join( ds_names ) raise DataSourceNotFoundException(msg) # Return a list of classes that have the same depends as 'depends' # iterate through cfg_list, loading "DataSource*" modules # and calling their "get_datasource_list". # Return an ordered list of classes that match (if any) def list_sources(cfg_list, depends, pkg_list): src_list = [] LOG.debug( "Looking for data source in: %s," " via packages %s that matches dependencies %s", cfg_list, pkg_list, depends, ) for ds_name in cfg_list: if not ds_name.startswith(DS_PREFIX): ds_name = "%s%s" % (DS_PREFIX, ds_name) m_locs, _looked_locs = importer.find_module( ds_name, pkg_list, ["get_datasource_list"] ) if not m_locs: LOG.error( "Could not import %s. Does the DataSource exist and " "is it importable?", ds_name, ) for m_loc in m_locs: mod = importer.import_module(m_loc) lister = getattr(mod, "get_datasource_list") matches = lister(depends) if matches: src_list.extend(matches) break return src_list def instance_id_matches_system_uuid( instance_id, field: str = "system-uuid" ) -> bool: # quickly (local check only) if self.instance_id is still valid # we check kernel command line or files. if not instance_id: return False dmi_value = dmi.read_dmi_data(field) if not dmi_value: return False return instance_id.lower() == dmi_value.lower() def canonical_cloud_id(cloud_name, region, platform): """Lookup the canonical cloud-id for a given cloud_name and region.""" if not cloud_name: cloud_name = METADATA_UNKNOWN if not region: region = METADATA_UNKNOWN if region == METADATA_UNKNOWN: if cloud_name != METADATA_UNKNOWN: return cloud_name return platform for prefix, cloud_id_test in CLOUD_ID_REGION_PREFIX_MAP.items(): (cloud_id, valid_cloud) = cloud_id_test if region.startswith(prefix) and valid_cloud(cloud_name): return cloud_id if cloud_name != METADATA_UNKNOWN: return cloud_name return platform def convert_vendordata(data, recurse=True): """data: a loaded object (strings, arrays, dicts). return something suitable for cloudinit vendordata_raw. if data is: None: return None string: return string list: return data the list is then processed in UserDataProcessor dict: return convert_vendordata(data.get('cloud-init')) """ if not data: return None if isinstance(data, str): return data if isinstance(data, list): return copy.deepcopy(data) if isinstance(data, dict): if recurse is True: return convert_vendordata(data.get("cloud-init"), recurse=False) raise ValueError("vendordata['cloud-init'] cannot be dict") raise ValueError("Unknown data type for vendordata: %s" % type(data)) class BrokenMetadata(IOError): pass # 'depends' is a list of dependencies (DEP_FILESYSTEM) # ds_list is a list of 2 item lists # ds_list = [ # ( class, ( depends-that-this-class-needs ) ) # } # It returns a list of 'class' that matched these deps exactly # It mainly is a helper function for DataSourceCollections def list_from_depends(depends, ds_list): ret_list = [] depset = set(depends) for (cls, deps) in ds_list: if depset == set(deps): ret_list.append(cls) return ret_list def pkl_store(obj: DataSource, fname: str) -> bool: """Use pickle to serialize Datasource to a file as a cache. :return: True on success """ try: pk_contents = pickle.dumps(obj) except Exception: util.logexc(LOG, "Failed pickling datasource %s", obj) return False try: util.write_file(fname, pk_contents, omode="wb", mode=0o400) except Exception: util.logexc(LOG, "Failed pickling datasource to %s", fname) return False return True def pkl_load(fname: str) -> Optional[DataSource]: """Use pickle to deserialize a instance Datasource from a cache file.""" pickle_contents = None try: pickle_contents = util.load_file(fname, decode=False) except Exception as e: if os.path.isfile(fname): LOG.warning("failed loading pickle in %s: %s", fname, e) # This is allowed so just return nothing successfully loaded... if not pickle_contents: return None try: return pickle.loads(pickle_contents) except DatasourceUnpickleUserDataError: return None except Exception: util.logexc(LOG, "Failed loading pickled blob from %s", fname) return None # vi: ts=4 expandtab DataSourceVMware.py 0000644 00000101315 15027667240 0010304 0 ustar 00 # Cloud-Init DataSource for VMware # # Copyright (c) 2018-2022 VMware, Inc. All Rights Reserved. # # Authors: Anish Swaminathan <anishs@vmware.com> # Andrew Kutz <akutz@vmware.com> # Pengpeng Sun <pengpengs@vmware.com> # # This file is part of cloud-init. See LICENSE file for license information. """Cloud-Init DataSource for VMware This module provides a cloud-init datasource for VMware systems and supports multiple transports types, including: * EnvVars * GuestInfo * IMC (Guest Customization) Netifaces (https://github.com/al45tair/netifaces) Please note this module relies on the netifaces project to introspect the runtime, network configuration of the host on which this datasource is running. This is in contrast to the rest of cloud-init which uses the cloudinit/netinfo module. The reasons for using netifaces include: * Netifaces is built in C and is more portable across multiple systems and more deterministic than shell exec'ing local network commands and parsing their output. * Netifaces provides a stable way to determine the view of the host's network after DHCP has brought the network online. Unlike most other datasources, this datasource still provides support for JINJA queries based on networking information even when the network is based on a DHCP lease. While this does not tie this datasource directly to netifaces, it does mean the ability to consistently obtain the correct information is paramount. * It is currently possible to execute this datasource on macOS (which many developers use today) to print the output of the get_host_info function. This function calls netifaces to obtain the same runtime network configuration that the datasource would persist to the local system's instance data. However, the netinfo module fails on macOS. The result is either a hung operation that requires a SIGINT to return control to the user, or, if brew is used to install iproute2mac, the ip commands are used but produce output the netinfo module is unable to parse. While macOS is not a target of cloud-init, this feature is quite useful when working on this datasource. For more information about this behavior, please see the following PR comment, https://bit.ly/3fG7OVh. The authors of this datasource are not opposed to moving away from netifaces. The goal may be to eventually do just that. This proviso was added to the top of this module as a way to remind future-us and others why netifaces was used in the first place in order to either smooth the transition away from netifaces or embrace it further up the cloud-init stack. """ import collections import copy import ipaddress import json import os import socket import time import netifaces from cloudinit import dmi from cloudinit import log as logging from cloudinit import net, sources, util from cloudinit.sources.helpers.vmware.imc import guestcust_util from cloudinit.subp import ProcessExecutionError, subp, which PRODUCT_UUID_FILE_PATH = "/sys/class/dmi/id/product_uuid" LOG = logging.getLogger(__name__) NOVAL = "No value found" # Data transports names DATA_ACCESS_METHOD_ENVVAR = "envvar" DATA_ACCESS_METHOD_GUESTINFO = "guestinfo" DATA_ACCESS_METHOD_IMC = "imc" VMWARE_RPCTOOL = which("vmware-rpctool") REDACT = "redact" CLEANUP_GUESTINFO = "cleanup-guestinfo" VMX_GUESTINFO = "VMX_GUESTINFO" GUESTINFO_EMPTY_YAML_VAL = "---" LOCAL_IPV4 = "local-ipv4" LOCAL_IPV6 = "local-ipv6" WAIT_ON_NETWORK = "wait-on-network" WAIT_ON_NETWORK_IPV4 = "ipv4" WAIT_ON_NETWORK_IPV6 = "ipv6" class DataSourceVMware(sources.DataSource): """ Setting the hostname: The hostname is set by way of the metadata key "local-hostname". Setting the instance ID: The instance ID may be set by way of the metadata key "instance-id". However, if this value is absent then the instance ID is read from the file /sys/class/dmi/id/product_uuid. Configuring the network: The network is configured by setting the metadata key "network" with a value consistent with Network Config Versions 1 or 2, depending on the Linux distro's version of cloud-init: Network Config Version 1 - http://bit.ly/cloudinit-net-conf-v1 Network Config Version 2 - http://bit.ly/cloudinit-net-conf-v2 For example, CentOS 7's official cloud-init package is version 0.7.9 and does not support Network Config Version 2. imc transport: Either Network Config Version 1 or Network Config Version 2 is supported which depends on the customization type. For LinuxPrep customization, Network config Version 1 data is parsed from the customization specification. For CloudinitPrep customization, Network config Version 2 data is parsed from the customization specification. envvar and guestinfo tranports: Network Config Version 2 data is supported as long as the Linux distro's cloud-init package is new enough to parse the data. The metadata key "network.encoding" may be used to indicate the format of the metadata key "network". Valid encodings are base64 and gzip+base64. """ dsname = "VMware" def __init__(self, sys_cfg, distro, paths, ud_proc=None): sources.DataSource.__init__(self, sys_cfg, distro, paths, ud_proc) self.cfg = {} self.data_access_method = None self.vmware_rpctool = VMWARE_RPCTOOL # A list includes all possible data transports, each tuple represents # one data transport type. This datasource will try to get data from # each of transports follows the tuples order in this list. # A tuple has 3 elements which are: # 1. The transport name # 2. The function name to get data for the transport # 3. A boolean tells whether the transport requires VMware platform self.possible_data_access_method_list = [ (DATA_ACCESS_METHOD_ENVVAR, self.get_envvar_data_fn, False), (DATA_ACCESS_METHOD_GUESTINFO, self.get_guestinfo_data_fn, True), (DATA_ACCESS_METHOD_IMC, self.get_imc_data_fn, True), ] def __str__(self): root = sources.DataSource.__str__(self) return "%s [seed=%s]" % (root, self.data_access_method) def _get_data(self): """ _get_data loads the metadata, userdata, and vendordata from one of the following locations in the given order: * envvars * guestinfo * imc Please note when updating this function with support for new data transports, the order should match the order in the dscheck_VMware function from the file ds-identify. """ # Initialize the locally scoped metadata, userdata, and vendordata # variables. They are assigned below depending on the detected data # access method. md, ud, vd = None, None, None # Crawl data from all possible data transports for ( data_access_method, get_data_fn, require_vmware_platform, ) in self.possible_data_access_method_list: if require_vmware_platform and not is_vmware_platform(): continue (md, ud, vd) = get_data_fn() if md or ud or vd: self.data_access_method = data_access_method break if not self.data_access_method: LOG.error("failed to find a valid data access method") return False LOG.info("using data access method %s", self._get_subplatform()) # Get the metadata. self.metadata = process_metadata(load_json_or_yaml(md)) # Get the user data. self.userdata_raw = ud # Get the vendor data. self.vendordata_raw = vd # Redact any sensitive information. self.redact_keys() # get_data returns true if there is any available metadata, # userdata, or vendordata. if self.metadata or self.userdata_raw or self.vendordata_raw: return True else: return False def setup(self, is_new_instance): """setup(is_new_instance) This is called before user-data and vendor-data have been processed. Unless the datasource has set mode to 'local', then networking per 'fallback' or per 'network_config' will have been written and brought up the OS at this point. """ host_info = wait_on_network(self.metadata) LOG.info("got host-info: %s", host_info) # Reflect any possible local IPv4 or IPv6 addresses in the guest # info. advertise_local_ip_addrs(host_info) # Ensure the metadata gets updated with information about the # host, including the network interfaces, default IP addresses, # etc. self.metadata = util.mergemanydict([self.metadata, host_info]) # Persist the instance data for versions of cloud-init that support # doing so. This occurs here rather than in the get_data call in # order to ensure that the network interfaces are up and can be # persisted with the metadata. self.persist_instance_data() def _get_subplatform(self): get_key_name_fn = None if self.data_access_method == DATA_ACCESS_METHOD_ENVVAR: get_key_name_fn = get_guestinfo_envvar_key_name elif self.data_access_method == DATA_ACCESS_METHOD_GUESTINFO: get_key_name_fn = get_guestinfo_key_name elif self.data_access_method == DATA_ACCESS_METHOD_IMC: get_key_name_fn = get_imc_key_name else: return sources.METADATA_UNKNOWN return "%s (%s)" % ( self.data_access_method, get_key_name_fn("metadata"), ) # The data sources' config_obj is a cloud-config formatted # object that came to it from ways other than cloud-config # because cloud-config content would be handled elsewhere def get_config_obj(self): return self.cfg @property def network_config(self): if "network" in self.metadata: LOG.debug("using metadata network config") else: LOG.debug("using fallback network config") self.metadata["network"] = { "config": self.distro.generate_fallback_config(), } return self.metadata["network"]["config"] def get_instance_id(self): # Pull the instance ID out of the metadata if present. Otherwise # read the file /sys/class/dmi/id/product_uuid for the instance ID. if self.metadata and "instance-id" in self.metadata: return self.metadata["instance-id"] with open(PRODUCT_UUID_FILE_PATH, "r") as id_file: self.metadata["instance-id"] = str(id_file.read()).rstrip().lower() return self.metadata["instance-id"] def get_public_ssh_keys(self): for key_name in ( "public-keys-data", "public_keys_data", "public-keys", "public_keys", ): if key_name in self.metadata: return sources.normalize_pubkey_data(self.metadata[key_name]) return [] def redact_keys(self): # Determine if there are any keys to redact. keys_to_redact = None if REDACT in self.metadata: keys_to_redact = self.metadata[REDACT] elif CLEANUP_GUESTINFO in self.metadata: # This is for backwards compatibility. keys_to_redact = self.metadata[CLEANUP_GUESTINFO] if self.data_access_method == DATA_ACCESS_METHOD_GUESTINFO: guestinfo_redact_keys(keys_to_redact, self.vmware_rpctool) def get_envvar_data_fn(self): """ check to see if there is data via env vars """ md, ud, vd = None, None, None if os.environ.get(VMX_GUESTINFO, ""): md = guestinfo_envvar("metadata") ud = guestinfo_envvar("userdata") vd = guestinfo_envvar("vendordata") return (md, ud, vd) def get_guestinfo_data_fn(self): """ check to see if there is data via the guestinfo transport """ md, ud, vd = None, None, None if self.vmware_rpctool: md = guestinfo("metadata", self.vmware_rpctool) ud = guestinfo("userdata", self.vmware_rpctool) vd = guestinfo("vendordata", self.vmware_rpctool) return (md, ud, vd) def get_imc_data_fn(self): """ check to see if there is data via vmware guest customization """ md, ud, vd = None, None, None # Check if vmware guest customization is enabled. allow_vmware_cust = guestcust_util.is_vmware_cust_enabled(self.sys_cfg) allow_raw_data_cust = guestcust_util.is_raw_data_cust_enabled( self.ds_cfg ) if not allow_vmware_cust and not allow_raw_data_cust: LOG.debug("Customization for VMware platform is disabled") return (md, ud, vd) # Check if "VMware Tools" plugin is available. if not guestcust_util.is_cust_plugin_available(): return (md, ud, vd) # Wait for vmware guest customization configuration file. cust_cfg_file = guestcust_util.get_cust_cfg_file(self.ds_cfg) if cust_cfg_file is None: return (md, ud, vd) # Check what type of guest customization is this. cust_cfg_dir = os.path.dirname(cust_cfg_file) cust_cfg = guestcust_util.parse_cust_cfg(cust_cfg_file) ( is_vmware_cust_cfg, is_raw_data_cust_cfg, ) = guestcust_util.get_cust_cfg_type(cust_cfg) # Get data only if guest customization type and flag matches. if is_vmware_cust_cfg and allow_vmware_cust: LOG.debug("Getting data via VMware customization configuration") (md, ud, vd, self.cfg) = guestcust_util.get_data_from_imc_cust_cfg( self.paths.cloud_dir, self.paths.get_cpath("scripts"), cust_cfg, cust_cfg_dir, self.distro, ) elif is_raw_data_cust_cfg and allow_raw_data_cust: LOG.debug( "Getting data via VMware raw cloudinit data " "customization configuration" ) (md, ud, vd) = guestcust_util.get_data_from_imc_raw_data_cust_cfg( cust_cfg ) else: LOG.debug("No allowed customization configuration data found") # Clean customization configuration file and directory util.del_dir(cust_cfg_dir) return (md, ud, vd) def is_vmware_platform(): system_type = dmi.read_dmi_data("system-product-name") if system_type is None: LOG.debug("No system-product-name found") return False elif "vmware" not in system_type.lower(): LOG.debug("Not a VMware platform") return False return True def decode(key, enc_type, data): """ decode returns the decoded string value of data key is a string used to identify the data being decoded in log messages """ LOG.debug("Getting encoded data for key=%s, enc=%s", key, enc_type) raw_data = None if enc_type in ["gzip+base64", "gz+b64"]: LOG.debug("Decoding %s format %s", enc_type, key) raw_data = util.decomp_gzip(util.b64d(data)) elif enc_type in ["base64", "b64"]: LOG.debug("Decoding %s format %s", enc_type, key) raw_data = util.b64d(data) else: LOG.debug("Plain-text data %s", key) raw_data = data return util.decode_binary(raw_data) def get_none_if_empty_val(val): """ get_none_if_empty_val returns None if the provided value, once stripped of its trailing whitespace, is empty or equal to GUESTINFO_EMPTY_YAML_VAL. The return value is always a string, regardless of whether the input is a bytes class or a string. """ # If the provided value is a bytes class, convert it to a string to # simplify the rest of this function's logic. val = util.decode_binary(val) val = val.rstrip() if len(val) == 0 or val == GUESTINFO_EMPTY_YAML_VAL: return None return val def advertise_local_ip_addrs(host_info): """ advertise_local_ip_addrs gets the local IP address information from the provided host_info map and sets the addresses in the guestinfo namespace """ if not host_info: return # Reflect any possible local IPv4 or IPv6 addresses in the guest # info. local_ipv4 = host_info.get(LOCAL_IPV4) if local_ipv4: guestinfo_set_value(LOCAL_IPV4, local_ipv4) LOG.info("advertised local ipv4 address %s in guestinfo", local_ipv4) local_ipv6 = host_info.get(LOCAL_IPV6) if local_ipv6: guestinfo_set_value(LOCAL_IPV6, local_ipv6) LOG.info("advertised local ipv6 address %s in guestinfo", local_ipv6) def handle_returned_guestinfo_val(key, val): """ handle_returned_guestinfo_val returns the provided value if it is not empty or set to GUESTINFO_EMPTY_YAML_VAL, otherwise None is returned """ val = get_none_if_empty_val(val) if val: return val LOG.debug("No value found for key %s", key) return None def get_imc_key_name(key): return "vmware-tools" def get_guestinfo_key_name(key): return "guestinfo." + key def get_guestinfo_envvar_key_name(key): return ("vmx." + get_guestinfo_key_name(key)).upper().replace(".", "_", -1) def guestinfo_envvar(key): val = guestinfo_envvar_get_value(key) if not val: return None enc_type = guestinfo_envvar_get_value(key + ".encoding") return decode(get_guestinfo_envvar_key_name(key), enc_type, val) def guestinfo_envvar_get_value(key): env_key = get_guestinfo_envvar_key_name(key) return handle_returned_guestinfo_val(key, os.environ.get(env_key, "")) def guestinfo(key, vmware_rpctool=VMWARE_RPCTOOL): """ guestinfo returns the guestinfo value for the provided key, decoding the value when required """ val = guestinfo_get_value(key, vmware_rpctool) if not val: return None enc_type = guestinfo_get_value(key + ".encoding", vmware_rpctool) return decode(get_guestinfo_key_name(key), enc_type, val) def guestinfo_get_value(key, vmware_rpctool=VMWARE_RPCTOOL): """ Returns a guestinfo value for the specified key. """ LOG.debug("Getting guestinfo value for key %s", key) try: (stdout, stderr) = subp( [ vmware_rpctool, "info-get " + get_guestinfo_key_name(key), ] ) if stderr == NOVAL: LOG.debug("No value found for key %s", key) elif not stdout: LOG.error("Failed to get guestinfo value for key %s", key) return handle_returned_guestinfo_val(key, stdout) except ProcessExecutionError as error: if error.stderr == NOVAL: LOG.debug("No value found for key %s", key) else: util.logexc( LOG, "Failed to get guestinfo value for key %s: %s", key, error, ) except Exception: util.logexc( LOG, "Unexpected error while trying to get " + "guestinfo value for key %s", key, ) return None def guestinfo_set_value(key, value, vmware_rpctool=VMWARE_RPCTOOL): """ Sets a guestinfo value for the specified key. Set value to an empty string to clear an existing guestinfo key. """ # If value is an empty string then set it to a single space as it is not # possible to set a guestinfo key to an empty string. Setting a guestinfo # key to a single space is as close as it gets to clearing an existing # guestinfo key. if value == "": value = " " LOG.debug("Setting guestinfo key=%s to value=%s", key, value) try: subp( [ vmware_rpctool, "info-set %s %s" % (get_guestinfo_key_name(key), value), ] ) return True except ProcessExecutionError as error: util.logexc( LOG, "Failed to set guestinfo key=%s to value=%s: %s", key, value, error, ) except Exception: util.logexc( LOG, "Unexpected error while trying to set " + "guestinfo key=%s to value=%s", key, value, ) return None def guestinfo_redact_keys(keys, vmware_rpctool=VMWARE_RPCTOOL): """ guestinfo_redact_keys redacts guestinfo of all of the keys in the given list. each key will have its value set to "---". Since the value is valid YAML, cloud-init can still read it if it tries. """ if not keys: return if not type(keys) in (list, tuple): keys = [keys] for key in keys: key_name = get_guestinfo_key_name(key) LOG.info("clearing %s", key_name) if not guestinfo_set_value( key, GUESTINFO_EMPTY_YAML_VAL, vmware_rpctool ): LOG.error("failed to clear %s", key_name) LOG.info("clearing %s.encoding", key_name) if not guestinfo_set_value(key + ".encoding", "", vmware_rpctool): LOG.error("failed to clear %s.encoding", key_name) def load_json_or_yaml(data): """ load first attempts to unmarshal the provided data as JSON, and if that fails then attempts to unmarshal the data as YAML. If data is None then a new dictionary is returned. """ if not data: return {} # If data is already a dictionary, here will return it directly. if isinstance(data, dict): return data try: return util.load_json(data) except (json.JSONDecodeError, TypeError): return util.load_yaml(data) def process_metadata(data): """ process_metadata processes metadata and loads the optional network configuration. """ if not data: return {} network = None if "network" in data: network = data["network"] del data["network"] network_enc = None if "network.encoding" in data: network_enc = data["network.encoding"] del data["network.encoding"] if network: if isinstance(network, collections.abc.Mapping): LOG.debug("network data copied to 'config' key") network = {"config": copy.deepcopy(network)} else: LOG.debug("network data to be decoded %s", network) dec_net = decode("metadata.network", network_enc, network) network = { "config": load_json_or_yaml(dec_net), } LOG.debug("network data %s", network) data["network"] = network return data # Used to match classes to dependencies datasources = [ (DataSourceVMware, (sources.DEP_FILESYSTEM,)), # Run at init-local (DataSourceVMware, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)), ] def get_datasource_list(depends): """ Return a list of data sources that match this set of dependencies """ return sources.list_from_depends(depends, datasources) def get_default_ip_addrs(): """ Returns the default IPv4 and IPv6 addresses based on the device(s) used for the default route. Please note that None may be returned for either address family if that family has no default route or if there are multiple addresses associated with the device used by the default route for a given address. """ # TODO(promote and use netifaces in cloudinit.net* modules) gateways = netifaces.gateways() if "default" not in gateways: return None, None default_gw = gateways["default"] if ( netifaces.AF_INET not in default_gw and netifaces.AF_INET6 not in default_gw ): return None, None ipv4 = None ipv6 = None gw4 = default_gw.get(netifaces.AF_INET) if gw4: _, dev4 = gw4 addr4_fams = netifaces.ifaddresses(dev4) if addr4_fams: af_inet4 = addr4_fams.get(netifaces.AF_INET) if af_inet4: if len(af_inet4) > 1: LOG.warning( "device %s has more than one ipv4 address: %s", dev4, af_inet4, ) elif "addr" in af_inet4[0]: ipv4 = af_inet4[0]["addr"] # Try to get the default IPv6 address by first seeing if there is a default # IPv6 route. gw6 = default_gw.get(netifaces.AF_INET6) if gw6: _, dev6 = gw6 addr6_fams = netifaces.ifaddresses(dev6) if addr6_fams: af_inet6 = addr6_fams.get(netifaces.AF_INET6) if af_inet6: if len(af_inet6) > 1: LOG.warning( "device %s has more than one ipv6 address: %s", dev6, af_inet6, ) elif "addr" in af_inet6[0]: ipv6 = af_inet6[0]["addr"] # If there is a default IPv4 address but not IPv6, then see if there is a # single IPv6 address associated with the same device associated with the # default IPv4 address. if ipv4 and not ipv6: af_inet6 = addr4_fams.get(netifaces.AF_INET6) if af_inet6: if len(af_inet6) > 1: LOG.warning( "device %s has more than one ipv6 address: %s", dev4, af_inet6, ) elif "addr" in af_inet6[0]: ipv6 = af_inet6[0]["addr"] # If there is a default IPv6 address but not IPv4, then see if there is a # single IPv4 address associated with the same device associated with the # default IPv6 address. if not ipv4 and ipv6: af_inet4 = addr6_fams.get(netifaces.AF_INET) if af_inet4: if len(af_inet4) > 1: LOG.warning( "device %s has more than one ipv4 address: %s", dev6, af_inet4, ) elif "addr" in af_inet4[0]: ipv4 = af_inet4[0]["addr"] return ipv4, ipv6 # patched socket.getfqdn() - see https://bugs.python.org/issue5004 def getfqdn(name=""): """Get fully qualified domain name from name. An empty argument is interpreted as meaning the local host. """ # TODO(may want to promote this function to util.getfqdn) # TODO(may want to extend util.get_hostname to accept fqdn=True param) name = name.strip() if not name or name == "0.0.0.0": name = util.get_hostname() try: addrs = socket.getaddrinfo( name, None, 0, socket.SOCK_DGRAM, 0, socket.AI_CANONNAME ) except socket.error: pass else: for addr in addrs: if addr[3]: name = addr[3] break return name def is_valid_ip_addr(val): """ Returns false if the address is loopback, link local or unspecified; otherwise true is returned. """ addr = net.maybe_get_address(ipaddress.ip_address, val) return addr and not ( addr.is_link_local or addr.is_loopback or addr.is_unspecified ) def get_host_info(): """ Returns host information such as the host name and network interfaces. """ # TODO(look to promote netifices use up in cloud-init netinfo funcs) host_info = { "network": { "interfaces": { "by-mac": collections.OrderedDict(), "by-ipv4": collections.OrderedDict(), "by-ipv6": collections.OrderedDict(), }, }, } hostname = getfqdn(util.get_hostname()) if hostname: host_info["hostname"] = hostname host_info["local-hostname"] = hostname host_info["local_hostname"] = hostname default_ipv4, default_ipv6 = get_default_ip_addrs() if default_ipv4: host_info[LOCAL_IPV4] = default_ipv4 if default_ipv6: host_info[LOCAL_IPV6] = default_ipv6 by_mac = host_info["network"]["interfaces"]["by-mac"] by_ipv4 = host_info["network"]["interfaces"]["by-ipv4"] by_ipv6 = host_info["network"]["interfaces"]["by-ipv6"] ifaces = netifaces.interfaces() for dev_name in ifaces: addr_fams = netifaces.ifaddresses(dev_name) af_link = addr_fams.get(netifaces.AF_LINK) af_inet4 = addr_fams.get(netifaces.AF_INET) af_inet6 = addr_fams.get(netifaces.AF_INET6) mac = None if af_link and "addr" in af_link[0]: mac = af_link[0]["addr"] # Do not bother recording localhost if mac == "00:00:00:00:00:00": continue if mac and (af_inet4 or af_inet6): key = mac val = {} if af_inet4: af_inet4_vals = [] for ip_info in af_inet4: if not is_valid_ip_addr(ip_info["addr"]): continue af_inet4_vals.append(ip_info) val["ipv4"] = af_inet4_vals if af_inet6: af_inet6_vals = [] for ip_info in af_inet6: if not is_valid_ip_addr(ip_info["addr"]): continue af_inet6_vals.append(ip_info) val["ipv6"] = af_inet6_vals by_mac[key] = val if af_inet4: for ip_info in af_inet4: key = ip_info["addr"] if not is_valid_ip_addr(key): continue val = copy.deepcopy(ip_info) del val["addr"] if mac: val["mac"] = mac by_ipv4[key] = val if af_inet6: for ip_info in af_inet6: key = ip_info["addr"] if not is_valid_ip_addr(key): continue val = copy.deepcopy(ip_info) del val["addr"] if mac: val["mac"] = mac by_ipv6[key] = val return host_info def wait_on_network(metadata): # Determine whether we need to wait on the network coming online. wait_on_ipv4 = False wait_on_ipv6 = False if WAIT_ON_NETWORK in metadata: wait_on_network = metadata[WAIT_ON_NETWORK] if WAIT_ON_NETWORK_IPV4 in wait_on_network: wait_on_ipv4_val = wait_on_network[WAIT_ON_NETWORK_IPV4] if isinstance(wait_on_ipv4_val, bool): wait_on_ipv4 = wait_on_ipv4_val else: wait_on_ipv4 = util.translate_bool(wait_on_ipv4_val) if WAIT_ON_NETWORK_IPV6 in wait_on_network: wait_on_ipv6_val = wait_on_network[WAIT_ON_NETWORK_IPV6] if isinstance(wait_on_ipv6_val, bool): wait_on_ipv6 = wait_on_ipv6_val else: wait_on_ipv6 = util.translate_bool(wait_on_ipv6_val) # Get information about the host. host_info, ipv4_ready, ipv6_ready = None, False, False while host_info is None: # This loop + sleep results in two logs every second while waiting # for either ipv4 or ipv6 up. Do we really need to log each iteration # or can we log once and log on successful exit? host_info = get_host_info() network = host_info.get("network") or {} interfaces = network.get("interfaces") or {} by_ipv4 = interfaces.get("by-ipv4") or {} by_ipv6 = interfaces.get("by-ipv6") or {} if wait_on_ipv4: ipv4_ready = len(by_ipv4) > 0 if by_ipv4 else False if not ipv4_ready: host_info = None if wait_on_ipv6: ipv6_ready = len(by_ipv6) > 0 if by_ipv6 else False if not ipv6_ready: host_info = None if host_info is None: LOG.debug( "waiting on network: wait4=%s, ready4=%s, wait6=%s, ready6=%s", wait_on_ipv4, ipv4_ready, wait_on_ipv6, ipv6_ready, ) time.sleep(1) LOG.debug("waiting on network complete") return host_info def main(): """ Executed when this file is used as a program. """ try: logging.setupBasicLogging() except Exception: pass metadata = { WAIT_ON_NETWORK: { WAIT_ON_NETWORK_IPV4: True, WAIT_ON_NETWORK_IPV6: False, }, "network": {"config": {"dhcp": True}}, } host_info = wait_on_network(metadata) metadata = util.mergemanydict([metadata, host_info]) print(util.json_dumps(metadata)) if __name__ == "__main__": main() # vi: ts=4 expandtab
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.04 |
proxy
|
phpinfo
|
Settings