socks5

Documentation

Overview

Package socks5 is a SOCKS5 server implementation.

This is used for userspace networking in Tailscale. Specifically, this is used for dialing out of the machine to other nodes, without the host kernel's involvement, so it doesn't proper routing tables, TUN, IPv6, etc. This package is meant to only handle the SOCKS5 protocol details and not any integration with Tailscale internals itself.

The glue between this package and Tailscale is in net/socks5/tssocks.

Index

• type Conn
  • func (c *Conn) Run() error
• type Server
  • func (s *Server) Serve(l net.Listener) error

Types

type Conn

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

Conn is a SOCKS5 connection for client to reach server.

func (*Conn) Run

func (c *Conn) Run() error

Run starts the new connection.

type Server

type Server struct {
	// Logf optionally specifies the logger to use.
	// If nil, the standard logger is used.
	Logf logger.Logf

	// Dialer optionally specifies the dialer to use for outgoing connections.
	// If nil, the net package's standard dialer is used.
	Dialer func(ctx context.Context, network, addr string) (net.Conn, error)

	// Username and Password, if set, are the credential clients must provide.
	Username string
	Password string
}

Server is a SOCKS5 proxy server.

func (*Server) Serve

func (s *Server) Serve(l net.Listener) error

Serve accepts and handles incoming connections on the given listener.