Using the Proxy protocol v2 with Load Balancer

• compute
• Proxy-Protocol
• IP
• Load-Balancer

Proxy Protocol V2 Overview

The PROXY Protocol allows an application, like a web server such as Apache or Nginx, to retrieve client information of a user passing via a load balanced infrastructure.

The protocol transports connection information including the originating IP address, the proxy server IP address, and both ports.

This information can be useful for automatic delivery of localized contents, blacklisting of abusive users or for logging purposes.

When using a Load Balancer in front of your web servers, the load balancer’s IP address is passed by default to your web servers. This result is visible in the access log files of the web server:

51.159.26.16 - - [28/Jun/2019:13:42:25 +0000] "GET /favicon.ico HTTP/1.1" 200 26066 "http://example.com/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
51.159.26.16 - - [28/Jun/2019:13:42:25 +0000] "GET / HTTP/1.1" 200 26099 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
51.159.26.16 - - [28/Jun/2019:13:42:26 +0000] "GET /favicon.ico HTTP/1.1" 200 26068 "http://example.com/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
51.159.26.16 - - [28/Jun/2019:13:42:49 +0000] "GET / HTTP/1.1" 200 26022 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.1 Safari/605.1.15"
Copy code

Only the IP 51.159.26.16 is visible in the log file, which is the Load Balancer’s IP address and not the IP of the different users.

Enabling PROXY Protocol

You can enable proxy for your Load Balancer in two ways through the Scaleway console:

1. Two options:
   • Option 1: Configure backend rules upon creating your Load Balancer.
   • Option 2: Click «Edit Icon», in the Backend tab of an existing Load Balancer.
2. Select a proxy option from the drop-down menu.
   

Configuring Proxy Protocol in Nginx Web Server

The proxy_protocol parameter must be set within the http {} block of the listen directive of a server block to configure NGINX to accept PROXY protocol headers.

1. Make sure that Nginx is installed with the http_realip_module. This is the case in the precompiled version that is delivered with Ubuntu Bionic Beaver (18.04).

   nginx -V 2>&1 | grep -- 'http_realip_module'
   Copy code

2. Open the configuration file of nginx, i.e. /etc/nginx/nginx.conf in a text editor, for example, nano:

   nano /etc/nginx/nginx.conf
   Copy code

3. Enable the proxy_protocol by adding/modifying the following lines in the server {} block:

   server {
       ...
       listen 80   proxy_protocol;
       listen 443  ssl proxy_protocol;
       ...
       }
   Copy code

4. Set the IP address of the Load Balancer with the set_real_ip_from directive in the server {} block:

   set_real_ip_from 51.159.26.16;
   Copy code

5. To change the IP address of the Load Balancer to the clients IP address, received from the PROXY protocol header, specify in the server {} block the proxy_protocol parameter to the real_ip_header directive:

   real_ip_header proxy_protocol;
   Copy code

6. As the clients IP address is now known to Nginx, configure the correct logging of it. Set the proxy_set_header directive with the $proxy_protocol_addr variable in the http {} block:

   http {
       proxy_set_header X-Real-IP       $proxy_protocol_addr;
       proxy_set_header X-Forwarded-For $proxy_protocol_addr;
   }
   Copy code

7. Configure the $proxy_protocol_addr variable to the log_format directive in the http block:

   http {
       #...
       log_format logs '$proxy_protocol_addr - $remote_user [$time_local] '
                           '"$request" $status $body_bytes_sent '
                           '"$http_referer" "$http_user_agent"';
   }
   Copy code

8. The configuration file should look like the following example:

   http {
       proxy_set_header X-Real-IP       $proxy_protocol_addr;
       proxy_set_header X-Forwarded-For $proxy_protocol_addr;
   
       log_format logs '$proxy_protocol_addr - $remote_user [$time_local] '
                           '"$request" $status $body_bytes_sent '
                           '"$http_referer" "$http_user_agent"';
       #...
   
       server {
           server_name example.com;
   
           listen 80   proxy_protocol;
   
           set_real_ip_from 51.159.26.16;
           real_ip_header proxy_protocol;
   
           #...
         }
     }
   Copy code

9. Save the configuration file, exit the editor, and test the syntax of the file:

   nginx -t
   Copy code

10. Restart Nginx:

    systemctl restart nginx.service
    Copy code

    195.154.228.158 - - [28/Jun/2019:15:44:23 +0000] "GET /favicon.ico HTTP/1.1" 200 26062 "http://51.159.26.16/index.php" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
    51.159.26.16 - - [28/Jun/2019:15:44:31 +0000] "GET /index.php HTTP/1.1" 200 26100 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
    195.154.228.158 - - [28/Jun/2019:15:44:32 +0000] "GET /favicon.ico HTTP/1.1" 200 26065 "http://51.159.26.16/index.php" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
    51.159.26.16 - - [28/Jun/2019:15:44:50 +0000] "GET /index.php HTTP/1.1" 200 26097 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
    Copy code

    Important:

    Once ProxyProtocol is enabled the Nginx virtual host will no longer accept direct connections.

Configuring Proxy Protocol in Apache Web Server

The Proxy Protocol support in Apache is still in an early stage. It is currently not natively supported with the Apache version provided by Ubuntu. An unofficial plugin is available for Apache versions prior to 2.4.30. To use it, follow these steps:

1. Download and install the required software components:

   apt install git apache2-dev
   Copy code

2. Download the sources of the plugin and enter their directory:

   git clone https://github.com/roadrunner2/mod-proxy-protocol.git
   cd mod-proxy-protocol
   Copy code

3. Build the plugin:

   apxs -i -a -c mod_proxy_protocol.c
   Copy code

4. Activate the module in the configuration of the virtual host:

   <VirtualHost *:80>
       ...
       ProxyProtocol On
       ...
   </VirtualHost>
   Copy code

5. Replace all %h by %a of the LogFormat directives in the Apache configuration file (/etc/apache2/apache2.conf):

   LogFormat "%v:%p %h %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combined
   LogFormat "%a %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" combined
   LogFormat "%a %l %u %t \"%r\" %>s %O" common
   LogFormat "%{Referer}i -> %U" referer
   LogFormat "%{User-agent}i" agent
   Copy code

6. Restart Apache to activate the new configuration:

   apache2ctl restart
   Copy code

   Important:

   Once ProxyProtocol is enabled the Apache virtual host will no longer accept direct connections.

Configuring Proxy Protocol in Apache with mod_remoteip

1. Enable the module remoteip:

   a2enmod remoteip
   Copy code

2. Configure the Apache virtual host configuration:

   <VirtualHost *:80>
       ...
       RemoteIPProxyProtocol On
       ...
   </VirtualHost>
   Copy code

3. Restart the Apache web server:

   apache2ctl restart
   Copy code