sing-tun/system.go

package tun

import (
	"context"
	"net"
	"net/netip"
	"syscall"
	"time"

	"github.com/sagernet/sing-tun/internal/clashtcpip"
	"github.com/sagernet/sing/common"
	"github.com/sagernet/sing/common/buf"
	"github.com/sagernet/sing/common/control"
	E "github.com/sagernet/sing/common/exceptions"
	"github.com/sagernet/sing/common/logger"
	M "github.com/sagernet/sing/common/metadata"
	N "github.com/sagernet/sing/common/network"
	"github.com/sagernet/sing/common/udpnat"
)

type System struct {
	ctx                context.Context
	tun                Tun
	tunName            string
	mtu                uint32
	router             Router
	handler            Handler
	logger             logger.Logger
	inet4Prefixes      []netip.Prefix
	inet6Prefixes      []netip.Prefix
	inet4ServerAddress netip.Addr
	inet4Address       netip.Addr
	inet6ServerAddress netip.Addr
	inet6Address       netip.Addr
	udpTimeout         int64
	tcpListener        net.Listener
	tcpListener6       net.Listener
	tcpPort            uint16
	tcpPort6           uint16
	tcpNat             *TCPNat
	udpNat             *udpnat.Service[netip.AddrPort]
	routeMapping       *RouteMapping
	underPlatform      bool
}

type Session struct {
	SourceAddress      netip.Addr
	DestinationAddress netip.Addr
	SourcePort         uint16
	DestinationPort    uint16
}

func NewSystem(options StackOptions) (Stack, error) {
	stack := &System{
		ctx:           options.Context,
		tun:           options.Tun,
		tunName:       options.Name,
		mtu:           options.MTU,
		udpTimeout:    options.UDPTimeout,
		router:        options.Router,
		handler:       options.Handler,
		logger:        options.Logger,
		inet4Prefixes: options.Inet4Address,
		inet6Prefixes: options.Inet6Address,
		underPlatform: options.UnderPlatform,
		routeMapping:  NewRouteMapping(options.UDPTimeout),
	}
	if len(options.Inet4Address) > 0 {
		if options.Inet4Address[0].Bits() == 32 {
			return nil, E.New("need one more IPv4 address in first prefix for system stack")
		}
		stack.inet4ServerAddress = options.Inet4Address[0].Addr()
		stack.inet4Address = stack.inet4ServerAddress.Next()
	}
	if len(options.Inet6Address) > 0 {
		if options.Inet6Address[0].Bits() == 128 {
			return nil, E.New("need one more IPv6 address in first prefix for system stack")
		}
		stack.inet6ServerAddress = options.Inet6Address[0].Addr()
		stack.inet6Address = stack.inet6ServerAddress.Next()
	}
	if !stack.inet4Address.IsValid() && !stack.inet6Address.IsValid() {
		return nil, E.New("missing interface address")
	}
	return stack, nil
}

func (s *System) Close() error {
	return common.Close(
		s.tcpListener,
		s.tcpListener6,
	)
}

func (s *System) Start() error {
	var listener net.ListenConfig
	if s.underPlatform {
		listener.Control = control.Append(listener.Control, control.BindToInterface(control.DefaultInterfaceFinder(), s.tunName, -1))
	}
	if s.inet4Address.IsValid() {
		tcpListener, err := listener.Listen(s.ctx, "tcp4", net.JoinHostPort(s.inet4ServerAddress.String(), "0"))
		if err != nil {
			return err
		}
		s.tcpListener = tcpListener
		s.tcpPort = M.SocksaddrFromNet(tcpListener.Addr()).Port
		go s.acceptLoop(tcpListener)
	}
	if s.inet6Address.IsValid() {
		tcpListener, err := listener.Listen(s.ctx, "tcp6", net.JoinHostPort(s.inet6ServerAddress.String(), "0"))
		if err != nil {
			return err
		}
		s.tcpListener6 = tcpListener
		s.tcpPort6 = M.SocksaddrFromNet(tcpListener.Addr()).Port
		go s.acceptLoop(tcpListener)
	}
	s.tcpNat = NewNat()
	s.udpNat = udpnat.New[netip.AddrPort](s.udpTimeout, s.handler)
	go s.tunLoop()
	return nil
}

func (s *System) tunLoop() {
	if winTun, isWinTun := s.tun.(WinTun); isWinTun {
		s.wintunLoop(winTun)
		return
	}
	_packetBuffer := buf.StackNewSize(int(s.mtu))
	defer common.KeepAlive(_packetBuffer)
	packetBuffer := common.Dup(_packetBuffer)
	defer packetBuffer.Release()
	packetSlice := packetBuffer.Slice()
	for {
		n, err := s.tun.Read(packetSlice)
		if err != nil {
			return
		}
		if n < clashtcpip.IPv4PacketMinLength {
			continue
		}
		packet := packetSlice[PacketOffset:n]
		switch ipVersion := packet[0] >> 4; ipVersion {
		case 4:
			err = s.processIPv4(packet)
		case 6:
			err = s.processIPv6(packet)
		default:
			err = E.New("ip: unknown version: ", ipVersion)
		}
		if err != nil {
			s.logger.Trace(err)
		}
	}
}

func (s *System) wintunLoop(winTun WinTun) {
	for {
		packet, release, err := winTun.ReadPacket()
		if err != nil {
			return
		}
		if len(packet) < clashtcpip.IPv4PacketMinLength {
			release()
			continue
		}
		switch ipVersion := packet[0] >> 4; ipVersion {
		case 4:
			err = s.processIPv4(packet)
		case 6:
			err = s.processIPv6(packet)
		default:
			err = E.New("ip: unknown version: ", ipVersion)
		}
		if err != nil {
			s.logger.Trace(err)
		}
		release()
	}
}

func (s *System) acceptLoop(listener net.Listener) {
	for {
		conn, err := listener.Accept()
		if err != nil {
			return
		}
		connPort := M.SocksaddrFromNet(conn.RemoteAddr()).Port
		session := s.tcpNat.LookupBack(connPort)
		if session == nil {
			s.logger.Trace(E.New("unknown session with port ", connPort))
			continue
		}
		destination := M.SocksaddrFromNetIP(session.Destination)
		if destination.Addr.Is4() {
			for _, prefix := range s.inet4Prefixes {
				if prefix.Contains(destination.Addr) {
					destination.Addr = netip.AddrFrom4([4]byte{127, 0, 0, 1})
					break
				}
			}
		} else {
			for _, prefix := range s.inet6Prefixes {
				if prefix.Contains(destination.Addr) {
					destination.Addr = netip.AddrFrom16([16]byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1})
					break
				}
			}
		}
		go func() {
			s.handler.NewConnection(s.ctx, conn, M.Metadata{
				Source:      M.SocksaddrFromNetIP(session.Source),
				Destination: destination,
			})
			conn.Close()
			time.Sleep(time.Second)
			s.tcpNat.Revoke(connPort, session)
		}()
	}
}

func (s *System) processIPv4(packet clashtcpip.IPv4Packet) error {
	switch packet.Protocol() {
	case clashtcpip.TCP:
		return s.processIPv4TCP(packet, packet.Payload())
	case clashtcpip.UDP:
		return s.processIPv4UDP(packet, packet.Payload())
	case clashtcpip.ICMP:
		return s.processIPv4ICMP(packet, packet.Payload())
	default:
		return common.Error(s.tun.Write(packet))
	}
}

func (s *System) processIPv6(packet clashtcpip.IPv6Packet) error {
	switch packet.Protocol() {
	case clashtcpip.TCP:
		return s.processIPv6TCP(packet, packet.Payload())
	case clashtcpip.UDP:
		return s.processIPv6UDP(packet, packet.Payload())
	case clashtcpip.ICMPv6:
		return s.processIPv6ICMP(packet, packet.Payload())
	default:
		return common.Error(s.tun.Write(packet))
	}
}

func (s *System) processIPv4TCP(packet clashtcpip.IPv4Packet, header clashtcpip.TCPPacket) error {
	source := netip.AddrPortFrom(packet.SourceIP(), header.SourcePort())
	destination := netip.AddrPortFrom(packet.DestinationIP(), header.DestinationPort())
	if !destination.Addr().IsGlobalUnicast() {
		return common.Error(s.tun.Write(packet))
	} else if source.Addr() == s.inet4ServerAddress && source.Port() == s.tcpPort {
		session := s.tcpNat.LookupBack(destination.Port())
		if session == nil {
			return E.New("ipv4: tcp: session not found: ", destination.Port())
		}
		packet.SetSourceIP(session.Destination.Addr())
		header.SetSourcePort(session.Destination.Port())
		packet.SetDestinationIP(session.Source.Addr())
		header.SetDestinationPort(session.Source.Port())
	} else {
		if s.router != nil {
			session := RouteSession{4, syscall.IPPROTO_TCP, source, destination}
			action := s.routeMapping.Lookup(session, func() RouteAction {
				return s.router.RouteConnection(session, &systemTCPDirectPacketWriter4{s.tun, source})
			})
			switch actionType := action.(type) {
			case *ActionBlock:
				// TODO: send ICMP unreachable
				return nil
			case *ActionDirect:
				return E.Append(nil, actionType.WritePacket(buf.As(packet).ToOwned()), func(err error) error {
					return E.Cause(err, "route ipv4 tcp packet")
				})
			}
		}
		natPort := s.tcpNat.Lookup(source, destination)
		packet.SetSourceIP(s.inet4Address)
		header.SetSourcePort(natPort)
		packet.SetDestinationIP(s.inet4ServerAddress)
		header.SetDestinationPort(s.tcpPort)
	}
	header.ResetChecksum(packet.PseudoSum())
	packet.ResetChecksum()
	return common.Error(s.tun.Write(packet))
}

func (s *System) processIPv6TCP(packet clashtcpip.IPv6Packet, header clashtcpip.TCPPacket) error {
	source := netip.AddrPortFrom(packet.SourceIP(), header.SourcePort())
	destination := netip.AddrPortFrom(packet.DestinationIP(), header.DestinationPort())
	if !destination.Addr().IsGlobalUnicast() {
		return common.Error(s.tun.Write(packet))
	} else if source.Addr() == s.inet6ServerAddress && source.Port() == s.tcpPort6 {
		session := s.tcpNat.LookupBack(destination.Port())
		if session == nil {
			return E.New("ipv6: tcp: session not found: ", destination.Port())
		}
		packet.SetSourceIP(session.Destination.Addr())
		header.SetSourcePort(session.Destination.Port())
		packet.SetDestinationIP(session.Source.Addr())
		header.SetDestinationPort(session.Source.Port())
	} else {
		if s.router != nil {
			session := RouteSession{6, syscall.IPPROTO_TCP, source, destination}
			action := s.routeMapping.Lookup(session, func() RouteAction {
				return s.router.RouteConnection(session, &systemTCPDirectPacketWriter6{s.tun, source})
			})
			switch actionType := action.(type) {
			case *ActionBlock:
				// TODO: send RST
				return nil
			case *ActionDirect:
				return E.Append(nil, actionType.WritePacket(buf.As(packet).ToOwned()), func(err error) error {
					return E.Cause(err, "route ipv6 tcp packet")
				})
			}
		}
		natPort := s.tcpNat.Lookup(source, destination)
		packet.SetSourceIP(s.inet6Address)
		header.SetSourcePort(natPort)
		packet.SetDestinationIP(s.inet6ServerAddress)
		header.SetDestinationPort(s.tcpPort6)
	}
	header.ResetChecksum(packet.PseudoSum())
	packet.ResetChecksum()
	return common.Error(s.tun.Write(packet))
}

func (s *System) processIPv4UDP(packet clashtcpip.IPv4Packet, header clashtcpip.UDPPacket) error {
	if packet.Flags()&clashtcpip.FlagMoreFragment != 0 {
		return E.New("ipv4: fragment dropped")
	}
	if packet.FragmentOffset() != 0 {
		return E.New("ipv4: udp: fragment dropped")
	}
	source := netip.AddrPortFrom(packet.SourceIP(), header.SourcePort())
	destination := netip.AddrPortFrom(packet.DestinationIP(), header.DestinationPort())
	if !destination.Addr().IsGlobalUnicast() {
		return common.Error(s.tun.Write(packet))
	}
	if s.router != nil {
		routeSession := RouteSession{4, syscall.IPPROTO_UDP, source, destination}
		action := s.routeMapping.Lookup(routeSession, func() RouteAction {
			return s.router.RouteConnection(routeSession, &systemUDPDirectPacketWriter4{s.tun, source})
		})
		switch actionType := action.(type) {
		case *ActionBlock:
			// TODO: send icmp unreachable
			return nil
		case *ActionDirect:
			return E.Append(nil, actionType.WritePacket(buf.As(packet).ToOwned()), func(err error) error {
				return E.Cause(err, "route ipv4 udp packet")
			})
		}
	}
	data := buf.As(header.Payload())
	if data.Len() == 0 {
		return nil
	}
	metadata := M.Metadata{
		Source:      M.SocksaddrFromNetIP(source),
		Destination: M.SocksaddrFromNetIP(destination),
	}
	s.udpNat.NewPacket(s.ctx, source, data.ToOwned(), metadata, func(natConn N.PacketConn) N.PacketWriter {
		headerLen := packet.HeaderLen() + clashtcpip.UDPHeaderSize
		headerCopy := make([]byte, headerLen)
		copy(headerCopy, packet[:headerLen])
		return &systemUDPPacketWriter4{s.tun, headerCopy, source}
	})
	return nil
}

func (s *System) processIPv6UDP(packet clashtcpip.IPv6Packet, header clashtcpip.UDPPacket) error {
	source := netip.AddrPortFrom(packet.SourceIP(), header.SourcePort())
	destination := netip.AddrPortFrom(packet.DestinationIP(), header.DestinationPort())
	if !destination.Addr().IsGlobalUnicast() {
		return common.Error(s.tun.Write(packet))
	}
	if s.router != nil {
		routeSession := RouteSession{6, syscall.IPPROTO_UDP, source, destination}
		action := s.routeMapping.Lookup(routeSession, func() RouteAction {
			return s.router.RouteConnection(routeSession, &systemUDPDirectPacketWriter6{s.tun, source})
		})
		switch actionType := action.(type) {
		case *ActionBlock:
			// TODO: send icmp unreachable
			return nil
		case *ActionDirect:
			return E.Append(nil, actionType.WritePacket(buf.As(packet).ToOwned()), func(err error) error {
				return E.Cause(err, "route ipv6 udp packet")
			})
		}
	}
	data := buf.As(header.Payload())
	if data.Len() == 0 {
		return nil
	}
	metadata := M.Metadata{
		Source:      M.SocksaddrFromNetIP(source),
		Destination: M.SocksaddrFromNetIP(destination),
	}
	s.udpNat.NewPacket(s.ctx, source, data.ToOwned(), metadata, func(natConn N.PacketConn) N.PacketWriter {
		headerLen := len(packet) - int(header.Length()) + clashtcpip.UDPHeaderSize
		headerCopy := make([]byte, headerLen)
		copy(headerCopy, packet[:headerLen])
		return &systemUDPPacketWriter6{s.tun, headerCopy, source}
	})
	return nil
}

func (s *System) processIPv4ICMP(packet clashtcpip.IPv4Packet, header clashtcpip.ICMPPacket) error {
	if s.router != nil {
		routeSession := RouteSession{4, clashtcpip.ICMP, netip.AddrPortFrom(packet.SourceIP(), 0), netip.AddrPortFrom(packet.DestinationIP(), 0)}
		action := s.routeMapping.Lookup(routeSession, func() RouteAction {
			return s.router.RouteConnection(routeSession, &systemICMPDirectPacketWriter4{s.tun, packet.SourceIP()})
		})
		switch actionType := action.(type) {
		case *ActionBlock:
			// TODO: send icmp unreachable
			return nil
		case *ActionDirect:
			return E.Append(nil, actionType.WritePacket(buf.As(packet).ToOwned()), func(err error) error {
				return E.Cause(err, "route ipv4 icmp packet")
			})
		}
	}
	if header.Type() != clashtcpip.ICMPTypePingRequest || header.Code() != 0 {
		return nil
	}
	header.SetType(clashtcpip.ICMPTypePingResponse)
	sourceAddress := packet.SourceIP()
	packet.SetSourceIP(packet.DestinationIP())
	packet.SetDestinationIP(sourceAddress)
	header.ResetChecksum()
	packet.ResetChecksum()
	return common.Error(s.tun.Write(packet))
}

func (s *System) processIPv6ICMP(packet clashtcpip.IPv6Packet, header clashtcpip.ICMPv6Packet) error {
	if s.router != nil {
		routeSession := RouteSession{6, clashtcpip.ICMPv6, netip.AddrPortFrom(packet.SourceIP(), 0), netip.AddrPortFrom(packet.DestinationIP(), 0)}
		action := s.routeMapping.Lookup(routeSession, func() RouteAction {
			return s.router.RouteConnection(routeSession, &systemICMPDirectPacketWriter6{s.tun, packet.SourceIP()})
		})
		switch actionType := action.(type) {
		case *ActionBlock:
			// TODO: send icmp unreachable
			return nil
		case *ActionDirect:
			return E.Append(nil, actionType.WritePacket(buf.As(packet).ToOwned()), func(err error) error {
				return E.Cause(err, "route ipv6 icmp packet")
			})
		}
	}
	if header.Type() != clashtcpip.ICMPv6EchoRequest || header.Code() != 0 {
		return nil
	}
	header.SetType(clashtcpip.ICMPv6EchoReply)
	sourceAddress := packet.SourceIP()
	packet.SetSourceIP(packet.DestinationIP())
	packet.SetDestinationIP(sourceAddress)
	header.ResetChecksum(packet.PseudoSum())
	packet.ResetChecksum()
	return common.Error(s.tun.Write(packet))
}

type systemTCPDirectPacketWriter4 struct {
	tun    Tun
	source netip.AddrPort
}

func (w *systemTCPDirectPacketWriter4) WritePacket(p []byte) error {
	packet := clashtcpip.IPv4Packet(p)
	header := clashtcpip.TCPPacket(packet.Payload())
	packet.SetDestinationIP(w.source.Addr())
	header.SetDestinationPort(w.source.Port())
	header.ResetChecksum(packet.PseudoSum())
	packet.ResetChecksum()
	return common.Error(w.tun.Write(packet))
}

type systemTCPDirectPacketWriter6 struct {
	tun    Tun
	source netip.AddrPort
}

func (w *systemTCPDirectPacketWriter6) WritePacket(p []byte) error {
	packet := clashtcpip.IPv6Packet(p)
	header := clashtcpip.TCPPacket(packet.Payload())
	packet.SetDestinationIP(w.source.Addr())
	header.SetDestinationPort(w.source.Port())
	header.ResetChecksum(packet.PseudoSum())
	packet.ResetChecksum()
	return common.Error(w.tun.Write(packet))
}

type systemUDPDirectPacketWriter4 struct {
	tun    Tun
	source netip.AddrPort
}

func (w *systemUDPDirectPacketWriter4) WritePacket(p []byte) error {
	packet := clashtcpip.IPv4Packet(p)
	header := clashtcpip.UDPPacket(packet.Payload())
	packet.SetDestinationIP(w.source.Addr())
	header.SetDestinationPort(w.source.Port())
	header.ResetChecksum(packet.PseudoSum())
	packet.ResetChecksum()
	return common.Error(w.tun.Write(packet))
}

type systemUDPDirectPacketWriter6 struct {
	tun    Tun
	source netip.AddrPort
}

func (w *systemUDPDirectPacketWriter6) WritePacket(p []byte) error {
	packet := clashtcpip.IPv6Packet(p)
	header := clashtcpip.UDPPacket(packet.Payload())
	packet.SetDestinationIP(w.source.Addr())
	header.SetDestinationPort(w.source.Port())
	header.ResetChecksum(packet.PseudoSum())
	packet.ResetChecksum()
	return common.Error(w.tun.Write(packet))
}

type systemICMPDirectPacketWriter4 struct {
	tun    Tun
	source netip.Addr
}

func (w *systemICMPDirectPacketWriter4) WritePacket(p []byte) error {
	packet := clashtcpip.IPv4Packet(p)
	packet.SetDestinationIP(w.source)
	packet.ResetChecksum()
	return common.Error(w.tun.Write(packet))
}

type systemICMPDirectPacketWriter6 struct {
	tun    Tun
	source netip.Addr
}

func (w *systemICMPDirectPacketWriter6) WritePacket(p []byte) error {
	packet := clashtcpip.IPv6Packet(p)
	packet.SetDestinationIP(w.source)
	packet.ResetChecksum()
	return common.Error(w.tun.Write(packet))
}

type systemUDPPacketWriter4 struct {
	tun    Tun
	header []byte
	source netip.AddrPort
}

func (w *systemUDPPacketWriter4) WritePacket(buffer *buf.Buffer, destination M.Socksaddr) error {
	newPacket := buf.StackNewSize(len(w.header) + buffer.Len())
	defer newPacket.Release()
	newPacket.Write(w.header)
	newPacket.Write(buffer.Bytes())
	ipHdr := clashtcpip.IPv4Packet(newPacket.Bytes())
	ipHdr.SetTotalLength(uint16(newPacket.Len()))
	ipHdr.SetDestinationIP(ipHdr.SourceIP())
	ipHdr.SetSourceIP(destination.Addr)
	udpHdr := clashtcpip.UDPPacket(ipHdr.Payload())
	udpHdr.SetDestinationPort(udpHdr.SourcePort())
	udpHdr.SetSourcePort(destination.Port)
	udpHdr.SetLength(uint16(buffer.Len() + clashtcpip.UDPHeaderSize))
	udpHdr.ResetChecksum(ipHdr.PseudoSum())
	ipHdr.ResetChecksum()
	return common.Error(w.tun.Write(newPacket.Bytes()))
}

type systemUDPPacketWriter6 struct {
	tun    Tun
	header []byte
	source netip.AddrPort
}

func (w *systemUDPPacketWriter6) WritePacket(buffer *buf.Buffer, destination M.Socksaddr) error {
	newPacket := buf.StackNewSize(len(w.header) + buffer.Len())
	defer newPacket.Release()
	newPacket.Write(w.header)
	newPacket.Write(buffer.Bytes())
	ipHdr := clashtcpip.IPv6Packet(newPacket.Bytes())
	udpLen := uint16(clashtcpip.UDPHeaderSize + buffer.Len())
	ipHdr.SetPayloadLength(udpLen)
	ipHdr.SetDestinationIP(ipHdr.SourceIP())
	ipHdr.SetSourceIP(destination.Addr)
	udpHdr := clashtcpip.UDPPacket(ipHdr.Payload())
	udpHdr.SetDestinationPort(udpHdr.SourcePort())
	udpHdr.SetSourcePort(destination.Port)
	udpHdr.SetLength(udpLen)
	udpHdr.ResetChecksum(ipHdr.PseudoSum())
	return common.Error(w.tun.Write(newPacket.Bytes()))
}