utils/cron_ipanalyse.py

   1 #!/usr/bin/python3
   2 #
   3 # Search apache logs for high-bandwith users and create a list of suspicious IPs.
   4 # There are three states: bulk, block, ban. The first are bulk requesters
   5 # that need throtteling, the second bulk requesters that have overdone it
   6 # and the last manually banned IPs.
   7 #
   8
   9 import re
  10 import os
  11 import sys
  12 import subprocess
  13 from datetime import datetime, timedelta
  14 from collections import defaultdict
  15
  16 #
  17 # DEFAULT SETTINGS
  18 #
  19 # Copy into settings/ip_blcoks.conf and adapt as required.
  20 #
  21 BASEDIR = os.path.normpath(os.path.join(os.path.realpath(__file__), '../..'))
  22 BLOCKEDFILE= BASEDIR + '/settings/ip_blocks.map'
  23 LOGFILE= BASEDIR + '/log/restricted_ip.log'
  24
  25 # space-separated list of IPs that are never banned
  26 WHITELIST = ''
  27 # space-separated list of IPs manually blocked
  28 BLACKLIST = ''
  29 # user-agents that should be blocked from bulk mode
  30 # (matched with startswith)
  31 UA_BLOCKLIST = ()
  32
  33 # time before a automatically blocked IP is allowed back
  34 BLOCKCOOLOFF_DELTA=timedelta(hours=1)
  35 # quiet time before an IP is released from the bulk pool
  36 BULKCOOLOFF_DELTA=timedelta(minutes=15)
  37
  38 BULKLONG_LIMIT=8000
  39 BULKSHORT_LIMIT=2000
  40 BLOCK_UPPER=19000
  41 BLOCK_LOWER=4000
  42 BLOCK_LOADFAC=380
  43 BULK_LOADFAC=160
  44 BULK_LOWER=1500
  45 MAX_BULK_IPS=85
  46
  47 #
  48 # END OF DEFAULT SETTINGS
  49 #
  50
  51 try:
  52     with open(BASEDIR + "/settings/ip_blocks.conf") as f:
  53         code = compile(f.read(), BASEDIR + "/settings/ip_blocks.conf", 'exec')
  54         exec(code)
  55 except IOError:
  56     pass
  57
  58 BLOCK_LIMIT = BLOCK_LOWER
  59
  60 time_regex = r'(?P<t_day>\d\d)/(?P<t_month>[A-Za-z]+)/(?P<t_year>\d\d\d\d):(?P<t_hour>\d\d):(?P<t_min>\d\d):(?P<t_sec>\d\d) [+-]\d\d\d\d'
  61
  62 format_pat= re.compile(r'(?P<ip>[a-f\d\.:]+) - - \['+ time_regex + r'] "(?P<query>.*?)" (?P<return>\d+) (?P<bytes>\d+) "(?P<referer>.*?)" "(?P<ua>.*?)"')
  63 time_pat= re.compile(r'[a-f\d:\.]+ - - \[' + time_regex + '\] ')
  64
  65 logtime_pat = "%d/%b/%Y:%H:%M:%S %z"
  66
  67 MONTHS = { 'Jan' : 1, 'Feb' : 2, 'Mar' : 3, 'Apr' : 4, 'May' : 5, 'Jun' : 6,
  68            'Jul' : 7, 'Aug' : 8, 'Sep' : 9, 'Oct' : 10, 'Nov' : 11, 'Dec' : 12 }
  69
  70 class LogEntry:
  71     def __init__(self, logline):
  72         e = format_pat.match(logline)
  73         if e is None:
  74             raise ValueError("Invalid log line:", logline)
  75         e = e.groupdict()
  76         self.ip = e['ip']
  77         self.date = datetime(int(e['t_year']), MONTHS[e['t_month']], int(e['t_day']),
  78                              int(e['t_hour']), int(e['t_min']), int(e['t_sec']))
  79         qp = e['query'].split(' ', 2)
  80         if len(qp) < 2:
  81             self.request = None
  82             self.query = None
  83         else:
  84             self.query = qp[1]
  85             if qp[0] == 'OPTIONS':
  86                 self.request = None
  87             else:
  88                 if '/?' in qp[1]:
  89                     self.request = 'S'
  90                 elif '/search' in qp[1]:
  91                     self.request = 'S'
  92                 elif '/reverse' in qp[1]:
  93                     self.request = 'R'
  94                 elif '/details' in qp[1]:
  95                     self.request = 'D'
  96                 elif '/lookup' in qp[1]:
  97                     self.request = 'L'
  98                 else:
  99                     self.request = None
 100         self.query = e['query']
 101         self.retcode = int(e['return'])
 102         self.referer = e['referer'] if e['referer'] != '-' else None
 103         self.ua = e['ua'] if e['ua'] != '-' else None
 104
 105     def get_log_time(logline):
 106         e = format_pat.match(logline)
 107         if e is None:
 108             return None
 109         e = e.groupdict()
 110         #return datetime.strptime(e['time'], logtime_pat).replace(tzinfo=None)
 111         return datetime(int(e['t_year']), MONTHS[e['t_month']], int(e['t_day']),
 112                              int(e['t_hour']), int(e['t_min']), int(e['t_sec']))
 113
 114
 115 class LogFile:
 116     """ An apache log file, unpacked. """
 117
 118     def __init__(self, filename):
 119         self.fd = open(filename)
 120         self.len = os.path.getsize(filename)
 121
 122     def __del__(self):
 123         self.fd.close()
 124
 125     def seek_next(self, abstime):
 126         self.fd.seek(abstime)
 127         self.fd.readline()
 128         l = self.fd.readline()
 129         return LogEntry.get_log_time(l) if l is not None else None
 130
 131     def seek_to_date(self, target):
 132         # start position for binary search
 133         fromseek = 0
 134         fromdate = self.seek_next(0)
 135         if fromdate > target:
 136             return True
 137         # end position for binary search
 138         toseek = -100
 139         while -toseek < self.len:
 140             todate = self.seek_next(self.len + toseek)
 141             if todate is not None:
 142                 break
 143             toseek -= 100
 144         if todate is None or todate < target:
 145             return False
 146         toseek = self.len + toseek
 147
 148
 149         while True:
 150             bps = (toseek - fromseek) / (todate - fromdate).total_seconds()
 151             newseek = fromseek + int((target - fromdate).total_seconds() * bps)
 152             newdate = self.seek_next(newseek)
 153             if newdate is None:
 154                 return False;
 155             error = abs((target - newdate).total_seconds())
 156             if error < 1:
 157                 return True
 158             if newdate > target:
 159                 toseek = newseek
 160                 todate = newdate
 161                 oldfromseek = fromseek
 162                 fromseek = toseek - error * bps
 163                 while True:
 164                     if fromseek <= oldfromseek:
 165                         fromseek = oldfromseek
 166                         fromdate = self.seek_next(fromseek)
 167                         break
 168                     fromdate = self.seek_next(fromseek)
 169                     if fromdate < target:
 170                         break;
 171                     bps *=2
 172                     fromseek -= error * bps
 173             else:
 174                 fromseek = newseek
 175                 fromdate = newdate
 176                 oldtoseek = toseek
 177                 toseek = fromseek + error * bps
 178                 while True:
 179                     if toseek > oldtoseek:
 180                         toseek = oldtoseek
 181                         todate = self.seek_next(toseek)
 182                         break
 183                     todate = self.seek_next(toseek)
 184                     if todate > target:
 185                         break
 186                     bps *=2
 187                     toseek += error * bps
 188             if toseek - fromseek < 500:
 189                 return True
 190
 191
 192     def loglines(self):
 193         for l in self.fd:
 194             try:
 195                 yield LogEntry(l)
 196             except ValueError:
 197                 pass # ignore invalid lines
 198
 199 class BlockList:
 200
 201     def __init__(self):
 202         self.whitelist = set(WHITELIST.split()) if WHITELIST else set()
 203         self.blacklist = set(BLACKLIST.split()) if BLACKLIST else set()
 204         self.prevblocks = set()
 205         self.prevbulks = set()
 206
 207         try:
 208             fd = open(BLOCKEDFILE)
 209             for line in fd:
 210                 ip, typ = line.strip().split(' ')
 211                 if ip not in self.blacklist:
 212                     if typ == 'block':
 213                         self.prevblocks.add(ip)
 214                     elif typ == 'bulk':
 215                         self.prevbulks.add(ip)
 216             fd.close()
 217         except IOError:
 218             pass #ignore non-existing file
 219
 220
 221 class IPstats:
 222
 223     def __init__(self):
 224         self.short_total = 0
 225         self.short_api = 0
 226         self.long_total = 0
 227         self.long_api = 0
 228         self.bad_ua = False
 229
 230     def add_long(self, logentry):
 231         self.long_total += 1
 232         if logentry.request is not None:
 233             self.long_api += 1
 234         if not self.bad_ua:
 235             if logentry.ua is None:
 236                 self.bad_ua = True
 237
 238     def add_short(self, logentry):
 239         self.short_total += 1
 240         if logentry.request is not None:
 241             self.short_api += 1
 242         self.add_long(logentry)
 243
 244     def new_state(self, was_blocked, was_bulked):
 245         if was_blocked:
 246             # deblock only if the IP has been really quiet
 247             # (properly catches the ones that simply ignore the HTTP error)
 248             return None if self.long_total < 20 else 'block'
 249         if self.long_api > BLOCK_UPPER or self.short_api > BLOCK_UPPER / 3:
 250                 # client totally overdoing it
 251                 return 'block'
 252         if was_bulked:
 253             if self.short_total < 20:
 254                 # client has stopped, debulk
 255                 return None
 256             if self.long_api > BLOCK_LIMIT or self.short_api > BLOCK_LIMIT / 3:
 257                 # client is still hammering us, block
 258                 return 'emblock'
 259             return 'bulk'
 260
 261         if self.long_api > BULKLONG_LIMIT or self.short_api > BULKSHORT_LIMIT:
 262             #if self.bad_ua:
 263             #    return 'uablock' # bad useragent
 264             return 'bulk'
 265
 266         return None
 267
 268
 269
 270 if __name__ == '__main__':
 271     if len(sys.argv) < 2:
 272         print("Usage: %s logfile startdate" % sys.argv[0])
 273         sys.exit(-1)
 274
 275     if len(sys.argv) == 2:
 276         dt = datetime.now() - BLOCKCOOLOFF_DELTA
 277     else:
 278         dt = datetime.strptime(sys.argv[2], "%Y-%m-%d %H:%M:%S")
 279
 280     if os.path.getsize(sys.argv[1]) < 2*1030*1024:
 281         sys.exit(0) # not enough data
 282
 283     lf = LogFile(sys.argv[1])
 284     if not lf.seek_to_date(dt):
 285         sys.exit(0)
 286
 287     bl = BlockList()
 288
 289     shortstart = dt + BLOCKCOOLOFF_DELTA - BULKCOOLOFF_DELTA
 290     notlogged = bl.whitelist | bl.blacklist
 291
 292     stats = defaultdict(IPstats)
 293
 294     for l in lf.loglines():
 295         if l.ip not in notlogged:
 296             stats[l.ip].add_long(l)
 297         if l.date > shortstart:
 298             break
 299
 300     total200 = 0
 301     for l in lf.loglines():
 302         if l.ip not in notlogged:
 303             stats[l.ip].add_short(l)
 304         if l.request is not None and l.retcode == 200:
 305             total200 += 1
 306
 307     # adapt limits according to CPU and DB load
 308     fd = open("/proc/loadavg")
 309     cpuload = int(float(fd.readline().split()[2]))
 310     fd.close()
 311     # check the number of excess connections to apache
 312     dbcons = int(subprocess.check_output("netstat -s | grep 'connections established' | sed 's:^\s*::;s: .*::'", shell=True))
 313     fpms = int(subprocess.check_output('ps -Af | grep php-fpm | wc -l', shell=True))
 314     dbload = max(0, dbcons - fpms)
 315
 316     numbulks = len(bl.prevbulks)
 317     BLOCK_LIMIT = max(BLOCK_LIMIT, BLOCK_UPPER - BLOCK_LOADFAC * dbload)
 318     BULKLONG_LIMIT = max(BULK_LOWER, BULKLONG_LIMIT - BULK_LOADFAC * cpuload)
 319     if numbulks > MAX_BULK_IPS:
 320         BLOCK_LIMIT = max(3600, BLOCK_LOWER - (numbulks - MAX_BULK_IPS)*10)
 321     # if the bulk pool is still empty, clients will be faster, avoid having
 322     # them blocked in this case
 323     if numbulks < 10:
 324         BLOCK_UPPER *= 2
 325         BLOCK_LIMIT = BLOCK_UPPER
 326
 327
 328     # collecting statistics
 329     unblocked = []
 330     debulked = []
 331     bulked = []
 332     blocked = []
 333     uablocked = []
 334     emblocked = []
 335     # write out new state file
 336     fd = open(BLOCKEDFILE, 'w')
 337     for k,v in stats.items():
 338         wasblocked = k in bl.prevblocks
 339         wasbulked = k in bl.prevbulks
 340         state = v.new_state(wasblocked, wasbulked)
 341         if state is not None:
 342             if state == 'uablock':
 343                 uablocked.append(k)
 344                 state = 'block'
 345             elif state == 'emblock':
 346                 emblocked.append(k)
 347                 state = 'block'
 348             elif state == 'block':
 349                 if not wasblocked:
 350                     blocked.append(k)
 351             elif state == 'bulk':
 352                 if not wasbulked:
 353                     bulked.append(k)
 354             fd.write("%s %s\n" % (k, state))
 355         else:
 356             if wasblocked:
 357                 unblocked.append(k)
 358             elif wasbulked:
 359                 debulked.append(k)
 360     for i in bl.blacklist:
 361         fd.write("%s ban\n" % i)
 362     fd.close()
 363
 364     # TODO write logs (need to collect some statistics)
 365     logstr = datetime.now().strftime('%Y-%m-%d %H:%M') + ' %s %s\n'
 366     fd = open(LOGFILE, 'a')
 367     if unblocked:
 368         fd.write(logstr % ('unblocked:', ', '.join(unblocked)))
 369     if debulked:
 370         fd.write(logstr % (' debulked:', ', '.join(debulked)))
 371     if bulked:
 372         fd.write(logstr % ('new bulks:', ', '.join(bulked)))
 373     if emblocked:
 374         fd.write(logstr % ('dir.block:', ', '.join(emblocked)))
 375     if uablocked:
 376         fd.write(logstr % (' ua block:', ', '.join(uablocked)))
 377     if blocked:
 378         fd.write(logstr % ('new block:', ', '.join(blocked)))
 379     fd.close()