envoy_api_v2_listener

package
v1.12.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 30, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var FilterChainMatch_ConnectionSourceType_name = map[int32]string{
	0: "ANY",
	1: "LOCAL",
	2: "EXTERNAL",
}
View Source
var FilterChainMatch_ConnectionSourceType_value = map[string]int32{
	"ANY":      0,
	"LOCAL":    1,
	"EXTERNAL": 2,
}

Functions

This section is empty.

Types

type Filter

type Filter struct {
	// The name of the filter to instantiate. The name must match a
	// :ref:`supported filter <config_network_filters>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Filter specific configuration which depends on the filter being
	// instantiated. See the supported filters for further documentation.
	//
	// Types that are valid to be assigned to ConfigType:
	//	*Filter_Config
	//	*Filter_TypedConfig
	ConfigType           isFilter_ConfigType `protobuf_oneof:"config_type"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

func (*Filter) Descriptor

func (*Filter) Descriptor() ([]byte, []int)

func (*Filter) GetConfig deprecated

func (m *Filter) GetConfig() *types.Struct

Deprecated: Do not use.

func (*Filter) GetConfigType

func (m *Filter) GetConfigType() isFilter_ConfigType

func (*Filter) GetName

func (m *Filter) GetName() string

func (*Filter) GetTypedConfig

func (m *Filter) GetTypedConfig() *types.Any

func (*Filter) ProtoMessage

func (*Filter) ProtoMessage()

func (*Filter) Reset

func (m *Filter) Reset()

func (*Filter) String

func (m *Filter) String() string

func (*Filter) XXX_DiscardUnknown

func (m *Filter) XXX_DiscardUnknown()

func (*Filter) XXX_Marshal

func (m *Filter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Filter) XXX_Merge

func (m *Filter) XXX_Merge(src proto.Message)

func (*Filter) XXX_OneofWrappers

func (*Filter) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Filter) XXX_Size

func (m *Filter) XXX_Size() int

func (*Filter) XXX_Unmarshal

func (m *Filter) XXX_Unmarshal(b []byte) error

type FilterChain

type FilterChain struct {
	// The criteria to use when matching a connection to this filter chain.
	FilterChainMatch *FilterChainMatch `protobuf:"bytes,1,opt,name=filter_chain_match,json=filterChainMatch,proto3" json:"filter_chain_match,omitempty"`
	// The TLS context for this filter chain.
	//
	// .. attention::
	//
	//   **This field is deprecated**. Use `transport_socket` with name `tls` instead. If both are
	//   set, `transport_socket` takes priority.
	TlsContext *auth.DownstreamTlsContext `protobuf:"bytes,2,opt,name=tls_context,json=tlsContext,proto3" json:"tls_context,omitempty"` // Deprecated: Do not use.
	// 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.
	Filters []*Filter `protobuf:"bytes,3,rep,name=filters,proto3" json:"filters,omitempty"`
	// 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.
	UseProxyProto *types.BoolValue `protobuf:"bytes,4,opt,name=use_proxy_proto,json=useProxyProto,proto3" json:"use_proxy_proto,omitempty"`
	// [#not-implemented-hide:] filter chain metadata.
	Metadata *core.Metadata `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Optional custom transport socket implementation to use for downstream connections.
	// To setup TLS, set a transport socket with name `tls` and
	// :ref:`DownstreamTlsContext <envoy_api_msg_auth.DownstreamTlsContext>` in the `typed_config`.
	// If no transport socket configuration is specified, new connections
	// will be set up with plaintext.
	TransportSocket *core.TransportSocket `protobuf:"bytes,6,opt,name=transport_socket,json=transportSocket,proto3" json:"transport_socket,omitempty"`
	// [#not-implemented-hide:] The unique name (or empty) by which this filter chain is known. If no
	// name is provided, Envoy will allocate an internal UUID for the filter chain. If the filter
	// chain is to be dynamically updated or removed via FCDS a unique name must be provided.
	Name                 string   `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A filter chain wraps a set of match criteria, an option TLS context, a set of filters, and various other parameters. [#next-free-field: 8]

func (*FilterChain) Descriptor

func (*FilterChain) Descriptor() ([]byte, []int)

func (*FilterChain) GetFilterChainMatch

func (m *FilterChain) GetFilterChainMatch() *FilterChainMatch

func (*FilterChain) GetFilters

func (m *FilterChain) GetFilters() []*Filter

func (*FilterChain) GetMetadata

func (m *FilterChain) GetMetadata() *core.Metadata

func (*FilterChain) GetName

func (m *FilterChain) GetName() string

func (*FilterChain) GetTlsContext deprecated

func (m *FilterChain) GetTlsContext() *auth.DownstreamTlsContext

Deprecated: Do not use.

func (*FilterChain) GetTransportSocket

func (m *FilterChain) GetTransportSocket() *core.TransportSocket

func (*FilterChain) GetUseProxyProto

func (m *FilterChain) GetUseProxyProto() *types.BoolValue

func (*FilterChain) ProtoMessage

func (*FilterChain) ProtoMessage()

func (*FilterChain) Reset

func (m *FilterChain) Reset()

func (*FilterChain) String

func (m *FilterChain) String() string

func (*FilterChain) XXX_DiscardUnknown

func (m *FilterChain) XXX_DiscardUnknown()

func (*FilterChain) XXX_Marshal

func (m *FilterChain) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*FilterChain) XXX_Merge

func (m *FilterChain) XXX_Merge(src proto.Message)

func (*FilterChain) XXX_Size

func (m *FilterChain) XXX_Size() int

func (*FilterChain) XXX_Unmarshal

func (m *FilterChain) XXX_Unmarshal(b []byte) error

type FilterChainMatch

type FilterChainMatch struct {
	// Optional destination port to consider when use_original_dst is set on the
	// listener in determining a filter chain match.
	DestinationPort *types.UInt32Value `protobuf:"bytes,8,opt,name=destination_port,json=destinationPort,proto3" json:"destination_port,omitempty"`
	// 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.
	PrefixRanges []*core.CidrRange `protobuf:"bytes,3,rep,name=prefix_ranges,json=prefixRanges,proto3" json:"prefix_ranges,omitempty"`
	// If non-empty, an IP address and suffix length to match addresses when the
	// listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
	// [#not-implemented-hide:]
	AddressSuffix string `protobuf:"bytes,4,opt,name=address_suffix,json=addressSuffix,proto3" json:"address_suffix,omitempty"`
	// [#not-implemented-hide:]
	SuffixLen *types.UInt32Value `protobuf:"bytes,5,opt,name=suffix_len,json=suffixLen,proto3" json:"suffix_len,omitempty"`
	// Specifies the connection source IP match type. Can be any, local or external network.
	SourceType FilterChainMatch_ConnectionSourceType `` /* 158-byte string literal not displayed */
	// 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.
	SourcePrefixRanges []*core.CidrRange `protobuf:"bytes,6,rep,name=source_prefix_ranges,json=sourcePrefixRanges,proto3" json:"source_prefix_ranges,omitempty"`
	// 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.
	SourcePorts []uint32 `protobuf:"varint,7,rep,packed,name=source_ports,json=sourcePorts,proto3" json:"source_ports,omitempty"`
	// 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 :ref:`FAQ entry <faq_how_to_setup_sni>` on how to configure SNI for more
	//   information.
	ServerNames []string `protobuf:"bytes,11,rep,name=server_names,json=serverNames,proto3" json:"server_names,omitempty"`
	// 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 :ref:`envoy.listener.tls_inspector <config_listener_filters_tls_inspector>`
	//   when TLS protocol is detected.
	TransportProtocol string `protobuf:"bytes,9,opt,name=transport_protocol,json=transportProtocol,proto3" json:"transport_protocol,omitempty"`
	// 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 :ref:`envoy.listener.tls_inspector
	//   <config_listener_filters_tls_inspector>`,
	// * “h2“ - set by :ref:`envoy.listener.tls_inspector <config_listener_filters_tls_inspector>`
	//
	// .. attention::
	//
	//   Currently, only :ref:`TLS Inspector <config_listener_filters_tls_inspector>` provides
	//   application protocol detection based on the requested
	//   `ALPN <https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation>`_ 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.
	ApplicationProtocols []string `protobuf:"bytes,10,rep,name=application_protocols,json=applicationProtocols,proto3" json:"application_protocols,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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:

1. Destination port. 2. Destination IP address. 3. Server name (e.g. SNI for TLS protocol), 4. Transport protocol. 5. Application protocols (e.g. ALPN for TLS protocol). 6. Source type (e.g. any, local or external network). 7. Source IP address. 8. 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).

[#comment: Implemented rules are kept in the preference order, with deprecated fields listed at the end, because that's how we want to list them in the docs.

[#comment:TODO(PiotrSikora): Add support for configurable precedence of the rules] [#next-free-field: 13]

func (*FilterChainMatch) Descriptor

func (*FilterChainMatch) Descriptor() ([]byte, []int)

func (*FilterChainMatch) GetAddressSuffix

func (m *FilterChainMatch) GetAddressSuffix() string

func (*FilterChainMatch) GetApplicationProtocols

func (m *FilterChainMatch) GetApplicationProtocols() []string

func (*FilterChainMatch) GetDestinationPort

func (m *FilterChainMatch) GetDestinationPort() *types.UInt32Value

func (*FilterChainMatch) GetPrefixRanges

func (m *FilterChainMatch) GetPrefixRanges() []*core.CidrRange

func (*FilterChainMatch) GetServerNames

func (m *FilterChainMatch) GetServerNames() []string

func (*FilterChainMatch) GetSourcePorts

func (m *FilterChainMatch) GetSourcePorts() []uint32

func (*FilterChainMatch) GetSourcePrefixRanges

func (m *FilterChainMatch) GetSourcePrefixRanges() []*core.CidrRange

func (*FilterChainMatch) GetSourceType

func (*FilterChainMatch) GetSuffixLen

func (m *FilterChainMatch) GetSuffixLen() *types.UInt32Value

func (*FilterChainMatch) GetTransportProtocol

func (m *FilterChainMatch) GetTransportProtocol() string

func (*FilterChainMatch) ProtoMessage

func (*FilterChainMatch) ProtoMessage()

func (*FilterChainMatch) Reset

func (m *FilterChainMatch) Reset()

func (*FilterChainMatch) String

func (m *FilterChainMatch) String() string

func (*FilterChainMatch) XXX_DiscardUnknown

func (m *FilterChainMatch) XXX_DiscardUnknown()

func (*FilterChainMatch) XXX_Marshal

func (m *FilterChainMatch) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*FilterChainMatch) XXX_Merge

func (m *FilterChainMatch) XXX_Merge(src proto.Message)

func (*FilterChainMatch) XXX_Size

func (m *FilterChainMatch) XXX_Size() int

func (*FilterChainMatch) XXX_Unmarshal

func (m *FilterChainMatch) XXX_Unmarshal(b []byte) error

type FilterChainMatch_ConnectionSourceType

type FilterChainMatch_ConnectionSourceType int32
const (
	// Any connection source matches.
	FilterChainMatch_ANY FilterChainMatch_ConnectionSourceType = 0
	// Match a connection originating from the same host.
	FilterChainMatch_LOCAL FilterChainMatch_ConnectionSourceType = 1
	// Match a connection originating from a different host.
	FilterChainMatch_EXTERNAL FilterChainMatch_ConnectionSourceType = 2
)

func (FilterChainMatch_ConnectionSourceType) EnumDescriptor

func (FilterChainMatch_ConnectionSourceType) EnumDescriptor() ([]byte, []int)

func (FilterChainMatch_ConnectionSourceType) String

type Filter_Config

type Filter_Config struct {
	Config *types.Struct `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}

type Filter_TypedConfig

type Filter_TypedConfig struct {
	TypedConfig *types.Any `protobuf:"bytes,4,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}

type ListenerFilter

type ListenerFilter struct {
	// The name of the filter to instantiate. The name must match a
	// :ref:`supported filter <config_listener_filters>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Filter specific configuration which depends on the filter being instantiated.
	// See the supported filters for further documentation.
	//
	// Types that are valid to be assigned to ConfigType:
	//	*ListenerFilter_Config
	//	*ListenerFilter_TypedConfig
	ConfigType           isListenerFilter_ConfigType `protobuf_oneof:"config_type"`
	XXX_NoUnkeyedLiteral struct{}                    `json:"-"`
	XXX_unrecognized     []byte                      `json:"-"`
	XXX_sizecache        int32                       `json:"-"`
}

func (*ListenerFilter) Descriptor

func (*ListenerFilter) Descriptor() ([]byte, []int)

func (*ListenerFilter) GetConfig deprecated

func (m *ListenerFilter) GetConfig() *types.Struct

Deprecated: Do not use.

func (*ListenerFilter) GetConfigType

func (m *ListenerFilter) GetConfigType() isListenerFilter_ConfigType

func (*ListenerFilter) GetName

func (m *ListenerFilter) GetName() string

func (*ListenerFilter) GetTypedConfig

func (m *ListenerFilter) GetTypedConfig() *types.Any

func (*ListenerFilter) ProtoMessage

func (*ListenerFilter) ProtoMessage()

func (*ListenerFilter) Reset

func (m *ListenerFilter) Reset()

func (*ListenerFilter) String

func (m *ListenerFilter) String() string

func (*ListenerFilter) XXX_DiscardUnknown

func (m *ListenerFilter) XXX_DiscardUnknown()

func (*ListenerFilter) XXX_Marshal

func (m *ListenerFilter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListenerFilter) XXX_Merge

func (m *ListenerFilter) XXX_Merge(src proto.Message)

func (*ListenerFilter) XXX_OneofWrappers

func (*ListenerFilter) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*ListenerFilter) XXX_Size

func (m *ListenerFilter) XXX_Size() int

func (*ListenerFilter) XXX_Unmarshal

func (m *ListenerFilter) XXX_Unmarshal(b []byte) error

type ListenerFilter_Config

type ListenerFilter_Config struct {
	Config *types.Struct `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}

type ListenerFilter_TypedConfig

type ListenerFilter_TypedConfig struct {
	TypedConfig *types.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}

type QuicProtocolOptions

type QuicProtocolOptions struct {
	// Maximum number of streams that the client can negotiate per connection. 100
	// if not specified.
	MaxConcurrentStreams *types.UInt32Value `protobuf:"bytes,1,opt,name=max_concurrent_streams,json=maxConcurrentStreams,proto3" json:"max_concurrent_streams,omitempty"`
	// Maximum number of milliseconds that connection will be alive when there is
	// no network activity. 300000ms if not specified.
	IdleTimeout *types.Duration `protobuf:"bytes,2,opt,name=idle_timeout,json=idleTimeout,proto3" json:"idle_timeout,omitempty"`
	// Connection timeout in milliseconds before the crypto handshake is finished.
	// 20000ms if not specified.
	CryptoHandshakeTimeout *types.Duration `` /* 129-byte string literal not displayed */
	XXX_NoUnkeyedLiteral   struct{}        `json:"-"`
	XXX_unrecognized       []byte          `json:"-"`
	XXX_sizecache          int32           `json:"-"`
}

Configuration specific to the QUIC protocol. Next id: 4

func (*QuicProtocolOptions) Descriptor

func (*QuicProtocolOptions) Descriptor() ([]byte, []int)

func (*QuicProtocolOptions) GetCryptoHandshakeTimeout

func (m *QuicProtocolOptions) GetCryptoHandshakeTimeout() *types.Duration

func (*QuicProtocolOptions) GetIdleTimeout

func (m *QuicProtocolOptions) GetIdleTimeout() *types.Duration

func (*QuicProtocolOptions) GetMaxConcurrentStreams

func (m *QuicProtocolOptions) GetMaxConcurrentStreams() *types.UInt32Value

func (*QuicProtocolOptions) ProtoMessage

func (*QuicProtocolOptions) ProtoMessage()

func (*QuicProtocolOptions) Reset

func (m *QuicProtocolOptions) Reset()

func (*QuicProtocolOptions) String

func (m *QuicProtocolOptions) String() string

func (*QuicProtocolOptions) XXX_DiscardUnknown

func (m *QuicProtocolOptions) XXX_DiscardUnknown()

func (*QuicProtocolOptions) XXX_Marshal

func (m *QuicProtocolOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QuicProtocolOptions) XXX_Merge

func (m *QuicProtocolOptions) XXX_Merge(src proto.Message)

func (*QuicProtocolOptions) XXX_Size

func (m *QuicProtocolOptions) XXX_Size() int

func (*QuicProtocolOptions) XXX_Unmarshal

func (m *QuicProtocolOptions) XXX_Unmarshal(b []byte) error

type UdpListenerConfig

type UdpListenerConfig struct {
	// Used to look up UDP listener factory, matches "raw_udp_listener" or
	// "quic_listener" to create a specific udp listener.
	// If not specified, treat as "raw_udp_listener".
	UdpListenerName string `protobuf:"bytes,1,opt,name=udp_listener_name,json=udpListenerName,proto3" json:"udp_listener_name,omitempty"`
	// Used to create a specific listener factory. To some factory, e.g.
	// "raw_udp_listener", config is not needed.
	//
	// Types that are valid to be assigned to ConfigType:
	//	*UdpListenerConfig_Config
	//	*UdpListenerConfig_TypedConfig
	ConfigType           isUdpListenerConfig_ConfigType `protobuf_oneof:"config_type"`
	XXX_NoUnkeyedLiteral struct{}                       `json:"-"`
	XXX_unrecognized     []byte                         `json:"-"`
	XXX_sizecache        int32                          `json:"-"`
}

func (*UdpListenerConfig) Descriptor

func (*UdpListenerConfig) Descriptor() ([]byte, []int)

func (*UdpListenerConfig) GetConfig

func (m *UdpListenerConfig) GetConfig() *types.Struct

func (*UdpListenerConfig) GetConfigType

func (m *UdpListenerConfig) GetConfigType() isUdpListenerConfig_ConfigType

func (*UdpListenerConfig) GetTypedConfig

func (m *UdpListenerConfig) GetTypedConfig() *types.Any

func (*UdpListenerConfig) GetUdpListenerName

func (m *UdpListenerConfig) GetUdpListenerName() string

func (*UdpListenerConfig) ProtoMessage

func (*UdpListenerConfig) ProtoMessage()

func (*UdpListenerConfig) Reset

func (m *UdpListenerConfig) Reset()

func (*UdpListenerConfig) String

func (m *UdpListenerConfig) String() string

func (*UdpListenerConfig) XXX_DiscardUnknown

func (m *UdpListenerConfig) XXX_DiscardUnknown()

func (*UdpListenerConfig) XXX_Marshal

func (m *UdpListenerConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UdpListenerConfig) XXX_Merge

func (m *UdpListenerConfig) XXX_Merge(src proto.Message)

func (*UdpListenerConfig) XXX_OneofWrappers

func (*UdpListenerConfig) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*UdpListenerConfig) XXX_Size

func (m *UdpListenerConfig) XXX_Size() int

func (*UdpListenerConfig) XXX_Unmarshal

func (m *UdpListenerConfig) XXX_Unmarshal(b []byte) error

type UdpListenerConfig_Config

type UdpListenerConfig_Config struct {
	Config *types.Struct `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}

type UdpListenerConfig_TypedConfig

type UdpListenerConfig_TypedConfig struct {
	TypedConfig *types.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL