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