Current File : //usr/lib/python3.9/site-packages/cloudinit/distros/__pycache__/__init__.cpython-39.pyc
a
��h� �
@ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlm Z d dl
m Z d dl m
Z
d dlmZmZmZmZmZmZmZmZmZmZ d dlm m m Z d dl m Z m Z m Z mZm!Z!m"Z"m#Z#m$Z$m%Z%m&Z& d dl'm(Z(m)Z) d dl*m+Z+ d d l,m-Z- d d
l.m/Z/ d d l0m1Z1 d d l2m3Z3 d d
l4m5Z5m6Z6m7Z7 d dl8m9Z9 d dl:m;Z; d dl<m=Z= dZ>dgdgdgddgddgddgdgd gg d �g d �d gd d!gd"� Z?e�@eA�ZBe�Cd#�ZDg d$�ZEejFejG d% ZHeeeI ee eeeI eeeIeeI f eeeIeeI ef f ZJG d&d'� d'eK�ZLG d(d)� d)e!jMe jNd*�ZOeIePd+�d,d-�ZQeId.�d/d0�ZRde&jSfd1d2�ZTd3d4� ZUeIeeO d5�d6d7�ZVd>d:d;�ZWd<d=� ZXdS )?� 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)�log_with_downgradable_level)�
activators�dhcp� renderers)�NetOps)�parse_net_config_data)�Renderer�all�alpine�aosc�arch�debianZubuntu�freebsdZ dragonfly�gentooZcos�netbsd�openbsd)Z almalinuxZamazonZ
azurelinuxZcentosZ
cloudlinuxZ eurolinuxZfedoraZmarinerZ miraclelinuxZ openmandrivaZphotonZrhelZrockyZ virtuozzo)Zopensusez
opensuse-leapzopensuse-microoszopensuse-tumbleweedZsle_hpcz sle-microZsles�suse� openeuler� OpenCloudOSZ TencentOS) r' r( r) r* r+ r, r- r. Zredhatr/ r0 r1 z#^[a-z][a-z]-(?:[a-z]+-)+[0-9][a-z]$)Zchronyzsystemd-timesyncdZntpZntpdate�-c @ s e Zd ZdS )�PackageInstallerErrorN)�__name__�
__module__� __qualname__� r7 r7 �>/usr/lib/python3.9/site-packages/cloudinit/distros/__init__.pyr3 � s r3 c @ s\ e Zd ZU dZdZdZdZdZdZdZ dZ
d d
gZ d Z d Z
d
gZee ed< i Zeeeeef f ed< dZeZee ed< dddd�Ze j Z ee ed< dZ dZ!dZ"eed< dZ#e$e ed< dZ%e$e ed < d d � Z&e'dd �d d!�Z(d"d#� Z)e*e+e,ee- e.f e.f d$�d%d&�Z/e*d'�d(d)�Z0e1e2j3d*�d+d,��Z4e1ee5j6 d*�d-d.��Z7e1e8d*�d/d0��Z9e8d1�d2d3�Z:d4d5� Z;d�d6d7�Z<d�d8d9�Z=d�d:d;�Z>e?d<d=� �Z@eAjBd�d>d?��ZCdd@�dAdB�ZDdCdD� ZEd�dEdF�ZFd�dGdH�ZGdIdJ� ZHd�eId*�dKdL�ZJeAjBd�dMdN��ZKeAjBdOdP� �ZLdQdR� ZMdSdT� ZNeAjBd�dUdV��ZOeAjBdWdX� �ZPeAjBdYdZ� �ZQd[d\� ZRd]d^� ZSe?d_d`� �ZTdadb� ZUdcdd� ZVe1dedf� �ZWdgdh� ZXeId*�didj�ZYdkdl� ZZeId*�dmdn�Z[dodp� Z\dqdr� Z]eds�dtdu�Z^dvdw� Z_d�dxdy�Z`eaeIdz�d{d|�Zbd}d~� Zcd�dd��Zdd�d�d��Zed�d�d��Zfd�d�d��Zgehd�d�� �Ziehd�d�d���Zjehdd��eeed��d�d���Zkeeeed��d�d��Zled*�d�d��Zmd�eaeed��d�d��Zne?eeeeeead��d�d���Zoe1d�d�� �Zpepjqd�d�� �Zpe?e'e$e' d��d�d���Zre?e'e$e' d��d�d���Zse?e'e'e$e' d��d�d���Zte?edd��d�d���Zue?ee$e d��d�d���Zve?eewd��d�d���Zxdd*�d�d��ZydS )��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�init_cmd�renderer_configsN�networking_clsz-Hz-Pz-r)ZhaltZpoweroffZreboot�net_ops� Fz/etc/resolv.confZosfamily�dhclient_lease_directory�dhclient_lease_file_regexc C sT || _ || _|| _| �� | _tj| _tj | _
t � |�| _
g | _d | _d | _d| _d S )NT)Z_paths�_cfg�namer= �
networkingr! �ALL_DHCP_CLIENTS�dhcp_client_priority�iproute2�Iproute2r> r ZRunners�_runner�package_managers� _dhcp_client�_fallback_interface�is_linux)�selfrC Zcfg�pathsr7 r7 r8 �__init__� s
zDistro.__init__)�ci_pkl_version�returnc C sP d| j vs| jj s | �� | _t| d�s,d| _t| d�s<d| _t| d�sLd| _dS )z)Perform deserialization fixes for Distro.rD rK NrL rM T)�__dict__rD r= �hasattrrK rL rM )rN rQ r7 r7 r8 � _unpickle� s
zDistro._unpicklec C s< t |t�r|S t |ttf�r0t|�dkr0t|�S td��d S )N� z?Invalid 'packages' yaml specification. Check schema definition.)�
isinstance�str�list�tuple�len�
ValueError)rN �entryr7 r7 r8 �_validate_entry� s
�zDistro._validate_entry)�pkglistrR c C s� t t�}t� }|D ]|}t|t�r~|�� D ]R\}}|D ]D}| �|�}z|t| �|� W q4 tyv t �
d|� Y q40 q4q(q|�| �|�� qt|�|fS )z�Transform 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 �setrW �dict�itemsr^ r �add�KeyError�LOG�error)rN r_ �packages_by_manager�generic_packagesr] Zpackage_managerZ package_listZ
definitionr7 r7 r8 �_extract_package_by_manager� s(
�� �z"Distro._extract_package_by_manager�r_ c C s� d}| � |�\}}t� }| jD ]~}|�|jt� �}||B }|�|� |�� sft�d|j � |�
|� q |slq |� |�} |�
| � | r�t� || � t| �| }q |�
� D ]>\}
} |
j dd� | jD �v r�q�|�
|
�| j| j�j | d�� q�|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 �qS r7 �rC )�.0�pr7 r7 r8 �
<listcomp> � z+Distro.install_packages.<locals>.<listcomp>rj )ri r` rJ �get� __class__�difference_update� availablere �debugrC �update�install_packages�inforb Z from_configrI rB r3 ) rN r_ Z
error_messagerg rh Z total_failed�managerZmanager_packagesZto_tryZfailedZ manager_typeZpackagesr7 r7 r8 rv � sH � �
�
���zDistro.install_packages)rR c C s� | j r | j S | j}t�| jdg �}|rxg }t�d|� |D ]4}tjD ] }||j krD|�
|� q:qDt� d|� q:|rx|}|D ]L}z"|� | _ t�d|j � | j W S tj fy� t�d|j � Y q|0 q|t� � �dS )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
)�networkrF z.Using configured dhcp client priority list: %sz4Configured dhcp client %s is not supported, skippingzDHCP client selected: %szDHCP client not found: %sN)
rK rF r �get_cfg_by_pathrB re rt r! rE Z client_name�append�warningZ NoDHCPLeaseMissingDhclientError)rN rF Zconfig_priorityZ
found_clientsZclient_configuredZ client_classZclientr7 r7 r8 � dhcp_client$ s> ��
� zDistro.dhcp_clientc C s t �| jdd�}tj|d�S )z�Return the configured network activator for this environment.
:returns: The network activator class to use
:raises: NoActivatorException if no activator is found
)ry r N��priority)r rz rB r Zselect_activator)rN r r7 r7 r8 �network_activator` s �zDistro.network_activatorc C sD t �| jdd �}tj|d�\}}t�d||� || j�|�d�}|S )N)ry r" r~ z-Selected renderer '%s' from priority list: %s)Zconfig) r rz rB r" Zselectre rt r< rp )rN r rC Z
render_cls�rendererr7 r7 r8 �network_rendererl s ��zDistro.network_renderer�r� c C s |� |� d S �N)Zrender_network_state)rN �
network_stater� r7 r7 r8 �_write_network_statey s zDistro._write_network_statec C s4 t j�| jt|��}t j�|�s0td||f ��|S )Nz(Invalid timezone %s, no file found at %s)�os�path�join� tz_zone_dirrX �isfile�IOError)rN �tz�tz_filer7 r7 r8 �
_find_tz_file| s
�zDistro._find_tz_filec C s | j �||�S r� )rB rp )rN �opt_name�defaultr7 r7 r8 �
get_option� s zDistro.get_optionc C s || j |< d S r� )rB )rN r� �valuer7 r7 r8 �
set_option� s zDistro.set_optionc C s( | � ||�}| �|| j� | �|� d S r� )�_select_hostname�_write_hostname�hostname_conf_fn�_apply_hostname)rN �hostname�fqdnZwriteable_hostnamer7 r7 r8 � set_hostname� s zDistro.set_hostnamec C s t � S )z?Wrapper to report whether this distro uses systemd or sysvinit.)� uses_systemdr7 r7 r7 r8 r� � s zDistro.uses_systemdc C s
t � �d S r� ��NotImplementedError)rN �command�argsZpkgsr7 r7 r8 �package_command� s zDistro.package_command��forcec C sn | j D ]b}|�� s"t�d|j� qz|j|d� W q tyf } z t�d|j|� W Y d }~qd }~0 0 qd S )Nz8Skipping update for package manager '%s': not available.r� z%Failed to update package using %s: %s)rJ rs re rt rC �update_package_sources� Exceptionrf )rN r� rx �er7 r7 r8 r� � s
��z Distro.update_package_sourcesc C s t �� d }|dv rdS |S )N� )�i386Zi486Zi586Zi686r� )r� �uname)rN r) r7 r7 r8 �get_primary_arch� s zDistro.get_primary_archc C s" | � dg �}|s| �� }t||�S )N�package_mirrors)r� r� � _get_arch_package_mirror_info)rN r) � mirror_infor7 r7 r8 r� � s z$Distro._get_arch_package_mirror_infoc C s | � |�}t||d�S )N)� data_sourcer� )r� �_get_package_mirror_info)rN r) r� Z arch_infor7 r7 r8 �get_package_mirror_info� s
�z Distro.get_package_mirror_infoc C s t �� S r� )r �generate_fallback_config�rN r7 r7 r8 r� � s z Distro.generate_fallback_configc C sr | j }t||d�}| �||� |rdt�d� z
| j}W n tjyV t�d� Y dS 0 |� |� n
t�d� dS )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� re rt r� r ZNoActivatorExceptionr| Zbring_up_all_interfaces)rN Z netconfigZbring_upr� r� r� r7 r7 r8 �apply_network_config� s
�
zDistro.apply_network_configc C s
t � �d S r� r� )rN �localeZout_fnr7 r7 r8 � apply_locale� s zDistro.apply_localec C s
t � �d S r� r� )rN r� r7 r7 r8 � set_timezone� s zDistro.set_timezonec C s dS )Nz 127.0.0.1r7 r� r7 r7 r8 �_get_localhost_ip� s zDistro._get_localhost_ipc C s
t � �d S r� r� r� r7 r7 r8 �
get_locale� s zDistro.get_localec C s
t � �d S r� r� )rN �filenamer� r7 r7 r8 �_read_hostname� s zDistro._read_hostnamec C s
t � �d S r� r� )rN r� r� r7 r7 r8 r� � s zDistro._write_hostnamec C s
t � �d S r� r� r� r7 r7 r8 �_read_system_hostname� s z Distro._read_system_hostnamec C sF t �d|� zt�d|g� W n" tjy@ t�t d|� Y n0 d S )Nz2Non-persistently setting the system hostname to %sr� z;Failed to non-persistently adjust the system hostname to %s)re rt r �ProcessExecutionErrorr �logexc)rN r� r7 r7 r8 r� � s ��zDistro._apply_hostnamec C s& t �| jd| j�r|r|S |s"|S |S )NZprefer_fqdn_over_hostname)r Zget_cfg_option_boolrB � prefer_fqdn)rN r� r� r7 r7 r8 r� s
���zDistro._select_hostnamec C s6 g }| D ](}|t vr"td�|���|�t | � q|S )Nz&No distributions found for osfamily {})�
OSFAMILIESr\ �format�extend)Z family_listZdistrosZfamilyr7 r7 r8 �expand_osfamily s �zDistro.expand_osfamilyc
C s |}| � ||�}|r,tj�|�r,| �|�}nd }| �� \}}g }|rL||krV|�|� |rj||krt||krt|�|� |r�|r�||kr�t�d||� d S t dd� |D ��}t�
d|t |�� |D ]8} z| � || � W q� t
y� t�td|| � Y q�0 q�||v �r | �|� d S )Nz6%s differs from %s, assuming user maintained hostname.c S s g | ] }|r|�qS r7 r7 )rl �fr7 r7 r8 rn O ro 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{ re rw r` rt r[ r� r� r r� r� )
rN r� r� Zprev_hostname_fnZapplying_hostnameZ
prev_hostnameZsys_fnZ sys_hostnameZ update_files�fnr7 r7 r8 �update_hostname" sJ
��
�� �
zDistro.update_hostnamec
C s~ d}t j�| j�r&t�t�| j��}nt�d�}tjdd�}| � � }|�
|�}d}|sj|� |||� d}n�d}|D ]T}d } g }
t |�dkr�|d } t |�dkr�|dd � }
| d urr| |krr||
v rrd}qr|�r6t
|�} | �||g� |�|� | D ]B}t |�dk�r|� ||d � q�t |�dkr�|j |g|�R � q�|�rzt� } |�rV| �d | � | �d | � tj| j| �� d
d � d S ) N� �added��baseFTr? r rV z%s
i� ��mode)r� r� r� �hosts_fnr Z HostsConfr �load_text_file� make_headerr� Z get_entryZ add_entryr[ rY r{ Z del_entriesr �write�
write_file�getvalue)
rN r� r� �headerZehZlocal_ipZ prev_infoZ need_changer] Z
entry_fqdnZ
entry_aliasesZ new_entries�contentsr7 r7 r8 �update_etc_hostsc sJ
zDistro.update_etc_hostsc C s | j stt�| _ | j S )z7Allow distro to determine the preferred ntp client list)�_preferred_ntp_clientsrY �PREFERRED_NTP_CLIENTSr� r7 r7 r8 �preferred_ntp_clients� s
z Distro.preferred_ntp_clientsc C s
| � d�S )NZ default_user)r� r� r7 r7 r8 �get_default_user� s zDistro.get_default_userc K s� t �|�rt�d|� dS d|v r.|�d�}nd}d|g}d|g}t �� r^|�d� |�d� ddd d
d d d
dddd�
}dddd�}dg}|�d�} | �rt| t �r�| �
d�} t| t �r�t j
d|� d�dd d � d d � | D �} d�| �|d< |�d �}
|
�r| �|
� |�rB| �rB| D ]*} t �| ��s| �| � t�d!| |� �qd"|�� v �r`t |d" �|d"< t|�� �D ]�\} }
| |v �r�|
�r�t|
t ��r�|�|| |
g� | |v �r�|�|| d#g� n|�|| |
g� n,| |v �rl|
�rl|�|| � |�|| � �ql|�d$��s |�d%��r2|�d&� |�d&� n|�d'� |�d'� t�d(|� ztj||d)� W n8 t�y� } z t �td*|� |�W Y d+}~n
d+}~0 0 dS ),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_groupsTZuseradd� --extrausersz --commentz--homez--gidz--uidz--groups�
--passwordz--shellz --expiredatez
--inactivez--selinux-user)
Zgecos�homedir�
primary_group�uid�groups�passwd�shellZ
expiredateZinactiveZ selinux_userz--no-user-groupz--systemz
--no-log-init)Z
no_user_group�systemZ no_log_initr� r� �,z The user z) has a 'groups' config value of type dictz22.3z=Use a comma-delimited string or array instead: group1,group2.�Z
deprecatedZdeprecated_versionZ
extra_messagec S s g | ] }|� � �qS r7 ��strip)rl �gr7 r7 r8 rn � ro z#Distro.add_user.<locals>.<listcomp>r� z created group '%s' for user '%s'r� ZREDACTEDZno_create_homer� z-Mz-mzAdding user %s)� logstringzFailed to create user %sN)r �is_userre rw �pop�system_is_snappyr{ rp rW rX �splitra r � deprecater� �is_group� create_grouprt �keys�sortedrb r� r r� r� )rN rC �kwargsr� Z useradd_cmdZlog_useradd_cmdZ useradd_optsZ
useradd_flagsZ redact_optsr� r� �group�key�valr� r7 r7 r8 �add_user� s�
��
�
zDistro.add_userc
K s� |� d�}|� dd�}g d�}|r,|�d� |�|� t�d|� z<tj||dd�\}}t�d ||� t�|�}|� d
d �} W n6 ty� }
z t�td |� |
�W Y d }
~
n
d }
~
0 0 | S )
zD
Add a snappy user to the system using snappy tools
�snapuser�knownF)Zsnapz create-userz--sudoerz--jsonz--knownzAdding snap user %sT)r� �capturez snap create-user returned: %s:%s�usernameNz Failed to create snap user %s) rp r{ re rt r r Z load_jsonr� r� ) rN rC r� r� r� Zcreate_user_cmd�out�errZjobjr� r� r7 r7 r8 �
add_snap_user s$
�
zDistro.add_snap_userc s� t �� r| j| jg}n| jg}d�� fdd�| jD ��}|D ]h}tj�|�sNq<t � |�}t
� d� � d�|t
j �s�t
�d� |� q<t
�d� |� t
� ||t
j �r< dS 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 ��qS )�r� )r� )rl �patternr r7 r8 rn 8 s �z?Distro._shadow_file_has_empty_user_password.<locals>.<listcomp>�^�:zUser %s not found in %sz0User %s found in %s. Checking for empty passwordTF)r r� �shadow_extrausers_fn� shadow_fnr� �#shadow_empty_locked_passwd_patternsr� r� r� r� �re�findall� MULTILINEre rt )rN r� Z shadow_filesZshadow_empty_passwd_reZ shadow_fileZshadow_contentr7 r r8 �$_shadow_file_has_empty_user_password- s2
��
��z+Distro._shadow_file_has_empty_user_passwordc K s� d|v r| j |fi |��S | j|fi |�� }d}d}d}d}d|v rld}d}|d rh| �||d � nd}d|v r�d}d}|d r�| j||d dd� nd}|r�|s�d|v r�d}ttd tjd
|d � | �|� }n d|v r�d}d}|d s�d}|�d d��r
| � |� n\|�s|�r6|�r*t�
d
||� | � |� n0|�rRttd tjd|d � nttd tjd|d � d|v �r�|d �r�| � ||d � d|v �r�|d �r�| �
||d � n&|d du �r�tjd|� d�ddd� d|v �rd|d }t|t��r�|g}nt|t��rt|�� �}|du�rTt|tttf��sFt�dt|�� g }nt|��pRg }t�t|�|� d|v �r�|�dg �} | �s�t�d||d � n:|d }
tj} | � d |
�} | � d |�} tjt| �|| d � dS ) 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``
r� FNZplain_text_passwdTZ
hashed_passwd)�hashedr� z24.3z5'passwd' in user-data is ignored for existing user %s)�logger�versionZrequested_level�msgr� � lock_passwdzIAllowing unlocking empty password for %s based on empty '%s' in user-dataz�Not 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-dataz�Not unlocking password for user %s. 'lock_passwd: false' present in user-data but no 'passwd'/'plain_text_passwd'/'hashed_passwd' provided in user-dataZdoasZsudoz The value of 'false' in user z's 'sudo' configz22.2zUse 'null' instead.r� Zssh_authorized_keyszZInvalid type '%s' detected for 'ssh_authorized_keys', expected list, string, dict, or set.Zssh_redirect_userZcloud_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) r� r� �
set_passwdr re �loggingZWARNINGr
rp r rt �
unlock_passwd�write_doas_rules�write_sudo_rulesr r� rW rX ra rY �valuesrZ r` r| �typer Zsetup_user_keysZDISABLE_USER_OPTS�replace) rN rC r� Zpre_existing_userZhas_existing_passwordZud_blank_password_specifiedZud_password_specifiedZ password_keyr� Z
cloud_keysZ
redirect_userZdisable_optionr7 r7 r8 � create_userO s� �
� � � �
�
�
�
�zDistro.create_userc
C s� dd|gdd|gf}zt dd� |D ��}W n@ tyj } z(td|dd � |D �f �|�W Y d
}~n
d
}~0 0 zt�|� W n6 ty� } z t�td |� |�W Y d
}~n
d
}~0 0 d
S ) zL
Lock the password of a user, i.e., disable password logins
r� z-l�usermodz--lockc s s | ]}t �|d �r|V qdS �r N�r �which�rl Ztoolr7 r7 r8 � <genexpr> ro z%Distro.lock_passwd.<locals>.<genexpr>zBUnable to lock user account '%s'. No tools available. Tried: %s.c S s g | ] }|d �qS �r r7 �rl �cr7 r7 r8 rn
ro z&Distro.lock_passwd.<locals>.<listcomp>Nz&Failed to disable password for user %s��next�
StopIteration� RuntimeErrorr r� r r� re )rN rC Z
lock_tools�cmdr� r7 r7 r8 r s ���zDistro.lock_passwdrk c
C s� dd|gdd|gf}zt dd� |D ��}W n@ tyj } z(td|dd � |D �f �|�W Y d
}~n
d
}~0 0 ztj|d d gd
�\}}W n6 ty� } z t�td|� |�W Y d
}~n
d
}~0 0 |�r|dd|gddd|gf}zt dd� |D ��}W nB t�y2 } z(td|dd � |D �f �|�W Y d
}~n
d
}~0 0 zt�|� W n8 t�yz } z t�td|� |�W Y d
}~n
d
}~0 0 d
S )zM
Unlock the password of a user, i.e., enable password logins
r� z-ur z--unlockc s s | ]}t �|d �r|V qdS r r r r7 r7 r8 r ro z'Distro.unlock_passwd.<locals>.<genexpr>zDUnable to unlock user account '%s'. No tools available. Tried: %s.c S s g | ] }|d �qS r r7 r! r7 r7 r8 rn ro z(Distro.unlock_passwd.<locals>.<listcomp>Nr � ��rcsz%Failed to enable password for user %sz-dr� z''c s s | ]}t �|d �r|V qdS r r r r7 r7 r8 r 0 s zTUnable to set blank password for user account '%s'. No tools available. Tried: %s.c S s g | ] }|d �qS r r7 r! r7 r7 r8 rn 7 ro z(Failed to set blank password for user %sr# )rN rC Z unlock_toolsr' r� �_r� Zpasswd_set_toolsr7 r7 r8 r sN ���
�� ����zDistro.unlock_passwdc
C sP zt � dd|g� W n6 tyJ } z t�td|� |�W Y d }~n
d }~0 0 d S )Nr� z--expirez Failed to set 'expire' for %s)r r� r r� re )rN �userr� r7 r7 r8 �
expire_passwdA s
zDistro.expire_passwdc
C st d||f }dg}|r |� d� ztj||d| d� W n6 tyn } z t�td|� |�W Y d }~n
d }~0 0 dS )Nz%s:%s�chpasswd�-ezchpasswd for %s)�datar� z Failed to set password for %sT)r{ r r� r r� re )rN r, r� r Z pass_stringr' r� r7 r7 r8 r H s
�
zDistro.set_passwd)�plist_inr c C s> d� dd� |D ��d }dg|r&dgng }tj||d� d S )N�
c s s | ]\}}d � ||g�V qdS )r N�r� )rl rC �passwordr7 r7 r8 r _ ro z"Distro.chpasswd.<locals>.<genexpr>r. r/ )r0 )r� r )rN r1 r Zpayloadr' r7 r7 r8 r. \ s ��� zDistro.chpasswdc C sz d}t �d||� t�||�}|rht �d|�d�� |�d�|krPt �d� dS t �d|�d�� dS nt �d � dS 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 ruler? 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)re rt r �searchr� )rN r, �ruleZ rule_patternZ valid_matchr7 r7 r8 �is_doas_rule_validi s( � �
�
�
zDistro.is_doas_rule_validc
C s< |s
| j }|D ],}| �||�sd||f }t�|� d S qdd| g}|D ]}|�d| � qLd�|�}|d7 }tj�|�s�t �
� |g}zt j |d�|�dd� W n6 t y� } z t �
td|� | �W Y d } ~ n
d } ~ 0 0 nZ|t �|�v�r8zt �||� W n8 t �y6 } z t �
td |� | �W Y d } ~ n
d } ~ 0 0 d S )
NzHInvalid doas rule %r for user '%s', not writing any doas rules for user!r� z # cloud-init User rules for %s�%sr2 � r� z Failed to write doas file %sz Failed to append to doas file %s)�doas_fnr7 re rf r{ r� r� r� r� r r� r� r� r� r� � append_file)
rN r, �rulesZ doas_filer6 r �lines�contentr� r� r7 r7 r8 r � s< ��
�zDistro.write_doas_rules� /etc/sudoersc
C sv d}d}d}t j�|�r(t�|�}d}nt j�|�r>t�|�}d}|�� D ]N}|�� }t�d|�}|shqJ|� d��� } | s|qJt j�
| �} | |krJd} q�qJ|�sfz�|s�ddtj dd �d
| dg}
|r�t �
d |� |d �|
�7 }t�||d
� n.dtj dd �d
| dg}
d �|
�}t�||� t �d||� W n8 t�yd } z t�t d|� | �W Y d } ~ n
d } ~ 0 0 t�|d� d S )Nr� Fz/usr/etc/sudoersTz^[#|@]includedir\s+(.*)$r? z?# See sudoers(5) for more information on "#include" directives:r� r� z#includedir %szUsing content from '%s'r2 r9 z Added '#includedir %s' to %szFailed to write %si� )r� r� r� r r� �
splitlinesr� r r5 r� �abspathr� re rw r� r� r; rt r� r� Z
ensure_dir) rN r� Z sudo_baseZsudoers_contentsZ base_existsZsystem_sudo_baseZ
found_include�lineZ
include_matchZ included_dirr= r� r7 r7 r8 �ensure_sudo_dir� s\
�
�
zDistro.ensure_sudo_dirc
C sf |s
| j }dd| g}t|ttf�rB|D ]}|�d||f � q(n4t|t�r`|�d||f � nd}t|t�|� ��d� |�}|d7 }| �
t j �
|�� t j �|��st�� |g}zt�|d� |�d� W n8 t�y } z t�td|� | �W Y d } ~ n
d } ~ 0 0 nZ|t�|�v�rbzt�||� W n8 t�y` } z t�td|� | �W Y d } ~ n
d } ~ 0 0 d S ) Nr� z# User rules for %sz%s %sz1Can not create sudoers rule addition with type %rr2 r9 z Failed to write sudoers file %sz#Failed to append to sudoers file %s)�
ci_sudoers_fnrW rY rZ r{ rX � TypeErrorr Zobj_namer� rC r� r� �dirnamer� r r� r� r� r� re r� r; )
rN r, r< Z sudo_filer= r6 r r> r� r� r7 r7 r8 r � s@ �
� �zDistro.write_sudo_rulesc C s� d|g}t �� r|�d� |s"g }t �|�r:t�d|� n<zt�|� t�d|� W n tyt t � td|� Y n0 t
|�dkr�|D ]@}t � |�s�t�d||� q�t�dd d
||g� t�d ||� q�d S ) NZgroupaddr� z(Skipping creation of existing group '%s'zCreated new group %szFailed 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 r� r{ r� re r| r rw r� r� r[ r� )rN rC �membersZ
group_add_cmd�memberr7 r7 r8 r� s.
�zDistro.create_groupc
C sx d| j | g}z|dkr$dt|� }W n4 tyZ } z td|f �|�W Y d }~n
d }~0 0 ||g }|rt|�|� |S )NZshutdownZnowz+%dz?power_state[delay] must be 'now' or '+m' (minutes). found '%s'.)�shutdown_options_map�intr\ rE r{ )�clsr� Zdelay�messager� r� r� r7 r7 r8 �shutdown_command, s ���
zDistro.shutdown_commandc C s2 | j }| �� sd|v r.|dg}tj|d|d�S dS )zX
Reload systemd startup daemon.
May raise ProcessExecutionError
� systemctlz
daemon-reloadT�r� r* N)r; r� r )rK r* r; r' r7 r7 r8 � reload_init= s zDistro.reload_initr) )�actionr: �
extra_argsc G s� | j }| �� sd|v rTdg}d|gd|gd|gd|gd|gd|gd|gd |gd
�}n6|dg|dg|dg|dg|dg|dg|dg|d gd
�}||| t|� }tj|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
rN �stop�start�enable�disable�restartzreload-or-restartzreload-or-try-restart�status)rS rT rU rV rW �reloadz
try-reloadrX TrO )r; r� rY r )rK rQ r: r* rR r; Zcmdsr' r7 r7 r8 �manage_serviceH s.
� �
zDistro.manage_service)�layout�model�variantr c C s* | � � r t�dd||||g� nt� �d S )NZ localectlzset-x11-keymap)r� r r� )rN r[ r\ r] r r7 r7 r8 �
set_keymapm s �� zDistro.set_keymapc C s. t jdd�}t�|d�s |S tj�| jdd�S )NT)Z needs_exeZnoexecz
cloud-initZclouddir)r Zget_tmp_ancestorr Z
has_mount_optr� r� r� � usr_lib_exec)rN Ztmp_dirr7 r7 r8 �get_tmp_exec_path| s zDistro.get_tmp_exec_pathr� )r� r, �cwdc K s> |rd|� d�nd}t j dd|d|d d�|� gfi |��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/
zcd z && r� Zsur2 z-czenv PATH=$PATH � )r r� )rN r� r, ra r� Z directoryr7 r7 r8 �do_as� s ���z Distro.do_as)r� �
lease_file�pid_file� interface� config_filerR c C s* | ddd|d|ddg |r"d||gn|g S )Nz-1z-vz-lfz-pfz-sfz /bin/truez-cfr7 )r� rd re rf rg r7 r7 r8 �build_dhclient_cmd� s �
�zDistro.build_dhclient_cmdc C s. | j du 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.)rL r Zfind_fallback_nicre r| rC r� r7 r7 r8 �fallback_interface� s
�zDistro.fallback_interfacec C s
|| _ d S r� )rL )rN r� r7 r7 r8 ri � s )�pidrR c C sV t �| d�}|durRtt�� t|�W d � S 1 s:0 Y t�d| |� dS )�=Return the parent pid of a process by parsing /proc/$pid/statr� Nz&/proc/%s/stat has an invalid ppid [%s]�r9 �_get_proc_stat_by_indexr r\ rJ re r| �rj �matchr7 r7 r8 �
get_proc_ppid� s
&zDistro.get_proc_ppidc C sV t �| d�}|durRtt�� t|�W d � S 1 s:0 Y t�d| |� dS )rk � Nz&/proc/%s/stat has an invalid pgid [%s]rl rn r7 r7 r8 �
get_proc_pgid� s
&zDistro.get_proc_pgid)rj �fieldrR c
C s� zJt jd| dd��� }t�d|�}|s<t�d| |� W dS t|�|��W S t y| } zt�d| |� W Y d}~n,d}~0 t
y� t�d|| ||� Y n0 dS ) 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� r� r r5 re r| rJ r� r� �
IndexError)rj rs r> ro r� r7 r7 r8 rm � s0 �
��" �
z Distro._get_proc_stat_by_index)�devicerR c C sL d }t �d�rd| g}n&t �d�r.dd| g}nt jdddd��t � |� d S )NZejectz/lib/udev/cdrom_idz
--eject-mediaZeject_media_cmdzeject command not foundz.neither eject nor /lib/udev/cdrom_id are found)r' � description�reason)r r r� )rv r' r7 r7 r8 � eject_media� s
�zDistro.eject_media)�blockdevrR c C s, t j�| �}|�d�r(t�d| |� |S dS )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�
startswithre rt )rz r{ r7 r7 r8 �get_mapped_device� s
�zDistro.get_mapped_device)�devpathrR c
C s� t j�| �}t j�|�}d| }t j�|�s<td| |f ��t j�|d�}t j�|�sbtd| ��t� |��
� }t j�|�}t j� |�}t� t j�|d���
� }t j�d| �} | |fS )z�convert 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� r\ r� rE r r� �rstriprF )
r~ ZrpathZbnameZsyspathZptpathZptnumZrsyspathZ disksyspathZ
diskmajminZ diskdevpathr7 r7 r8 �device_part_info s �zDistro.device_part_infoc C s dS )a� Ensure that cloud-init has network connectivity.
For most distros, this is a no-op as cloud-init's network service is
ordered in boot to start after network connectivity has been achieved.
As an optimization, distros may opt to order cloud-init's network
service immediately after cloud-init's local service, and only
require network connectivity if it has been deemed necessary.
This method is a hook for distros to implement this optimization.
It is called during cloud-init's network stage if it was determined
that network connectivity is necessary in cloud-init's network stage.
Nr7 r� r7 r7 r8 �wait_for_network5 s zDistro.wait_for_network)N)N)N)NN)N)NN)F)N)N)F)N)r? )N)N)N)r� )zr4 r5 r6 Zpip_package_namer_ r� r: rD r� r r r r� Z
default_ownerr; r rX �__annotations__r< r r r r� r r= r
r rI rG rH r> r# Z_ci_pkl_versionr� Zresolve_conf_fnr@ r
rA rP rJ rU r^ � PackageListr r r r ri rv �propertyr! Z
DhcpClientr} r ZNetworkActivatorr� 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� r� r� r� r
r r r r- r rY r. r7 r rC r r� � classmethodrM rP rZ r^ r` rc rh ri �setterrp rr rm ry r} rZ r� r� r7 r7 r7 r8 r9 � s�
� 5;
A+
y" 4,
$
6
)
��$�
#r9 )� metaclass��url�transformationsc C s� zt j�| �}W n ty$ Y dS 0 |j}|du r8dS |D ] }||�}|du r<| S q<|}|jdurvd�||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�urlsplitr\ r� �portr� �
urlunsplit�_replace)r� r� �partsZ new_hostnameZtransformationZ
new_netlocr7 r7 r8 �&_apply_hostname_transformations_to_urlC s
r� )r� c s2 t d � dd� dd� � fdd�dd� 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 �| �rd S | S r� )r Z
is_ip_address�r� r7 r7 r8 �<lambda>� ro z&_sanitize_mirror_url.<locals>.<lambda>c S s | � d��d�S )NZidna�ascii)�encode�decoder� r7 r7 r8 r� � ro c s d� � fdd�| D ��S )Nr� c 3 s | ]}|� v r|nd V qdS �r2 Nr7 r! �Zacceptable_charsr7 r8 r � s �9_sanitize_mirror_url.<locals>.<lambda>.<locals>.<genexpr>r3 r� r� r7 r8 r� � s �c S s d� dd� | �d�D ��S )Nr� c s s | ]}|� d �V qdS r� r� )rl �partr7 r7 r8 r � s r� )r� r� r� r7 r7 r8 r� � s
�)�LDH_ASCII_CHARSr� r� r7 r� r8 �_sanitize_mirror_urln s &
�r� c
C s& | si } i }|rb|j rb|j |d< t�|j �rb|j dd� }trLd| |d< n|jdkrbd| |d< |rv|jrv|j|d< i }| �di ��� D ]\}}|||< q�| �d i ��� D ]h\}}g } |D ]B}
z |
| }W n ty� Y q�Y n0 t |�}|d ur�| �
|� q�|| �} | r�| ||< q�t � d
|� |S ) N�availability_zoner ���r8 �
ec2_regionZec2�regionZfailsafer5 z filtered distro mirror info: %s)
r� �
_EC2_AZ_REro r Z
platform_typer� rp rb rd r� r{ re rt ) r� r� Z
mirror_filter�substr� �resultsrC ZmirrorZ
searchlistZmirrorsZtmpl�foundr7 r7 r8 r� � s>
r� c C s8 d }| D ]*}|� d�}||v r&| S d|v r|}q|S )N�archesr� )rp )r� r) r� �itemr� r7 r7 r8 r� � s
r� )rC rR c C sH t �| dtgdg�\}}|s,td| |f ��t �|d �}t|d�}|S )Nr� r9 z1No distribution found for distro %s (searched %s)r )r � find_moduler4 � ImportError�
import_module�getattr)rC ZlocsZ looked_locs�modrK r7 r7 r8 �fetch� s ��
r� �
/etc/timezone�/etc/localtimec C sh t �|t| ��� d � |rd|rdtj�|�}|s<tj�|�sX|rJt �|� t� ||� n t �
||� d S )Nr2 ) r r� rX r� r� r� �islinkr� Zdel_file�symlink�copy)r� r� Ztz_confZtz_localr� r7 r7 r8 �set_etc_timezone� s
r� c C s2 zt �d�} t�| j�W S ty, Y dS 0 d S )Nz/run/systemd/systemF)r� �lstat�stat�S_ISDIR�st_moder� )�resr7 r7 r8 r� s
r� )Nr� r� )Yr� r r� r r� �string� urllib.parser� � collectionsr �
contextlibr �ior �typingr r r r r r
r r r
r Z cloudinit.net.netops.iproute2r ZnetopsrG Z cloudinitr r r r r r r r r Z cloudinit.distros.networkingr r Z4cloudinit.distros.package_management.package_managerr Z*cloudinit.distros.package_management.utilsr Zcloudinit.distros.parsersr Zcloudinit.featuresr Zcloudinit.lifecycler Z
cloudinit.netr r! r" Zcloudinit.net.netopsr# Zcloudinit.net.network_stater$ Zcloudinit.net.rendererr% Z ALL_DISTROSr� Z getLoggerr4 re �compiler� r� �
ascii_letters�digitsr� rX r� r� r3 ZCloudInitPickleMixin�ABCMetar9 rY r� r� Zsearch_for_mirrorr� r� r� r� r� r7 r7 r7 r8 �<module> s� 0
0
�'
�� I+<�
3
�
Mini Shell