Forward real IP to a NGINX behind a GCP Load Balancer
This article focuses in GCP Load Balancers, but can apply to other cloud providers / proxy servers.
We worked in a project that required a nginx server to be able to whitelist some public ip addresses while denying all other connections. While this can be addressed using GCP firewall rules there were some other reasons why it was necessary to be done through nginx configuration instead of using GCP rules.
The problem is that nginx was not showing the correct real ip address of the request in the REMOTE_ADDR header.
22.214.171.124 - - [23/Jan/2020:09:44:51 +0000] "GET / HTTP/1.1" 404 "126.96.36.199, 188.8.131.52"
I’ll be using a very simple scenario:
- Google Compute private instance running two docker containers: nginx and a php based app
- Public GCP Load Balancer targeting the nginx container.
Fake IP addresses used in this post:
- User originating requests: 184.108.40.206
- GCP Load Balancer public IP: 220.127.116.11
- GCP Load Balancer private ranges: 18.104.22.168/22 and 22.214.171.124/16
Let’s quickly review how a Load Balancer works: When a request is received from a remote client it is terminated and a new request is issued from the LB against the backend, forwarding a set of headers (click on GCP and AWS for specific details) that are then catched by the underlying service.
When you place a nginx server behind the LB you receive the Load Balancer’s private IP as remote address instead of the user’s real public ip.
If we take a look at nginx logs we can see this:
126.96.36.199 - - [23/Jan/2020:09:02:51 +0000] "GET / HTTP/1.1" 200 "188.8.131.52, 184.108.40.206"
Wait! The user IP address appears in that chain at the end of the log. Why the heck is nginx taking the private range of the LB as the origin ip address? Well, this is because the LB is actually doing a new request.
How did we solve the issue
The first IP in the log comes from the REMOTE_ADDR header. We need to replace the value of this header with the real ip address received in the X-Forwarded-For header.
But there’s something else we need to deal with this second header: It actually comes not only with the user real IP but with the Load Balancer public address too.
In order to solve all this we will use the real_ip module. We are going to apply the following configuration in nginx.conf inside the “server” block:
set_real_ip_from 220.127.116.11/32; // LB Public IP address set_real_ip_from 18.104.22.168/22; // Private IP range for GCP Load Balancers set_real_ip_from 22.214.171.124/16; //Private IP range for GCP Load Balancers real_ip_header X-Forwarded-For; real_ip_recursive on;
Let’s split it down:
- set_real_ip_from: Tell nginx to trust GCP LB public and private IPs.
- real_ip_header: Replace REMOTE_ADDR header with the values from X-Forwarded-For.
- real_ip_recursive on: Filter out the trusted ips from the chain, therefore the last non-trusted address in the chain will be used as the remote address.
Finally test it out:
126.96.36.199 - - [23/Jan/2020:09:44:51 +0000] "GET / HTTP/1.1" 200 "188.8.131.52, 184.108.40.206"
As we can see the solution was pretty straight forward, but still it took some time diving into documentation to understand how the Load Balancer was forwarding the headers and how we can tune nginx to rewrite the headers in order to achieve the expected behaviour.
Nevertheless it was a good learning experience.