3
�~�f-� � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
m Z m Z m
Z
mZmZmZ ddlmZ ddlmZmZmZ dZeje�ZdZdZ d Z d
Z d Z d Z d
Z!dZ"dZ#dZ$dZ%dZ&dZ'G dd� dej(�Z)dd� Z*dd� Z+dd� Z,d d � Z-d d � Z.d d!� Z/d"d#� Z0d$d%� Z1d&d'� Z2d(d)� Z3d*d+� Z4d,d-� Z5d.d � Z6d/d0� Z7d1d2� Z8d3d4� Z9d5d6� Z:d7d8� Z;e)ej<ffe)ej<ej=ffgZ>d9d:� Z?d;d<� Z@dId>d?�ZAd@dA� ZBdBdC� ZCdDdE� ZDdFdG� ZEedHk�r�eE� dS )Ja� 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_helper�dmi�log�net�sources�util)�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�Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
e dd� �Z dd� Z
dd� Zdd� Zdd� Zdd� Zd d � 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.
ZVMwareNc C sT t jj| ||||� 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" �&/usr/lib/python3.6/DataSourceVMware.pyr � s
zDataSourceVMware.__init__c C s t jj| �}d|| jf S )Nz %s [seed=%s])r r �__str__r )r �rootr" r" r# r$ � s zDataSourceVMware.__str__c C s� d\}}}xB| j D ]8\}}}|r*t� r*q|� \}}}|sB|sB|r|| _P qW | jsbtjd� dS tjd| j� � tt|��| _ || _
|| _ | j � | 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.
Nz)failed to find a valid data access methodFzusing data access method %sT)NNN)
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�}tjd|� t|| j| j� tj| j|g�| _| j � 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_networkr- r' r) �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)r- ) r r � get_guestinfo_envvar_key_namer �get_guestinfo_key_namer �get_imc_key_namer ZMETADATA_UNKNOWN)r Zget_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 krtjd� n tjd� d| jj� i| j d< | j d d S )N�networkz using metadata network configz using fallback network config�config)r- r' r( r Zgenerate_fallback_config)r r" r" r# �network_config s
z DataSourceVMware.network_configc
C sT | j rd| j kr| j d S ttd��&}t|j� �j� j� | j d< | j d S Q R X d S )Nz instance-id�r)r- �open�PRODUCT_UUID_FILE_PATH�str�read�rstrip�lower)r Zid_filer" r" r# �get_instance_id s
z DataSourceVMware.get_instance_idc C s. | j r*| j tkr*t� r*tjd| j� � dS dS )Nz"Cache fallback is allowed for : %sTF)r r r& r' r( r* )r r" r" r# � check_if_fallback_is_allowed& s
z-DataSourceVMware.check_if_fallback_is_allowedc C s, x&dD ] }|| j krtj| j | �S qW g S )N�public-keys-data�public_keys_data� public-keys� public_keys)rH rI rJ rK )r- r Znormalize_pubkey_data)r �key_namer" r" r# �get_public_ssh_keys2 s
z$DataSourceVMware.get_public_ssh_keysc C sL d }t | jkr| jt }nt| jkr.| jt }| jtkrHt|| j| j� d S )N)�REDACTr- �CLEANUP_GUESTINFOr r �guestinfo_redact_keysr r )r Zkeys_to_redactr" r" r# r. = s
z DataSourceVMware.redact_keysc C s: d\}}}t jjtd�r0td�}td�}td�}|||fS )z<
check to see if there is data via env vars
N� r- �userdata�
vendordata)NNN)�os�environ�getr
�guestinfo_envvar)r r/ r0 r1 r" r" r# r K s
z#DataSourceVMware.get_envvar_data_fnc C s$ t d�}t d�}|r,|| _t| _tjd|� |rL|s@|| _t| _tjd|� | js`tjd� d S dd� }y|| j| j�S tk
�r } z�tj td | j|� |r�| j|kr�d
S |s�tj
d
� dS tj
d � || _t| _y|| j| j�S tk
�r tj td | j|� dS X W Y dd}~X nX dS )zK
check to see if there is data via the guestinfo transport
�vmtoolsdzvmware-rpctoolz discovered vmware-rpctool: %szdiscovered vmtoolsd: %szno rpctool discoveredNc S sD d\}}}t jd| � td| |�}td| |�}td| |�}|||fS )Nzquery guestinfo with %sr- rR rS )NNN)r' r) r )r r r/ r0 r1 r" r" r# �query_guestinfos s
z?DataSourceVMware.get_guestinfo_data_fn.<locals>.query_guestinfoz%Failed to query guestinfo with %s: %sz$vmtoolsd fallback option not presentzfallback to vmtoolsd)NNN)NNN)NNN)NNN) r r �exec_vmware_rpctoolr r' r( �
exec_vmtoolsd� Exceptionr �logexcr) )r rX Zvmware_rpctoolrY �errorr" r" r# r W sP
z&DataSourceVMware.get_guestinfo_data_fnc C s d\}}}t j| j�}t j| j�}| rB| rBtjd� |||fS t j� sT|||fS t j| j�}|dkrr|||fS t j
j |�}t j |�}t j
|�\} }
| r�|r�tjd� t j| jj| jjd�||| j�\}}}| _n0|
o�|� r�tjd� t j|�\}}}n
tjd� tj|� |||fS )zN
check to see if there is data via vmware guest customization
Nz-Customization for VMware platform is disabledz3Getting data via VMware customization configuration�scriptszFGetting data via VMware raw cloudinit data customization configurationz1No allowed customization configuration data found)NNN)r Zis_vmware_cust_enabledr Zis_raw_data_cust_enabledZds_cfgr' r( Zis_cust_plugin_availableZget_cust_cfg_filerT �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/ r0 r1 Zallow_vmware_custZallow_raw_data_custZ
cust_cfg_fileZ cust_cfg_dirZcust_cfgZis_vmware_cust_cfgZis_raw_data_cust_cfgr" r" r# r � s>
z DataSourceVMware.get_imc_data_fn)N)�__name__�
__module__� __qualname__�__doc__Zdsnamer r$ r2 r7 r* r; �propertyr> rF rG rM r. r r r r" r" r" r# r g s #
9 Lr c C s> t jd�} | d kr tjd� dS d| j� kr:tjd� dS dS )Nzsystem-product-namez No system-product-name foundFZvmwarezNot a VMware platformT)r Z
read_dmi_datar' r( rE )Z system_typer" r" r# r& � s
r& c C sv t jd| |� d}|d kr:t jd|| � tjtj|��}n2|d
kr\t jd|| � tj|�}nt jd| � |}tj|�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� gzip+base64�gz+b64zDecoding %s format %s�base64�b64zPlain-text data %s)rg rh )ri rj )r' r( r Z decomp_gzipr Zb64d�
decode_binary)�key�enc_type�dataZraw_datar" r" r# �decode� s ro c C s. t j| �} | j� } 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 rk rD �len�GUESTINFO_EMPTY_YAML_VAL)�valr" r" r# �get_none_if_empty_val� s
rs c C sj | s| s| rdS | j t�}|r>tt|||� tjd|� | j t�}|rftt|||� tjd|� 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)rV �
LOCAL_IPV4�guestinfo_set_valuer' r) �
LOCAL_IPV6)r6 r r Z
local_ipv4Z
local_ipv6r" r" r# r4 s
r4 c C s t |�}|r|S tjd| � 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
zNo value found for key %sN)rs r' r( )rl rr r" r" r# � handle_returned_guestinfo_val% s
rw c C s dS )Nz vmware-toolsr" )rl r" r" r# r: 2 s r: c C s d| S )Nz
guestinfo.r" )rl r" r" r# r9 6 s r9 c C s dt | � j� jddd�S )Nzvmx.�.�_� ���)r9 �upper�replace)rl r" r" r# r8 : s r8 c C s, t | �}|sd S t | d �}tt| �||�S )Nz .encoding)�guestinfo_envvar_get_valuero r8 )rl rr rm r" r" r# rW > s
rW c C s t | �}t| tjj|d��S )NrQ )r8 rw rT rU rV )rl Zenv_keyr" r" r# r~ F s r~ c C s t | |g�\}}||fS )N)r
)r �arg�stdout�stderrr" r" r# rZ K s rZ c C s t | d|g�\}}||fS )Nz--cmd)r
)r r r� r� r" r" r# r[ P 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
Nz .encoding)�guestinfo_get_valuero r9 )rl r r rr rm r" r" r# r U s
c C s� t jd| � yF||dt| � �\}}|tkr:t jd| � n|sJt jd| � t| |�S tk
r� } z2|jtkr|t jd| � ntj t d| |� |�W Y dd}~X n6 t
k
r� } ztj t d| |� |�W Y dd}~X nX dS )z:
Returns a guestinfo value for the specified key.
z"Getting guestinfo value for key %sz info-get zNo value found for key %sz(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) r' r( r9 �NOVALr^ rw r r� r r] r\ )rl r r r� r� r^ r" r" r# r� a s4
r� c C s� |dkr d}t jd| |� y||dt| �|f � dS tk
rh } ztjt d| ||� W Y dd}~X n$ tk
r� tjt d| |� Y nX dS ) z|
Sets a guestinfo value for the specified key. Set value to an empty string
to clear an existing guestinfo key.
rQ � 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' r( r9 r r r] r\ )rl �valuer r r^ r" r" r# ru � s*
ru c C s� | sdS t | �ttfkr | g} xd| D ]\}t|�}tjd|� t|t||�sVtjd|� tjd|� t|d d||�s$tjd|� q$W 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.encodingz .encodingrQ zfailed to clear %s.encoding) �type�list�tupler9 r' r) ru rq r^ )�keysr r rl rL r" r" r# rP � s
rP c C sF | si S t | t�r| S y
tj| �S tjtfk
r@ tj| �S X 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)rn r" r" r# r, � s
r, c C s� | si S d}d| kr"| d }| d= d}d| kr<| d }| d= |r�t |tjj�rhtjd� dtj|�i}n$tjd|� td||�}dt |�i}tjd|� || d< | S ) z_
process_metadata processes metadata and loads the optional network
configuration.
Nr< znetwork.encodingz#network data copied to 'config' keyr= z network data to be decoded %szmetadata.networkznetwork data %s)
r� � collections�abc�Mappingr' r( �copy�deepcopyro r, )rn r< Z network_encZdec_netr" r" r# r+ � s(
r+ c C s t j| 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� t j� } d| krdS | d }t j|kr4t j|kr4d S d}d}|jt j�}|r�|\}}t j|�}|r�|jt j�}|r�t|�dkr�tjd||� nd|d kr�|d d }|jt j�} | �r| \}}
t j|
�} | �r| jt j�} | �rt| �dk�r tjd|
| � nd| d k�r| d d }|�rr| �rr|jt j�} | �rrt| �dk�rXtjd|| � nd| d k�rr| d d }| �r�|�r�| jt j�}|�r�t|�dk�r�tjd|
|� nd|d k�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.
�defaultNrz z,device %s has more than one ipv4 address: %s�addrr z,device %s has more than one ipv6 address: %s)NN)NN) � netifaces�gateways�AF_INET�AF_INET6rV � ifaddressesrp r' r( )
r� Z
default_gwr r Zgw4ry Zdev4Z
addr4_fams�af_inet4Zgw6Zdev6Z
addr6_fams�af_inet6r" r" r# �get_default_ip_addrs st
r� rQ c
C sv | j � } | s| dkr tj� } y tj| ddtjdtj�}W n tjk
rP Y n"X x |D ]}|d rX|d } P qXW | 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�socketZ getaddrinfoZ
SOCK_DGRAMZ AI_CANONNAMEr^ )�nameZaddrsr� r" r" r# �getfqdnl s
r� c C s& t jtj| �}|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� ipaddressZ
ip_addressZ
is_link_localZ is_loopbackZis_unspecified)rr r� r" r" r# �is_valid_ip_addr� s r� c C sR ddt j� t j� t j� d�ii} ttj� �}|rH|| d< || d< || d< t� \}}|r^|| t< |rj|| t< | d d d }| d d d }| d d d }tj � }�x�|D �]�}tj
|�} | j tj �}
| j tj
�} | j tj�} d
}
|
r�d |
d kr�|
d d }
|
d
k�r
q�|
�r�| �s | �r�|
}i }| �rbg }x*| D ]"}t|d ��sJ�q4|j|� �q4W ||d< | �r�g }x*| D ]"}t|d ��s��qr|j|� �qrW ||d< |||< | �r�xJ| D ]B}|d }t|��sΐq�tj|�}|d = |
�r�|
|d< |||< �q�W | r�xJ| D ]B}|d }t|��s �qtj|�}|d = |
�r<|
|d< |||< �qW q�W | S )zP
Returns host information such as the host name and network interfaces.
r< �
interfaces)zby-maczby-ipv4zby-ipv6�hostnamezlocal-hostnameZlocal_hostnamezby-maczby-ipv4zby-ipv6Nr� r z00:00:00:00:00:00r r �mac)r� � OrderedDictr� r r� r� rt rv r� r� r� rV ZAF_LINKr� r� r� �appendr� r� )r6 r� Z default_ipv4Z default_ipv6Zby_mac�by_ipv4�by_ipv6ZifacesZdev_nameZ addr_famsZaf_linkr� r� r� rl rr Z
af_inet4_valsZip_infoZ
af_inet6_valsr" r" r# �
get_host_info� s�
r� c
C s: d}d}t | krl| t }t|krB|t }t|t�r8|}n
tj|�}t|krl|t }t|t�rb|}n
tj|�}d
\}}}x�|d k�r*t� }|jd�p�i } | jd�p�i }
|
jd�p�i } |
jd�p�i } |r�| r�t | �dknd}|s�d }|�r| r�t | �dknd}|�sd }|d krxt
j d||||� t j
d� qxW t
j d � |S ) NFr< r� zby-ipv4zby-ipv6r z<waiting on network: wait4=%s, ready4=%s, wait6=%s, ready6=%srz zwaiting on network complete)NFF)�WAIT_ON_NETWORK�WAIT_ON_NETWORK_IPV4r� �boolr Ztranslate_bool�WAIT_ON_NETWORK_IPV6r� rV rp r' r( �timeZsleep)
r- Z wait_on_ipv4Z wait_on_ipv6r3 Zwait_on_ipv4_valZwait_on_ipv6_valr6 Z
ipv4_readyZ
ipv6_readyr< r� r� r� r" r" r# r3 � sN
r3 c C sf y t j� W n tk
r Y nX ttdtdiddddiii} t| �}tj| |g�} t t
j | �� dS )z7
Executed when this file is used as a program.
TFr< r= ZdhcpN) r Zsetup_basic_loggingr\ r� r� r� r3 r r5 �printr Z
json_dumps)r- r6 r" r" r# �main s r� �__main__)rQ )Fre r� r� r� r� ZloggingrT r� r� r� Z cloudinitr r r r r r Z$cloudinit.sources.helpers.vmware.imcr Zcloudinit.subpr r
r rA Z getLoggerrb r' r� r r r rN rO r
rq rt rv r� r� r� r r r& ro rs r4 rw r: r9 r8 rW r~ rZ r[ r r� ru rP r, r+ ZDEP_FILESYSTEMZ DEP_NETWORKr� r� r� r� r� r� r3 r� r" r" r" r# �<module>@ sv
x
,+$
]
Y8