U ӇgV@sdZddlZddlZddlmZddlmZmZmZm Z m Z m Z m Z ddl mZddlmZddlmZmZddlmZddlmZmZeeZGdd d ZGd d d ZGd d d ZGdddZe ee efe e dddZ!dS)z.Module for ephemeral network context managers N)partial)AnyCallableDictListLiteralOptionalTuple)NoDHCPLeaseErrormaybe_perform_dhcp_discovery)ProcessExecutionError)UrlError wait_for_urlc@sHeZdZdZdedddZddZdd Zd d Zd d Z ddZ dS)EphemeralIPv4NetworkaContext manager which sets up temporary static network configuration. No operations are performed if the provided interface already has the specified configuration. This can be verified with the connectivity_urls_data. If unconnected, bring up the interface with valid ip, prefix and broadcast. If router is provided setup a default route for that interface. Upon context exit, clean up the interface leaving no configuration behind. N)interface_addrs_before_dhcpc Cst||||gs$td||||zt||_Wn2tk rf} ztd| | W5d} ~ XYnX||_||_||_||_ ||_ g|_ ||_ |jd|j|_ ||ji|_dS)aSetup context manager and validate call signature. @param interface: Name of the network interface to bring up. @param ip: IP address to assign to the interface. @param prefix_or_mask: Either netmask of the format X.X.X.X or an int prefix. @param broadcast: Broadcast address for the IPv4 network. @param router: Optionally the default gateway IP. @param static_routes: Optionally a list of static routes from DHCP z5Cannot init network on {0} with {1}/{2} and bcast {3}z4Cannot setup network, invalid prefix or netmask: {0}N/)all ValueErrorformatnetZipv4_mask_to_net_prefixprefix interfaceip broadcastrouter static_routes cleanup_cmdsdistrocidrgetr) selfrrrprefix_or_maskrrrrer#9/usr/lib/python3/dist-packages/cloudinit/net/ephemeral.py__init__s>zEphemeralIPv4Network.__init__c Cszpz |Wn@tk rN}z"dt|jkr>dt|jkr>W5d}~XYnX|jr`|n|jrn|Wn$tk r|dddYnXdS)zSet up ephemeral network if interface is not connected. This context manager handles the lifecycle of the network interface, addresses, routes, etc z File existszAddress already assignedN) _bringup_devicer strstderrr_bringup_static_routesr_bringup_router__exit__)r r"r#r#r$ __enter__Ns"    zEphemeralIPv4Network.__enter__cCs|jD] }|qdS)zTeardown anything we set up.N)r)r excp_type excp_valueexcp_tracebackcmdr#r#r$r+rs zEphemeralIPv4Network.__exit__cCs:td|j|j|jt|ji}|d}|jd}|j dd|diDk}|j dd|jdiDk}|rtd|j|j n|j j |j|j|j|rtd|jn|j j j |jd d |rtd |jn|jt|j j j|jd d |rtd |j n|jt|j j j|j|jd S)afPerform the ip commands to fully set up the device. Dhcp clients behave differently in how they leave link state and ip address assignment. Attempt assigning address and setting up link if needed to be done. Set cleanup_cmds to return the interface state to how it was prior to execution of the dhcp client. z:Attempting setup of ephemeral network on %s with %s brd %supcSsg|]}|dqSrr.0rr#r#r$ sz8EphemeralIPv4Network._bringup_device..ipv4cSsg|]}|dqSr2r3r4r#r#r$r6sz1Skip adding ip address: %s already has address %sz9Skip bringing up network link: interface %s is already upZinet)ZfamilyzLNot queueing link down: link [%s] was up prior before receiving a dhcp leasezSNot queueing address removal: address %s was assigned before receiving a dhcp leaseN)LOGdebugrrrnetinfo netdev_inforrrrnet_opsZadd_addrlink_uprappendrZ link_downZdel_addr)r Zinterface_addrs_after_dhcpZhas_linkZhad_linkZhas_ipZhad_ipr#r#r$r&wsv       z$EphemeralIPv4Network._bringup_devicec CsJ|jD]>\}}|jj|j|||jdt|jjj|j||dqdS)Nrgateway) rrr<Z append_routerrinsertr del_route)r Z net_addressr@r#r#r$r)sz+EphemeralIPv4Network._bringup_static_routesc Cs|jj}d|kr,td|j|dS|jjj|j|j|j d|j dt |jjj |j|j|j d|jjj|jd|jd|j dt |jjj |jddS)z  z$EphemeralIPv4Network._bringup_router)NN) __name__ __module__ __qualname____doc__dictr%r,r+r&r)r*r#r#r#r$rs 0$Irc@s(eZdZdZddZddZddZdS) EphemeralIPv6NetworkzContext manager which sets up a ipv6 link local address The linux kernel assigns link local addresses on link-up, which is sufficient for link-local communication. cCs"|std|||_||_dS)zSetup context manager and validate call signature. @param interface: Name of the network interface to bring up. @param ip: IP address to assign to the interface. @param prefix: IPv6 uses prefixes, not netmasks zCannot init network on {0}N)rrrr)r rrr#r#r$r%szEphemeralIPv6Network.__init__cCs&t|jddkr"|jj|jdS)zlinux kernel does autoconfiguration even when autoconf=0 https://www.kernel.org/doc/html/latest/networking/ipv6.html Z operstater1N)rZ read_sys_netrrr<r=r r#r#r$r, szEphemeralIPv6Network.__enter__cGsdS)z%No need to set the link to down stateNr#r Z_argsr#r#r$r+szEphemeralIPv6Network.__exit__N)rFrGrHrIr%r,r+r#r#r#r$rKs rKc@s\eZdZdeeeeefdddZddZ ddZ d d Z d d Z d dZ ddZdS)EphemeralDHCPv4Nconnectivity_urls_datacCs6||_d|_d|_||_|pg|_||_t|_dSN) iface_ephipv4lease dhcp_log_funcrPrr:r;r)r rrRrPrUr#r#r$r%s zEphemeralDHCPv4.__init__cCs&t|j}rtd|dS|S)zUSetup sandboxed dhcp context, unless connectivity_url can already be reached.z:Skip ephemeral DHCP setup, instance has connectivity to %sN)_check_connectivity_to_imdsrPr8r9 obtain_lease)r Zimds_reached_at_urlr#r#r$r,(szEphemeralDHCPv4.__enter__cCs |dS)z Teardown sandboxed dhcp context.N) clean_network)r r-r.r/r#r#r$r+7szEphemeralDHCPv4.__exit__cCs d|_|jr|jddddS)z@Exit _ephipv4 context to teardown of ip configuration performed.N)rTrSr+rLr#r#r$rX;szEphemeralDHCPv4.clean_networkcCs|jr |jSt|j|j|j|_|js,ttd|jd|jd|jddddddddd gd d }||}|d st |d |d|d <|dr|jj |d|d<t |jfd|ji|}|||_|jS)a9Perform dhcp discovery in a sandboxed environment if possible. @return: A dict representing dhcp options on the most recent lease obtained from the dhclient discovery if run, otherwise an error is raised. @raises: NoDHCPLeaseError if no leases could be obtained. z#Received dhcp lease on %s for %s/%srz fixed-addressz subnet-maskzbroadcast-addresszrfc3442-classless-static-routeszclassless-static-routesrz unknown-121Zrouters)rrr!rrrrr!rr)rTr rrRrUr r8r9extract_dhcp_options_mappingrZmask_and_ipv4_to_bcast_addrZ dhcp_clientZparse_static_routesrrr,rS)r nmapkwargsZephipv4r#r#r$rWAs^  zEphemeralDHCPv4.obtain_leasecCsDi}|D]2\}}t|tr.||||q |j|||<q |SrQ)items isinstancelistget_first_option_valuerTr)r rZresultZinternal_referencelease_option_namesr#r#r$rYxs z,EphemeralDHCPv4.extract_dhcp_options_mappingcCs(|D]}||s|j|||<qdSrQ)rrT)r Zinternal_mappingrar`Zdifferent_namesr#r#r$r_s z&EphemeralDHCPv4.get_first_option_value)NNN)rFrGrHrrrr'rr%r,r+rXrWrYr_r#r#r#r$rNs 7 rNc@sdeZdZdZdeeeeeee fdddZ dd Z e d e eeefd d d ZddZdS)EphemeralIPNetworkahCombined ephemeral context manager for IPv4 and IPv6 Either ipv4 or ipv6 ephemeral network may fail to initialize, but if either succeeds, then this context manager will not raise exception. This allows either ipv4 or ipv6 ephemeral network to succeed, but requires that error handling for networks unavailable be done within the context. FTN)ipv6r7rPcCs2||_||_||_t|_d|_||_||_dS)a Args: distro: The distro object interface: The interface to bring up ipv6: Whether to bring up an ipv6 network ipv4: Whether to bring up an ipv4 network connectivity_urls_data: List of url data to use for connectivity check before attempting to bring up ephemeral networks. If connectivity can be established to any of the urls, then the ephemeral network setup is skipped. N) rr7rc contextlib ExitStackstack state_msgrrP)r rrrcr7rPr#r#r$r%s zEphemeralIPNetwork.__init__cCs|js|js|Sg}d}t|j}r6td||Std|jrl|jdd\}}||O}|rl|||jr|jdd\}}||O}|r|||jr|s|jsd|_|st d|d |S) NFz:We already have connectivity to IMDS at %s, skipping DHCP.z/No connectivity to IMDS, attempting DHCP setup.r7) ip_versionrczusing link-local ipv6zGFailed to bring up EphemeralIPNetwork. Datasource setup cannot continuer) r7rcrVrPr8r9 _perform_ephemeral_network_setupr>rherror)r exceptionsZephemeral_obtainedZimds_urlZipv4_ephemeral_obtainedZipv4_exceptionZipv6_ephemeral_obtainedZipv6_exceptionr#r#r$r,sB      zEphemeralIPNetwork.__enter__)r7rc)rireturnc Cszf|dkr$|jt|j|jdn.|dkrD|jt|j|jntd|td|j|WdSt t fk r}z td|j|d|fWYSd }~XYnXd S) a Attempt to bring up an ephemeral network for the specified IP version. Args: ip_version (str): The IP version to bring up ("ipv4" or "ipv6"). Returns: Tuple: A tuple containing: - a boolean indicating whether an ephemeral network was successfully obtained - an optional exception if ephemeral network setup failed or None if successful r7)rrRrczUnsupported IP version: z7Successfully brought up %s for ephemeral %s networking.)TNz2Failed to bring up %s for ephemeral %s networking.FN) rg enter_contextrNrrrKrr8r9r r )r rir"r#r#r$rjs:z3EphemeralIPNetwork._perform_ephemeral_network_setupcGs|jdSrQ)rgcloserMr#r#r$r+szEphemeralIPNetwork.__exit__)FTN)rFrGrHrIboolrrrr'rr%r,rr Exceptionrjr+r#r#r#r$rbs  6 1rb)rPrmc sfdd}stddStddDp2d}z$tdd D||d d d \}}Wn.tk r}ztd |W5d}~XYnX|stddS|SdS)a Perform a connectivity check to the provided URLs to determine if the ephemeral network setup is necessary. This function attempts to reach one of the provided URLs and returns the URL that was successfully reached. If none of the URLs can be reached, it returns None. The timeout for the request is determined by the highest timeout value provided in the connectivity URLs data. If no timeout is provided, a default timeout of 5 seconds is used. Args: connectivity_urls_data: A list of dictionaries, each containing the following keys: - "url" (str): The URL to check connectivity for. - "headers" (dict, optional): Headers to include in the request. - "timeout" (int, optional): Timeout for the request in seconds. Returns: Optional[str]: The URL that was successfully reached, or None if no connectivity was established. csfddDd}|S)z Helper function to get headers for a given URL from the connectivity URLs data provided to _check_connectivity_to_imds. cs"g|]}|dkr|dqSurlZheadersr3r5Zurl_datarsr#r$r68s zD_check_connectivity_to_imds.._headers_cb..rr#rrrOrur$ _headers_cb3s  z0_check_connectivity_to_imds.._headers_cbzZNo connectivity URLs provided. Skipping connectivity check before ephemeral network setup.Ncss|]}|ddVqdS)timeoutrNr3rtr#r#r$ Hsz._check_connectivity_to_imds..cSsg|] }|dqSrur#rtr#r#r$r6Nsz/_check_connectivity_to_imds..Fr)ZurlsZ headers_cbrwZconnect_synchronouslyZmax_waitz8Failed to reach IMDS without ephemeral network setup: %sz5Failed to reach IMDS without ephemeral network setup.)r8r9maxrr )rPrvrwZurl_that_worked_r"r#rOr$rVs6   rV)"rIreZlogging functoolsrtypingrrrrrrr Z cloudinit.netrZcloudinit.netinfor:Zcloudinit.net.dhcpr r Zcloudinit.subpr Zcloudinit.url_helperr rZ getLoggerrFr8rrKrNrbr'rVr#r#r#r$s& $    f s