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 '/search' in qp[1]:
  89                     self.request = 'S'
  90                 elif '/reverse' in qp[1]:
  91                     self.request = 'R'
  92                 elif '/details' in qp[1]:
  93                     self.request = 'D'
  94                 else:
  95                     self.request = None
  96         self.query = e['query']
  97         self.retcode = int(e['return'])
  98         self.referer = e['referer'] if e['referer'] != '-' else None
  99         self.ua = e['ua'] if e['ua'] != '-' else None
 100
 101     def get_log_time(logline):
 102         e = format_pat.match(logline)
 103         if e is None:
 104             return None
 105         e = e.groupdict()
 106         #return datetime.strptime(e['time'], logtime_pat).replace(tzinfo=None)
 107         return datetime(int(e['t_year']), MONTHS[e['t_month']], int(e['t_day']),
 108                              int(e['t_hour']), int(e['t_min']), int(e['t_sec']))
 109
 110
 111 class LogFile:
 112     """ An apache log file, unpacked. """
 113
 114     def __init__(self, filename):
 115         self.fd = open(filename)
 116         self.len = os.path.getsize(filename)
 117
 118     def __del__(self):
 119         self.fd.close()
 120
 121     def seek_next(self, abstime):
 122         self.fd.seek(abstime)
 123         self.fd.readline()
 124         l = self.fd.readline()
 125         return LogEntry.get_log_time(l) if l is not None else None
 126
 127     def seek_to_date(self, target):
 128         # start position for binary search
 129         fromseek = 0
 130         fromdate = self.seek_next(0)
 131         if fromdate > target:
 132             return True
 133         # end position for binary search
 134         toseek = -100
 135         while -toseek < self.len:
 136             todate = self.seek_next(self.len + toseek)
 137             if todate is not None:
 138                 break
 139             toseek -= 100
 140         if todate is None or todate < target:
 141             return False
 142         toseek = self.len + toseek
 143
 144
 145         while True:
 146             bps = (toseek - fromseek) / (todate - fromdate).total_seconds()
 147             newseek = fromseek + int((target - fromdate).total_seconds() * bps)
 148             newdate = self.seek_next(newseek)
 149             if newdate is None:
 150                 return False;
 151             error = abs((target - newdate).total_seconds())
 152             if error < 1:
 153                 return True
 154             if newdate > target:
 155                 toseek = newseek
 156                 todate = newdate
 157                 oldfromseek = fromseek
 158                 fromseek = toseek - error * bps
 159                 while True:
 160                     if fromseek <= oldfromseek:
 161                         fromseek = oldfromseek
 162                         fromdate = self.seek_next(fromseek)
 163                         break
 164                     fromdate = self.seek_next(fromseek)
 165                     if fromdate < target:
 166                         break;
 167                     bps *=2
 168                     fromseek -= error * bps
 169             else:
 170                 fromseek = newseek
 171                 fromdate = newdate
 172                 oldtoseek = toseek
 173                 toseek = fromseek + error * bps
 174                 while True:
 175                     if toseek > oldtoseek:
 176                         toseek = oldtoseek
 177                         todate = self.seek_next(toseek)
 178                         break
 179                     todate = self.seek_next(toseek)
 180                     if todate > target:
 181                         break
 182                     bps *=2
 183                     toseek += error * bps
 184             if toseek - fromseek < 500:
 185                 return True
 186
 187
 188     def loglines(self):
 189         for l in self.fd:
 190             try:
 191                 yield LogEntry(l)
 192             except ValueError:
 193                 pass # ignore invalid lines
 194
 195 class BlockList:
 196
 197     def __init__(self):
 198         self.whitelist = set(WHITELIST.split()) if WHITELIST else set()
 199         self.blacklist = set(BLACKLIST.split()) if BLACKLIST else set()
 200         self.prevblocks = set()
 201         self.prevbulks = set()
 202
 203         try:
 204             fd = open(BLOCKEDFILE)
 205             for line in fd:
 206                 ip, typ = line.strip().split(' ')
 207                 if ip not in self.blacklist:
 208                     if typ == 'block':
 209                         self.prevblocks.add(ip)
 210                     elif typ == 'bulk':
 211                         self.prevbulks.add(ip)
 212             fd.close()
 213         except IOError:
 214             pass #ignore non-existing file
 215
 216
 217 class IPstats:
 218
 219     def __init__(self):
 220         self.short_total = 0
 221         self.short_api = 0
 222         self.long_total = 0
 223         self.long_api = 0
 224         self.bad_ua = False
 225
 226     def add_long(self, logentry):
 227         self.long_total += 1
 228         if logentry.request is not None:
 229             self.long_api += 1
 230         if not self.bad_ua:
 231             if logentry.ua is None:
 232                 self.bad_ua = True
 233
 234     def add_short(self, logentry):
 235         self.short_total += 1
 236         if logentry.request is not None:
 237             self.short_api += 1
 238         self.add_long(logentry)
 239
 240     def new_state(self, was_blocked, was_bulked):
 241         if was_blocked:
 242             # deblock only if the IP has been really quiet
 243             # (properly catches the ones that simply ignore the HTTP error)
 244             return None if self.long_total < 5 else 'block'
 245         if self.long_api > BLOCK_UPPER or self.short_api > BLOCK_UPPER / 3:
 246                 # client totally overdoing it
 247                 return 'block'
 248         if was_bulked:
 249             if self.short_total < 5:
 250                 # client has stopped, debulk
 251                 return None
 252             if self.long_api > BLOCK_LIMIT or self.short_api > BLOCK_LIMIT / 3:
 253                 # client is still hammering us, block
 254                 return 'emblock'
 255             return 'bulk'
 256
 257         if self.long_api > BULKLONG_LIMIT or self.short_api > BULKSHORT_LIMIT:
 258             if self.bad_ua:
 259                 return 'uablock' # bad useragent
 260             return 'bulk'
 261
 262         return None
 263
 264
 265
 266 if __name__ == '__main__':
 267     if len(sys.argv) < 2:
 268         print("Usage: %s logfile startdate" % sys.argv[0])
 269         sys.exit(-1)
 270
 271     if len(sys.argv) == 2:
 272         dt = datetime.now() - BLOCKCOOLOFF_DELTA
 273     else:
 274         dt = datetime.strptime(sys.argv[2], "%Y-%m-%d %H:%M:%S")
 275
 276     if os.path.getsize(sys.argv[1]) < 2*1030*1024:
 277         sys.exit(0) # not enough data
 278
 279     lf = LogFile(sys.argv[1])
 280     if not lf.seek_to_date(dt):
 281         sys.exit(0)
 282
 283     bl = BlockList()
 284
 285     shortstart = dt + BLOCKCOOLOFF_DELTA - BULKCOOLOFF_DELTA
 286     notlogged = bl.whitelist | bl.blacklist
 287
 288     stats = defaultdict(IPstats)
 289
 290     for l in lf.loglines():
 291         if l.ip not in notlogged:
 292             stats[l.ip].add_long(l)
 293         if l.date > shortstart:
 294             break
 295
 296     total200 = 0
 297     for l in lf.loglines():
 298         if l.ip not in notlogged:
 299             stats[l.ip].add_short(l)
 300         if l.request is not None and l.retcode == 200:
 301             total200 += 1
 302
 303     # adapt limits according to CPU and DB load
 304     fd = open("/proc/loadavg")
 305     cpuload = int(float(fd.readline().split()[2]))
 306     fd.close()
 307     # check the number of excess connections to apache
 308     dbcons = int(subprocess.check_output("netstat -s | grep 'connections established' | sed 's:^\s*::;s: .*::'", shell=True))
 309     fpms = int(subprocess.check_output('ps -Af | grep php-fpm | wc -l', shell=True))
 310     dbload = max(0, dbcons - fpms)
 311
 312     numbulks = len(bl.prevbulks)
 313     BLOCK_LIMIT = max(BLOCK_LIMIT, BLOCK_UPPER - BLOCK_LOADFAC * dbload)
 314     BULKLONG_LIMIT = max(BULK_LOWER, BULKLONG_LIMIT - BULK_LOADFAC * cpuload)
 315     if numbulks > MAX_BULK_IPS:
 316         BLOCK_LIMIT = max(3600, BLOCK_LOWER - (numbulks - MAX_BULK_IPS)*10)
 317     # if the bulk pool is still empty, clients will be faster, avoid having
 318     # them blocked in this case
 319     if numbulks < 10:
 320         BLOCK_LIMIT = 2*BLOCK_UPPER
 321
 322
 323     # collecting statistics
 324     unblocked = []
 325     debulked = []
 326     bulked = []
 327     blocked = []
 328     uablocked = []
 329     emblocked = []
 330     # write out new state file
 331     fd = open(BLOCKEDFILE, 'w')
 332     for k,v in stats.items():
 333         wasblocked = k in bl.prevblocks
 334         wasbulked = k in bl.prevbulks
 335         state = v.new_state(wasblocked, wasbulked)
 336         if state is not None:
 337             if state == 'uablock':
 338                 uablocked.append(k)
 339                 state = 'block'
 340             elif state == 'emblock':
 341                 emblocked.append(k)
 342                 state = 'block'
 343             elif state == 'block':
 344                 if not wasblocked:
 345                     blocked.append(k)
 346             elif state == 'bulk':
 347                 if not wasbulked:
 348                     bulked.append(k)
 349             fd.write("%s %s\n" % (k, state))
 350         else:
 351             if wasblocked:
 352                 unblocked.append(k)
 353             elif wasbulked:
 354                 debulked.append(k)
 355     for i in bl.blacklist:
 356         fd.write("%s ban\n" % i)
 357     fd.close()
 358
 359     # TODO write logs (need to collect some statistics)
 360     logstr = datetime.now().strftime('%Y-%m-%d %H:%M') + ' %s %s\n'
 361     fd = open(LOGFILE, 'a')
 362     if unblocked:
 363         fd.write(logstr % ('unblocked:', ', '.join(unblocked)))
 364     if debulked:
 365         fd.write(logstr % (' debulked:', ', '.join(debulked)))
 366     if bulked:
 367         fd.write(logstr % ('new bulks:', ', '.join(bulked)))
 368     if emblocked:
 369         fd.write(logstr % ('dir.block:', ', '.join(emblocked)))
 370     if uablocked:
 371         fd.write(logstr % (' ua block:', ', '.join(uablocked)))
 372     if blocked:
 373         fd.write(logstr % ('new block:', ', '.join(blocked)))
 374     fd.close()