socks

Documentation

Overview

Package socks provides implements of Socks protocol 4, 4a and 5.

Index

• Variables
• func ClientHandshake(request *protocol.RequestHeader, reader io.Reader, writer io.Writer) (*protocol.RequestHeader, error)
• func DecodeUDPPacket(packet []byte) (*protocol.RequestHeader, []byte, error)
• func EncodeUDPPacket(request *protocol.RequestHeader, data []byte) (*buf.Buffer, error)
• type Account
  • func (a *Account) AsAccount() (protocol.Account, error)
  • func (*Account) Descriptor() ([]byte, []int)
  • func (a *Account) Equals(another protocol.Account) bool
  • func (m *Account) GetPassword() string
  • func (m *Account) GetUsername() string
  • func (*Account) ProtoMessage()
  • func (m *Account) Reset()
  • func (m *Account) String() string
• type AuthType
  • func (AuthType) EnumDescriptor() ([]byte, []int)
  • func (x AuthType) String() string
• type Client
  • func NewClient(ctx context.Context, config *ClientConfig) (*Client, error)
  • func (c *Client) Process(ctx context.Context, ray ray.OutboundRay, dialer proxy.Dialer) error
• type ClientConfig
  • func (*ClientConfig) Descriptor() ([]byte, []int)
  • func (m *ClientConfig) GetServer() []*v2ray_core_common_protocol1.ServerEndpoint
  • func (*ClientConfig) ProtoMessage()
  • func (m *ClientConfig) Reset()
  • func (m *ClientConfig) String() string
• type Server
  • func NewServer(ctx context.Context, config *ServerConfig) (*Server, error)
  • func (s *Server) Network() net.NetworkList
  • func (s *Server) Process(ctx context.Context, network net.Network, conn internet.Connection, ...) error
• type ServerConfig
  • func (*ServerConfig) Descriptor() ([]byte, []int)
  • func (m *ServerConfig) GetAccounts() map[string]string
  • func (m *ServerConfig) GetAddress() *v2ray_core_common_net.IPOrDomain
  • func (m *ServerConfig) GetAuthType() AuthType
  • func (m *ServerConfig) GetTimeout() uint32
  • func (m *ServerConfig) GetUdpEnabled() bool
  • func (c *ServerConfig) HasAccount(username, password string) bool
  • func (*ServerConfig) ProtoMessage()
  • func (m *ServerConfig) Reset()
  • func (m *ServerConfig) String() string
• type ServerSession
  • func (s *ServerSession) Handshake(reader io.Reader, writer io.Writer) (*protocol.RequestHeader, error)
• type UDPReader
  • func NewUDPReader(reader io.Reader) *UDPReader
  • func (r *UDPReader) Read() (buf.MultiBuffer, error)
• type UDPWriter
  • func NewUDPWriter(request *protocol.RequestHeader, writer io.Writer) *UDPWriter
  • func (w *UDPWriter) Write(b []byte) (int, error)

Variables

var AuthType_name = map[int32]string{
	0: "NO_AUTH",
	1: "PASSWORD",
}

var AuthType_value = map[string]int32{
	"NO_AUTH":  0,
	"PASSWORD": 1,
}

Functions

func ClientHandshake

func ClientHandshake(request *protocol.RequestHeader, reader io.Reader, writer io.Writer) (*protocol.RequestHeader, error)

func DecodeUDPPacket

func DecodeUDPPacket(packet []byte) (*protocol.RequestHeader, []byte, error)

func EncodeUDPPacket

func EncodeUDPPacket(request *protocol.RequestHeader, data []byte) (*buf.Buffer, error)

Types

type Account

type Account struct {
	Username string `protobuf:"bytes,1,opt,name=username" json:"username,omitempty"`
	Password string `protobuf:"bytes,2,opt,name=password" json:"password,omitempty"`
}

func (*Account) AsAccount

func (a *Account) AsAccount() (protocol.Account, error)

func (*Account) Descriptor

func (*Account) Descriptor() ([]byte, []int)

func (*Account) Equals

func (a *Account) Equals(another protocol.Account) bool

func (*Account) GetPassword

func (m *Account) GetPassword() string

func (*Account) GetUsername

func (m *Account) GetUsername() string

func (*Account) ProtoMessage

func (*Account) ProtoMessage()

func (*Account) Reset

func (m *Account) Reset()

func (*Account) String

func (m *Account) String() string

type AuthType

type AuthType int32

const (
	AuthType_NO_AUTH  AuthType = 0
	AuthType_PASSWORD AuthType = 1
)

func (AuthType) EnumDescriptor

func (AuthType) EnumDescriptor() ([]byte, []int)

func (AuthType) String

func (x AuthType) String() string

type Client

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

Client is a Socks5 client.

func NewClient

func NewClient(ctx context.Context, config *ClientConfig) (*Client, error)

NewClient create a new Socks5 client based on the given config.

func (*Client) Process

func (c *Client) Process(ctx context.Context, ray ray.OutboundRay, dialer proxy.Dialer) error

Process implements proxy.Outbound.Process.

type ClientConfig

type ClientConfig struct {
	Server []*v2ray_core_common_protocol1.ServerEndpoint `protobuf:"bytes,1,rep,name=server" json:"server,omitempty"`
}

func (*ClientConfig) Descriptor

func (*ClientConfig) Descriptor() ([]byte, []int)

func (*ClientConfig) GetServer

func (m *ClientConfig) GetServer() []*v2ray_core_common_protocol1.ServerEndpoint

func (*ClientConfig) ProtoMessage

func (*ClientConfig) ProtoMessage()

func (*ClientConfig) Reset

func (m *ClientConfig) Reset()

func (*ClientConfig) String

func (m *ClientConfig) String() string

type Server

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

Server is a SOCKS 5 proxy server

func NewServer

func NewServer(ctx context.Context, config *ServerConfig) (*Server, error)

NewServer creates a new Server object.

func (*Server) Network

func (s *Server) Network() net.NetworkList

func (*Server) Process

func (s *Server) Process(ctx context.Context, network net.Network, conn internet.Connection, dispatcher dispatcher.Interface) error

type ServerConfig

type ServerConfig struct {
	AuthType   AuthType                          `protobuf:"varint,1,opt,name=auth_type,json=authType,enum=v2ray.core.proxy.socks.AuthType" json:"auth_type,omitempty"`
	Accounts   map[string]string                 `` /* 136-byte string literal not displayed */
	Address    *v2ray_core_common_net.IPOrDomain `protobuf:"bytes,3,opt,name=address" json:"address,omitempty"`
	UdpEnabled bool                              `protobuf:"varint,4,opt,name=udp_enabled,json=udpEnabled" json:"udp_enabled,omitempty"`
	Timeout    uint32                            `protobuf:"varint,5,opt,name=timeout" json:"timeout,omitempty"`
}

func (*ServerConfig) Descriptor

func (*ServerConfig) Descriptor() ([]byte, []int)

func (*ServerConfig) GetAccounts

func (m *ServerConfig) GetAccounts() map[string]string

func (*ServerConfig) GetAddress

func (m *ServerConfig) GetAddress() *v2ray_core_common_net.IPOrDomain

func (*ServerConfig) GetAuthType

func (m *ServerConfig) GetAuthType() AuthType

func (*ServerConfig) GetTimeout

func (m *ServerConfig) GetTimeout() uint32

func (*ServerConfig) GetUdpEnabled

func (m *ServerConfig) GetUdpEnabled() bool

func (*ServerConfig) HasAccount

func (c *ServerConfig) HasAccount(username, password string) bool

func (*ServerConfig) ProtoMessage

func (*ServerConfig) ProtoMessage()

func (*ServerConfig) Reset

func (m *ServerConfig) Reset()

func (*ServerConfig) String

func (m *ServerConfig) String() string

type ServerSession

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

func (*ServerSession) Handshake

func (s *ServerSession) Handshake(reader io.Reader, writer io.Writer) (*protocol.RequestHeader, error)

type UDPReader

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

func NewUDPReader

func NewUDPReader(reader io.Reader) *UDPReader

func (*UDPReader) Read

func (r *UDPReader) Read() (buf.MultiBuffer, error)

type UDPWriter

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

func NewUDPWriter

func NewUDPWriter(request *protocol.RequestHeader, writer io.Writer) *UDPWriter

func (*UDPWriter) Write

func (w *UDPWriter) Write(b []byte) (int, error)

Write implements io.Writer.