socks5

Documentation

Index

• Constants
• type MethodReply
  • func (*MethodReply) Len() int64
  • func (r *MethodReply) ReadFrom(in io.Reader) (int64, error)
• type MethodRequest
  • func NewMethodRequest(version byte, methods ...byte) *MethodRequest
  • func (r *MethodRequest) Len() int64
  • func (r *MethodRequest) WriteTo(w io.Writer) (int64, error)
• type ScanResult
  • func (r *ScanResult) ID() string
  • func (r *ScanResult) MarshalJSON() ([]byte, error)
  • func (r *ScanResult) String() string
• type Scanner
  • func NewScanner(opts ...ScannerOption) *Scanner
  • func (s *Scanner) Scan(ctx context.Context, r *scan.Request) (result scan.Result, err error)
• type ScannerOption
  • func WithDataTimeout(timeout time.Duration) ScannerOption
  • func WithDialTimeout(timeout time.Duration) ScannerOption

Constants

const (
	ScanType     = "socks"
	SOCKSVersion = 5
)

const MethodNoAuth = 0

Types

type MethodReply

type MethodReply struct {
	Ver    byte // version of the protocol
	Method byte // server selects from one of the methods given in the request METHODS field.
}

MethodReply is a negotiation reply for the authentication method to be used. From RFC1928: +----+--------+ |VER | METHOD | +----+--------+ | 1 | 1 | +----+--------+

func (*MethodReply) Len

func (*MethodReply) Len() int64

func (*MethodReply) ReadFrom

func (r *MethodReply) ReadFrom(in io.Reader) (int64, error)

type MethodRequest

type MethodRequest struct {
	Ver      byte // version of the protocol
	NMethods byte // number of method identifier octets that appear in the METHODS field.
	Methods  []byte
}

MethodRequest is a negotiation request for the authentication method to be used. It is the initial message that the client sends to the SOCKS5 server. From RFC1928: +----+----------+----------+ |VER | NMETHODS | METHODS | +----+----------+----------+ | 1 | 1 | 1 to 255 | +----+----------+----------+

func NewMethodRequest

func NewMethodRequest(version byte, methods ...byte) *MethodRequest

func (*MethodRequest) Len

func (r *MethodRequest) Len() int64

func (*MethodRequest) WriteTo

func (r *MethodRequest) WriteTo(w io.Writer) (int64, error)

type ScanResult

type ScanResult struct {
	ScanType string `json:"scan"`
	Version  int    `json:"version"`
	IP       string `json:"ip"`
	Port     uint16 `json:"port"`
	Auth     bool   `json:"auth,omitempty"`
}

func (*ScanResult) ID

func (r *ScanResult) ID() string

func (*ScanResult) MarshalJSON

func (r *ScanResult) MarshalJSON() ([]byte, error)

func (*ScanResult) String

func (r *ScanResult) String() string

type Scanner

type Scanner struct {
	// contains filtered or unexported fields
}

func NewScanner

func NewScanner(opts ...ScannerOption) *Scanner

func (*Scanner) Scan

func (s *Scanner) Scan(ctx context.Context, r *scan.Request) (result scan.Result, err error)

type ScannerOption

type ScannerOption func(*Scanner)

func WithDataTimeout

func WithDataTimeout(timeout time.Duration) ScannerOption

func WithDialTimeout

func WithDialTimeout(timeout time.Duration) ScannerOption