socks5

README

socks5

Socks5/Socks5h server and client

This project is to add protocol support for the Bridge, or it can be used alone

The following is the implementation of other proxy protocols

• Socks4
• HTTP Proxy
• Shadow Socks
• SSH Proxy
• Any Proxy
• Emux

Usage

API Documentation

Example

• Support for the CONNECT command
• Support for the BIND command
• Support for the ASSOCIATE command

License

Licensed under the MIT License. See LICENSE for the full license text.

Documentation

Index

• type Authentication
  • func UserAuth(username, password string) Authentication
• type AuthenticationFunc
  • func (f AuthenticationFunc) Auth(cmd Command, username, password string) bool
• type BytesPool
• type Command
  • func (cmd Command) String() string
• type Dialer
  • func NewDialer(addr string) (*Dialer, error)
  • func (d *Dialer) Dial(network, address string) (net.Conn, error)
  • func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)
  • func (d *Dialer) Listen(ctx context.Context, network, address string) (net.Listener, error)
• type Logger
• type Server
  • func NewServer() *Server
  • func (s *Server) ListenAndServe(network, addr string) error
  • func (s *Server) Serve(l net.Listener) error
  • func (s *Server) ServeConn(conn net.Conn)
• type SimpleServer
  • func NewSimpleServer(addr string) (*SimpleServer, error)
  • func (s *SimpleServer) Close() error
  • func (s *SimpleServer) ProxyURL() string
  • func (s *SimpleServer) Run(ctx context.Context) error
  • func (s *SimpleServer) Start(ctx context.Context) error
• type UDPConn
  • func NewUDPConn(raw net.PacketConn, proxyAddress net.Addr, defaultTarget net.Addr) (*UDPConn, error)
  • func (c *UDPConn) Read(b []byte) (int, error)
  • func (c *UDPConn) ReadFrom(p []byte) (n int, addr net.Addr, err error)
  • func (c *UDPConn) ReadFromUDP(p []byte) (n int, addr *net.UDPAddr, err error)
  • func (c *UDPConn) ReadFromUDPAddrPort(b []byte) (n int, addr netip.AddrPort, err error)
  • func (c *UDPConn) ReadMsgUDP(b, oob []byte) (n, oobn, flags int, addr *net.UDPAddr, err error)
  • func (c *UDPConn) ReadMsgUDPAddrPort(b, oob []byte) (n, oobn, flags int, addr netip.AddrPort, err error)
  • func (c *UDPConn) RemoteAddr() net.Addr
  • func (c *UDPConn) SetDeadline(t time.Time) error
  • func (c *UDPConn) SetReadBuffer(bytes int) error
  • func (c *UDPConn) SetReadDeadline(t time.Time) error
  • func (c *UDPConn) SetWriteBuffer(bytes int) error
  • func (c *UDPConn) SetWriteDeadline(t time.Time) error
  • func (c *UDPConn) Write(b []byte) (int, error)
  • func (c *UDPConn) WriteMsgUDP(b, oob []byte, addr *net.UDPAddr) (n, oobn int, err error)
  • func (c *UDPConn) WriteMsgUDPAddrPort(b, oob []byte, addr netip.AddrPort) (n, oobn int, err error)
  • func (c *UDPConn) WriteTo(p []byte, addr net.Addr) (n int, err error)
  • func (c *UDPConn) WriteToUDP(p []byte, addr *net.UDPAddr) (n int, err error)
  • func (c *UDPConn) WriteToUDPAddrPort(b []byte, addr netip.AddrPort) (n int, err error)

Types

type Authentication

type Authentication interface {
	Auth(cmd Command, username, password string) bool
}

Authentication proxy authentication

func UserAuth

func UserAuth(username, password string) Authentication

UserAuth basic authentication

type AuthenticationFunc

type AuthenticationFunc func(cmd Command, username, password string) bool

AuthenticationFunc Authentication interface is implemented

func (AuthenticationFunc) Auth

func (f AuthenticationFunc) Auth(cmd Command, username, password string) bool

Auth authentication processing

type BytesPool

type BytesPool interface {
	Get() []byte
	Put([]byte)
}

BytesPool is an interface for getting and returning temporary bytes for use by io.CopyBuffer.

type Command

type Command byte

Command is a SOCKS Command.

const (
	ConnectCommand   Command = 0x01
	BindCommand      Command = 0x02
	AssociateCommand Command = 0x03
)

func (Command) String

func (cmd Command) String() string

type Dialer

type Dialer struct {
	// ProxyNetwork network between a proxy server and a client
	ProxyNetwork string
	// ProxyAddress proxy server address
	ProxyAddress string
	// ProxyDial specifies the optional dial function for
	// establishing the transport connection.
	ProxyDial func(ctx context.Context, network string, address string) (net.Conn, error)
	// ProxyPacketDial specifies the optional proxyPacketDial function for
	// establishing the transport connection.
	ProxyPacketDial func(ctx context.Context, network string, address string) (net.PacketConn, error)
	// Username use username authentication if not empty
	Username string
	// Password use password authentication if not empty,
	// only valid if username is set
	Password string
	// IsResolve resolve domain name on locally
	IsResolve bool
	// Resolver optionally specifies an alternate resolver to use
	Resolver *net.Resolver
	// Timeout is the maximum amount of time a dial will wait for
	// a connect to complete. The default is no timeout
	Timeout time.Duration
}

Dialer is a SOCKS5 dialer.

func NewDialer

func NewDialer(addr string) (*Dialer, error)

NewDialer returns a new Dialer that dials through the provided proxy server's network and address.

func (*Dialer) Dial

func (d *Dialer) Dial(network, address string) (net.Conn, error)

Dial connects to the provided address on the provided network.

func (*Dialer) DialContext

func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)

DialContext connects to the provided address on the provided network.

func (*Dialer) Listen

func (d *Dialer) Listen(ctx context.Context, network, address string) (net.Listener, error)

type Logger

type Logger interface {
	Println(v ...interface{})
}

type Server

type Server struct {
	// Authentication is proxy authentication
	Authentication Authentication
	// ProxyDial specifies the optional proxyDial function for
	// establishing the transport connection.
	ProxyDial func(ctx context.Context, network string, address string) (net.Conn, error)
	// ProxyListen specifies the optional proxyListen function for
	// establishing the transport connection.
	ProxyListen func(ctx context.Context, network string, address string) (net.Listener, error)
	// ProxyListenPacket specifies the optional proxyListenPacket function for
	// establishing the transport connection.
	ProxyListenPacket func(ctx context.Context, network string, address string) (net.PacketConn, error)
	// ProxyOutgoingListenPacket specifies the optional proxyOutgoingListenPacket function for
	// establishing outgoing UDP connections. If not set, ProxyListenPacket is used for both
	// relay and outgoing connections.
	ProxyOutgoingListenPacket func(ctx context.Context, network string, address string) (net.PacketConn, error)
	// PacketForwardAddress specifies the packet forwarding address
	PacketForwardAddress func(ctx context.Context, destinationAddr string, packet net.PacketConn, conn net.Conn) (net.IP, int, error)
	// ProxyListenBind specifies the optional proxyListenBind function for
	// establishing the transport connection.
	ProxyListenBind func(ctx context.Context, network string, address string) (net.Listener, error)
	// ListenBindReuseTimeout is the timeout for reusing bind listener
	ListenBindReuseTimeout time.Duration
	// ListenBindAcceptTimeout is the timeout for accepting connections on bind listener
	ListenBindAcceptTimeout time.Duration

	// Logger error log
	Logger Logger
	// Context is default context
	Context context.Context
	// BytesPool getting and returning temporary bytes for use by io.CopyBuffer
	BytesPool BytesPool
	// contains filtered or unexported fields
}

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

func NewServer

func NewServer() *Server

NewServer creates a new Server

func (*Server) ListenAndServe

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

ListenAndServe is used to create a listener and serve on it

func (*Server) Serve

func (s *Server) Serve(l net.Listener) error

Serve is used to serve connections from a listener

func (*Server) ServeConn

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

ServeConn is used to serve a single connection.

type SimpleServer

type SimpleServer struct {
	Server
	Listener net.Listener
	Network  string
	Address  string
	Username string
	Password string
}

SimpleServer is a simplified server, which can be configured as easily as client.

func NewSimpleServer

func NewSimpleServer(addr string) (*SimpleServer, error)

NewServer creates a new NewSimpleServer

func (*SimpleServer) Close

func (s *SimpleServer) Close() error

Close closes the listener

func (*SimpleServer) ProxyURL

func (s *SimpleServer) ProxyURL() string

ProxyURL returns the URL of the proxy

func (*SimpleServer) Run

func (s *SimpleServer) Run(ctx context.Context) error

Run the server

func (*SimpleServer) Start

func (s *SimpleServer) Start(ctx context.Context) error

Start the server

type UDPConn

type UDPConn struct {
	net.PacketConn
	// contains filtered or unexported fields
}

func NewUDPConn

func NewUDPConn(raw net.PacketConn, proxyAddress net.Addr, defaultTarget net.Addr) (*UDPConn, error)

func (*UDPConn) Read

func (c *UDPConn) Read(b []byte) (int, error)

Read implements the net.Conn Read method.

func (*UDPConn) ReadFrom

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

ReadFrom implements the net.PacketConn ReadFrom method.

func (*UDPConn) ReadFromUDP

func (c *UDPConn) ReadFromUDP(p []byte) (n int, addr *net.UDPAddr, err error)

ReadFromUDP implements the net.UDPConn ReadFromUDP method.

func (*UDPConn) ReadFromUDPAddrPort

func (c *UDPConn) ReadFromUDPAddrPort(b []byte) (n int, addr netip.AddrPort, err error)

ReadFromUDPAddrPort implements the net.UDPConn ReadFromUDPAddrPort method.

func (*UDPConn) ReadMsgUDP

func (c *UDPConn) ReadMsgUDP(b, oob []byte) (n, oobn, flags int, addr *net.UDPAddr, err error)

ReadMsgUDP implements the net.UDPConn ReadMsgUDP method.

func (*UDPConn) ReadMsgUDPAddrPort

func (c *UDPConn) ReadMsgUDPAddrPort(b, oob []byte) (n, oobn, flags int, addr netip.AddrPort, err error)

ReadMsgUDPAddrPort implements the net.UDPConn ReadMsgUDPAddrPort method.

func (*UDPConn) RemoteAddr

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

RemoteAddr implements the net.Conn RemoteAddr method.

func (*UDPConn) SetDeadline

func (c *UDPConn) SetDeadline(t time.Time) error

SetDeadline implements the Conn SetDeadline method.

func (*UDPConn) SetReadBuffer

func (c *UDPConn) SetReadBuffer(bytes int) error

SetReadBuffer implements the net.UDPConn SetReadBuffer method.

func (*UDPConn) SetReadDeadline

func (c *UDPConn) SetReadDeadline(t time.Time) error

SetReadDeadline implements the Conn SetReadDeadline method.

func (*UDPConn) SetWriteBuffer

func (c *UDPConn) SetWriteBuffer(bytes int) error

SetWriteBuffer implements the net.UDPConn SetWriteBuffer method.

func (*UDPConn) SetWriteDeadline

func (c *UDPConn) SetWriteDeadline(t time.Time) error

SetWriteDeadline implements the Conn SetWriteDeadline method.

func (*UDPConn) Write

func (c *UDPConn) Write(b []byte) (int, error)

Write implements the net.Conn Write method.

func (*UDPConn) WriteMsgUDP

func (c *UDPConn) WriteMsgUDP(b, oob []byte, addr *net.UDPAddr) (n, oobn int, err error)

WriteMsgUDP implements the net.UDPConn WriteMsgUDP method.

func (*UDPConn) WriteMsgUDPAddrPort

func (c *UDPConn) WriteMsgUDPAddrPort(b, oob []byte, addr netip.AddrPort) (n, oobn int, err error)

WriteMsgUDPAddrPort implements the net.UDPConn WriteMsgUDPAddrPort method.

func (*UDPConn) WriteTo

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

WriteTo implements the net.PacketConn WriteTo method.

func (*UDPConn) WriteToUDP

func (c *UDPConn) WriteToUDP(p []byte, addr *net.UDPAddr) (n int, err error)

WriteToUDP implements the net.UDPConn WriteToUDP method.

func (*UDPConn) WriteToUDPAddrPort

func (c *UDPConn) WriteToUDPAddrPort(b []byte, addr netip.AddrPort) (n int, err error)

WriteToUDPAddrPort implements the net.UDPConn WriteToUDPAddrPort method.