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