summaryrefslogtreecommitdiffhomepage
path: root/docs/changes.xml
diff options
context:
space:
mode:
authorOisin Canty <o.canty@f5.com>2021-08-12 08:23:16 +0000
committerOisin Canty <o.canty@f5.com>2021-08-12 08:23:16 +0000
commitca373aaccd276fb412e59557a3971a8d06ada0f8 (patch)
tree083d75282d8ae54affbe999cc7894b852a532043 /docs/changes.xml
parent73ea6a1c3a7a4a7f3ab14230b80e783e57a7d830 (diff)
downloadunit-ca373aaccd276fb412e59557a3971a8d06ada0f8.tar.gz
unit-ca373aaccd276fb412e59557a3971a8d06ada0f8.tar.bz2
Router: client IP address replacement.
This commit introduces the replacement of the client address based on the value of a specified HTTP header. This is intended for use when Unit is placed behind a reverse proxy like nginx or a CDN. You must specify the source addresses of the trusted proxies. This can be accomplished with any valid IP pattern supported by Unit's match block: ["10.0.0.1", "10.4.0.0/16", "!192.168.1.1"] The feature is configured per listener. The client address replacement functionality only operates when there is a source IP match and the specified header is present. Typically this would be an 'X-Forwarded-For' header. { "listeners": { "127.0.0.1:8080": { "client_ip": { "header": "X-Forwarded-For", "source": [ "10.0.0.0/8" ] }, "pass": "applications/my_app" }, } } If a request occurs and Unit receives a header like below: "X-Forwarded-For: 84.123.23.23" By default, Unit trusts the last rightmost IP in the header, so REMOTE_ADDR will be set to 84.123.23.23 if the connection originated from 10.0.0.0/8. If Unit runs behind consecutive reverse proxies and receives a header similar to the following: "X-Forwarded-For: 84.123.23.23, 10.0.0.254" You will need to enable "recursive" checking, which walks the header from last address to first and chooses the first non-trusted address it finds. { "listeners": { "127.0.0.1:8080": { "client_ip": { "header": "X-Forwarded-For", "source": [ "10.0.0.0/8" ] "recursive": true, }, "pass": "applications/my_app" }, } } If a connection from 10.0.0.0/8 occurs, the chain is walked. Here, 10.0.0.254 is also a trusted address so the client address will be replaced with 84.123.23.23. If all IP addresses in the header are trusted, the client address is set to the first address in the header: If 10.0.0.0/8 is trusted and "X-Forwarded-For: 10.0.0.3, 10.0.0.2, 10.0.0.1", the client address will be replaced with 10.0.0.3.
Diffstat (limited to 'docs/changes.xml')
-rw-r--r--docs/changes.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/changes.xml b/docs/changes.xml
index e183f907..56dfa038 100644
--- a/docs/changes.xml
+++ b/docs/changes.xml
@@ -49,6 +49,12 @@ application restart control.
</para>
</change>
+<change type="feature">
+<para>
+client IP address replacement from specified HTTP header field.
+</para>
+</change>
+
<change type="bugfix">
<para>
TLS connection was rejected for configuration with more than one