]> git.openstreetmap.org Git - nominatim.git/blob - utils/cron_banip.py
tweak block limits
[nominatim.git] / 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 - 75))
110 BULKLONG_LIMIT = max(BULK_LOWER, BULKLONG_LIMIT - BULK_LOADFAC * (avgload - 14))
111 if len(prevbulks) > 85:
112     BLOCK_LIMIT = max(3600, BLOCK_LOWER - (len(prevbulks) - 85)*10)
113
114 # get the new block candidates
115 cur.execute("""
116   SELECT ipaddress, max(count) FROM
117    ((SELECT * FROM
118      (SELECT ipaddress, sum(case when endtime is null then 1 else 1+date_part('epoch',endtime-starttime) end) as count FROM new_query_log
119       WHERE starttime > now() - interval '1 hour' GROUP BY ipaddress) as i
120    WHERE count > %s)
121    UNION
122    (SELECT ipaddress, count * 3 FROM
123      (SELECT ipaddress, sum(case when endtime is null then 1 else 1+date_part('epoch',endtime-starttime) end) as count FROM new_query_log 
124       WHERE starttime > now() - interval '10 min' GROUP BY ipaddress) as i
125    WHERE count > %s)) as o
126   GROUP BY ipaddress
127 """, (BULKLONG_LIMIT, BULKSHORT_LIMIT))
128
129 bulkips = {}
130 emergencyblocks = []
131
132 for c in cur:
133     if c[0] not in WHITELIST and c[0] not in BLACKLIST:
134         if c[1] > BLOCK_UPPER and c[0] not in prevbulks:
135             newblocks.add(c[0])
136             if c[0] not in prevblocks:
137                 emergencyblocks.append(c[0])
138         else:
139             bulkips[c[0]] = c[1]
140
141 # IPs from the block list that are no longer in the bulk list
142 deblockcandidates = set()
143 # IPs from the bulk list that are no longer in the bulk list
144 debulkcandidates = set()
145 # new IPs to go into the block list
146 newlyblocked = []
147
148
149 for ip in prevblocks:
150     if ip in bulkips:
151         newblocks.add(ip)
152         del bulkips[ip]
153     else:
154         deblockcandidates.add(ip)    
155         
156 for ip in prevbulks:
157     if ip in bulkips:
158         if bulkips[ip] > BLOCK_LIMIT:
159             newblocks.add(ip)
160             newlyblocked.append(ip)
161         else:
162             newbulks.add(ip)
163         del bulkips[ip]
164     else:
165         debulkcandidates.add(ip)
166
167 # cross-check deblock candidates
168 if deblockcandidates:
169     cur.execute("""
170         SELECT DISTINCT ipaddress FROM new_query_log
171         WHERE ipaddress IN ('%s') AND starttime > now() - interval '%s'
172         """ % ("','".join(deblockcandidates), BLOCKCOOLOFF_PERIOD))
173
174     for c in cur:
175         newblocks.add(c[0])
176         deblockcandidates.remove(c[0])
177 # deblocked IPs go back to the bulk pool to catch the ones that simply
178 # ignored the HTTP error and just continue to hammer the API.
179 # Those that behave and stopped will be debulked a minute later.
180 for ip in deblockcandidates:
181     newbulks.add(ip)
182
183 # cross-check debulk candidates
184 if debulkcandidates:
185     cur.execute("""
186         SELECT DISTINCT ipaddress FROM new_query_log
187         WHERE ipaddress IN ('%s') AND starttime > now() - interval '%s'
188         AND starttime > date_trunc('day', now())
189         """ % ("','".join(debulkcandidates), BULKCOOLOFF_PERIOD))
190
191     for c in cur:
192         newbulks.add(c[0])
193         debulkcandidates.remove(c[0])
194
195 for ip in bulkips.iterkeys():
196     newbulks.add(ip)
197
198 # write out the new list
199 fd = open(BLOCKEDFILE, 'w')
200 for ip in newblocks:
201     fd.write(ip + " block\n")
202 for ip in newbulks:
203     fd.write(ip + " bulk\n")
204 for ip in BLACKLIST:
205     fd.write(ip + " ban\n")
206 fd.close()
207
208 # write out the log
209 logstr = datetime.datetime.now().strftime('%Y-%m-%d %H:%M') + ' %s %s\n'
210 fd = open(LOGFILE, 'a')
211 if deblockcandidates:
212     fd.write(logstr % ('unblocked:', ', '.join(deblockcandidates)))
213 if debulkcandidates:
214     fd.write(logstr % (' debulked:', ', '.join(debulkcandidates)))
215 if bulkips:
216     fd.write(logstr % ('new bulks:', ', '.join(bulkips.keys())))
217 if emergencyblocks:
218     fd.write(logstr % ('dir.block:', ', '.join(emergencyblocks)))
219 if newlyblocked:
220     fd.write(logstr % ('new block:', ', '.join(newlyblocked)))
221 fd.close()