socks5

package module

Go to main page

Versions in this module

v0

v0.1.4

Oct 28, 2026

v0.1.3

Aug 24, 2026

v0.1.2

Aug 24, 2026

v0.1.1

Mar 25, 2026

v0.1.0

Aug 26, 2025

Changes in this version

type Option

+ func WithUseBindIpBaseResolveAsUdpAddr(b bool) Option

v0.0.6

Apr 24, 2025

Changes in this version

+ type Handler func(ctx context.Context, writer io.Writer, request *Request) error

+ type Middleware func(ctx context.Context, writer io.Writer, request *Request) error

+ type MiddlewareChain []Middleware

+ func (m MiddlewareChain) Execute(ctx context.Context, writer io.Writer, request *Request, last Handler) error

type Option

+ func WithAssociateMiddleware(m Middleware) Option

+ func WithBindMiddleware(m Middleware) Option

+ func WithConnectMiddleware(m Middleware) Option

type Server

+ func (sf *Server) ListenAndServeTLS(network, addr string, c *tls.Config) error

v0.0.5

Jan 19, 2024

Changes in this version

type Option

+ func WithDialAndRequest(...) Option

v0.0.4

Sep 11, 2023

v0.0.3

Feb 14, 2023

v0.0.2

Jul 11, 2021

v0.0.1

Jul 10, 2021

Changes in this version

+ func SendReply(w io.Writer, rep uint8, bindAddr net.Addr) error

+ type AddressRewriter interface

+ Rewrite func(ctx context.Context, request *Request) (context.Context, *statute.AddrSpec)

+ type AuthContext struct

+ Method uint8

+ Payload map[string]string

+ type Authenticator interface

+ Authenticate func(reader io.Reader, writer io.Writer, userAddr string) (*AuthContext, error)

+ GetCode func() uint8

+ type CredentialStore interface

+ Valid func(user, password, userAddr string) bool

+ type DNSResolver struct

+ func (d DNSResolver) Resolve(ctx context.Context, name string) (context.Context, net.IP, error)

+ type GPool interface

+ Submit func(f func()) error

+ type Logger interface

+ Errorf func(format string, arg ...interface{})

+ type NameResolver interface

+ Resolve func(ctx context.Context, name string) (context.Context, net.IP, error)

+ type NoAuthAuthenticator struct

+ func (a NoAuthAuthenticator) Authenticate(_ io.Reader, writer io.Writer, _ string) (*AuthContext, error)

+ func (a NoAuthAuthenticator) GetCode() uint8

+ type Option func(s *Server)

+ func WithAssociateHandle(h func(ctx context.Context, writer io.Writer, request *Request) error) Option

+ func WithAuthMethods(authMethods []Authenticator) Option

+ func WithBindHandle(h func(ctx context.Context, writer io.Writer, request *Request) error) Option

+ func WithBindIP(ip net.IP) Option

+ func WithBufferPool(bufferPool bufferpool.BufPool) Option

+ func WithConnectHandle(h func(ctx context.Context, writer io.Writer, request *Request) error) Option

+ func WithCredential(cs CredentialStore) Option

+ func WithDial(dial func(ctx context.Context, network, addr string) (net.Conn, error)) Option

+ func WithGPool(pool GPool) Option

+ func WithLogger(l Logger) Option

+ func WithResolver(res NameResolver) Option

+ func WithRewriter(rew AddressRewriter) Option

+ func WithRule(rule RuleSet) Option

+ type PermitCommand struct

+ EnableAssociate bool

+ EnableBind bool

+ EnableConnect bool

+ func (p *PermitCommand) Allow(ctx context.Context, req *Request) (context.Context, bool)

+ type Request struct

+ AuthContext *AuthContext

+ DestAddr *statute.AddrSpec

+ LocalAddr net.Addr

+ RawDestAddr *statute.AddrSpec

+ Reader io.Reader

+ RemoteAddr net.Addr

+ func ParseRequest(bufConn io.Reader) (*Request, error)

+ type RuleSet interface

+ Allow func(ctx context.Context, req *Request) (context.Context, bool)

+ func NewPermitAll() RuleSet

+ func NewPermitConnAndAss() RuleSet

+ func NewPermitNone() RuleSet

+ type Server struct

+ func NewServer(opts ...Option) *Server

+ func (sf *Server) ListenAndServe(network, addr string) error

+ func (sf *Server) Proxy(dst io.Writer, src io.Reader) error

+ func (sf *Server) Serve(l net.Listener) error

+ func (sf *Server) ServeConn(conn net.Conn) error

+ type StaticCredentials map[string]string

+ func (s StaticCredentials) Valid(user, password, _ string) bool

+ type Std struct

+ func NewLogger(l *log.Logger) *Std

+ func (sf Std) Errorf(format string, args ...interface{})

+ type UserPassAuthenticator struct

+ Credentials CredentialStore

+ func (a UserPassAuthenticator) Authenticate(reader io.Reader, writer io.Writer, userAddr string) (*AuthContext, error)

+ func (a UserPassAuthenticator) GetCode() uint8

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