관리-도구
편집 파일: __init__.cpython-39.pyc
a -�_gK? � @ sb d dl Z d dlZd dlZd dlZd dlZd dlZd dlmZ d dlm Z dd� Z G dd� d�Z dS )� N)�ProcessPoolExecutor)�file_is_binaryc C s� t �| ���}tj�|d�}tt ddd� �|_|�� D ]d}tj�||j�}tj� |�}tj� |�}tj� ||g�}||kr�t d|� d|� ���|� ||� q4tj�||j� d�d � d �d �W d � S 1 s�0 Y d S ) NZcleanerZfully_trusted_filterc S s | S �N� )�member�pathr r �A/usr/lib/python3.9/site-packages/sos/cleaner/archives/__init__.py�<lambda>! � z!extract_archive.<locals>.<lambda>z"Attempted path traversal in tarflez != �/����.tarr )�tarfile�open�osr �join�getattrZextraction_filterZ getmembers�name�abspath� commonprefix� Exception�extract�split) � archive_path�tmpdir�archiver r Z member_pathZ abs_directoryZ abs_target�prefixr r r �extract_archive s$ � ��r c @ s. e Zd ZdZg ZdZdZdZdZdZ i Z dd� Z e dd� �Z ed d � �Zed d � �Zd d� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd � Zed d � �Zd d � Zd!d"� Zd#d$� Z dBd%d&�Z d'd(� Z d)d*� Z d+d,� Z d-d.� Z!d/d0� Z"d1d2� Z#d3d4� Z$d5d6� Z%d7d8� Z&d9d:� Z'd;d<� Z(d=d>� Z)d?d@� Z*dAS )C�SoSObfuscationArchivea A representation of an extracted archive or an sos archive build directory which is used by SoSCleaner. Each archive that needs to be obfuscated is loaded into an instance of this class. All report-level operations should be contained within this class. r Z undeterminedFc C s� || _ | j | _|| _| j �d�d �d�d | _| j| _t�d�| _t�d�| _ | � � | _ d| _ | � � d| _| �d | j � d | j� �� d S ) Nr r r r �sosZsos_uiF� zLoaded z as type )r �final_archive_pathr r � archive_name�ui_name�loggingZ getLogger�soslog�ui_log�_load_skip_list� skip_list� is_extracted� _load_self� archive_root�log_info� description)�selfr r r r r �__init__A s �z SoSObfuscationArchive.__init__c C s t �dS )z=Check if the archive is a well-known type we directly supportN)�NotImplementedError)�clsZarc_pathr r r � check_is_typeQ s z#SoSObfuscationArchive.check_is_typec C s d| j j�� v S )Nr )� __class__�__name__�lower�r. r r r �is_sosV s z SoSObfuscationArchive.is_sosc C s d| j v S )NZinsights)� type_namer6 r r r � is_insightsZ s z!SoSObfuscationArchive.is_insightsc C s | j rt�| j�| _d S r )� is_tarfiler r r �tarobjr6 r r r r* ^ s z SoSObfuscationArchive._load_selfc C s g S )a/ Return a list of ObfuscationArchives that represent additional archives found within the target archive. For example, an archive from `sos collect` will return a list of ``SoSReportArchive`` objects. This should be overridden by individual types of ObfuscationArchive's r r6 r r r �get_nested_archivesc s z)SoSObfuscationArchive.get_nested_archivesc C s> | j r0| jj}|�� r |jS tj�|j�p.tjS tj� | j �S )z|Set the root path for the archive that should be prepended to any filenames given to methods in this class. ) r: r; Z firstmember�isdirr r r �dirname�sepr r )r. Ztoplevelr r r �get_archive_rootl s z&SoSObfuscationArchive.get_archive_rootc C s" | j �| jd d�d|� �� dS )z9Helper to easily format ui messages on a per-report basisz :z<50� N)r& �infor# �r. �msgr r r � report_msgw s z SoSObfuscationArchive.report_msgc C s d| j � d|� �S )Nz [cleaner:z] )r" rC r r r � _fmt_log_msg{ s z"SoSObfuscationArchive._fmt_log_msgc C s | j �| �|�� d S r )r% �debugrF rC r r r � log_debug~ s z SoSObfuscationArchive.log_debugc C s | j �| �|�� d S r )r% rB rF rC r r r r, � s z SoSObfuscationArchive.log_infoc C s g d�S )zyProvide a list of files and file regexes to skip obfuscation on Returns: list of files and file regexes )z proc/kallsymsz sosreport-z sys/firmwarezsys/fszsys/kernel/debugz sys/moduler r6 r r r r' � s z%SoSObfuscationArchive._load_skip_listc C s( zt �| j�W S ty" Y dS 0 d S )NF)r r: r r r6 r r r r: � s z SoSObfuscationArchive.is_tarfilec C s< | � |�}|r8| �d|� d�� t�|� | jd7 _dS )z�Remove a file from the archive. This is used when cleaner encounters a binary file, which we cannot reliably obfuscate. zRemoving binary file 'z' from archive� N)� get_file_pathr, r �remove�removed_file_count)r. �fnameZ full_fnamer r r � remove_file� s z!SoSObfuscationArchive.remove_filec C s6 | j s&| js| �� | _tj�| j|�S tj�| j|�S )z�Based on the type of archive we're dealing with, do whatever that archive requires to a provided **relative** filepath to be able to access it within the archive )r) r+ r@ r r r �extracted_path)r. rM r r r �format_file_name� s z&SoSObfuscationArchive.format_file_namec C s� | j du r\| jr\| �|�}z| j�|��� �d�W S tyX | �d|� d�� Y dS 0 n�zBt | �|�ddd��}|�� W d � W S 1 s�0 Y W n< t y� } z$| �d |� d |� �� W Y d}~dS d}~0 0 dS ) z�Return the content from the specified fname. Particularly useful for tarball-type archives so we can retrieve prep file contents prior to extracting the entire archive Fzutf-8zUnable to retrieve z: no such file in archiver �r)�encodingNzFailed to get contents of z: ) r) r: rP r; Z extractfile�read�decode�KeyErrorrH r r )r. rM �filenameZto_read�errr r r �get_file_content� s$ � �,z&SoSObfuscationArchive.get_file_contentc C sd | j r&|s| �d� | �� | _d| _n| j| _t�� dk�rN| �d� t� | j�D ]�\}}}z�|D ]0}tj � ||�}t� |�j }t�||t jB � qb|D ]x}tj � ||�} tj �| �r�tj �| �r�q�t�| tj�r�t�| tj�s�| �d| �| j�d � �� t�| t jt jB � q�W qR t�yJ } z | �d| � �� W Y d } ~ qRd } ~ 0 0 qR| �d| j� �� d S ) Nz Extracting...Tr z)Verifying permissions of archive contentsz Adding owner rw permissions to r z!Error while trying to set perms: zExtracted path is )r: rE � extract_selfrO r) r r �getuidrH �walkr r �stat�st_mode�chmod�S_IRWXU�exists�islink�access�R_OK�W_OKr �S_IRUSR�S_IWUSRr ) r. �quietr> �dirs�files�_dirZ_dirnameZ _dir_permsrV rM rW r r r r � s< ���(z SoSObfuscationArchive.extractc C s. | j �| j|�}|| _t�| j |� || _ dS )z�Rename the top-level directory to new_name, which should be an obfuscated string that scrubs the hostname from the top-level dir which would be named after the unobfuscated sos report N)rO �replacer" r �rename)r. �new_name�_pathr r r �rename_top_dir� s z$SoSObfuscationArchive.rename_top_dirc C s | j r| j�d�rdS dS dS )z�Return the compression type used by the archive, if any. This is then used by SoSCleaner to generate a policy-derived compression command to repack the archive �xz�gzN)r: r �endswithr6 r r r �get_compression� s z%SoSObfuscationArchive.get_compressionc C s� d}| j d }i }|rL|d|� �7 }|d|� �7 }|dkrDddi}ndd i}| �d |� �� tj|fd |i|���.}|j| j tj�| j�d d � W d � n1 s�0 Y |S )zIPack the extracted archive as a tarfile to then be re-compressed �wz-obfuscated.tar�:�.rp �preset� � compresslevel� zBuilding tar file �moderI )ZarcnameN) rO rH r r �addr r r r" )r. �methodr{ ZtarpathZ compr_args�tarr r r �build_tar_file s �$z$SoSObfuscationArchive.build_tar_filec C s� z| � |�| _W n6 tyF } z | �d|� �� � W Y d}~n d}~0 0 | �d| j� �� z | �� W n> ty� } z&| �d|� �� | �d� W Y d}~n d}~0 0 dS )z�Execute the compression command, and set the appropriate final archive path for later reference by SoSCleaner on a per-archive basis z(Exception while re-compressing archive: NzCompressed to z'Failed to remove extraction directory: z/Failed to remove temporary extraction directory)r r! r rH �remove_extracted_pathrE )r. r} rW r r r �compress s z SoSObfuscationArchive.compressc C sr z"| � d| j� �� t�| j� W nJ tyl t�| jtj� tj � | j�r\t� | j� n t�| j� Y n0 dS )z�After the tarball has been re-compressed, remove the extracted path so that we don't take up that duplicate space any longer during execution z Removing N) rH rO �shutil�rmtree�OSErrorr r^ r\ rf r �isfilerK r6 r r r r� # s z+SoSObfuscationArchive.remove_extracted_pathc C sJ t d��.}|�t| j| j�}|�� }|W d � S 1 s<0 Y dS )z}Extract an archive into our tmpdir so that we may inspect it or iterate through its contents for obfuscation rI N)r Zsubmitr r r �result)r. Z_poolZ _path_futurer r r r rY 2 s �z"SoSObfuscationArchive.extract_selfc c sp t �| j�D ]^\}}}|D ]$}t j�||�}t j�|�r|V q|D ]$}t j�||�}t j�|�rD|V qDq dS )z.Iterator for a list of symlinks in the archiveN)r r[ rO r r ra )r. r> rh ri rj Z_dirpathrV �_fnamer r r � get_symlinks= s z"SoSObfuscationArchive.get_symlinksc c sL t �| j�D ]:\}}}|D ]*}t j�||�d��}t j�|�s|V qq dS )z�Iterator for a list of files in the archive, to allow clean to iterate over. Will not include symlinks, as those are handled separately r N)r r[ rO r r �lstripra )r. r> �_ri rV r� r r r � get_file_listI s z#SoSObfuscationArchive.get_file_listc C s* g }t �| j�D ]\}}}|�|� q|S )z3Return a list of all directories within the archive)r r[ rO �append)r. Zdir_listr> r� r r r �get_directory_listU s z(SoSObfuscationArchive.get_directory_listc C s | j �|� | j|7 _dS )z�Called when a file has finished being parsed and used to track total substitutions made and number of files that had changes made N)� file_sub_listr� �total_sub_count)r. rM �countr r r �update_sub_count\ s z&SoSObfuscationArchive.update_sub_countc C s* t j�| j|�d��}t j�|�r&|S dS )zReturn the filepath of a specific file within the archive so that it may be selectively inspected if it exists r r )r r r rO r� r` )r. rM rn r r r rJ c s z#SoSObfuscationArchive.get_file_pathc C sT t j�| �|��s(t j�| �|��s(dS | jD ] }|�|�sHt�||�r. dS q.dS )a% Checks the provided filename against a list of filepaths to not perform obfuscation on, as defined in self.skip_list Positional arguments: :param filename str: Filename relative to the extracted archive root TF) r r r� rJ ra r( � startswith�re�match)r. rV Z_skipr r r �should_skip_filej s � z&SoSObfuscationArchive.should_skip_filec C sF g d�}|D ]}t �||�r dS q | �|�}tj�|�rBt|�S dS )aa Determine if the file should be removed or not, due to an inability to reliably obfuscate that file based on the filename. :param fname: Filename relative to the extracted archive root :type fname: ``str`` :returns: ``True`` if the file cannot be reliably obfuscated :rtype: ``bool`` ) z.*\.gz$z.*\.xz$z .*\.bzip2$z .*\.tar\..*z.*\.txz$z.*\.tgz$z.*\.bin$z .*\.journal$z.*\~$TF)r� r� rJ r r r� r )r. rM Zobvious_removesZ_arc_regZ _full_pathr r r �should_remove_file} s z(SoSObfuscationArchive.should_remove_fileN)F)+r4 � __module__� __qualname__�__doc__r� r� rL r8 r- Z is_nestedZ prep_filesr/ � classmethodr2 �propertyr7 r9 r* r< r@ rE rF rH r, r' r: rN rP rX r ro rs r r� r� rY r� r� r� r� rJ r� r� r r r r r 1 sT % r ) r$ r r� r\ r r� �concurrent.futuresr Z sos.utilitiesr r r r r r r �<module> s