o
    f                    @   s  d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlm	Z	 d dl
mZ d dlmZ d dlmZmZmZmZmZmZmZmZmZmZ d dlm  m  mZ d dlmZmZm Z mZm!Z!m"Z"m#Z#m$Z$m%Z%m&Z& d dl'm(Z(m)Z) d dl*m+Z+ d d	l,m-Z- d d
l.m/Z/ d dl0m1Z1 d dl2m3Z3m4Z4m5Z5 d dl6m7Z7 d dl8m9Z9 d dl:m;Z; dZ<dgdgdgddgddgddgdgdgg dg ddgdd gd!Z=e>e?Z@eAd"ZBg d#ZCejDejE d$ ZFeeeG ee eeeG  eeeGeeG f  eeeGeeG ef  f ZHG d%d& d&eIZJG d'd( d(e!jKe jLd)ZMd*eGd+eNfd,d-ZOd*eGfd.d/ZPde&jQfd0d1ZRd2d3 ZSd4eGd5eeM fd6d7ZT	9d>d:d;ZUd<d= ZVdS )?    N)defaultdict)suppress)StringIO)
AnyDictListMappingMutableMappingOptionalSetTupleTypeUnion)
helpersimporter	lifecyclenetpersistencessh_utilsubp
temp_utils
type_utilsutil)LinuxNetworking
Networking)PackageManager)known_package_managers)hosts)+ALLOW_EC2_MIRRORS_ON_NON_AWS_INSTANCE_TYPES)
activatorsdhcp	renderers)NetOps)parse_net_config_data)Rendererallalpineaoscarchdebianubuntufreebsd	dragonflygentoocosnetbsdopenbsd)	almalinuxamazon
azurelinuxcentos
cloudlinux	eurolinuxfedoramarinermiraclelinuxopenmandrivaphotonrhelrocky	virtuozzo)opensusezopensuse-leapzopensuse-microoszopensuse-tumbleweedsle_hpcz	sle-microslessuse	openeulerOpenCloudOS	TencentOS)r&   r'   r(   r)   r+   r-   r/   r0   redhatrB   rC   rD   z#^[a-z][a-z]-(?:[a-z]+-)+[0-9][a-z]$)chronyzsystemd-timesyncdntpntpdate-c                   @   s   e Zd ZdS )PackageInstallerErrorN)__name__
__module____qualname__ rO   rO   </usr/lib/python3/dist-packages/cloudinit/distros/__init__.pyrK      s    rK   c                   @   sr  e Zd ZU dZdZdZdZdZdZdZ	dZ
d	d
gZdZdZdgZi Zeeeeef f ed< dZeZee ed< ddddZejZee ed< dZdZ dZ!eed< dZ"e#e ed< dZ$e#e ed< dd Z%de&ddfd d!Z'd"d# Z(d$e)de*e+ee, e-f e-f fd%d&Z.d$e)fd'd(Z/e0de1j2fd)d*Z3e0de#ee4j5  fd+d,Z6e0de7fd-d.Z8d/e7fd0d1Z9d2d3 Z:dd4d5Z;dd6d7Z<dd8d9Z=e>d:d; Z?e@jAdd<d=ZBdd>d?d@ZCdAdB ZDddCdDZEddEdFZFdGdH ZGddeHfdIdJZIe@jAddKdLZJe@jAdMdN ZKdOdP ZLdQdR ZMe@jAddSdTZNe@jAdUdV ZOe@jAdWdX ZPdYdZ ZQd[d\ ZRe>d]d^ ZSd_d` ZTdadb ZUe0dcdd ZVdedf ZWdeHfdgdhZXdidj ZYdeHfdkdlZZdmdn Z[dodp Z\dqefdrdsZ]dtdu Z^ddvdwZ_dxe`dyeHfdzd{Zad|d} Zbdd~dZcdddZddddZedddZfegdd ZhegdddZiegdddededefddZjdedededefddZkdefddZldde`dedefddZme>dededededede`fddZne0dd Zoeojpdd Zoe>de&de#e& fddZqe>de&de#e& fddZre>de&de&de#e& fddZse>deddfddZte>dede#e fddZue>dedevfddZwdS )Distrozpython3-pipz/usr/libz
/etc/hostsz/etc/doas.confz"/etc/sudoers.d/90-cloud-init-usersz/etc/hostnamez/etc/shadowz/var/lib/extrausers/shadowz^{username}::z^{username}:!:z/usr/share/zoneinfoz	root:rootservicerenderer_configsNnetworking_clsz-Hz-Pz-r)haltpoweroffrebootnet_ops   Fz/etc/resolv.confosfamilydhclient_lease_directorydhclient_lease_file_regexc                 C   sT   || _ || _|| _|  | _tj| _tj	| _
t|| _g | _d | _d | _d| _d S )NT)_paths_cfgnamerT   
networkingr    ALL_DHCP_CLIENTSdhcp_client_priorityiproute2Iproute2rX   r   Runners_runnerpackage_managers_dhcp_client_fallback_interfaceis_linux)selfr_   cfgpathsrO   rO   rP   __init__   s   

zDistro.__init__ci_pkl_versionreturnc                 C   sT   d| j vs	| jj s|  | _t| dsd| _t| dsd| _t| ds(d| _dS dS )z)Perform deserialization fixes for Distro.r`   rh   Nri   rj   T)__dict__r`   rT   hasattrrh   ri   rj   )rk   ro   rO   rO   rP   	_unpickle   s   




zDistro._unpicklec                 C   s8   t |tr|S t |ttfrt|dkrt|S td)N   z?Invalid 'packages' yaml specification. Check schema definition.)
isinstancestrlisttuplelen
ValueError)rk   entryrO   rO   rP   _validate_entry   s   
zDistro._validate_entrypkglistc                 C   s   t t}t }|D ]=}t|tr>| D ](\}}|D ]!}| |}z|t|  | W q ty;   t	
d| Y qw qq	|| | q	t||fS )zTransform the generic package list to package by package manager.

        Additionally, include list of generic packages
        zLCannot install packages under '%s' as it is not a supported package manager!)r   setru   dictitemsr|   r   addKeyErrorLOGerror)rk   r}   packages_by_managergeneric_packagesr{   package_managerpackage_list
definitionrO   rO   rP   _extract_package_by_manager   s,   

z"Distro._extract_package_by_managerc                 C   s   d}|  |\}}t }| jD ]?}||jt }||B }|| | s3td|j	 |
| q|s6q||}	|
|	 |	rHt||	 t|	| }q| D ]\}
}|
j	dd | jD v rcqS|
|
| j| jj|d qS|r{t|| d S )NzcFailed to install the following packages: %s. See associated package manager logs for more details.z"Package manager '%s' not availablec                 S   s   g | ]}|j qS rO   )r_   ).0prO   rO   rP   
<listcomp>      z+Distro.install_packages.<locals>.<listcomp>)r}   )r   r~   rg   get	__class__difference_update	availabler   debugr_   updateinstall_packagesinfor   from_configrf   r^   rK   )rk   r}   error_messager   r   total_failedmanagermanager_packagesto_tryfailedmanager_typepackagesrO   rO   rP   r      sJ   	




zDistro.install_packagesc              	   C   s   | j r| j S | j}t| jdg }|r<g }td| |D ]}tjD ]}||j	kr0|
|  nq"td| q|r<|}|D ]%}z| | _ td|j	 | j W   S  tjfyc   td|j	 Y q>w t )a  access the distro's preferred dhcp client

        if no client has been selected yet select one - uses
        self.dhcp_client_priority, which may be overridden in each distro's
        object to eliminate checking for clients which will not be provided
        by the distro
        )networkrb   z.Using configured dhcp client priority list: %sz4Configured dhcp client %s is not supported, skippingzDHCP client selected: %szDHCP client not found: %s)rh   rb   r   get_cfg_by_pathr^   r   r   r    ra   client_nameappendwarningNoDHCPLeaseMissingDhclientError)rk   rb   config_priorityfound_clientsclient_configuredclient_classclientrO   rO   rP   dhcp_client#  sD   	


	zDistro.dhcp_clientc                 C   s6   t | jdd}ztj|dW S  tjy   Y dS w )z=Return the configured network activator for this environment.)r   r   Npriority)r   r   r^   r   select_activatorNoActivatorException)rk   r   rO   rO   rP   network_activator_  s   zDistro.network_activatorc                 C   sD   t | jdd }tj|d\}}td|| || j|d}|S )N)r   r!   r   z-Selected renderer '%s' from priority list: %s)config)	r   r   r^   r!   selectr   r   rS   r   )rk   r   r_   
render_clsrendererrO   rO   rP   network_rendererj  s   zDistro.network_rendererr   c                 C   s   | | d S N)render_network_state)rk   network_stater   rO   rO   rP   _write_network_statew     zDistro._write_network_statec                 C   s4   t j| jt|}t j|std||f |S )Nz(Invalid timezone %s, no file found at %s)ospathjointz_zone_dirrv   isfileIOError)rk   tztz_filerO   rO   rP   _find_tz_filez  s   
zDistro._find_tz_filec                 C   s   | j ||S r   )r^   r   )rk   opt_namedefaultrO   rO   rP   
get_option  r   zDistro.get_optionc                 C   s   || j |< d S r   )r^   )rk   r   valuerO   rO   rP   
set_option  r   zDistro.set_optionc                 C   s(   |  ||}| || j | | d S r   )_select_hostname_write_hostnamehostname_conf_fn_apply_hostname)rk   hostnamefqdnwriteable_hostnamerO   rO   rP   set_hostname  s   zDistro.set_hostnamec                   C   s   t  S )z?Wrapper to report whether this distro uses systemd or sysvinit.)uses_systemdrO   rO   rO   rP   r     s   zDistro.uses_systemdc                 C      t  r   NotImplementedError)rk   commandargspkgsrO   rO   rP   package_command  s   zDistro.package_commandforcec                C   sl   | j D ]0}| std|j qz|j|d W q ty3 } ztd|j| W Y d }~qd }~ww d S )Nz8Skipping update for package manager '%s': not available.r   z%Failed to update package using %s: %s)rg   r   r   r   r_   update_package_sources	Exceptionr   )rk   r   r   erO   rO   rP   r     s    
zDistro.update_package_sourcesc                 C   s   t  d }|dv rdS |S )N   )i386i486i586i686r   )r   uname)rk   r(   rO   rO   rP   get_primary_arch  s   zDistro.get_primary_archc                 C   s"   |  dg }|s|  }t||S )Npackage_mirrors)r   r   _get_arch_package_mirror_info)rk   r(   mirror_inforO   rO   rP   r     s   
z$Distro._get_arch_package_mirror_infoc                 C   s   |  |}t||dS )N)data_sourcer   )r   _get_package_mirror_info)rk   r(   r   	arch_inforO   rO   rP   get_package_mirror_info  s   
zDistro.get_package_mirror_infoc                 C   s   t  S r   )r   generate_fallback_configrk   rO   rO   rP   r     s   zDistro.generate_fallback_configc                 C   s`   | j }t||d}| || |r)td | j}|s"td dS || dS td dS )a  Apply the network config.

        If bring_up is True, attempt to bring up the passed in devices. If
        devices is None, attempt to bring up devices returned by
        _write_network_config.

        Returns True if any devices failed to come up, otherwise False.
        )r   z/Bringing up newly configured network interfacesz>No network activator found, not bringing up network interfacesTz3Not bringing up newly configured network interfacesF)r   r#   r   r   r   r   r   bring_up_all_interfaces)rk   	netconfigbring_upr   r   r   rO   rO   rP   apply_network_config  s   	


zDistro.apply_network_configc                 C   r   r   r   )rk   localeout_fnrO   rO   rP   apply_locale     zDistro.apply_localec                 C   r   r   r   )rk   r   rO   rO   rP   set_timezone  r   zDistro.set_timezonec                 C   s   dS )Nz	127.0.0.1rO   r   rO   rO   rP   _get_localhost_ip  s   zDistro._get_localhost_ipc                 C   r   r   r   r   rO   rO   rP   
get_locale  s   zDistro.get_localec                 C   r   r   r   )rk   filenamer   rO   rO   rP   _read_hostname  r   zDistro._read_hostnamec                 C   r   r   r   )rk   r   r   rO   rO   rP   r     r   zDistro._write_hostnamec                 C   r   r   r   r   rO   rO   rP   _read_system_hostname  r   zDistro._read_system_hostnamec                 C   sF   t d| z
td|g W d S  tjy"   tt d| Y d S w )Nz2Non-persistently setting the system hostname to %sr   z;Failed to non-persistently adjust the system hostname to %s)r   r   r   ProcessExecutionErrorr   logexc)rk   r   rO   rO   rP   r     s   
zDistro._apply_hostnamec                 C   s&   t | jd| jr|r|S |s|S |S )Nprefer_fqdn_over_hostname)r   get_cfg_option_boolr^   prefer_fqdn)rk   r   r   rO   rO   rP   r     s   
zDistro._select_hostnamec                 C   s6   g }| D ]}|t vrtd||t |  q|S )Nz&No distributions found for osfamily {})
OSFAMILIESrz   formatextend)family_listdistrosfamilyrO   rO   rP   expand_osfamily  s   zDistro.expand_osfamilyc           
   
   C   s  |}|  ||}|rtj|r| |}nd }|  \}}g }|r&||kr+|| |r5||kr:||kr:|| |rK|rK||krKtd|| d S t	dd |D }t
d|t| |D ]}	z| ||	 W q_ tyz   ttd||	 Y q_w ||v r| | d S d S )Nz6%s differs from %s, assuming user maintained hostname.c                 S   s   g | ]}|r|qS rO   rO   )r   frO   rO   rP   r   L      z*Distro.update_hostname.<locals>.<listcomp>z/Attempting to update hostname to %s in %s filesz!Failed to write hostname %s to %s)r   r   r   existsr   r   r   r   r   r~   r   ry   r   r   r   r   r   )
rk   r   r   prev_hostname_fnapplying_hostnameprev_hostnamesys_fnsys_hostnameupdate_filesfnrO   rO   rP   update_hostname  sH   

zDistro.update_hostnamec                 C   sz  d}t j| jrtt| j}ntd}tjdd}| 	 }|
|}d}|s5|||| d}ndd}|D ]*}d }	g }
t|dkrI|d }	t|dkrU|dd  }
|	d urc|	|krc||
v rcd}q9|rt|}|||g || |D ] }t|dkr|||d  qxt|dkr|j|g|R   qx|rt }|r|d	|  |d	|  tj| j| d
d d S d S )N addedbaseFTrY   r   rt   z%s
i  mode)r   r   r
  hosts_fnr   	HostsConfr   load_text_filemake_headerr   	get_entry	add_entryry   rw   r   del_entriesr   write
write_filegetvalue)rk   r   r   headerehlocal_ip	prev_infoneed_changer{   
entry_fqdnentry_aliasesnew_entriescontentsrO   rO   rP   update_etc_hosts`  sP   


zDistro.update_etc_hostsc                 C   s   | j stt| _ | j S )z7Allow distro to determine the preferred ntp client list)_preferred_ntp_clientsrw   PREFERRED_NTP_CLIENTSr   rO   rO   rP   preferred_ntp_clients  s   
zDistro.preferred_ntp_clientsc                 C   s
   |  dS )Ndefault_user)r   r   rO   rO   rP   get_default_user  s   
zDistro.get_default_userc                 K   sv  t |rtd| dS d|v r|d}nd}d|g}d|g}t  r/|d |d ddd	d
ddddddd
}dddd}dg}|d}	|	rt|	t	rV|	
d}	t|	trgtjd| dddd dd |	D }	d|	|d< |d }
|
r|	|
 |r|	r|	D ]}t |s| | td!|| qd"| v rt	|d" |d"< t| D ]D\}}||v r|rt|t	r||| |g ||v r||| d#g q||| |g q||v r|r|||  |||  q|d$s|d%r
|d& |d& n
|d' |d' td(| z
tj||d) W dS  ty: } z	t td*| |d+}~ww ),z
        Add a user to the system using standard GNU tools

        This should be overridden on distros where useradd is not desirable or
        not available.

        Returns False if user already exists, otherwise True.
        z!User %s already exists, skipping.Fcreate_groupsTuseradd--extrausersz	--commentz--homez--gidz--uidz--groups
--passwordz--shellz--expiredatez
--inactivez--selinux-user)
gecoshomedirprimary_groupuidgroupspasswdshell
expiredateinactiveselinux_userz--no-user-groupz--systemz--no-log-init)no_user_groupsystemno_log_initr;  r:  ,z	The user z) has a 'groups' config value of type dictz22.3z=Use a comma-delimited string or array instead: group1,group2.
deprecateddeprecated_versionextra_messagec                 S   s   g | ]}|  qS rO   strip)r   grO   rO   rP   r     r	  z#Distro.add_user.<locals>.<listcomp>r8  z created group '%s' for user '%s'r9  REDACTEDno_create_homerA  z-Mz-mzAdding user %s)	logstringzFailed to create user %sN)r   is_userr   r   popsystem_is_snappyr   r   ru   rv   splitr   r   	deprecater   is_groupcreate_groupr   keyssortedr   r  r   r   r   )rk   r_   kwargsr2  useradd_cmdlog_useradd_cmduseradd_optsuseradd_flagsredact_optsr:  r8  groupkeyvalr   rO   rO   rP   add_user  s   















zDistro.add_userc              
   K   s   | d}| dd}g d}|r|d || td| ztj||dd\}}td	|| t|}| d
d}	W |	S  tyU }
 z	ttd| |
d}
~
ww )zD
        Add a snappy user to the system using snappy tools
        snapuserknownF)snapzcreate-userz--sudoerz--jsonz--knownzAdding snap user %sT)rM  capturez snap create-user returned: %s:%susernameNzFailed to create snap user %s)	r   r   r   r   r   r   	load_jsonr   r   )rk   r_   rW  ra  rb  create_user_cmdouterrjobjre  r   rO   rO   rP   add_snap_user  s(   




zDistro.add_snap_userc                    s   t  r| j| jg}n| jg}d fdd| jD }|D ]4}tj|s'qt 	|}t
d  d|t
js@td | qtd | t
||t
jrR dS qd	S )
z
        Check whether username exists in shadow files with empty password.

        Support reading /var/lib/extrausers/shadow on snappy systems.
        |c                    s   g | ]}|j  d qS )re  )r  )r   patternrm  rO   rP   r   5  s    
z?Distro._shadow_file_has_empty_user_password.<locals>.<listcomp>^:zUser %s not found in %sz0User %s found in %s. Checking for empty passwordTF)r   rP  shadow_extrausers_fn	shadow_fnr   #shadow_empty_locked_passwd_patternsr   r   r
  r  refindall	MULTILINEr   r   )rk   re  shadow_filesshadow_empty_passwd_reshadow_fileshadow_contentrO   rm  rP   $_shadow_file_has_empty_user_password*  s4   

z+Distro._shadow_file_has_empty_user_passwordc                 K   s  d|v r| j |fi |S | j|fi | }d}d}d}d}d|v r6d}d}|d r4| ||d  nd}d|v rOd}d}|d rM| j||d dd nd}|rf|sed|v r_d}td	| | | }nd|v rtd}d}|d std}|d
dr| | n"|s|r|rtd|| | 	| n|rtd| ntd| d|v r|d r| 
||d  d|v r|d r| ||d  n|d du rtjd| dddd d|v r|d }t|tr|g}nt|trt| }|durt|tttfstdt| g }nt|pg }tt|| d|v rP|dg }	|	s3td||d  dS |d }
tj}|d|
}|d|}tjt|	||d dS )a  
        Creates or partially updates the ``name`` user in the system.

        This defers the actual user creation to ``self.add_user`` or
        ``self.add_snap_user``, and most of the keys in ``kwargs`` will be
        processed there if and only if the user does not already exist.

        Once the existence of the ``name`` user has been ensured, this method
        then processes these keys (for both just-created and pre-existing
        users):

        * ``plain_text_passwd``
        * ``hashed_passwd``
        * ``lock_passwd``
        * ``doas``
        * ``sudo``
        * ``ssh_authorized_keys``
        * ``ssh_redirect_user``
        ra  FNplain_text_passwdThashed_passwd)hashedr;  z5'passwd' in user-data is ignored for existing user %slock_passwdzIAllowing unlocking empty password for %s based on empty '%s' in user-datazNot unlocking blank password for existing user %s. 'lock_passwd: false' present in user-data but no existing password set and no 'plain_text_passwd'/'hashed_passwd' provided in user-datazNot unlocking password for user %s. 'lock_passwd: false' present in user-data but no 'passwd'/'plain_text_passwd'/'hashed_passwd' provided in user-datadoassudozThe value of 'false' in user z's 'sudo' configz22.2zUse 'null' instead.rD  ssh_authorized_keyszZInvalid type '%s' detected for 'ssh_authorized_keys', expected list, string, dict, or set.ssh_redirect_usercloud_public_ssh_keysz^Unable to disable SSH logins for %s given ssh_redirect_user: %s. No cloud public-keys present.z$USERz$DISABLE_USER)options)rk  r`  
set_passwdr   r   r{  r   r  r   unlock_passwdwrite_doas_ruleswrite_sudo_rulesr   rR  ru   rv   r   rw   valuesrx   r~   typer   setup_user_keysDISABLE_USER_OPTSreplace)rk   r_   rW  pre_existing_userhas_existing_passwordud_blank_password_specifiedud_password_specifiedpassword_keyrU  
cloud_keysredirect_userdisable_optionrO   rO   rP   create_userL  s   
	






zDistro.create_userc              
   C   s   dd|gdd|gf}zt dd |D }W n ty/ } ztd|dd	 |D f |d
}~ww zt| W d
S  tyM } z	ttd| |d
}~ww )zL
        Lock the password of a user, i.e., disable password logins
        r;  z-lusermodz--lockc                 s   "    | ]}t |d  r|V  qdS r   Nr   whichr   toolrO   rO   rP   	<genexpr>       z%Distro.lock_passwd.<locals>.<genexpr>zBUnable to lock user account '%s'. No tools available.   Tried: %s.c                 S      g | ]}|d  qS r   rO   r   crO   rO   rP   r     r	  z&Distro.lock_passwd.<locals>.<listcomp>Nz&Failed to disable password for user %snextStopIterationRuntimeErrorr   r   r   r   r   )rk   r_   
lock_toolscmdr   rO   rO   rP   r    s(   zDistro.lock_passwdr_   c              
   C   sL  dd|gdd|gf}zt dd |D }W n ty/ } ztd|dd	 |D f |d
}~ww ztj|ddgd\}}W n tyR } z	ttd| |d
}~ww |rdd|gddd|gf}zt dd |D }W n ty } ztd|dd	 |D f |d
}~ww zt| W d
S  ty } z	ttd| |d
}~ww d
S )zM
        Unlock the password of a user, i.e., enable password logins
        r;  z-ur  z--unlockc                 s   r  r  r  r  rO   rO   rP   r    r  z'Distro.unlock_passwd.<locals>.<genexpr>zDUnable to unlock user account '%s'. No tools available.   Tried: %s.c                 S   r  r  rO   r  rO   rO   rP   r     r	  z(Distro.unlock_passwd.<locals>.<listcomp>Nr      rcsz%Failed to enable password for user %sz-dr5  z''c                 s   r  r  r  r  rO   rO   rP   r  $  s    
zTUnable to set blank password for user account '%s'. No tools available.   Tried: %s.c                 S   r  r  rO   r  rO   rO   rP   r   +  r	  z(Failed to set blank password for user %sr  )rk   r_   unlock_toolsr  r   _ri  passwd_set_toolsrO   rO   rP   r  	  s`   
zDistro.unlock_passwdc              
   C   sB   zt  dd|g W d S  ty  } z	ttd| |d }~ww )Nr;  z--expirezFailed to set 'expire' for %s)r   r   r   r   r   )rk   userr   rO   rO   rP   expire_passwd5  s   zDistro.expire_passwdc              
   C   sf   d||f }dg}|r| d ztj||d| d W dS  ty2 } z	ttd| |d }~ww )Nz%s:%schpasswd-ezchpasswd for %s)datarM  zFailed to set password for %sT)r   r   r   r   r   r   )rk   r  r;  r~  pass_stringr  r   rO   rO   rP   r  <  s   

zDistro.set_passwdplist_inr~  c                 C   s>   d dd |D d }dg|rdgng  }tj||d d S )N
c                 s   s"    | ]\}}d  ||gV  qdS )rp  Nr   )r   r_   passwordrO   rO   rP   r  S  r  z"Distro.chpasswd.<locals>.<genexpr>r  r  )r  )r   r   )rk   r  r~  payloadr  rO   rO   rP   r  P  s   	zDistro.chpasswdc                 C   st   d}t d|| t||}|r3t d|d |d|kr(t d dS t d|d dS t d	 dS )
Nz^(?:permit|deny)(?:\s+(?:nolog|nopass|persist|keepenv|setenv \{[^}]+\})+)*\s+([a-zA-Z0-9_]+)+(?:\s+as\s+[a-zA-Z0-9_]+)*(?:\s+cmd\s+[^\s]+(?:\s+args\s+[^\s]+(?:\s*[^\s]+)*)*)*\s*$z3Checking if user '%s' is referenced in doas rule %rz!User '%s' referenced in doas rulerY   z'Correct user is referenced in doas ruleTz.Incorrect user '%s' is referenced in doas ruleFz/doas rule does not appear to reference any user)r   r   rt  searchr]  )rk   r  rulerule_patternvalid_matchrO   rO   rP   is_doas_rule_valid]  s(   	


zDistro.is_doas_rule_validc           
   
   C   s"  |s| j }|D ]}| ||sd||f }t|  d S qdd| g}|D ]	}|d|  q&d|}|d7 }tj|sit	
 |g}zt	j|d|dd W d S  tyh }	 z	t	td| |	d }	~	ww |t	|vrz	t	|| W d S  ty }	 z	t	td	| |	d }	~	ww d S )
NzHInvalid doas rule %r for user '%s', not writing any doas rules for user!r  z# cloud-init User rules for %s%sr     r  zFailed to write doas file %sz Failed to append to doas file %s)doas_fnr  r   r   r   r   r   r   r
  r   r  r!  r   r   r  append_file)
rk   r  rules	doas_filer  msglinescontentr+  r   rO   rO   rP   r  }  sH   

zDistro.write_doas_rules/etc/sudoersc              
   C   sf  d}d}d}t j|rt|}d}nt j|rt|}d}| D ]'}| }td|}|s4q%|	d }	|	s>q%t j
|	}	|	|krLd} nq%|szF|svddtjdd	d
| dg}
|rgtd| |d|
7 }t||d ndtjdd	d
| dg}
d|
}t|| td|| W n ty } z	ttd| |d }~ww t|d d S )Nr  Fz/usr/etc/sudoersTz^[#|@]includedir\s+(.*)$rY   z?# See sudoers(5) for more information on "#include" directives:r  r  z#includedir %szUsing content from '%s'r  r  zAdded '#includedir %s' to %szFailed to write %si  )r   r   r
  r   r  
splitlinesrI  rt  r  r]  abspathr  r   r   r   r!  r  r   r   r   
ensure_dir)rk   r   	sudo_basesudoers_contentsbase_existssystem_sudo_basefound_includelineinclude_matchincluded_dirr  r   rO   rO   rP   ensure_sudo_dir  sb   




zDistro.ensure_sudo_dirc           
   
   C   sH  |s| j }dd| g}t|ttfr!|D ]}|d||f  qnt|tr0|d||f  nd}t|t| d	|}|d7 }| 
tj| tj|s|t |g}zt|d	|d W d S  ty{ }	 z	ttd| |	d }	~	ww |t|vrz	t|| W d S  ty }	 z	ttd| |	d }	~	ww d S )	Nr  z# User rules for %sz%s %sz1Can not create sudoers rule addition with type %rr  r  zFailed to write sudoers file %sz#Failed to append to sudoers file %s)ci_sudoers_fnru   rw   rx   r   rv   	TypeErrorr   obj_namer   r  r   r   dirnamer
  r   r  r!  r   r   r   r  r  )
rk   r  r  	sudo_filer  r  r  r  r+  r   rO   rO   rP   r    sL   

zDistro.write_sudo_rulesc                 C   s   d|g}t  r|d |sg }t |rtd| nzt| td| W n ty:   t 	td| Y nw t
|dkrd|D ]"}t |sRtd|| qCtdd	d
||g td|| qCd S d S )Ngroupaddr4  z(Skipping creation of existing group '%s'zCreated new group %szFailed to create group %sr   zCUnable to add group member '%s' to group '%s'; user does not exist.r  z-az-GzAdded user '%s' to group '%s')r   rP  r   rS  r   r   r   r   r   r   ry   rN  )rk   r_   membersgroup_add_cmdmemberrO   rO   rP   rT     s4   



zDistro.create_groupc             
   C   sl   d| j | g}z|dkrdt| }W n ty' } ztd|f |d }~ww ||g }|r4|| |S )Nshutdownnowz+%dz?power_state[delay] must be 'now' or '+m' (minutes). found '%s'.)shutdown_options_mapintrz   r  r   )clsr  delaymessager   r   r   rO   rO   rP   shutdown_command   s&   

zDistro.shutdown_commandc                 C   s2   | j }|  sd|v r|dg}tj|d|dS dS )zX
        Reload systemd startup daemon.
        May raise ProcessExecutionError
        	systemctlzdaemon-reloadTrd  r  N)init_cmdr   r   )r  r  r  r  rO   rO   rP   reload_init1  s
   zDistro.reload_initr  action
extra_argsc             	   G   s   | j }|  sd|v r*dg}d|gd|gd|gd|gd|gd|gd|gd	|gd
}n|dg|dg|dg|dg|dg|dg|dg|d	gd
}t|t||  }tj|d|dS )z
        Perform the requested action on a service. This handles the common
        'systemctl' and 'service' cases and may be overridden in subclasses
        as necessary.
        May raise ProcessExecutionError
        r  stopstartenabledisablerestartzreload-or-restartzreload-or-try-restartstatus)r  r  r  r  r  reloadz
try-reloadr  Tr  )r  r   rw   r   )r  r  rR   r  r  r  cmdsr  rO   rO   rP   manage_service<  s.   

zDistro.manage_servicelayoutmodelvariantr  c                 C   s(   |   rtdd||||g d S t )N	localectlzset-x11-keymap)r   r   r   )rk   r  r  r  r  rO   rO   rP   
set_keymapa  s   zDistro.set_keymapc                 C   s.   t jdd}t|ds|S tj| jddS )NT)	needs_exenoexecz
cloud-initclouddir)r   get_tmp_ancestorr   has_mount_optr   r   r   usr_lib_exec)rk   tmp_dirrO   rO   rP   get_tmp_exec_pathp  s   zDistro.get_tmp_exec_pathr  r   r  cwdc              	   K   s>   |rd| dnd}t j dd|d|d d| gfi |S )	a`  
        Perform a command as the requested user. Behaves like subp()

        Note: We pass `PATH` to the user env by using `env`. This could be
        probably simplified after bionic EOL by using
        `su --whitelist-environment=PATH ...`, more info on:
        https://lore.kernel.org/all/20180815110445.4qefy5zx5gfgbqly@ws.net.home/T/
        zcd z && r  surJ   z-czenv PATH=$PATH  )r   r   )rk   r   r  r  rW  	directoryrO   rO   rP   do_asv  s   	zDistro.do_asr   
lease_filepid_file	interfaceconfig_filec              	   C   s,   | ddd|d|ddg	|rd||g S |g S )Nz-1z-vz-lfz-pfz-sfz	/bin/truez-cfrO   )r   r	  r
  r  r  rO   rO   rP   build_dhclient_cmd  s   	

zDistro.build_dhclient_cmdc                 C   s.   | j du rt | _ | j std| j | j S )zADetermine the network interface used during local network config.Nz0Did not find a fallback interface on distro: %s.)ri   r   find_fallback_nicr   r   r_   r   rO   rO   rP   fallback_interface  s   

zDistro.fallback_interfacec                 C   s
   || _ d S r   )ri   )rk   r   rO   rO   rP   r    s   
pidc                 C   V   t | d}|dur)tt t|W  d   S 1 sw   Y  td| | dS )=Return the parent pid of a process by parsing /proc/$pid/statr   Nz&/proc/%s/stat has an invalid ppid [%s]rQ   _get_proc_stat_by_indexr   rz   r  r   r   r  matchrO   rO   rP   get_proc_ppid     
 zDistro.get_proc_ppidc                 C   r  )r     Nz&/proc/%s/stat has an invalid pgid [%s]r  r  rO   rO   rP   get_proc_pgid  r  zDistro.get_proc_pgidfieldc              
   C   s   z%t jd|  dd }td|}|std| | W dS t||W S  t	y? } ztd| | W Y d}~dS d}~w t
yQ   td|| || Y dS w )	z
        parse /proc/$pid/stat for a specific field as numbered in man:proc(5)

        param pid: integer to query /proc/$pid/stat for
        param field: field number within /proc/$pid/stat to return
        z/proc/%s/statT)quietz,^(\d+) (\(.+\)) ([RSDZTtWXxKPI]) (\d+) (\d+)z*/proc/%s/stat has an invalid contents [%s]Nz Failed to load /proc/%s/stat. %sz4Unable to match field %s of process pid=%s (%s) (%s))r   r  rI  rt  r  r   r   r  r]  r   
IndexError)r  r  r  r  r   rO   rO   rP   r    s:   	zDistro._get_proc_stat_by_indexdevicec                 C   sL   d }t drd| g}nt drdd| g}nt jddddt  | d S )Nejectz/lib/udev/cdrom_idz--eject-mediaeject_media_cmdzeject command not foundz.neither eject nor /lib/udev/cdrom_id are found)r  descriptionreason)r   r  r   )r  r  rO   rO   rP   eject_media  s   


zDistro.eject_mediablockdevc                 C   s,   t j| }|drtd| | |S dS )a  Returns underlying block device for a mapped device.

        If it is mapped, blockdev will usually take the form of
        /dev/mapper/some_name

        If blockdev is a symlink pointing to a /dev/dm-* device, return
        the device pointed to. Otherwise, return None.
        z/dev/dm-z$%s is a mapped device pointing to %sN)r   r   realpath
startswithr   r   )r$  r%  rO   rO   rP   get_mapped_device  s   

zDistro.get_mapped_devicedevpathc           
      C   s   t j| }t j|}d| }t j|std| |f t j|d}t j|s1td|  t	|
 }t j|}t j|}t	t j|d
 }t jd| }	|	|fS )zconvert an entry in /dev/ to parent disk and partition number

        input of /dev/vdb or /dev/disk/by-label/foo
        rpath is hopefully a real-ish path in /dev (vda, sdb..)
        z/sys/class/block/%sz%s had no syspath (%s)	partitionz%s not a partitiondevz/dev/block/%s)r   r   r%  basenamer
  rz   r   r  r   r  rstripr  )
r(  rpathbnamesyspathptpathptnumrsyspathdisksyspath
diskmajmindiskdevpathrO   rO   rP   device_part_info  s$   zDistro.device_part_infor   )NN)F)r  )r  )xrL   rM   rN   pip_package_namer  r  r  r  r   rr  rq  rs  r   default_ownerr  rS   r   rv   r	   r   __annotations__r-  r   rT   r   r   r  rc   rd   rX   r"   _ci_pkl_versionr   resolve_conf_fnr[   r
   r\   rn   r  rs   r|   PackageListr   r   r   r   r   r   propertyr    
DhcpClientr   r   NetworkActivatorr   r$   r   r   r   r   r   r   staticmethodr   abcabstractmethodr   r   r   r   r   r   boolr   r   r   r   r   r   r   r   r   r   r  r  r,  r/  r1  r`  rk  r{  r  r  r  r  r  rw   r  r  r  r  r  rT  classmethodr  r  r  r  r  r  r  r  setterr  r  r  r#  r'  rx   r6  rO   rO   rO   rP   rQ      s  
 
5;











A+
y" +,

 
$
6
) 

$

		 rQ   )	metaclassurltransformationsc                 C   s   zt j| }W n
 ty   Y dS w |j}|du rdS |D ]}||}|du r,|   S q|}|jdur;d||j}t j|j|dS )a  
    Apply transformations to a URL's hostname, return transformed URL.

    This is a separate function because unwrapping and rewrapping only the
    hostname portion of a URL is complex.

    :param url:
        The URL to operate on.
    :param transformations:
        A list of ``(str) -> Optional[str]`` functions, which will be applied
        in order to the hostname portion of the URL.  If any function
        (regardless of ordering) returns None, ``url`` will be returned without
        any modification.

    :return:
        A string whose value is ``url`` with the hostname ``transformations``
        applied, or ``None`` if ``url`` is unparsable.
    Nz{}:{})netloc)	urllibparseurlsplitrz   r   portr  
urlunsplit_replace)rG  rH  partsnew_hostnametransformation
new_netlocrO   rO   rP   &_apply_hostname_transformations_to_url*  s"   
rT  c                    s2   t d  dd dd  fdddd g}t| |S )aH  
    Given a mirror URL, replace or remove any invalid URI characters.

    This performs the following actions on the URL's hostname:
      * Checks if it is an IP address, returning the URL immediately if it is
      * Converts it to its IDN form (see below for details)
      * Replaces any non-Letters/Digits/Hyphen (LDH) characters in it with
        hyphens
      * Removes any leading/trailing hyphens from each domain name label

    Before we replace any invalid domain name characters, we first need to
    ensure that any valid non-ASCII characters in the hostname will not be
    replaced, by ensuring the hostname is in its Internationalized domain name
    (IDN) representation (see RFC 5890).  This conversion has to be applied to
    the whole hostname (rather than just the substitution variables), because
    the Punycode algorithm used by IDNA transcodes each part of the hostname as
    a whole string (rather than encoding individual characters).  It cannot be
    applied to the whole URL, because (a) the Punycode algorithm expects to
    operate on domain names so doesn't output a valid URL, and (b) non-ASCII
    characters in non-hostname parts of the URL aren't encoded via Punycode.

    To put this in RFC 5890's terminology: before we remove or replace any
    characters from our domain name (which we do to ensure that each label is a
    valid LDH Label), we first ensure each label is in its A-label form.

    (Note that Python's builtin idna encoding is actually IDNA2003, not
    IDNA2008.  This changes the specifics of how some characters are encoded to
    ASCII, but doesn't affect the logic here.)

    :param url:
        The URL to operate on.

    :return:
        A sanitized version of the URL, which will have been IDNA encoded if
        necessary, or ``None`` if the generated string is not a parseable URL.
    .c                 S   s   t | rd S | S r   )r   is_ip_addressr   rO   rO   rP   <lambda>  r   z&_sanitize_mirror_url.<locals>.<lambda>c                 S   s   |  ddS )Nidnaascii)encodedecoderW  rO   rO   rP   rX    s    c                    s   d  fdd| D S )Nr  c                 3   s     | ]}| v r
|nd V  qdS rJ   NrO   r  acceptable_charsrO   rP   r    s    
9_sanitize_mirror_url.<locals>.<lambda>.<locals>.<genexpr>r  rW  r^  rO   rP   rX    s    c                 S   s   d dd | dD S )NrU  c                 s   s    | ]}| d V  qdS r]  rH  )r   partrO   rO   rP   r    s    

r`  )r   rQ  rW  rO   rO   rP   rX    s   
 )LDH_ASCII_CHARSrT  )rG  rH  rO   r^  rP   _sanitize_mirror_urlU  s   &

rc  c              
   C   s"  | si } i }|r1|j r1|j |d< t|j r1|j dd }tr&d| |d< n|jdkr1d| |d< |r;|jr;|j|d< i }| di  D ]\}}|||< qE| d	i  D ]2\}}g }	|D ]}
z|
| }W n	 tyo   Y q^w t	|}|d ur}|	
| q^||	}|r|||< qVtd
| |S )Navailability_zoner   r  
ec2_regionec2regionfailsafer  zfiltered distro mirror info: %s)rd  
_EC2_AZ_REr  r   platform_typerh  r   r   r   rc  r   r   r   )r   r   mirror_filtersubstrf  resultsr_   mirror
searchlistmirrorstmplfoundrO   rO   rP   r     sD   






r   c                 C   s8   d }| D ]}| d}||v r|  S d|v r|}q|S )Narchesr   )r   )r   r(   r   itemrt  rO   rO   rP   r     s   
r   r_   rp   c                 C   sH   t | dtgdg\}}|std| |f t |d }t|d}|S )Nr  rQ   z1No distribution found for distro %s (searched %s)r   )r   find_modulerL   ImportErrorimport_modulegetattr)r_   locslooked_locsmodr  rO   rO   rP   fetch  s   
r}  /etc/timezone/etc/localtimec                 C   sj   t |t|  d  |r3|r3tj|}|stj|s-|r%t | t	|| d S t 
|| d S )Nr  )r   r!  rv   r,  r   r   islinkr
  del_filesymlinkcopy)r   r   tz_conftz_localr  rO   rO   rP   set_etc_timezone  s   
r  c                  C   s.   zt d} t| jW S  ty   Y dS w )Nz/run/systemd/systemF)r   lstatstatS_ISDIRst_moder   )resrO   rO   rP   r     s   
r   )Nr~  r  )WrA  loggingr   rt  r  stringurllib.parserJ  collectionsr   
contextlibr   ior   typingr   r   r   r   r	   r
   r   r   r   r   cloudinit.net.netops.iproute2r   netopsrc   	cloudinitr   r   r   r   r   r   r   r   r   cloudinit.distros.networkingr   r   4cloudinit.distros.package_management.package_managerr   *cloudinit.distros.package_management.utilsr   cloudinit.distros.parsersr   cloudinit.featuresr   cloudinit.netr   r    r!   cloudinit.net.netopsr"   cloudinit.net.network_stater#   cloudinit.net.rendererr$   ALL_DISTROSr  	getLoggerrL   r   compilerj  r.  ascii_lettersdigitsrb  rv   r<  r   rK   CloudInitPickleMixinABCMetarQ   rw   rT  rc  search_for_mirrorr   r   r}  r  r   rO   rO   rO   rP   <module>   s   00

'

	           1+<
3
