The Ultimate Guide to High Availability with MariaDB

Proxy protocol support

You are viewing an old version of this article. View the current version here.

Starting with version 10.3, MariaDB server supports proxy protocol .

The proxy protocol allows proxy programs to relay the IP of the clients to the server programs. It is important in case of MariaDB, since IP information is actually a part of user identity.

How proxy protocol works.

As per proxy protocol specification, connecting client can prefix its first packet with a proxy protocol header. Server will parse the header and assume client's IP address is the one set in the proxy header

For example, if client send proxy header (V1, text) which is "PROXY TCP4 192.168.0.1 192.168.0.11 56324 443\r\n", server after parsing assumes client's IP is 192.168.0.1

MariaDB server understands both Version 1 (text) and Version 2(binary) of the proxy header.

Enabling proxy protocol in MariaDB

To enable use of the proxy protocol, it is necessary to specify subnetworks that are allowed to send proxy header, using proxy-protocol-networks server variable.

proxy-protocol-networks is a either comma-separated list of (sub)networks or IP addresses. One also can use 'localhost' in this list, which means unix domain socket/named pipe/shared memory connections are allowed as well. Or, proxy-protocol-networks can be set to * , meaning that proxy header is allowed from any client. * should be used with extreme care, it might have security implication.

Example in my.ini/my.cnf

proxy-protocol-networks=::1, 192.168.0.0/16 ,localhost

allows IPv6 connection from local machine ::1, from IP addresses starting with 192.128, and from connections made with unix domain socket or named pipe

Client support

Since the functionality is suited only to very specific proxy-like programs, most client APIs do not provide support for sending proxy headers. One exception is Connector/C version 3 or later. One can now use

mysql_optionsv(mysql, MARIADB_OPT_PROXY_HEADER, header,  header_size)

prior to mysql_real_connect()/mysql_connect() , to send the header. In the call above _header_ is the proxy header withe the type void * , and _header_size_ is its size in bytes (type is size_t)

Example use

const char *hdr="PROXY TCP4 192.168.0.1 192.168.0.11 56324 443\r\n";
mysql_optionsv(mysql, MARIADB_OPT_PROXY_HEADER, hdr,  strlen(hdr));

Comments

Comments loading...
Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.