File: //lib/python3/dist-packages/sos/policies/distros/__pycache__/__init__.cpython-310.pyc
o
i��d�z � @ s� d dl Z d dlZd dlmZ d dlmZ d dlmZ d dlm Z d dl
m Z d dl m
Z
d dlmZ d d lmZ d d
lmZmZmZmZ zd dlZd ZW n eyW d ZY nw d
ZdZG dd� de�Z G dd� de �Z dS )� N)�getpass)�_sos)�Policy)�
InitSystem)� SystemdInit)�CrioContainerRuntime)�PodmanContainerRuntime)�DockerContainerRuntime)� shell_out�
is_executable�bold�sos_get_command_outputTF� container�HOSTc s� e Zd ZdZdZdZdZdZdZdZ dZ
dZ dZ dZ
dZdZdZdZdZdZdZdZd Zd
ZdZdZ dV� fd d
� Zedd� �Z dd� Z dd� Z dd� Z dd� Z dd� Z!dd� Z"ed d � �Z#ed d � �Z$ed d!� �Z%d"d#� Z&d$d%� Z'd&d'� Z(d(d)� Z)d*d+� Z*d,d-� Z+d.d/� Z,d0d1� Z-d2d3� Z.dWd4d5�Z/d6d7� Z0d8d9� Z1d:d;� Z2d<d=� Z3dWd>d?�Z4d@dA� Z5dXdBdC�Z6dDdE� Z7dXdFdG�Z8dHdI� Z9dYdJdK�Z:dLdM� Z;dNdO� Z<dZdPdQ�Z=dRdS� Z>dTdU� Z?� Z@S )[� LinuxPolicyzfThis policy is meant to be an abc class that provides common
implementations used in Linux distros�Linux�Nonez /bin:/sbin:/usr/bin:/usr/sbinN�/�dockerFz/usr/binzsos-collector-tmpTc s& t t| �j|||d� |r|| _n| �� pd| _| �� |d ur$|| _ntj� d�r2t
| jd�| _nt � | _i | _ | j
r�t| d�t| d�t| d�g}|D ]#}|�� ro|| j |j< |j| jkrg| j |j | j d< | j |j �� qL| j r�d| j �� vr�t| j �� �}| j |d | j d< d S d S d S d S )N)�sysroot�
probe_runtime� remote_execr z/run/systemd/system/)�chroot)�policy�defaultr )�superr �__init__r �_container_init�init_kernel_modules� init_system�os�path�isdirr r �runtimesr r r r �check_is_active�name�default_container_runtime�load_container_info�keys�list)�selfr �initr r �_crun�runtime�idx�� __class__� �?/usr/lib/python3/dist-packages/sos/policies/distros/__init__.pyr I s> � � ��
zLinuxPolicy.__init__c C s ddgS )Nz /etc/passwdz /etc/shadowr1 )�clsr1 r1 r2 �set_forbidden_pathsq s �z LinuxPolicy.set_forbidden_pathsc C � | j S �N)�release�r* r1 r1 r2 �kernel_versionx � zLinuxPolicy.kernel_versionc C r5 r6 )�hostnamer8 r1 r1 r2 � host_name{ r: zLinuxPolicy.host_namec C r5 r6 )�smpr8 r1 r1 r2 �
is_kernel_smp~ r: zLinuxPolicy.is_kernel_smpc C r5 r6 )�machiner8 r1 r1 r2 �get_arch� r: zLinuxPolicy.get_archc C � | � � S )z)Returns the name usd in the pre_work step)r< r8 r1 r1 r2 �get_local_name� s zLinuxPolicy.get_local_namec C s t �dd|�S )Nz[^-a-z,A-Z.0-9]� )�re�sub)r* r% r1 r1 r2 �sanitize_filename� s z LinuxPolicy.sanitize_filenamec C s4 | t kr | �|� d S |�d| j � | �|� d S )Nz%s Distribution Policy)r �display_self_help� set_title�distro�display_distro_help�r3 �sectionr1 r1 r2 � display_help� s zLinuxPolicy.display_helpc C s |� d� |�d� d S )NzSoS Distribution Policiesz�Distributions supported by SoS will each have a specific policy defined for them, to ensure proper operation of SoS on those systems.)rH �add_textrK r1 r1 r2 rG � s
�z LinuxPolicy.display_self_helpc C s | j r| j tj ur|�| j � n|�d� | d d d�}|�d|j � |jd|j dd� |jd|j dd� |�d�}| jD ]}|jd�d |d
|d �dd� q?|�d �}|jt d
�d ddd��dd� |j
D ] }|j
| }d � |j �
� �}|jd
�d ||j|�dd� qid S )Nz;
Detailed help information for this policy is not availableFz Default --upload location: %sz Default container runtime: %s)�newlinez"$PATH used when running report: %szReference URLsz{:>8}{:<30}{:<40}� r � z#Presets Available With This Policy
z{:>8}{:<20}{:<45}{:<30}z Preset Name� DescriptionzEnabled Options)�__doc__r rN � _upload_urlr& �PATH� add_section� vendor_urls�formatr �presets�join�opts�to_args�desc) r3 rL �_pol�refsec�url�presec�preset�_preset�_optsr1 r1 r2 rJ � sV � ���
�
���
���z LinuxPolicy.display_distro_helpc C s^ t tjv r-tjt dv r-d| _ttjv r-tjt sdS tj�tjt | j �| _tjt S dS )z�Check if sos is running in a container and perform container
specific initialisation based on ENV_HOST_SYSROOT.
)r �oci�podmanTN)�
ENV_CONTAINERr �environ�
_in_container�ENV_HOST_SYSROOTr! �abspath�_tmp_dirr8 r1 r1 r2 r � s
�
zLinuxPolicy._container_initc C sj g | _ t�� j}tdd| jd��� }| j �dd� |dd� D �� | �d| �}z.t |d �� }|D ]}|�
d
�d �
d �d }| j � |� q1W d � n1 sPw Y W n t y_ Y nw d
dd�}| �d| �}g } z*t |d ��}
|
D ]}d|v r�| � |�
d�d � qwW d � n1 s�w Y W n t y� Y nw |D ]} || | v r�| j � | � q�dS )zxObtain a list of loaded kernel modules to reference later for plugin
enablement and SoSPredicate checks
�lsmodr )�timeoutr c S s g | ]
}|� � d �� �qS )r )�split�strip)�.0�liner1 r1 r2 �
<listcomp>� s �z3LinuxPolicy.init_kernel_modules.<locals>.<listcomp>rQ Nz#/usr/lib/modules/%s/modules.builtin�rr ���z.ko�CONFIG_NET_DEVLINK�CONFIG_BLK_DEV_DM)�devlink�dm_modz/boot/config-%sz=y)
� kernel_modsr �unamer7 r
r �
splitlines�extend� join_sysroot�openro �append�IOError) r* r7 �lines�builtins�mfilerr �kmod�config_strings�
booted_config�kconfigs�kfile�builtinr1 r1 r2 r � sT
�� � �� �� �� �� � ��z LinuxPolicy.init_kernel_modulesc C s* | j r| j dkrtj�| j |�d��}|S )Nr )r r r! rZ �lstrip)r* r! r1 r1 r2 r~ s zLinuxPolicy.join_sysrootc C s� | j d }|jr |jnd}|jr| �� |j| _|j| _|j| _|j| _d| _ |j
sM|j sMz|r7|| j d _n t t
d�| �| j d _W n tyL � w |jrT|j| _|j
s{|j s{z|jrj| �� rj| �� | �� | j�d� W d S tyz � w d S )N� cmdlineoptsrC zSOptionally, please enter the case id that you are generating this report for [%s]: )�commons�case_id� low_priority�_configure_low_priority�
upload_url� upload_user�upload_directory� upload_pass�upload_password�upload_archive_name�batch�quiet�input�_�KeyboardInterrupt�upload�get_upload_url�prompt_for_upload_user�prompt_for_upload_password�ui_log�info)r* � cmdline_opts�caseidr1 r1 r2 �pre_work sN
�� �� �� ��zLinuxPolicy.pre_workc
C s� t �� }td�r2td|� �dd�}|d dkr | j�d� nd|d � d
|d � d �}| j�|� n| j�d � zt � d
� | j�d� W dS t
yb } z| j�d|� �� W Y d}~dS d}~ww )ay Used to constrain sos to a 'low priority' execution, potentially
letting individual policies set their own definition of what that is.
By default, this will attempt to assign sos to an idle io class via
ionice if available. We will also renice our own pid to 19 in order to
not cause competition with other host processes for CPU time.
�ionicezionice -c3 -p � �rn �statusr zSet IO class to idlez Error setting IO class to idle: �outputz (exit code �)zNWarning: unable to constrain report to idle IO class: ionice is not available.� z Set niceness of report to 19z%Error setting report niceness to 19: N) r �getpidr r
�soslogr� �errorr� �warning�nice� Exception)r* �_pid�ret�msg�errr1 r1 r2 r� D s*
� ��
��z#LinuxPolicy._configure_low_priorityc C s* | � � sd| �� }tt|��| _dS dS )zdShould be overridden by policies to determine if a user needs to
be provided or not
z#Please provide upload user for %s: N)�get_upload_userr� r� r� r� �r* r� r1 r1 r2 r� c s �z"LinuxPolicy.prompt_for_upload_userc C s8 | � � s| �� | jkrd| �� }t|�| _dS dS dS )zsShould be overridden by policies to determine if a password needs to
be provided for upload or not
z+Please provide the upload password for %s: N)�get_upload_passwordr� � _upload_userr r� r� r1 r1 r2 r� k s ���z&LinuxPolicy.prompt_for_upload_passwordc C sL || _ | js | �� | _| jstd��| �� }| j�td| �� � ��� |� S )a
Entry point for sos attempts to upload the generated archive to a
policy or user specified location.
Curerntly there is support for HTTPS, SFTP, and FTP. HTTPS uploads are
preferred for policy-defined defaults.
Policies that need to override uploading methods should override the
respective upload_https(), upload_sftp(), and/or upload_ftp() methods
and should NOT override this method.
:param archive: The archive filepath to use for upload
:type archive: ``str``
In order to enable this for a policy, that policy needs to implement
the following:
Required Class Attrs
:_upload_url: The default location to use. Note these MUST include
protocol header
:_upload_user: Default username, if any else None
:_upload_password: Default password, if any else None
The following Class Attrs may optionally be overidden by the Policy
:_upload_directory: Default FTP server directory, if any
The following methods may be overridden by ``Policy`` as needed
`prompt_for_upload_user()`
Determines if sos should prompt for a username or not.
`get_upload_user()`
Determines if the default or a different username should be used
`get_upload_https_auth()`
Format authentication data for HTTPS uploads
`get_upload_url_string()`
Print a more human-friendly string than vendor URLs
z;No upload destination provided by policy or by --upload-urlzAttempting upload to ) r� r� r� r� �_determine_upload_typer� r� r� �get_upload_url_string)r* �archive� upload_funcr1 r1 r2 �upload_archiveu s ,
�zLinuxPolicy.upload_archivec C sx | j | j| jd�}| jd j|�� v r|| jd j S d| jvr$td��| j�d�\}}||�� vr8td| ��|| S )a Based on the url provided, determine what type of upload to attempt.
Note that this requires users to provide a FQDN address, such as
https://myvendor.com/api or ftp://myvendor.com instead of
myvendor.com/api or myvendor.com
)�ftp�sftp�httpsr� z://z#Must provide protocol in upload URLz(Unsupported or unrecognized protocol: %s) �
upload_ftp� upload_sftp� upload_httpsr� �upload_protocolr( r� r� ro )r* �prots�protr` r1 r1 r2 r� � s �
z"LinuxPolicy._determine_upload_typec C s& |s| � � }|s | �� }tj�||�S )ag Formats the user/password credentials using basic auth
:param user: The username for upload
:type user: ``str``
:param password: Password for `user` to use for upload
:type password: ``str``
:returns: The user/password auth suitable for use in reqests calls
:rtype: ``requests.auth.HTTPBasicAuth()``
)r� r� �requests�auth�
HTTPBasicAuth)r* �user�passwordr1 r1 r2 �get_upload_https_auth� s
z!LinuxPolicy.get_upload_https_authc C s | j p| jS )z�Helper function to determine if we should use the policy default
upload url or one provided by the user
:returns: The URL to use for upload
:rtype: ``str``
)r� rT r8 r1 r1 r2 r� � s zLinuxPolicy.get_upload_urlc C rA )z�Used by distro policies to potentially change the string used to
report upload location from the URL to a more human-friendly string
)r� r8 r1 r1 r2 r� � s z!LinuxPolicy.get_upload_url_stringc C � t �dd�p | jp | jS )z�Helper function to determine if we should use the policy default
upload user or one provided by the user
:returns: The username to use for upload
:rtype: ``str``
�
SOSUPLOADUSERN)r �getenvr� r� r8 r1 r1 r2 r� � s
��zLinuxPolicy.get_upload_userc C r� )a_ Helper function to determine if we should use the policy default
upload password or one provided by the user
A user provided password, either via option or the 'SOSUPLOADPASSWORD'
environment variable will have precendent over any policy value
:returns: The password to use for upload
:rtype: ``str``
�SOSUPLOADPASSWORDN)r r� r� �_upload_passwordr8 r1 r1 r2 r� � s
��z LinuxPolicy.get_upload_passwordc C s� t d�std��zddl}W n ty td��w d}|s"| �� }|s(| �� }| �� �dd�}d ||f }|j|d
d �}d d
d|j |j
g}|j |dd�} | dkrTd}nL| dkr}|� |� d d|j |j
g}
|j |
dd�dk}|s||�
� td| �� ��n#| dkr�td| �� ��| dkr�td| �� ��| dkr�td|j ��|s�|�
� td | �� ��d | j| �� f } |� | � d |j |j
d g} |j | d d�}
|
dkr�|� d!� dS |
dkr�td"��|
dkr�td#|j ��|
dkr�td$��td%|j ��)&a� Attempts to upload the archive to an SFTP location.
Due to the lack of well maintained, secure, and generally widespread
python libraries for SFTP, sos will shell-out to the system's local ssh
installation in order to handle these uploads.
Do not override this method with one that uses python-paramiko, as the
upstream sos team will reject any PR that includes that dependency.
r� z SFTP is not locally supportedr NzFSFTP upload requires python3-pexpect, which is not currently installedFzsftp://rC z%sftp -oStrictHostKeyChecking=no %s@%szutf-8)�encodingzsftp>z password:zConnection refused� r� TrQ zPermission denied�
z%Incorrect username or password for %s� z)Connection refused by %s. Incorrect port?� z#Timeout hit trying to connect to %s� z.Unexpected error trying to connect to sftp: %sz Unable to connect via SFTP to %sz put %s %sz100%zNo such file or directory� �byez Timeout expired while uploadingz Unknown error during upload: %sz&Unable to write archive to destinationz#Unexpected response from server: %s)r r� �pexpect� ImportErrorr� r� r� �replace�spawn�TIMEOUT�EOF�expect�sendline�closer� �beforer� �_get_sftp_upload_name)r* r� r� r� �sftp_connected�sftp_url�sftp_cmdr� � sftp_expectsr. � pass_expects�put_cmd� put_expects� put_successr1 r1 r2 r� � s� � �
��������
�
zLinuxPolicy.upload_sftpc C s* | j �d�d }| jrtj�| j|�}|S )a If a specific file name pattern is required by the SFTP server,
override this method in the relevant Policy. Otherwise the archive's
name on disk will be used
:returns: Filename as it will exist on the SFTP server
:rtype: ``str``
r ru )r� ro r� r r! rZ )r* �fnamer1 r1 r2 r� a s z!LinuxPolicy._get_sftp_upload_namec C s t j| �� || �� |d�S )z�If upload_https() needs to use requests.put(), use this method.
Policies should override this method instead of the base upload_https()
:param archive: The open archive file object
)�datar� �verify)r� �putr� r� )r* r� r� r1 r1 r2 �_upload_https_putn s �z LinuxPolicy._upload_https_putc C s i S )zJDefine any needed headers to be passed with the POST request here
r1 r8 r1 r1 r2 �_get_upload_headersy s z LinuxPolicy._get_upload_headersc C s8 d|j �d�d || �� fi}tj| �� || �� |d�S )z�If upload_https() needs to use requests.post(), use this method.
Policies should override this method instead of the base upload_https()
:param archive: The open archive file object
�filer ru )�filesr� r� )r% ro r� r� �postr� r� )r* r� r� r� r1 r1 r2 �_upload_https_post~ s �� �z LinuxPolicy._upload_https_postc C s� t std��t| jd��R}| jd jdkr| j}n| jd j}| jd jdu }|dkr2| �||�}n| � ||�}|j
dkrU|j
dkrU|j
d krKtd
��td |j
|j f �� W d � d
S 1 saw Y d S )z�Attempts to upload the archive to an HTTPS location.
:returns: ``True`` if upload is successful
:rtype: ``bool``
:raises: ``Exception`` if upload was unsuccessful
z7Unable to upload due to missing python requests library�rbr� �autoFr� �� �� i� z/Authentication failed: invalid user credentialsz POST request returned %s: %sNT) �REQUESTS_LOADEDr� r r� r� �
upload_method�_upload_method�upload_no_ssl_verifyr� r� � status_code�reason)r* �arc�methodr� rt r1 r1 r2 r� � s(
�
�$�zLinuxPolicy.upload_httpsc
C s� z
ddl }ddl}W n ty td��w |s | �� }|du r$td��|�dd�}|s0| �� }|s6| �� }|s>| jp=| j }z|j
|||dd�}|sNtd ��|� |� W nU |j yb td
| �� |j
yo td | �� |jy� } z.t|��� d } | d kr�td
| ��| dkr�td| ��| dkr�td| ��tdt|� ��d}~ww z+t| jd��}
|�d| j�d�d |
� W d � n1 s�w Y |�� W dS ty� td��w )aT Attempts to upload the archive to either the policy defined or user
provided FTP location.
:param url: The URL to upload to
:type url: ``str``
:param directory: The directory on the FTP server to write to
:type directory: ``str`` or ``None``
:param user: The user to authenticate with
:type user: ``str``
:param password: The password to use for `user`
:type password: ``str``
:returns: ``True`` if upload is successful
:rtype: ``bool``
:raises: ``Exception`` if upload in unsuccessful
r Nz missing python ftplib libraryzIno FTP server specified by policy, use --upload-url to specify a locationzftp://rC r� r� z3connection failed, did you set a user and password?z"timeout hit while connecting to %szunable to connect to %s�503zcould not login as '%s'�530z invalid password for user '%s'�550z$could not set upload directory to %sz%error trying to establish session: %sr� zSTOR %sr ru Tzcould not open archive file)�ftplib�socketr� r� r� r� r� r� r� �_upload_directory�FTP�cwdrn �gaierror�
error_perm�strro r r� �
storbinary�quitr� ) r* r` � directoryr� r� r r �sessionr� �errno�_arcfiler1 r1 r2 r� � sj � ���� � � �zLinuxPolicy.upload_ftpc C � dS )z�If sosreport commands need to always be prefixed with something,
for example running in a specific container image, then it should be
defined here.
If no prefix should be set, return an empty string instead of None.
rC r1 r8 r1 r1 r2 �set_sos_prefix� s zLinuxPolicy.set_sos_prefixc C r )zcIf a host requires additional cleanup, the command should be set and
returned here
rC r1 r8 r1 r1 r2 �set_cleanup_cmd s zLinuxPolicy.set_cleanup_cmdc C r )aI Returns the command that will create the container that will be
used for running commands inside a container on hosts that require it.
This will use the container runtime defined for the host type to
launch a container. From there, we use the defined runtime to exec into
the container's namespace.
:param image: The name of the image if not using the policy default
:type image: ``str`` or ``None``
:param auth: The auth string required by the runtime to pull an
image from the registry
:type auth: ``str`` or ``None``
:param force_pull: Should the runtime forcibly pull the image
:type force_pull: ``bool``
:returns: The command to execute to launch the temp container
:rtype: ``str``
rC r1 )r* �imager� �
force_pullr1 r1 r2 �create_sos_container
s z LinuxPolicy.create_sos_containerc C s d| j | jf S )a� Restarts the container created for sos collect if it has stopped.
This is called immediately after create_sos_container() as the command
to create the container will exit and the container will stop. For
current container runtimes, subsequently starting the container will
default to opening a bash shell in the container to keep it running,
thus allowing us to exec into it again.
z %s start %s��container_runtime�sos_container_namer8 r1 r1 r2 �restart_sos_container! s �z!LinuxPolicy.restart_sos_containerc C s | j r d| j | j|f S |S )a Returns the command that allows us to exec into the created
container for sos collect.
:param cmd: The command to run in the sos container
:type cmd: ``str``
:returns: The command to execute to run `cmd` in the container
:rtype: ``str``
z
%s exec %s %sr )r* �cmdr1 r1 r2 �format_container_command- s
�z$LinuxPolicy.format_container_command)NNTN)NN)T)NNNN)NNF)A�__name__�
__module__� __qualname__rS rI �vendorrU r+ rT r r� r� r� r& �_preferred_hash_namer� r� r� �
containerized�container_image�sos_path_strip� sos_pkg_name� sos_bin_pathr �container_version_command�container_authfiler � classmethodr4 r9 r< r> r@ rB rF rM rG rJ r r r~ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r �
__classcell__r1 r1 r/ r2 r ' s� �(
1/1
8
d
O
r c @ s e Zd ZdZdgZdZdZdS )�GenericLinuxPolicyz�This Policy will be returned if no other policy can be loaded. This
should allow for IndependentPlugins to be executed on any system)zUpstream Projectz https://github.com/sosreport/sos�SoSa SoS was unable to determine that the distribution of this system is supported, and has loaded a generic configuration. This may not provide desired behavior, and users are encouraged to request a new distribution-specifc policy at the GitHub project above.
N)r! r" r# rS rW r$ � vendor_textr1 r1 r1 r2 r/ ? s
r/ ) r rD r �sosr r� � sos.policiesr �sos.policies.init_systemsr �!sos.policies.init_systems.systemdr �sos.policies.runtimes.crior � sos.policies.runtimes.podmanr � sos.policies.runtimes.dockerr �
sos.utilitiesr
r r r
r� r� r� rg rj r r/ r1 r1 r1 r2 �<module> s6
�