a
=*fa @ s d Z dZdZddlZddlZddlZddlZzddlmZ W n e yZ ddl
mZ Y n0 ddl
m Z ddl m
Z
mZ dd lmZ dd
lmZ dd lmZmZmZ dd lmZ dd
lmZ ddlm Z ddl m Z e e Z G dd deeZ!dS )z
Cyril Jaquierz Copyright (c) 2004 Cyril JaquierZGPL N)Mapping) OrderedDict )
BanManager BanTicket)IPAddr)
JailThread)
ActionBase
CommandAction
CallingMap)MyTime) Observers)Utils ) getLoggerc @ s e Zd ZdZdd Zedd Zd?dd Zd@d d Zd
d Z dd Z
dd Z dd Z dd Z
dd Zdd Zdd Zd d ZdAd d Zd!d" ZdBd#d$ZdCd%d&Zd'd( ZG d)d* d*eZd+d, ZdDd.d/ZdEd0d1ZdFd2d3Z d4d5 Z dGd6d7Z dHd8d9Z dId:d;Z dJd=d>Z!dS )KActionsa Handles jail actions.
This class handles the actions of the jail. Creation, deletion or to
actions must be done through this class. This class is based on the
Mapping type, and the `add` method must be used to add new actions.
This class also starts and stops the actions, and fetches bans from
the jail executing these bans via the actions.
Parameters
----------
jail: Jail
The jail of which the actions belongs to.
Attributes
----------
daemon
ident
name
status
active : bool
Control the state of the thread.
idle : bool
Control the idle state of the thread.
sleeptime : int
The time the thread sleeps for in the loop.
c C sL t j| d|j d || _t | _t | _d| _d| _ d| _
| j
d | _ d S )Nzf2b/a.)namer
r ) r __init__r _jailr _actionsr
banManagerbanEpoch _Actions__lastConsistencyCheckTM
banPrecedence
unbanMaxCount)selfjail r ;/usr/lib/python3.9/site-packages/fail2ban/server/actions.pyr N s zActions.__init__c C sF t | }t|ds"td| n t|jtsBtd| |jjf |S )NActionz&%s module does not have 'Action' classz0%s module %s does not implement required methods)r Zload_python_modulehasattr RuntimeError
issubclassr r __name__) pythonModulemodr r r _load_python_module\ s
zActions._load_python_moduleNFc C s || j v rN|std| | j | }t|drNt|drJ| || j|< dS |du rdt| j|}n | |}|j| j|fi |}|| j |< dS )a Adds a new action.
Add a new action if not already present, defaulting to standard
`CommandAction`, or specified Python module.
Parameters
----------
name : str
The name of the action.
pythonModule : str, optional
Path to Python file which must contain `Action` class.
Default None, which means `CommandAction` is used.
initOpts : dict, optional
Options for Python Action, used as keyword arguments for
initialisation. Default None.
Raises
------
ValueError
If action name already exists.
RuntimeError
If external Python module does not have `Action` class
or does not implement necessary methods as per `ActionBase`
abstract class.
zAction %s already existsreloadclearAllParamsN) r
ValueErrorr! r) _reload_actionsr
r r' r )r r r% initOptsr( actionZcustomActionModuler r r addi s
z Actions.addTc s |rt _nt dr j D ]0\}}| jv r" j| jf i |rJ|ni q"t fdd j D }t|r jd|dd j |d t
d dS ) z@ Begin or end of reloading resp. refreshing of all parameters
r+ c 3 s$ | ] \}}| j vr||fV qd S N)r+ .0r r- r r r s
z!Actions.reload..FT)dbactionsstopr5 N) dictr+ r! itemsr r( r len_Actions__flushBan stopActionsdelattr)r Zbeginr r, Zdelactsr r2 r r( s
zActions.reloadc C s0 z | j | W S ty* td| Y n0 d S NzInvalid Action name: %sr KeyErrorr r r r r __getitem__ s zActions.__getitem__c C s0 z | j |= W n ty* td| Y n0 d S r> r? rA r r r __delitem__ s zActions.__delitem__c C s
t | jS r/ )iterr r2 r r r __iter__ s zActions.__iter__c C s
t | jS r/ )r: r r2 r r r __len__ s zActions.__len__c C s dS NFr )r otherr r r __eq__ s zActions.__eq__c C s t | S r/ )idr2 r r r __hash__ s zActions.__hash__c C s( t |}| j| td| d S )Nz
banTime: %s)r Z str2secondsr
setBanTimelogSysinfo)r valuer r r rL s
zActions.setBanTimec C s
| j S r/ )r
getBanTimer2 r r r rP s zActions.getBanTimec sD | j |s S t|dkr2|d v r.dS dS fdd|D S )Nr r c s g | ]}| v rd ndqS )r r r r1 iplstr r
z%Actions.getBanned..)r
getBanListr: )r Zidsr rS r getBanned s
zActions.getBannedc C s | j jd|dS )zkReturns the list of banned IP addresses.
Returns
-------
list
The list of banned IP addresses.
T)ZorderedwithTime)r rW )r rY r r r rW s zActions.getBanListc s< t t|tr& fdd|D }n t| f}| |S )zBan an IP or list of IPs.c 3 s | ]}t | V qd S r/ )r rQ ZunixTimer r r3 rV z&Actions.addBannedIP..)r time
isinstancelistr _Actions__checkBan)r rR ticketsr rZ r addBannedIP s
zActions.addBannedIPc C s2 |du r| |S t|ttfr~g }d}|D ]<}z|| |||7 }W q, tyf |sb|| Y q,0 q,|rztd| |S |r| jjdur| jj | j| | j
|}|dur| | nnt|t
st
|}|jstt|j| j
} | r| | ||S d| }
ttj|
|r&dS t|
dS )aO Removes banned IP calling actions' unban method
Remove a banned IP now, rather than waiting for it to expire,
even if set to never expire.
Parameters
----------
ip : list, str, IPAddr or None
The IP address (or multiple IPs as list) to unban or all IPs if None
Raises
------
ValueError
If `ip` is not banned
Nr znot banned: %rz%s is not bannedr )r; r\ r] tupleremoveBannedIPr* appendr databasedelBanr Z
getTicketByID_Actions__unBanr ZisSinglefiltercontainsrW rM logloggingZMSG) r rR r4 ZifexistsZmissedcntiticketZipaipsmsgr r r rb s>
zActions.removeBannedIPc C s |du r| j }tt| D ]v\}}z | W nF tyx } z.tjd| jj ||t
t j kd W Y d}~n
d}~0 0 | j |= t
d| jj | q dS )z>Stops the actions in reverse sequence (optionally filtered)
Nz(Failed to stop jail '%s' action '%s': %sexc_infoz%s: action %s terminated)r reversedr] r9 r6 ExceptionrM errorr r getEffectiveLevelrj DEBUGdebug)r r5 r r- er r r r< / s
zActions.stopActionsc s d} j D ]\\}}z | W q tyh } z.tjd jj||t t j
kd W Y d}~qd}~0 0 q j rƐz j rt
d t fdddd j t
d W qld}t j jjt }td
d | j t fd d|r }||7 }|r| jkrz j rv|d
9 }td
d|rF| jk rF|n j| j |rn| jk rn|n j d}W ql ty } z,tjd jj|t t j
kd W Y d}~qld}~0 0 ql jdd dS )zMain loop for Threading.
This function is the main loop of the thread. It checks the jail
queue and executes commands when an IP address is banned.
Returns
-------
bool
True when the thread exits nicely.
r z)Failed to start jail '%s' action '%s': %srp NzActions: enter idle modec s j p j S r/ )activeidler r2 r r V rV z Actions.run..c S s dS rG r r r r r r{ W rV zActions: leave idle mode z1Actions: wait for pending tickets %s (default %s)c s j p jjS r/ )ry r ZhasFailTicketsr r2 r r r{ ^ rV r z+Actions: check-unban %s, bancnt %s, max: %sz*[%s] unhandled error in actions thread: %sT)r6 ) r r9 startrs rM rt r r ru rj rv ry rz rw r wait_forZ sleeptimeminr Z_nextUnbanTimer r[ ri r^ r r _Actions__checkUnBanr; r< )r rk r r- rx ZbancntZwtr r2 r run? sL
," z Actions.runc @ s e Zd ZdZdd dd dd dd dd dd d d d
d d d d d d
d d%dddd dd dd dd dd dd dd dd dd dZejd Zddefd d Zd d Zd d! Z d&d#d$Z
dS )'zActions.ActionInfo)fid
raw-ticketc C s
| j S r/ )_ActionInfo__ticketZgetIPr2 r r r r{ w rV zActions.ActionInfo.c C s
| d j S NrR )Z familyStrr2 r r r r{ x rV c C s | d dS )NrR )ZgetPTRr2 r r r r{ y rV c C s | d S r )ZgetHostr2 r r r r{ z rV c C s
| j S r/ )r getIDr2 r r r r{ { rV c C s
| j S r/ )r
getAttemptr2 r r r r{ | rV c C s
| j S r/ )r getTimer2 r r r r{ } rV c C s | S r/ ) _getBanTimer2 r r r r{ ~ rV c C s
| j S r/ )r Z getBanCountr2 r r r r{ rV c C s d | j S N
)joinr
getMatchesr2 r r r r{ rV c C s | j jr dS dS )Nr r )r restoredr2 r r r r{ rV Nc C s | j |S r/ )r ZgetData)r tagr r r r{ rV c C s d | d S )Nr Tr _mi4ipr r2 r r r r{ rV c C s d | S r r r2 r r r r{ rV c C s | d S )NTr r r2 r r r r{ rV c C s | S r/ r r2 r r r r{ rV c C s
t | jS r/ )reprr r2 r r r r{ rV c C s | j jj S r/ )_ActionInfo__jailr5 r sizer2 r r r r{ rV c C s | j jj S r/ )r r5 r getBanTotalr2 r r r r{ rV c C s | j jj S r/ )r rg failManagerr r2 r r r r{ rV c C s | j jj S r/ )r rg r Z getFailTotalr2 r r r r{ rV )rR Zfamilyzip-revzip-hostr Zfailuresr[ ZbantimeZbancountmatchesr zF-*Z ipmatchesZ
ipjailmatchesZ
ipfailuresZipjailfailuresr z jail.bannedzjail.banned_totalz
jail.foundzjail.found_total)Z__ticketZ__jail__mi4ipTc C s$ || _ || _t | _|| _|| _d S r/ )r r r8 Zstorage immutabledata)r rm r r r r r r r s
zActions.ActionInfo.__init__c C s | | j| j| j| j S r/ ) __class__r r r r copyr2 r r r r s zActions.ActionInfo.copyc C s& | j }|d u r | jj }t|S r/ )r rP r r5 int)r btimer r r r s
z Actions.ActionInfo._getBanTimeFc
C s t | dsi | _| j}|r dnd}||v rD|| dur>|| S | jS zT| j}| d }d||< |jsj| jW S |r|jj|d||< n|jj||d||< W nD ty } z,tjd||j |t
t j kd W Y d}~n
d}~0 0 || dur|| S | jS )
a Gets bans merged once, a helper for lambda(s), prevents stop of executing action by any exception inside.
This function never returns None for ainfo lambdas - always a ticket (merged or single one)
and prevents any errors through merging (to guarantee ban actions will be executed).
[TODO] move merging to observer - here we could wait for merge and read already merged info from a database
Parameters
----------
overalljails : bool
switch to get a merged bans :
False - (default) bans merged for current jail only
True - bans merged for all jails of current ip address
Returns
-------
BanTicket
merged or self ticket only
r allr NrR )rR )rR r z+Failed to get %s bans merged, jail '%s': %srp )
r! Z_ActionInfo__mi4ipr r rd Z
getBansMergedrs rM rt r ru rj rv )r Z overalljailsmiidxr rR rx r r r r s,
zActions.ActionInfo._mi4ip)N)F) r$
__module__ __qualname__Z
CM_REPR_ITEMSZAI_DICTr __slots__r r r r r r r r
ActionInfor s8
r c C s$ |st dt }t|| j}|S )Nr )r r r[ r r r )r rm aInfor r r _getActionInfo s zActions._getActionInfod c c s0 d}||k r,| j }|s q,|V |d7 }qdS )zAGenerator to get maximal count failure tickets from fail-manager.r r N)r Z
getFailTicket)r countrk rm r r r Z__getFailTickets s
zActions.__getFailTicketsc
s d}|s| | j}d}|D ]n}t| || j } }| }i }| jj |drX|d7 }t j
dur j st j
d | j
| td| j
j j sdnd| | j D ]\} }
z2 j rt|
d d
rW q|js| |
| W q ty< } z0tjd | j
j| || t tjkd W Y d} ~ qd} ~ 0 0 qd
_ | j r| j _ q | ddrzt d| j
j| q | d j r~| } | dk rtjn| dk rtj!ntj"}
t#|
d| j
j| j | j kr:| dkr:|s:t$% | j&d kr:t$% | _&| j' D ]}
t(|
dr |
) q j | j k r|sjt* fdd| j D }|| j+ |d7 }q || + 7 }q |rt,d|| j- | j. | j
j |S )a Check for IP address to ban.
If tickets are not specified look in the jail queue for FailTicket. If a ticket is available,
it executes the "ban" command and adds a ticket to the BanManager.
Returns
-------
bool
True if an IP address get banned.
r N)reasonr ZbanFoundz
[%s] %sBan %sr zRestore
norestoredF9Failed to execute ban jail '%s' action '%s' info '%r': %srp TZexpiredz [%s] Ignore %s, expired bantimerm < z[%s] %s already bannedconsistencyCheckc 3 s& | ] \}}|j j kr||fV qd S r/ )r r0 ZbTicketr r r3 ' s z%Actions.__checkBan..r7 z"Banned %s / %s, %s ticket(s) in %r)/_Actions__getFailTicketsr r wraprP r r r Z addBanTicketr
ZMainr r. r rM noticer r r9 getattrr resetZbanrs rt ru rj rv bannedr getrN r ZNOTICEZWARNINGri r r[ r valuesr! r r8 _Actions__reBanrw r r )r r_ rk Z rebanactsrm r rR r r r r- rx ZdiftmZllr r r Z
__checkBan st
zActions.__checkBanc C s |p| j }| }| |}|rTtd| jj|t|dkrNdt| d nd |
D ]\}}z0t d| jj|| |j s|
|| W q\ ty } z4tjd| jj|||t tjkd W Y d }~ dS d }~0 0 q\d
|_| j r| j|_dS ) zRepeat bans for the ticket.
Executes the actions in order to reban the host given in the
ticket.
Parameters
----------
ticket : Ticket
Ticket to reban
z[%s] Reban %s%sr z , action %rr r z[%s] action %r: reban %sz;Failed to execute reban jail '%s' action '%s' info '%r': %srp NT)r r r rM r r r r: r] keysr9 rw r r Zrebanrs rt ru rj rv r r ) r rm r5 ri rR r r r- rx r r r Z__reBan4 s*
4 zActions.__reBanc C s | j |sd S d }| j D ]\}}zN|jr>t|ddr>W q |jsHW q |d u rZ| |}|jsh| |
| W q t y } z0t j
d| jj|||t tjkd W Y d }~q d }~0 0 q d S )Nr Fr rp )r Z
_inBanListr r9 r r Z _prolongabler r r Zprolongrs rM rt r r ru rj rv )r rm r r r- rx r r r _prolongBanV s$
zActions._prolongBanc C sP | j t |}|D ]}| | qt|}|rLtd|| j | j j
|S )zKCheck for IP address to unban.
Unban IP addresses which are outdated.
z Unbanned %s, %s ticket(s) in %r) r Z unBanListr r[ rf r: rM rw r r r )r ZmaxCountrT rm rk r r r Z __checkUnBanm s zActions.__checkUnBanc s d}|du r"t d | j }nd}t| j}d}i }|durD|n| j D ]\} z._beforeRepairz! Unban tickets each individuallyz Flush jail in database)r5 ri r z! Unbanned %s, %s ticket(s) in %r)rM rw r Z flushBanListrD r r9 r! r\ r
Z actionflushr r r r rs rt ru rj rv rN r rd re rf r ) r r4 r5 r6 ri rT rk
unbactionsr rx r rm r r r Z
__flushBan{ sJ
"
zActions.__flushBanc
C s |du r| j }n|}| }| |}|r s*