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