socks

type Authenticator interface {
	Authenticate(r *Request) bool
}

type Dialer interface {
	Dial(r *Request) (net.Conn, error)
}

type Request struct {
	// Version is either SOCKS4 or SOCKS5
	Version version

	// Hostname is the destination DNS hostname.
	// If this is empty, IP is set to the destination address.
	Hostname string

	// Command is the requested command.
	Command commandType

	// IP is the destination IP address.
	// This may not be set if Hostname is not empty.
	IP net.IP

	// Port is the destination port number.
	Port int

	// Username is user name string for authentication.
	// Username may be empty when no authencation is requested.
	Username string

	// Password is password string for authentication.
	Password string

	// Conn is the connection from the client.
	Conn net.Conn
	// contains filtered or unexported fields
}

type RuleSet interface {
	Match(r *Request) bool
}

type Server struct {
	// Auth can be used to authenticate a request.
	// If nil, all requests are allowed.
	Auth Authenticator

	// Rules can be used to test a request if it matches rules.
	// If nil, all requests passes.
	Rules RuleSet

	// Dialer is used to make connections to destination servers.
	// If nil, net.DialContext is used.
	Dialer Dialer

	// Logger can be used to provide a custom logger.
	// If nil, the default logger is used.
	Logger *log.Logger

	// ShutdownTimeout is the maximum duration the server waits for
	// all connections to be closed before shutdown.
	//
	// Zero duration disables timeout.
	ShutdownTimeout time.Duration

	// Env is the environment where this server runs.
	//
	// The global environment is used if Env is nil.
	Env *well.Environment

	// SilenceLogs changes Info-level logs to Debug-level ones.
	SilenceLogs bool
	// contains filtered or unexported fields
}