socks5

Documentation

Index

• Constants
• Variables
• func AddrFromReader(r io.Reader) ([]byte, error)
• func AddrPortFromSlice(b []byte) (netip.AddrPort, int, error)
• func AppendAddrFromAddrPort(b []byte, addrPort netip.AddrPort) []byte
• func AppendAddrFromConnAddr(b []byte, addr conn.Addr) []byte
• func AppendFromReader(b []byte, r io.Reader) ([]byte, error)
• func ClientConnect(rw io.ReadWriter, targetAddr conn.Addr) error
• func ClientConnectUsernamePassword(rw io.ReadWriter, authMsg []byte, targetAddr conn.Addr) error
• func ClientRequest(rw io.ReadWriter, command byte, targetAddr conn.Addr) (addr conn.Addr, err error)
• func ClientRequestUsernamePassword(rw io.ReadWriter, authMsg []byte, command byte, targetAddr conn.Addr) (addr conn.Addr, err error)
• func ClientUDPAssociate(rw io.ReadWriter, targetAddr conn.Addr) (conn.Addr, error)
• func ClientUDPAssociateUsernamePassword(rw io.ReadWriter, authMsg []byte, targetAddr conn.Addr) (conn.Addr, error)
• func ConnAddrFromReader(r io.Reader) (conn.Addr, error)
• func ConnAddrFromSlice(b []byte) (conn.Addr, int, error)
• func ConnAddrFromSliceWithDomainCache(b []byte, cachedDomain string) (conn.Addr, int, string, error)
• func LengthOfAddrFromAddrPort(addrPort netip.AddrPort) int
• func LengthOfAddrFromConnAddr(addr conn.Addr) int
• func ServerAccept(rw io.ReadWriter, enableTCP, enableUDP bool) (addr conn.Addr, err error)
• func ServerAcceptUsernamePassword(rw io.ReadWriter, userInfoByUsername map[string]UserInfo, ...) (addr conn.Addr, username string, err error)
• func ValidatePacketHeader(b []byte) error
• func WriteAddrFromAddrPort(b []byte, addrPort netip.AddrPort) (n int)
• func WriteAddrFromConnAddr(b []byte, addr conn.Addr) int
• func WritePacketHeader(b []byte)
• type ReplyError
  • func (r ReplyError) Error() string
• type UnsupportedAuthMethodError
  • func (m UnsupportedAuthMethodError) Error() string
  • func (UnsupportedAuthMethodError) Is(target error) bool
• type UnsupportedCommandError
  • func (c UnsupportedCommandError) Error() string
  • func (UnsupportedCommandError) Is(target error) bool
• type UnsupportedUsernamePasswordAuthVersionError
  • func (v UnsupportedUsernamePasswordAuthVersionError) Error() string
  • func (UnsupportedUsernamePasswordAuthVersionError) Is(target error) bool
• type UnsupportedVersionError
  • func (v UnsupportedVersionError) Error() string
  • func (UnsupportedVersionError) Is(target error) bool
• type UserInfo
  • func (u UserInfo) AppendAuthMsg(b []byte) []byte
  • func (u UserInfo) AuthMsgLength() int
  • func (u UserInfo) Validate() error

Constants

const (
	AtypIPv4       = 1
	AtypDomainName = 3
	AtypIPv6       = 4
)

SOCKS address types as defined in RFC 1928 section 5.

const (
	// IPv4AddrLen is the size of an IPv4 SOCKS address in bytes.
	IPv4AddrLen = 1 + 4 + 2

	// IPv6AddrLen is the size of an IPv6 SOCKS address in bytes.
	IPv6AddrLen = 1 + 16 + 2

	// MaxAddrLen is the maximum size of a SOCKS address in bytes.
	MaxAddrLen = 1 + 1 + 255 + 2
)

const (
	MethodNoAuthenticationRequired = 0
	MethodGSSAPI                   = 1
	MethodUsernamePassword         = 2
	MethodNoAcceptable             = 0xFF
)

SOCKS5 authentication methods as defined in RFC 1928 section 3.

const (
	CmdConnect      = 1
	CmdBind         = 2
	CmdUDPAssociate = 3
)

SOCKS5 request commands as defined in RFC 1928 section 4.

const (
	ReplySucceeded                     = 0
	ReplyGeneralSocksServerFailure     = 1
	ReplyConnectionNotAllowedByRuleset = 2
	ReplyNetworkUnreachable            = 3
	ReplyHostUnreachable               = 4
	ReplyConnectionRefused             = 5
	ReplyTTLExpired                    = 6
	ReplyCommandNotSupported           = 7
	ReplyAddressTypeNotSupported       = 8
)

SOCKS5 reply field values as defined in RFC 1928 section 6.

const UsernamePasswordAuthVersion = 1

UsernamePasswordAuthVersion is the version of the username/password authentication method, as defined in RFC 1929 section 2.

const Version = 5

SOCKS version 5.

Variables

var (
	// IPv4UnspecifiedAddr represents 0.0.0.0:0.
	IPv4UnspecifiedAddr = [IPv4AddrLen]byte{AtypIPv4}

	// IPv6UnspecifiedAddr represents [::]:0.
	IPv6UnspecifiedAddr = [IPv6AddrLen]byte{AtypIPv6}
)

var (
	ErrUsernameLengthOutOfRange  = errors.New("username length out of range [1, 255]")
	ErrPasswordLengthOutOfRange  = errors.New("password length out of range [1, 255]")
	ErrNoAcceptableAuthMethod    = errors.New("no acceptable authentication method")
	ErrIncorrectUsernamePassword = errors.New("incorrect username or password")
	ErrUDPAssociateDone          = errors.New("UDP ASSOCIATE done")
)

var ErrFragmentationNotSupported = errors.New("packet fragmentation is not supported")

Functions

func AddrFromReader

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

AddrFromReader allocates and reads a SOCKS address from an io.Reader.

To avoid allocations, call AppendFromReader directly.

func AddrPortFromSlice

func AddrPortFromSlice(b []byte) (netip.AddrPort, int, error)

AddrPortFromSlice slices a SOCKS address from the beginning of b and returns the converted netip.AddrPort and the length of the SOCKS address.

func AppendAddrFromAddrPort

func AppendAddrFromAddrPort(b []byte, addrPort netip.AddrPort) []byte

AppendAddrFromAddrPort appends the netip.AddrPort to the buffer in the SOCKS address format.

If the address is an IPv4-mapped IPv6 address, it is converted to an IPv4 address.

func AppendAddrFromConnAddr

func AppendAddrFromConnAddr(b []byte, addr conn.Addr) []byte

AppendAddrFromConnAddr appends the address to the buffer in the SOCKS address format.

- Zero value address is treated as 0.0.0.0:0. - IPv4-mapped IPv6 address is converted to the equivalent IPv4 address.

func AppendFromReader

func AppendFromReader(b []byte, r io.Reader) ([]byte, error)

AppendFromReader reads just enough bytes from r to get a valid Addr and appends it to the buffer.

func ClientConnect

func ClientConnect(rw io.ReadWriter, targetAddr conn.Addr) error

ClientConnect writes a CONNECT request to targetAddr.

func ClientConnectUsernamePassword

func ClientConnectUsernamePassword(rw io.ReadWriter, authMsg []byte, targetAddr conn.Addr) error

ClientConnectUsernamePassword is like ClientConnect, but uses username/password authentication.

func ClientRequest

func ClientRequest(rw io.ReadWriter, command byte, targetAddr conn.Addr) (addr conn.Addr, err error)

ClientRequest completes the handshake and writes a request with the given command and target address to rw. It returns the bound address in the reply.

func ClientRequestUsernamePassword

func ClientRequestUsernamePassword(rw io.ReadWriter, authMsg []byte, command byte, targetAddr conn.Addr) (addr conn.Addr, err error)

ClientRequestUsernamePassword is like ClientRequest, but uses username/password authentication.

func ClientUDPAssociate

func ClientUDPAssociate(rw io.ReadWriter, targetAddr conn.Addr) (conn.Addr, error)

ClientUDPAssociate writes a UDP ASSOCIATE request to targetAddr.

func ClientUDPAssociateUsernamePassword

func ClientUDPAssociateUsernamePassword(rw io.ReadWriter, authMsg []byte, targetAddr conn.Addr) (conn.Addr, error)

ClientUDPAssociateUsernamePassword is like ClientUDPAssociate, but uses username/password authentication.

func ConnAddrFromReader

func ConnAddrFromReader(r io.Reader) (conn.Addr, error)

ConnAddrFromReader reads a SOCKS address from r and returns the converted conn.Addr.

func ConnAddrFromSlice

func ConnAddrFromSlice(b []byte) (conn.Addr, int, error)

ConnAddrFromSlice slices a SOCKS address from the beginning of b and returns the converted conn.Addr and the length of the SOCKS address.

func ConnAddrFromSliceWithDomainCache

func ConnAddrFromSliceWithDomainCache(b []byte, cachedDomain string) (conn.Addr, int, string, error)

ConnAddrFromSliceWithDomainCache is like ConnAddrFromSlice but uses a domain cache to minimize string allocations. The returned string is the updated domain cache.

func LengthOfAddrFromAddrPort

func LengthOfAddrFromAddrPort(addrPort netip.AddrPort) int

LengthOfAddrFromAddrPort returns the length of a SOCKS address converted from the netip.AddrPort.

func LengthOfAddrFromConnAddr

func LengthOfAddrFromConnAddr(addr conn.Addr) int

LengthOfAddrFromConnAddr returns the length of a SOCKS address converted from the conn.Addr.

- Zero value address is treated as 0.0.0.0:0. - IPv4-mapped IPv6 address is treated as the equivalent IPv4 address.

func ServerAccept

func ServerAccept(rw io.ReadWriter, enableTCP, enableUDP bool) (addr conn.Addr, err error)

ServerAccept processes an incoming request from rw.

enableTCP enables the CONNECT command. enableUDP enables the UDP ASSOCIATE command.

When UDP is enabled, rw must be a *net.TCPConn.

func ServerAcceptUsernamePassword

func ServerAcceptUsernamePassword(rw io.ReadWriter, userInfoByUsername map[string]UserInfo, enableTCP, enableUDP bool) (addr conn.Addr, username string, err error)

ServerAcceptUsernamePassword is like ServerAccept, but uses username/password authentication.

func ValidatePacketHeader

func ValidatePacketHeader(b []byte) error

ValidatePacketHeader validates RSV and FRAG at the beginning of b. The length of b must be at least 3 bytes.

func WriteAddrFromAddrPort

func WriteAddrFromAddrPort(b []byte, addrPort netip.AddrPort) (n int)

WriteAddrFromAddrPort writes the netip.AddrPort to the buffer in the SOCKS address format and returns the number of bytes written.

If the address is an IPv4-mapped IPv6 address, it is converted to an IPv4 address.

This function does not check whether b has sufficient space for the address. The caller may call LengthOfAddrFromAddrPort to get the required length.

func WriteAddrFromConnAddr

func WriteAddrFromConnAddr(b []byte, addr conn.Addr) int

WriteAddrFromConnAddr writes the address to the buffer in the SOCKS address format and returns the number of bytes written.

- Zero value address is treated as 0.0.0.0:0. - IPv4-mapped IPv6 address is converted to the equivalent IPv4 address.

This function does not check whether b has sufficient space for the address. The caller may call LengthOfAddrFromConnAddr to get the required length.

func WritePacketHeader

func WritePacketHeader(b []byte)

WritePacketHeader writes RSV and FRAG to the beginning of b. The length of b must be at least 3 bytes.

Types

type ReplyError

type ReplyError byte

ReplyError is an error type for SOCKS5 reply errors.

func (ReplyError) Error

func (r ReplyError) Error() string

type UnsupportedAuthMethodError

type UnsupportedAuthMethodError byte

UnsupportedAuthMethodError is an error type for unsupported SOCKS5 authentication methods.

func (UnsupportedAuthMethodError) Error

func (m UnsupportedAuthMethodError) Error() string

func (UnsupportedAuthMethodError) Is

func (UnsupportedAuthMethodError) Is(target error) bool

type UnsupportedCommandError

type UnsupportedCommandError byte

UnsupportedCommandError is an error type for unsupported SOCKS5 request commands.

func (UnsupportedCommandError) Error

func (c UnsupportedCommandError) Error() string

func (UnsupportedCommandError) Is

func (UnsupportedCommandError) Is(target error) bool

type UnsupportedUsernamePasswordAuthVersionError

type UnsupportedUsernamePasswordAuthVersionError byte

UnsupportedUsernamePasswordAuthVersionError is an error type for unsupported username/password authentication versions.

func (UnsupportedUsernamePasswordAuthVersionError) Error

func (v UnsupportedUsernamePasswordAuthVersionError) Error() string

func (UnsupportedUsernamePasswordAuthVersionError) Is

func (UnsupportedUsernamePasswordAuthVersionError) Is(target error) bool

type UnsupportedVersionError

type UnsupportedVersionError byte

UnsupportedVersionError is an error type for unsupported SOCKS versions.

func (UnsupportedVersionError) Error

func (v UnsupportedVersionError) Error() string

func (UnsupportedVersionError) Is

func (UnsupportedVersionError) Is(target error) bool

type UserInfo

type UserInfo struct {
	// Username is the username.
	// It must be non-empty and at most 255 bytes long.
	Username string `json:"username"`

	// Password is the password.
	// It must be non-empty and at most 255 bytes long.
	Password string `json:"password"`
}

UserInfo is a username/password pair.

func (UserInfo) AppendAuthMsg

func (u UserInfo) AppendAuthMsg(b []byte) []byte

AppendAuthMsg appends the username/password pair as an authentication message to b.

Call Validate first to ensure the username and password are valid.

func (UserInfo) AuthMsgLength

func (u UserInfo) AuthMsgLength() int

AuthMsgLength returns the length of the authentication message for the username/password pair.

func (UserInfo) Validate

func (u UserInfo) Validate() error

Validate checks if the username and password are valid.