netstackgo

README

netstackgo

⚠️ Deprecated: This project is no longer maintained.

Please use https://github.com/josexy/cropstun instead.

An easy-to-use netstack, wrapped by gvisor and wireguard-go, which supports macOS/Linux/Windows.

go get github.com/josexy/netstackgo

usage

type myHandler struct{}

func (*myHandler) HandleTCPConn(info *netstackgo.ConnTuple, conn net.Conn) {
	log.Printf("tcp, src: %s, dst: %s", info.Src(), info.Dst())
	// do something...
}
func (*myHandler) HandleUDPConn(info *netstackgo.ConnTuple, conn net.PacketConn) {
	log.Printf("udp, src: %s, dst: %s", info.Src(), info.Dst())
	// do something...
}

func main() {
	nt := netstackgo.New(tun.TunConfig{
		Name: "tun2",
		Addr: "192.18.0.1/16",
		MTU:  tun.DefaultMTU,
	})
	if err := nt.Start(); err != nil {
		log.Fatal(err)
	}
	defer nt.Close()
	nt.RegisterConnHandler(&myHandler{})
	interrupt := make(chan os.Signal, 1)
	signal.Notify(interrupt, syscall.SIGINT)
	<-interrupt
}

PS: Windows user requires downloading wintun.dll from https://www.wintun.net

credits

• clash
• tun2socks
• gvisor
• wireguard-go

Documentation

Index

• type ConnHandler
• type ConnTuple
  • func (t *ConnTuple) Dst() string
  • func (t *ConnTuple) Src() string
• type TunNetstack
  • func New(tunCfg tun.TunConfig) *TunNetstack
  • func (ns *TunNetstack) Close() error
  • func (ns *TunNetstack) RegisterConnHandler(handler ConnHandler)
  • func (ns *TunNetstack) Start() (err error)

Types

type ConnHandler

type ConnHandler interface {
	HandleTCPConn(ConnTuple, net.Conn)
	HandleUDPConn(ConnTuple, net.PacketConn)
}

type ConnTuple

type ConnTuple struct {
	SrcAddr netip.AddrPort
	DstAddr netip.AddrPort
}

func (*ConnTuple) Dst

func (t *ConnTuple) Dst() string

func (*ConnTuple) Src

func (t *ConnTuple) Src() string

type TunNetstack

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

func New

func New(tunCfg tun.TunConfig) *TunNetstack

func (*TunNetstack) Close

func (ns *TunNetstack) Close() error

func (*TunNetstack) RegisterConnHandler

func (ns *TunNetstack) RegisterConnHandler(handler ConnHandler)

func (*TunNetstack) Start

func (ns *TunNetstack) Start() (err error)