Current File : //lib/python2.7/site-packages/salt/beacons/wtmp.pyo
�
���^c
@@ sf d Z d d l m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z d d l m Z d d l
m Z d Z d Z d Z d d
d d d
d d d d d g
Z e j e � Z d Z d Z d Z d Z e j e � Z y d d l j Z e Z Wn e! k
r"e" Z n Xd � Z# d � Z$ d � Z% d � Z& d � Z' d � Z( d � Z) d S( u�
Beacon to fire events at login of users as registered in the wtmp file
.. versionadded:: 2015.5.0
Example Configuration
=====================
.. code-block:: yaml
# Fire events on all logins
beacons:
wtmp: []
# Matching on user name, using a default time range
beacons:
wtmp:
- users:
gareth:
- defaults:
time_range:
start: '8am'
end: '4pm'
# Matching on user name, overriding the default time range
beacons:
wtmp:
- users:
gareth:
time_range:
start: '7am'
end: '3pm'
- defaults:
time_range:
start: '8am'
end: '4pm'
# Matching on group name, overriding the default time range
beacons:
wtmp:
- groups:
users:
time_range:
start: '7am'
end: '3pm'
- defaults:
time_range:
start: '8am'
end: '4pm'
How to Tell What An Event Means
===============================
In the events that this beacon fires, a type of ``7`` denotes a login, while a
type of ``8`` denotes a logout. These values correspond to the ``ut_type``
value from a wtmp/utmp event (see the ``wtmp`` manpage for more information).
In the extremely unlikely case that your platform uses different values, they
can be overridden using a ``ut_type`` key in the beacon configuration:
.. code-block:: yaml
beacons:
wtmp:
- ut_type:
login: 9
logout: 10
This beacon's events include an ``action`` key which will be either ``login``
or ``logout`` depending on the event type.
.. versionchanged:: 2019.2.0
``action`` key added to beacon event, and ``ut_type`` config parameter
added.
Use Case: Posting Login/Logout Events to Slack
==============================================
This can be done using the following reactor SLS:
.. code-block:: jinja
report-wtmp:
runner.salt.cmd:
- args:
- fun: slack.post_message
- channel: mychannel # Slack channel
- from_name: someuser # Slack user
- message: "{{ data.get('action', 'Unknown event') | capitalize }} from `{{ data.get('user', '') or 'unknown user' }}` on `{{ data['id'] }}`"
Match the event like so in the master config file:
.. code-block:: yaml
reactor:
- 'salt/beacon/*/wtmp/':
- salt://reactor/wtmp.sls
.. note::
This approach uses the :py:mod:`slack execution module
<salt.modules.slack_notify>` directly on the master, and therefore requires
that the master has a slack API key in its configuration:
.. code-block:: yaml
slack:
api_key: xoxb-XXXXXXXXXXXX-XXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXX
See the :py:mod:`slack execution module <salt.modules.slack_notify>`
documentation for more information. While you can use an individual user's
API key to post to Slack, a bot user is likely better suited for this. The
:py:mod:`slack engine <salt.engines.slack>` documentation has information
on how to set up a bot user.
i ( t absolute_importt unicode_literalsN( t six( t mapu wtmpu
/var/log/wtmpt hi32s4s32s256shhiii4i20xu typeu PIDu lineu inittabu useru hostnameu exit_statusu sessionu timeu addru wtmp.locu wtmp.tty.i i c C@ s t j j t � r t St S( N( t ost patht isfilet WTMPt __virtualname__t False( ( ( s5 /usr/lib/python2.7/site-packages/salt/beacons/wtmp.pyt __virtual__� s c @ sc � s | | f St � t � s. t } d } n t � f d � d D� � sY t } d } n | | f S( u
Check time range
u> The time_range parameter for wtmp beacon must be a dictionary.c 3@ s | ] } | � k Vq d S( N( ( t .0t k( t trange( s5 /usr/lib/python2.7/site-packages/salt/beacons/wtmp.pys <genexpr>� s u startu enduJ The time_range parameter for wtmp beacon must contain start & end options.( u startu end( t
isinstancet dictR
t all( R t statust msg( ( R s5 /usr/lib/python2.7/site-packages/salt/beacons/wtmp.pyt _validate_time_range� s
c C@ s` t d | � } | s* t j d | � d Sx/ | d D]# } | | k r5 | | | | <q5 q5 Wd S( u
Gather group members
u
group.infou" Group %s does not exist, ignoring.Nu members( t __salt__t logt warning( t groupt groupst userst _groupt member( ( s5 /usr/lib/python2.7/site-packages/salt/beacons/wtmp.pyt _gather_group_members� s c C@ sa t rL t j | d � } t j | d � } t | | k oF | k n � St j d � t Sd S( u
Check time range
u startu endu Dateutil is required.N( t _TIME_SUPPORTEDt dateutil_parsert parset boolR t errorR
( t
time_ranget nowt _startt _end( ( s5 /usr/lib/python2.7/site-packages/salt/beacons/wtmp.pyt _check_time_range� s
c C@ s t t k r t t Sd S( u)
return the active file location
N( t LOC_KEYt __context__( ( ( s5 /usr/lib/python2.7/site-packages/salt/beacons/wtmp.pyt _get_loc� s c C@ s� t } d } t | t � s* t } d } n�i } t t | j | � � d | k r� t | d t � st t } d } nG xD | d D]8 } | d | j d i � } t | | | � \ } } q W| s� | | f Sn d | k rVt | d t � s� t } d } nG xD | d D]8 } | d | j d i � } t | | | � \ } } qW| sV| | f Sn d | k r�t | d t � s�t } d } n. | d j d i � } t | | | � \ } } | s�| | f Sn | | f S(
u+
Validate the beacon configuration
u Valid beacon configurationu- Configuration for wtmp beacon must be a list.u usersu8 User configuration for wtmp beacon must be a dictionary.u
time_rangeu groupsu9 Group configuration for wtmp beacon must be a dictionary.u defaultsu< Defaults configuration for wtmp beacon must be a dictionary.( t TrueR t listR
R t updateR t getR ( t configt vstatust vmsgt _configt usert _time_rangeR ( ( s5 /usr/lib/python2.7/site-packages/salt/beacons/wtmp.pyt validate� sP
c
C@ s� g } i } i } d } t } t } x� | D]� } d | k rJ | d } n d | k rc | d } n d | k r| | d } n | d k r+ y | d d } Wn t k
r� n Xy | d d } Wq� t k
r� q� Xq+ q+ Wt j j j t d � ��} t j
t d � } | d k r8| j d d � | j
� t t <| S| j | � x�t r�t j j � }
| j t � } t | � t k r�| S| j
� t t <t j t | � } i }
x� t t � D]} \ } } | | |
| <t |
| t j � r�t |
| t � rt j j j |
| � |
| <n |
| j d
� |
| <q�q�W|
d | k rsd |
d <|
d
t d j t! |
d � <nX |
d | k r�d |
d <y' t j" d j t! |
d � � |
d
<Wq�t k
r�q�Xn x | D] } t# | | | � q�W| r�|
d
| k r�| |
d
} t | t$ � rQd | k rQt% | d |
� r�| j& |
� q�q�| r�d | k r�t% | d |
� r�| j& |
� q�q�| j& |
� q�qH| r�d | k r�t% | d |
� r�| j& |
� q�qH| j& |
� qHWWd QX| S( uF
Read the last wtmp file and return information on the logins
u usersu groupsu defaultsu ut_typeu loginu logoutu rbi i u u typeu actionu useru {0}{1}u lineu
time_rangeN(' t Nonet
LOGIN_TYPEt LOGOUT_TYPEt KeyErrort saltt utilst filest fopenR R) R. R( t seekt tellR+ t datetimeR$ t readt SIZEt lent structt unpackt FMTt enumeratet FIELDSR R t string_typest bytest stringutilst
to_unicodet stript formatt TTY_KEY_PREFIXt popR R R' t append( R/ t retR R t defaultst
login_typet logout_typet config_itemt fp_t locR$ t rawt packt eventt indt fieldR t _user( ( s5 /usr/lib/python2.7/site-packages/salt/beacons/wtmp.pyt beacon& s�
!
'
(* t __doc__t
__future__R R R@ t loggingR RD t salt.utils.stringutilsR: t salt.utils.filest salt.extR t salt.ext.six.movesR R R RF RH t calcsizeRB R( RO R7 R8 t getLoggert __name__R t dateutil.parsert parserR R+ R t ImportErrorR
R R R R' R* R5 R_ ( ( ( s5 /usr/lib/python2.7/site-packages/salt/beacons/wtmp.pyt <module>v sP
<
Mini Shell