socks

Documentation

Overview

Package socks is a generated protocol buffer package.

It is generated from these files:

v2ray.com/core/proxy/socks/config.proto

It has these top-level messages:

Account
ServerConfig
ClientConfig

Index

• Variables
• type Account
  • func (v *Account) AsAccount() (protocol.Account, error)
  • func (*Account) Descriptor() ([]byte, []int)
  • func (v *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 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(config *ServerConfig, space app.Space, meta *proxy.InboundHandlerMeta) *Server
  • func (v *Server) Close()
  • func (v *Server) Port() v2net.Port
  • func (v *Server) Start() 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 (v *ServerConfig) GetNetAddress() v2net.Address
  • func (m *ServerConfig) GetTimeout() uint32
  • func (m *ServerConfig) GetUdpEnabled() bool
  • func (v *ServerConfig) HasAccount(username, password string) bool
  • func (*ServerConfig) ProtoMessage()
  • func (m *ServerConfig) Reset()
  • func (m *ServerConfig) String() string
• type ServerFactory
  • func (v *ServerFactory) Create(space app.Space, rawConfig interface{}, meta *proxy.InboundHandlerMeta) (proxy.InboundHandler, error)
  • func (v *ServerFactory) StreamCapability() v2net.NetworkList

Variables

var (
	ErrUnsupportedSocksCommand = errors.New("Unsupported socks command.")
	ErrUnsupportedAuthMethod   = errors.New("Unsupported auth method.")
)

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

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

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 (v *Account) AsAccount() (protocol.Account, error)

func (*Account) Descriptor

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

func (*Account) Equals

func (v *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 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(config *ServerConfig, space app.Space, meta *proxy.InboundHandlerMeta) *Server

NewServer creates a new Server object.

func (*Server) Close

func (v *Server) Close()

Close implements InboundHandler.Close().

func (*Server) Port

func (v *Server) Port() v2net.Port

Port implements InboundHandler.Port().

func (*Server) Start

func (v *Server) Start() error

Listen implements InboundHandler.Listen().

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) GetNetAddress

func (v *ServerConfig) GetNetAddress() v2net.Address

func (*ServerConfig) GetTimeout

func (m *ServerConfig) GetTimeout() uint32

func (*ServerConfig) GetUdpEnabled

func (m *ServerConfig) GetUdpEnabled() bool

func (*ServerConfig) HasAccount

func (v *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 ServerFactory

type ServerFactory struct{}

func (*ServerFactory) Create

func (v *ServerFactory) Create(space app.Space, rawConfig interface{}, meta *proxy.InboundHandlerMeta) (proxy.InboundHandler, error)

func (*ServerFactory) StreamCapability

func (v *ServerFactory) StreamCapability() v2net.NetworkList