Proxy Protocol Filter

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.

PROXY protocol listener filter.

extensions.filters.listener.proxy_protocol.v3.ProxyProtocol

[extensions.filters.listener.proxy_protocol.v3.ProxyProtocol proto]

{
  "rules": []
}
rules

(repeated extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule) The list of rules to apply to requests.

extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair

[extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair proto]

{
  "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.

extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule

[extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule proto]

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

(extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair) If the TLV type is present, apply this metadata KeyValuePair.