Merge pull request #68 from UKHomeOffice/custom-error-pages

Add support for individual custom error pages

Author: daniel-ac-martin

README.md

@@ -38,8 +38,9 @@ rules to be specified without downloading or mounting in a rule file.
  for easy tracking in down stream logs e.g. `nginxId=50c91049-667f-4286-c2f0-86b04b27d3f0`.
  If set to `HEADER` it will add `nginxId` to the headers, not append to the get params.
 * `CLIENT_CERT_REQUIRED` - if set to `TRUE`, will deny access at this location, see [Client Certs](#client-certs).
-* `ERROR_REDIRECT_CODES` - Can override when Nginx will redirect requests to the error page. Defaults to 
-"`500 501 502 503 504`"
+* `ERROR_REDIRECT_CODES` - Can override when Nginx will redirect requests to its own error page. Defaults to
+"`500 501 502 503 504`". To support a new code, say `505`, an error page must be provided at
+`/usr/local/openresty/nginx/html/505.shtml`, see [Useful File Locations](#useful-file-locations).
 * `ADD_NGINX_LOCATION_CFG` - Arbitrary extra NGINX configuration to be added to the location context, see 
 [Arbitrary Config](#arbitrary-config).
 * `PORT_IN_HOST_HEADER` - If FALSE will remove the port from the http `Host` header.
@@ -101,9 +102,11 @@ N.B. see HTTP(S)_LISTEN_PORT above
 See `CLIENT_CERT_REQUIRED` above in [Environment Variables](#environment-variables).
 * `/usr/local/openresty/naxsi/*.conf` - [Naxsi](https://github.com/nbs-system/naxsi) rules location in default 
 nginx.conf.
-* `/usr/local/openresty/nginx/html/50x.html` - HTML displayed when a 500 error occurs. See ERROR_REDIRECT_CODES to 
-change this.
-  
+* `/usr/local/openresty/nginx/html/$CODE.shtml` - HTML (with SSI support) displayed when a the status code $CODE
+is encountered upstream and the proxy is configured to intercept. See ERROR_REDIRECT_CODES to change this.
+* `/usr/local/openresty/nginx/html/418-request-denied.shtml` - HTML (with SSI support) displayed when NAXSI
+blocks a request.
+
 ### Examples
 
 #### Self signed SSL Certificate

ci-build.sh

@@ -269,6 +269,24 @@ else
     exit 1
 fi
 
+start_test "Test custom error pages..." "${STD_CMD} \
+           -e \"PROXY_SERVICE_HOST=http://mockserver\" \
+           -e \"PROXY_SERVICE_PORT=8080\" \
+           -e \"DNSMASK=TRUE\" \
+           -e \"ENABLE_UUID_PARAM=FALSE\" \
+           -e \"ERROR_REDIRECT_CODES=502 404 500\" \
+           --link mockserver:mockserver "
+if curl -k https://${DOCKER_HOST_NAME}:${PORT}/not-found | grep "404 Not Found" ; then
+    if curl -k https://${DOCKER_HOST_NAME}:${PORT}/api/dead | grep "An error occurred" ; then
+        echo "Passed custom error pages with ERROR_REDIRECT_CODES"
+    else
+        echo "Failed custom error pages with ERROR_REDIRECT_CODES on code 500"
+        exit 1
+    fi
+else
+    echo "Failed custom error pages with ERROR_REDIRECT_CODES on code 404"
+    exit 1
+fi
 
 start_test "Start with Custom upload size" "${STD_CMD} \
            -e \"PROXY_SERVICE_HOST=http://mockserver\" \
@@ -390,5 +408,5 @@ echo "Testing no logging of url params option works..."
 docker logs mockserver | grep 'Nginxid:'
 docker logs ${INSTANCE} | grep '"nginx_uuid": "'
 
-echo "__________________________________"
-echo "We got here, ALL tests successfull"
+echo "_________________________________"
+echo "We got here, ALL tests successful"

enable_location.sh

@@ -135,9 +135,17 @@ else
     msg "Auto UUID request parameter enabled for location ${LOCATION_ID}."
     touch ${UUID_FILE}
 fi
+
 if [ "${ERROR_REDIRECT_CODES}" == "" ]; then
     ERROR_REDIRECT_CODES="${DEFAULT_ERROR_CODES}"
 fi
+ERROR_PAGES=""
+for code in ${ERROR_REDIRECT_CODES}; do
+  # Set up an individual error page for each code
+  msg "Enabling redirect on status code: ${code}"
+  ERROR_PAGES="${ERROR_PAGES} error_page ${code} /nginx-proxy/${code}.shtml;"
+done
+
 if [ "${ENABLE_WEB_SOCKETS}" == "TRUE" ]; then
     msg "Enable web socket support"
     WEB_SOCKETS="include ${NGIX_CONF_DIR}/nginx_web_sockets_proxy.conf;"
@@ -183,7 +191,7 @@ location ${LOCATION} {
     ${BASIC_AUTH_CONFIG}
     ${DENY_COUNTRY}
 
-    error_page ${ERROR_REDIRECT_CODES} /nginx-proxy/50x.shtml;
+    ${ERROR_PAGES}
 
     set \$proxy_address "${PROXY_SERVICE_HOST}:${PROXY_SERVICE_PORT}";
 

html/500.shtml

@@ -0,0 +1 @@
+<!--#include file="50x.shtml" -->

html/501.shtml

@@ -0,0 +1 @@
+<!--#include file="50x.shtml" -->

html/502.shtml

@@ -0,0 +1 @@
+<!--#include file="50x.shtml" -->

html/503.shtml

@@ -0,0 +1 @@
+<!--#include file="50x.shtml" -->

html/504.shtml

@@ -0,0 +1 @@
+<!--#include file="50x.shtml" -->

test-servers.yaml

@@ -54,4 +54,4 @@
      code: 500
      body: '{"message": "Oh dear!"}'
      headers:
-       content-type: text/json
+       content-type: text/json