socks

Documentation

Index

• Constants
• Variables
• func ATYP(b byte) int
• func UoT(b byte) bool
• type Addr
  • func ParseAddr(s string) Addr
  • func ReadAddr(r io.Reader) (Addr, error)
  • func ReadAddrBuf(r io.Reader, b []byte) (Addr, error)
  • func SplitAddr(b []byte) Addr
  • func (a Addr) String() string

Constants

const (
	AuthNone     = 0
	AuthPassword = 2
)

SOCKS auth type

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

SOCKS request commands as defined in RFC 1928 section 4.

const (
	ATypIP4    = 1
	ATypDomain = 3
	ATypIP6    = 4
)

SOCKS address types as defined in RFC 1928 section 5.

const MaxAddrLen = 1 + 1 + 255 + 2

MaxAddrLen is the maximum size of SOCKS address in bytes.

Variables

var Errors = []error{
	errors.New(""),
	errors.New("general failure"),
	errors.New("connection forbidden"),
	errors.New("network unreachable"),
	errors.New("host unreachable"),
	errors.New("connection refused"),
	errors.New("TTL expired"),
	errors.New("command not supported"),
	errors.New("address type not supported"),
	errors.New("socks5UDPAssociate"),
}

Errors are socks5 errors

Functions

func ATYP

func ATYP(b byte) int

ATYP returns the address type

func UoT

func UoT(b byte) bool

UoT returns whether it is udp over tcp

Types

type Addr

type Addr []byte

Addr .

func ParseAddr

func ParseAddr(s string) Addr

ParseAddr parses the address in string s. Returns nil if failed.

func ReadAddr

func ReadAddr(r io.Reader) (Addr, error)

ReadAddr reads just enough bytes from r to get a valid Addr.

func ReadAddrBuf

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

ReadAddrBuf reads just enough bytes from r to get a valid Addr.

func SplitAddr

func SplitAddr(b []byte) Addr

SplitAddr slices a SOCKS address from beginning of b. Returns nil if failed.

func (Addr) String

func (a Addr) String() string

String serializes SOCKS address a to string form.