o w7e@sdZddlZddlZddlZddlZddlZddlZddlZddlZddl m Z m Z ddl m Z ddl mZmZmZddlmZddlmZmZmZdZe eZd Zd Zd Zd Zed ZdZ dZ!dZ"dZ#dZ$dZ%dZ&dZ'dZ(Gdddej)Z*ddZ+ddZ,ddZ-dd Z.d!d"Z/d#d$Z0d%d&Z1d'd(Z2d)d*Z3d+d,Z4efd-d Z5efd.d/Z6efd0d1Z7efd2d3Z8d4d5Z9d6d7Z:e*ej;ffe*ej;ejd:d;Z?dHd=d>Z@d?d@ZAdAdBZBdCdDZCdEdFZDedGkreDdSdS)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) atomic_helperdmi)log)netsourcesutil)guestcust_util)ProcessExecutionErrorsubpwhichz/sys/class/dmi/id/product_uuidzNo value foundenvvar guestinfoimczvmware-rpctoolredactzcleanup-guestinfo VMX_GUESTINFOz---z local-ipv4z local-ipv6zwait-on-networkipv4ipv6c@seZdZdZdZdddZddZdd Zd d Zd d Z ddZ e ddZ ddZ ddZddZddZddZddZdS)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. VMwareNcCsNtj|||||i|_d|_t|_t|jdft |j dft |j dfg|_ dS)NFT)r DataSource__init__cfgdata_access_methodVMWARE_RPCTOOLvmware_rpctoolDATA_ACCESS_METHOD_ENVVARget_envvar_data_fnDATA_ACCESS_METHOD_GUESTINFOget_guestinfo_data_fnDATA_ACCESS_METHOD_IMCget_imc_data_fn possible_data_access_method_list)selfsys_cfgdistropathsud_procr'D/usr/lib/python3/dist-packages/cloudinit/sources/DataSourceVMware.pyrs   zDataSourceVMware.__init__cCstj|}d||jfS)Nz %s [seed=%s])rr__str__r)r"rootr'r'r(r)s zDataSourceVMware.__str__cCsd\}}}|jD]\}}}|rtsq|\}}}|s|s|r$||_nq|js/tddStd|tt||_ ||_ ||_ | |j sQ|j sQ|j rSdSdS)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_platformrLOGerrorinfo_get_subplatformprocess_metadataload_json_or_yamlmetadata userdata_rawvendordata_raw redact_keys)r"mdudvdr get_data_fnrequire_vmware_platformr'r'r( _get_datas0     zDataSourceVMware._get_datacCs<t|j}td|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_networkr3r-r/advertise_local_ip_addrsr mergemanydictpersist_instance_data)r"is_new_instance host_infor'r'r(setups  zDataSourceVMware.setupcCsLd}|jtkr t}n|jtkrt}n |jtkrt}ntjSd|j|dfS)Nz%s (%s)r3) rrget_guestinfo_envvar_key_namerget_guestinfo_key_namerget_imc_key_namerMETADATA_UNKNOWN)r"get_key_name_fnr'r'r(r0s   z!DataSourceVMware._get_subplatformcCs|jSN)rr"r'r'r(get_config_objszDataSourceVMware.get_config_objcCsBd|jvr tdntdd|ji|jd<|jddS)Nnetworkzusing metadata network configzusing fallback network configconfig)r3r-debugr$generate_fallback_configrJr'r'r(network_configs     zDataSourceVMware.network_configcCsl|jr d|jvr |jdSttd}t||jd<|jdWdS1s/wYdS)Nz instance-idr)r3openPRODUCT_UUID_FILE_PATHstrreadrstriplower)r"id_filer'r'r(get_instance_ids   $z DataSourceVMware.get_instance_idcCs,dD]}||jvrt|j|SqgS)N)zpublic-keys-datapublic_keys_dataz public-keys public_keys)r3rnormalize_pubkey_data)r"key_namer'r'r(get_public_ssh_keys's  z$DataSourceVMware.get_public_ssh_keyscCsLd}t|jvr |jt}n t|jvr|jt}|jtkr$t||jdSdSrI)REDACTr3CLEANUP_GUESTINFOrrguestinfo_redact_keysr)r"keys_to_redactr'r'r(r62s     zDataSourceVMware.redact_keyscCs:d\}}}tjtdrtd}td}td}|||fS)z< check to see if there is data via env vars r+r3userdata vendordata)osenvirongetrguestinfo_envvarr"r7r8r9r'r'r(r>s  z#DataSourceVMware.get_envvar_data_fncCs>d\}}}|jrtd|j}td|j}td|j}|||fS)zK check to see if there is data via the guestinfo transport r+r3rdre)rr rjr'r'r(rJs     z&DataSourceVMware.get_guestinfo_data_fnc Csd\}}}t|j}t|j}|s|std|||fSts(|||fSt|j}|dur7|||fSt j |}t |}t |\} } | rh|rhtdt|jj|jd|||j\}}}|_n| rz|rztdt|\}}}ntdt||||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 configurationscriptszFGetting data via VMware raw cloudinit data customization configurationz1No allowed customization configuration data found)ris_vmware_cust_enabledr#is_raw_data_cust_enabledds_cfgr-rNis_cust_plugin_availableget_cust_cfg_filerfpathdirnameparse_cust_cfgget_cust_cfg_typeget_data_from_imc_cust_cfgr% cloud_dir get_cpathr$r#get_data_from_imc_raw_data_cust_cfgrdel_dir) r"r7r8r9allow_vmware_custallow_raw_data_cust cust_cfg_file cust_cfg_dircust_cfgis_vmware_cust_cfgis_raw_data_cust_cfgr'r'r(r VsL              z DataSourceVMware.get_imc_data_fnrI)__name__ __module__ __qualname____doc__dsnamerr)r<rCr0rKpropertyrPrYr^r6rrr r'r'r'r(ris"$ 9      rcCs>td}|durtddSd|vrtddSdS)Nzsystem-product-namezNo system-product-name foundFvmwarezNot a VMware platformT)r read_dmi_datar-rNrW) system_typer'r'r(r,s    r,cCsvtd||d}|dvrtd||tt|}n|dvr.td||t|}ntd||}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)base64b64zPlain-text data %s)r-rNr decomp_gziprb64d decode_binary)keyenc_typedataraw_datar'r'r(decodes   rcCs.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. rN)rrrVlenGUESTINFO_EMPTY_YAML_VAL)valr'r'r(get_none_if_empty_vals rcCsX|sdS|t}|rtt|td||t}|r*tt|td|dSdS)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)rh LOCAL_IPV4guestinfo_set_valuer-r/ LOCAL_IPV6)rB local_ipv4 local_ipv6r'r'r(r>s     r>cCs t|}|r|Std|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)rr-rN)rrr'r'r(handle_returned_guestinfo_vals  rcCsdS)Nz vmware-toolsr'rr'r'r(rFsrFcCsd|S)Nz guestinfo.r'rr'r'r(rEsrEcCsdt|dddS)Nzvmx.._)rEupperreplacerr'r'r(rDsrDcCs,t|}|sdSt|d}tt|||S)N .encoding)guestinfo_envvar_get_valuerrD)rrrr'r'r(ris  ricCst|}t|tj|dS)Nrc)rDrrfrgrh)renv_keyr'r'r(rsrcCs0t||}|s dSt|d|}tt|||S)zj guestinfo returns the guestinfo value for the provided key, decoding the value when required Nr)guestinfo_get_valuerrE)rrrrr'r'r(r s c Cstd|z%t|dt|g\}}|tkrtd|n|s&td|t||WStyY}z"|jtkr?td|nt td||WYd}~dSWYd}~dSd}~wt yit td|YdSw)z: Returns a guestinfo value for the specified key. z"Getting guestinfo value for key %sz info-get rz(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-rNr rENOVALr.rr stderrrlogexc Exception)rrstdoutrr.r'r'r(r sB       rc Cs|dkrd}td||zt|dt||fgWdSty8}zttd|||WYd}~dSd}~wtyIttd||YdSw) z| Sets a guestinfo value for the specified key. Set value to an empty string to clear an existing guestinfo key. rc 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-rNr rEr rrr)rvaluerr.r'r'r(r1s:  rcCs|sdSt|ttfvr|g}|D],}t|}td|t|t|s)td|td|t|dd|s=td|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.encodingrrczfailed to clear %s.encoding) typelisttuplerEr-r/rrr.)keysrrr]r'r'r(ra\s     rac CsF|siSt|tr |Szt|WStjtfy"t|YSw)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. ) isinstancedictr load_jsonjsonJSONDecodeError TypeError load_yaml)rr'r'r(r2rs  r2cCs|siSd}d|vr|d}|d=d}d|vr|d}|d=|rPt|tjjr4tddt|i}ntd|td||}dt |i}td|||d<|S) z_ process_metadata processes metadata and loads the optional network configuration. NrLznetwork.encodingz#network data copied to 'config' keyrMznetwork data to be decoded %szmetadata.networkznetwork data %s) r collectionsabcMappingr-rNcopydeepcopyrr2)rrL network_encdec_netr'r'r(r1s*    r1cCs t|tS)zK Return a list of data sources that match this set of dependencies )rlist_from_depends datasources)dependsr'r'r(get_datasource_lists rc Cst}d|vr dS|d}tj|vrtj|vrdSd}d}|tj}|rS|\}}t|}|rS|tj}|rSt|dkrGtd||n d|dvrS|dd}|tj} | r| \}} t| } | r| tj} | rt| dkr|td| | n d| dvr| dd}|r|s|tj} | rt| dkrtd|| n d| dvr| dd}|s|r| tj}|rt|dkrtd| |||fSd|dvr|dd}||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)NNNz,device %s has more than one ipv4 address: %saddrrz,device %s has more than one ipv6 address: %s) netifacesgatewaysAF_INETAF_INET6rh ifaddressesrr-rN) r default_gwrrgw4rdev4 addr4_famsaf_inet4gw6dev6 addr6_famsaf_inet6r'r'r(get_default_ip_addrss~                      rrccCst|}|r |dkrt}zt|ddtjdtj}Wn tjy'Y|Sw|D] }|dr7|d}|Sq*|S)zoGet fully qualified domain name from name. An empty argument is interpreted as meaning the local host. z0.0.0.0Nr)stripr get_hostnamesocket getaddrinfo SOCK_DGRAM AI_CANONNAMEr.)nameaddrsrr'r'r(getfqdns$ rcCs&ttj|}|o|jp|jp|j S)zn Returns false if the address is loopback, link local or unspecified; otherwise true is returned. )rmaybe_get_address ipaddress ip_address is_link_local is_loopbackis_unspecified)rrr'r'r(is_valid_ip_addr'srcCsddtttdii}tt}|r$||d<||d<||d<t\}}|r/||t<|r5||t<|ddd}|ddd}|ddd }t }|D]}t |} | tj } | tj } | tj} d } | r|d | d vr|| d d } | d krqS| r| s| r| }i}| rg}| D]}t|d sq||q||d<| rg}| D]}t|d sq||q||d<|||<| r| D]}|d }t|sqt|}|d =| r| |d<|||<q| r| D]}|d }t|sqt|}|d =| r| |d<|||<qqS|S)zP Returns host information such as the host name and network interfaces. rL interfaces)by-macby-ipv4by-ipv6hostnamezlocal-hostnamelocal_hostnamerrrNrrz00:00:00:00:00:00rrmac)r OrderedDictrrrrrrrrrrhAF_LINKrrrappendrr)rBr default_ipv4 default_ipv6by_macby_ipv4by_ipv6ifacesdev_name addr_famsaf_linkrrrrr af_inet4_valsip_info af_inet6_valsr'r'r( get_host_info2s                rc Cs6d}d}t|vr6|t}t|vr!|t}t|tr|}nt|}t|vr6|t}t|tr1|}nt|}d\}}}|durt}|dpHi} | dpOi} | dpVi} | dp]i} |rn| rht | dknd}|snd}|r~| rxt | dknd}|s~d}|durt d||||t d |dus?t d |S) NF)NFFrLrrrrzrrFrErDrirr rrrar2r1DEP_FILESYSTEM DEP_NETWORKrrrrrrr=rr'r'r'r(s| 7   )    ' + $ ] Y8