File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/engines/__pycache__/ircbot.cpython-310.pyc
o
�N�g�( � @ s� d Z ddlZddlZddlZddlZddlZddlmZ ddlZ ddl
Z ddl Z e� e
�Zedd�Zedd�ZG dd � d �Z
ddd�ZdS )a
IRC Bot engine
.. versionadded:: 2017.7.0
Example Configuration
.. code-block:: yaml
engines:
- ircbot:
nick: <nick>
username: <username>
password: <password>
host: irc.oftc.net
port: 7000
channels:
- salt-test
- '##something'
use_ssl: True
use_sasl: True
disable_query: True
allow_hosts:
- salt/engineer/.*
allow_nicks:
- gtmanfred
Available commands on irc are:
ping
return pong
echo <stuff>
return <stuff> targeted at the user who sent the commands
event <tag> [<extra>, <data>]
fire event on the master or minion event stream with the tag `salt/engines/ircbot/<tag>` and a data object with a
list of everything else sent in the message
Example of usage
.. code-block:: text
08:33:57 @gtmanfred > !ping
08:33:57 gtmanbot > gtmanfred: pong
08:34:02 @gtmanfred > !echo ping
08:34:02 gtmanbot > ping
08:34:17 @gtmanfred > !event test/tag/ircbot irc is useful
08:34:17 gtmanbot > gtmanfred: TaDa!
.. code-block:: text
[DEBUG ] Sending event: tag = salt/engines/ircbot/test/tag/ircbot; data = {'_stamp': '2016-11-28T14:34:16.633623', 'data': ['irc', 'is', 'useful']}
� N)�
namedtuple�Eventzsource code line� PrivEventz/source nick user host code channel command linec @ s� e Zd Z d$dd�Zdd � Zd
d � Zed d
� �Zdd� Zdd� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zd d � Zd d � Zd d!� Zd"d#� ZdS )%� IRCClient� NF�!Tc
C sz || _ || _|| _|p || _|| _|pg | _|| _|| _| | _|
| _ | | _
| | _ t j
jjjdd�| _| j�� | �� d S )NF)� make_current)�nick�host�port�username�password�channels�ssl�sasl�char� allow_hosts� allow_nicks�
disable_query�salt�ext�tornado�ioloop�IOLoop�io_loopr �_connect)
�selfr r
r r r
r �use_ssl�use_saslr r r r � r �G/opt/saltstack/salt/lib/python3.10/site-packages/salt/engines/ircbot.py�__init__M s
zIRCClient.__init__c C sv t � t jt jd�}| jdu r tjjjj|dtj id�| _
n tjjj� |�| _
| j
� | j
� | j
�| j| jf| j� d S )Nr T� cert_reqs)Z ssl_options)�socket�AF_INET� SOCK_STREAMr r r r ZiostreamZ SSLIOStream� CERT_NONE�_streamZIOStreamZset_close_callback� on_closed�connectr
r �
on_connect)r �_sockr r r r l s
� zIRCClient._connectc C s | j �d| j� d S )Nz
)r' Z
read_until�_message�r r r r �
read_messagesw s zIRCClient.read_messagesc C sF t �d| � t�d| �}|�d�|�d�|�d�}}} t||| �S )Nz Received: %sz;^(?:(?P<source>:[^ ]+) )?(?P<code>[^ ]+)(?: (?P<line>.*))?$�source�code�line)�log�debug�re�match�groupr )r1 �searchr/ r0 r r r �_eventz s �
� zIRCClient._eventc �* t | jt�r | jS t� fdd�| jD ��S )Nc � g | ]}t �|� ��qS r �r4 r5 ��.0r5 �r
r r �
<listcomp>� � z)IRCClient._allow_host.<locals>.<listcomp>)�
isinstancer �bool�any)r r
r r> r � _allow_host� � zIRCClient._allow_hostc r9 )Nc r: r r; r< �r r r r? � r@ z)IRCClient._allow_nick.<locals>.<listcomp>)rA r rB rC )r r r rF r � _allow_nick� rE zIRCClient._allow_nickc
C s� t �d|j�}|�d�|�d�|�d�}}}t �d�| j�|j�}|rt|�d�|�d�|�d�}}}| jd u rB|�d
�sBd S || j krI|}t
|j||||j |||�} | � |�s`| �
|�rxt| d |� ��rvt| d |� ��| � d S d S d S d S ) Nz/^:(?P<nick>[^!]+)!(?P<user>[^@]+)@(?P<host>.*)$r �userr
zA^(?P<channel>[^ ]+) :(?:{}(?P<command>[^ ]+)(?: (?P<line>.*))?)?$�channel�commandr1 T�#Z _command_)r4 r5 r/ r6 �formatr r1 r �
startswithr r r0 rG rD �hasattr�getattr)
r �eventr7 r rH r
rI rJ r1 Z priveventr r r �_privmsg� s> �
���
�
�
��
zIRCClient._privmsgc C s" d|j � d|j� �}| �|� d S )N�PRIVMSG � :)rI r1 � send_message�r rP �messager r r �
_command_echo� s zIRCClient._command_echoc C s$ d|j � d|j� d�}| �|� d S )NrR rS z: pong)rI r rT rU r r r �
_command_ping� s zIRCClient._command_pingc s� t �d�dkrtjj�t t d �j� nd � � fdd�}|j�d�}|d }t |�dkr4d |dd � i}nd g i}|d
| |� d |j
� d |j � d
�}| � |� d S )NZ__roleZmasterZsock_dirc s$ � r � || � dS t d | |� dS )z/
How to fire the event
z
event.sendN)Z__salt__)�tag�msg�Z fire_masterr r �fire� s z&IRCClient._command_event.<locals>.fire� r � �datazsalt/engines/ircbot/rR rS z: TaDa!)
Z__opts__�getr �utilsrP Zget_master_eventZ
fire_eventr1 �split�lenrI r rT )r rP r\ �argsrY �payloadrV r r[ r �_command_event� s �� zIRCClient._command_eventc C sx |� d��d�}| �|�}|jdkr$tjjjj� � �
| j d|j � �� n|jdkr6tjjjj� � �
| j
|� | �� d S )N�
�utf-8ZPINGzPONG ZPRIVMSG)�rstrip�decoder8 r0 r r r r r �currentZspawn_callbackrT r1 rQ r. )r �rawrP r r r r, � s
�
� zIRCClient._messagec C s& |� d�s d| }| �d|� �� d S )NrK zJOIN )rM rT )r rI r r r � join_channel� s
zIRCClient.join_channelc C s� t �d� | jdu r| �d� | �d| j� �� | �d� | jrP| jdu rEt�d�| j | j��
� �}| �d� | �d|� �� | �d � n | �d
�| j | j�� | j D ]}| � |� qS| �
� d S ) Nr* Tz
CAP REQ :saslzNICK z USER saltstack 0 * :saltstackz {0} {0} {1}zAUTHENTICATE PLAINz
AUTHENTICATE zCAP ENDz PRIVMSG NickServ :IDENTIFY {} {})�logging�infor rT r r
�base64� b64encoderL r �encoder rm r. )r Z
authstringrI r r r r* � s*
�
��
zIRCClient.on_connectc C s t �d� d S )Nr( )rn ro r- r r r r( s zIRCClient.on_closedc C s4 t |t�r
|�d�}t�d|� | j�|d � d S )Nrh z Sending: %srg )rA �strrr r2 r3 r' �write)r r1 r r r rT s
zIRCClient.send_message�
r NNNFFr FFT)�__name__�
__module__� __qualname__r! r r. � staticmethodr8 rD rG rQ rW rX rf r, rm r* r( rT r r r r r L s6
�
! r r Fr Tc
C s0 t | |||||p g |||| |
| � } | j�� dS )aj
IRC Bot for interacting with salt.
nick
Nickname of the connected Bot.
host
irc server (example - irc.oftc.net).
port
irc port. Default: 6667
password
password for authenticating. If not provided, user will not authenticate on the irc server.
channels
channels to join.
use_ssl
connect to server using ssl. Default: False
use_sasl
authenticate using sasl, instead of messaging NickServ. Default: False
.. note:: This will allow the bot user to be fully authenticated before joining any channels
char
command character to look for. Default: !
allow_hosts
hostmasks allowed to use commands on the bot. Default: False
True to allow all
False to allow none
List of regexes to allow matching
allow_nicks
Nicks that are allowed to use commands on the bot. Default: False
True to allow all
False to allow none
List of regexes to allow matching
disable_query
Disable commands from being sent through private queries. Require they be sent to a channel, so that all
communication can be controlled by access to the channel. Default: True
.. warning:: Unauthenticated Access to event stream
This engine sends events calls to the event stream without authenticating them in salt. Authentication will
need to be configured and enforced on the irc server or enforced in the irc channel. The engine only accepts
commands from channels, so non authenticated users could be banned or quieted in the channel.
/mode +q $~a # quiet all users who are not authenticated
/mode +r # do not allow unauthenticated users into the channel
It would also be possible to add a password to the irc channel, or only allow invited users to join.
N)r r �start)
r r
r r r
r r r r r r r �clientr r r rz
s F�rz ru )�__doc__rp rn r4 r# r � collectionsr Zsalt.ext.tornado.ioloopr Zsalt.ext.tornado.iostreamZsalt.utils.event� getLoggerrv r2 r r r rz r r r r �<module> s4 8
E�