Listener components

Listener components

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:

api/v2/listener/listener_components.proto

config.listener.v3.Filter

{
  "name": "...",
  "typed_config": "{...}"
}

name

(string, REQUIRED) The name of the filter configuration.

typed_config

(Any) Filter specific configuration which depends on the filter being instantiated. See the supported filters for further documentation.

Tip

This extension category has the following known extensions:

The following extensions are available in contrib images only:

config.listener.v3.FilterChainMatch

[config.listener.v3.FilterChainMatch proto]

Specifies the match criteria for selecting a specific filter chain for a listener.

In order for a filter chain to be selected, ALL of its criteria must be fulfilled by the incoming connection, properties of which are set by the networking stack and/or listener filters.

The following order applies:

Destination port.
Destination IP address.
Server name (e.g. SNI for TLS protocol),
Transport protocol.
Application protocols (e.g. ALPN for TLS protocol).
Directly connected source IP address (this will only be different from the source IP address when using a listener filter that overrides the source address, such as the Proxy Protocol listener filter).
Source type (e.g. any, local or external network).
Source IP address.
Source port.

For criteria that allow ranges or wildcards, the most specific value in any of the configured filter chains that matches the incoming connection is going to be used (e.g. for SNI www.example.com the most specific match would be www.example.com, then *.example.com, then *.com, then any filter chain without server_names requirements).

A different way to reason about the filter chain matches: Suppose there exists N filter chains. Prune the filter chain set using the above 8 steps. In each step, filter chains which most specifically matches the attributes continue to the next step. The listener guarantees at most 1 filter chain is left after all of the steps.

Example:

For destination port, filter chains specifying the destination port of incoming traffic are the most specific match. If none of the filter chains specifies the exact destination port, the filter chains which do not specify ports are the most specific match. Filter chains specifying the wrong port can never be the most specific match.

{
  "destination_port": "{...}",
  "prefix_ranges": [],
  "direct_source_prefix_ranges": [],
  "source_type": "...",
  "source_prefix_ranges": [],
  "source_ports": [],
  "server_names": [],
  "transport_protocol": "...",
  "application_protocols": []
}

destination_port

(UInt32Value) Optional destination port to consider when use_original_dst is set on the listener in determining a filter chain match.

prefix_ranges

(repeated config.core.v3.CidrRange) If non-empty, an IP address and prefix length to match addresses when the listener is bound to 0.0.0.0/:: or when use_original_dst is specified.

direct_source_prefix_ranges

(repeated config.core.v3.CidrRange) The criteria is satisfied if the directly connected source IP address of the downstream connection is contained in at least one of the specified subnets. If the parameter is not specified or the list is empty, the directly connected source IP address is ignored.

source_type

(config.listener.v3.FilterChainMatch.ConnectionSourceType) Specifies the connection source IP match type. Can be any, local or external network.

source_prefix_ranges

(repeated config.core.v3.CidrRange) The criteria is satisfied if the source IP address of the downstream connection is contained in at least one of the specified subnets. If the parameter is not specified or the list is empty, the source IP address is ignored.

source_ports

(repeated uint32) The criteria is satisfied if the source port of the downstream connection is contained in at least one of the specified ports. If the parameter is not specified, the source port is ignored.

server_names

(repeated string) If non-empty, a list of server names (e.g. SNI for TLS protocol) to consider when determining a filter chain match. Those values will be compared against the server names of a new connection, when detected by one of the listener filters.

The server name will be matched against all wildcard domains, i.e. www.example.com will be first matched against www.example.com, then *.example.com, then *.com.

Note that partial wildcards are not supported, and values like *w.example.com are invalid.

Attention

See the FAQ entry on how to configure SNI for more information.

transport_protocol

(string) If non-empty, a transport protocol to consider when determining a filter chain match. This value will be compared against the transport protocol of a new connection, when it’s detected by one of the listener filters.

Suggested values include:

raw_buffer - default, used when no transport protocol is detected,
tls - set by envoy.filters.listener.tls_inspector when TLS protocol is detected.

application_protocols

(repeated string) If non-empty, a list of application protocols (e.g. ALPN for TLS protocol) to consider when determining a filter chain match. Those values will be compared against the application protocols of a new connection, when detected by one of the listener filters.

Suggested values include:

http/1.1 - set by envoy.filters.listener.tls_inspector,
h2 - set by envoy.filters.listener.tls_inspector

Attention

Currently, only TLS Inspector provides application protocol detection based on the requested ALPN values.

However, the use of ALPN is pretty much limited to the HTTP/2 traffic on the Internet, and matching on values other than h2 is going to lead to a lot of false negatives, unless all connecting clients are known to use ALPN.

Enum config.listener.v3.FilterChainMatch.ConnectionSourceType

[config.listener.v3.FilterChainMatch.ConnectionSourceType proto]

ANY

(DEFAULT) ⁣Any connection source matches.

SAME_IP_OR_LOOPBACK

⁣Match a connection originating from the same host.

EXTERNAL

⁣Match a connection originating from a different host.

config.listener.v3.FilterChain

[config.listener.v3.FilterChain proto]

A filter chain wraps a set of match criteria, an option TLS context, a set of filters, and various other parameters.

{
  "filter_chain_match": "{...}",
  "filters": [],
  "use_proxy_proto": "{...}",
  "transport_socket": "{...}",
  "transport_socket_connect_timeout": "{...}",
  "name": "..."
}

filter_chain_match

(config.listener.v3.FilterChainMatch) The criteria to use when matching a connection to this filter chain.

filters

(repeated config.listener.v3.Filter) A list of individual network filters that make up the filter chain for connections established with the listener. Order matters as the filters are processed sequentially as connection events happen. Note: If the filter list is empty, the connection will close by default.

use_proxy_proto

(BoolValue) Whether the listener should expect a PROXY protocol V1 header on new connections. If this option is enabled, the listener will assume that that remote address of the connection is the one specified in the header. Some load balancers including the AWS ELB support this option. If the option is absent or set to false, Envoy will use the physical peer address of the connection as the remote address.

This field is deprecated. Add a PROXY protocol listener filter explicitly instead.

transport_socket

(config.core.v3.TransportSocket) Optional custom transport socket implementation to use for downstream connections. To setup TLS, set a transport socket with name envoy.transport_sockets.tls and DownstreamTlsContext in the typed_config. If no transport socket configuration is specified, new connections will be set up with plaintext.

Tip

This extension category has the following known extensions:

transport_socket_connect_timeout

(Duration) If present and nonzero, the amount of time to allow incoming connections to complete any transport socket negotiations. If this expires before the transport reports connection establishment, the connection is summarily closed.

name

(string) The unique name (or empty) by which this filter chain is known. Note: filter_chain_matcher requires that filter chains are uniquely named within a listener.

Warning

This API feature is currently work-in-progress. API features marked as work-in-progress are not considered stable, are not covered by the threat model, are not supported by the security team, and are subject to breaking changes. Do not use this feature without understanding each of the previous points.

config.listener.v3.FilterChain.OnDemandConfiguration

[config.listener.v3.FilterChain.OnDemandConfiguration proto]

The configuration for on-demand filter chain. If this field is not empty in FilterChain message, a filter chain will be built on-demand. On-demand filter chains help speedup the warming up of listeners since the building and initialization of an on-demand filter chain will be postponed to the arrival of new connection requests that require this filter chain. Filter chains that are not often used can be set as on-demand.

{
  "rebuild_timeout": "{...}"
}

rebuild_timeout

(Duration) The timeout to wait for filter chain placeholders to complete rebuilding. 1. If this field is set to 0, timeout is disabled. 2. If not specified, a default timeout of 15s is used. Rebuilding will wait until dependencies are ready, have failed, or this timeout is reached. Upon failure or timeout, all connections related to this filter chain will be closed. Rebuilding will start again on the next new connection.

config.listener.v3.ListenerFilterChainMatchPredicate

[config.listener.v3.ListenerFilterChainMatchPredicate proto]

Listener filter chain match configuration. This is a recursive structure which allows complex nested match configurations to be built using various logical operators.

Examples:

Matches if the destination port is 3306.

destination_port_range:
 start: 3306
 end: 3307

Matches if the destination port is 3306 or 15000.

or_match:
  rules:
    - destination_port_range:
        start: 3306
        end: 3307
    - destination_port_range:
        start: 15000
        end: 15001

{
  "or_match": "{...}",
  "and_match": "{...}",
  "not_match": "{...}",
  "any_match": "...",
  "destination_port_range": "{...}"
}

or_match

(config.listener.v3.ListenerFilterChainMatchPredicate.MatchSet) A set that describes a logical OR. If any member of the set matches, the match configuration matches.

Precisely one of or_match, and_match, not_match, any_match, destination_port_range must be set.

and_match

(config.listener.v3.ListenerFilterChainMatchPredicate.MatchSet) A set that describes a logical AND. If all members of the set match, the match configuration matches.

Precisely one of or_match, and_match, not_match, any_match, destination_port_range must be set.

not_match

(config.listener.v3.ListenerFilterChainMatchPredicate) A negation match. The match configuration will match if the negated match condition matches.

Precisely one of or_match, and_match, not_match, any_match, destination_port_range must be set.

any_match

(bool) The match configuration will always match.

Precisely one of or_match, and_match, not_match, any_match, destination_port_range must be set.

destination_port_range

(type.v3.Int32Range) Match destination port. Particularly, the match evaluation must use the recovered local port if the owning listener filter is after an original_dst listener filter.

Precisely one of or_match, and_match, not_match, any_match, destination_port_range must be set.

config.listener.v3.ListenerFilterChainMatchPredicate.MatchSet

[config.listener.v3.ListenerFilterChainMatchPredicate.MatchSet proto]

A set of match configurations used for logical operations.

{
  "rules": []
}

rules

(repeated config.listener.v3.ListenerFilterChainMatchPredicate, REQUIRED) The list of rules that make up the set.

config.listener.v3.ListenerFilter

[config.listener.v3.ListenerFilter proto]

{
  "name": "...",
  "typed_config": "{...}",
  "filter_disabled": "{...}"
}

name

(string, REQUIRED) The name of the filter configuration.

typed_config

(Any) Filter specific configuration which depends on the filter being instantiated. See the supported filters for further documentation.

Tip

This extension category has the following known extensions:

Tip

This extension category has the following known extensions:

filter_disabled

(config.listener.v3.ListenerFilterChainMatchPredicate) Optional match predicate used to disable the filter. The filter is enabled when this field is empty. See ListenerFilterChainMatchPredicate for further examples.