IP Transparency¶

What is IP Transparency¶

As a proxy, Envoy is an IP endpoint: it has its own IP address, distinct from that of any downstream requests. Consequently, when Envoy establishes connections to upstream hosts, the IP address of that connection will be different from that of any proxied connections.

Sometimes the upstream server or network may need to know the original IP address of the connection, called the downstream remote address, for many reasons. Some examples include:

the IP address being used to form part of an identity,
the IP address being used to enforce network policy, or
the IP address being included in an audit.

Envoy supports multiple methods for providing the downstream remote address to the upstream host. These techniques vary in complexity and applicability.

Envoy also supports extensions for detecting the original IP address. This might be useful if none of the techniques below is applicable to your setup. Two available extensions are the custom header extension and the xff extension.

HTTP Headers¶

HTTP headers may carry the original IP address of the request in the x-forwarded-for header. The upstream server can use this header to determine the downstream remote address. Envoy may also use this header to choose the IP address used by the Original Src HTTP Filter.

The HTTP header approach has a few downsides:

It is only applicable to HTTP.
It may not be supported by the upstream host.
It requires careful configuration.

Proxy Protocol¶

HAProxy Proxy Protocol defines a protocol for communicating metadata about a connection over TCP, prior to the main TCP stream. This metadata includes the source IP. Envoy supports consuming this information using Proxy Protocol filter, which may be used to recover the downstream remote address for propagation into an x-forwarded-for header. It can also be used in conjunction with the Original Src Listener Filter. Finally, Envoy supports generating this header using the Proxy Protocol Transport Socket.

Here is an example config for setting up the socket:

clusters:
- name: service1
  connect_timeout: 0.25s
  type: strict_dns
  lb_policy: round_robin
  transport_socket:
    name: envoy.transport_sockets.upstream_proxy_protocol
    typed_config:
      "@type": type.googleapis.com/envoy.extensions.transport_sockets.proxy_protocol.v3.ProxyProtocolUpstreamTransport
      config:
        version: V1
      transport_socket:
        name: envoy.transport_sockets.raw_buffer
  ...

There are several things to consider if you plan to use this socket in conjunction with the HTTP connection manager. There will be a performance hit as there will be no upstream connection re-use among downstream clients. Every client that connects to Envoy will get a new connection to the upstream server. This is due to the nature of proxy protocol being a connection based protocol. Downstream client info is only forwarded to the upstream at the start of a connection before any other data has been sent (Note: this includes before a TLS handshake occurs). If possible, using the x-forwarded-for header should be preferred as Envoy will be able to re-use upstream connections with this method. Due to the disconnect between Envoy’s handling of downstream and upstream connections, it is a good idea to enforce short idle timeouts on upstream connections as Envoy will not inherently close a corresponding upstream connection when a downstream connection is closed.

Some drawbacks to Proxy Protocol:

It only supports TCP protocols.
It requires upstream host support.

Original Source Listener Filter¶

In controlled deployments, it may be possible to replicate the downstream remote address on the upstream connection by using a Original Source listener filter. No metadata is added to the upstream request or stream. Rather, the upstream connection itself will be established with the downstream remote address as its source address. This filter will work with any upstream protocol or host. However, it requires fairly complex configuration, and it may not be supported in all deployments due to routing constraints.

Some drawbacks to the Original Source filter:

It requires that Envoy have access to the downstream remote address.
Its configuration is relatively complex.
It may introduce a slight performance hit due to restrictions on connection pooling.
Not supported on Windows.

Original Source HTTP Filter¶

In controlled deployments, it may be possible to replicate the downstream remote address on the upstream connection by using a Original Source HTTP filter. This filter operates much like the Original Src Listener Filter. The main difference is that it can infer the original source address from HTTP headers, which is important for cases where a single downstream connection carries multiple HTTP requests from different original source addresses. Deployments with a front proxy forwarding to sidecar proxies are examples where case applies.

This filter will work with any upstream HTTP host. However, it requires fairly complex configuration, and it may not be supported in all deployments due to routing constraints.

Some drawbacks to the Original Source filter:

It requires that Envoy be properly configured to extract the downstream remote address from the x-forwarded-for header.
Its configuration is relatively complex.
It may introduce a slight performance hit due to restrictions on connection pooling.

Note

This feature is not supported on Windows.