3
ܓir @ s d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlmZ d dl m
Z
d dl m Z d dl
mZ y d dlZW n ek
r Y nX dZdZdZd Zd
ZG d d d ZG d
d deZG dd deZdS ) N)datetime)Lock) find_spec)sos_get_command_outputfilelinkZnodedirz
contaner filec @ s e Zd ZdZedd ZejdZdZ dZ
e Z dd Z
d d
Zd d Zd
d Zdd Zdd Zdd Zd-ddZd.ddZdd Zd d Zd d Zd!d" Zd#d$ Zd%d& Zd'd( Z d)d* Z d+d, Z dS )/Archivez!Abstract base class for archives.c C s | j S )z6Returns the archive class's name as a string.
)__name__)cls r /usr/lib/python3.6/archive.py archive_type, s zArchive.archive_typeZsosZunsetFc C s d| j d| S )Nz [archive:z] )r )selfmsgr r r
_format_msg9 s zArchive._format_msgc C s
|| _ d S )N)_debug)r debugr r r
set_debug< s zArchive.set_debugc C s | j j| j| d S )N)logerrorr )r r r r r
log_error? s zArchive.log_errorc C s | j j| j| d S )N)r Zwarningr )r r r r r
log_warnB s zArchive.log_warnc C s | j j| j| d S )N)r infor )r r r r r
log_infoE s zArchive.log_infoc C s | j s
d S | jj| j| d S )N)r r r r )r r r r r
log_debugH s zArchive.log_debugc C s | j S )N)_name)r r r r
nameM s z Archive.nameNc C s t d S )N)NotImplementedError)r srcdestforcer r r
add_fileS s zArchive.add_filewc C s t d S )N)r )r contentr moder r r
add_stringV s zArchive.add_stringc C s t d S )N)r )r r$ r r r r
add_binaryY s zArchive.add_binaryc C s t d S )N)r )r source link_namer r r
add_link\ s zArchive.add_linkc C s t d S )N)r )r pathr r r
add_dir_ s zArchive.add_dirc C s t d S )N)r )r r+ r% devicer r r
add_nodeb s zArchive.add_nodec C s t dS )zReturn a temporary directory that clients of the archive may
use to write content to. The content of the path is guaranteed
to be included in the generated archive.N)r )r r r r
get_tmp_dire s zArchive.get_tmp_dirc C s t dS )zReturn the maximum file name length this archive can support.
This is the lesser of the name length limit of the archive
format and any temporary file system based cache.N)r )r r r r
name_maxk s zArchive.name_maxc C s t dS )aT Return a string representing the path to the temporary
archive. For archive classes that implement in-line handling
this will be the archive file itself. Archives that use a
directory based cache prior to packaging should return the
path to the temporary directory where the report content is
locatedN)r )r r r r
get_archive_pathq s zArchive.get_archive_pathc C s t dS )z:Clean up any temporary resources used by an Archive class.N)r )r r r r
cleanupz s zArchive.cleanupc C s t dS )a Finalize an archive object via method. This may involve creating
An archive that is subsequently compressed or simply closing an
archive that supports in-line handling. If method is automatic then
the following methods are tried in order: xz, gzipN)r )r methodr r r
finalize~ s zArchive.finalize)NF)r# ) r
__module__ __qualname____doc__ classmethodr loggingZ getLoggerr r r r
_path_lockr r r r r r r r" r& r' r* r, r. r/ r0 r1 r2 r4 r r r r
r ) s0
r c @ s e Zd ZdZdZdZdZd7ddZdd Zdd Z d8d d Z
d9ddZ dd Z d:ddZ
d;ddZdd Zdd Zdd Zd d Zd d Zd!d" Zd#d$ ZdTest whether path ``path`` is inside the archive.
r< )rR r? r+ rF )r+ )rootr r
in_archive s z8FileCacheArchive._make_leading_paths..in_archiver= r r< z Making path )r% zMaking symlink 'z' -> 'r> zMaking directory )r= r< )r rG rR r? r+ isdirrS splitappendreverserF existsislinkreadlink_make_leading_pathsnormpathrM rA symlinkmkdir)r r r% r rV src_dirr+ Z
path_compsheadtailZabs_pathZsrc_pathcomptargetZ
target_dirZ
target_srcr )rU r
r^ sL
z$FileCacheArchive._make_leading_pathsFc
C sd |p | j |}|tkr |}ntjj|d }|s4|S tjj|r^tjj| r^td| dtjj|s|tkrv|ntjj|d }| j| dd }|r|S tjj|r`tj |}d} |t
krt j |j
rt| |df |tkot j|j
r
t| |df |tkr2||j
r2t| |d f |tkr\t j|j
r\t| |d
f d S |S ) a4 Check a new destination path in the archive.
Since it is possible for multiple plugins to collect the same
paths, and since plugins can now run concurrently, it is possible
for two threads to race in archive methods: historically the
archive class only needed to test for the actual presence of a
path, since it was impossible for another `Archive` client to
enter the class while another method invocation was being
dispatched.
Deal with this by implementing a locking scheme for operations
that modify the path structure of the archive, and by testing
explicitly for conflicts with any existing content at the
specified destination path.
It is not an error to attempt to create a path that already
exists in the archive so long as the type of the object to be
added matches the type of object already found at the path.
It is an error to attempt to re-create an existing path with
a different path type (for example, creating a symbolic link
at a path already occupied by a regular file).
:param src: the source path to be copied to the archive
:param path_type: the type of object to be copied
:param dest: an optional destination path
:param force: force file creation even if the path exists
:returns: An absolute destination path if the path should be
copied now or `None` otherwise
r zpath 'z ' exists and is not a directoryc S s( t tj| tj| tj| tj| gS )N)anystatS_ISBLKS_ISCHRS_ISFIFOS_ISSOCK)r% r r r
is_special8 s
z/FileCacheArchive.check_path..is_specialz path '%s' exists and is not a %sz regular filez
symbolic linkz special fileZ directoryN)rP P_DIRr? r+ rX r[ rW
ValueErrorr^ lstatP_FILErh S_ISREGst_modeP_LINKS_ISLNKP_NODES_ISDIR)
r r path_typer r! dest_dirrb rm stZve_msgr r r
check_path s6
zFileCacheArchive.check_pathc C s ydt j|}|jds |jdrDtj|| t j||j|jfd n tj|| t j ||j
|j W n: t k
r } z | j
d| d| d W Y d d }~X nX d S )Nz/sys/z/proc/)nszcaught 'z' setting attributes of 'r> )r? rh rR shutilZcopymodeutime st_atime_ns st_mtime_nsZcopystatchownst_uidst_gid Exceptionr )r r r _stater r r
_copy_attributesT s
z!FileCacheArchive._copy_attributesc C s | j |s|}| j|t|d}|s*d S t|dd sytj|| W nP tk
r } z4|jds|jdrnn| jd| d| d W Y d d }~X nX | j || d| d}n@|j
d t |d d
d }x|D ]}|j | qW W d Q R X d }| j
d
| d| j d W d Q R X d S )N)r! readz/sys/z/proc/zFile z not collected: 'r> r r# zutf-8)encodingz open filezadded z to FileCacheArchive ')r: r{ rq getattrr} copyOSErrorrR r r seekopenwriter rG )r r r r! r file_namefliner r r
r" a s*
*
zFileCacheArchive.add_filer# c C s | j |}| j|tdd}tj||ddX}t|trD|jdd}|j| t j
j |rf| j || | j
d| d| j d W d Q R X W d Q R X d S )
NT)r! zutf-8)r utf8ignorezadded string at 'z' to FileCacheArchive 'r> )r: r{ rq codecsr
isinstancebytesdecoder r? r+ r[ r r rG )r r$ r r% r r r r r
r& s
zFileCacheArchive.add_stringc C sj | j Z | j|t}|s d S tj|dd d}|j| W d Q R X | jd| d| j d W d Q R X d S )Nwb)r zadded binary content at 'z' to archive 'r> )r: r{ rq r r r r rG )r r$ r r r r r
r' s zFileCacheArchive.add_binaryc C s | j d| d| d | jR | j|t}|s4d S tjj|sltj|| | j d| d| d| j d W d Q R X | j d| d| d | tjj |}tjj
tjj ||}| j |}d
d }tjj
|stjj|rb|}tjj |}tjj |tj|}tjj||}|||r<| j d | d
| d d S | j d| d| d | j|| nntjj|r| j d| d | j| nBtjj|r| j d| d | j| n| j d| d| d S )Nzadding symlink at 'z' -> 'r> zadded symlink at 'z' to 'z' in archive 'zLink follow up: source=z link_name=z dest=c S s t jj| }t jj|s.t jjt jj||}t jj| } | |krFdS yt j| W n2 tk
r } z|jdkrtdS W Y dd}~X nX dS )zReturn ``True`` if the symbolic link ``link_name`` is part
of a file system loop, or ``False`` otherwise.
T( NF) r? r+ dirnamerM realpathrF rh r errno)r) r( Zlink_dirr r r r
is_loop s
z*FileCacheArchive.add_link..is_loopzLink 'z' - 'z' loops: skipping...z Adding link z -> z for link follow upz Adding dir z Adding file zNo link follow up: source=)r r: r{ rt r? r+ lexistsr` rG r r rF rP r[ r\ r] rA r* rW r, isfiler" ) r r( r) r Z
source_dirZhost_path_nameZdest_path_namer ry r r r
r* s> *
zFileCacheArchive.add_linkc
C s" | j | j|t W dQ R X dS )zmCreate a directory in the archive.
:param path: the path in the host file system to add
N)r: r{ rn )r r+ r r r
r, s zFileCacheArchive.add_dirc C s | j |t}|sd S tjj|sytj||| W nR tk
r } z6|jtjkrpd}| j d| d| d d S |W Y d d }~X nX | j
|| d S )NzOperation not permittedz
add_node: z
- mknod 'r> ) r{ rv r? r+ r[ mknodr r ZEPERMr r )r r+ r% r- r r r r r r
r. s zFileCacheArchive.add_nodec C s& dt jkr"t jd }t j| j|S dS )N PC_NAME_MAX )r? pathconf_namespathconfrG )r Z pc_name_maxr r r
r0 s
zFileCacheArchive.name_maxc C s | j S )N)rG )r r r r
r/
s z FileCacheArchive.get_tmp_dirc C s | j S )N)rG )r r r r
r1
s z!FileCacheArchive.get_archive_pathc C s8 t jt jj| j||d | jd| d| j d dS )zsCreate path, including leading components.
Used by sos.sosreport to set up sos_* directories.
)r% zcreated directory at 'z' in FileCacheArchive 'r> N)r? rH r+ rF rG r )r r+ r% r r r
rH s zFileCacheArchive.makedirsc C s | j |}tj|ddddS )Nrzutf-8r )r errors)rP r r )r r+ r r r
open_file s
zFileCacheArchive.open_filec C s t jj| jrtj| j d S )N)r? r+ rW rG r} Zrmtree)r r r r
r2 s zFileCacheArchive.cleanupc C sf t j }| jj}|| }| jjd| | jjd| | jjd| | j| jjddtjj dd dS ) zAdds component-agnostic data to the manifest so that individual
SoSComponents do not need to redundantly add these manually
Zend_timerun_timeZ compression )indent sos_reportsz
manifest.jsonN)
r ZnowrE Z
start_timeZ add_fieldr& Zget_jsonr? r+ rF )r r3 endstartr r r r
add_final_manifest_data! s z(FileCacheArchive.add_final_manifest_datac C sN |j | j| _tjj| j| j}tj| j| || _tjj| j| j | _ dS )zeRename the archive to an obfuscated version using an initialized
SoSCleaner instance
N)
Zobfuscate_stringr r? r+ rF rB renamerG r
_archive_name)r ZcleanerZ _new_rootr r r
rename_archive_root. s
z$FileCacheArchive.rename_archive_rootc
C s t jt jB }t|dr(|j}|j|B }n|}|}d}| j|}|j }W dQ R X t|t sh|j
dd}t j ||||d\} }
|
r| j | | nd}
|
S )a Apply a regexp substitution to a file in the archive.
:param path: Path in the archive where the file can be found
:type path: ``str``
:param regexp: A regex to match the contents of the file
:type regexp: ``str`` or compiled ``re`` object
:param subst: The substitution string to be used to replace matches
within the file
:type subst: ``str``
:returns: Number of replacements made
:rtype: ``int``
patternr< Nr r )flagsr )
re
IGNORECASE MULTILINEhasattrr r r r r strr subnr& ) r r+ ZregexpZsubstZ common_flagsr r r$ readableresultZ replacementsr r r
do_file_sub8 s"
z FileCacheArchive.do_file_subc C s | j d| j d| d y| j|}W n4 tk
r\ } z| jd| | j S d }~X nX | j | j d| j dtj | jj
d | j d ry
| j |S tk
r } z d }| j| d
| |S d }~X qX n|S d S ) Nzfinalizing archive 'z' using method 'r> z+An error occurred compressing the archive: zbuilt archive at 'z' (size=)Zencryptz)An error occurred encrypting the archive: )
r rG _build_archiver r r r2 r r? rh st_sizerC _encrypt)r r3 reserrr Zexp_msgr r r
r4 ] s $
zFileCacheArchive.finalizec C s |j dd}|d7 }d| d}d}| jd rL|d| jd d7 }||7 }| jd r| jd j d
d }d |i}|d
7 }d| d}||7 }t|d|dd}|d dkr|S |d dkr| jd rd}qd}nd|d d|d }t|dS )a Encrypts the compressed archive using GPG.
If encryption fails for any reason, it should be logged by sos but not
cause execution to stop. The assumption is that the unencrypted archive
would still be of use to the user, and/or that the end user has another
means of securing the archive.
Returns the name of the encrypted archive, or raises an exception to
signal that encryption failed and the unencrypted archive name should
be used.
z
sosreport-zsecured-sosreport-z.gpgzgpg --batch -o r Nkeyz--trust-model always -e -r Zpasswordz'"r< Zsos_gpgz-c --passphrase-fd 0 z /bin/bash -c "echo $sos_gpg | "r T)ZtimeoutenvstderrZstatus z Specified key not in keyringzCould not read passphrasezgpg exited with code z and error output)replacerC r r )r archiveZarc_nameZenc_cmdr Zpasswdr r r r r
r t s,
zFileCacheArchive._encryptc C s | j S )N)r )r r3 r r r
r s z FileCacheArchive._build_archive)N)rT )NF)NF)r# )rT ) r
r5 r6 r7 rB rG r rL rP rS r^ r{ r r" r& r' r* r, r. r0 r/ r1 rH r r2 r r r r4 r r r r r r
r; s8
]
K
$
G
%)r; c sT e Zd ZdZdZdZd fdd ZdddZdd Zd
d Z d d
Z
dd Z Z S )TarFileArchivez: archive class using python TarFile to create tar archivesNFc s6 t j||||||| d| _tjj|| j | _d S )Ntar)superrL _suffixr? r+ rF r r )r r rI rJ rK rC rD rE ) __class__r r
rL s
zTarFileArchive.__init__c C sP |j |_|jd|jd< |jd|jd< |r4||_n|j|_|j|_|j |_
d S )Nz.9fZatimeZctime) st_mtimemtimest_atime pax_headersst_ctimer% rs r Zuidr gid)r Ztar_infofstatr% r r r
set_tarinfo_from_stat s z$TarFileArchive.set_tarinfo_from_statc s |j ttjj| jd d s*| j dddg}t fdd|D rNd S ytj }W n tk
rp |S X | j r| j
}|r||j d< | j || |S ) NrQ z
/version.txt$z/sos_logs(/.*)?z/sos_reports(/.*)?c 3 s | ]}t j| V qd S )N)r match).0skip) orig_pathr r
s z9TarFileArchive.copy_permissions_filter..zRHT.security.selinux)
r lenr? r+ rX rG rg rh r _with_selinux_contextget_selinux_contextr r )r ZtarinfoZskipsr contextr )r r
copy_permissions_filter s
z&TarFileArchive.copy_permissions_filterc C s, yt j|\}}|S tk
r& d S X d S )N)selinuxZ
getfileconr )r r+ _cr r r
r s
z"TarFileArchive.get_selinux_contextc C s | j d| j S )N.)rG r )r r r r
r s zTarFileArchive.namec
C s d}|dkr t dd k r dnd}|dkr,d }|d k rn|jd}| j d| | _| jd| 7 _d | }i d
d id d
id}tj| jfd|i|| h}xJdD ]B}tjjtjj | j
|r|j tjj | j
|| j d| d qW |j | j
| j | j
d W d Q R X | j S )Nr# autoZlzmaxzgzipZnoneZipr zw:Z
compresslevel Zpreset )Nr r r% version.txtr sos_logsr= )arcname)r filter)r r r )r stripr r tarfiler r? r+ r[ rF rG addr r r )r r3 _modeZ
_comp_modekwargsr Z_contentr r r
r s0
z TarFileArchive._build_archive)N)N)
r
r5 r6 r7 r3 r rL r r r r r
__classcell__r r )r r
r s
r )r? r r} r9 r r rh r r Z threadingr importlib.utilr Z
sos.utilitiesr r ImportErrorrq rt rv rn Z
P_CONTFILEr r; r r r r r
s6 ]