Files
x/handler/tun/client.go
T
ginuerzh 37bc81576c fix(tun): prevent leaked goroutines in bidirectional copy on transport failure
transportClient and transportServer each launch two goroutines for
bidirectional copy between the TUN device and the remote connection.
Previously, when one goroutine errored, the function returned
immediately while the sibling goroutine continued running — reading
from and writing to connections that would soon be closed by the
caller's deferred cleanup. In the retry loop of handleClient and
handleServer, stale goroutines accumulated across iterations, racing
with new goroutines for the TUN device and writing to closed pipes.

This caused the "io: read/write on closed pipe" error reported in
go-gost/gost#345, and more importantly, prevented recovery because
subsequent retry iterations operated on a corrupted state.

Fix:
- Derive a per-transport context in transportClient/transportServer
  and check it at the top of each goroutine's loop to allow the
  first-failing goroutine to signal its sibling to exit
- Replace the single-error select with a collectFirstError helper
  that drains both goroutines and includes a timeout guard (5s) to
  prevent deadlock when a goroutine is stuck in a non-cancelable read
- Use a per-iteration context in handleClient for the keepalive
  goroutine so it is properly cancelled when an iteration ends
- Fix handleServer to use errors.Is(err, ErrTun) for consistency
- Fix transportServer's errc buffer from 1 to 2 to prevent a
  goroutine leak when both goroutines error simultaneously
2026-06-20 22:10:09 +08:00

236 lines
5.0 KiB
Go

package tun
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"net"
"time"
"github.com/go-gost/core/common/bufpool"
"github.com/go-gost/core/logger"
xip "github.com/go-gost/x/internal/net/ip"
tun_util "github.com/go-gost/x/internal/util/tun"
"github.com/songgao/water/waterutil"
"golang.org/x/net/ipv4"
"golang.org/x/net/ipv6"
)
const (
// 4-byte magic header followed by 16-byte key.
keepAliveHeaderLength = 20
)
var (
magicHeader = []byte("GOST")
)
func (h *tunHandler) handleClient(ctx context.Context, conn net.Conn, network string, raddr string, config *tun_util.Config, log logger.Logger) error {
var ips []net.IP
for _, net := range config.Net {
ips = append(ips, net.IP)
}
if len(ips) == 0 {
return ErrInvalidNet
}
for {
err := func() error {
cc, err := h.options.Router.Dial(ctx, network, raddr)
if err != nil {
return err
}
defer cc.Close()
if network == "udp" {
iterCtx, iterCancel := context.WithCancel(ctx)
defer iterCancel()
go h.keepalive(iterCtx, cc, ips)
}
return h.transportClient(ctx, conn, cc, log)
}()
if errors.Is(err, ErrTun) {
return err
}
log.Error(err)
time.Sleep(time.Second)
}
}
func (h *tunHandler) keepalive(ctx context.Context, conn net.Conn, ips []net.IP) {
// handshake
keepAliveData := bufpool.Get(keepAliveHeaderLength + len(ips)*net.IPv6len)
defer bufpool.Put(keepAliveData)
copy(keepAliveData[:4], magicHeader) // magic header
copy(keepAliveData[4:20], []byte(h.md.passphrase))
pos := 20
for _, ip := range ips {
copy(keepAliveData[pos:pos+net.IPv6len], ip.To16())
pos += net.IPv6len
}
if _, err := conn.Write(keepAliveData); err != nil {
return
}
if h.md.keepAlivePeriod <= 0 {
return
}
conn.SetReadDeadline(time.Now().Add(h.md.keepAlivePeriod * 3))
ticker := time.NewTicker(h.md.keepAlivePeriod)
defer ticker.Stop()
for {
select {
case <-ticker.C:
if _, err := conn.Write(keepAliveData); err != nil {
return
}
h.options.Logger.Debugf("keepalive sended")
case <-ctx.Done():
return
}
}
}
func (h *tunHandler) transportClient(ctx context.Context, tun io.ReadWriter, conn net.Conn, log logger.Logger) error {
c, cancel := context.WithCancel(ctx)
defer cancel()
errc := make(chan error, 2)
go func() {
var b [MaxMessageSize]byte
for {
select {
case <-c.Done():
errc <- c.Err()
return
default:
}
err := func() error {
n, err := tun.Read(b[:])
if err != nil {
return fmt.Errorf("%w: read: %s", ErrTun, err.Error())
}
if waterutil.IsIPv4(b[:n]) {
header, err := ipv4.ParseHeader(b[:n])
if err != nil {
log.Warn(err)
return nil
}
if log.IsLevelEnabled(logger.TraceLevel) {
log.Tracef("%s >> %s %-4s %d/%-4d %-4x %d",
header.Src, header.Dst, xip.Protocol(waterutil.IPv4Protocol(b[:n])),
header.Len, header.TotalLen, header.ID, header.Flags)
}
} else if waterutil.IsIPv6(b[:n]) {
header, err := ipv6.ParseHeader(b[:n])
if err != nil {
log.Warn(err)
return nil
}
if log.IsLevelEnabled(logger.TraceLevel) {
log.Tracef("%s >> %s %s %d %d",
header.Src, header.Dst,
xip.Protocol(waterutil.IPProtocol(header.NextHeader)),
header.PayloadLen, header.TrafficClass)
}
} else {
log.Warnf("unknown packet, discarded(%d)", n)
return nil
}
_, err = conn.Write(b[:n])
return err
}()
if err != nil {
errc <- err
return
}
}
}()
go func() {
var b [MaxMessageSize]byte
for {
select {
case <-c.Done():
errc <- c.Err()
return
default:
}
err := func() error {
n, err := conn.Read(b[:])
if err != nil {
return err
}
if n == keepAliveHeaderLength && bytes.Equal(b[:4], magicHeader) {
ip := net.IP(b[4:20])
log.Debugf("keepalive received at %v", ip)
if h.md.keepAlivePeriod > 0 {
conn.SetReadDeadline(time.Now().Add(h.md.keepAlivePeriod * 3))
}
return nil
}
if waterutil.IsIPv4(b[:n]) {
header, err := ipv4.ParseHeader(b[:n])
if err != nil {
log.Warn(err)
return nil
}
if log.IsLevelEnabled(logger.TraceLevel) {
log.Tracef("%s >> %s %-4s %d/%-4d %-4x %d",
header.Src, header.Dst, xip.Protocol(waterutil.IPv4Protocol(b[:n])),
header.Len, header.TotalLen, header.ID, header.Flags)
}
} else if waterutil.IsIPv6(b[:n]) {
header, err := ipv6.ParseHeader(b[:n])
if err != nil {
log.Warn(err)
return nil
}
if log.IsLevelEnabled(logger.TraceLevel) {
log.Tracef("%s > %s %s %d %d",
header.Src, header.Dst,
xip.Protocol(waterutil.IPProtocol(header.NextHeader)),
header.PayloadLen, header.TrafficClass)
}
} else {
log.Warn("unknown packet, discarded")
return nil
}
if _, err = tun.Write(b[:n]); err != nil {
return fmt.Errorf("%w: write: %s", ErrTun, err.Error())
}
return nil
}()
if err != nil {
errc <- err
return
}
}
}()
return collectFirstError(errc, cancel)
}