package xffv3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/http/original_ip_detection/xff/v3"

Index ¶

• Variables
• type XffConfig
• func (*XffConfig) Descriptor() ([]byte, []int)
• func (x *XffConfig) GetXffNumTrustedHops() uint32
• func (*XffConfig) ProtoMessage()
• func (x *XffConfig) ProtoReflect() protoreflect.Message
• func (x *XffConfig) Reset()
• func (x *XffConfig) String() string
• func (m *XffConfig) Validate() error
• func (m *XffConfig) ValidateAll() error
• type XffConfigMultiError
• func (m XffConfigMultiError) AllErrors() []error
• func (m XffConfigMultiError) Error() string
• type XffConfigValidationError
• func (e XffConfigValidationError) Cause() error
• func (e XffConfigValidationError) Error() string
• func (e XffConfigValidationError) ErrorName() string
• func (e XffConfigValidationError) Field() string
• func (e XffConfigValidationError) Key() bool
• func (e XffConfigValidationError) Reason() string

Variables ¶

var File_envoy_extensions_http_original_ip_detection_xff_v3_xff_proto protoreflect.FileDescriptor

Types ¶

type XffConfig ¶

type XffConfig struct {

	// The number of additional ingress proxy hops from the right side of the
	// :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when
	// determining the origin client's IP address. The default is zero if this option
	// is not specified. See the documentation for
	// :ref:`config_http_conn_man_headers_x-forwarded-for` for more information.
	XffNumTrustedHops uint32 `protobuf:"varint,1,opt,name=xff_num_trusted_hops,json=xffNumTrustedHops,proto3" json:"xff_num_trusted_hops,omitempty"`
	// contains filtered or unexported fields
}

This extension allows for the original downstream remote IP to be detected by reading the :ref:`config_http_conn_man_headers_x-forwarded-for` header.

[#extension: envoy.http.original_ip_detection.xff]

func (*XffConfig) Descriptor ¶

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

Deprecated: Use XffConfig.ProtoReflect.Descriptor instead.

func (*XffConfig) GetXffNumTrustedHops ¶

func (x *XffConfig) GetXffNumTrustedHops() uint32

func (*XffConfig) ProtoMessage ¶

func (*XffConfig) ProtoMessage()

func (*XffConfig) ProtoReflect ¶

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

func (*XffConfig) Reset ¶

func (x *XffConfig) Reset()

func (*XffConfig) String ¶

func (x *XffConfig) String() string

func (*XffConfig) Validate ¶

func (m *XffConfig) Validate() error

Validate checks the field values on XffConfig 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 (*XffConfig) ValidateAll ¶

func (m *XffConfig) ValidateAll() error

ValidateAll checks the field values on XffConfig 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 XffConfigMultiError, or nil if none found.

type XffConfigMultiError ¶

type XffConfigMultiError []error

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

func (XffConfigMultiError) AllErrors ¶

func (m XffConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (XffConfigMultiError) Error ¶

func (m XffConfigMultiError) Error() string

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

type XffConfigValidationError ¶

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

XffConfigValidationError is the validation error returned by XffConfig.Validate if the designated constraints aren't met.

func (XffConfigValidationError) Cause ¶

func (e XffConfigValidationError) Cause() error

Cause function returns cause value.

func (XffConfigValidationError) Error ¶

func (e XffConfigValidationError) Error() string

Error satisfies the builtin error interface

func (XffConfigValidationError) ErrorName ¶

func (e XffConfigValidationError) ErrorName() string

ErrorName returns error name.

func (XffConfigValidationError) Field ¶

func (e XffConfigValidationError) Field() string

Field function returns field value.

func (XffConfigValidationError) Key ¶

func (e XffConfigValidationError) Key() bool

Key function returns key value.

func (XffConfigValidationError) Reason ¶

func (e XffConfigValidationError) Reason() string

Reason function returns reason value.

Source Files ¶

xff.pb.go xff.pb.validate.go