]> git.openstreetmap.org Git - chef.git/blob - cookbooks/tilecache/templates/default/nginx_tile.conf.erb
tilecache: restrict cache control headers to osm.org only
[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;
5   server 127.0.0.2;
6   server 127.0.0.3;
7
8   # Add the other caches to relieve pressure if local squid failing
9   # Balancer: round-robin
10 <% @caches.each do |cache| -%>
11 <% if cache[:hostname] != node[:hostname] -%>
12 <% if node[:tilecache][:tile_siblings].include? cache[:fqdn] -%>
13 <% cache.ipaddresses(:family => :inet, :role => :external).sort.each do |address| -%>
14   server <%= address %> backup; # Server <%= cache[:hostname] %>
15 <% end -%>
16 <% end -%>
17 <% end -%>
18 <% end -%>
19
20   keepalive 512;
21   keepalive_requests 1024;
22 }
23
24 # Geo Map of tile caches
25 geo $tile_cache {
26   default 0;
27 <% @caches.each do |cache| -%>
28 <% cache.ipaddresses(:family => :inet, :role => :external).sort.each do |address| -%>
29   <%= address %> 1; # <%= cache[:hostname] %>
30 <% end -%>
31 <% end -%>
32 }
33
34 # Rates table based on current cookie value
35 map $cookie__osm_totp_token $limit_rate_qos {
36   include /etc/nginx/conf.d/tile_qos_rates.map;
37 }
38
39 # Set-Cookie table based on current cookie value
40 map $cookie__osm_totp_token $cookie_qos_token_set {
41   include /etc/nginx/conf.d/tile_qos_cookies.map;
42 }
43
44 map $http_user_agent $approved_scraper {
45   default                   0; # Not approved
46   '~^JOSM\/'                1; # JOSM
47   '~^Mozilla\/5\.0\ QGIS\/' 1; # QGIS
48 }
49
50 map $http_user_agent $denied_scraper {
51   default                0; # Not denied
52   ''                     1; # No User-Agent Set
53   '~^Python\-urllib\/'   1; # Library Default
54   '~^python\-requests\/' 1; # Library Default
55   '~^node\-fetch\/'      1; # Library Default
56   '~^R$'                 1; # Library Default
57   '~^Java\/'             1; # Library Default
58   '~^tiles$'             1; # Library Default
59   '~^runtastic'          1; # App
60   'Mozilla/4.0'          1; # Fake
61   'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)' 1;  # Fake
62 }
63
64 map $http_referer $denied_referer {
65   default                          0; # Not denied
66   'http://www.openstreetmap.org/'  1; # Faked
67   'http://www.openstreetmap.org'   1; # Faked
68   'http://openstreetmap.org/'      1; # Faked
69   'http://openstreetmap.org'       1; # Faked
70   'http://www.osm.org/'            1; # Faked
71   'http://www.osm.org'             1; # Faked
72   'http://osm.org/'                1; # Faked
73   'http://osm.org'                 1; # Faked
74 }
75
76 map $http_referer $osm_referer {
77   default                                 0;     # False
78   '~^https:\/\/www\.openstreetmap\.org\/' 'osm'; # True
79 }
80
81 # Limit Cache-Control header to only approved User-Agents
82 map $http_user_agent $limit_http_cache_control {
83   default '';                              # Unset Header
84   '~^Mozilla\/5\.0\ QGIS\/' '';            # Unset Header
85   '~^Mozilla\/5\.0\ ' $http_cache_control; # Pass Header
86 }
87
88 # Limit Pragma header to only approved User-Agents
89 map $http_user_agent $limit_http_pragma {
90   default '';                       # Unset Header
91   '~^Mozilla\/5\.0\ QGIS\/' '';     # Unset Header
92   '~^Mozilla\/5\.0\ ' $http_pragma; # Pass Header
93 }
94
95 server {
96     listen       443 ssl deferred backlog=16384 reuseport fastopen=2048 http2 default_server;
97     server_name  localhost;
98
99     proxy_buffers 8 64k;
100
101     ssl_certificate      /etc/ssl/certs/tile.openstreetmap.org.pem;
102     ssl_certificate_key  /etc/ssl/private/tile.openstreetmap.org.key;
103
104     # Requests sent within early data are subject to replay attacks.
105     # See: http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_early_data
106     ssl_early_data on;
107
108     # Immediately 404 layers we do not support
109 <% for i in 20..99 do %>
110     location /<%= i %>/ {
111       set $limit_rate 512;
112       return 404;
113     }
114 <% end %>
115
116     # Immediately 404 silly tile requests
117     location = /0/0/-1.png {
118       set $limit_rate 512;
119       return 404;
120     }
121     location = /1/0/-1.png {
122       set $limit_rate 512;
123       return 404;
124     }
125     location = /1/-1/0.png {
126       set $limit_rate 512;
127       return 404;
128     }
129     location = /1/-1/1.png {
130       set $limit_rate 512;
131       return 404;
132     }
133     location = /1/-1/-1.png {
134       set $limit_rate 512;
135       return 404;
136     }
137     location = /1/-1/2.png {
138       set $limit_rate 512;
139       return 404;
140     }
141     location = /1/1/-1.png {
142       set $limit_rate 512;
143       return 404;
144     }
145     location = /1/2/-1.png {
146       set $limit_rate 512;
147       return 404;
148     }
149     location = /2/0/-1.png {
150       set $limit_rate 512;
151       return 404;
152     }
153     location = /2/-1/0.png {
154       set $limit_rate 512;
155       return 404;
156     }
157     location = /2/-1/1.png {
158       set $limit_rate 512;
159       return 404;
160     }
161     location = /2/1/-1.png {
162       set $limit_rate 512;
163       return 404;
164     }
165     location = /2/-1/2.png {
166       set $limit_rate 512;
167       return 404;
168     }
169     location = /2/-1/3.png {
170       set $limit_rate 512;
171       return 404;
172     }
173
174 <% for i in 0..14 do %>
175 <% if i == 0 -%>
176     # Default Fallback Location Handler (lowest)
177     location / {
178 <% elsif -%>
179     # Dedicated zoom handler for caching
180     location /<%= i %>/ {
181 <% end %>
182       proxy_pass http://tile_cache_backend;
183       proxy_set_header X-Forwarded-For $remote_addr;
184       proxy_http_version 1.1;
185       proxy_set_header Connection '';
186
187       proxy_connect_timeout 10s;
188
189       # Replace host header.
190       proxy_set_header Host 'tile.openstreetmap.org';
191       # Do not pass cookies to backends.
192       proxy_set_header Cookie '';
193       # Do not pass Accept-Encoding to backends.
194       proxy_set_header Accept-Encoding '';
195       # Do not pass Accept to backends.
196       proxy_set_header Accept '';
197       # Do not pass Accept-Language to backends as unused.
198       proxy_set_header Accept-Language '';
199       proxy_set_header Accept-Charset '';
200       # Do not send origin, we allow all.
201       proxy_set_header origin '';
202       # Do not pass invalid headers to backend.
203       proxy_set_header X-Forwarded-Host '';
204       proxy_set_header X-Host '';
205       proxy_set_header Authorization '';
206       proxy_set_header Proxy-Authorization '';
207
208       # Drop partial requests
209       proxy_set_header range '';
210
211       # Do not allow setting cookies from backends due to caching.
212       proxy_ignore_headers Set-Cookie;
213       proxy_hide_header Set-Cookie;
214
215 <% if i != 0 -%>
216       # Caching
217       proxy_cache "proxy_cache_zone";
218       proxy_cache_lock on;
219       proxy_cache_valid 200 1d;
220       proxy_cache_valid 404 15m;
221       # Serve stale cache on errors or if updating
222       proxy_cache_use_stale error timeout updating http_500 http_503 http_504;
223       # If in cache as stale, serve stale and update in background
224       proxy_cache_background_update on;
225       proxy_cache_min_uses 8;
226
227       add_header X-Nginx-Cache-Status $upstream_cache_status;
228 <% end -%>
229
230       # Set a QoS cookie if none presented (uses nginx Map)
231       add_header Set-Cookie $cookie_qos_token_set;
232 <% if node[:ssl][:strict_transport_security] -%>
233       # Ensure Strict-Transport-Security header is removed from proxied server responses
234       proxy_hide_header Strict-Transport-Security;
235
236       # Enable HSTS
237       add_header Strict-Transport-Security "<%= node[:ssl][:strict_transport_security] %>" always;
238 <% end -%>
239
240       # QoS Traffic Rate see $limit_rate on http://nginx.org/en/docs/http/ngx_http_core_module.html
241       set $limit_rate $limit_rate_qos;
242
243       # Allow Higher Traffic Rate from Approved User-Agents which do not support cookies (uses nginx Map)
244       if ($approved_scraper) {
245         set $limit_rate 65536;
246       }
247
248       if ($denied_scraper) {
249         set $limit_rate 512;
250         return 429;
251       }
252       if ($denied_referer) {
253         set $limit_rate 512;
254         return 418;
255       }
256
257       # Only allow cache purges if from OpenStreetMap referer
258       if ($osm_referer) {
259         # Allow cache purging headers only from select User-Agents (uses nginx Map)
260         proxy_set_header Cache-Control $limit_http_cache_control;
261         proxy_set_header Pragma $limit_http_pragma;
262       }
263       # nginx has no if else logic
264       if ($osm_referer != 'osm') {
265         proxy_set_header Cache-Control '';
266         proxy_set_header Pragma '';
267       }
268
269       # Strip any ?query parameters from urls
270       set $args '';
271     }
272 <% end %>
273 }