This was suppose to be 10 minutes fix..
Or so I thought. If you read my blog you probably know that for the most part I’m doing operations stuff for FastCompany. That means sometimes I deal with little tricky problems like the one I’m going to talk about today.
CDN, HEADERS and IPs
After recent switch to a new CDN provider, we discovered wrong Client IP address in our Nginx access logs. I started debugging process by taking sample of the headers with tcpdump ( quite useful for this sort of stuff! ) on one of the of the Nginx router boxes.
sudo tcpdump -A -vvvv -s 9999 -i eth0 port 80 > /tmp/sample
Here is part of packet:
X-Geo: US X-Real-IP: 188.8.131.52 X-Timer: S1398278909.637000322,VS0,VS3 X-Varnish: 58497648 X-Varnish: 506864951 X-Varnish: 2932897992 X-Varnish: 1531049198 X-Forwarded-For: 184.108.40.206, 220.127.116.11, 18.104.22.168 X-Forwarded-Port: 80 X-Forwarded-Proto: http
I would like us to focus on two headers from this sample X-Real-IP and X-Forwarded-For. It turns out our CDN provider was passing Client-IP in both of them, but in our Nginx access logs we saw 22.214.171.124 (last IP of the X-Forwarded-For).
Turns out there is not much information or specifications about those X- headers, but I found out that:
- X-Forwarded-For is usually used by proxies to carry original Client IP through intermediary hops. Otherwords each time request goes through proxy, it should add current request IP to the list. More details here. The format should look like this pretty much:
X-Forwarded-For: client, proxy1, proxy2
There is one problem though (as with many standards implementations) it’s not mandatory to use, meaning some proxies will add the header and some will not.. And it’s quite easy to spoof as well. Let say you want to hide your real IP – to do that you can just send a request with
X-Forwarded-For: spoofand proxy will gladly add request IP to the list. The result will look like this
X-Forwarded-For: spoof realip. As you can see, you can’t just extract leftmost IP, because it might be forged (you also need to keep that in mind if you are using that X-Forwarded-For in the application for some kind of IP based logic).
- X-Real-IP to be honest, I didn’t find any good info or specs about this one.. Looking through numerous blog posts about passing true Client IP to the backend it seem like it’s common to set both X-Real-IP and X-Forwarded-For. Anyways if you know more about the history of this header, you are more than welcomed to do it in the comments section below.
Nginx time to shine
At this point we have both X-Forwarded-For and X-Real-IP in the request headers (and both contain precious Client-IP, well to be honest, you cant 100% say what’s real client IP, because packets travel through many proxies between client and us. I guess that’s another story) but Nginx uses current request IP.
To change that behaviour we need to use Nginx real_ip module (I don’t think it’s compiled by default). The module exposes couple control knobs which we can use to alter client IP.
If you look at the documentation of the module, you will notice that by default Nginx will use X-Real-IP header (
real_ip_header) if it’s present in the request. Since we have Client IP set by CDN to be X-Real-IP, there is no need to do anything else and we should see correct IP in the logs after enabling the module.
There are couple other important things though:
set_real_ip_from (set addresses allowed to influence client IP change) and
Lets talk about second one. Since Nginx (whith real_ip module) provides a way to extract client IP from X-Forwarded-For it’s common to see
real_ip_header set to X-Forwarded-For, but if you won’t enable
real_ip_recursive, you will get rightmost IP inetead of lefmost.. Here is super useful ServerFault post describing the problem and solution.
If you are lazy to read, I’ll summarize – in order to protect yourself from IP spoof, and get REAL CLIENT IP (Morpheus: How do you define ‘real’?) you need to enable
real_ip_recursive and set known proxies using
set_real_ip_from. Nginx will remove IPs matching known proxies and then use rightmost IP which should be the IP you are looking for!
Related story: Nginx server_name and how it works?
2 thoughts on “Story behind X-Forwarded-For and X-Real-IP headers”
I have to add x-forward-for and x-real-ip to our nginx.conf. i have never used nginx or these specific features. Can you share the exact syntax for each? I have
Proxy_set_header x-real-ip $remote_addr;
Proxy_set_header x-forward-for $proxy_add_x_forwarder_for;
Its a bit unclear why you have to add those headers, but in any case you need real_ip nginx module in order to extract and pass down correct ip.
Here is the example:
which basically says to use X-Forwarded-For as the main header to determine client ip and then set known proxies with set_real_ip_from that way those ips will be removed during client_ip calculation.
It also depends on what you have coming in the request, whether u are sitting behind system (like CDN) that sets those headers already… Hard to give any specific advice in your case as it’s unclear what you are trying to achieve.