wiresocks

Documentation

Index

• func NewVtunUDPForwarder(ctx context.Context, localBind netip.AddrPort, dest string, vtun *VirtualTun, ...) (netip.AddrPort, error)
• func RunScan(ctx context.Context, l *slog.Logger, opts ScanOptions) (result []ipscanner.IPInfo, err error)
• type Configuration
  • func ParseConfig(path string, endpoint string) (*Configuration, error)
• type InterfaceConfig
  • func ParseInterface(cfg *ini.File) (InterfaceConfig, error)
• type PeerConfig
  • func ParsePeers(cfg *ini.File) ([]PeerConfig, error)
• type ScanOptions
• type VirtualTun
  • func StartWireguard(ctx context.Context, l *slog.Logger, conf *Configuration) (*VirtualTun, error)
  • func (vt *VirtualTun) StartProxy(bindAddress netip.AddrPort) (netip.AddrPort, error)
  • func (vt *VirtualTun) Stop()

Functions

func NewVtunUDPForwarder

func NewVtunUDPForwarder(ctx context.Context, localBind netip.AddrPort, dest string, vtun *VirtualTun, mtu int) (netip.AddrPort, error)

func RunScan

func RunScan(ctx context.Context, l *slog.Logger, opts ScanOptions) (result []ipscanner.IPInfo, err error)

Types

type Configuration

type Configuration struct {
	Interface *InterfaceConfig
	Peers     []PeerConfig
}

func ParseConfig

func ParseConfig(path string, endpoint string) (*Configuration, error)

ParseConfig takes the path of a configuration file and parses it into Configuration

type InterfaceConfig

type InterfaceConfig struct {
	PrivateKey string
	Addresses  []netip.Addr
	DNS        []netip.Addr
	MTU        int
}

func ParseInterface

func ParseInterface(cfg *ini.File) (InterfaceConfig, error)

ParseInterface parses the [Interface] section

type PeerConfig

type PeerConfig struct {
	PublicKey    string
	PreSharedKey string
	Endpoint     string
	KeepAlive    int
	AllowedIPs   []netip.Prefix
	Trick        bool
}

func ParsePeers

func ParsePeers(cfg *ini.File) ([]PeerConfig, error)

ParsePeers parses the [Peer] section and extract the information into `peers`

type ScanOptions

type ScanOptions struct {
	V4     bool
	V6     bool
	MaxRTT time.Duration
}

type VirtualTun

type VirtualTun struct {
	Tnet   *netstack.Net
	Logger *slog.Logger
	Dev    *device.Device
	Ctx    context.Context
}

VirtualTun stores a reference to netstack network and DNS configuration

func StartWireguard

func StartWireguard(ctx context.Context, l *slog.Logger, conf *Configuration) (*VirtualTun, error)

StartWireguard creates a tun interface on netstack given a configuration

func (*VirtualTun) StartProxy

func (vt *VirtualTun) StartProxy(bindAddress netip.AddrPort) (netip.AddrPort, error)

StartProxy spawns a socks5 server.

func (*VirtualTun) Stop

func (vt *VirtualTun) Stop()