File: //lib/python3.9/site-packages/sos/cleaner/__pycache__/__init__.cpython-39.pyc
a
�:�hv� � @ s d dl Z d dlZd dlZd dlZd dlZd dlZd dlmZ d dlmZ d dl m
Z
d dl Z d dl m
Z
d dlmZ d dlmZ d dlmZ d d lmZ d d
lmZ d d lmZ d d lmZ d d
l m Z m Z m Z m Z d dl!m"Z"m#Z# d dl$m%Z% d dl&m'Z'm(Z(m)Z) dd� Z*G dd� de�Z+dS )� N)�ProcessPoolExecutor)�datetime)�getpwuid)� __version__)� SoSComponent)� SoSIPParser)� SoSMacParser)�SoSHostnameParser)�SoSKeywordParser)�SoSUsernameParser)�
SoSIPv6Parser)�SoSReportArchive�SoSReportDirectory�SoSCollectorArchive�SoSCollectorDirectory)�DataDirArchive�TarballArchive)�InsightsArchive)�get_human_readable�
import_module�ImporterHelperc C s
| � |�S �N)�obfuscate_arc_files)�arc�flist� r �8/usr/lib/python3.9/site-packages/sos/cleaner/__init__.pyr ) s r c
sN e Zd ZdZdZdg g g dg dddddg d � ZdJ� fd
d � ZdKd d
�ZdLdd�ZdMdd�Z dNdd�Z
e dd� �Z dd� Z
dd� Ze dd� �Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� ZdOd.d/�Zd0d1� Zd2d3� Zd4d5� Z d6d7� Z d8d9� Z d:d;� Z d<d=� Z d>d?� Z!d@dA� Z"dBdC� Z#dDdE� Z$dFdG� Z%dHdI� Z&� Z'S )P�
SoSCleanera-
This function is designed to obfuscate potentially sensitive information
from an sos report archive in a consistent and reproducible manner.
It may either be invoked during the creation of a report by using the
--clean option in the report command, or may be used on an already existing
archive by way of 'sos clean'.
The target of obfuscation are items such as IP addresses, MAC addresses,
hostnames, usernames, and also keywords provided by users via the
--keywords and/or --keyword-file options.
For every collection made in a report the collection is parsed for such
items, and when items are found SoS will generate an obfuscated replacement
for it, and in all places that item is found replace the text with the
obfuscated replacement mapped to it. These mappings are saved locally so
that future iterations will maintain the same consistent obfuscation
pairing.
In the case of IP addresses, support is for IPv4 and IPv6 - effort is made
to keep network topology intact so that later analysis is as accurate and
easily understandable as possible. If an IP address is encountered that we
cannot determine the netmask for, a private IP address from 172.17.0.0/22
range is used instead.
For IPv6, note that IPv4-mapped addresses, e.g. ::ffff:10.11.12.13, are
NOT supported currently, and will remain unobfuscated.
For hostnames, domains are obfuscated as whole units, leaving the TLD in
place.
For instance, 'example.com' may be obfuscated to 'obfuscateddomain0.com'
and 'foo.example.com' may end up being 'obfuscateddomain1.com'.
Users will be notified of a 'mapping' file that records all items and the
obfuscated counterpart mapped to them for ease of reference later on. This
file should be kept private.
z6Obfuscate sensitive networking information in a report�auto� N� /etc/sos/cleaner/default_mappingF� ) � archive_type�domains�disable_parsers�skip_cleaning_files�jobs�keywords� keyword_file�map_file� no_update�keep_binary_files�target� usernamesc s� |s t � �|||� d| _n�|d | _|d | _|d | _|d | _|d | _d| _t| jd�sl| jj | j_
d | j_ t �
d
�| _t �
d �| _tjtj�| jd �dd
� | �� | �� | _t�d� || _| j�� | _| jj� d �| _ | jj r�tj� | jj �nd}| j|| jj g}t!|� t"|� t#|� t$|� t%|� t&|� g| _'| jj(D ]v}| j'D ]h} | j)�*� j+ddd�d }
|
�,� } |�*� �,� | k�rL| �-d| � �� | j�.d|� d�� | j'�/| � �qL�qBt0t1t2t3t4t5t6g| _7d | _8| �-d| j� �� d S )NT�options�tmpdir�sys_tmp�policy�manifestFr& r �sosZsos_ui�cleaner��exist_ok�? z/etc/sos/cleaner�parser� )�maxsplitr zDisabling parser: zDisabling the 'zP' parser. Be aware that this may leave sensitive plain-text data in the archive.z#Cleaner initialized. From cmdline: )9�super�__init__� from_cmdline�optsr/ r0 r1 r2 �hasattr�threadsr& r" �loggingZ getLogger�soslog�ui_log�os�makedirs�path�join�review_parser_values�
load_map_fileZcleaner_mapping�umask�in_placeZget_preferred_hash_name� hash_name�
components� add_section�
cleaner_mdr) �dirnamer% r r r r r
r �parsersr$ �name�lower�split�strip�log_info�warning�remover r
r r r r r �
archive_types�nested_archive) �selfr8 �argsZcmdlinerK Z hook_commons� cleaner_dirZ parser_args�_parserZ_loadedZ_tempZ _loaded_name�� __class__r r r< f st
����
��
�zSoSCleaner.__init__c C s d|rd|� �nd� d|� �S )Nz[cleaner�:r! z] r �r[ �msg�callerr r r � _fmt_log_msg� s zSoSCleaner._fmt_log_msgc C s | j �| �||�� d S r )rB �debugre rb r r r � log_debug� s zSoSCleaner.log_debugc C s | j �| �||�� d S r )rB �infore rb r r r rV � s zSoSCleaner.log_infoc C s | j �| �||�� d S r )rB �errorre rb r r r � log_error� s zSoSCleaner.log_errorc C s |� d� |�| j� d S )NzSoS Cleaner Detailed Help)Z set_title�add_text�__doc__)�cls�sectionr r r � display_help� s
zSoSCleaner.display_helpc C s i }d}t j�| jj�r,td| jj� d���t j�| jj�s`| jj|kr�| �d| jj� d�� n�t| jjddd��z}zt �
|�}W nZ t j y� | �d � Y n> ty� } z&| �d
| jj� d |� �� W Y d }~n
d }~0 0 W d � n1 s�0 Y |S )
z�Verifies that the map file exists and has usable content.
If the provided map file does not exist, or it is empty, we will print
a warning and continue on with cleaning building a fresh map
r zRequested map file z is a directoryzERROR: map file z6 does not exist, will not load any obfuscation matches�r�utf-8��encodingzOERROR: Unable to parse map file, json is malformed. Will not load any mappings.zERROR: Could not load '�': N) rD rF �isdirr> r) � Exception�existsrj �open�json�loadZJSONDecodeError)r[ Z_confZ default_map�mf�errr r r rI � s* ���<zSoSCleaner.load_map_filec
C s� | � d�}| j�dt� d�� | j�|� | jjs�z td� W nV tyf | j�d� | �d� Y n0 t y� } z| �d|� W Y d}~n
d}~0 0 dS ) z�When we are directly running `sos clean`, rather than hooking into
SoSCleaner via report or collect, print a disclaimer banner
a� This command will attempt to obfuscate information that is generally considered to be potentially sensitive. Such information includes IP addresses, MAC addresses, domain names, and any user-provided keywords.
Note that this utility provides a best-effort approach to data obfuscation, but it does not guarantee that such obfuscation provides complete coverage of all such data in the archive, or that any obfuscation is provided to data that does not fit the description above.
Users should review any resulting data and/or archives generated or processed by this utility for remaining sensitive content before being passed to a third party.
z
sos clean (version z)
z-
Press ENTER to continue, or CTRL-C to quit.
z
Exiting on user cancel� r9 N)
Z_fmt_msgrC rh r r> Zbatch�input�KeyboardInterrupt�_exitrv )r[ rc �er r r �print_disclaimer� s
zSoSCleaner.print_disclaimerc C s d|_ |�dd�}|jdddd� |jdd g d
�d d � |jd
dg dd� |jddg ddd� |jdddg ddd� |jdddtd d � |jd dg d d d� |jd!d d"d#d$� |jd%d&d'd(d)� |jd*d+d,d-d.d/� |jd0d,d-d1d2d3� |jd4d5g dd6d/� d S )7Nz sos clean|mask TARGET [options]zCleaner/Masking Optionsz7These options control how data obfuscation is performedr, ZTARGETz%The directory or archive to obfuscate)�metavar�helpz--archive-typer )r �reportZcollectZinsightszdata-dir�tarballz8Specify what kind of archive the target was generated as)�default�choicesr� z --domains�extendz!List of domain names to obfuscate)�actionr� r� z--disable-parsersr$ zCDisable specific parsers, so that those elements are not obfuscated)r� r� �destr� z--skip-cleaning-filesz--skip-masking-filesr% zBList of files to skip/ignore during cleaning. Globs are supported.z-jz--jobsr z&Number of concurrent archives to clean)r� �typer� z
--keywordsr' z List of keywords to obfuscatez--keyword-filer( z&Provide a file a keywords to obfuscate)r� r� r� z
--map-filer) r z;Provide a previously generated mapping file for obfuscation)r� r� r� z --no-updater* F�
store_truez<Do not update the --map-file with new mappings from this run)r� r� r� r� z--keep-binary-filesr+ zGKeep unprocessable binary files in the archive instead of removing them)r� r� r� r� z --usernamesr- z List of usernames to obfuscate)�usage�add_argument_group� add_argument�int)rm r8 Z clean_grpr r r �add_parser_options� sh ���
��� �
���
��
�z SoSCleaner.add_parser_optionsc C s || j _dS )z�For use by report and collect to set the TARGET option appropriately
so that execute() can be called just as if we were running `sos clean`
directly from the cmdline.
N)r> r, )r[ rF r r r �set_target_path0 s zSoSCleaner.set_target_pathc C s� d}| j jdkrN| j j�dd�}| jD ]$}|j|kr&|| j j| j| j j�}q&n4| jD ],}|�| j j�rT|| j j| j| j j�} q�qT|s�dS || _ | j
� |� |j r�| j
�
|�� � | j
�|� || _| jr�| jj| j_dS )z�The target path is not a directory, so inspect it for being an
archive or an archive of archives.
In the event the target path is not an archive, abort.
Nr �-�_)r> r" �replacerY � type_namer, r/ r+ Z
check_is_type� main_archive� report_paths�append� is_nestedr� Zget_nested_archivesrX rZ � description�ui_name)r[ Z_arcZ
check_type�archiver r r r �inspect_target_archive7 s0
�
� z!SoSCleaner.inspect_target_archivec C sJ | j jD ]&}t|�d��dk rtd|� d���qdd� | j jD �| j _dS )z�Check any values passed to the parsers via the commandline:
- For the --domains option, ensure that they are valid for the parser
in question.
- Convert --skip-cleaning-files from globs to regular expressions.
�.� zInvalid value 'z0' given: --domains values must be actual domainsc S s g | ]}t �|��qS r )�fnmatch� translate)�.0�pr r r �
<listcomp>c � z3SoSCleaner.review_parser_values.<locals>.<listcomp>N)r> r# �lenrT rv r% )r[ Z_domr r r rH W s
��z SoSCleaner.review_parser_valuesc C s� | j j�d�| j _| j j�d�d �d�d | _| jr>| �� g | _tj �
| j j�st| j � d| j j� �� | �
d� | �� | js�| j � d� | �
d� g | _| jD ]}|jdkr�|j�� q�| �� | �� | �� | js�| jr�d S | j �d
� | �
d� | j �d t| j�� d �� | �� }| �|�}| � |� | � � | j�rZd
d� | jD �}||fS d }t| j�dk�rx| � � }n�| jd }|j }| � |j �}|d u�r| �!|�d�d � d| j"� ��} t#tj �$| j%| �ddd��}
|
�&|� W d � n1 �s�0 Y | �'� tj �$| j%| �!|�d�d ��}t(�)||� t�*|�} | j �d|� �� | j �d|� d�� | j �dt+| j,�� �� | j �dt-| j.�j/� d�� | j �d� | �0� d S )a, SoSCleaner will begin by inspecting the TARGET option to determine
if it is a directory, archive, or archive of archives.
In the case of a directory, the default behavior will be to edit the
data in place. For an archive will we unpack the archive, iterate
over the contents, and then repack the archive. In the case of an
archive of archives, such as one from SoSCollector, each archive will
be unpacked, cleaned, and repacked and the final top-level archive will
then be repacked as well.
�/���z.tarr z*Invalid target: no such file or directory r9 z'No valid archives or directories found
zHostname ParserNz#No reports obfuscated, aborting...
z
Successfully obfuscated z report(s)
c S s g | ]
}|j �qS r )�final_archive_path)r� �ar r r r� � r� z&SoSCleaner.execute.<locals>.<listcomp>r� �wrq rr z2A mapping of obfuscated elements is available at
z)
The obfuscated archive is available at
�
z Size z Owner zcPlease send the obfuscated archive to your support representative and keep the mapping file private)1r> r, �rstriprT �arc_namer= r� r� rD rF rw rC ri r� r� �completed_reportsrQ rR �mappingZset_initial_counts� preload_all_archives_into_maps� generate_parser_item_regexes�obfuscate_report_pathsrK rh r� �compile_mapping_dict�write_map_for_archive�write_map_for_config�write_stats_to_manifest�rebuild_nested_archiver� �get_new_checksum�obfuscate_stringrL rx rG r0 �write�write_cleaner_log�shutil�move�statr �st_sizer �st_uid�pw_nameZcleanup) r[ r8 �_map�map_pathZ arc_pathsZ
final_pathZarc_pathr �checksumZ chksum_name�cfZarcstatr r r �executef s� �
�
��*�
�
� zSoSCleaner.executec C s� | j d }| j|d� | jD ]J}|j�d�d }| �|j�}|dur d|� d| j� �}| jj||d� q t �
| j j �D ]X\}}}|D ]H} t j
�|| �}
|
�| j j �d }|�d�}| jj|
|d� t �|
� q�qv| jd d
� | j�| jj�S ) z�Handles repacking the nested tarball, now containing only obfuscated
copies of the reports, log files, manifest, etc...
z -obfuscated)rR r� r� Nz
checksums/r� �r� T�r� )r� Z
setup_archiver� r� rT r� rL r� Z
add_stringrD �walkrZ �extracted_pathrF rG �lstrip�add_filerX r� �finalizer> Zcompression_type) r[ r� r� Zarc_destr� ZdnameZdirnr� �files�filename�fnamer r r r� � s"
z!SoSCleaner.rebuild_nested_archivec C s2 i }| j D ]"}i ||j< ||j �|�� � q
|S )a Build a dict that contains each parser's map as a key, with the
contents as that key's value. This will then be written to disk in the
same directory as the obfuscated report so that sysadmins have a way
to 'decode' the obfuscation locally
)rQ Z map_file_key�updateZget_map_contents)r[ r� r8 r r r r� � s
z SoSCleaner.compile_mapping_dictc C sF t |ddd��$}|�tj|dd�� W d � n1 s80 Y |S )zjWrite the mapping to a file on disk that is in the same location as
the final archive(s).
r� rq rr r )�indentN)rx r� ry �dumps)r[ r� rF r{ r r r �write_map_to_file� s 2z SoSCleaner.write_map_to_filec
C sh z,t j�| j| �| j� d���}| �||�W S tyb } z | �d|� �� W Y d }~d S d }~0 0 d S )Nz -private_mapz"Could not write private map file: ) rD rF rG r0 r� r� r� rv rj )r[ r� r� r| r r r r� � s �z SoSCleaner.write_map_for_archivec
C s� | j jr�| j js�tj�| j j�}z6tj|dd� | �|| j j� | �d| j j� �� W n4 t y� } z | �
d|� �� W Y d}~n
d}~0 0 dS )z}Write the mapping to the config file so that subsequent runs are
able to provide the same consistent mapping
Tr5 zWrote mapping to z&Could not update mapping config file: N) r> r) r* rD rF rP rE r� rg rv rj )r[ r� r] r| r r r r� � s z SoSCleaner.write_map_for_configc C s� t j�| j| j� d��}t|ddd��6}| j�d� | j�� D ]}|� |� q>W d � n1 sb0 Y |r�| �
|� | j j |dd� dS ) z�When invoked via the command line, the logging from SoSCleaner will
not be added to the archive(s) it processes, so we need to write it
separately to disk
z-obfuscation.logr� rq rr r Nzsos_logs/cleaner.logr� )
rD rF rG r0 r� rx Z sos_log_file�seek� readlinesr� �obfuscate_filer� r� )r[ r� Zlog_nameZlogfile�liner r r r� s � *
z SoSCleaner.write_cleaner_logc
C s� zhd}t |d��F}t�| j�}|�|�}|s.q:|�|� q |�� d W d � W S 1 s\0 Y W n4 ty� } z | �d|� �� W Y d}~n
d}~0 0 dS )zvCalculate a new checksum for the obfuscated archive, as the previous
checksum will no longer be valid
i �rbr� Nz!Could not generate new checksum: ) rx �hashlib�newrL �readr� Z hexdigestrv rg )r[ � archive_pathZ hash_sizeZ
archive_fpZdigestZhashdatar| r r r r� s
0&zSoSCleaner.get_new_checksumc C s� z�dt | j�� d| jj� d�}| j�|� | jjr>| j�d� | jD ]"}| j�d|j� �� | � |� qD| j
r�| � � | � | j
� W n( t y� | j�d� t
�d� Y n0 dS ) z�Perform the obfuscation for each archive or sos directory discovered
during setup.
Each archive is handled in a separate thread, up to self.opts.jobs will
be obfuscated concurrently.
zFound z. total reports to obfuscate, processing up to z! concurrently within one archive
zpWARNING: binary files that potentially contain sensitive information will NOT be removed from the final archive
z Obfuscating zExiting on user cancelr} N)r� r� r> r& rC rh r+ rW r� �obfuscate_reportrZ � _replace_obfuscated_archivesr rD r� )r[ rc Z report_pathr r r r� 1 s& �� �
z!SoSCleaner.obfuscate_report_pathsc C sV | j D ]J}t�|j� | jj}|j�d�d }tj� ||�}t
� |j|� ||_qdS )z�When we have a nested archive, we need to rebuild the original
archive, which entails replacing the existing archives with their
obfuscated counterparts
r� r� N) r� rD rX r� rZ r� r� rT rF rG r� r� )r[ r� r� r� Z dest_namer r r r� O s
z'SoSCleaner._replace_obfuscated_archivesc C s | j D ] }|�� qdS )z�For the parsers that use prebuilt lists of items, generate those
regexes now since all the parsers should be preloaded by the archive(s)
as well as being handed cmdline options and mapping file configuration.
N)rQ Zgenerate_item_regexes)r[ r8 r r r r� \ s
z'SoSCleaner.generate_parser_item_regexesc C s. | j D �]}|j�� �� d �� }|�||�D ]�}|�|�}|sBq.| �d|� d|� d|j� �� |� � D ]T}z|�
|� W qh t y� } z(| �d|� d|� d|� �� W Y d}~qhd}~0 0 qhq.|� ||�} | r�| �d|� d |j� �� | D ]}
|j
�|
� q�|j| D ]} |j
�| � �qq|�| j � dS )
a*
For each archive we've determined we need to operate on, pass it to
each prepper so that we can extract necessary files and/or items for
direct regex replacement. Preppers define these methods per parser,
so it is possible that a single prepper will read the same file for
different parsers/mappings. This is preferable to the alternative of
building up monolithic lists of file paths, as we'd still need to
manipulate these on a per-archive basis.
:param archive: The archive we are currently using to prepare our
mappings with
:type archive: ``SoSObfuscationArchive`` subclass
:param prepper: The individual prepper we're using to source items
:type prepper: ``SoSPrepper`` subclass
r z Prepping z parser with file z from zFailed to prep z
map from �: Nz mapping with items from )rQ rR rS rT rU Zget_parser_file_listZget_file_contentrg r� �
splitlinesZ
parse_linerv Zget_items_for_mapr� �addZ regex_itemsZadd_regex_item� set_parsers) r[ r� �prepperr^ ZpnameZ_fileZcontentr� r| Z map_items�itemZritemr r r � _prepare_archive_with_prepperd s4
� � �z(SoSCleaner._prepare_archive_with_prepperc c sZ t tjj�}g }|�� D ]}|�td|� ��� qt|dd� d�D ]}|| jd�V qBdS )a
Discover all locally available preppers so that we can prepare the
mappings with obfuscation matches in a controlled manner
:returns: All preppers that can be leveraged locally
:rtype: A generator of `SoSPrepper` items
zsos.cleaner.preppers.c S s | j S r )�priority)�xr r r �<lambda>� r� z)SoSCleaner.get_preppers.<locals>.<lambda>)�key)r. N) r r3 r4 ZpreppersZ get_modulesr� r �sortedr> )r[ �helperZprepsZ_prepr� r r r � get_preppers� s zSoSCleaner.get_preppersc C sB | � d� | �� D ] }| jD ]}| �||� q q| j�| j� dS )a Before doing the actual obfuscation, if we have multiple archives
to obfuscate then we need to preload each of them into the mappings
to ensure that node1 is obfuscated in node2 as well as node2 being
obfuscated in node1's archive.
z.Pre-loading all archives into obfuscation mapsN)rV r� r� r� r� r� rQ )r[ r� r� r r r r� � s
z)SoSCleaner.preload_all_archives_into_mapsc
s� �z��j �� j�}t�� }|�d|� � js4� �� � �d� t � �
� ��d } }}� fdd�t �j j
�D �}t�j j
� jd��^}|�t|��fdd�t �j j
�D ��} | D ]"\}
} } ||
7 }|| 7 }|| 7 }q�W d � n1 s�0 Y � �� z��� � W n< t�yB }
z"�jd |
� �� jd
� W Y d}
~
n
d}
~
0 0 z��� � W n< t�y� }
z"�jd |
� �� jd
� W Y d}
~
n
d}
~
0 0 � j�s0� �� }|�r$� �d � z � ���� j�� � �|� W nR t�y" }
z8��d
� j� d|
� �� � �d|
� �� W Y d}
~
W dS d}
~
0 0 �j � � � t�� }|�d|� |�d|| � |�d|� |�d|� d}|�r�d}|| }� �d|� �� W n@ t�y� }
z&�j � d� j� d|
� �� W Y d}
~
n
d}
~
0 0 dS )z�Individually handle each archive or directory we've discovered by
running through each file therein.
Positional arguments:
:param archive str: Filepath to the directory or archive
�
start_timezBeginning obfuscation...r c s g | ]}� �qS r r �r� �ir� r r r� � r� z/SoSCleaner.obfuscate_report.<locals>.<listcomp>)� max_workersZ initializerc s g | ]}� |d �j j� �qS r )r> r& r� )� file_listr[ r r r� � r� Nz!Failed to obfuscate directories: �rd z Failed to obfuscate symlinks: zRe-compressing...zArchive z failed to compress: z Failed to re-compress archive: �end_timeZrun_timeZfiles_obfuscatedZtotal_substitutionsr! z! [removed %s unprocessable files]zObfuscation completedzException while processing r� ) rO rN � archive_namer Znow� add_fieldZ is_extracted�extractZ
report_msg�listZ get_files�ranger> r& r Zload_parser_entries�mapr �obfuscate_directory_namesrv rV �obfuscate_symlinksr� Zget_compressionZrename_top_dirr� �compressrg r� r� rC rh )r[ r� Zarc_mdr� Zfiles_obfuscated_countZtotal_sub_countZremoved_file_countZ archive_list�executorZfuturesZfocZtscZrfcr| �methodr� Zrmsgr )r� r� r[ r r� � s�
�
��( � �
��� ��zSoSCleaner.obfuscate_reportc C s | j �|g� d S r )r� r )r[ r� r r r r� s zSoSCleaner.obfuscate_filec s | j d|jd� |�� D ]�}z�|�|j�d �d�� � fdd�| jD �}|sb| �d� � d�� W q| jd � � �|jd� t� |�}tj
� |j| � � ��}| � |�}||ks�||kr�t�
|� t�||� W q t�y } z"| � d
|� d |� �� W Y d }~qd }~0 0 qd S )
a� Iterate over symlinks in the archive and obfuscate their names.
The content of the link target will have already been cleaned, and this
second pass over just the names of the links is to ensure we avoid a
possible race condition dependent on the order in which the link or the
target get obfuscated.
:param archive: The archive being obfuscated
:type archive: ``SoSObfuscationArchive``
zObfuscating symlink namesr� r9 r� c s( g | ] }t � fd d�|jD ��s|�qS )c 3 s | ]}|� � �V qd S r )�match)r� Z_skip�Z_symr r � <genexpr>* r� z;SoSCleaner.obfuscate_symlinks.<locals>.<listcomp>.<genexpr>)�anyZ
skip_patterns)r� Z_pr r r r� ( s �z1SoSCleaner.obfuscate_symlinks.<locals>.<listcomp>z Skipping obfuscation of symlink z due to skip pattern matchzObfuscating symlink zError obfuscating symlink 'rt N)rV r� Z get_symlinksrT r� r� rQ rg rD �readlinkrF rG r� rX �symlinkrv )r[ r� r Z_parsers�_targetZ _ob_sym_nameZ
_ob_targetr| r r r r� s2
�
� �
�
z SoSCleaner.obfuscate_symlinksc C s� | � d|j� �� t|�� dd�D ]~}t�|�D ]n}tj�||�}|�|j �d }tj�
|�r0| � |�}||kr0|� |�}tj�|j |�
d�|�}t�||� q0q"dS )z�For all directories that exist within the archive, obfuscate the
directory name if it contains sensitive strings found during execution
z'Obfuscating directory names in archive T)�reverser� r� N)rV r� r� Zget_directory_listrD �listdirrF rG rT r� ru r� r� r� �rename)r[ r� �dirpath�_nameZ_dirnameZ_arc_dirZ _ob_dirnameZ _ob_arc_dirr r r r� E s" �
�z$SoSCleaner.obfuscate_directory_namesc C sT | j D ]H}z|�|�}W q tyL } z | �d|� �� W Y d }~qd }~0 0 q|S )Nz Error obfuscating string data: )rQ Zparse_string_for_keysrv rV )r[ Z string_datar8 r| r r r r� \ s
(zSoSCleaner.obfuscate_stringc C sL | j �d�}| jD ]4}|�|j�dd��� �}|�dt|jj �
� �� qdS )zLWrite some cleaner-level, non-report-specific stats to the manifest
rQ � r� �entriesN) rO rN rQ rR r� rS r� r� r� Zdataset�keys)r[ Z parse_secr8 Z_secr r r r� d s
z"SoSCleaner.write_stats_to_manifest)NNNFN)N)N)N)N)F)(�__name__�
__module__� __qualname__rl ZdescZ arg_defaultsr< re rg rV rj � classmethodro rI r� r� r� r� rH r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� �
__classcell__r r r_ r r - sf '� �N
1 a
, i.r ),r� ry rA rD r� r� �concurrent.futuresr r �pwdr Zsos.cleaner.preppersr3 r Z
sos.componentr Z sos.cleaner.parsers.ip_parserr Z sos.cleaner.parsers.mac_parserr Z#sos.cleaner.parsers.hostname_parserr Z"sos.cleaner.parsers.keyword_parserr
Z#sos.cleaner.parsers.username_parserr Z sos.cleaner.parsers.ipv6_parserr Zsos.cleaner.archives.sosr
r r r Z sos.cleaner.archives.genericr r Z sos.cleaner.archives.insightsr Z
sos.utilitiesr r r r r r r r r �<module> s.