gosocks4

README

gosocks4

golang and SOCKS4(a)

Documentation

Overview

SOCKS Protocol Version 4(a) https://www.openssh.com/txt/socks4.protocol https://www.openssh.com/txt/socks4a.protocol

Index

• Constants
• Variables
• type Addr
  • func (addr *Addr) Decode(b []byte) error
  • func (addr *Addr) Encode(b []byte) error
  • func (addr *Addr) String() string
• type Reply
  • func NewReply(code uint8, addr *Addr) *Reply
  • func ReadReply(r io.Reader) (*Reply, error)
  • func (r *Reply) String() string
  • func (r *Reply) Write(w io.Writer) (err error)
• type Request
  • func NewRequest(cmd uint8, addr *Addr, userid []byte) *Request
  • func ReadRequest(r io.Reader) (*Request, error)
  • func (r *Request) String() string
  • func (r *Request) Write(w io.Writer) (err error)

Constants

const (
	CmdConnect uint8 = 1
	CmdBind          = 2
)

const (
	AddrIPv4   = 0
	AddrDomain = 1
)

const (
	Granted        = 90
	Failed         = 91
	Rejected       = 92
	RejectedUserid = 93
)

const (
	Ver4 = 4
)

Variables

var (
	ErrBadVersion      = errors.New("Bad version")
	ErrBadFormat       = errors.New("Bad format")
	ErrBadAddrType     = errors.New("Bad address type")
	ErrShortDataLength = errors.New("Short data length")
	ErrBadCmd          = errors.New("Bad Command")
)

Types

type Addr

type Addr struct {
	Type int
	Host string
	Port uint16
}

func (*Addr) Decode

func (addr *Addr) Decode(b []byte) error

func (*Addr) Encode

func (addr *Addr) Encode(b []byte) error

func (*Addr) String

func (addr *Addr) String() string

type Reply

type Reply struct {
	Code uint8
	Addr *Addr
}

+----+----+----+----+----+----+----+----+ | VN | CD | DSTPORT | DSTIP | +----+----+----+----+----+----+----+----+

1    1      2              4

func NewReply

func NewReply(code uint8, addr *Addr) *Reply

func ReadReply

func ReadReply(r io.Reader) (*Reply, error)

func (*Reply) String

func (r *Reply) String() string

func (*Reply) Write

func (r *Reply) Write(w io.Writer) (err error)

type Request

type Request struct {
	Cmd    uint8
	Addr   *Addr
	Userid []byte
}

+----+----+----+----+----+----+----+----+----+----+....+----+ | VN | CD | DSTPORT | DSTIP | USERID |NULL| +----+----+----+----+----+----+----+----+----+----+....+----+

1    1      2              4           variable       1

func NewRequest

func NewRequest(cmd uint8, addr *Addr, userid []byte) *Request

func ReadRequest

func ReadRequest(r io.Reader) (*Request, error)

func (*Request) String

func (r *Request) String() string

func (*Request) Write

func (r *Request) Write(w io.Writer) (err error)