]> git.openstreetmap.org Git - chef.git/blob - cookbooks/tilecache/templates/default/nginx_tile.conf.erb
tilecache: only rate limit clients not peers
[chef.git] / cookbooks / tilecache / templates / default / nginx_tile.conf.erb
1 # DO NOT EDIT - This file is being maintained by Chef
2
3 upstream tile_cache_backend {
4   server 127.0.0.1:8080;
5   server 127.0.0.2:8080;
6
7   # Add the tile_siblings caches to relieve pressure if local squid failing
8   # Balancer: round-robin
9 <% server_weight = 20 -%>
10 <% @node[:tilecache][:tile_siblings].each do |cache_peer| -%>
11 <% @caches.each do |cache| -%>
12 <% if cache_peer == cache[:fqdn] -%>
13 <% if cache[:hostname] != node[:hostname] -%>
14 <% cache.ipaddresses(:family => :inet, :role => :external).sort.each do |address| -%>
15   server <%= address %>:80 weight=<%= server_weight.div(10) %>; # Server <%= cache[:hostname] %>
16 <% server_weight += 5 -%>
17 <% end -%>
18 <% end -%>
19 <% end -%>
20 <% end -%>
21 <% end -%>
22
23   keepalive 128;
24 }
25
26 # Geo Map of tile caches
27 geo $tile_cache {
28   default "client";
29 <% @caches.each do |cache| -%>
30 <% cache.ipaddresses(:family => :inet, :role => :external).sort.each do |address| -%>
31   <%= address %> "cache"; # <%= cache[:hostname] %>
32 <% end -%>
33 <% end -%>
34 }
35
36 # Rates table based on current cookie value
37 # map $cookie__osm_totp_token $limit_rate_qos {
38 #  include /etc/nginx/conf.d/tile_qos_rates.map;
39 # }
40
41 # Set-Cookie table based on current cookie value
42 # map $cookie__osm_totp_token $cookie_qos_token_set {
43 #  include /etc/nginx/conf.d/tile_qos_cookies.map;
44 # }
45
46 map $http_user_agent $approved_scraper {
47   default                   0; # Not approved
48   '~^JOSM\/'                1; # JOSM
49   '~^Mozilla\/5\.0\ QGIS\/' 1; # QGIS
50 }
51
52 map $http_user_agent $denied_scraper {
53   default                0; # Not denied
54   ''                     1; # No User-Agent Set
55   '~^Python\-urllib\/'   1; # Library Default
56   '~^python\-requests\/' 1; # Library Default
57   '~^node\-fetch\/'      1; # Library Default
58   '~^R$'                 1; # Library Default
59   '~^Java\/'             1; # Library Default
60   '~^tiles$'             1; # Library Default
61   '~^okhttp\/'           1; # Library Default
62   '~^Microsoft-ATL-Native\/' 1; # Library Default
63   '/n software IPWorks HTTP/S Component - www.nsoftware.com' 1; #Library default
64   '~^Wget\/'             1; # Library Default
65   'C# TilesDownloader'   1; # Downloader
66   'MapDownloader'        1; # Downloader
67   '~^staticmaps'         1; # Downloader
68   'Android'              1; # Default or fake
69   'kc_android'           1; # Default or fake
70   'Mozilla/4.0'          1; # Fake
71   'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)' 1;  # Fake
72   '~^runtastic'          1; # App
73   '~^Where\ my\ children' 1; # App
74   'nossoonibusjp.android.crosswalk' 1; # App
75   'br.com.concisoti.potybus' 1; # App
76   'com.soft373.taptaxi'  1;
77   'com.kradac.ktxcore'   1;
78   'ru.crowdsystems.topcontrol.knd' 1;
79   'pl.itaxi.driver'      1;
80   'net.uztaxi.driver'    1;
81   'OSMDroid/2.1 (its; rutaxi 3.28.0)' 1;
82   'com.helleniccomms.mercedes.driver' 1;
83   'ru.taximaster.www'    1;
84   'com.arobs.trackgps'   1;
85   'com.helleniccomms.asteras.driver' 1;
86   # '~[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}' 1; # Fake UA
87 }
88
89 map $http_referer $denied_referer {
90   default                          0; # Not denied
91   'http://www.openstreetmap.org/'  1; # Faked
92   'http://www.openstreetmap.org'   1; # Faked
93   'https://www.openstreetmap.org'  1; # Faked
94   'http://openstreetmap.org/'      1; # Faked
95   'http://openstreetmap.org'       1; # Faked
96   'https://openstreetmap.org'      1; # Faked
97   'http://www.osm.org/'            1; # Faked
98   'http://www.osm.org'             1; # Faked
99   'http://osm.org/'                1; # Faked
100   'http://osm.org'                 1; # Faked
101   'http://google.com'              1; # Faked
102   'http://www.google.com'          1; # Faked
103   'http://google.com/'             1; # Faked
104   'http://www.google.com/'         1; # Faked
105   'https://google.com'             1; # Faked
106   'https://www.google.com'         1; # Faked
107   'https://google.com/'            1; # Faked
108   'https://www.google.com/'        1; # Faked
109   'http://www.microsoft.com/'      1; # Faked
110   '~^https?://pmap\.kuku\.lu/'           1; # Too much traffic
111   '~^https?://[^.]*\.pmap\.kuku\.lu/'    1; # Too much traffic
112   '~^https?://fastpokemap\.com/'         1; # Too much traffic
113   '~^https?://[^.]*\.fastpokemap\.com/'  1; # Too much traffic
114   '~^https?://pkget\.com/'               1; # Too much traffic
115   '~^https?://[^.]*\.pkget\.com/'        1; # Too much traffic
116   '~^https?://twpkinfo\.com/'            1; # Too much traffic
117   '~^https?://[^.]*\.twpkinfo\.com/'     1; # Too much traffic
118   '~^https?://9db\.jp/'                  1; # Too much traffic
119   '~^https?://[^.]*\.9db\.jp/'           1; # Too much traffic
120   '~^https?://clustrmaps\.com/'          1; # Too much traffic
121   '~^https?://[^.]*\.clustrmaps\.com/'   1; # Too much traffic
122 }
123
124 map $http_referer $osm_referer {
125   default                                 '';    # False
126   '~^https:\/\/www\.openstreetmap\.org\/' 'osm'; # True
127 }
128
129 # Limit Cache-Control header to only approved User-Agents
130 map $osm_referer$http_user_agent $limit_http_cache_control {
131   default '';                                # Unset Header
132   '~^osmMozilla\/5\.0\ QGIS\/' '';            # Unset Header
133   '~^osmMozilla\/5\.0\ ' $http_cache_control; # Pass Header
134 }
135
136 # Limit Pragma header to only approved User-Agents
137 map $osm_referer$http_user_agent $limit_http_pragma {
138   default '';                          # Unset Header
139   '~^osmMozilla\/5\.0\ QGIS\/' '';     # Unset Header
140   '~^osmMozilla\/5\.0\ ' $http_pragma; # Pass Header
141 }
142
143 # Find Browser User-Agents which are not sending a referer.
144 # Browsers with no referer could be due to Browser extension or website Referrer-Policy
145 map $tile_cache$http_referer$scheme$http_user_agent $deny_missing_referer {
146   default                             0; # Not denied
147   '~^clienthttpsMozilla\/5\.0\ \(X11'       1;
148   '~^clienthttpsMozilla\/5\.0\ \(Windows'   1;
149   '~^clienthttpsMozilla\/5\.0\ \(iPhone'    1;
150   '~^clienthttpsMozilla\/5\.0\ \(Macintosh' 1;
151   '~^clienthttpsMozilla\/5\.0\ \(Linux'     1;
152 }
153
154 server {
155     # IPv4
156     listen       80 deferred backlog=16384 reuseport fastopen=2048 default_server;
157     listen       443 ssl deferred backlog=16384 reuseport fastopen=2048 http2 default_server;
158     # IPv6
159     listen       [::]:80 deferred backlog=16384 reuseport fastopen=2048 default_server;
160     listen       [::]:443 ssl deferred backlog=16384 reuseport fastopen=2048 http2 default_server;
161     server_name  localhost;
162
163     proxy_buffers 8 64k;
164     proxy_busy_buffers_size 64k;
165
166     ssl_certificate      /etc/ssl/certs/tile.openstreetmap.org.pem;
167     ssl_certificate_key  /etc/ssl/private/tile.openstreetmap.org.key;
168
169     # Requests sent within early data are subject to replay attacks.
170     # See: http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_early_data
171     ssl_early_data on;
172
173     # Immediately 404 layers we do not support
174 <% for i in 20..99 do %>
175     location /<%= i %>/ {
176       set $limit_rate 512;
177       return 404;
178     }
179 <% end %>
180
181     # Immediately 404 silly tile requests
182     location = /0/0/-1.png {
183       set $limit_rate 512;
184       return 404;
185     }
186     location = /1/0/-1.png {
187       set $limit_rate 512;
188       return 404;
189     }
190     location = /1/-1/0.png {
191       set $limit_rate 512;
192       return 404;
193     }
194     location = /1/-1/1.png {
195       set $limit_rate 512;
196       return 404;
197     }
198     location = /1/-1/-1.png {
199       set $limit_rate 512;
200       return 404;
201     }
202     location = /1/-1/2.png {
203       set $limit_rate 512;
204       return 404;
205     }
206     location = /1/1/-1.png {
207       set $limit_rate 512;
208       return 404;
209     }
210     location = /1/2/-1.png {
211       set $limit_rate 512;
212       return 404;
213     }
214     location = /2/0/-1.png {
215       set $limit_rate 512;
216       return 404;
217     }
218     location = /2/-1/0.png {
219       set $limit_rate 512;
220       return 404;
221     }
222     location = /2/-1/1.png {
223       set $limit_rate 512;
224       return 404;
225     }
226     location = /2/1/-1.png {
227       set $limit_rate 512;
228       return 404;
229     }
230     location = /2/-1/2.png {
231       set $limit_rate 512;
232       return 404;
233     }
234     location = /2/-1/3.png {
235       set $limit_rate 512;
236       return 404;
237     }
238
239 <% for i in 0..16 do %>
240 <% if i == 0 -%>
241     # Default Fallback Location Handler (lowest)
242     location / {
243 <% elsif -%>
244     # Dedicated zoom handler for caching
245     location /<%= i %>/ {
246 <% end %>
247       # Only allow GET / HEAD / OPTIONS (CORS) requests
248       limit_except GET HEAD OPTIONS {
249         deny all;
250       }
251
252       proxy_pass http://tile_cache_backend;
253       proxy_set_header X-Forwarded-For $remote_addr;
254       proxy_http_version 1.1;
255       proxy_set_header Connection '';
256
257       proxy_connect_timeout 20s;
258
259       # Replace host header.
260       proxy_set_header Host 'tile.openstreetmap.org';
261       # Do not pass cookies to backends.
262       proxy_set_header Cookie '';
263       # Do not pass Accept-Encoding to backends.
264       proxy_set_header Accept-Encoding '';
265       # Do not pass Accept to backends.
266       proxy_set_header Accept '';
267       # Do not pass Accept-Language to backends as unused.
268       proxy_set_header Accept-Language '';
269       proxy_set_header Accept-Charset '';
270       # Do not send origin, we allow all.
271       proxy_set_header origin '';
272       # Do not pass invalid headers to backend.
273       proxy_set_header X-Forwarded-Host '';
274       proxy_set_header X-Host '';
275       proxy_set_header Authorization '';
276       proxy_set_header Proxy-Authorization '';
277
278       # Drop partial requests
279       proxy_set_header range '';
280
281       # Do not allow setting cookies from backends due to caching.
282       proxy_ignore_headers Set-Cookie;
283       proxy_hide_header Set-Cookie;
284
285 <% if i != 0 -%>
286       # Caching
287       proxy_cache "proxy_cache_zone";
288       proxy_cache_lock on;
289       proxy_cache_valid 200 2d;
290       proxy_cache_valid 404 15m;
291       # Serve stale cache on errors or if updating
292       proxy_cache_use_stale error timeout updating http_404 http_500 http_503 http_504;
293       # If in cache as stale, serve stale and update in background
294       proxy_cache_background_update on;
295       # Workaround nginx async bug which causes stale cache replies to wait for the async backend cache update reply (seen in v1.16.0)
296       keepalive_requests 0;
297       # Enable revalidation using If-Modified-Since and If-None-Match for stale items
298       proxy_cache_revalidate on;
299       proxy_cache_min_uses 4;
300
301       add_header x-cache-status $upstream_cache_status;
302 <% else %>
303       # Severely rate limit Browser UAs which are not sending a referer.
304       # With no referer we do not know who is using tiles
305       if ($deny_missing_referer) {
306         set $limit_rate 1024;
307         add_header x-cache-ratelimit "missing-referer";
308       }
309 <% end -%>
310
311       # Set a QoS cookie if none presented (uses nginx Map)
312       # add_header Set-Cookie $cookie_qos_token_set;
313 <% if node[:ssl][:strict_transport_security] -%>
314       # Ensure Strict-Transport-Security header is removed from proxied server responses
315       proxy_hide_header Strict-Transport-Security;
316
317       # Enable HSTS
318       add_header Strict-Transport-Security "<%= node[:ssl][:strict_transport_security] %>" always;
319 <% end -%>
320
321       # QoS Traffic Rate see $limit_rate on http://nginx.org/en/docs/http/ngx_http_core_module.html
322       # set $limit_rate $limit_rate_qos;
323
324       # Allow Higher Traffic Rate from Approved User-Agents which do not support cookies (uses nginx Map)
325       # if ($approved_scraper) {
326       #   set $limit_rate 65536;
327       # }
328
329       if ($denied_scraper) {
330         set $limit_rate 512;
331         return 429;
332       }
333       if ($denied_referer) {
334         set $limit_rate 512;
335         return 418;
336       }
337
338       # Strip any ?query parameters from urls
339       set $args '';
340
341       # Allow cache purging headers only from select User-Agents (uses nginx Map)
342       proxy_set_header Cache-Control $limit_http_cache_control;
343       proxy_set_header Pragma $limit_http_pragma;
344     }
345 <% end %>
346 }