File: //opt/alt/python37/lib/python3.7/site-packages/xray/internal/__pycache__/utils.cpython-37.pyc
B
�V�d�a � @ s0 d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl m m
Z ddlmZ ddlmZmZ ddlmZ ddlmZ ddlmZmZmZmZmZm Z m Z ddl m Z dd l m!Z!m"Z"m#Z# ddl$Z$dd
l%m&Z& dd l'm(Z( dd l)m*Z* dd
l+m,Z,m-Z- ddl.m/Z/m0Z0m1Z1m2Z2 ddl3m4Z4 ddl5m6Z6 ddl7m8Z8 ddl9m:Z: ddl;m<Z<m=Z=m>Z>m?Z?m@Z@mAZA ddlBmCZC e�Dd�ZEeFeGejHfZIe0jJjKe0jLjKe0jMjKgZNe!e!d�dd�ZOe!e!d�dd�ZPe!e!d�d d �ZQeRd �d d �ZSed �d!d"�ZTeRed#�d$d%�ZUeVd �d&d'�ZWe"eX eVd(�d)d*�ZYe"eX eVd(�d+d,�ZZeVd �d-d.�Z[eVdd/�d0d1�Z\eVd �d2d3�Z]dweVe#e^ d4�d5d6�Z_eQeVd �d7d8��Z`eVe#eV d9�d:d;�Zae#eV d �d<d=�Zbdd �d>d?�ZceVe#eV d@�dAdB�ZdeVeVddC�dDdE�ZeeVdFdG�dHdI�ZfeReRdJ�dKdL�ZgeVe#eh dM�dNdO�ZieVe#eV dM�dPdQ�ZjdxeVddM�dRdS�ZkeVe^dM�dTdU�Zle^d �dVdW�Zme^d �dXdY�Zne^ddZ�d[d\�Zoe^d �d]d^�Zpe^d �d_d`�Zqe^d �dadb�ZreVe^d9�dcdd�Zsdedf� Ztedgddh�didj��ZuedyeVe^dl�dmdn��ZvedzeRddo�dpdq��Zwed{eReReRddt�dudv��ZxdS )|zB
This module contains helpful utility functions for X-Ray Manager
� N)�contextmanager)�date� timedelta)�wraps)�glob)�socket�fromfd�AF_UNIX� SOCK_STREAM�
SOCK_DGRAM�AF_INET�AF_INET6)�current_thread)�Callable�List�Optional)�AtexitIntegration)�LoggingIntegration)�Feature)�is_panel_feature_supported�get_cp_description)�
CLEditions�SupportedEditions�CLEditionDetectionError�get_cl_edition_readable)�UIConfig)�drop_privileges)�get_rhn_systemid_value)�php_get_vhost_versions_user� )�
sentry_dsn�local_tasks_storage�
agent_file�
logging_level�jwt_token_location�user_agent_sock)� XRayErrorZutils)�func�returnc s" dd� �t � �� �fdd��}|S )zf
Decorator aimed to update ini file in cagefs-skeleton
Applies to task.add nd task.remove
c
W s< t j�| d jd�}|�d�r>td�r>t j�d|dd� �}nT|�d�r�td �r�t j�d |dd� �}t j�t j�|��s�t �t j�|�� ndS t j�|�s�yt � |� W n: t
k
r� } z t j d
|t
|�d �d � W dd}~X Y nX nNyt�||� W n< t
k
�r6 } z t j d
|t
|�d �d � W dd}~X Y nX dS )zd
Copy ini file to cagefs-skeleton
Action takes place for cPanel ea-php only
r zxray.iniz /opt/cpanelz/usr/share/cagefsz"/usr/share/cagefs/.cpanel.multiphpr Nz
/usr/localz/usr/share/cagefs-skeletonz'Failed to unlink ini in cagefs-skeleton)Zxray_ini�err)�extraz'Failed to copy ini into cagefs-skeleton)�os�path�joinZ ini_location�
startswithr �exists�dirname�mkdir�unlink�OSError�logger�warning�str�shutil�copy)�argsZ original_iniZ skeleton_ini�e� r; �D/opt/alt/python37/lib/python3.7/site-packages/xray/internal/utils.py�updateP s2 $z skeleton_update.<locals>.updatec s � | |� �| � dS )z
Wraps func
Nr; )r9 �kwargs)r' r= r; r< �wrapperr s
z skeleton_update.<locals>.wrapper)r )r' r? r; )r' r= r< �skeleton_updateJ s "r@ c s, dd� �dd� �t � �� ��fdd��}|S )zs
Decorator aimed to update DBM storage with fake_id:real_id mapping
Applies to task.add nd task.remove
c W s, | d }t t��}|j||j< W dQ R X dS )z-
Update DBM storage contents
r N)� dbm_storager! Ztask_id�fake_id)r9 Z
task_instance� task_storager; r; r< r= � s
z"dbm_storage_update.<locals>.updatec W sB t t��0}y|| d j�� = W n tk
r2 Y nX W dQ R X dS )z.
Remove task from DBM storage
r N)rA r! rB �encode�KeyError)r9 rC r; r; r< �remove� s
z"dbm_storage_update.<locals>.removec
s� y� j dkr�| � W n. tk
rD } ztt|���W dd}~X Y nX y� | |� W n( tk
r| � j dkrv�| � � Y nX y� j dkr��| � W n. tk
r� } ztt|���W dd}~X Y nX dS )z
Wraps func
�addNrF )�__name__� RuntimeErrorr& r6 � Exception)r9 r> r: )r' rF r= r; r< r? � s
z#dbm_storage_update.<locals>.wrapper)r )r' r? r; )r' rF r= r< �dbm_storage_update} s rK c s" dd� � t ��� �fdd��}|S )z5
Decorator aimed to validate given JWT token
c S s t | � dS )z7
Check if retrieved JWT token is valid
N)�is_edition_supported)�_tokenr; r; r< �check� s zcheck_jwt.<locals>.checkc s �| |�}� |� |S )z
Wraps func
r; )r9 r> �token)rN r' r; r< r? � s
zcheck_jwt.<locals>.wrapper)r )r' r? r; )rN r' r< � check_jwt� s rP )r( c C s t t�� �S )zJ
Get current epoch timestamp as int
:return: timestamp as int
)�int�timer; r; r; r< � timestamp� s rS c C s t �� tdd� S )zC
Pick a yesterday date
:return: a datetime.date object
r )Zdays)r Ztodayr r; r; r; r< � prev_date� s rT )�tsr( c C s
t �| �S )zy
Get the datetime.date object for given int timestamp
:param ts: timestamp
:return: datetime.date object
)r Z
fromtimestamp)rU r; r; r< �date_of_timestamp� s rV c C s t � �d�S )zj
Get a formatted representation of yesterday date
:return: str date in the form of dd/mm/YYYY
z%d/%m/%Y)rT �strftimer; r; r; r< �get_formatted_date� s rX )�linksr( c s" d� d� � fdd�t| d�D ��S )z
HTML formatted links
z)<p>{num}) <a href={link}>{domain}</a></p>�
c s2 g | ]*\}}|� � D ]\}}� j|||d ��qqS ))�num�link�domain)�items�format)�.0�i�l�k�v)� html_itemr; r< �
<listcomp>� s z,get_html_formatted_links.<locals>.<listcomp>r )r- � enumerate)rY r; )re r< �get_html_formatted_links� s rh c s" d� d� � fdd�t| d�D ��S )z
Formatted links
z{num}) {dom}: {link}rZ c s2 g | ]*\}}|� � D ]\}}� j|||d ��qqS ))r[ Zdomr\ )r^ r_ )r` ra rb rc rd )� text_itemr; r< rf � s z,get_text_formatted_links.<locals>.<listcomp>r )r- rg )rY r; )ri r< �get_text_formatted_links� s rj c
C s� yHt �d�} | �� }|�d�j}t�� �}|�d|� W dQ R X |�d�S t t j
fk
rz } zt d�|�W dd}~X Y nX dS )ze
Obtain system ID from /etc/sysconfig/rhn/systemid
:return: system ID without ID- prefix
z/etc/sysconfig/rhn/systemidz(.//member[name='system_id']/value/string� system_idNzID-z Failed to retrieve system_id) �ET�parseZgetroot�find�text�
sentry_sdk�configure_scope�set_tag�lstripr3 Z
ParseErrorr& )Ztree�rootZwhole_id�scoper: r; r; r< � read_sys_id s
rv )�sys_idr( c C s$ t td��}|�| � W dQ R X dS )zH
Write system_id into file /usr/share/alt-php-xray/agent_sys_id
�wN)�openr" �write)rw �outr; r; r< � write_sys_id s r| c
C s` y t t��} | �� �� S Q R X W n: tk
rZ } z tjddt|�id� t� S d}~X Y nX dS )zA
Read system_id saved by agent during its initialization
Nz8Failed to retrieve agent's system_id, returning real oner) )r* ) ry r" �read�stripr3 r4 �errorr6 rv )Zagent_sysid_filer: r; r; r< �read_agent_sys_id s
r� )rM r( c
C sf yt j| dd�}W n. tk
r@ } zt|j�|�W dd}~X Y nX |tkrbtdt|��� � d���dS )z9Raise XRayError in case of detected non-supported editionT)Zraw_jwtZskip_marker_checkNzCL z" edition is not supported by X-Ray)r Zget_cl_editionr r& �message�SUPPORTED_EDITIONSr6 �
capitalize)rM Zeditionr: r; r; r< rL ) s rL c C sN y t t��} | �� �� S Q R X W n( ttfk
rH tdt� d���Y nX dS )zT
Obtain jwt token from /etc/sysconfig/rhn/jwt.token
:return: token read
Nz JWT file z read error)ry r$ r} r~ r3 �IOErrorr& )Z
token_filer; r; r< �read_jwt_token6 s
r� )�filepathr( c C sV y$t | ��}|�� �� }W dQ R X W n tk
r8 dS X d�|�d�dd� �pTdS )z8Get version of package from file. alt-php-xray supportedN�.� z0.0-0)ry r} r~ r3 r- �split)r� Zv_file�versionr; r; r< � pkg_versionC s
r� c C s t d�S )z#Get version of alt-php-xray packagez /usr/share/alt-php-xray/version)r� r; r; r; r< � xray_versionM s r� c s� t t t d�dd�} dd� }dd�dd �}d
d � � td�� fd d
� }ttjtjd�}t� pZd}t|d�}tj t
| |||gd� t� � �4}d|� i|_ y ||� W n t
k
r� Y nX W dQ R X dS )u�
Initialize Sentry client
shutdown_timeout=0 disables Atexit integration as stated in docs:
'it’s easier to disable it by setting the shutdown_timeout to 0'
https://docs.sentry.io/platforms/python/default-integrations/#atexit
On the other hand, docs say, that
'Setting this value too low will most likely cause problems
for sending events from command line applications'
https://docs.sentry.io/error-reporting/configuration/?platform=python#shutdown-timeout
)�event�hintr( c S s | d � ddi� | S )z�
Add extra data into sentry event
:param event: original event
:param hint: additional data caught
:return: updated event
r* z xray.versionz
0.5-26.el8)r= )r� r� r; r; r< �add_info] s z sentry_init.<locals>.add_infoc S s| t � }|r|�d�nd }|r&|�d�nd }d|fd|fdt�� fdtd�fdt� fd td
�ff}x|D ]}| j|� qfW d S ) Nr� �namezControl Panel NamezControl Panel VersionZkernelzCloudLinux versionZ
os_releasezCloudlinux editionZ ArchitectureZ architecture)r �get�platform�releaser r rr )Z sentry_scopeZcp_descriptionZ
cp_versionZcp_nameZtags�tagr; r; r< �set_tagsg s
z sentry_init.<locals>.set_tagsN)r( c S s d S )Nr; )�pending�timeoutr; r; r< �nopew s zsentry_init.<locals>.nopec S sR t | t��>}y |�|df� |�� d }W n tk
rB d}Y nX W dQ R X |S )aI
address_family - we can choose constants represent the address
(and protocol) families
(AF_INET for ipv4 and AF_INET6 for ipv6)
private_ip - specify some private ip address. For instance:
ipv4 -> 10.255.255.255 or ipv6 -> fc00::
r r N)r r �connectZ getsocknamerJ )Zaddress_familyZ
private_ip�s�IPr; r; r< �
try_get_ipz s z sentry_init.<locals>.try_get_ipc s8 t dftdff} x"| D ]\}}� ||�}|r|S qW dS )z&
Retrieve server's IP
z10.255.255.255zfc00::z 127.0.0.1)r r
)Z
ipversionsZaddr_famZpriv_ipZip)r� r; r< �ip_addr� s
z sentry_init.<locals>.ip_addr)�levelZ event_levelzalt-php-xray@0.5-26.el8)�callback)ZdsnZ before_sendr� Z integrationsZ
ip_address)�dictr6 r �logging�INFO�WARNINGr� r rp Zinitr rq �userrJ )r� r� r� r� Zsentry_loggingZxray_verZ
silent_atexitru r; )r� r< � sentry_initQ s$
r� )�lognamer( c C s� t jt jt jt jt jd�}t� y t j| |�t t j�ddd� W n& t
k
rf t jt � � gd� dS X yt �
| d� W n tk
r� Y nX | S )z[
Configure logging and Sentry
:param logname: path to log
:return: logpath
)�debug�infor5 r �criticalz%(asctime)s %(message)sz%m/%d/%Y %I:%M:%S %p)�filenamer� r_ �datefmt)�handlersNi� )r� �DEBUGr� r� �ERROR�CRITICALr� � basicConfigr� r# r3 � NullHandlerr+ �chmod�PermissionError)r� Zlevelsr; r; r< �configure_logging� s&
r� )�src�dstr( c C sX yt �| |� W nB tk
rR } z$td| � d|� dt|�� ��|�W dd}~X Y nX dS )zZ
Move file with error catching
:param src: source
:param dst: destination
zFailed to move file z to z: N)r7 Zmover3 r& r6 )r� r� r: r; r; r< � safe_move� s r� z
socket object)�
sock_locationr( c C s` t tj�dd��}|dkrHt� � tt�}|�| � |�� W dQ R X nt dtt
�}|�� |S )z�
Create world-writable socket in given sock_location
or reuse existing one
:param sock_location: socket address
:return: socket object
�
LISTEN_FDSr N� ) rQ r+ �environr� �umask_0r r ZbindZlistenr r
)r� r� Zsockobjr; r; r< �
create_socket� s
r� )�lve_idr( c
C s� t tj�sdS d}d| � d�}y\t|��J}xB|D ]:}|�|�r0t�dt� j|� t |�
� � |�d �
� �S q0W W dQ R X W n4 t k
r� } zt�
d|t|�� W dd}~X Y nX dS ) zX
Retrieve current value of CPU throttled time.
Return 0 in case of failures
r Zthrottled_timez /sys/fs/cgroup/cpu,cpuacct/lvez /cpu.statz[%s] %s���NzFailed to open %s: %s)r r �LVEry r. r4 r� r r� rQ r~ r� r3 r r6 )r� ZmarkerZ stat_fileZ stat_values�valuer: r; r; r< � get_current_cpu_throttling_time� s
,$r� )�usernamer( c
C s� d}t j�|�sdS y.tj|d| dgdddd�}|j�� |j�� fS tjk
r| } zt j
ddt |�id � W dd}~X Y n2 t k
r� } zt �
d
t |�� W dd}~X Y nX dS ) z�
'selectorctl -u username --user-current' command
:param username: name of user
:return: tuple(stdout, stderr) or None if command fails
z/usr/bin/selectorctlNz-uz--user-currentT)�capture_outputro rN z&Failed to get selectorctl user-currentr) )r* z%selectorctl --user-current failed: %s)r+ r, �isfile�
subprocess�run�stdoutr~ �stderr�CalledProcessErrorr4 r5 r6 �subprocess_errorsr )r� Z _selectorctl�resultr: r; r; r< �_selectorctl_get_version� s r� c
C s� d}t j�|�sdS y"tj|d| gdddd�}|j�� S tjk
rp } ztj ddt
|�id� W dd}~X Y n2 t k
r� } zt� d t
|�� W dd}~X Y nX dS )
z�
'cagefsctl --get-prefix username' command
:param username: name of user
:return: cagefsctl prefix for given username
or None if command fails
z/usr/sbin/cagefsctlNz --getprefixT)r� ro rN z Failed to get cagefsctl prefixr) )r* z cagefsctl --getprefix failed: %s)
r+ r, r� r� r� r� r~ r� r4 r5 r6 r� r )r� �
_cagefsctlr� r: r; r; r< �_cagefsctl_get_prefix s
r� c
C s� d}t j�|�sdS | dkr(|ddg}n
|d| g}y tj|ddd� t�d| � W nj tjk
r� } ztjd d
t |�id � W dd}~X Y n2 t
k
r� } zt� d t |�� W dd}~X Y nX dS )
z�
'cagefsctl --remount username' or 'cagefsctl --remount-all' command
:param username: name of user or None (for remount-all)
z/usr/sbin/cagefsctlNz --wait-lockz
--remount-allz --remountT)rN r� z Remounted %szFailed to remount cagefsr) )r* z cagefsctl --remount failed: %s) r+ r, r� r� r� r4 r� r� r5 r6 r� r )r� r� r9 r: r; r; r< �_cagefsctl_remount' s
r� c
C sp d}t j�|�sdS y$tj|d| gddd�}d|j�� kS tk
rj } zt� dt
|�� W dd}~X Y nX dS ) z�
'cagefsctl --user-status username' command
:param username: name of user
:return: True if user has Enabled status, False otherwise
z/usr/sbin/cagefsctlFz
--user-statusT)r� ro ZEnabledz"cagefsctl --user-status failed: %sN) r+ r, r� r� r� r� r~ r� r4 r r6 )r� r� r� r: r; r; r< �_is_cagefs_enabled> s
r� c C s> y t d��} | �� }W dQ R X W n tk
r4 dS X d|kS )z`
Check if there is php.d.location = selector
set in /etc/cl.selector/symlinks.rules
z /etc/cl.selector/symlinks.rulesNFZselector)ry r} r3 )Z
rules_file�contentsr; r; r< � _is_selector_phpd_location_setR s
r� c C s$ t t��} t| �� �dkS Q R X dS )z:Check if there are no active tasks (== empty task storage)r N)rA r! �len�keys)rC r; r; r< �no_active_tasks_ s
r� )�enabledr( c
C sx t tj�sdS y0tdddd��}|�| r,dnd� W dQ R X W n4 tk
rr } zt�d| t|�� W dd}~X Y nX dS ) zb
Switch on/off throttle statistics gathering by kmodlve
:param enabled: True or False
Nz!/proc/sys/kernel/sched_schedstats�wbr )�mode� buffering� 1� 0z(Failed to set sched_schedstats to %s: %s) r r r� ry rz r3 r4 r� r6 )r� �fr: r; r; r< �switch_schedstatse s
r� c C s t � �dd�dkS )zG
Check if end-users have access to X-Ray UI of End-User plugin
Z hideXrayAppZ
uiSettingsF)r Z get_paramr; r; r; r< �is_xray_app_availablew s r� c
C sB t tt��.} y| �t� W n ttfk
r2 dS X W dQ R X dS )z Check if User Agent is listeningFNT)r r r
r� r% �ConnectionErrorr3 )r� r; r; r< �is_xray_user_agent_active~ s r� c C s t j�d� S )z2Check if SSA is disabled by its internal flag-filez /usr/share/clos_ssa/ssa_enabled)r+ r, r� r; r; r; r< � ssa_disabled� s r� c C s0 yt � t�| �j dk S tk
r* dS X dS )z.Check is file was modified during the last dayi�Q FN)rS r+ �stat�st_mtimer3 )r� r; r; r< �is_file_recently_modified� s r� c C s t | �� t� }W d Q R X |S )N)r r )r� r� r; r; r< �get_user_php_version� s
r� z'file object providing a fileno() method)�fdr( c c s� x�t d�D ]z}y$t�| tjtjB � t�d� P W q
tk
r� } z2t�dt|�� |j t j
t j fkrh� t �
d� W dd}~X Y q
X q
W tddd��dV t�| tj� dS ) uq
Context manager for locking given file object
:param fd: а file object providing a fileno() method
�x z File lockedzFailed to lock: %sg �?Nz%Failed to lock at all. Exiting threadr5 )�flag)�range�fcntlZflockZLOCK_EXZLOCK_NBr4 r� r3 r6 �errnoZEAGAINZEACCESrR �sleepr& ZLOCK_UN)r� �_r: r; r; r< �filelock� s
r� F)r� � is_shelvec c s� t j�| �}d}x�td�D ]v}y.|r0t�| �}n t�| d�}t�d|� P W q tj k
r� } z"t�d|||� |}t
� d� W dd}~X Y qX qW t d|� d|� ���|V |�
� t�d |� dS )
a1
Context manager for waiting for lock to be released for DBM file storage,
either plain DBM or a Shelf object
(desired return value is controlled by _shelve_instance flag)
:param filename: a DBM file to open
:param is_shelve: if a shelve file should be opened instead of plain DBM
N�d �czStorage %s openedz#[#%i] Failed to open storage %s: %sg333333�?zFailed to open z
storage: zStorage %s closed)r+ r, �basenamer� �shelvery �dbmr4 r� r rR r� rI �close)r� r� Z_fileZ_errr� Zstorager: r; r; r< rA � s& rA )�maskr( c c s t �| �}dV t �|� dS )z,
Context manager for dropping umask
N)r+ �umask)r� �prevr; r; r< r� � s
r� r� T)�
target_uid�
target_gidr� r( c c sd t �� }t �� }yt �|�}W n tk
r6 d}Y nX | dkrT|dkrN|} n|j} |dkrp|dkrj|}n|j}|dk r�t �|�}||kr�t �|� t �
d|� |r�t � � |kr�t d��|| k�rt �
| � t �
d| � |�rt �� | k�r||kr�t �|� t d��dV || k�r,t �
|� t �
d|� ||k�rLt �|� t �
d|� |dk �r`t �|� dS )aH
Context manager to drop privileges during some operation
and then restore them back.
If target_uid or target_gid are given, use input values.
Otherwise, stat target_uid and target_gid from given target_path.
If no target_path given, use current directory.
Use mask if given.
:param target_uid: uid to set
:param target_gid: gid to set
:param target_path: directory or file to stat for privileges,
default -- current directory
:param mask: umask to use
:param with_check: check the result of switching privileges
NzDropped GID privs to %sz6Unable to execute required operation: permission issuezDropped UID privs to %szRestored UID privs to %szRestored GID privs to %s)r+ �getuid�getgidr� r3 �st_uid�st_gidr� �setegidr4 r� �getegidr& �seteuid�geteuid) r� r� Z target_pathr� Z
with_checkZprev_uidZprev_gid� stat_infor� r; r; r< �set_privileges� sN
r )N)N)F)r )NNr� NT)y�__doc__r� r� r� r� r+ r� r7 r� r� rR Zxml.etree.ElementTreeZetreeZ ElementTreerl Z
contextlibr Zdatetimer r � functoolsr r r r r r
r r r
� threadingr �typingr r r rp Z sentry_sdk.integrations.atexitr Z sentry_sdk.integrations.loggingr Zclcommon.constr Zclcommon.cpapir r Zclcommon.lib.cleditionr r r r Zclcommon.ui_configr Zclcommon.clpwdr Zclcommon.utilsr Z clwpos.papir Z constantsr r! r" r# r$ r% Z
exceptionsr& � getLoggerr4 r3 �
ValueErrorZSubprocessErrorr� Z
SHARED_PROr� ZSOLOZADMINr� r@ rK rP rQ rS rT rV r6 rX r� rh rj rv r| r� �boolrL r� r� r� r� r� r� r� r� �tupler� r� r� r� r� r� r� r� r� r� r� r� r� rA r� r r; r; r; r< �<module>
s� $
38
S