Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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
- API
  
  Reference documentation for the pkg.go.dev API
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

socks5

package module

Go to main page

Versions in this module

v1

v1.1.2

Aug 15, 2026

v1.1.1

Aug 15, 2026

v1.1.0

Aug 2, 2026

v1.0.1

Jun 29, 2026

v1.0.0

Jun 29, 2026

Changes in this version

+ const AddressDomainName

+ const AddressIPv4

+ const AddressIPv6

+ const AuthMethodNoAcceptable

+ const AuthMethodNoAuth

+ const AuthMethodUserPass

+ const CommandAssociate

+ const CommandBind

+ const CommandConnect

+ const ReplyAddrTypeNotSupported

+ const ReplyCommandNotSupported

+ const ReplyConnectionNotAllowed

+ const ReplyConnectionRefused

+ const ReplyGeneralFailure

+ const ReplyHostUnreachable

+ const ReplyNetworkUnreachable

+ const ReplySucceeded

+ const ReplyTTLExpired

+ var ErrCommandNotSupported = errors.New("socks5: command not supported")

+ var ErrConnectionNotAllowed = errors.New("socks5: connection not allowed")

+ var ErrHostUnreachable = errors.New("socks5: host unreachable")

+ var ErrInvalidHostname = errors.New("socks5: invalid hostname")

+ var ErrInvalidRequest = errors.New("socks5: invalid request")

+ var ErrInvalidVersion = errors.New("socks5: invalid SOCKS version")

+ var ErrListenerNotFound = errors.New("socks5: virtual listener not found")

+ var ErrNoSupportedAuth = errors.New("socks5: no supported authentication mechanism")

+ var ErrProxyProtoMalformed = errors.New("socks5: malformed PROXY protocol header")

+ var ErrReservedNotZero = errors.New("socks5: reserved byte is non-zero")

+ var ErrServerAlreadyServing = errors.New("socks5: Server.Serve already called")

+ var ErrShuttingDown = errors.New("socks5: server is shutting down")

+ var ErrUnrecognizedAddrType = errors.New("socks5: unrecognized address type")

+ var ErrUserAuthFailed = errors.New("socks5: user authentication failed")

+ func DNSResolver(ctx context.Context, name string) (context.Context, []net.IP, error)

+ func DefaultForwarder(src, dst net.Conn) error

+ func LiteForwarder(src, dst io.ReadWriter) error

+ func MeteredForwarder(m Metrics) func(src, dst net.Conn) error

+ func NewLogger(l zerolog.Logger) *zerolog.Logger

+ func NewStdLogger() *zerolog.Logger

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

+ func PermitCommand(connect, bind, assoc bool) func(ctx context.Context, req *Request) (context.Context, bool)

+ func PermitDest(cidrs ...string) func(ctx context.Context, req *Request) (context.Context, bool)

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

+ func PermitPorts(ports ...int) func(ctx context.Context, req *Request) (context.Context, bool)

+ func PermitSource(cidrs ...string) func(ctx context.Context, req *Request) (context.Context, bool)

+ func ProxyStream(a, b net.Conn) error

+ func ReadMethods(r io.Reader) ([]byte, error)

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

+ type AddrSpec struct

+ FQDN string

+ IP net.IP

+ Port int

+ func ParseAddrSpec(addr string) (*AddrSpec, error)

+ func (a *AddrSpec) Address() string

+ func (a *AddrSpec) String() string

+ type AuthContext struct

+ Identity string

+ Method uint8

+ Payload map[string]string

+ type Authenticator interface

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

+ GetCode func() uint8

+ type BoundConn struct

+ func (b *BoundConn) ListenAddr() *AddrSpec

+ func (b *BoundConn) PeerAddr() *AddrSpec

+ type BytesPool interface

+ Get func(n int) []byte

+ Put func(buf []byte)

+ type Client struct

+ func NewClient(cfg *ClientConfig) *Client

+ func (c *Client) Associate(ctx context.Context, targetAddr string) (*UDPRelay, error)

+ func (c *Client) Bind(ctx context.Context, targetAddr string) (*BoundConn, error)

+ func (c *Client) Dial(network, targetAddr string) (net.Conn, error)

+ func (c *Client) DialContext(ctx context.Context, network, targetAddr string) (net.Conn, error)

+ type ClientConfig struct

+ Auth Authenticator

+ DialFunc func(ctx context.Context, network, addr string) (net.Conn, error)

+ Dialer *net.Dialer

+ HandshakeTimeout time.Duration

+ Password string

+ ProxyAddr string

+ ResolveOnProxy bool

+ Username string

+ type CloseReader interface

+ CloseRead func() error

+ type CloseWriter interface

+ CloseWrite func() error

+ type CredentialStore interface

+ Valid func(user, password string) bool

+ type Datagram struct

+ Data []byte

+ DstAddr *AddrSpec

+ Frag uint8

+ func NewDatagram(frag uint8, dst *AddrSpec, data []byte) *Datagram

+ func ParseDatagram(payload []byte) (*Datagram, error)

+ func (d *Datagram) AppendTo(buf []byte) []byte

+ func (d *Datagram) Bytes() []byte

+ func (d *Datagram) Header() []byte

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

+ type Listener struct

+ func NewListener(addr string) (*Listener, error)

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

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

+ func (vl *Listener) Close() error

+ func (vl *Listener) Dial() (net.Conn, error)

+ type MethodReply struct

+ Method uint8

+ Version uint8

+ func NewMethodReply(ver, method uint8) *MethodReply

+ func ParseMethodReply(r io.Reader) (*MethodReply, error)

+ func (m *MethodReply) Bytes() []byte

+ type MethodRequest struct

+ Methods []byte

+ Version uint8

+ func NewMethodRequest(ver uint8, methods []byte) *MethodRequest

+ func ParseMethodRequest(r io.Reader) (*MethodRequest, error)

+ func (m *MethodRequest) Bytes() []byte

+ type Metrics interface

+ AddBytesProxied func(ctx context.Context, direction string, n int64)

+ IncAuthFailure func(ctx context.Context, method uint8)

+ IncCommand func(ctx context.Context, command uint8)

+ IncConnectionsAccepted func(ctx context.Context)

+ IncConnectionsRejected func(ctx context.Context, reason string)

+ type Middleware func(next Handler) Handler

+ type MiddlewareChain []Middleware

+ func (c MiddlewareChain) Then(h Handler) Handler

+ type NoAuthAuthenticator struct

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

+ func (a NoAuthAuthenticator) GetCode() uint8

+ type NoOpMetrics struct

+ func (NoOpMetrics) AddBytesProxied(_ context.Context, _ string, _ int64)

+ func (NoOpMetrics) IncAuthFailure(_ context.Context, _ uint8)

+ func (NoOpMetrics) IncCommand(_ context.Context, _ uint8)

+ func (NoOpMetrics) IncConnectionsAccepted(_ context.Context)

+ func (NoOpMetrics) IncConnectionsRejected(_ context.Context, _ string)

+ type NoOpObserver struct

+ func (NoOpObserver) OnAssociate(_ context.Context, _ *Request, _ net.PacketConn)

+ func (NoOpObserver) OnBind(_ context.Context, _ *Request, _ net.Listener)

+ func (NoOpObserver) OnConnect(_ context.Context, _ *Request, _ net.Conn)

+ func (NoOpObserver) OnError(_ context.Context, _ *Request, _ error)

+ func (NoOpObserver) OnShutdown()

+ type Observer interface

+ OnAssociate func(ctx context.Context, req *Request, conn net.PacketConn)

+ OnBind func(ctx context.Context, req *Request, listener net.Listener)

+ OnConnect func(ctx context.Context, req *Request, target net.Conn)

+ OnError func(ctx context.Context, req *Request, err error)

+ OnShutdown func()

+ type PacketConn struct

+ func NewPacketConn(addr string) (*PacketConn, error)

+ func (vpc *PacketConn) Close() error

+ func (vpc *PacketConn) LocalAddr() net.Addr

+ func (vpc *PacketConn) ReadFrom(p []byte) (int, net.Addr, error)

+ func (vpc *PacketConn) SetDeadline(t time.Time) error

+ func (vpc *PacketConn) SetReadDeadline(t time.Time) error

+ func (vpc *PacketConn) SetWriteDeadline(t time.Time) error

+ func (vpc *PacketConn) WriteTo(p []byte, addr net.Addr) (int, error)

+ type ProtoReply struct

+ BndAddr *AddrSpec

+ Reply uint8

+ Reserved uint8

+ Version uint8

+ func NewProtoReply(reply uint8, bnd *AddrSpec) *ProtoReply

+ func ParseProtoReply(r io.Reader) (*ProtoReply, error)

+ func (p *ProtoReply) Bytes() []byte

+ type ProtoRequest struct

+ Command uint8

+ DstAddr *AddrSpec

+ Reserved uint8

+ Version uint8

+ func NewProtoRequest(cmd uint8, dst *AddrSpec) *ProtoRequest

+ func ParseProtoRequest(r io.Reader) (*ProtoRequest, error)

+ func (p *ProtoRequest) Bytes() []byte

+ func (p *ProtoRequest) Validate() error

+ type ReplyError struct

+ Code uint8

+ Message string

+ func (e *ReplyError) Error() string

+ type Request struct

+ AuthContext *AuthContext

+ Command uint8

+ DestAddr *AddrSpec

+ RemoteAddr net.Addr

+ Reserved uint8

+ Version uint8

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

+ func (r *Request) String() string

+ type RoutinePool interface

+ Submit func(f func()) error

+ type Server struct

+ func NewServer(cfg *ServerConfig) (*Server, error)

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

+ func (s *Server) Serve(ln net.Listener) error

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

+ func (s *Server) ServeConnNoAuth(conn net.Conn) error

+ func (s *Server) Shutdown(ctx context.Context) error

+ type ServerConfig struct

+ AcceptProxyProtocol bool

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

+ AssociateHandle Handler

+ AssociateMiddleware MiddlewareChain

+ AssociateSetupTimeout time.Duration

+ AuthMethods []Authenticator

+ BindHandle Handler

+ BindIP net.IP

+ BindMiddleware MiddlewareChain

+ BindPort int

+ BytesPool BytesPool

+ ConnectHandle Handler

+ ConnectMiddleware MiddlewareChain

+ Context context.Context

+ Dial func(ctx context.Context, network, addr string) (net.Conn, error)

+ Forwarder func(src, dst net.Conn) error

+ FragmentPoolSize int

+ FragmentTimeout time.Duration

+ HandshakeTimeout time.Duration

+ IdleTimeout time.Duration

+ KeepAlivePeriod time.Duration

+ LenientUDPRSV bool

+ ListenBindAcceptTimeout time.Duration

+ ListenBindReuseTimeout time.Duration

+ Listeners map[string]*Listener

+ Logger *zerolog.Logger

+ MaxConnections int

+ MaxConnectionsPerIP int

+ MaxDatagramSize int

+ Metrics Metrics

+ NameResolver func(ctx context.Context, name string) (context.Context, []net.IP, error)

+ Observer Observer

+ PacketForwardAddress func(ctx context.Context, destinationAddr string, packet net.PacketConn, ...) (net.IP, int, error)

+ ProxyListen func(ctx context.Context, network, addr string) (net.Listener, error)

+ ProxyListenBind func(ctx context.Context, network, addr string) (net.Listener, error)

+ ProxyListenPacket func(ctx context.Context, network, addr string) (net.PacketConn, error)

+ ProxyOutgoingListenPacket func(ctx context.Context, network, addr string) (net.PacketConn, error)

+ RateLimit float64

+ ReadBufferSize int

+ RoutinePool RoutinePool

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

+ StrictAssociateBinding bool

+ StrictBindOrigin bool

+ StrictRSV bool

+ TLSConfig *tls.Config

+ WriteBufferSize int

+ type SocksConn struct

+ func (c *SocksConn) BoundAddr() *AddrSpec

+ type StaticCredentials map[string]string

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

+ type UDPRelay struct

+ func (u *UDPRelay) Close() error

+ func (u *UDPRelay) RelayAddr() *AddrSpec

+ type UserPassAuthenticator struct

+ Credentials CredentialStore

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

+ func (a UserPassAuthenticator) GetCode() uint8

+ type UserPassReply struct

+ Status uint8

+ Version uint8

+ func NewUserPassReply(ver, status uint8) *UserPassReply

+ func ParseUserPassReply(r io.Reader) (*UserPassReply, error)

+ func (u *UserPassReply) Bytes() []byte

+ type UserPassRequest struct

+ Password string

+ Username string

+ Version uint8

+ func NewUserPassRequest(ver uint8, user, pass string) *UserPassRequest

+ func ParseUserPassRequest(r io.Reader) (*UserPassRequest, error)

+ func (u *UserPassRequest) Bytes() []byte