mirror of https://github.com/fail2ban/fail2ban
272 lines
8.3 KiB
Python
272 lines
8.3 KiB
Python
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: t -*-
|
|
# vi: set ft=python sts=4 ts=4 sw=4 noet :
|
|
|
|
# This file is part of Fail2Ban.
|
|
#
|
|
# Fail2Ban is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Fail2Ban is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Fail2Ban; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
__author__ = "Cyril Jaquier and Fail2Ban Contributors"
|
|
__copyright__ = "Copyright (c) 2004 Cyril Jaquier"
|
|
__license__ = "GPL"
|
|
|
|
import time
|
|
|
|
from threading import Lock
|
|
|
|
from .datetemplate import DatePatternRegex, DateTai64n, DateEpoch
|
|
from ..helpers import getLogger
|
|
|
|
# Gets the instance of the logger.
|
|
logSys = getLogger(__name__)
|
|
|
|
logLevel = 6
|
|
|
|
|
|
class DateDetectorCache(object):
|
|
def __init__(self):
|
|
self.__lock = Lock()
|
|
self.__templates = list()
|
|
|
|
@property
|
|
def templates(self):
|
|
"""List of template instances managed by the detector.
|
|
"""
|
|
with self.__lock:
|
|
if self.__templates:
|
|
return self.__templates
|
|
self._addDefaultTemplate()
|
|
return self.__templates
|
|
|
|
def _cacheTemplate(self, template):
|
|
"""Cache Fail2Ban's default template.
|
|
"""
|
|
if isinstance(template, str):
|
|
template = DatePatternRegex(template)
|
|
self.__templates.append(template)
|
|
|
|
def _addDefaultTemplate(self):
|
|
"""Add resp. cache Fail2Ban's default set of date templates.
|
|
"""
|
|
# asctime with optional day, subsecond and/or year:
|
|
# Sun Jan 23 21:59:59.011 2005
|
|
self._cacheTemplate("(?:%a )?%b %d %H:%M:%S(?:\.%f)?(?: %Y)?")
|
|
# asctime with optional day, subsecond and/or year coming after day
|
|
# http://bugs.debian.org/798923
|
|
# Sun Jan 23 2005 21:59:59.011
|
|
self._cacheTemplate("(?:%a )?%b %d %Y %H:%M:%S(?:\.%f)?")
|
|
# simple date, optional subsecond (proftpd):
|
|
# 2005-01-23 21:59:59
|
|
# simple date: 2005/01/23 21:59:59
|
|
# custom for syslog-ng 2006.12.21 06:43:20
|
|
self._cacheTemplate("%Y(?P<_sep>[-/.])%m(?P=_sep)%d %H:%M:%S(?:,%f)?")
|
|
# simple date too (from x11vnc): 23/01/2005 21:59:59
|
|
# and with optional year given by 2 digits: 23/01/05 21:59:59
|
|
# (See http://bugs.debian.org/537610)
|
|
# 17-07-2008 17:23:25
|
|
self._cacheTemplate("%d(?P<_sep>[-/])%m(?P=_sep)(?:%Y|%y) %H:%M:%S")
|
|
# Apache format optional time zone:
|
|
# [31/Oct/2006:09:22:55 -0000]
|
|
# 26-Jul-2007 15:20:52
|
|
self._cacheTemplate("%d(?P<_sep>[-/])%b(?P=_sep)%Y[ :]?%H:%M:%S(?:\.%f)?(?: %z)?")
|
|
# CPanel 05/20/2008:01:57:39
|
|
self._cacheTemplate("%m/%d/%Y:%H:%M:%S")
|
|
# named 26-Jul-2007 15:20:52.252
|
|
# roundcube 26-Jul-2007 15:20:52 +0200
|
|
# 01-27-2012 16:22:44.252
|
|
# subseconds explicit to avoid possible %m<->%d confusion
|
|
# with previous
|
|
self._cacheTemplate("%m-%d-%Y %H:%M:%S\.%f")
|
|
# TAI64N
|
|
template = DateTai64n()
|
|
template.name = "TAI64N"
|
|
self._cacheTemplate(template)
|
|
# Epoch
|
|
template = DateEpoch()
|
|
template.name = "Epoch"
|
|
self._cacheTemplate(template)
|
|
# ISO 8601
|
|
self._cacheTemplate("%Y-%m-%d[T ]%H:%M:%S(?:\.%f)?(?:%z)?")
|
|
# Only time information in the log
|
|
self._cacheTemplate("^%H:%M:%S")
|
|
# <09/16/08@05:03:30>
|
|
self._cacheTemplate("^<%m/%d/%y@%H:%M:%S>")
|
|
# MySQL: 130322 11:46:11
|
|
self._cacheTemplate("^%y%m%d ?%H:%M:%S")
|
|
# Apache Tomcat
|
|
self._cacheTemplate("%b %d, %Y %I:%M:%S %p")
|
|
# ASSP: Apr-27-13 02:33:06
|
|
self._cacheTemplate("^%b-%d-%y %H:%M:%S")
|
|
|
|
|
|
class DateDetector(object):
|
|
"""Manages one or more date templates to find a date within a log line.
|
|
|
|
Attributes
|
|
----------
|
|
templates
|
|
"""
|
|
_defCache = DateDetectorCache()
|
|
|
|
def __init__(self):
|
|
self.__lock = Lock()
|
|
self.__templates = list()
|
|
self.__known_names = set()
|
|
# time the template was long unused (currently 300 == 5m):
|
|
self.__unusedTime = 300
|
|
|
|
def _appendTemplate(self, template):
|
|
name = template.name
|
|
if name in self.__known_names:
|
|
raise ValueError(
|
|
"There is already a template with name %s" % name)
|
|
self.__known_names.add(name)
|
|
self.__templates.append(template)
|
|
|
|
def appendTemplate(self, template):
|
|
"""Add a date template to manage and use in search of dates.
|
|
|
|
Parameters
|
|
----------
|
|
template : DateTemplate or str
|
|
Can be either a `DateTemplate` instance, or a string which will
|
|
be used as the pattern for the `DatePatternRegex` template. The
|
|
template will then be added to the detector.
|
|
|
|
Raises
|
|
------
|
|
ValueError
|
|
If a template already exists with the same name.
|
|
"""
|
|
if isinstance(template, str):
|
|
template = DatePatternRegex(template)
|
|
self._appendTemplate(template)
|
|
|
|
def addDefaultTemplate(self):
|
|
"""Add Fail2Ban's default set of date templates.
|
|
"""
|
|
with self.__lock:
|
|
for template in DateDetector._defCache.templates:
|
|
self._appendTemplate(template)
|
|
|
|
@property
|
|
def templates(self):
|
|
"""List of template instances managed by the detector.
|
|
"""
|
|
return self.__templates
|
|
|
|
def matchTime(self, line):
|
|
"""Attempts to find date on a log line using templates.
|
|
|
|
This uses the templates' `matchDate` method in an attempt to find
|
|
a date. It also increments the match hit count for the winning
|
|
template.
|
|
|
|
Parameters
|
|
----------
|
|
line : str
|
|
Line which is searched by the date templates.
|
|
|
|
Returns
|
|
-------
|
|
re.MatchObject, DateTemplate
|
|
The regex match returned from the first successfully matched
|
|
template.
|
|
"""
|
|
i = 0
|
|
with self.__lock:
|
|
for template in self.__templates:
|
|
match = template.matchDate(line)
|
|
if not match is None:
|
|
if logSys.getEffectiveLevel() <= logLevel:
|
|
logSys.log(logLevel, "Matched time template %s", template.name)
|
|
template.hits += 1
|
|
template.lastUsed = time.time()
|
|
# if not first - try to reorder current template (bubble up), they will be not sorted anymore:
|
|
if i:
|
|
self._reorderTemplate(i)
|
|
# return tuple with match and template reference used for parsing:
|
|
return (match, template)
|
|
i += 1
|
|
# not found:
|
|
return (None, None)
|
|
|
|
def getTime(self, line, timeMatch=None):
|
|
"""Attempts to return the date on a log line using templates.
|
|
|
|
This uses the templates' `getDate` method in an attempt to find
|
|
a date.
|
|
For the faster usage, always specify a parameter timeMatch (the previous tuple result
|
|
of the matchTime), then this will work without locking and without cycle over templates.
|
|
|
|
Parameters
|
|
----------
|
|
line : str
|
|
Line which is searched by the date templates.
|
|
|
|
Returns
|
|
-------
|
|
float
|
|
The Unix timestamp returned from the first successfully matched
|
|
template or None if not found.
|
|
"""
|
|
if timeMatch:
|
|
template = timeMatch[1]
|
|
if template is not None:
|
|
date = template.getDate(line, timeMatch[0])
|
|
if date is not None:
|
|
if logSys.getEffectiveLevel() <= logLevel:
|
|
logSys.log(logLevel, "Got time %f for \"%r\" using template %s",
|
|
date[0], date[1].group(), template.name)
|
|
return date
|
|
with self.__lock:
|
|
for template in self.__templates:
|
|
try:
|
|
date = template.getDate(line)
|
|
if date is None:
|
|
continue
|
|
if logSys.getEffectiveLevel() <= logLevel:
|
|
logSys.log(logLevel, "Got time %f for \"%r\" using template %s",
|
|
date[0], date[1].group(), template.name)
|
|
return date
|
|
except ValueError: # pragma: no cover
|
|
pass
|
|
return None
|
|
|
|
def _reorderTemplate(self, num):
|
|
"""Reorder template (bubble up) in template list if hits grows enough.
|
|
|
|
Parameters
|
|
----------
|
|
num : int
|
|
Index of template should be moved.
|
|
"""
|
|
if num:
|
|
templates = self.__templates
|
|
template = templates[num]
|
|
## current hits and time the template was long unused:
|
|
untime = template.lastUsed - self.__unusedTime
|
|
hits = template.hits
|
|
## don't move too often (multiline logs resp. log's with different date patterns),
|
|
## if template not used too long, replace it also :
|
|
if hits > templates[num-1].hits + 5 or templates[num-1].lastUsed < untime:
|
|
## try to move faster (half of part to current template):
|
|
pos = num // 2
|
|
## if not larger - move slow (exact 1 position):
|
|
if hits <= templates[pos].hits or templates[pos].lastUsed < untime:
|
|
pos = num-1
|
|
templates[pos], templates[num] = template, templates[pos]
|
|
|
|
|