proxyprotocol

Documentation

Index

• type ListenerWrapper
• type ListenerWrapperName
  • func (ListenerWrapperName) MarshalJSON() ([]byte, error)

Types

type ListenerWrapper

type ListenerWrapper struct {
	// Wrapper is the name of this wrapper for the JSON config.
	// DO NOT USE this. This is a special value to represent this wrapper.
	// It will be overwritten when we are marshalled.
	Wrapper ListenerWrapperName `json:"wrapper"`

	// Timeout specifies an optional maximum time for
	// the PROXY header to be received.
	// If zero, timeout is disabled. Default is 5s.
	Timeout kengine.Duration `json:"timeout,omitempty"`

	// Allow is an optional list of CIDR ranges to
	// allow/require PROXY headers from.
	Allow []string `json:"allow,omitempty"`
}

ListenerWrapper provides PROXY protocol support to Kengine by implementing the kengine.ListenerWrapper interface. It must be loaded before the `tls` listener.

Credit goes to https://github.com/mastercactapus/kengine2-proxyprotocol for having initially implemented this as a plugin.

type ListenerWrapperName

type ListenerWrapperName string

func (ListenerWrapperName) MarshalJSON

func (ListenerWrapperName) MarshalJSON() ([]byte, error)