U

i��d�z�@s�dd
lZdd
l
Z
ddlmZ
ddlmZ
ddlmZ
ddlm	Z	
ddl
mZ
ddlm
Z

ddlmZ
dd	lmZ
dd
lmZmZmZmZ
zdd
lZdZWnek
r�


dZYnXd
ZdZGdd�de�ZGdd�de�Zd
S)�N)
�getpass)
�_sos)
�Policy)
�
InitSystem)
�SystemdInit)
�CrioContainerRuntime)
�PodmanContainerRuntime)
�DockerContainerRuntime)�	shell_out�
is_executable�bold�sos_get_command_outputTFZ	containerZHOSTcs�
eZ
dZd
ZdZdZdZdZdZdZ	dZ
dZdZdZ
dZdZdZdZdZdZdZdZd	Zd
ZdZdZdV�f
dd
�	Zedd��
Zdd�Zdd�Zdd�Zdd�Z dd�Z!dd�Z"edd��
Z#edd��
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=�Z3dXd>d?�
Z4d@dA�Z5dYdBdC�
Z6dDdE�Z7dZdFdG�
Z8dHdI�Z9d[dJdK�
Z:dLdM�Z;dNdO�Z<d\dPdQ�
Z=dRdS�Z>dTdU�Z?�Z@S)]�LinuxPolicyzfThis policy is meant to be an abc class that provides common
    implementations used in Linux distrosZLinux�Nonez/bin:/sbin:/usr/bin:/usr/sbinN�
/�dockerFz/usr/binzsos-collector-tmpTcs 
tt
|�j|
||d
�
|
r"|
|_n|��p,d|_|��
|dk	rH||_n$tj�	d�
rdt
|jd�
|_nt�|_i|_|j
�
rt|d�
t|d�
t|d�
g}|D]F}|��r�||j|j<|j|jkr�|j|j|jd<|j|j��
q�|j�
rd|j��k�
rt|j���
}|j|d|jd<dS)N)�sysroot�
probe_runtime�remote_execrz/run/systemd/system/)
�chroot)
Zpolicy�defaultr
)�superr�__init__r�_container_init�init_kernel_modulesZinit_system�os�path�isdirrrZruntimesrrr	rZcheck_is_active�name�default_container_runtimeZload_container_info�keys�list)�selfr�initrrZ_crunZruntime�idx�
�	__class__��?/usr/lib/python3/dist-packages/sos/policies/distros/__init__.pyrIs8

�






�





zLinuxPolicy.__init__c

Csd
dgS)Nz/etc/passwdz/etc/shadowr')
�clsr'r'r(�set_forbidden_pathsqs
�zLinuxPolicy.set_forbidden_pathsc


Cs|jS�
N)
�release�
r"r'r'r(�kernel_versionxs
zLinuxPolicy.kernel_versionc


Cs|jSr+)
Zhostnamer-r'r'r(�	host_name{s
zLinuxPolicy.host_namec


Cs|jSr+)
Zsmpr-r'r'r(�
is_kernel_smp~s
zLinuxPolicy.is_kernel_smpc


Cs|jSr+)
�machiner-r'r'r(�get_arch�s
zLinuxPolicy.get_archc

Cs|��S)
z)Returns the name usd in the pre_work step)
r/r-r'r'r(�get_local_name�szLinuxPolicy.get_local_namecCst�
d
d|
�S)Nz[^-a-z,A-Z.0-9]�)�re�sub)r"rr'r'r(�sanitize_filename�s
zLinuxPolicy.sanitize_filenamecCs2|tkr|�
|
�

n|
�d
|j�

|�|
�

dS)Nz%s Distribution Policy)r�display_self_help�	set_title�distro�display_distro_help�r)�sectionr'r'r(�display_help�s

zLinuxPolicy.display_helpcCs|
�d
�

|
�
d�

dS)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.)r9�add_textr<r'r'r(r8�s


�zLinuxPolicy.display_self_helpc	Cs
|jr |jt
jk	r |
�|j�

n
|
�d
�

|ddd�}|
�d|j�

|
jd|jdd�
|
jd|jdd�
|
�d�
}|jD]$}|jd�d	|d
|d�dd�
q~|
�d�
}|jt	d
�d	ddd��
dd�
|j
D]:}|j
|}d	�|j�
��
}|jd
�d	||j|�dd�
q�dS)Nz;
Detailed help information for this policy is not availableFzDefault --upload location: %szDefault 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}zPreset NameZDescriptionzEnabled Options)�__doc__rr?�_upload_urlr�PATHZadd_section�vendor_urls�formatrZpresets�joinZoptsZto_argsZdesc)	r)r=Z_polZrefsec�urlZpresecZpresetZ_presetZ_optsr'r'r(r;�sZ

�

�

�

�





�





���






��zLinuxPolicy.display_distro_helpc

Cs^tt
jkrZt
jtd
krZd|_tt
jkrZt
jts6dSt
j�t
jt|j�
|_t
jtSdS)z�Check if sos is running in a container and perform container
        specific initialisation based on ENV_HOST_SYSROOT.
        )rZociZpodmanTN)�
ENV_CONTAINERr�environZ
_in_container�ENV_HOST_SYSROOTr�abspathZ_tmp_dirr-r'r'r(r�s








�

zLinuxPolicy._container_initc
	CsL
g|_t
��j}
td
d|jd���}|j�dd�|dd�D�
�

|�d|
�
}zHt	|d	��4}|D](}|�
d
�
d�
d�
d}|j�|�

qbW5QRXWntk
r�


YnXd
dd�}|�d|
�
}g}	z@t	|d	��,}
|
D] }d|kr�|	�|�
d�
d�

q�W5QRXWntk
�
r 


YnX|D] }|||	k�
r&|j�|�

�
q&dS)zxObtain a list of loaded kernel modules to reference later for plugin
        enablement and SoSPredicate checks
        Zlsmodr
)�timeoutrc
Ssg|]}
|
��d�
��qS)
r
)�split�strip)�.0�liner'r'r(�
<listcomp>�s
z3LinuxPolicy.init_kernel_modules.<locals>.<listcomp>rBNz#/usr/lib/modules/%s/modules.builtin�
rr���z.koZCONFIG_NET_DEVLINKZCONFIG_BLK_DEV_DM)ZdevlinkZdm_modz/boot/config-%sz=y)
Zkernel_modsr�unamer,r
r�
splitlines�extend�join_sysroot�openrO�append�IOError)r"r,�lines�builtinsZmfilerRZkmodZconfig_stringsZ
booted_configZkconfigsZkfileZbuiltinr'r'r(r�s>




�
�






�





$



zLinuxPolicy.init_kernel_modulescCs*|jr&|jd
kr&t
j�|j|
�d
�
�}
|
S)Nr)rrrrH�lstrip)r"rr'r'r(rY
s


zLinuxPolicy.join_sysrootc
Cs

|jd
}
|
j
r|
j
nd}|
jr(|��
|
j|_|
j|_|
j|_|
j|_d|_	|
j
s�|
js�z.|rn||jd
_
ntt
d�
|�
|jd
_
Wntk
r�


�YnX|
j
r�|
j
|_
|
j
�
s|
j�
sz.|
jr�|��r�|��
|��
|j�d�

Wntk
�
r


�YnXdS)N�cmdlineoptsr4zSOptionally, please enter the case id that you are generating this report for [%s]: )�commonsZcase_idZlow_priority�_configure_low_priority�
upload_url�upload_user�upload_directoryZupload_pass�upload_password�upload_archive_nameZbatch�quiet�input�
_�KeyboardInterruptZupload�get_upload_url�prompt_for_upload_user�prompt_for_upload_password�ui_log�info)r"Zcmdline_optsZcaseidr'r'r(�pre_work
sF







�



��



�




zLinuxPolicy.pre_workc

Cs�t�
�}
td
�
rdtd|
��dd�}|ddkr<|j�d�

qpd|d	�d
|d�d�}|j�|�

n|j�d�

zt�	d
�

|j�d�

Wn4t
k
r�
}
z|j�d|���

W5d}~XYnXdS)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.
        Zionicezionice -c3 -p ��
rNZstatusr
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.�zSet niceness of report to 19z%Error setting report niceness to 19: N)r�getpidrr
Zsoslogrp�errorroZwarning�nice�	Exception)r"Z_pid�ret�msg�errr'r'r(rbD
s$


�

�




z#LinuxPolicy._configure_low_priorityc
Cs&|��s"d
|�
�}
tt|
�
�
|_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_userrlrirjrd�r"r|r'r'r(rmc
s

z"LinuxPolicy.prompt_for_upload_userc
Cs0|��s,|�
�|jkr,d
|�
�}
t|
�
|_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_userrrfrr'r'r(rnk
s
�
�z&LinuxPolicy.prompt_for_upload_passwordcCsL|
|_|j
s|��|_
|j
s$td
�
�
|��}|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 )	rgrcrlrz�_determine_upload_typerorprj�get_upload_url_string)r"�archiveZupload_funcr'r'r(�upload_archiveu
s,






�zLinuxPolicy.upload_archivec
Csx|j|j
|jd
�}
|jdj|
��kr6|
|jdjSd|jkrHtd�
�
|j�d�
\}}||
��krptd|�
�
|
|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
        )Zftp�sftpZhttpsr`z://z#Must provide protocol in upload URLz(Unsupported or unrecognized protocol: %s)	�
upload_ftp�upload_sftp�upload_httpsraZupload_protocolr rcrzrO)r"ZprotsZprotrIr'r'r(r��
s

�







z"LinuxPolicy._determine_upload_typecCs&|
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�authZ
HTTPBasicAuth)r"�user�passwordr'r'r(�get_upload_https_auth�
s



z!LinuxPolicy.get_upload_https_authc


Cs|jp
|j
S)
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``
        )rcrDr-r'r'r(rl�
szLinuxPolicy.get_upload_urlc

Cs|��S)
z�Used by distro policies to potentially change the string used to
        report upload location from the URL to a more human-friendly string
        )
rlr-r'r'r(r��
sz!LinuxPolicy.get_upload_url_stringc

Cst�
d
d�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``
        Z
SOSUPLOADUSERN)r�getenvrdr�r-r'r'r(r~�
s

��zLinuxPolicy.get_upload_userc

Cst�
d
d�p|jp|jS)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``
        ZSOSUPLOADPASSWORDN)rr�rf�_upload_passwordr-r'r'r(r��
s


��zLinuxPolicy.get_upload_passwordcCstd
�
st
d�
�
zddl}Wntk
r8


t
d�
�
YnXd}|
sJ|��}
|sV|��}|���dd�}d	|
|f}|j|d
d�}dd
d|j	|j
g}|j|dd�}	|	dkr�d}n�|	dk�
r|�|�

dd|j	|j
g}
|j|
dd�dk}|�
sT|�
�
t
d|���
�
nP|	dk�
r t
d|���
�
n4|	dk�
r<t
d|���
�
n|	dk�
rTt
d|j�
�
|�
sr|�
�
t
d|���
�
d|j|��f}|�|�

d|j	|j
dg}|j|d d�}
|
dk�
r�|�d!�

dS|
dk�
r�t
d"�
�
n<|
dk�
r�t
d#|j�
�
n"|
dk�rt
d$�
�
nt
d%|j�
�
dS)&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�zSFTP is not locally supportedr
NzFSFTP upload requires python3-pexpect, which is not currently installedFzsftp://r4z%sftp -oStrictHostKeyChecking=no %s@%szutf-8)
�encodingzsftp>z	password:zConnection refused�rsTrBzPermission 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�ZbyezTimeout expired while uploadingzUnknown error during upload: %sz&Unable to write archive to destinationz#Unexpected response from server: %s)rrz�pexpect�ImportErrorr~r�rl�replaceZspawnZTIMEOUTZEOFZexpectZsendline�closer�Zbeforerg�_get_sftp_upload_name)r"r�r�r�Zsftp_connectedZsftp_urlZsftp_cmdr{Zsftp_expectsr$Zpass_expectsZput_cmdZput_expectsZput_successr'r'r(r��
s�












�







�



�


�


�


�


�
�



�














zLinuxPolicy.upload_sftpc
Cs*|j�
d
�
d}
|jr&tj�|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``
        rrU)rgrOrerrrH)r"�fnamer'r'r(r�as


z!LinuxPolicy._get_sftp_upload_namecCstj
|��|
|��|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��putrlr�)r"r�r�r'r'r(�_upload_https_putns

�zLinuxPolicy._upload_https_putc


CsiS)
zJDefine any needed headers to be passed with the POST request here
        r'r-r'r'r(�_get_upload_headersyszLinuxPolicy._get_upload_headerscCs8d
|
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
        �filerrU)�filesr�r�)rrOr�r�Zpostrlr�)r"r�r�r�r'r'r(�_upload_https_post~s
��

�zLinuxPolicy._upload_https_postc
	Cs�tst
d
�
�
t|jd���}
|jdjdkr2|j}n|jdj}|jdjdk}|dkrd|�|
|�}n|�	|
|�}|j
dkr�|j
dkr�|j
d	kr�t
d
�
�
t
d|j
|jf�
�
W5QR�dSQRXd
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 credentialszPOST request returned %s: %sTN)�REQUESTS_LOADEDrzrZrgraZ
upload_method�_upload_methodZupload_no_ssl_verifyr�r�Zstatus_code�reason)r"Zarc�methodr�rTr'r'r(r��s&










�

�zLinuxPolicy.upload_httpsc
Cs�
zd
dl}d
dl
}Wntk
r0


td�
�
YnX|
s>|��}
|
dkrNtd�
�
|
�dd�}
|sf|��}|sr|��}|s�|jp�|j	}z,|j
|
||dd�}|s�td	�
�
|�|�

Wn�|jk
r�


td
|
�
�
Yn�|j
k
r�


td|
�
�
Yn�|jk
�
rv
}
zft|�
��d
}	|	dk�
r*td
|�
�
|	dk�
r@td|�
�
|	dk�
rVtd|�
�
tdt|�
�
�
W5d}~XYnXzBt|jd��"}
|�d|j�d�
d|
�
W5QRX|��
WdStk
�
r�


td�
�
YnXdS)aTAttempts 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
Nzmissing python ftplib libraryzIno FTP server specified by policy, use --upload-url to specify a locationzftp://r4r�rsz3connection failed, did you set a user and password?z"timeout hit while connecting to %szunable to connect to %sZ503zcould not login as '%s'Z530zinvalid password for user '%s'Z550z$could not set upload directory to %sz%error trying to establish session: %sr�zSTOR %srrUTzcould not open archive file)�ftplib�socketr�rzrlr�r~r�re�_upload_directoryZFTP�cwdrNZgaierrorZ
error_perm�strrOrZrgZ
storbinary�quitr\)r"rIZ	directoryr�r�r�r�Zsessionr}�errnoZ_arcfiler'r'r(r��s`



























�
�



�


zLinuxPolicy.upload_ftpc


Csd
S)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.
        r4r'r-r'r'r(�set_sos_prefix�szLinuxPolicy.set_sos_prefixc


Csd
S)zcIf a host requires additional cleanup, the command should be set and
        returned here
        r4r'r-r'r'r(�set_cleanup_cmdszLinuxPolicy.set_cleanup_cmdc
Csd
S)aIReturns 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``
        r4r')r"Zimager�Z
force_pullr'r'r(�create_sos_container
sz LinuxPolicy.create_sos_containerc

Csd
|j|j
fS)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�Zcontainer_runtime�sos_container_namer-r'r'r(�restart_sos_container!s	
�z!LinuxPolicy.restart_sos_containercCs |jrd
|j|j
|
fS|
SdS)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 %sNr�)r"�cmdr'r'r(�format_container_command-s



�z$LinuxPolicy.format_container_command)NNTN)NN)NN)
T)
T)NNNN)NNF)A�__name__�
__module__�__qualname__rCr:�vendorrEr#rDr�r�r�r�rZ_preferred_hash_namercrdrfZ
containerizedZcontainer_imageZsos_path_stripZsos_pkg_nameZsos_bin_pathr�Zcontainer_version_commandZcontainer_authfiler�classmethodr*r.r/r0r2r3r7r>r8r;rrrYrqrbrmrnr�r�r�rlr�r~r�r�r�r�r�r�r�r�r�r�r�r�r��
__classcell__r'r'r%r(r's�




















�(







1/1
8
	
d


O	
rc
@seZ
dZd
Zdg
ZdZdZdS)�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/sosZSoSa

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�rCrFr�Zvendor_textr'r'r'r(r�?s


r�)rr5rZsosrrjZsos.policiesrZsos.policies.init_systemsrZ!sos.policies.init_systems.systemdrZsos.policies.runtimes.criorZsos.policies.runtimes.podmanrZsos.policies.runtimes.dockerr	Z
sos.utilitiesr
rrr
r�r�r�rJrLrr�r'r'r'r(�<module>s2