socks4

Documentation

Index

• type AddrAnfUser
  • func (a AddrAnfUser) Address() string
  • func (a *AddrAnfUser) Network() string
  • func (a *AddrAnfUser) String() string
• type Command
  • func (cmd Command) String() string
• type Server
  • func NewServer(options ...ServerOption) *Server
  • func (s *Server) ListenAndServe() error
  • func (s *Server) ServeConn(conn net.Conn) error
• type ServerOption
  • func WithBind(bindAddress string) ServerOption
  • func WithBytesPool(bytesPool statute.BytesPool) ServerOption
  • func WithConnectHandle(handler statute.UserConnectHandler) ServerOption
  • func WithContext(ctx context.Context) ServerOption
  • func WithLogger(logger *slog.Logger) ServerOption
  • func WithProxyDial(proxyDial statute.ProxyDialFunc) ServerOption

Types

type AddrAnfUser

type AddrAnfUser struct {
	Username string
	// contains filtered or unexported fields
}

func (AddrAnfUser) Address

func (a AddrAnfUser) Address() string

Address returns a string suitable to dial; prefer returning IP-based address, fallback to Name

func (*AddrAnfUser) Network

func (a *AddrAnfUser) Network() string

func (*AddrAnfUser) String

func (a *AddrAnfUser) String() string

type Command

type Command byte

Command is a SOCKS Command.

const (
	ConnectCommand Command = 0x01
)

func (Command) String

func (cmd Command) String() string

type Server

type Server struct {
	// bind is the address to listen on
	Bind string

	Listener net.Listener

	// ProxyDial specifies the optional proxyDial function for
	// establishing the transport connection.
	ProxyDial statute.ProxyDialFunc
	// UserConnectHandle gives the user control to handle the TCP CONNECT requests
	UserConnectHandle statute.UserConnectHandler
	// Logger error log
	Logger *slog.Logger
	// Context is default context
	Context context.Context
	// BytesPool getting and returning temporary bytes for use by io.CopyBuffer
	BytesPool statute.BytesPool
}

Server is accepting connections and handling the details of the SOCKS4 protocol

func NewServer

func NewServer(options ...ServerOption) *Server

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

func (*Server) ServeConn

func (s *Server) ServeConn(conn net.Conn) error

type ServerOption

type ServerOption func(*Server)

func WithBind

func WithBind(bindAddress string) ServerOption

func WithBytesPool

func WithBytesPool(bytesPool statute.BytesPool) ServerOption

func WithConnectHandle

func WithConnectHandle(handler statute.UserConnectHandler) ServerOption

func WithContext

func WithContext(ctx context.Context) ServerOption

func WithLogger

func WithLogger(logger *slog.Logger) ServerOption

func WithProxyDial

func WithProxyDial(proxyDial statute.ProxyDialFunc) ServerOption