go-proxyproto: github.com/armon/go-proxyproto Index | Files

package proxyproto

import "github.com/armon/go-proxyproto"


Package Files



var (
    ErrInvalidUpstream = errors.New("upstream connection address not trusted for PROXY information")

type Conn Uses

type Conn struct {
    // contains filtered or unexported fields

Conn is used to wrap and underlying connection which may be speaking the Proxy Protocol. If it is, the RemoteAddr() will return the address of the client instead of the proxy address.

func NewConn Uses

func NewConn(conn net.Conn, timeout time.Duration) *Conn

NewConn is used to wrap a net.Conn that may be speaking the proxy protocol into a proxyproto.Conn

func (*Conn) Close Uses

func (p *Conn) Close() error

func (*Conn) LocalAddr Uses

func (p *Conn) LocalAddr() net.Addr

func (*Conn) Read Uses

func (p *Conn) Read(b []byte) (int, error)

Read is check for the proxy protocol header when doing the initial scan. If there is an error parsing the header, it is returned and the socket is closed.

func (*Conn) ReadFrom Uses

func (p *Conn) ReadFrom(r io.Reader) (int64, error)

func (*Conn) RemoteAddr Uses

func (p *Conn) RemoteAddr() net.Addr

RemoteAddr returns the address of the client if the proxy protocol is being used, otherwise just returns the address of the socket peer. If there is an error parsing the header, the address of the client is not returned, and the socket is closed. Once implication of this is that the call could block if the client is slow. Using a Deadline is recommended if this is called before Read()

func (*Conn) SetDeadline Uses

func (p *Conn) SetDeadline(t time.Time) error

func (*Conn) SetReadDeadline Uses

func (p *Conn) SetReadDeadline(t time.Time) error

func (*Conn) SetWriteDeadline Uses

func (p *Conn) SetWriteDeadline(t time.Time) error

func (*Conn) Write Uses

func (p *Conn) Write(b []byte) (int, error)

func (*Conn) WriteTo Uses

func (p *Conn) WriteTo(w io.Writer) (int64, error)

type Listener Uses

type Listener struct {
    Listener           net.Listener
    ProxyHeaderTimeout time.Duration
    SourceCheck        SourceChecker
    UnknownOK          bool // allow PROXY UNKNOWN

Listener is used to wrap an underlying listener, whose connections may be using the HAProxy Proxy Protocol (version 1). If the connection is using the protocol, the RemoteAddr() will return the correct client address.

Optionally define ProxyHeaderTimeout to set a maximum time to receive the Proxy Protocol Header. Zero means no timeout.

func (*Listener) Accept Uses

func (p *Listener) Accept() (net.Conn, error)

Accept waits for and returns the next connection to the listener.

func (*Listener) Addr Uses

func (p *Listener) Addr() net.Addr

Addr returns the underlying listener's network address.

func (*Listener) Close Uses

func (p *Listener) Close() error

Close closes the underlying listener.

type SourceChecker Uses

type SourceChecker func(net.Addr) (bool, error)

SourceChecker can be used to decide whether to trust the PROXY info or pass the original connection address through. If set, the connecting address is passed in as an argument. If the function returns an error due to the source being disallowed, it should return ErrInvalidUpstream.

If error is not nil, the call to Accept() will fail. If the reason for triggering this failure is due to a disallowed source, it should return ErrInvalidUpstream.

If bool is true, the PROXY-set address is used.

If bool is false, the connection's remote address is used, rather than the address claimed in the PROXY info.

Package proxyproto imports 11 packages (graph) and is imported by 112 packages. Updated 2020-01-08. Refresh now. Tools for package owners.