proxy_protocolv3

package
v0.0.0-...-145a048 Latest Latest
Warning

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

 Go to latest Published: Apr 15, 2024 License: Apache-2.0 Imports: 20 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_envoy_extensions_filters_listener_proxy_protocol_v3_proxy_protocol_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ProxyProtocol 

type ProxyProtocol struct {

	// The list of rules to apply to requests.
	Rules []*ProxyProtocol_Rule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
	// Allow requests through that don't use proxy protocol. Defaults to false.
	//
	// .. attention::
	//
	//	This breaks conformance with the specification.
	//	Only enable if ALL traffic to the listener comes from a trusted source.
	//	For more information on the security implications of this feature, see
	//	https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt
	//
	// .. attention::
	//
	//	Requests of 12 or fewer bytes that match the proxy protocol v2 signature
	//	and requests of 6 or fewer bytes that match the proxy protocol v1
	//	signature will timeout (Envoy is unable to differentiate these requests
	//	from incomplete proxy protocol requests).
	AllowRequestsWithoutProxyProtocol bool `` /* 167-byte string literal not displayed */
	// This config controls which TLVs can be passed to filter state if it is Proxy Protocol
	// V2 header. If there is no setting for this field, no TLVs will be passed through.
	//
	// .. note::
	//
	//	If this is configured, you likely also want to set
	//	:ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>`,
	//	which controls pass-through for the upstream.
	PassThroughTlvs *v3.ProxyProtocolPassThroughTLVs `protobuf:"bytes,3,opt,name=pass_through_tlvs,json=passThroughTlvs,proto3" json:"pass_through_tlvs,omitempty"`
	// contains filtered or unexported fields
}

func (*ProxyProtocol) Descriptor deprecated 

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

Deprecated: Use ProxyProtocol.ProtoReflect.Descriptor instead.

func (*ProxyProtocol) GetAllowRequestsWithoutProxyProtocol 

func (x *ProxyProtocol) GetAllowRequestsWithoutProxyProtocol() bool

func (*ProxyProtocol) GetPassThroughTlvs 

func (x *ProxyProtocol) GetPassThroughTlvs() *v3.ProxyProtocolPassThroughTLVs

func (*ProxyProtocol) GetRules 

func (x *ProxyProtocol) GetRules() []*ProxyProtocol_Rule

func (*ProxyProtocol) ProtoMessage 

func (*ProxyProtocol) ProtoMessage()

func (*ProxyProtocol) ProtoReflect 

func (x *ProxyProtocol) ProtoReflect() protoreflect.Message

func (*ProxyProtocol) Reset 

func (x *ProxyProtocol) Reset()

func (*ProxyProtocol) String 

func (x *ProxyProtocol) String() string

func (*ProxyProtocol) Validate 

func (m *ProxyProtocol) Validate() error

Validate checks the field values on ProxyProtocol with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ProxyProtocol) ValidateAll 

func (m *ProxyProtocol) ValidateAll() error

ValidateAll checks the field values on ProxyProtocol with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ProxyProtocolMultiError, or nil if none found.

type ProxyProtocolMultiError 

type ProxyProtocolMultiError []error

ProxyProtocolMultiError is an error wrapping multiple validation errors returned by ProxyProtocol.ValidateAll() if the designated constraints aren't met.

func (ProxyProtocolMultiError) AllErrors 

func (m ProxyProtocolMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ProxyProtocolMultiError) Error 

func (m ProxyProtocolMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ProxyProtocolValidationError 

type ProxyProtocolValidationError struct {
	// contains filtered or unexported fields
}

ProxyProtocolValidationError is the validation error returned by ProxyProtocol.Validate if the designated constraints aren't met.

func (ProxyProtocolValidationError) Cause 

func (e ProxyProtocolValidationError) Cause() error

Cause function returns cause value.

func (ProxyProtocolValidationError) Error 

func (e ProxyProtocolValidationError) Error() string

Error satisfies the builtin error interface

func (ProxyProtocolValidationError) ErrorName 

func (e ProxyProtocolValidationError) ErrorName() string

ErrorName returns error name.

func (ProxyProtocolValidationError) Field 

func (e ProxyProtocolValidationError) Field() string

Field function returns field value.

func (ProxyProtocolValidationError) Key 

func (e ProxyProtocolValidationError) Key() bool

Key function returns key value.

func (ProxyProtocolValidationError) Reason 

func (e ProxyProtocolValidationError) Reason() string

Reason function returns reason value.

type ProxyProtocol_KeyValuePair 

type ProxyProtocol_KeyValuePair struct {

	// The namespace — if this is empty, the filter's namespace will be used.
	MetadataNamespace string `protobuf:"bytes,1,opt,name=metadata_namespace,json=metadataNamespace,proto3" json:"metadata_namespace,omitempty"`
	// The key to use within the namespace.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*ProxyProtocol_KeyValuePair) Descriptor deprecated 

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

Deprecated: Use ProxyProtocol_KeyValuePair.ProtoReflect.Descriptor instead.

func (*ProxyProtocol_KeyValuePair) GetKey 

func (x *ProxyProtocol_KeyValuePair) GetKey() string

func (*ProxyProtocol_KeyValuePair) GetMetadataNamespace 

func (x *ProxyProtocol_KeyValuePair) GetMetadataNamespace() string

func (*ProxyProtocol_KeyValuePair) ProtoMessage 

func (*ProxyProtocol_KeyValuePair) ProtoMessage()

func (*ProxyProtocol_KeyValuePair) ProtoReflect 

func (x *ProxyProtocol_KeyValuePair) ProtoReflect() protoreflect.Message

func (*ProxyProtocol_KeyValuePair) Reset 

func (x *ProxyProtocol_KeyValuePair) Reset()

func (*ProxyProtocol_KeyValuePair) String 

func (x *ProxyProtocol_KeyValuePair) String() string

func (*ProxyProtocol_KeyValuePair) Validate 

func (m *ProxyProtocol_KeyValuePair) Validate() error

Validate checks the field values on ProxyProtocol_KeyValuePair with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ProxyProtocol_KeyValuePair) ValidateAll 

func (m *ProxyProtocol_KeyValuePair) ValidateAll() error

ValidateAll checks the field values on ProxyProtocol_KeyValuePair with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ProxyProtocol_KeyValuePairMultiError, or nil if none found.

type ProxyProtocol_KeyValuePairMultiError 

type ProxyProtocol_KeyValuePairMultiError []error

ProxyProtocol_KeyValuePairMultiError is an error wrapping multiple validation errors returned by ProxyProtocol_KeyValuePair.ValidateAll() if the designated constraints aren't met.

func (ProxyProtocol_KeyValuePairMultiError) AllErrors 

func (m ProxyProtocol_KeyValuePairMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ProxyProtocol_KeyValuePairMultiError) Error 

func (m ProxyProtocol_KeyValuePairMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ProxyProtocol_KeyValuePairValidationError 

type ProxyProtocol_KeyValuePairValidationError struct {
	// contains filtered or unexported fields
}

ProxyProtocol_KeyValuePairValidationError is the validation error returned by ProxyProtocol_KeyValuePair.Validate if the designated constraints aren't met.

func (ProxyProtocol_KeyValuePairValidationError) Cause 

func (e ProxyProtocol_KeyValuePairValidationError) Cause() error

Cause function returns cause value.

func (ProxyProtocol_KeyValuePairValidationError) Error 

func (e ProxyProtocol_KeyValuePairValidationError) Error() string

Error satisfies the builtin error interface

func (ProxyProtocol_KeyValuePairValidationError) ErrorName 

func (e ProxyProtocol_KeyValuePairValidationError) ErrorName() string

ErrorName returns error name.

func (ProxyProtocol_KeyValuePairValidationError) Field 

func (e ProxyProtocol_KeyValuePairValidationError) Field() string

Field function returns field value.

func (ProxyProtocol_KeyValuePairValidationError) Key 

func (e ProxyProtocol_KeyValuePairValidationError) Key() bool

Key function returns key value.

func (ProxyProtocol_KeyValuePairValidationError) Reason 

func (e ProxyProtocol_KeyValuePairValidationError) Reason() string

Reason function returns reason value.

type ProxyProtocol_Rule 

type ProxyProtocol_Rule struct {

	// The type that triggers the rule - required
	// TLV type is defined as uint8_t in proxy protocol. See `the spec
	// <https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt>`_ for details.
	TlvType uint32 `protobuf:"varint,1,opt,name=tlv_type,json=tlvType,proto3" json:"tlv_type,omitempty"`
	// If the TLV type is present, apply this metadata KeyValuePair.
	OnTlvPresent *ProxyProtocol_KeyValuePair `protobuf:"bytes,2,opt,name=on_tlv_present,json=onTlvPresent,proto3" json:"on_tlv_present,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ProxyProtocol_Rule) Descriptor deprecated 

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

Deprecated: Use ProxyProtocol_Rule.ProtoReflect.Descriptor instead.

func (*ProxyProtocol_Rule) GetOnTlvPresent 

func (x *ProxyProtocol_Rule) GetOnTlvPresent() *ProxyProtocol_KeyValuePair

func (*ProxyProtocol_Rule) GetTlvType 

func (x *ProxyProtocol_Rule) GetTlvType() uint32

func (*ProxyProtocol_Rule) ProtoMessage 

func (*ProxyProtocol_Rule) ProtoMessage()

func (*ProxyProtocol_Rule) ProtoReflect 

func (x *ProxyProtocol_Rule) ProtoReflect() protoreflect.Message

func (*ProxyProtocol_Rule) Reset 

func (x *ProxyProtocol_Rule) Reset()

func (*ProxyProtocol_Rule) String 

func (x *ProxyProtocol_Rule) String() string

func (*ProxyProtocol_Rule) Validate 

func (m *ProxyProtocol_Rule) Validate() error

Validate checks the field values on ProxyProtocol_Rule with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ProxyProtocol_Rule) ValidateAll 

func (m *ProxyProtocol_Rule) ValidateAll() error

ValidateAll checks the field values on ProxyProtocol_Rule with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ProxyProtocol_RuleMultiError, or nil if none found.

type ProxyProtocol_RuleMultiError 

type ProxyProtocol_RuleMultiError []error

ProxyProtocol_RuleMultiError is an error wrapping multiple validation errors returned by ProxyProtocol_Rule.ValidateAll() if the designated constraints aren't met.

func (ProxyProtocol_RuleMultiError) AllErrors 

func (m ProxyProtocol_RuleMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ProxyProtocol_RuleMultiError) Error 

func (m ProxyProtocol_RuleMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ProxyProtocol_RuleValidationError 

type ProxyProtocol_RuleValidationError struct {
	// contains filtered or unexported fields
}

ProxyProtocol_RuleValidationError is the validation error returned by ProxyProtocol_Rule.Validate if the designated constraints aren't met.

func (ProxyProtocol_RuleValidationError) Cause 

func (e ProxyProtocol_RuleValidationError) Cause() error

Cause function returns cause value.

func (ProxyProtocol_RuleValidationError) Error 

func (e ProxyProtocol_RuleValidationError) Error() string

Error satisfies the builtin error interface

func (ProxyProtocol_RuleValidationError) ErrorName 

func (e ProxyProtocol_RuleValidationError) ErrorName() string

ErrorName returns error name.

func (ProxyProtocol_RuleValidationError) Field 

func (e ProxyProtocol_RuleValidationError) Field() string

Field function returns field value.

func (ProxyProtocol_RuleValidationError) Key 

func (e ProxyProtocol_RuleValidationError) Key() bool

Key function returns key value.

func (ProxyProtocol_RuleValidationError) Reason 

func (e ProxyProtocol_RuleValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.