package v5 import ( "context" "errors" "net" "time" "github.com/go-gost/core/handler" "github.com/go-gost/core/limiter" "github.com/go-gost/core/limiter/traffic" md "github.com/go-gost/core/metadata" "github.com/go-gost/core/observer" "github.com/go-gost/core/observer/stats" "github.com/go-gost/core/recorder" "github.com/go-gost/gosocks5" xctx "github.com/go-gost/x/ctx" "github.com/go-gost/x/internal/util/socks" stats_util "github.com/go-gost/x/internal/util/stats" tls_util "github.com/go-gost/x/internal/util/tls" rate_limiter "github.com/go-gost/x/limiter/rate" cache_limiter "github.com/go-gost/x/limiter/traffic/cache" xstats "github.com/go-gost/x/observer/stats" stats_wrapper "github.com/go-gost/x/observer/stats/wrapper" xrecorder "github.com/go-gost/x/recorder" "github.com/go-gost/x/registry" ) var ( ErrUnknownCmd = errors.New("socks5: unknown command") ) func init() { registry.HandlerRegistry().Register("socks5", NewHandler) registry.HandlerRegistry().Register("socks", NewHandler) } type socks5Handler struct { selector gosocks5.Selector md metadata options handler.Options stats *stats_util.HandlerStats limiter traffic.TrafficLimiter cancel context.CancelFunc recorder recorder.RecorderObject certPool tls_util.CertPool } func NewHandler(opts ...handler.Option) handler.Handler { options := handler.Options{} for _, opt := range opts { opt(&options) } return &socks5Handler{ options: options, } } func (h *socks5Handler) Init(md md.Metadata) (err error) { if err = h.parseMetadata(md); err != nil { return } h.selector = &serverSelector{ service: h.options.Service, Authenticator: h.options.Auther, TLSConfig: h.options.TLSConfig, logger: h.options.Logger, noTLS: h.md.noTLS, } ctx, cancel := context.WithCancel(context.Background()) h.cancel = cancel if h.options.Observer != nil { h.stats = stats_util.NewHandlerStats(h.options.Service, h.md.observerResetTraffic) go h.observeStats(ctx) } if h.options.Limiter != nil { h.limiter = cache_limiter.NewCachedTrafficLimiter(h.options.Limiter, cache_limiter.RefreshIntervalOption(h.md.limiterRefreshInterval), cache_limiter.CleanupIntervalOption(h.md.limiterCleanupInterval), cache_limiter.ScopeOption(limiter.ScopeClient), ) } for _, ro := range h.options.Recorders { if ro.Record == xrecorder.RecorderServiceHandler { h.recorder = ro break } } if h.md.certificate != nil && h.md.privateKey != nil { h.certPool = tls_util.NewMemoryCertPool() } return } // networkAddr derives the network string from the SOCKS5 address type. // For IPv4 addresses it returns "tcp4"/"udp4" to prevent dual-stack // (IPv4-mapped-IPv6) socket creation on Linux, which would cause the // listener to bind on [::]:port instead of 0.0.0.0:port. // For IPv6 addresses it returns "tcp6"/"udp6". // For domain addresses it returns the unmodified network. func networkAddr(network string, addr *gosocks5.Addr) string { if addr == nil { return network } switch addr.Type { case gosocks5.AddrIPv4: return network + "4" case gosocks5.AddrIPv6: return network + "6" default: return network } } func (h *socks5Handler) Handle(ctx context.Context, conn net.Conn, opts ...handler.HandleOption) (err error) { defer conn.Close() start := time.Now() ro := &xrecorder.HandlerRecorderObject{ Network: "tcp", Service: h.options.Service, RemoteAddr: conn.RemoteAddr().String(), LocalAddr: conn.LocalAddr().String(), SID: xctx.SidFromContext(ctx).String(), Time: start, } if srcAddr := xctx.SrcAddrFromContext(ctx); srcAddr != nil { ro.ClientAddr = srcAddr.String() } log := h.options.Logger.WithFields(map[string]any{ "network": ro.Network, "remote": conn.RemoteAddr().String(), "local": conn.LocalAddr().String(), "client": ro.ClientAddr, "sid": ro.SID, }) log.Infof("%s <> %s", conn.RemoteAddr(), conn.LocalAddr()) pStats := xstats.Stats{} conn = stats_wrapper.WrapConn(conn, &pStats) defer func() { if err != nil { ro.Err = err.Error() } ro.InputBytes += pStats.Get(stats.KindInputBytes) ro.OutputBytes += pStats.Get(stats.KindOutputBytes) ro.Duration = time.Since(start) if err := ro.Record(ctx, h.recorder.Recorder); err != nil { log.Errorf("record: %v", err) } log.WithFields(map[string]any{ "network": ro.Network, "duration": time.Since(start), "inputBytes": ro.InputBytes, "outputBytes": ro.OutputBytes, }).Infof("%s >< %s", conn.RemoteAddr(), conn.LocalAddr()) }() if !h.checkRateLimit(conn.RemoteAddr()) { return rate_limiter.ErrRateLimit } conn.SetReadDeadline(time.Now().Add(h.md.readTimeout)) sc := gosocks5.ServerConn(conn, h.selector) req, err := gosocks5.ReadRequest(sc) if err != nil { log.Error(err) return err } log.Trace(req) if clientID := sc.ID(); clientID != "" { ctx = xctx.ContextWithClientID(ctx, xctx.ClientID(clientID)) log = log.WithFields(map[string]any{"user": clientID, "clientID": clientID}) ro.ClientID = clientID } conn = sc conn.SetReadDeadline(time.Time{}) address := req.Addr.String() ro.Host = address switch req.Cmd { case gosocks5.CmdConnect: return h.handleConnect(ctx, conn, "tcp", address, ro, log) case gosocks5.CmdBind: return h.handleBind(ctx, conn, networkAddr("tcp", req.Addr), address, ro, log) case socks.CmdMuxBind: return h.handleMuxBind(ctx, conn, networkAddr("tcp", req.Addr), address, ro, log) case gosocks5.CmdUdp: ro.Network = "udp" return h.handleUDP(ctx, conn, "udp", ro, log) case socks.CmdUDPTun: ro.Network = "udp" return h.handleUDPTun(ctx, conn, networkAddr("udp", req.Addr), address, ro, log) default: err = ErrUnknownCmd log.Error(err) resp := gosocks5.NewReply(gosocks5.CmdUnsupported, nil) log.Trace(resp) resp.Write(conn) return err } } func (h *socks5Handler) Close() error { if h.cancel != nil { h.cancel() } return nil } func (h *socks5Handler) checkRateLimit(addr net.Addr) bool { if h.options.RateLimiter == nil { return true } host, _, _ := net.SplitHostPort(addr.String()) if limiter := h.options.RateLimiter.Limiter(host); limiter != nil { return limiter.Allow(1) } return true } func (h *socks5Handler) observeStats(ctx context.Context) { if h.options.Observer == nil { return } var events []observer.Event ticker := time.NewTicker(h.md.observerPeriod) defer ticker.Stop() for { select { case <-ticker.C: // Try to flush any buffered events from a previous failed attempt. if len(events) > 0 { if err := h.options.Observer.Observe(ctx, events); err != nil { continue } } // Collect and send fresh events. if evs := h.stats.Events(); len(evs) > 0 { if err := h.options.Observer.Observe(ctx, evs); err != nil { events = evs continue } } events = nil case <-ctx.Done(): return } } }