Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

proxyproto

package module

Go to main page

Versions in this module

v0

v0.6.2

May 14, 2022

Changes in this version

+ var DefaultReadHeaderTimeout = 200 * time.Millisecond

type Listener

+ ReadHeaderTimeout time.Duration

v0.5.1

Jan 15, 2022

Changes in this version

+ var ErrCantReadAddressFamilyAndProtocol = errors.New("proxyproto: can't read address family or protocol")

+ var ErrCantReadLength = errors.New("proxyproto: can't read length")

+ var ErrCantReadProtocolVersionAndCommand = errors.New("proxyproto: can't read proxy protocol version and command")

+ var ErrCantReadVersion1Header = errors.New("proxyproto: can't read version 1 header")

+ var ErrCantResolveDestinationUnixAddress = errors.New("proxyproto: can't resolve destination Unix address")

+ var ErrCantResolveSourceUnixAddress = errors.New("proxyproto: can't resolve source Unix address")

+ var ErrIncompatibleTLV = errors.New("proxyproto: incompatible TLV type")

+ var ErrInvalidAddress = errors.New("proxyproto: invalid address")

+ var ErrInvalidLength = errors.New("proxyproto: invalid length")

+ var ErrInvalidPortNumber = errors.New("proxyproto: invalid port number")

+ var ErrLineMustEndWithCrlf = errors.New("proxyproto: version 1 header is invalid, must end with \\r\\n")

+ var ErrMalformedTLV = errors.New("proxyproto: malformed TLV Value")

+ var ErrNoProxyProtocol = errors.New("proxyproto: proxy protocol signature not present")

+ var ErrSuperfluousProxyHeader = errors.New(...)

+ var ErrTruncatedTLV = errors.New("proxyproto: truncated TLV")

+ var ErrUnknownProxyProtocolVersion = errors.New("proxyproto: unknown proxy protocol version")

+ var ErrUnsupportedAddressFamilyAndProtocol = errors.New("proxyproto: unsupported address family and protocol")

+ var ErrUnsupportedProtocolVersionAndCommand = errors.New("proxyproto: unsupported proxy protocol version and command")

+ var ErrVersion1HeaderTooLong = errors.New("proxyproto: version 1 header must be 107 bytes or less")

+ var SIGV1 = []byte

+ var SIGV2 = []byte

+ func JoinTLVs(tlvs []TLV) ([]byte, error)

+ func ValidateHeader(v Validator) func(*Conn)

+ func WithPolicy(p Policy) func(*Conn)

+ type AddressFamilyAndProtocol byte

+ const TCPv4

+ const TCPv6

+ const UDPv4

+ const UDPv6

+ const UNSPEC

+ const UnixDatagram

+ const UnixStream

+ func (ap AddressFamilyAndProtocol) IsDatagram() bool

+ func (ap AddressFamilyAndProtocol) IsIPv4() bool

+ func (ap AddressFamilyAndProtocol) IsIPv6() bool

+ func (ap AddressFamilyAndProtocol) IsStream() bool

+ func (ap AddressFamilyAndProtocol) IsUnix() bool

+ func (ap AddressFamilyAndProtocol) IsUnspec() bool

+ type Conn struct

+ ProxyHeaderPolicy Policy

+ Validate Validator

+ func NewConn(conn net.Conn, opts ...func(*Conn)) *Conn

+ func (p *Conn) Close() error

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

+ func (p *Conn) ProxyHeader() *Header

+ func (p *Conn) Raw() net.Conn

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

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

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

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

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

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

+ func (p *Conn) TCPConn() (conn *net.TCPConn, ok bool)

+ func (p *Conn) UDPConn() (conn *net.UDPConn, ok bool)

+ func (p *Conn) UnixConn() (conn *net.UnixConn, ok bool)

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

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

+ type Header struct

+ Command ProtocolVersionAndCommand

+ DestinationAddr net.Addr

+ SourceAddr net.Addr

+ TransportProtocol AddressFamilyAndProtocol

+ Version byte

+ func HeaderProxyFromAddrs(version byte, sourceAddr, destAddr net.Addr) *Header

+ func Read(reader *bufio.Reader) (*Header, error)

+ func ReadTimeout(reader *bufio.Reader, timeout time.Duration) (*Header, error)

+ func (header *Header) EqualTo(otherHeader *Header) bool

+ func (header *Header) EqualsTo(otherHeader *Header) bool

+ func (header *Header) Format() ([]byte, error)

+ func (header *Header) IPs() (sourceIP, destIP net.IP, ok bool)

+ func (header *Header) Ports() (sourcePort, destPort int, ok bool)

+ func (header *Header) SetTLVs(tlvs []TLV) error

+ func (header *Header) TCPAddrs() (sourceAddr, destAddr *net.TCPAddr, ok bool)

+ func (header *Header) TLVs() ([]TLV, error)

+ func (header *Header) UDPAddrs() (sourceAddr, destAddr *net.UDPAddr, ok bool)

+ func (header *Header) UnixAddrs() (sourceAddr, destAddr *net.UnixAddr, ok bool)

+ func (header *Header) WriteTo(w io.Writer) (int64, error)

+ type Listener struct

+ Listener net.Listener

+ Policy PolicyFunc

+ ValidateHeader Validator

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

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

+ func (p *Listener) Close() error

+ type PP2Type byte

+ const PP2_SUBTYPE_SSL_CIPHER

+ const PP2_SUBTYPE_SSL_CN

+ const PP2_SUBTYPE_SSL_KEY_ALG

+ const PP2_SUBTYPE_SSL_SIG_ALG

+ const PP2_SUBTYPE_SSL_VERSION

+ const PP2_TYPE_ALPN

+ const PP2_TYPE_AUTHORITY

+ const PP2_TYPE_CRC32C

+ const PP2_TYPE_MAX_CUSTOM

+ const PP2_TYPE_MAX_EXPERIMENT

+ const PP2_TYPE_MAX_FUTURE

+ const PP2_TYPE_MIN_CUSTOM

+ const PP2_TYPE_MIN_EXPERIMENT

+ const PP2_TYPE_MIN_FUTURE

+ const PP2_TYPE_NETNS

+ const PP2_TYPE_NOOP

+ const PP2_TYPE_SSL

+ const PP2_TYPE_UNIQUE_ID

+ func (p PP2Type) App() bool

+ func (p PP2Type) Experiment() bool

+ func (p PP2Type) Future() bool

+ func (p PP2Type) Registered() bool

+ func (p PP2Type) Spec() bool

+ type Policy int

+ const IGNORE

+ const REJECT

+ const REQUIRE

+ const USE

+ type PolicyFunc func(upstream net.Addr) (Policy, error)

+ func LaxWhiteListPolicy(allowed []string) (PolicyFunc, error)

+ func MustLaxWhiteListPolicy(allowed []string) PolicyFunc

+ func MustStrictWhiteListPolicy(allowed []string) PolicyFunc

+ func StrictWhiteListPolicy(allowed []string) (PolicyFunc, error)

+ type ProtocolVersionAndCommand byte

+ const LOCAL

+ const PROXY

+ func (pvc ProtocolVersionAndCommand) IsLocal() bool

+ func (pvc ProtocolVersionAndCommand) IsProxy() bool

+ func (pvc ProtocolVersionAndCommand) IsUnspec() bool

+ type TLV struct

+ Type PP2Type

+ Value []byte

+ func SplitTLVs(raw []byte) ([]TLV, error)

+ type Validator func(*Header) error