socks

Documentation

Index

• Variables
• func ClientHandshake4(conn io.ReadWriter, command byte, destination M.Socksaddr, username string) (socks4.Response, error)
• func ClientHandshake5(conn io.ReadWriter, command byte, destination M.Socksaddr, username string, ...) (socks5.Response, error)
• func HandleConnection(ctx context.Context, conn net.Conn, authenticator *auth.Authenticator, ...) error
• func HandleConnection0(ctx context.Context, conn net.Conn, version byte, ...) error
• type AssociatePacketConn
  • func NewAssociateConn(conn net.Conn, remoteAddr M.Socksaddr, underlying net.Conn) *AssociatePacketConn
  • func NewAssociatePacketConn(conn net.PacketConn, remoteAddr M.Socksaddr, underlying net.Conn) *AssociatePacketConn
  • func (c *AssociatePacketConn) Close() error
  • func (c *AssociatePacketConn) CreateReadWaiter() (N.PacketReadWaiter, bool)
  • func (c *AssociatePacketConn) FrontHeadroom() int
  • func (c *AssociatePacketConn) Read(b []byte) (n int, err error)
  • func (c *AssociatePacketConn) ReadFrom(p []byte) (n int, addr net.Addr, err error)
  • func (c *AssociatePacketConn) ReadPacket(buffer *buf.Buffer) (destination M.Socksaddr, err error)
  • func (c *AssociatePacketConn) RemoteAddr() net.Addr
  • func (c *AssociatePacketConn) Upstream() any
  • func (c *AssociatePacketConn) Write(b []byte) (n int, err error)
  • func (c *AssociatePacketConn) WritePacket(buffer *buf.Buffer, destination M.Socksaddr) error
  • func (c *AssociatePacketConn) WriteTo(p []byte, addr net.Addr) (n int, err error)
• type AssociatePacketReadWaiter
  • func (w *AssociatePacketReadWaiter) InitializeReadWaiter(options N.ReadWaitOptions) (needCopy bool)
  • func (w *AssociatePacketReadWaiter) WaitReadPacket() (buffer *buf.Buffer, destination M.Socksaddr, err error)
• type Client
  • func NewClient(dialer N.Dialer, serverAddr M.Socksaddr, version Version, username string, ...) *Client
  • func NewClientFromURL(dialer N.Dialer, rawURL string) (*Client, error)
  • func (c *Client) BindContext(ctx context.Context, address M.Socksaddr) (net.Conn, error)
  • func (c *Client) DialContext(ctx context.Context, network string, address M.Socksaddr) (net.Conn, error)
  • func (c *Client) ListenPacket(ctx context.Context, destination M.Socksaddr) (net.PacketConn, error)
• type Handler
• type VectorisedAssociatePacketConn
  • func NewVectorisedAssociateConn(conn net.Conn, writer N.VectorisedWriter, remoteAddr M.Socksaddr, ...) *VectorisedAssociatePacketConn
  • func NewVectorisedAssociatePacketConn(conn net.PacketConn, writer N.VectorisedPacketWriter, remoteAddr M.Socksaddr, ...) *VectorisedAssociatePacketConn
  • func (c *VectorisedAssociatePacketConn) FrontHeadroom() int
  • func (v *VectorisedAssociatePacketConn) WriteVectorisedPacket(buffers []*buf.Buffer, destination M.Socksaddr) error
• type Version
  • func ParseVersion(version string) (Version, error)
  • func (v Version) String() string

Variables

var ErrInvalidPacket = E.New("socks5: invalid packet")

Functions

func ClientHandshake4

func ClientHandshake4(conn io.ReadWriter, command byte, destination M.Socksaddr, username string) (socks4.Response, error)

func ClientHandshake5

func ClientHandshake5(conn io.ReadWriter, command byte, destination M.Socksaddr, username string, password string) (socks5.Response, error)

func HandleConnection

func HandleConnection(ctx context.Context, conn net.Conn, authenticator *auth.Authenticator, handler Handler, metadata M.Metadata) error

func HandleConnection0

func HandleConnection0(ctx context.Context, conn net.Conn, version byte, authenticator *auth.Authenticator, handler Handler, metadata M.Metadata) error

Types

type AssociatePacketConn

type AssociatePacketConn struct {
	N.NetPacketConn
	// contains filtered or unexported fields
}

func NewAssociateConn

func NewAssociateConn(conn net.Conn, remoteAddr M.Socksaddr, underlying net.Conn) *AssociatePacketConn

Deprecated: NewAssociatePacketConn(bufio.NewUnbindPacketConn(conn), remoteAddr, underlying) instead.

func NewAssociatePacketConn

func NewAssociatePacketConn(conn net.PacketConn, remoteAddr M.Socksaddr, underlying net.Conn) *AssociatePacketConn

func (*AssociatePacketConn) Close

func (c *AssociatePacketConn) Close() error

func (*AssociatePacketConn) CreateReadWaiter

func (c *AssociatePacketConn) CreateReadWaiter() (N.PacketReadWaiter, bool)

func (*AssociatePacketConn) FrontHeadroom

func (c *AssociatePacketConn) FrontHeadroom() int

func (*AssociatePacketConn) Read

func (c *AssociatePacketConn) Read(b []byte) (n int, err error)

func (*AssociatePacketConn) ReadFrom

func (c *AssociatePacketConn) ReadFrom(p []byte) (n int, addr net.Addr, err error)

func (*AssociatePacketConn) ReadPacket

func (c *AssociatePacketConn) ReadPacket(buffer *buf.Buffer) (destination M.Socksaddr, err error)

func (*AssociatePacketConn) RemoteAddr

func (c *AssociatePacketConn) RemoteAddr() net.Addr

func (*AssociatePacketConn) Upstream

func (c *AssociatePacketConn) Upstream() any

func (*AssociatePacketConn) Write

func (c *AssociatePacketConn) Write(b []byte) (n int, err error)

func (*AssociatePacketConn) WritePacket

func (c *AssociatePacketConn) WritePacket(buffer *buf.Buffer, destination M.Socksaddr) error

func (*AssociatePacketConn) WriteTo

func (c *AssociatePacketConn) WriteTo(p []byte, addr net.Addr) (n int, err error)

type AssociatePacketReadWaiter

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

func (*AssociatePacketReadWaiter) InitializeReadWaiter

func (w *AssociatePacketReadWaiter) InitializeReadWaiter(options N.ReadWaitOptions) (needCopy bool)

func (*AssociatePacketReadWaiter) WaitReadPacket

func (w *AssociatePacketReadWaiter) WaitReadPacket() (buffer *buf.Buffer, destination M.Socksaddr, err error)

type Client

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

func NewClient

func NewClient(dialer N.Dialer, serverAddr M.Socksaddr, version Version, username string, password string) *Client

func NewClientFromURL

func NewClientFromURL(dialer N.Dialer, rawURL string) (*Client, error)

func (*Client) BindContext

func (c *Client) BindContext(ctx context.Context, address M.Socksaddr) (net.Conn, error)

func (*Client) DialContext

func (c *Client) DialContext(ctx context.Context, network string, address M.Socksaddr) (net.Conn, error)

func (*Client) ListenPacket

func (c *Client) ListenPacket(ctx context.Context, destination M.Socksaddr) (net.PacketConn, error)

type Handler

type Handler interface {
	N.TCPConnectionHandler
	N.UDPConnectionHandler
}

type VectorisedAssociatePacketConn

type VectorisedAssociatePacketConn struct {
	AssociatePacketConn
	N.VectorisedPacketWriter
}

func NewVectorisedAssociateConn

func NewVectorisedAssociateConn(conn net.Conn, writer N.VectorisedWriter, remoteAddr M.Socksaddr, underlying net.Conn) *VectorisedAssociatePacketConn

func NewVectorisedAssociatePacketConn

func NewVectorisedAssociatePacketConn(conn net.PacketConn, writer N.VectorisedPacketWriter, remoteAddr M.Socksaddr, underlying net.Conn) *VectorisedAssociatePacketConn

func (*VectorisedAssociatePacketConn) FrontHeadroom

func (c *VectorisedAssociatePacketConn) FrontHeadroom() int

func (*VectorisedAssociatePacketConn) WriteVectorisedPacket

func (v *VectorisedAssociatePacketConn) WriteVectorisedPacket(buffers []*buf.Buffer, destination M.Socksaddr) error

type Version

type Version uint8

const (
	Version4 Version = iota
	Version4A
	Version5
)

func ParseVersion

func ParseVersion(version string) (Version, error)

func (Version) String

func (v Version) String() string