3
�f�T � @ s d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl m
Z
d dl m Z m
Z
mZmZmZmZmZ d dlmZ d dlmZmZmZmZ d dlmZm Z d dl m Z d dl m Z! d d l"m#Z# d
d � Z$i ddd dd
fdd�Z%G dd� d�Z&dS )� N)�getpwuid)� NO_PRESET�GENERIC_PRESETS� PRESETS_PATH�PresetDefaults�DESC�NOTE�OPTS)�PackageManager)�ImporterHelper�
import_module�get_human_readable�bold)�IndependentPlugin�ExperimentalPlugin)�
SoSOptions)�_sos)�fillc C s, d| }y
t |t�S tk
r& d S X d S )Nzsos.policies.distros.%s)r �Policy� ImportError)�nameZ
policy_fqname� r � /usr/lib/python3.6/__init__.py�
import_policy s
r T� c
C s� d| kr| j d�S dd l}t|jj�}xB|j� D ]6}x0t|�D ]$} | j|d�r>| ||||d�| d< q>W q0W tj dkr|t
d��d| kr�|jjj � | d< | d S )N�policyr )�remote)�sysroot�init�
probe_runtime� remote_exec�linuxz%SoS is not supported on this platform) �getZsos.policies.distrosr ZpoliciesZdistrosZ get_modulesr �check�sys�platform� ExceptionZGenericLinuxPolicy)
�cacher r r r Z remote_check�sos�helper�moduler r r r �load s
r+ c @ sb e Zd ZdZed�ZdZdZdJgZdZ dZ
dZ de � iZ
eZd ZdKd d
�ZdLdd�Zedd� �Zedd� �Zdd� Zdd� Zdd� Zdd� Zd d � Zd d � Z d d!� Z dMd"d#�Z d$d%� Z d&d'� Z d(d)� Z!d*d+� Z"d,d-� Z#d.d/� Z$d0d1� Z%d2d3� Z&d4d5� Z'ed6d7� �Z(dNd8d9�Z)d:d;� Z*d<d=� Z+dOd>d?�Z,d@dA� Z-dBdC� Z.dPdDdE�Z/d
d
d
e0� fdFdG�Z1dQdHdI�Z2d
S )Rr a/ Policies represent distributions that sos supports, and define the way
in which sos behaves on those distributions. A policy should define at
minimum a way to identify the distribution, and a package manager to allow
for package based plugin enablement.
Policies also control preferred ContainerRuntime()'s, upload support to
default locations for distribution vendors, disclaimer text, and default
presets supported by that distribution or vendor's products.
Every Policy will also need at least one "tagging class" for plugins.
:param sysroot: Set the sysroot for the system, if not /
:type sysroot: ``str`` or ``None``
:param probe_runtime: Should the Policy try to load a ContainerRuntime
:type probe_runtime: ``bool``
:param remote_exec: If this policy is loaded for a remote node, use
this to facilitate executing commands via the
SoSTransport in use
:type remote_exec: ``SoSTranport.run_command()``
:cvar distro: The name of the distribution the Policy represents
:vartype distro: ``str``
:cvar vendor: The name of the vendor producing the distribution
:vartype vendor: ``str``
:cvar vendor_urls: List of URLs for the vendor's website, or support portal
:vartype vendor_urls: ``list`` of ``tuples`` formatted
``(``description``, ``url``)``
:cvar vendor_text: Additional text to add to the banner message
:vartype vendor_text: ``str``
:cvar name_pattern: The naming pattern to be used for naming archives
generated by sos. Values of `legacy`, and `friendly`
are preset patterns. May also be set to an explicit
custom pattern, see `get_archive_name()`
:vartype name_pattern: ``str``
ap This command will collect system configuration and diagnostic information from this %(distro)s system.
For more information on %(vendor)s visit:
%(vendor_urls)s
The generated archive may contain data considered sensitive and its content should be reviewed by the originating organization before being passed to any third party.
%(changes_text)s
%(vendor_text)s
ZUnknown� Example URL�http://www.example.com/r z</usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin�legacyFNTc C sd t jd�| _t jd�| _| j� d| _|| _t� | _t g| _
|| _ | j sP| j � || _
| jt� dS )aJ Subclasses that choose to override this initializer should call
super() to ensure that they get the required platform bits attached.
super(SubClass, self).__init__(). Policies that require runtime
tests to construct PATH must call self.set_exec_path() after
modifying PATH in their own initializer.r( Zsos_uiN)�loggingZ getLoggerZsoslog�ui_log� _parse_uname�case_idr r
�package_managerr �valid_subclassesr �
set_exec_pathr �register_presetsr )�selfr r r r r r �__init__| s zPolicy.__init__c C s dS )a�
This function is responsible for determining if the underlying system
is supported by this policy.
If `remote` is provided, it should be the contents of os-release from
a remote host, or a similar vendor-specific file that can be used in
place of a locally available file.
:returns: ``True`` if the Policy should be loaded, else ``False``
:rtype: ``bool``
Fr )r7 r r r r r# � s z Policy.checkc C sJ t | d�s<g | _x*| jjD ] }t |d�r| jj|j� � qW tt| j��S )a# This property is used to determine the list of forbidden paths
set by the policy. Note that this property will construct a
*cumulative* list based on all subclasses of a given policy.
:returns: All patterns of policy forbidden paths
:rtype: ``list``
�_forbidden_paths�set_forbidden_paths)�hasattrr9 � __class__�__mro__�extendr: �list�set)r7 �clsr r r �forbidden_paths� s
zPolicy.forbidden_pathsc C s ddddgS )z�Use this to *append* policy-specifc forbidden paths that apply to
all plugins. Setting this classmethod on an invidual policy will *not*
override subclass-specific paths
z*.eggz*.pycz*.pyoz*.swpr )rA r r r r: � s zPolicy.set_forbidden_pathsc C s | j S )z�Are we running inside a container?
:returns: ``True`` if in a container, else ``False``
:rtype: ``bool``
)�
_in_container)r7 r r r � in_container� s zPolicy.in_containerc C s dS )z'
Return the OS version
Nr )r7 r r r � dist_version� s zPolicy.dist_versionc C s ddl m} |S )zb
Return the class object of the prefered archive format for this
platform
r )�TarFileArchive)Z sos.archiverF )r7 rF r r r �get_preferred_archive� s z Policy.get_preferred_archivec C s� | j � jd�d }| j}| jd j}d}djdd� td�D ��}| jdkrr|rVd| nd}d }d
|� |� |� �}nR| jd kr�|r�d | nd}|r�d | nd}d
}d
|� |� |� |� d |� �}n| j}| jt j
|��S )a^
This function should return the filename of the archive without the
extension.
This uses the policy's `name_pattern` attribute to determine the name.
There are two pre-defined naming patterns - `legacy` and `friendly`
that give names like the following:
* legacy - `sosreport-tux.123456-20171224185433`
* friendly - `sosreport-tux-mylabel-123456-2017-12-24-ezcfcop.tar.xz`
A custom name_pattern can be used by a policy provided that it
defines name_pattern using a format() style string substitution.
Usable substitutions are:
* name - the short hostname of the system
* label - the label given by --label
* case - the case id given by --case-id
* rand - a random string of 7 alpha characters
Note that if a datestamp is needed, the substring should be set
in `name_pattern` in the format accepted by ``strftime()``.
:returns: A name to be used for the archive, as expanded from
the Policy `name_pattern`
:rtype: ``str``
�.r � cmdlineoptsr c s s | ]}t jtj�V qd S )N)�randomZchoice�stringZascii_lowercase)�.0�xr r r � <genexpr>� s z*Policy.get_archive_name.<locals>.<genexpr>� r. z
-%Y%m%d%H%M%Sz
sosreport-Zfriendly�-z -%Y-%m-%d) Zget_local_name�splitr2 �commons�label�join�range� name_patternZsanitize_filename�timeZstrftime)r7 r ZcaserS ZdateZrandZnstrr r r �get_archive_name� s
zPolicy.get_archive_namec C s |S )Nr )r7 Zbinaryr r r �_get_pkg_name_for_binary s z Policy._get_pkg_name_for_binaryc C s |s t j� S |S )N)�tempfileZ
gettempdir)r7 Z opt_tmp_dirr r r � get_tmp_dir s zPolicy.get_tmp_dirc C s6 t |�dkr.x |D ]}t|| jd �r|S qW |d S )az Determine what subclass of a Plugin should be used based on the
tagging classes assigned to the Plugin
:param plugin_classes: The classes that the Plugin subclasses
:type plugin_classes: ``list``
:returns: The first tagging class that matches one of the Policy's
`valid_subclasses`
:rtype: ``PluginDistroTag``
� r )�len�
issubclassr4 )r7 Zplugin_classes�pr r r � match_plugin s
zPolicy.match_pluginc s0 t g| j }|r|tg7 }t� fdd�|D ��S )a#
Verifies that the plugin_class should execute under this policy
:param plugin_class: The tagging class being checked
:type plugin_class: ``PluginDistroTag``
:returns: ``True`` if the `plugin_class` is allowed by the policy
:rtype: ``bool``
c 3 s | ]}t � |�V qd S )N)r^ )rL Zclass_)� plugin_classr r rN - s z)Policy.validate_plugin.<locals>.<genexpr>)r r4 r �any)r7 ra Z experimentalr4 r )ra r �validate_plugin s
zPolicy.validate_pluginc C s dS )z>
This function is called prior to collection.
Nr )r7 r r r �pre_work0 s zPolicy.pre_workc C s dS )zQ
This function is called after the sosreport has been generated.
Nr )r7 r r r � post_work6 s zPolicy.post_workc C s | j j|�S )z�Wrapper to retrieve a package from the Policy's package manager
:param pkg: The name of the package
:type pkg: ``str``
:returns: The first package that matches `pkg`
:rtype: ``str``
)r3 � pkg_by_name)r7 Zpkgr r r rf < s zPolicy.pkg_by_namec C sB t j� \}}}}}}|| _|| _|| _|j� d dk| _|| _d S )Nr\ ZSMP)r% �uname�systemZhostname�releaserQ Zsmp�machine)r7 rh Znoderi �versionrj Z processorr r r r1 G s zPolicy._parse_unamec C s
|| _ dS )z9Set common host data for the Policy to reference
N)rR )r7 rR r r r � set_commonsP s zPolicy.set_commonsc C s |t jd< d S )N�PATH)�os�environ)r7 �pathr r r � _set_PATHU s zPolicy._set_PATHc C s | j | j� d S )N)rq rm )r7 r r r r5 X s zPolicy.set_exec_pathc C s t j� dkS )z�This method should return true if the user calling the script is
considered to be a superuser
:returns: ``True`` if user is superuser, else ``False``
:rtype: ``bool``
r )rn �getuid)r7 r r r �is_root[ s zPolicy.is_rootc C s dS )zRReturns the string name of the hashlib-supported checksum algorithm
to useZsha256r )r7 r r r �get_preferred_hash_named s z Policy.get_preferred_hash_namec C s� |j d� |jd� |jdtd�td�f � |jd� ddd d
d �}|jd �}|jd
� x0|D ](}|jdd�|d�|| d��dd� q`W d S )Nz SoS Policiesz�Policies help govern how SoS operates on across different distributions of Linux. They control aspects such as plugin enablement, $PATH determination, how/which package managers are queried, default upload specifications, and more.a� When SoS intializes most functions, for example %s and %s, one of the first operations is to determine the correct policy to load for the local system. Policies will determine the proper package manager to use, any applicable container runtime(s), and init systems so that SoS and report plugins can properly function for collections. Generally speaking a single policy will map to a single distribution; for example there are separate policies for Debian, Ubuntu, RHEL, and Fedora.z
sos reportz sos collectzRIt is currently not possible for users to directly control which policy is loaded.z*The Google Cloud-Optimized OS distributionzThe Debian distributionz=Red Hat family distributions, not necessarily including forksz Ubuntu/Canonical distributions)z policies.coszpolicies.debianzpolicies.redhatzpolicies.ubuntuzSee Alsoz9For more information on distribution policies, see below
� z>8z<20z<30F)�newline)Z set_titleZadd_textr Z add_section)r7 ZsectionZpolsZseealsoZpolr r r � display_helpi s&
zPolicy.display_helpc C s� | r| rdS |r*| j jtd|� ��� |r�| j jtd|� d��� | j jtdt|j�� ��� | j jtdt|j�j� ��� n| j jtd|� d��� |r�| j jd| j� � d |� �� | j jtd
�� d S ) ah Display final information about a generated archive
:param archive: The name of the archive that was generated
:type archive: ``str``
:param directory: The build directory for sos if --build was used
:type directory: ``str``
:param checksum: The checksum of the archive
:type checksum: ``str``
:param archivestat: stat() information for the archive
:type archivestat: `os.stat_result`
:param map_file: If sos clean was invoked, the location of the mapping
file for this run
:type map_file: ``str``
Fz3
A mapping of obfuscated elements is available at
z2
Your sosreport has been generated and saved in:
�
z Size z Owner z2Your sosreport build tree has been generated in:
ru � z7
Please send this file to your support representative.
N) r0 �info�_r
�st_sizer �st_uidZpw_namert )r7 �archiveZ directoryZchecksumZ archivestatZmap_filer r r �display_results� s&
zPolicy.display_resultsc C sr | j d jrd}nd}d}| j| j| j| j� | j| j d |d� }d}x&|j� D ]}|t||dd � d
}qPW |S ) aU This method is used to prepare the preamble text to display to
the user in non-batch mode. If your policy sets self.distro that
text will be substituted accordingly. You can also override this
method to do something more complicated.
:returns: Formatted banner message string
:rtype: ``str``
rI z,Changes CAN be made to system configuration.z0No changes will be made to system configuration.�H �tmpdir)�distro�vendor� vendor_urls� vendor_textr� � changes_textr F)Zreplace_whitespacerx ) rR Zallow_system_changes�msgr� r� �_fmt_vendor_urlsr� �
splitlinesr )r7 r� �widthZ_msgZ_fmt�liner r r �get_msg� s
zPolicy.get_msgc s. t dd� | jD ��� dj� fdd�| jD ��S )z�Formats all items in the ``vendor_urls`` class attr into a usable
string for the banner message.
:returns: Formatted string of URLS
:rtype: ``str``
c S s g | ]}t |d ��qS )r )r] )rL �vr r r �
<listcomp>� s z+Policy._fmt_vendor_urls.<locals>.<listcomp>rx c 3 s. | ]&}d |d d� � ��d|d � �V qdS )ry r �<z : r\ Nr )rL Zurl)r� r r rN � s z*Policy._fmt_vendor_urls.<locals>.<genexpr>)�maxr� rT )r7 r )r� r r� � s zPolicy._fmt_vendor_urlsc C s |r
i | _ | j j|� dS )a Add new presets to this policy object.
Merges the presets dictionary ``presets`` into this ``Policy``
object, or replaces the current presets if ``replace`` is
``True``.
``presets`` should be a dictionary mapping ``str`` preset names
to ``<class PresetDefaults>`` objects specifying the command
line defaults.
:param presets: dictionary of presets to add or replace
:param replace: replace presets rather than merge new presets.
N)�presets�update)r7 r� �replacer r r r6 � s zPolicy.register_presetsc C s* x$| j j� D ]}||kr | j | S q W dS )z�Find a preset profile matching the specified preset string.
:param preset: a string containing a preset profile name.
:returns: a matching PresetProfile.
N)r� �keys)r7 �preset�matchr r r � find_preset s zPolicy.find_presetc C s
| j t S )z�Return a ``PresetDefaults`` object matching the runing host.
Stub method to be implemented by derived policy classes.
:returns: a ``PresetDefaults`` object.
)r� r )r7 r r r � probe_preset s zPolicy.probe_presetc C s |p| j }tjj|�sdS x�tj|�D ]�}tjj||�}t|��,}ytj|�}W n t k
rf w&Y nX W dQ R X x�|j
� D ]�}t |t � d�}|| }t
|kr�|t
nd|_t|kr�|t nd|_t|kr�x&|t D ]}t|j||t | � q�W d|_|| j|< q|W q&W dS )z�Load presets from disk.
Read JSON formatted preset data from the specified path,
or the default location at ``/var/lib/sos/presets``.
:param presets_path: a directory containing JSON presets.
N)�optsr F)� presets_pathrn rp �exists�listdirrT �open�jsonr+ �
ValueErrorr� r r r �descr �noter �setattrr� �builtinr� ) r7 r� Z preset_pathZpfZ preset_datar� Zpd�data�argr r r � load_presets s(
zPolicy.load_presetsc C s\ | j }|std��|| jj� kr,td| ��t||||d�}d|_|| j|j< |j|� dS )z�Add a new on-disk preset and write it to the configured
presets path.
:param preset: the new PresetDefaults to add
zPreset name cannot be emptyz&A preset with name '%s' already exists)r r� r� r� FN)r� r� r� r� r r� r �write)r7 r r� r� r� r� r� r r r �
add_preset; s zPolicy.add_presetc C sZ | s|| j j� kr td| ��| j | }|jr>td|j ��|j| j� | j j|� d S )NzUnknown profile: '%s'z"Cannot delete built-in preset '%s')r� r� r� r� r �deleter� �pop)r7 r r� r r r �
del_presetN s
zPolicy.del_preset)r, r- )NTN)r )F)NN)F)N)r )3�__name__�
__module__� __qualname__�__doc__r{ r� r� r� r� r� rm rV r r� r r� rC r8 r# �propertyrB � classmethodr: rD rE rG rX rY r[ r` rc rd re rf r1 rl rq r5 rs rt rw r r� r� r6 r� r� r� r r� r� r r r r r 6 sX )
4
-
8
r )'r/ rn r% rW r� rZ rJ rK r$ �pwdr Z sos.presetsr r r r r r r Z sos.policies.package_managersr
Z
sos.utilitiesr r r
r Zsos.report.pluginsr r Z sos.optionsr r( r r{ �textwrapr r r+ r r r r r �<module> s( $