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_LOADFAC=300
  65
  66 #
  67 # END OF DEFAULT SETTINGS
  68 #
  69
  70 try:
  71     execfile(os.path.expanduser(BASEDIR + "/settings/ip_blocks.conf"))
  72 except IOError:
  73     pass
  74
  75 # determine current load
  76 fd = open("/proc/loadavg")
  77 avgload = int(float(fd.readline().split()[1]))
  78 fd.close()
  79
  80 BLOCK_LIMIT = BLOCK_UPPER - BLOCK_LOADFAC * avgload
  81
  82 # read the previous blocklist
  83 WHITELIST = set(WHITELIST.split()) if WHITELIST else set()
  84 prevblocks = []
  85 prevbulks = []
  86 BLACKLIST = set(BLACKLIST.split()) if BLACKLIST else set()
  87 newblocks = set()
  88 newbulks = set()
  89
  90 try:
  91     fd = open(BLOCKEDFILE)
  92     for line in fd:
  93         ip, typ = line.strip().split(' ')
  94         if ip not in BLACKLIST:
  95             if typ == 'block':
  96                 prevblocks.append(ip)
  97             elif typ == 'bulk':
  98                 prevbulks.append(ip)
  99     fd.close()
 100 except IOError:
 101     pass #ignore non-existing file
 102
 103 conn = psycopg2.connect('dbname=nominatim')
 104 cur = conn.cursor()
 105
 106 # get the new block candidates
 107 cur.execute("""
 108   SELECT ipaddress, max(count) FROM
 109    ((SELECT * FROM
 110      (SELECT ipaddress, sum(CASE WHEN type = 'search' THEN 3 ELSE 1 END) as count FROM new_query_log
 111       WHERE starttime > now() - interval '1 hour' GROUP BY ipaddress) as i
 112    WHERE count > %s)
 113    UNION
 114    (SELECT ipaddress, count * 4 FROM
 115      (SELECT ipaddress, sum(CASE WHEN type = 'search' THEN 2 ELSE 1 END) as count FROM new_query_log
 116       WHERE starttime > now() - interval '10 min' GROUP BY ipaddress) as i
 117    WHERE count > %s)) as o
 118   GROUP BY ipaddress
 119 """, (BULKLONG_LIMIT, BULKSHORT_LIMIT))
 120
 121 bulkips = {}
 122 emergencyblocks = []
 123
 124 for c in cur:
 125     if c[0] not in WHITELIST and c[0] not in BLACKLIST:
 126         if c[1] > BLOCK_UPPER and c[0] not in prevbulks:
 127             newblocks.add(c[0])
 128             if c[0] not in prevblocks:
 129                 emergencyblocks.append(c[0])
 130         else:
 131             bulkips[c[0]] = c[1]
 132
 133 # IPs from the block list that are no longer in the bulk list
 134 deblockcandidates = set()
 135 # IPs from the bulk list that are no longer in the bulk list
 136 debulkcandidates = set()
 137 # new IPs to go into the block list
 138 newlyblocked = []
 139
 140
 141 for ip in prevblocks:
 142     if ip in bulkips:
 143         newblocks.add(ip)
 144         del bulkips[ip]
 145     else:
 146         deblockcandidates.add(ip)
 147
 148 for ip in prevbulks:
 149     if ip in bulkips:
 150         if bulkips[ip] > BLOCK_LIMIT:
 151             newblocks.add(ip)
 152             newlyblocked.append(ip)
 153         else:
 154             newbulks.add(ip)
 155         del bulkips[ip]
 156     else:
 157         debulkcandidates.add(ip)
 158
 159 # cross-check deblock candidates
 160 if deblockcandidates:
 161     cur.execute("""
 162         SELECT DISTINCT ipaddress FROM new_query_log
 163         WHERE ipaddress IN ('%s') AND starttime > now() - interval '%s'
 164         """ % ("','".join(deblockcandidates), BLOCKCOOLOFF_PERIOD))
 165
 166     for c in cur:
 167         newblocks.add(c[0])
 168         deblockcandidates.remove(c[0])
 169 # deblocked IPs go back to the bulk pool to catch the ones that simply
 170 # ignored the HTTP error and just continue to hammer the API.
 171 # Those that behave and stopped will be debulked a minute later.
 172 for ip in deblockcandidates:
 173     newbulks.add(ip)
 174
 175 # cross-check debulk candidates
 176 if debulkcandidates:
 177     cur.execute("""
 178         SELECT DISTINCT ipaddress FROM new_query_log
 179         WHERE ipaddress IN ('%s') AND starttime > now() - interval '%s'
 180         """ % ("','".join(debulkcandidates), BULKCOOLOFF_PERIOD))
 181
 182     for c in cur:
 183         newbulks.add(c[0])
 184         debulkcandidates.remove(c[0])
 185
 186 for ip in bulkips.iterkeys():
 187     newbulks.add(ip)
 188
 189 # write out the new list
 190 fd = open(BLOCKEDFILE, 'w')
 191 for ip in newblocks:
 192     fd.write(ip + " block\n")
 193 for ip in newbulks:
 194     fd.write(ip + " bulk\n")
 195 for ip in BLACKLIST:
 196     fd.write(ip + " ban\n")
 197 fd.close()
 198
 199 # write out the log
 200 logstr = datetime.datetime.now().strftime('%Y-%m-%d %H:%M') + ' %s %s\n'
 201 fd = open(LOGFILE, 'a')
 202 if deblockcandidates:
 203     fd.write(logstr % ('unblocked:', ', '.join(deblockcandidates)))
 204 if debulkcandidates:
 205     fd.write(logstr % (' debulked:', ', '.join(debulkcandidates)))
 206 if bulkips:
 207     fd.write(logstr % ('new bulks:', ', '.join(bulkips.keys())))
 208 if emergencyblocks:
 209     fd.write(logstr % ('dir.block:', ', '.join(emergencyblocks)))
 210 if newlyblocked:
 211     fd.write(logstr % ('new block:', ', '.join(newlyblocked)))
 212 fd.close()