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.com/'        1; # (hold per 2020-04-10 email)
 150 }
 151
 152 map $http_referer $osm_referer {
 153   default                                 '';    # False
 154   '~^https:\/\/www\.openstreetmap\.org\/' 'osm'; # True
 155 }
 156
 157 # Limit Cache-Control header to only approved User-Agents
 158 map $tile_cache$osm_referer$http_user_agent $limit_http_cache_control {
 159   default '';                             # Unset Header
 160   '~^clientosmMozilla\/5\.0\ \(X11'       $http_cache_control; # Pass Header
 161   '~^clientosmMozilla\/5\.0\ \(Windows'   $http_cache_control; # Pass Header
 162   '~^clientosmMozilla\/5\.0\ \(iPhone'    $http_cache_control; # Pass Header
 163   '~^clientosmMozilla\/5\.0\ \(Macintosh' $http_cache_control; # Pass Header
 164   '~^clientosmMozilla\/5\.0\ \(Linux'     $http_cache_control; # Pass Header
 165 }
 166
 167 # Limit Pragma header to only approved User-Agents
 168 map $tile_cache$osm_referer$http_user_agent $limit_http_pragma {
 169   default '';                             # Unset Header
 170   '~^clientosmMozilla\/5\.0\ \(X11'       $http_pragma; # Pass Header
 171   '~^clientosmMozilla\/5\.0\ \(Windows'   $http_pragma; # Pass Header
 172   '~^clientosmMozilla\/5\.0\ \(iPhone'    $http_pragma; # Pass Header
 173   '~^clientosmMozilla\/5\.0\ \(Macintosh' $http_pragma; # Pass Header
 174   '~^clientosmMozilla\/5\.0\ \(Linux'     $http_pragma; # Pass Header
 175 }
 176
 177 # Find Browser User-Agents which are not sending a referer.
 178 # Browsers with no referer could be due to Browser extension or website Referrer-Policy
 179 map $tile_cache$http_referer$scheme$http_user_agent $deny_missing_referer {
 180   default                                   0; # Not denied
 181   '~^clienthttpsMozilla\/5\.0\ \(X11'       1;
 182   '~^clienthttpsMozilla\/5\.0\ \(Windows'   1;
 183   '~^clienthttpsMozilla\/5\.0\ \(iPhone'    1;
 184   '~^clienthttpsMozilla\/5\.0\ \(Macintosh' 1;
 185   '~^clienthttpsMozilla\/5\.0\ \(Linux'     1;
 186 }
 187
 188 server {
 189     # IPv4
 190     listen       80 deferred backlog=16384 reuseport fastopen=2048 default_server;
 191     listen       443 ssl deferred backlog=16384 reuseport fastopen=2048 http2 default_server;
 192     # IPv6
 193     listen       [::]:80 deferred backlog=16384 reuseport fastopen=2048 default_server;
 194     listen       [::]:443 ssl deferred backlog=16384 reuseport fastopen=2048 http2 default_server;
 195     server_name  localhost;
 196
 197     proxy_buffers 8 64k;
 198     proxy_busy_buffers_size 64k;
 199
 200     ssl_certificate      /etc/ssl/certs/tile.openstreetmap.org.pem;
 201     ssl_certificate_key  /etc/ssl/private/tile.openstreetmap.org.key;
 202
 203     # Requests sent within early data are subject to replay attacks.
 204     # See: http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_early_data
 205     ssl_early_data on;
 206
 207     # Immediately 404 layers we do not support
 208 <% for i in 20..99 do %>
 209     location /<%= i %>/ {
 210       return 404;
 211     }
 212 <% end %>
 213
 214     # Immediately 404 silly tile requests
 215     location = /0/0/-1.png {
 216       return 404;
 217     }
 218     location = /1/0/-1.png {
 219       return 404;
 220     }
 221     location = /1/-1/0.png {
 222       return 404;
 223     }
 224     location = /1/-1/1.png {
 225       return 404;
 226     }
 227     location = /1/-1/-1.png {
 228       return 404;
 229     }
 230     location = /1/-1/2.png {
 231       return 404;
 232     }
 233     location = /1/1/-1.png {
 234       return 404;
 235     }
 236     location = /1/2/-1.png {
 237       return 404;
 238     }
 239     location = /2/0/-1.png {
 240       return 404;
 241     }
 242     location = /2/-1/0.png {
 243       return 404;
 244     }
 245     location = /2/-1/1.png {
 246       return 404;
 247     }
 248     location = /2/1/-1.png {
 249       return 404;
 250     }
 251     location = /2/-1/2.png {
 252       return 404;
 253     }
 254     location = /2/-1/3.png {
 255       return 404;
 256     }
 257
 258 <% for i in 0..16 do %>
 259 <% if i == 0 -%>
 260     # Default Fallback Location Handler (lowest)
 261     location / {
 262 <% elsif -%>
 263     # Dedicated zoom handler for caching
 264     location /<%= i %>/ {
 265 <% end %>
 266       # Only allow GET / HEAD / OPTIONS (CORS) requests
 267       limit_except GET HEAD OPTIONS {
 268         deny all;
 269       }
 270
 271       proxy_pass http://tile_cache_backend;
 272       proxy_set_header X-Forwarded-For $remote_addr;
 273       proxy_http_version 1.1;
 274       proxy_set_header Connection '';
 275
 276       proxy_connect_timeout 20s;
 277
 278       proxy_next_upstream_tries 2;
 279
 280       # Replace host header.
 281       proxy_set_header Host 'tile.openstreetmap.org';
 282       # Do not pass cookies to backends.
 283       proxy_set_header Cookie '';
 284       # Do not pass Accept-Encoding to backends.
 285       proxy_set_header Accept-Encoding '';
 286       # Do not pass Accept to backends.
 287       proxy_set_header Accept '';
 288       # Do not pass Accept-Language to backends as unused.
 289       proxy_set_header Accept-Language '';
 290       proxy_set_header Accept-Charset '';
 291       # Do not send origin, we allow all.
 292       proxy_set_header origin '';
 293       # Do not pass invalid headers to backend.
 294       proxy_set_header X-Forwarded-Host '';
 295       proxy_set_header X-Host '';
 296       proxy_set_header Authorization '';
 297       proxy_set_header Proxy-Authorization '';
 298
 299       # Drop partial requests
 300       proxy_set_header range '';
 301
 302       # Do not allow setting cookies from backends due to caching.
 303       proxy_ignore_headers Set-Cookie;
 304       proxy_hide_header Set-Cookie;
 305
 306 <% if i != 0 -%>
 307       # Caching
 308       proxy_cache "proxy_cache_zone";
 309       proxy_cache_lock on;
 310       proxy_cache_valid 200 2d;
 311       proxy_cache_valid 404 15m;
 312       # Serve stale cache on errors or if updating
 313       proxy_cache_use_stale error timeout updating http_404 http_500 http_503 http_504;
 314       # If in cache as stale, serve stale and update in background
 315       proxy_cache_background_update on;
 316       # Workaround nginx async bug which causes stale cache replies to wait for the async backend cache update reply (seen in v1.16.0)
 317       keepalive_requests 0;
 318       # Enable revalidation using If-Modified-Since and If-None-Match for stale items
 319       proxy_cache_revalidate on;
 320       proxy_cache_min_uses 4;
 321
 322       add_header x-cache-status "$upstream_cache_status - <%= node[:hostname] %>";
 323 <% else %>
 324       # Severely rate limit Browser UAs which are not sending a referer.
 325       # With no referer we do not know who is using tiles
 326       if ($deny_missing_referer) {
 327         set $limit_rate 1024;
 328         add_header x-cache-ratelimit "missing-referer";
 329       }
 330 <% end -%>
 331
 332       # Set a QoS cookie if none presented (uses nginx Map)
 333       # add_header Set-Cookie $cookie_qos_token_set;
 334 <% if node[:ssl][:strict_transport_security] -%>
 335       # Ensure Strict-Transport-Security header is removed from proxied server responses
 336       proxy_hide_header Strict-Transport-Security;
 337
 338       # Enable HSTS
 339       add_header Strict-Transport-Security "<%= node[:ssl][:strict_transport_security] %>" always;
 340 <% end -%>
 341
 342       # QoS Traffic Rate see $limit_rate on http://nginx.org/en/docs/http/ngx_http_core_module.html
 343       # set $limit_rate $limit_rate_qos;
 344
 345       # Allow Higher Traffic Rate from Approved User-Agents which do not support cookies (uses nginx Map)
 346       # if ($approved_scraper) {
 347       #   set $limit_rate 65536;
 348       # }
 349
 350       if ($denied_scraper) {
 351         set $limit_rate 512;
 352         return 429;
 353       }
 354       if ($denied_referer) {
 355         set $limit_rate 512;
 356         return 418;
 357       }
 358
 359       # Strip any ?query parameters from urls
 360       set $args '';
 361
 362       # Allow cache purging headers only from select User-Agents (uses nginx Map)
 363       proxy_set_header Cache-Control $limit_http_cache_control;
 364       proxy_set_header Pragma $limit_http_pragma;
 365     }
 366 <% end %>
 367 }