Google
Edit File: DataSourceVMware.cpython-39.opt-1.pyc
a '�Dg=� � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl m Z m Z m Z m Z mZmZ ddlmZ ddlmZ ddlmZmZmZ dZe�e�ZdZ d Z d Z d Z d Z d Z!dZ"dZ#dZ$dZ%dZ&dZ'dZ(G dd� dej)�Z*dd� Z+dd� Z,dd � Z-d d � Z.d d � Z/d!d"� Z0d#d$� Z1d%d&� Z2d'd(� Z3d)d*� Z4d+d,� Z5d-d.� Z6d/d � Z7d0d1� Z8d2d3� Z9d4d5� Z:d6d7� Z;d8d9� Z<e*ej=ffe*ej=ej>ffgZ?d:d;� Z@d<d=� ZAdOd?d@�ZBdAdB� ZCeDeDdC�dDdE�ZEeDeDdC�dFdG�ZFdHdI� ZGdJdK� ZHdLdM� ZIedNk�r�eI� dS )Pz�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) � N)� atomic_helper�dmi�net�netinfo�sources�util)�loggers)�guestcust_util)�ProcessExecutionError�subp�whichz /sys/class/dmi/id/product_uuidzNo value foundZenvvar� guestinfoZimcZredactzcleanup-guestinfo� VMX_GUESTINFOz---z local-ipv4z local-ipv6zwait-on-network�ipv4�ipv6c s� e Zd ZdZdZd#dd�Zedd�� fdd� Zd d � Zd d � Z d d� Z dd� Z dd� Z e dd� �Zdd� Zdd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Z� ZS )$�DataSourceVMwareav 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 transports: 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. ZVMwareNc C sT t j�| ||||� i | _d | _d | _d | _t| jdft | j dft | j dfg| _ d S )NFT)r � DataSource�__init__�cfg�data_access_method�rpctool� rpctool_fn�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�pathsZud_proc� r# �F/usr/lib/python3.9/site-packages/cloudinit/sources/DataSourceVMware.pyr ` s �zDataSourceVMware.__init__)�ci_pkl_version�returnc sz t � �|� dD ]}t| |�st| |d � qt| d�sBt| di � t| d�svt| dt| jdft| jdft| j dfg� d S )N)r r r r FT) �super� _unpickle�hasattr�setattrr r r r r r )r r% �attr�� __class__r# r$ r( u s* �� ��zDataSourceVMware._unpicklec 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 ]8\}}}|r&t� s&q|� \}}}|s>|s>|r|| _ qJq| js^t�d� dS t�d| �� � tt|��| _ || _ || _ | � � | j s�| j s�| j r�dS dS 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 %sTN) r �is_vmware_platformr �LOG�debug�info�_get_subplatform�process_metadata�load_json_or_yaml�metadataZ userdata_rawZvendordata_raw� redact_keys)r �md�ud�vdr Z get_data_fnZrequire_vmware_platformr# r# r$ � _get_data� s. � zDataSourceVMware._get_datac C sD t | j�}t�d|� t|| j| j� 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_networkr8 r2 r4 �advertise_local_ip_addrsr r r � mergemanydictZpersist_instance_data)r Zis_new_instance� host_infor# r# r$ �setup� s zDataSourceVMware.setupc C sL d }| j tkrt}n&| j tkr$t}n| j tkr4t}ntjS d| j |d�f S )Nz%s (%s)r8 ) r r � get_guestinfo_envvar_key_namer �get_guestinfo_key_namer �get_imc_key_namer ZMETADATA_UNKNOWN)r Zget_key_name_fnr# r# r$ r5 � 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 rt�d� n t�d� d| j�� i| j d< | j d d S )N�networkz using metadata network configz using fallback network config�config)r8 r2 r3 r! Zgenerate_fallback_configrG r# r# r$ �network_config� s � z DataSourceVMware.network_configc C s< | j rd| j v r| j d S t�t��� �� | j d< | j d S )Nz instance-id)r8 r Zload_text_file�PRODUCT_UUID_FILE_PATH�rstrip�lowerrG r# r# r$ �get_instance_id s �z DataSourceVMware.get_instance_idc C s. | j r*| j tkr*t� r*t�d| �� � dS dS )Nz"Cache fallback is allowed for : %sTF)r r r1 r2 r3 r5 rG r# r# r$ � check_if_fallback_is_allowed s ����z-DataSourceVMware.check_if_fallback_is_allowedc C s, dD ]"}|| j v rt�| j | � S qg S )N)zpublic-keys-dataZpublic_keys_dataz public-keysZ public_keys)r8 r Znormalize_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 }nt| jv r.| jt }| jtkrHt|| j| j� d S rF )�REDACTr8 �CLEANUP_GUESTINFOr r �guestinfo_redact_keysr r )r Zkeys_to_redactr# r# r$ r9 * s �z DataSourceVMware.redact_keysc C s: d\}}}t j�td�r0td�}td�}td�}|||fS )z< check to see if there is data via env vars r0 � r8 �userdata� vendordata)�os�environ�getr �guestinfo_envvar)r r: r; r< r# r# r$ r 8 s z#DataSourceVMware.get_envvar_data_fnc C sT t d�}t d�}|r,|| _t| _t�d|� |rL|s@|| _t| _t�d|� | js`t�d� dS dd� }z|| j| j�W S t�yN } z�t� td | j|� |r�| j|kr�W Y d }~dS |s�t� d � W Y d }~dS t� d � || _t| _z || j| j�W W Y d }~S t�y8 t� td | j|� Y W Y d }~dS 0 W Y d }~n d }~0 0 d S ) zK check to see if there is data via the guestinfo transport �vmtoolsdzvmware-rpctoolz discovered vmware-rpctool: %szdiscovered vmtoolsd: %szno rpctool discoveredr0 c S sD d\}}}t �d| � td| |�}td| |�}td| |�}|||fS )Nr0 zquery guestinfo with %sr8 rW rX )r2 r4 r )r r r: r; r< r# r# r$ �query_guestinfo` s z?DataSourceVMware.get_guestinfo_data_fn.<locals>.query_guestinfoz%Failed to query guestinfo with %s: %sNz$vmtoolsd fallback option not presentzfallback to vmtoolsd) r r �exec_vmware_rpctoolr r2 r3 � exec_vmtoolsd� Exceptionr �logexcr4 )r r] Zvmware_rpctoolr^ �errorr# r# r$ r D sT � �z&DataSourceVMware.get_guestinfo_data_fnc C s d\}}}t �| j�}t �| j�}|s>|s>t�d� |||fS t �� sP|||fS t �| j�}|du rn|||fS t j � |�}t � |�}t � |�\} } | r�|r�t�d� t �| jj| j�d�||| j�\}}}| _n.| r�|r�t�d� t �|�\}}}n t�d� t�|� |||fS )zN check to see if there is data via vmware guest customization r0 z-Customization for VMware platform is disabledNz3Getting data via VMware customization configurationZscriptszFGetting data via VMware raw cloudinit data customization configurationz1No allowed customization configuration data found)r Zis_vmware_cust_enabledr Zis_raw_data_cust_enabledZds_cfgr2 r3 Zis_cust_plugin_availableZget_cust_cfg_filerY �path�dirnameZparse_cust_cfgZget_cust_cfg_typeZget_data_from_imc_cust_cfgr" Z cloud_dirZ get_cpathr! r Z#get_data_from_imc_raw_data_cust_cfgr Zdel_dir) r r: r; r< Zallow_vmware_custZallow_raw_data_custZ cust_cfg_fileZ cust_cfg_dirZcust_cfgZis_vmware_cust_cfgZis_raw_data_cust_cfgr# r# r$ r � sL � � ��� z DataSourceVMware.get_imc_data_fn)N)�__name__� __module__� __qualname__�__doc__Zdsnamer �intr( r. r= rB r5 rH �propertyrK rO rP rR r9 r r r � __classcell__r# r# r, r$ r 9 s$ $ 9 Lr c C s> t �d�} | d u r t�d� dS d| �� vr:t�d� dS dS )Nzsystem-product-namez No system-product-name foundFZvmwarezNot a VMware platformT)r Z read_dmi_datar2 r3 rN )Z system_typer# r# r$ r1 � s r1 c C sv t �d| |� d}|dv r:t �d|| � t�t�|��}n2|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)�base64Zb64zPlain-text data %s)r2 r3 r Z decomp_gzipr Zb64d� decode_binary)�key�enc_type�data�raw_datar# r# r$ �decode� s rs c C s. t �| �} | �� } t| �dks&| tkr*dS | 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 rn rM �len�GUESTINFO_EMPTY_YAML_VAL)�valr# r# r$ �get_none_if_empty_val� s rw c C sd | r |r |sdS | � t�}|r8tt|||� t�d|� | � t�}|r`tt|||� t�d|� 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)r[ � LOCAL_IPV4�guestinfo_set_valuer2 r4 � LOCAL_IPV6)rA r r Z local_ipv4Z 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)rw r2 r3 )ro rv r# r# r$ � handle_returned_guestinfo_val s r| c C s dS )Nz vmware-toolsr# �ro 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_valuers rC )ro rv rp r# r# r$ r\ + s r\ c C s t | �}t| tj�|d��S )NrV )rC r| rY rZ r[ )ro Zenv_keyr# r# r$ r� 3 s r� c C s t | |g�\}}||fS rF �r �r �arg�stdout�stderrr# r# r$ r_ 8 s r_ c C s t | d|g�\}}||fS )Nz--cmdr� r� r# r# r$ r` = s r` c C s4 t | ||�}|sdS t | d ||�}tt| �||�S )zj guestinfo returns the guestinfo value for the provided key, decoding the value when required Nr� )�guestinfo_get_valuers rD )ro r r rv rp r# r# r$ r B s c C s� t �d| � zH||dt| � �\}}|tkr:t �d| � n|sJt �d| � t| |�W S ty� } z8|jtkr|t �d| � nt� t d| |� |�W Y d}~n@d}~0 t y� } z t� t d| |� |�W Y d}~n d}~0 0 dS )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: %sNzCUnexpected error while trying to get guestinfo value for key %s: %s) r2 r3 rD �NOVALrc r| r r� r rb ra )ro r r r� r� rc r# r# r$ r� N s: � ��r� c C s� |dkr d}t �d| |� z ||dt| �|f � W dS tyl } z t�t d| ||� W Y d}~n*d}~0 ty� t�t d| |� Y n0 dS ) z| Sets a guestinfo value for the specified key. Set value to an empty string to clear an existing guestinfo key. rV � 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)r2 r3 rD r r rb ra )ro �valuer r rc r# r# r$ ry z s0 �� � ry c C s� | sdS t | �ttfvr | g} | D ]\}t|�}t�d|� t|t||�sTt�d|� t�d|� t|d d||�s"t�d|� q"dS )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� rV zfailed to clear %s.encoding) �type�list�tuplerD r2 r4 ry ru rc )�keysr r ro rQ r# r# r$ rU � s � rU c C sJ | si S t | t�r| S z t�| �W S tjtfyD t�| � Y S 0 dS )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. N)� isinstance�dictr Z load_json�jsonZJSONDecodeError� TypeErrorZ load_yaml)rq r# r# r$ r7 � s r7 c C s� | si S d}d| v r"| d }| d= d}d| v r<| d }| d= |r�t |tjj�rht�d� dt�|�i}n$t�d|� td||�}dt |�i}t�d|� || d< | S ) z_ process_metadata processes metadata and loads the optional network configuration. NrI znetwork.encodingz#network data copied to 'config' keyrJ z network data to be decoded %szmetadata.networkznetwork data %s) r� � collections�abc�Mappingr2 r3 �copy�deepcopyrs r7 )rq rI Z network_encZdec_netr# r# r$ r6 � s* � r6 c C s t �| t�S )zK Return a list of data sources that match this set of dependencies )r Zlist_from_depends� datasources)Zdependsr# r# r$ �get_datasource_list� s r� c C s d} d}t �� }|d D ] }|d dkr|d } q6q|d D ] }|d dkr>|d } q\q>d}d}t �� }| |v r�|| d }t|�dkr�t�d | |� n$t|�dkr�d |d v r�|d d }||v �r|| d }t|�dkr�t�d ||� n(t|�dk�rd |d v �r|d d }|du�r�|du �r�|D ]X}|| d D ]D} | d |k�rBt|| d �dk�rB|| d d d } �q2�qB�q2|du �r�|du�r�|D ]X}|| d D ]D} | d |k�r�t|| d �dk�r�|| d d d } �q��q��q�||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. Nr Z destination�0.0.0.0Zifacer z::/0� z,device %s has more than one ipv4 address: %s�ipr z,device %s has more than one ipv6 address: %s)r Z route_info� netdev_infort r2 r3 ) Zipv4_ifZipv6_ifZroutesZrouter r Znetdev�addrs�dev_name�addrr# r# r$ �get_default_ip_addrs� sV � � $$r� rV c C sp | � � } | r| dkr t�� } z t�| ddtjdtj�}W n tjyL Y n 0 |D ]}|d rR|d } qlqR| S )zoGet fully qualified domain name from name. An empty argument is interpreted as meaning the local host. r� Nr � )�stripr � get_hostname�socketZ getaddrinfoZ SOCK_DGRAMZ AI_CANONNAMErc )�namer� r� 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 Zmaybe_get_address� ipaddress� ip_address� is_link_local� is_loopback�is_unspecified)rv r� r# r# r$ �is_valid_ip_addrU s �r� )r� r& c C s, | � d�si S | � d�| � d�| � d�d�S )a� Takes a cloudinit.netinfo formatted address and converts to netifaces format, since this module was originally written with netifaces as the network introspection module. netifaces ipv4 format: { "broadcast": "10.15.255.255", "netmask": "255.240.0.0", "addr": "10.0.1.4" } cloudinit.netinfo ipv4 format: { "ip": "10.0.1.4", "mask": "255.240.0.0", "bcast": "10.15.255.255", "scope": "global", } r� Zbcast�mask)� broadcast�netmaskr� )r[ )r� r# r# r$ � convert_to_netifaces_ipv4_format` s �r� c C s> | � d�si S t�| � d��}|j� d|jj� �t|j�d�S )a� Takes a cloudinit.netinfo formatted address and converts to netifaces format, since this module was originally written with netifaces as the network introspection module. netifaces ipv6 format: { "netmask": "ffff:ffff:ffff:ffff::/64", "addr": "2001:db8:abcd:1234::1" } cloudinit.netinfo ipv6 format: { "ip": "2001:db8:abcd:1234::1/64", "scope6": "global", } r� �/)r� r� )r[ r� � IPv6Interfacer� rI � prefixlen�strr� )r� r r# r# r$ � convert_to_netifaces_ipv6_format| s �r� c C sD ddt �� t �� t �� d�ii} tt�� �}|rH|| d< || d< || d< t� \}}|r^|| t< |rj|| t< | d d d }| d d d }| d d d }t� � }|D �]�}g } g } || d D ]} | � t | �� q�|| d D ]} | � t | �� q�|| � d �} | d k�rq�| �r�| �s | �r�| } i }| �rbg }| D ]"}t|d ��sL�q6|� |� �q6||d < | �r�g }| D ]"}t|d ��s��qp|� |� �qp||d < ||| < | �r�| D ]B}|d } t| ��sȐq�t�|�}|d= | �r�| |d< ||| < �q�| r�| D ]B}|d } t| ��s�q�t�|�}|d= | �r2| |d< ||| < �q�q�| S )zP Returns host information such as the host name and network interfaces. rI � interfaces)�by-mac�by-ipv4�by-ipv6�hostnamezlocal-hostnameZlocal_hostnamer� r� r� r r Zhwaddrz00:00:00:00:00:00r� �mac)r� � OrderedDictr� r r� r� rx rz r r� �appendr� r� r[ r� r� r� )rA r� Z default_ipv4Z default_ipv6Zby_mac�by_ipv4�by_ipv6Zifacesr� Zaf_inet4Zaf_inet6r� r� ro rv Z af_inet4_valsZip_infoZ af_inet6_valsr# r# r$ � get_host_info� s� ��� r� c C s2 d}d}t | v rl| t }t|v rB|t }t|t�r8|}n t�|�}t|v rl|t }t|t�rb|}n t�|�}d\}}}|d u �r$t� }|�d�p�i } | �d�p�i } | �d�p�i } | �d�p�i } |r�| r�t | �dknd}|s�d }|r�| r�t | �dknd}|s�d }|d u rvt � d||||� t � d � qvt � d � |S ) NF)NFFrI 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 Ztranslate_bool�WAIT_ON_NETWORK_IPV6r� r[ rt r2 r3 �time�sleep) r8 Z wait_on_ipv4Z wait_on_ipv6r> Zwait_on_ipv4_valZwait_on_ipv6_valrA Z ipv4_readyZ ipv6_readyrI r� r� r� r# r# r$ r> � sP � r> c C sd z t �� W n ty Y n0 ttdtdiddddiii} t| �}t�| |g�} t t � | �� dS )z7 Executed when this file is used as a program. TFrI rJ ZdhcpN) r Zsetup_basic_loggingra r� r� r� r> r r@ �printr Z json_dumps)r8 rA r# r# r$ �main% s � �r� �__main__)rV )Jri r� r� r� r� ZloggingrY r� r� Z cloudinitr r r r r r Z cloudinit.logr Z$cloudinit.sources.helpers.vmware.imcr Zcloudinit.subpr r r rL Z getLoggerrf r2 r� r r r rS rT r ru rx rz r� r� r� r r r1 rs rw r? r| rE rD rC r\ r� r_ r` r r� ry rU r7 r6 ZDEP_FILESYSTEMZ DEP_NETWORKr� r� r� r� r� r� r� r� r� r> r� r# r# r# r$ �<module> s~ ,+$ �B X8