File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/engines/__pycache__/slack.cpython-310.pyc
o
�N�g؏ � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlZ ddl
Z ddl Z ddl Z ddl
Z ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ zddlZdZW n ey] dZY nw e�e�ZdZdd� ZG dd � d �Z
dd d
�Z dS )ad
An engine that reads messages from Slack and can act on them
.. versionadded:: 2016.3.0
:depends: `slackclient <https://pypi.org/project/slackclient/>`_ Python module
.. important::
This engine requires a bot user. To create a bot user, first go to the
**Custom Integrations** page in your Slack Workspace. Copy and paste the
following URL, and replace ``myworkspace`` with the proper value for your
workspace:
``https://myworkspace.slack.com/apps/manage/custom-integrations``
Next, click on the ``Bots`` integration and request installation. Once
approved by an admin, you will be able to proceed with adding the bot user.
Once the bot user has been added, you can configure it by adding an avatar,
setting the display name, etc. You will also at this time have access to
your API token, which will be needed to configure this engine.
Finally, add this bot user to a channel by switching to the channel and
using ``/invite @mybotuser``. Keep in mind that this engine will process
messages from each channel in which the bot is a member, so it is
recommended to narrowly define the commands which can be executed, and the
Slack users which are allowed to run commands.
This engine has two boolean configuration parameters that toggle specific
features (both default to ``False``):
1. ``control`` - If set to ``True``, then any message which starts with the
trigger string (which defaults to ``!`` and can be overridden by setting the
``trigger`` option in the engine configuration) will be interpreted as a
Salt CLI command and the engine will attempt to run it. The permissions
defined in the various ``groups`` will determine if the Slack user is
allowed to run the command. The ``targets`` and ``default_target`` options
can be used to set targets for a given command, but the engine can also read
the following two keyword arguments:
- ``target`` - The target expression to use for the command
- ``tgt_type`` - The match type, can be one of ``glob``, ``list``,
``pcre``, ``grain``, ``grain_pcre``, ``pillar``, ``nodegroup``, ``range``,
``ipcidr``, or ``compound``. The default value is ``glob``.
Here are a few examples:
.. code-block:: text
!test.ping target=*
!state.apply foo target=os:CentOS tgt_type=grain
!pkg.version mypkg target=role:database tgt_type=pillar
2. ``fire_all`` - If set to ``True``, all messages which are not prefixed with
the trigger string will fired as events onto Salt's ref:`event bus
<event-system>`. The tag for these veents will be prefixed with the string
specified by the ``tag`` config option (default: ``salt/engines/slack``).
The ``groups_pillar_name`` config option can be used to pull group
configuration from the specified pillar key.
.. note::
In order to use ``groups_pillar_name``, the engine must be running as a
minion running on the master, so that the ``Caller`` client can be used to
retrieve that minions pillar data, because the master process does not have
pillar data.
Configuration Examples
======================
.. versionchanged:: 2017.7.0
Access control group support added
This example uses a single group called ``default``. In addition, other groups
are being loaded from pillar data. The group names do not have any
significance, it is the users and commands defined within them that are used to
determine whether the Slack user has permission to run the desired command.
.. code-block:: text
engines:
- slack:
token: 'xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx'
control: True
fire_all: False
groups_pillar_name: 'slack_engine:groups_pillar'
groups:
default:
users:
- '*'
commands:
- test.ping
- cmd.run
- list_jobs
- list_commands
aliases:
list_jobs:
cmd: jobs.list_jobs
list_commands:
cmd: 'pillar.get salt:engines:slack:valid_commands target=saltmaster tgt_type=list'
default_target:
target: saltmaster
tgt_type: glob
targets:
test.ping:
target: '*'
tgt_type: glob
cmd.run:
target: saltmaster
tgt_type: list
This example shows multiple groups applying to different users, with all users
having access to run test.ping. Keep in mind that when using ``*``, the value
must be quoted, or else PyYAML will fail to load the configuration.
.. code-block:: text
engines:
- slack:
groups_pillar: slack_engine_pillar
token: 'xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx'
control: True
fire_all: True
tag: salt/engines/slack
groups_pillar_name: 'slack_engine:groups_pillar'
groups:
default:
users:
- '*'
commands:
- test.ping
aliases:
list_jobs:
cmd: jobs.list_jobs
list_commands:
cmd: 'pillar.get salt:engines:slack:valid_commands target=saltmaster tgt_type=list'
gods:
users:
- garethgreenaway
commands:
- '*'
� NTF�slackc C s t sdS tS )N)Fz3The 'slackclient' Python module could not be loaded)�HAS_SLACKCLIENT�__virtualname__� r r �F/opt/saltstack/salt/lib/python3.10/site-packages/salt/engines/slack.py� __virtual__� s r c @ s� e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd � Zd d � Z d%d d!�Zd"d#� Zd$S )&� SlackClientc C s* t j�t�| _t�|�| _| j�� | _ d S �N)
�salt�minionZ MasterMinion�__opts__�
master_minion� slackclientr �scZ rtm_connect�
slack_connect)�self�tokenr r r �__init__� s zSlackClient.__init__c C sb t jjjd|td�}i }d|v r/|d D ]}d|v r.|d s.|d ||d < |d ||d < q|S )z*
Get all users from Slack
�users��functionZapi_key�opts�messageZis_bot�id�name)r
�utilsr �queryr )r r �retr �itemr r r �get_slack_users� s �zSlackClient.get_slack_usersc C sH t jjjd|ddd�d�}i }d|v r"|d D ]
}|d ||d < q|S )z2
Get all channel names from Slack
ZroomsT)Zexclude_archivedZexclude_membersr r r r )r
r r r )r r r �channelsr r r r �get_slack_channels� s � z SlackClient.get_slack_channelsc
C sv dt � t � i i i d�i}|si }n|}t�d|� zt�| �|��� |�� �}W n ty> t�d|| �|�|� g }Y nw |D ]q\}}t� d||� |�
|t � t � i i i d�� zG|| d � t |� dg ��� || d � t |� dg ��� || d � |� di �� || d � |� d i �� || d
� |� d
i �� W qA t
tfy� t�d |� Y qAw t�d |� |S )
z�
get info from groups in config, and from the named pillar
todo: add specification for the minion to use to recover pillar
�default)r �commands�aliases�default_target�targetsz
use_groups %sz3Failed to get groups from %s: %s or from config: %sz$Trying to get %s and %s to be usefulr r# r$ r% r& zHCouldn't use group %s. Check that targets is a dictionary and not a listzGot the groups: %s)�set�log�debug� itertools�chain�_groups_from_pillar�items�AttributeError�warning�info�
setdefault�update�get�
IndexError)r Z groups_conf�groups_pillar_nameZ
ret_groupsZ
use_groupsZ
groups_genr Zconfigr r r �get_config_groups� sh �� � �� ��
� �� z SlackClient.get_config_groupsc C sT |r&t d dkr&td |i �}t�d||� t�d|� t�dt|�� |S i }|S )a�
pillar_prefix is the pillar.get syntax for the pillar to be queried.
Group name is gotten via the equivalent of using
``salt['pillar.get']('{}:{}'.format(pillar_prefix, group_name))``
in a jinja template.
returns a dictionary (unless the pillar is mis-formatted)
XXX: instead of using Caller, make the minion to use configurable so there could be some
restrictions placed on what pillars can be used.
�__roler z
pillar.getz#Got pillar groups %s from pillar %szpillar groups is %szpillar groups type is %s)r �__salt__r( r) �type)r Z pillar_nameZ
pillar_groupsr r r r, ' s �z SlackClient._groups_from_pillarc C sN t �d�dkrtjj�t t d �j}nd}|r |||� dS td ||� dS )zn
This replaces a function in main called 'fire'
It fires an event into the salt bus.
r7 ZmasterZsock_dirNz
event.send)r r3 r
r �eventZget_master_event� fire_masterr8 )r �tag�msgr; r r r �fire; s ��zSlackClient.firec C s� t �d|||� |�� D ]4\}}||d vr d|d vr q ||d vr4||�di ��� vr4d|d vr4q t �d||� ||f S t �d||� dS ) a�
Break out the permissions into the following:
Check whether a user is in any group, including whether a group has the '*' membership
:type user: str
:param user: The username being checked against
:type command: str
:param command: The command that is being invoked (e.g. test.ping)
:type groups: dict
:param groups: the dictionary with groups permissions structure.
:rtype: tuple
:returns: On a successful permitting match, returns 2-element tuple that contains
the name of the group that successfully matched, and a dictionary containing
the configuration of the group so it can be referenced.
On failure it returns an empty tuple
z!%s wants to run %s with groups %sr �*r# r$ z!Slack user %s permitted to run %sz%Slack user %s denied trying to run %sr )r( r0 r- r3 �keys)r �userZcommand�groups�key�valr r r � can_user_runM s �zSlackClient.can_user_runc C st t jj�|t|�d� �}g }|D ]&}d}t�||�}|r2|�d�|�d� |�d� }|�|� q|�|� q|S )z{
cmdline_str is the string of the command line
trigger_string is the trigger string, to be removed
Nz3(?P<begin>.*)(<.*\|)(?P<url>.*)(>)(?P<remainder>.*)�begin�url� remainder) r
r �argsZ shlex_split�len�re�match�group�append) r Z cmdline_str�trigger_string�cmdlineZcmdlistZcmditem�patternZmtchZorigtextr r r �commandline_to_listv s � z SlackClient.commandline_to_listc C s� | � ||�}| �||d |�}t�d||� |s dd|d fS |s(dd|d fS |d |d �di ��� v rR| � |d d |d �dd�d�}|�|dd� � n|}| �|||�}d d
� |D �}d ||fS ) a# Returns a tuple of (target, cmdline,) for the response
Raises IndexError if a user can't be looked up from all_slack_users
Returns (False, False) if the user doesn't have permission
These are returned together because the commandline and the targeting
interact with the group config (specifically aliases and targeting configuration)
so taking care of them together works out.
The cmdline that is returned is the actual list that should be
processed by salt, and not the alias.
r z3slack_user_name is %s and the permitted group is %sFN� r$ �cmd� c s& g | ]� t � fd d�dD ��r� �qS )c 3 s � | ] }� � |� V qd S r )�
startswith)�.0�x�r r r � <genexpr>� s � z@SlackClient.control_message_target.<locals>.<listcomp>.<genexpr>��target�tgt_type)�all)rW r rY r �
<listcomp>� s ��z6SlackClient.control_message_target.<locals>.<listcomp>T)rR rE r( r) r3 r@ �extend�
get_target) r Zslack_user_name�text�
loaded_groupsrO rP �permitted_groupZ use_cmdliner\ r r r �control_message_target� s, � ��
z"SlackClient.control_message_targetc
C s� |� d�dkr td��|� dd�p|� di �� dd�}zt�d|� W n ty; } z t�d|� W Y d}~nd}~ww tjj� |�}tjj
� |�}|sPt d��|S ) zs
Raises ValueError if a value doesn't work out, and TypeError if
this isn't a message type
r9 r zThis is not a messagerb Nz
Message is %sz5Got a message that I could not log. The reason is: %sz_text has no value)
r3 � TypeErrorr( r0 �UnicodeEncodeErrorr/ r
r �json�dumps�yaml� safe_load�
ValueError)r �m_dataZ_textZueer r r � message_text� s ��zSlackClient.message_textc # s� � �� �������� � ���fdd�}dD ]}�jr nt�d�jj|� t�|� qt d�
�j��� �j� � }|D ]�}z�� |�} W n t
tfyd }
zt�d|
� d|iV W Y d }
~
q<d }
~
ww �jjj�|d
�} ||�} | �|�rӈ�||�}
| �d �s�t�d |�d
�� | �d�
| d | �� d|iV q<��| d | |
|�\}}}t�d||� |r�||d
| d | d ||d�V q<| �d�
| d |�� | V q<| V q<ddiV q5)a�
slack_token = string
trigger_string = string
input_valid_users = set
input_valid_commands = set
When the trigger_string prefixes the message text, yields a dictionary
of::
{
'message_data': m_data,
'cmdline': cmdline_list, # this is a list
'channel': channel,
'user': m_data['user'],
'slack_client': sc
}
else yields {'message_data': m_data} and the caller can handle that
When encountering an error (e.g. invalid message), yields {}, the caller can proceed to the next message
When the websocket being read from has given up all its messages, yields {'done': True} to
indicate that the caller has read all of the relevant data for now, and should continue
its own processing and check back for more data later.
This relies on the caller sleeping between checks, otherwise this could flood
c s d| vr0d| v rd| d v rt �d� | d d }nd| v r/d| d v r/t �d� | d d }n| �d�}| �d�}|�d�rBd}n� �|�}| |��|�|d �}|d
sh��� ������� ��|�|d
< |d s� �� � ������ � �|�|d < |S ) z0Always try to return the user and channel anywayrA r z@Message was edited, so we look for user in the original message.Zcommentz6Comment was added, so we look for user in the comment.�channel�Dz private chat)� message_data�user_id� user_name� channel_namers rt )r( r) r3 rV �clearr2 r r! )rm rr Z
channel_idrt �data�Zall_slack_channelsZall_slack_usersr r r r � just_data� s: �
�
�z:SlackClient.generate_triggered_messages.<locals>.just_data)� �
� �< z4Slack connection is invalid. Server: %s, sleeping %sz3Connection to slack is still invalid, giving up: {}Tz3Got an error from trying to get the message text %srq Nro rs zCThe user %s can not be looked up via slack. What has happened here?rA z;The user {} can not be looked up via slack. Not running {}rr zGot target: %s, cmdline: %s)rq ro rA rs rP r\ z${} is not allowed to use command {}.�done)r r! r r( r/ r �server�time�sleep� UserWarning�formatZrtm_readrn rl rf r) r �findrV r6 r3 �error� send_messagere )r r rO rB r5 rx Zsleepsr= rm Zmsg_textZmsg_errro rv rc �allowedr\ rP r rw r �generate_triggered_messages� s� � ��$����
�
��
� �
����
�z'SlackClient.generate_triggered_messagesc s� ddd�� � �fdd�}||fD ]1}| � |�\}}d|v rAt�d|� d|v r8t�d |� |d |d d� S |d dd� S q||fD ]}||d
�}t�d |� |�d�r]| S qF� S ) a�
When we are permitted to run a command on a target, look to see
what the default targeting is for that group, and for that specific
command (if provided).
It's possible for None or False to be the result of either, which means
that it's expected that the caller provide a specific target.
If no configured target is provided, the command line will be parsed
for target=foo and tgt_type=bar
Test for this::
h = {'aliases': {}, 'commands': {'cmd.run', 'pillar.get'},
'default_target': {'target': '*', 'tgt_type': 'glob'},
'targets': {'pillar.get': {'target': 'you_momma', 'tgt_type': 'list'}},
'users': {'dmangot', 'jmickle', 'pcn'}}
f = {'aliases': {}, 'commands': {'cmd.run', 'pillar.get'},
'default_target': {}, 'targets': {},'users': {'dmangot', 'jmickle', 'pcn'}}
g = {'aliases': {}, 'commands': {'cmd.run', 'pillar.get'},
'default_target': {'target': '*', 'tgt_type': 'glob'},
'targets': {}, 'users': {'dmangot', 'jmickle', 'pcn'}}
Run each of them through ``get_configured_target(('foo', f), 'pillar.get')`` and confirm a valid target
r? �globr[ c sZ �\}}|� d�}|s
� }|� d�r |d � | �r |d | }|� d�s+t�d|| � |S )z_
Validate cmd against the group to return the target, or a null target
r% r& r\ z7Group %s is not configured to have a target for cmd %s.)r3 r( r) )rT r Z group_configr\ �Z null_targetrd r r �check_cmd_against_group� s
�z7SlackClient.get_target.<locals>.check_cmd_against_groupr\ ztarget is in kwargs %s.r] ztgt_type is in kwargs %s.r zthis cmdline has target %s.)�parse_args_and_kwargsr( r) r3 ) r rd rP Z
alias_cmdliner� Zthis_cl�_�kwargs�checkedr r� r ra l s$
�
�zSlackClient.get_targetc
K s� z,z
|t t|�� �d�}W n
ttfy d}Y nw tjjdd� |�� D �|t d�W S t
yL } zddl }t �
d|�|�� W Y d}~dS d}~ww ) z5
Print out YAML using the block mode
�outNc S s i | ] \}}||d �qS )�returnr )rW rX �yr r r �
<dictcomp>� s z2SlackClient.format_return_text.<locals>.<dictcomp>)r� r r z1Exception encountered when trying to serialize %sz5Got an error trying to serialze/clean up the response)�next�iterr3 �
StopIterationr. r
�outputZ
string_formatr- r � Exception�pprintr( � exceptionZpformat)r rv r r� Z outputter�excr� r r r �format_return_text� s( �����z SlackClient.format_return_textc C sZ g }i }t |�dkr)|dd� D ]}d|v r#|�dd�\}}|||< q|�|� q||fS )zU
cmdline: list
returns tuple of: args (list), kwargs (dict)
rS N�=)rJ �splitrN )r rP rI r� r rC �valuer r r r� � s
z!SlackClient.parse_args_and_kwargsc C s� t j�t�}t�d�}|st�d�}i }|D ]1}| jj|� d� |�rG|�d|g�}|�di �}|�di �}t jj �
t jj � |��|d�||< q|S )aV
Given a list of job_ids, return a dictionary of those job_ids that have
completed and their results.
Query the salt event bus via the jobs runner. jobs.list_job will show
a job in progress, jobs.lookup_jid will return a job that has
completed.
returns a dictionary of job id: result
Z
ext_job_cacheZmaster_job_cachez.get_jidz
jobs.list_jobZResultZFunction)rv r ) r
�runner� RunnerClientr r3 r
Z returnersrT r rh �loadsri ) r Zoutstanding_jidsr� �source�results�jidZ
job_resultZ
jid_resultZ jid_functionr r r �get_jobs_from_runner� s
��z SlackClient.get_jobs_from_runnerrS c C sp i } t �d|� t�|� d}|D ]�}t �d|�� � |dkr't �d� nl|s3|d7 }t �d� q|�d �r?t �d
� nT|r]t �d |� t �d ||� | �d
� ||d �d��|� |r�t
|�dkr�|�d�r�| j j j
�|d �} | �|�}
t �d|
� |||
< | �d� |d |
�� |d7 }qt�� } | �|�� �} t �dt
| �t�� | � | D ]�}
| |
d }
| |
d }|
�r6t �d|
� ||
}| j j j
�|d �} | �|
|�}d� |d |d |
|d �}| �|� t�� }tj�|��d�}d |� d �}| j jd | j||d �}t �d |� tjj�tjj � |��}d!|v �r3|d! d"u �r3|d �d#� |d$ �� ||
= q�q)%z�
Pull any pending messages from the message_generator, sending each
one to either the event bus, the command_async or both, depending on
the values of fire_all and command
TzSleeping for interval of %sr z$Got a message from the generator: %srz z6Breaking in getting messages because count is exceededrS zSkipping an empty message.r} z msg is donez&Firing message to the bus with tag: %sz%s %sz{}/{}rq r9 rP ro z Submitted a job and got jid: %sz%@{}'s job is submitted as salt jid {}rs z&Getting %s jobs status took %s secondsrv r zret to send back is %sz-@{}'s job `{}` (id: {}) (target: {}) returnedr\ z%Y%m%d%H%M%S%fz
salt-results-z.yamlz files.upload)r �filename�contentz Got back %s via the slack client�okFz Error: {}r� ) r( Ztracer r� r@ r/ r3 r) r> r� rJ r r~ r r� �run_command_asyncr� r� r� �datetime�
fromtimestamp�strftimeZapi_callr r
r rj rk rh ri )r �message_generator�fire_allr< �control�intervalZ outstanding�countr= ro r� Z
start_timeZ
job_status�resultr Zthis_jobZ return_textZ
return_prefix�ts�str� �rZrespr r r � run_commands_from_slack_async� s�
�
���
�
� ��
� ���z)SlackClient.run_commands_from_slack_asyncc C s2 t �d� ttj�t�j�}|d d }| �|d �\}}d|v r,|j t
� |d �d� |d d }|d d }t �d|� ||v r]tj� t�}t �d |� |�
|||d
��} | d }
|
S t �d ||� t �d
|||||� tj�� �} | jt|�|||t|�d�}
W d � n1 s�w Y t �d|
� |
S )a�
:type message_generator: generator of dict
:param message_generator: Generates messages from slack that should be run
:type fire_all: bool
:param fire_all: Whether to also fire messages to the event bus
:type tag: str
:param tag: The tag to send to use to send to the event bus
:type interval: int
:param interval: time to wait between ending a loop and beginning the next
z#Going to run a command asynchronousrP r �pillar)r� r\ r] ztarget_type is: %sz(Command %s will run via runner_functions)�arg�kwargr� z5Command %s will run via local.cmd_async, targeting %szRunning %s, %s, %s, %s, %s)r� r� r] Nz ret from local.cmd_async is %s)r( r) �sortedr
r� ZRunnerr Z functionsr� r2 �astZ literal_evalr� Z asynchronous�clientZ LocalClientZ cmd_async�strr0 ) r r= Zrunner_functionsrT rI r� r\ r] r� Z job_id_dictZjob_id�localr r r r� Y s<
�� � � z SlackClient.run_command_asyncN)rS )�__name__�
__module__� __qualname__r r r! r6 r, r> rE rR re rn r� ra r� r� r� r� r� r r r r r � s( F)6 @!
� _r �!�salt/engines/slackc C s� t jj�dd� | r| �d�s t�d� t�d� t d��zt
| d�}|� | |||�}|� ||||� W dS t
yC t
t�� � ��w ) zF
Listen to slack events and forward them to salt, new version
ZArgonz�This 'slack' engine will be deprecated and will be replace by the slack_bolt engine. This new engine will use the new Bolt library from Slack and requires a Slack app and a Slack bot account.Zxoxb� z%Slack bot token not found, bailing...z%Slack Engine bot token not configured)r N)r
r ZversionsZ
warn_untilrV r r� r( r� r� r r� r� r� � traceback�
format_exc) r r� ZtriggerrB r5 r� r< r� r� r r r �start� s"
�
� �r� )Fr� NNFr� ) �__doc__r� r� r* �loggingrK r r� Z salt.clientr
Z salt.loaderZ salt.minionZ salt.outputZ salt.runnerZsalt.utils.argsZsalt.utils.eventZsalt.utils.httpZsalt.utils.jsonZsalt.utils.slackZsalt.utils.yamlr r � ImportError� getLoggerr� r( r r r r� r r r r �<module> sT �
_�