Golang network filter (proto)

This extension has the qualified name envoy.filters.network.golang

Note

This extension is only available in contrib images.

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension is not hardened and should only be used in deployments where both the downstream and upstream are trusted.

Tip

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

• envoy.filters.network

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.

Golang network filter configuration overview.

extensions.filters.network.golang.v3alpha.Config

[extensions.filters.network.golang.v3alpha.Config proto]

{
  "is_terminal_filter": ...,
  "library_id": ...,
  "library_path": ...,
  "plugin_name": ...,
  "plugin_config": {...}
}

is_terminal_filter

(bool) Bool true if this filter must be the last filter in a filter chain, false otherwise.

library_id

(string, REQUIRED) Globally unique ID for a dynamic library file.

library_path

(string, REQUIRED) Path to a dynamic library implementing the DownstreamFilter API interface.

plugin_name

(string, REQUIRED) Globally unique name of the Go plugin.

This name must be consistent with the name registered in network::RegisterNetworkFilterConfigFactory

plugin_config

(Any) Configuration for the Go plugin.

Note

This configuration is only parsed in the go plugin, and is therefore not validated by Envoy.

See the DownstreamFilter API for more information about how the plugin’s configuration data can be accessed.