o
;s*br @ s d Z dZdZddlZddlZddlZddlZddlZddlZddl m
Z
ddl m Z ddl
mZ dd lmZ dd
lmZ d d lmZmZmZ eeZd
d Zejdkr\dd Zdd Z n dd Z dd Zdd Z e e e e de dd Z!G dd d e"Z#dS ) zSteven Hiscocksz"Copyright (c) 2013 Steven HiscocksGPL Nwraps)RLock )MyTime)
FailTicket)Utils ) getLogger
uni_string
PREFER_ENCc C s t | tr t| } t| S )z/Avoid errors on types unknown in json-adapters.)
isinstancesetlistr x r :/usr/lib/python3/dist-packages/fail2ban/server/database.py
_json_default* s
r ) c
C sb zt j| dtdtd} W | S ty0 } ztjd|t dkd d} W Y d }~| S d }~ww )NF ensure_asciidefaultreplacejson dumps failed: %r exc_info{}) jsondumpsr encoder
ExceptionlogSyserrorgetEffectiveLevelr er r r _json_dumps_safe1 s r) c
C \ z t | td} W | S ty- } ztjd|t dkd i } W Y d }~| S d }~ww Nr zjson loads failed: %rr r r loadsdecoder
r# r$ r% r& r' r r r _json_loads_safe; r/ c C sr t | trtdd | D S t | ttfr dd | D S t | tr,| tdtS t | tr7| tdS | S )Nc s s$ | ]
\}}t |t |fV qd S N
_normalize).0kvr r r F s " z _normalize..c S s g | ]}t |qS r r2 )r4 elementr r r
H s z _normalize..r ) r dictitemsr r strr" r
r. r r r r r3 D s
r3 c
C s^ z
t jt| dtd} W | S ty. } ztjd|t dkd d} W Y d }~| S d }~ww )NFr r r r r )r r! r3 r r# r$ r% r& r' r r r r) P s c
C r* r+ r, r' r r r r/ Y r0 JSONc s t fdd}|S )Nc s~ | j 2 | j | | j g|R i |W d W d S 1 s(w Y W d d S 1 s8w Y d S r1 )_lock_dbcursor)selfargskwargsfr r wrapperg s "z"commitandrollback..wrapperr )rE rF r rD r commitandrollbackf s rG c @ s e Zd ZdZdZdZeeZdMddZdNd d
Z d d Z
e d
d Z dd Z
e dd Ze dd Zejdd ZdNddZedNddZdd Zed d Zed d Zed d! Zed"d# ZedOd%d&Zed'd( ZdPd*d+ZedOd,d-Z ed.d/ Z d0d1 Z edPd2d3Z ed4d5 Z ed6d7 Z!ed8d9 Z"edQd:d;Z#dd?Z%edRd@dAZ&dRdBdCZ'e $ $dSdEdFZ(dGdH Z)dIdJ Z*edKdL Z+d$S )T
Fail2BanDba Fail2Ban database for storing persistent data.
This allows after Fail2Ban is restarted to reinstated bans and
to continue monitoring logs from the same point.
This will either create a new Fail2Ban database, connect to an
existing, and if applicable upgrade the schema in the process.
Parameters
----------
filename : str
File name for SQLite3 database, which will be created if
doesn't already exist.
purgeAge : int
Purge age in seconds, used to remove old bans from
database during purge.
Raises
------
sqlite3.OperationalError
Error connecting/creating a SQLite3 database.
RuntimeError
If exisiting database fails to update to new schema.
Attributes
----------
filename
purgeage
r ))
fail2banDbz7CREATE TABLE IF NOT EXISTS fail2banDb(version INTEGER);)jailszCREATE TABLE IF NOT EXISTS jails(name TEXT NOT NULL UNIQUE, enabled INTEGER NOT NULL DEFAULT 1);CREATE INDEX IF NOT EXISTS jails_name ON jails(name);)logsaS CREATE TABLE IF NOT EXISTS logs(jail TEXT NOT NULL, path TEXT, firstlinemd5 TEXT, lastfilepos INTEGER DEFAULT 0, FOREIGN KEY(jail) REFERENCES jails(name) ON DELETE CASCADE, UNIQUE(jail, path),UNIQUE(jail, path, firstlinemd5));CREATE INDEX IF NOT EXISTS logs_path ON logs(path);CREATE INDEX IF NOT EXISTS logs_jail_path ON logs(jail, path);)bansa CREATE TABLE IF NOT EXISTS bans(jail TEXT NOT NULL, ip TEXT, timeofban INTEGER NOT NULL, bantime INTEGER NOT NULL, bancount INTEGER NOT NULL default 1, data JSON, FOREIGN KEY(jail) REFERENCES jails(name) );CREATE INDEX IF NOT EXISTS bans_jail_timeofban_ip ON bans(jail, timeofban);CREATE INDEX IF NOT EXISTS bans_jail_ip ON bans(jail, ip);CREATE INDEX IF NOT EXISTS bans_ip ON bans(ip);)bipsaZ CREATE TABLE IF NOT EXISTS bips(ip TEXT NOT NULL, jail TEXT NOT NULL, timeofban INTEGER NOT NULL, bantime INTEGER NOT NULL, bancount INTEGER NOT NULL default 1, data JSON, PRIMARY KEY(ip, jail), FOREIGN KEY(jail) REFERENCES jails(name) );CREATE INDEX IF NOT EXISTS bips_timeofban ON bips(timeofban);CREATE INDEX IF NOT EXISTS bips_ip ON bips(ip);Q r c C s, d| _ t | _|| _|| _|| _| d S )N
)
maxMatchesr r> _dbFilename _purgeAge_outDatedFactor
_connectDB)rA filenamepurgeAgeoutDatedFactorr r r __init__ s zFail2BanDb.__init__Fc
C s | j }ztj|dtjd| _i | _td| W n tjy0 } z t d||j
d d }~ww zdd l }d}W n t yD d}Y nw | j
}zz |d |d |s]|d |d
|d W n? tjyz td | Y nX tjy } z!t d
||j
d tj|s | d }| W Y d }~n/d }~ww | d }|tjk r| |}|tjkrtd|| n
t dtj|| tdW |rt d | j |dd t d t d |d | D ] } t dd | q| j |r|r|d | d S d S |rMt d | j |dd t d t d |d | D ] } t dd | q;| j |r]|rX|d | w w )NF)check_same_thread detect_typesz.Connected to fail2ban persistent database '%s'z9Error connecting to fail2ban persistent database '%s': %sr TzPRAGMA foreign_keys = ONzPRAGMA synchronous = OFFz PRAGMA journal_mode = MEMORYzPRAGMA temp_store = MEMORY&SELECT version FROM fail2banDb LIMIT 1z"New database created. Version '%r'z3Error opening fail2ban persistent database '%s': %sz"Database updated from '%r' to '%r'zIDatabase update failed to achieve version '%r': updated from '%r' to '%r'zFailed to fully updatez# Create missing tables/indices ...) incrementalz -> okz Check integrity ...zPRAGMA integrity_checkz -> %s )!rQ sqlite3connectPARSE_DECLTYPESr? _bansMergedCacher$ infoOperationalErrorr% rB __pypy__ ImportErrorr@ executewarningcreateDbErrorospathisfilecloserepairDBfetchonerH __version__updateDb RuntimeErrordebug _createDbfetchalljoincommit)
rA checkIntegrityrU r( rd pypycurversion
newversionsr r r rT s
zFail2BanDb._connectDBc C s" t d | j t d d S )Nz Close connection to database ...z Connection to database closed.)r$ rs r? rm rb rA r r r rm s
zFail2BanDb.closec C s> z| j W S ty | jd tdt | _ | j Y S w )N.z
%Y%m%d-%H%M%S) _Fail2BanDb__dbBackupFilenameAttributeErrorrQ timestrftimer gmtimer~ r r r _dbBackupFilename s
z Fail2BanDb._dbBackupFilenamec
C s. G dd dt }| j}d | _zzBtd| j t| j| j td| j t d| j| jf t
| jj }|rFtd| | j
dd n
td | |d
W n5 t y } z)tjd | j|jd t|| omt d
kd t
| j | j
dd W Y d }~n d }~ww W || _d S W || _d S || _w )Nc @ s e Zd ZdS )z,Fail2BanDb.repairDB..RepairExceptionN)__name__
__module__ __qualname__r r r r RepairException( s r z Trying to repair database %s Database backup created: %szHf2b_db=$0; f2b_dbbk=$1; sqlite3 "$f2b_dbbk" ".dump" | sqlite3 "$f2b_db" z5 Repair seems to be successful, restored %d byte(s).T)rx z1 Repair seems to be failed, restored %d byte(s).z Recreate ...z/ Error repairing of fail2ban database '%s': %sr rO r )r# rn r$ rb rQ shutilmover r
executeCmdrj statst_sizerT r% rB r r& remove)rA r _repairDB
dbFileSizer( r r r rn ' s<
zFail2BanDb.repairDBc C | j S )z&File name of SQLite3 database file.
)rQ r~ r r r rU H zFail2BanDb.filenamec C r )zPurge age in seconds.
)rR r~ r r r purgeageN r zFail2BanDb.purgeagec C s t || _d S r1 )r str2secondsrR )rA valuer r r r T s c C s@ t jD ] \}}|| q|dt jf |d | d S )z8Creates a new database, called during initialisation.
z\INSERT INTO fail2banDb(version) SELECT ? WHERE NOT EXISTS (SELECT 1 FROM fail2banDb LIMIT 1)r[ r )rH _CREATE_SCRIPTS
executescriptrf rp ro )rA rz r\ nr} r r r rt X s
zFail2BanDb._createDbc C s | ||S r1 )rt )rA rz r\ r r r rh e s zFail2BanDb.createDbc C s& | d|f | }|d uo|d S )NzQselect 1 where exists (select 1 from sqlite_master WHERE type='table' AND name=?)r )rf ro )rA rz tableresr r r _tableExistsi s
zFail2BanDb._tableExistsc
C s2 |t jkr tdzqtd| j| tj| js(t
| j | j td| j |dk r<| |dr<|
dt jd |dk rP| |drP|
d t jd |d
k ro| |d so|
d t jd | |dro|d
|d | d W S ty } ztjd| j|jd t dkd d}~ww )zUpdate an existing database, called during initialisation.
A timestamped backup is also created prior to attempting the update.
zIAttempt to travel to future version of database ...how did you get here??z&Upgrade database: %s from version '%r'r r
rK zBEGIN TRANSACTION;CREATE TEMPORARY TABLE logs_temp AS SELECT * FROM logs;DROP TABLE logs;%s;INSERT INTO logs SELECT * from logs_temp;DROP TABLE logs_temp;UPDATE fail2banDb SET version = 2;COMMIT;r rL zBEGIN TRANSACTION;CREATE TEMPORARY TABLE bans_temp AS SELECT jail, ip, timeofban, -2 as bantime, 1 as bancount, data FROM bans;DROP TABLE bans;%s;
INSERT INTO bans SELECT * from bans_temp;DROP TABLE bans_temp;COMMIT;r rM z?BEGIN TRANSACTION;%s;
UPDATE fail2banDb SET version = 4;COMMIT;zINSERT OR REPLACE INTO bips(ip, jail, timeofban, bantime, bancount, data) SELECT ip, jail, timeofban, bantime, bancount, data FROM bans order by timeofbanr[ r z#Failed to upgrade database '%s': %srO r N)rH rp NotImplementedErrorr$ rb r rj rk rl r copyfilerU r r _CREATE_TABSrf ro r# r% rQ rB r& )rA rz r{ r( r r r rq o sF
zFail2BanDb.updateDbc C s2 | d|jf |jdkr| d|jf dS dS )zmAdds a jail to the database.
Parameters
----------
jail : Jail
Jail to be added to the database.
z7INSERT OR IGNORE INTO jails(name, enabled) VALUES(?, 1)r z |du r
| d n
| dt|f tdd | D S )zGet name of jails in database.
Currently only used for testing purposes.
Returns
-------
set
Set of jail names.
NzSELECT name FROM jailsz'SELECT name FROM jails WHERE enabled=%sc s | ]}|d V qdS r Nr r4 rowr r r r7 z*Fail2BanDb.getJailNames..)rf intr fetchmany)rA rz enabledr r r getJailNames s zFail2BanDb.getJailNamesc C s | ||| | | S )a7 Adds a log to the database.
Parameters
----------
jail : Jail
Jail that log is being monitored by.
container : FileContainer
File container of the log file being added.
Returns
-------
int
If log was already present in database, value of last position
in the log file; else `None`
)_addLog getFileNamegetPosgetHashrA rz r containerr r r addLog s zFail2BanDb.addLogr c C sx d }| d|j|f z| \}}W n ty d }Y nw |s0|s%|r0| d|j|||f |d ur:||kr:d }|S )NzBSELECT firstlinemd5, lastfilepos FROM logs WHERE jail=? AND path=?UINSERT OR REPLACE INTO logs(jail, path, firstlinemd5, lastfilepos) VALUES(?, ?, ?, ?))rf r ro TypeError)rA rz r r posmd5 lastLinePos firstLineMD5r r r r s$ zFail2BanDb._addLogc C sF d}g }|dur|d7 }| |j ||| tdd | D S )zGets all the log paths from the database.
Currently only for testing purposes.
Parameters
----------
jail : Jail
If specified, will only reutrn logs belonging to the jail.
Returns
-------
set
Set of log paths.
zSELECT path FROM logsNz
WHERE jail=?c s r r r r r r r r7 r z)Fail2BanDb.getLogPaths..)appendr rf r r )rA rz r query queryArgsr r r getLogPaths s zFail2BanDb.getLogPathsc C s" | ||| | | dS )zUpdates hash and last position in log file.
Parameters
----------
jail : Jail
Jail of which the log file belongs to.
container : FileContainer
File container of the log file being updated.
N)
_updateLogr r r r r r r updateLog s " zFail2BanDb.updateLogc C s: | d|||j|f |js| d|j|||f d S d S )NzEUPDATE logs SET firstlinemd5=?, lastfilepos=? WHERE jail=? AND path=?r r )rA rz r r r r r r r r & s zFail2BanDb._updateLogc C s | |||||S )aA Get journal position from database.
Parameters
----------
jail : Jail
Jail of which the journal belongs to.
name, time, iso :
Journal name (typically systemd-journal) and last known time.
Returns
-------
int (or float)
Last position (as time) if it was already present in database; else `None`
)r rA rz r r r isor r r
getJournalPos0 s zFail2BanDb.getJournalPosc C s | ||||| dS )zUpdates last position (as time) of journal.
Parameters
----------
jail : Jail
Jail of which the journal belongs to.
name, time, iso :
Journal name (typically systemd-journal) and last known time.
N)r r r r r
updateJournalB s zFail2BanDb.updateJournalc
C s t | }z| j||f= W n ty Y nw z| j|df= W n ty) Y nw | }|d}| jrN|rMt|| jkrM| }|| j d |d< n |rW| }|d= | d|j
|t t |
||j | |f | d||j
t t |
||j | |f dS )zAdd a ban to the database.
Parameters
----------
jail : Jail
Jail in which the ban has occurred.
ticket : BanTicket
Ticket of the ban to be added.
NmatcheszWINSERT INTO bans(jail, ip, timeofban, bantime, bancount, data) VALUES(?, ?, ?, ?, ?, ?)zbINSERT OR REPLACE INTO bips(ip, jail, timeofban, bantime, bancount, data) VALUES(?, ?, ?, ?, ?, ?))r< getIPra KeyErrorgetDatagetrP lencopyrf r r roundgetTime
getBanTimeactions getBanCount)rA rz r ticketipdatar r r r addBanO sB
((zFail2BanDb.addBanc G s d}d}|j g}t|s||| ||| dS |d7 }|d7 }|d |D ]}t||d< ||| ||| q)dS )zDelete a single or multiple tickets from the database.
Parameters
----------
jail : Jail
Jail in which the ticket(s) should be removed.
args : list of IP
IPs to be removed, if not given all tickets of jail will be removed.
z DELETE FROM bips WHERE jail = ?z DELETE FROM bans WHERE jail = ?Nz AND ip = ? r )r r rf r r< )rA rz r rB query1query2r r r r r delBanv s
zFail2BanDb.delBanc C s d}g }|d ur|d7 }| |j |d ur'|dkr'|d7 }| t | |d ur6|d7 }| t| |d7 }t|||S )Nz,SELECT ip, timeofban, data FROM bans WHERE 1 AND jail=?r AND timeofban > ? AND ip=?z ORDER BY ip, timeofban desc)r r r r r< r rf )rA rz r bantimer r r r r r _getBans s zFail2BanDb._getBansc K sB g }| j di |D ]\}}}|t|| |d | q
|S )a Get bans from the database.
Parameters
----------
jail : Jail
Jail that the ban belongs to. Default `None`; all jails.
bantime : int
Ban time in seconds, such that bans returned would still be
valid now. Negative values are equivalent to `None`.
Default `None`; no limit.
ip : str
IP Address to filter bans by. Default `None`; all IPs.
Returns
-------
list
List of `Ticket`s for bans stored in database.
Nr )r r r setData)rA rC ticketsr timeofbanr r r r getBans s
zFail2BanDb.getBansc C s | j d}|du s|dk r#||f}|| jv r#| j| W d S g }d}t| j|||d}|r|d d }g } d}
i } |D ]]\} }
}| |krbt||| }||
|| | }g } d}
i } |dg }| jt | }|dkrt ||kr~|| } n || d | } |
|dd7 }
|
|d< | |d< |
| |
}qAt| || d}|| |r|du r|n|| j|< |du r|n|W d S 1 sw Y dS )a} Get bans from the database, merged into single ticket.
This is the same as `getBans`, but bans merged into single
ticket.
Parameters
----------
jail : Jail
Jail that the ban belongs to. Default `None`; all jails.
bantime : int
Ban time in seconds, such that bans returned would still be
valid now. Negative values are equivalent to `None`.
Default `None`; no limit.
ip : str
IP Address to filter bans by. Default `None`; all IPs.
Returns
-------
list or Ticket
Single ticket representing bans stored in database per IP
in a list. When `ip` argument passed, a single `Ticket` is
returned.
Nr )r r r r failuresr r ) r> ra r r r
setAttemptr r rP r update)rA r r r cacheKeyr r results
prev_banipr r tickdatabanipr r prev_timeofbanmmaxaddr r r
getBansMerged sR
$zFail2BanDb.getBansMergedc C s t |}|s d}nd}|d7 }|g}|s"|d ur"|d7 }||j |d ur3|d7 }|t | |d ur@|d7 }|| |sF|d u rJ|d7 }| j }t|||S )Nz-SELECT bancount, timeofban, bantime FROM bipsz