HEX

File: //lib/python3/dist-packages/cloudinit/sources/__pycache__/DataSourceEc2.cpython-310.pyc
o

�Ad ��@s�ddlZddlZddlZddlmZddlmZddlmZddlm	Z	m
Z
ddlmZddlm
Z
mZddlmZmZdd	lmZdd
lmZddlmZe�e�Zeejg�ZdZd
ZGdd�d�Z dd�Z!e j"e j#gZ$Gdd�de
j%�Z&Gdd�de&�Z'dd�Z(dd�Z)dd�Z*dd�Z+dd�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,eZdZdZdZdZdZdZdZdZ	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"srcCs|jdko	d|jvS)N�zmeta-data/tags/)�code�url)�	exceptionr&r&r'�skip_404_tag_errors2sr,csxeZdZUdZgd�ZdZgd�Zeee	d<dZ
dZdZe
jZd	ZejejejejejhiZ�fd
d�Zdd
�Zdd�Zdd�Zedd��Zedd��Zedd��Z edd��Z!edd��Z"edd��Z#edd��Z$d d!�Z%d"d#�Z&d$d%�Z'd&d'�Z(d(d)�Z)ed*d+��Z*ed,d-��Z+d.d/�Z,ed0d1��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�2NFcstt|��|||�d|_dS�N)�superr-�__init__�metadata_address)�self�sys_cfg�distro�paths��	__class__r&r'r3es
zDataSourceEc2.__init__cCst�S)z5Return the cloud name as identified during _get_data.)�identify_platform�r5r&r&r'�_get_cloud_nameiszDataSourceEc2._get_cloud_namecCsZtt�|jtt�d�\}}t�d||j|j	�|dkr#|jt
jkr#dS|jt
jkr+dS|j
r{t��r9t�d�dSz7t|jdd|j��d��!}|jrPd|j��nd	}tjtjd
|��|jd�|_Wd�n1sjwYWntyzYdSwtjtjd
|jd�|_|js�dS|j�dd�|_|j�d
d�|_|j�di��di��di�|_dS)N)rNz0strict_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�platformrr$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�netwrYr&r&r'�	_get_datamsj���
�
���
���zDataSourceEc2._get_datacCsL|jsdS|j�di��di�}|�di���D]\}}d|vr#dSqdS)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_instancecCs|jsdS|j�d�S)Nzami-launch-index)r^r]r<r&r&r'�launch_index�szDataSourceEc2.launch_indexcCs.t|d�stj��|_|jstj��|_|jS)N�_platform_type)�hasattrr-�dsname�lowerrnr<r&r&r'rT�s

zDataSourceEc2.platformcC�dS)Nzlatest/api/tokenr&r<r&r&r'�api_token_route��zDataSourceEc2.api_token_routecCrr)N�21600r&r<r&r&r'�imdsv2_token_ttl_seconds�rtz&DataSourceEc2.imdsv2_token_ttl_secondscCrr)NzX-aws-ec2-metadata-tokenr&r<r&r&r'�imdsv2_token_put_header�rtz%DataSourceEc2.imdsv2_token_put_headercCs
|jdS)Nz-ttl-seconds)rwr<r&r&r'�imdsv2_token_req_header�s
z%DataSourceEc2.imdsv2_token_req_headercCs|j|jgSr1)rwrxr<r&r&r'�imdsv2_token_redact�sz!DataSourceEc2.imdsv2_token_redactcCs�d}|��}|jD]M}|�|j|�}ztj|||jd�}Wntjy7}z
t�	d||�WYd}~q	d}~ww|j
dkrGt�	d|�|S|j
dkrVd}t�	|||j�q	|jS)	aEGet 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�UrlErrorrQrRr)rz�min_metadata_version)r5�url_tmplrz�api_verr*�resp�erFr&r&r'�get_metadata_api_version�s,


���

�z&DataSourceEc2.get_metadata_api_versioncCsd|jtjkr-t|dd�s#|��}tj||j|j|j	|j
d��di�|_|j�d|j
d�S|j
dS)Nr`��
headers_cbr{�exception_cbrL�
instanceIdzinstance-id)rSrr�getattrr�r�get_instance_identityr4r}ry�_refresh_stale_aws_token_cbr]r`r^)r5�api_versionr&r&r'�get_instance_id�s ��
�
zDataSourceEc2.get_instance_idc
Cs�|jtvrdSg}i}|j}d}|D]}d�||�}|�|�|||<qt�d�d}d}|��}	ztj	||	j
|	jtj|j
|j||jdd�	\}}Wn
tjySYnw|r_|r_||_||SdS)aGet 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}zFetching Ec2 IMDSv2 API TokenF)	�urls�max_wait�timeout�	status_cbr�r��request_methodr{�connect_synchronously)rS� IDMSV2_SUPPORTED_CLOUD_PLATFORMSrsr~�appendrQrR�get_url_paramsr�wait_for_url�max_wait_seconds�timeout_seconds�warningr}�_imds_exception_cbryr��
_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	Cst|j}|��}|jdkrdS|�d|j�}dd�|D�}t|�t|�kr2t�dtt|�t|���t	|�r9|}nt�
d�|j}|�|�}|s�|jt
vr�g}i}dj|jd	�}d
}	|D]}
d�|
|�}|�|�|
||<q\t��}tj||j|jtj
|j|j|	d�\}
}
|
r�||
}|r�||_t�d
|j�t|�S|jt
vr�t�
d�t|�St�d|tt��|��t|�S)NrF�
metadata_urlscSsg|]	}t�|�r|�qSr&)r�is_resolvable_url)�.0�xr&r&r'�
<listcomp>Dsz;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��setrQrR�list�lenr�r�rSr�r~r�r��timerr�r�ryr}r4�critical�int�bool)r5�mcfgr�r��filteredr4r�r�r�r�r*r��
start_time�_r&r&r'�wait_for_metadata_service;sn
�

���


�


�
��z'DataSourceEc2.wait_for_metadata_servicecCs�d|jvrdSd}|jd}t|t�st�d|�dS|��D]\}}||kr+|}n|dkr5|dkr5|}q|durBt�d|�dS|}|�d�sMd|}tj�	|�rU|S|�
tj�|��}|rit�d||�|S|dkrodS|S)	Nzblock-device-mappingz+block-device-mapping not a dictionary: '%s'�	ephemeral�
ephemeral0z Unable to convert %s to a device�/z/dev/%szRemapped device name %s => %s)r^�
isinstance�dictrQrRrh�
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_devicecCsLz|jtjkr|j�d|jdd�WS|jddWSty%YdSw)N�availabilityZone�	placementzavailability-zone)rSrrr`r]r^�KeyErrorr<r&r&r'�availability_zone�s��zDataSourceEc2.availability_zonecCsR|jtjkr|j�d�}|jr|s|jdd�}|S|j}|dur'|dd�SdS)N�region���)rSrrr`r]r�)r5r��azr&r&r'r��s
zDataSourceEc2.regioncCs0|sdS|jtjkrtt�|tt�|�dSdSr1)rSrr$�warn_if_necessaryrrNrOrP)r5�cfg�is_new_instancer&r&r'�activate�s��zDataSourceEc2.activatecCs�|jtjkr	|jS|jdurt�d�dSd}td|jvo"|jtj	k�}|r5t�
d�tjtj
d|j
d�|j}|j�d�}t|t�rpt||t�|jdd�d	�}|��rot�|j�|_|jtj�tj�|jtj�tj�nt�d
|�||_|jS)z@Return a network config dict for rendering ENI or netplan files.Nz8Unexpected call to network_config when metadata is None.rezPMetadata 'network' not present: Refreshing stale metadata from prior to upgrade.zRe-crawl of metadata servicerD�apply_full_imds_network_configT)�fallback_nic�full_network_configz%Metadata 'network' key not valid: %s.)�_network_configr�UNSETr^rQr�r�rSrrrRrrZ�get_datarWr]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
�

���
��
����zDataSourceEc2.network_configcs>|jdurt|dd�}|r||_d|_|jStt|�jS|jS)Nr�)�_fallback_interfacer�r�r2r-rW)r5�
_legacy_fbnicr9r&r'rWs
�z DataSourceEc2.fallback_interfacecCs|��siS|��}|j}i}|jtvr|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<Wntyzt�td|j�iYSw||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_cbrHrKrJz'Failed reading from metadata address %s�_metadata_api_version)r�r�ryrSr�r��#_skip_or_refresh_stale_aws_token_cbrr#r,r�get_instance_userdatar4r}�get_instance_metadatarr��	Exceptionr�logexcrQ)r5r��redact�crawled_metadata�exc_cb�	exc_cb_ud�skip_cbr`r&r&r'r[%sb

�
�����zDataSourceEc2.crawl_metadatac
Cs�|jtvrdS|dur|j}t�d�|j|i}d�|j|j�}zt	j
|||jdd�}W|jSt	jyI}zt�
d||�WYd}~dSd}~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�)rzr{r�z/Unable to get API token: %s raised exception %s)rSr�rvrQrRrxr~r4rsrr�ryr�r��contents)r5�seconds�request_header�	token_urlr�r�r&r&r'�_refresh_api_token\s,


�����z DataSourceEc2._refresh_api_tokencCs$t�tj||�}|sdS|�||�S)zSCallback will not retry on SKIP_USERDATA_CODES or if no token
        is available.F)r�skip_retry_on_codes�SKIP_USERDATA_CODESr�)r5rFr+�retryr&r&r'r�ys�z1DataSourceEc2._skip_or_refresh_stale_aws_token_cbcCs*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�rr�r)rQrRr��r5rFr+r&r&r'r��s
z)DataSourceEc2._refresh_stale_aws_token_cbcCsNt|tj�r!|jr#|jdkr%|jdkrt�d�|�t�d�|�dSdSdS)a2Fail 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�rr�r)rQr�rr&r&r'r��s

����z DataSourceEc2._imds_exception_cbrCcCsN|jtvriS|j|ji}|j|vr|S|js!|��|_|js!iS|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.
        )rSr�rxrvrsr�rrw)r5r*�request_token_headerr&r&r'r}�s
�

zDataSourceEc2._get_headersr1)rC)6rrrrpr�r�r.r�str�__annotations__�url_max_wait�url_timeoutr�rr�r�rUr
r�r�BOOT_NEW_INSTANCEr�r��HOTPLUG�supported_update_eventsr3r=rdrl�propertyrmrTrsrvrwrxryr�r�r�r�r�r�r�r�r�rWr[rr�r�r�r}�
__classcell__r&r&r9r'r-:sn
��	8

	




2I3


	
<
7

r-cs$eZdZdZdZ�fdd�Z�ZS)�DataSourceEc2LocalayDatasource 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.
    Tcs8tjtjf}|j|vrt�d||j�dStt|���S)Nz+Local Ec2 mode only supported on %s, not %sF)	rrr#rSrQrRr2rr�)r5�supported_platformsr9r&r'r��s
�zDataSourceEc2Local.get_data)rrr�__doc__rUr�rr&r&r9r'r�src
Cs>zt|�WSty}z
t�|�|WYd}~Sd}~wwr1)�parse_strict_mode�
ValueErrorrQr�)�cfgval�defaultr�r&r&r'rM�s

��rMc
Cs�|durdS|durdS|sdS|�d�\}}}|dvr$td||f��|rEz	t|�}W||fStyD}z	td	||f�|�d}~wwd}||fS)
NT)r>NF)�falseN)rr�,)r>rrzUInvalid 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)�	partitionrr�)r�moder��sleepr�r&r&r'r�s:��
	������rc
Csdzt|�\}}Wnty }zt�|�WYd}~dSd}~ww|dkr'dStjd|d|d�dS)Nr�
non_ec2_mdT)rr)rrrQr�r	�show_warning)rr�rrr�r&r&r'r��s
��r�cC�|ddkr	tjSdS)N�product_namezAlibaba Cloud ECS)rr��datar&r&r'�identify_aliyun��r"cCs4|d�d�r|ddks|d|dkrtjSdS)N�uuidr�uuid_source�
hypervisor�serial)r�rrr r&r&r'�identify_awss
��r(cC�|d�d�r
tjSdS)Nr'z.brightbox.com)�endswithrr r r&r&r'�identify_brightbox��r+cCr))N�	asset_tagz
.zstack.io)r*rr!r r&r&r'�identify_zstackr,r.cCr)N�vendorr)rr"r r&r&r'�identify_e24cloud$r#r0cCs.|dd��kr|dd��krtjSdSdS)Nrz3DS Outscale VMr/z3DS Outscale)rqrr#r r&r&r'�identify_outscale)s���r1cCsxt�}ttttttdd�f}|D])}z
||�}|r|WSWqty9}zt�	d|||�WYd}~qd}~wwdS)NcSstjSr1)rr$)r�r&r&r'�<lambda>;sz#identify_platform.<locals>.<lambda>z'calling %s with %s raised exception: %s)
�_collect_platform_datar(r+r.r0r1r"r�rQr�)r!�checks�checkerr�r�r&r&r'r;1s,�	
�����r;cCs�i}z
t�d���}d|d<Wnty!t�d�}d|d<Ynw|dur(d}|��|d<t�d	�}|dur9d}|��|d
<t�d�}|durJd}|��|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%zsystem-uuidrNrCr$zsystem-serial-numberr'zchassis-asset-tagr-zsystem-manufacturerr/zsystem-product-namer)r�	load_file�stripr�r�
read_dmi_datarq)r!r$r'r-r/rr&r&r'r3Hs0
�



r3TcCszdid�}|st��}|dd}|sC|��D]
\}}||kr!nqddd|��i|d�}|�|�}	|	�d	�r;d|d
<||d|<|Sd}
t|���D]K\}}|�|�}	|	sWqKt|	�d
|
��d}
d|
di}d|dd|��i|d�}|	�d	�r�d|d
<||d<t|	|�|d<|ds�|�d�||d|<qKt	|d�dkr�|d�
�D]}|d|�d�|d|�dd�q�|S)aConvert 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�	ethernetsrfrgTF�
macaddress)�dhcp4�dhcp6�match�set-name�ipv6sr>r;rz
device-number�zroute-metric�d)r=�dhcp4-overridesr>r?r@zdhcp6-overrides�	addressesrDN)r�get_interfaces_by_macrhrqr]�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�wsX
�
�



�

r�cCs�|�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
    zlocal-ipv4srArBzsubnet-ipv4-cidr-block�24zsubnet-ipv6-cidr-block�128)r]r�r�r�r��extend�_get_secondary_addressesrG)rRrO�ipv4srArEr&r&r'rH�s 


��
��rHc
Cs�g}|�|�}|}|rt|�d��dkr'd|vrdnd}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�r9r?r@zJCould not parse %s %s for mac %s. %s network config prefix defaults to /%srBNz
{ip}/{prefix})�ip�prefix)r]r��splitrQr�r�r~)
rR�cidr_keyrO�ips�default_prefixrE�cidrr[�ip_typerZr&r&r'rX�s"
�
rXcCst�|t�Sr1)r�list_from_depends�datasources)�dependsr&r&r'�get_datasource_list�sre)NNT):r�r�r��typingr�	cloudinitrr�loggingrrrrrr	�cloudinit.eventr
r�cloudinit.net.dhcpr�cloudinit.net.ephemeralr
�cloudinit.sources.helpersr�	getLoggerrrQ�	frozenset�	NOT_FOUND�SKIP_METADATA_URL_CODESrOrPrr,rrr��
DataSourcer-rrMrr�r"r(r+r.r0r1r;r3r�rHrX�DEP_FILESYSTEM�DEP_NETWORKrcrer&r&r&r'�<module>s\

	!

0
�I
�