l4proxyprotocol

package

v0.0.0-...-a2d147f Latest Latest Go to latest Published: Aug 22, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/armangodev/caddy-l4

Links

Open Source Insights

Documentation ¶

Index ¶

func GetConn(cx *layer4.Connection) net.Conn
type Handler
type MatchProxyProtocol

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetConn ¶

func GetConn(cx *layer4.Connection) net.Conn

GetConn gets the connection which holds the information received from the PROXY protocol.

Types ¶

type Handler ¶

type Handler struct {
	// How long to wait for the PROXY protocol header to be received.
	// Defaults to zero, which means timeout is disabled.
	Timeout caddy.Duration `json:"timeout,omitempty"`

	// An optional list of CIDR ranges to allow/require PROXY headers from.
	Allow []string `json:"allow,omitempty"`
	// contains filtered or unexported fields
}

Handler is a connection handler that accepts the PROXY protocol.

func (*Handler) CaddyModule ¶

func (*Handler) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Handler) Handle ¶

func (h *Handler) Handle(cx *layer4.Connection, next layer4.Handler) error

Handle handles the connections.

func (*Handler) Provision ¶

func (h *Handler) Provision(ctx caddy.Context) error

Provision sets up the module.

func (*Handler) UnmarshalCaddyfile ¶

func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile sets up the Handler from Caddyfile tokens. Syntax:

proxy_protocol {
	allow <ranges...>
	timeout <duration>
}

proxy_protocol

type MatchProxyProtocol ¶

type MatchProxyProtocol struct{}

func (*MatchProxyProtocol) CaddyModule ¶

func (*MatchProxyProtocol) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*MatchProxyProtocol) Match ¶

func (m *MatchProxyProtocol) Match(cx *layer4.Connection) (bool, error)

Match returns true if the connection looks like it is using the Proxy Protocol.

func (*MatchProxyProtocol) UnmarshalCaddyfile ¶

func (m *MatchProxyProtocol) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile sets up the MatchProxyProtocol from Caddyfile tokens. Syntax:

proxy_protocol

Source Files ¶

View all Source files

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