utils/cron_banip.py

   1 #!/usr/bin/python
   2 #
   3 # Search 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 # The list can then be used in apache using rewrite rules to
   9 # direct bulk users to smaller thread pools or block them. A
  10 # typical apache config that uses php-fpm pools would look
  11 # like this:
  12 #
  13 #    Alias /nominatim-www/ "/var/www/nominatim/"
  14 #    Alias /nominatim-bulk/ "/var/www/nominatim/"
  15 #    <Directory "/var/www/nominatim/">
  16 #        Options MultiViews FollowSymLinks
  17 #        AddType text/html   .php
  18 #    </Directory>
  19 #
  20 #    <Location /nominatim-www>
  21 #        AddHandler fcgi:/var/run/php5-fpm-www.sock .php
  22 #    </Location>
  23 #    <Location /nominatim-bulk>
  24 #        AddHandler fcgi:/var/run/php5-fpm-bulk.sock .php
  25 #    </Location>
  26 #
  27 #    Redirect 509 /nominatim-block/
  28 #    ErrorDocument 509 "Bandwidth limit exceeded."
  29 #    Redirect 403 /nominatim-ban/
  30 #    ErrorDocument 403 "Access blocked."
  31 #
  32 #    RewriteEngine On
  33 #    RewriteMap bulklist txt:/home/wherever/ip-block.map
  34 #    RewriteRule ^/(.*) /nominatim-${bulklist:%{REMOTE_ADDR}|www}/$1 [PT]
  35 #
  36
  37 import os
  38 import psycopg2
  39 import datetime
  40
  41 BASEDIR = os.path.normpath(os.path.join(os.path.realpath(__file__), '../..'))
  42
  43 #
  44 # DEFAULT SETTINGS
  45 #
  46 # Copy into settings/ip_blcoks.conf and adapt as required.
  47 #
  48 BLOCKEDFILE= BASEDIR + '/settings/ip_blocks.map'
  49 LOGFILE= BASEDIR + '/log/restricted_ip.log'
  50
  51 # space-separated list of IPs that are never banned
  52 WHITELIST = ''
  53 # space-separated list of IPs manually blocked
  54 BLACKLIST = ''
  55
  56 # time before a automatically blocked IP is allowed back
  57 BLOCKCOOLOFF_PERIOD='1 hour'
  58 # quiet time before an IP is released from the bulk pool
  59 BULKCOOLOFF_PERIOD='15 min'
  60
  61 BULKLONG_LIMIT=8000
  62 BULKSHORT_LIMIT=2000
  63 BLOCK_UPPER=19000
  64 BLOCK_LOWER=4000
  65 BLOCK_LOADFAC=380
  66 BULK_LOADFAC=160
  67 BULK_LOWER=1500
  68
  69 #
  70 # END OF DEFAULT SETTINGS
  71 #
  72
  73 try:
  74     execfile(os.path.expanduser(BASEDIR + "/settings/ip_blocks.conf"))
  75 except IOError:
  76     pass
  77
  78 # read the previous blocklist
  79 WHITELIST = set(WHITELIST.split()) if WHITELIST else set()
  80 prevblocks = []
  81 prevbulks = []
  82 BLACKLIST = set(BLACKLIST.split()) if BLACKLIST else set()
  83 newblocks = set()
  84 newbulks = set()
  85
  86 try:
  87     fd = open(BLOCKEDFILE)
  88     for line in fd:
  89         ip, typ = line.strip().split(' ')
  90         if ip not in BLACKLIST:
  91             if typ == 'block':
  92                 prevblocks.append(ip)
  93             elif typ == 'bulk':
  94                 prevbulks.append(ip)
  95     fd.close()
  96 except IOError:
  97     pass #ignore non-existing file
  98
  99 # determine current load
 100 fd = open("/proc/loadavg")
 101 avgload = int(float(fd.readline().split()[2]))
 102 fd.close()
 103 # DB load
 104 conn = psycopg2.connect('dbname=nominatim')
 105 cur = conn.cursor()
 106 cur.execute("select count(*)/60 from new_query_log where starttime > now() - interval '1min'")
 107 dbload = int(cur.fetchone()[0])
 108
 109 BLOCK_LIMIT = max(BLOCK_LOWER, BLOCK_UPPER - BLOCK_LOADFAC * (dbload - 70))
 110 BULKLONG_LIMIT = max(BULK_LOWER, BULKLONG_LIMIT - BULK_LOADFAC * (avgload - 14))
 111
 112 # get the new block candidates
 113 cur.execute("""
 114   SELECT ipaddress, max(count) FROM
 115    ((SELECT * FROM
 116      (SELECT ipaddress, sum(case when endtime is null then 1 else 1+date_part('epoch',endtime-starttime) end) as count FROM new_query_log
 117       WHERE starttime > now() - interval '1 hour' GROUP BY ipaddress) as i
 118    WHERE count > %s)
 119    UNION
 120    (SELECT ipaddress, count * 4 FROM
 121      (SELECT ipaddress, sum(case when endtime is null then 1 else 1+date_part('epoch',endtime-starttime) end) as count FROM new_query_log
 122       WHERE starttime > now() - interval '10 min' GROUP BY ipaddress) as i
 123    WHERE count > %s)) as o
 124   GROUP BY ipaddress
 125 """, (BULKLONG_LIMIT, BULKSHORT_LIMIT))
 126
 127 bulkips = {}
 128 emergencyblocks = []
 129
 130 for c in cur:
 131     if c[0] not in WHITELIST and c[0] not in BLACKLIST:
 132         if c[1] > BLOCK_UPPER and c[0] not in prevbulks:
 133             newblocks.add(c[0])
 134             if c[0] not in prevblocks:
 135                 emergencyblocks.append(c[0])
 136         else:
 137             bulkips[c[0]] = c[1]
 138
 139 # IPs from the block list that are no longer in the bulk list
 140 deblockcandidates = set()
 141 # IPs from the bulk list that are no longer in the bulk list
 142 debulkcandidates = set()
 143 # new IPs to go into the block list
 144 newlyblocked = []
 145
 146
 147 for ip in prevblocks:
 148     if ip in bulkips:
 149         newblocks.add(ip)
 150         del bulkips[ip]
 151     else:
 152         deblockcandidates.add(ip)
 153
 154 for ip in prevbulks:
 155     if ip in bulkips:
 156         if bulkips[ip] > BLOCK_LIMIT:
 157             newblocks.add(ip)
 158             newlyblocked.append(ip)
 159         else:
 160             newbulks.add(ip)
 161         del bulkips[ip]
 162     else:
 163         debulkcandidates.add(ip)
 164
 165 # cross-check deblock candidates
 166 if deblockcandidates:
 167     cur.execute("""
 168         SELECT DISTINCT ipaddress FROM new_query_log
 169         WHERE ipaddress IN ('%s') AND starttime > now() - interval '%s'
 170         """ % ("','".join(deblockcandidates), BLOCKCOOLOFF_PERIOD))
 171
 172     for c in cur:
 173         newblocks.add(c[0])
 174         deblockcandidates.remove(c[0])
 175 # deblocked IPs go back to the bulk pool to catch the ones that simply
 176 # ignored the HTTP error and just continue to hammer the API.
 177 # Those that behave and stopped will be debulked a minute later.
 178 for ip in deblockcandidates:
 179     newbulks.add(ip)
 180
 181 # cross-check debulk candidates
 182 if debulkcandidates:
 183     cur.execute("""
 184         SELECT DISTINCT ipaddress FROM new_query_log
 185         WHERE ipaddress IN ('%s') AND starttime > now() - interval '%s'
 186         AND starttime > date_trunc('day', now())
 187         """ % ("','".join(debulkcandidates), BULKCOOLOFF_PERIOD))
 188
 189     for c in cur:
 190         newbulks.add(c[0])
 191         debulkcandidates.remove(c[0])
 192
 193 for ip in bulkips.iterkeys():
 194     newbulks.add(ip)
 195
 196 # write out the new list
 197 fd = open(BLOCKEDFILE, 'w')
 198 for ip in newblocks:
 199     fd.write(ip + " block\n")
 200 for ip in newbulks:
 201     fd.write(ip + " bulk\n")
 202 for ip in BLACKLIST:
 203     fd.write(ip + " ban\n")
 204 fd.close()
 205
 206 # write out the log
 207 logstr = datetime.datetime.now().strftime('%Y-%m-%d %H:%M') + ' %s %s\n'
 208 fd = open(LOGFILE, 'a')
 209 if deblockcandidates:
 210     fd.write(logstr % ('unblocked:', ', '.join(deblockcandidates)))
 211 if debulkcandidates:
 212     fd.write(logstr % (' debulked:', ', '.join(debulkcandidates)))
 213 if bulkips:
 214     fd.write(logstr % ('new bulks:', ', '.join(bulkips.keys())))
 215 if emergencyblocks:
 216     fd.write(logstr % ('dir.block:', ', '.join(emergencyblocks)))
 217 if newlyblocked:
 218     fd.write(logstr % ('new block:', ', '.join(newlyblocked)))
 219 fd.close()