socks5

Documentation

Index

• Constants
• Variables
• type AddrSpec
  • func (a *AddrSpec) Address() string
  • func (a *AddrSpec) String() string
• type AddressRewriter
• type AuthContext
• type Authenticator
• type Config
• type CredentialStore
• type DNSResolver
  • func (d DNSResolver) Resolve(ctx context.Context, name string) (context.Context, net.IP, error)
• type NameResolver
• type NoAuthAuthenticator
  • func (a NoAuthAuthenticator) Authenticate(_ io.Reader, writer io.Writer) (*AuthContext, error)
  • func (a NoAuthAuthenticator) GetCode() uint8
• type PermitCommand
  • func (p *PermitCommand) Allow(ctx context.Context, req *Request) (context.Context, bool)
• type Request
  • func NewRequest(bufConn io.Reader) (*Request, error)
• type RuleSet
  • func PermitAll() RuleSet
  • func PermitNone() RuleSet
• type Server
  • func New(conf *Config) (*Server, error)
  • func (s *Server) Handler(conn net.Conn, bufConn *bufio.Reader) error
• type StaticCredentials
  • func (s StaticCredentials) Valid(user, password string) bool
• type UserPassAuthenticator
  • func (a UserPassAuthenticator) Authenticate(reader io.Reader, writer io.Writer) (*AuthContext, error)
  • func (a UserPassAuthenticator) GetCode() uint8

Constants

const (
	NoAuth = uint8(0)

	UserPassAuth = uint8(2)
)

const (
	ConnectCommand   = uint8(1)
	BindCommand      = uint8(2)
	AssociateCommand = uint8(3)
)

const (
	Socks5Version = uint8(5)
)

Variables

var (
	UserAuthFailed  = fmt.Errorf("user authentication failed")
	NoSupportedAuth = fmt.Errorf("no supported authentication mechanism")
)

Types

type AddrSpec

type AddrSpec struct {
	FQDN string
	IP   net.IP
	Port int
}

func (*AddrSpec) Address

func (a *AddrSpec) Address() string

func (*AddrSpec) String

func (a *AddrSpec) String() string

type AddressRewriter

type AddressRewriter interface {
	Rewrite(ctx context.Context, request *Request) (context.Context, *AddrSpec)
}

type AuthContext

type AuthContext struct {
	Method  uint8
	Payload map[string]string
}

type Authenticator

type Authenticator interface {
	Authenticate(reader io.Reader, writer io.Writer) (*AuthContext, error)
	GetCode() uint8
}

type Config

type Config struct {
	AuthMethods []Authenticator
	Credentials CredentialStore
	Resolver    NameResolver
	Rules       RuleSet
	Rewriter    AddressRewriter
	BindIP      net.IP
	Dial        func(ctx context.Context, network, addr string) (net.Conn, error)
}

type CredentialStore

type CredentialStore interface {
	Valid(user, password string) bool
}

type DNSResolver

type DNSResolver struct{}

func (DNSResolver) Resolve

func (d DNSResolver) Resolve(ctx context.Context, name string) (context.Context, net.IP, error)

type NameResolver

type NameResolver interface {
	Resolve(ctx context.Context, name string) (context.Context, net.IP, error)
}

type NoAuthAuthenticator

type NoAuthAuthenticator struct{}

func (NoAuthAuthenticator) Authenticate

func (a NoAuthAuthenticator) Authenticate(_ io.Reader, writer io.Writer) (*AuthContext, error)

func (NoAuthAuthenticator) GetCode

func (a NoAuthAuthenticator) GetCode() uint8

type PermitCommand

type PermitCommand struct {
	EnableConnect   bool
	EnableBind      bool
	EnableAssociate bool
}

func (*PermitCommand) Allow

func (p *PermitCommand) Allow(ctx context.Context, req *Request) (context.Context, bool)

type Request

type Request struct {
	Version     uint8
	Command     uint8
	AuthContext *AuthContext
	RemoteAddr  *AddrSpec
	DestAddr    *AddrSpec
	// contains filtered or unexported fields
}

func NewRequest

func NewRequest(bufConn io.Reader) (*Request, error)

type RuleSet

type RuleSet interface {
	Allow(ctx context.Context, req *Request) (context.Context, bool)
}

func PermitAll

func PermitAll() RuleSet

func PermitNone

func PermitNone() RuleSet

type Server

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

func New

func New(conf *Config) (*Server, error)

func (*Server) Handler

func (s *Server) Handler(conn net.Conn, bufConn *bufio.Reader) error

type StaticCredentials

type StaticCredentials map[string]string

func (StaticCredentials) Valid

func (s StaticCredentials) Valid(user, password string) bool

type UserPassAuthenticator

type UserPassAuthenticator struct {
	Credentials CredentialStore
}

func (UserPassAuthenticator) Authenticate

func (a UserPassAuthenticator) Authenticate(reader io.Reader, writer io.Writer) (*AuthContext, error)

func (UserPassAuthenticator) GetCode

func (a UserPassAuthenticator) GetCode() uint8