Proxy Protocol Filter

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/filter/listener/proxy_protocol/v2/proxy_protocol.proto

This extension may be referenced by the qualified name envoy.filters.listener.proxy_protocol

Note

This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted.

Tip

This extension extends and can be used with the following extension category:

PROXY protocol listener filter.

extensions.filters.listener.proxy_protocol.v3.ProxyProtocol

{
  "rules": []
}

rules

{
  "metadata_namespace": "...",
  "key": "..."
}

metadata_namespace

(string) The namespace — if this is empty, the filter’s namespace will be used.

key

(string, REQUIRED) The key to use within the namespace.

A Rule defines what metadata to apply when a header is present or missing.

{
  "tlv_type": "...",
  "on_tlv_present": "{...}"
}

tlv_type

(uint32) The type that triggers the rule - required TLV type is defined as uint8_t in proxy protocol. See the spec for details.

on_tlv_present