add router handler & connector

This commit is contained in:
ginuerzh
2025-02-07 15:44:31 +08:00
parent 379d9a73ad
commit 355c72477a
25 changed files with 1265 additions and 110 deletions
+262
View File
@@ -0,0 +1,262 @@
package router
import (
"context"
"encoding/binary"
"errors"
"fmt"
"io"
"math"
"net"
"sync"
"github.com/go-gost/core/common/bufpool"
"github.com/go-gost/core/limiter"
"github.com/go-gost/core/logger"
"github.com/go-gost/core/observer/stats"
"github.com/go-gost/core/router"
"github.com/go-gost/core/sd"
"github.com/go-gost/relay"
xip "github.com/go-gost/x/internal/net/ip"
traffic_wrapper "github.com/go-gost/x/limiter/traffic/wrapper"
stats_wrapper "github.com/go-gost/x/observer/stats/wrapper"
"github.com/go-gost/x/registry"
"github.com/google/uuid"
"github.com/songgao/water/waterutil"
"golang.org/x/net/ipv4"
"golang.org/x/net/ipv6"
)
func (h *routerHandler) handleAssociate(ctx context.Context, conn net.Conn, network, host string, routerID relay.TunnelID, log logger.Logger) (err error) {
log = log.WithFields(map[string]any{
"dst": fmt.Sprintf("%s/%s", host, network),
"cmd": "associate",
"router": routerID.String(),
"host": host,
})
resp := relay.Response{
Version: relay.Version1,
Status: relay.StatusOK,
}
if ingress := h.md.ingress; ingress != nil && host != "" {
var rid relay.TunnelID
if rule := ingress.GetRule(ctx, host); rule != nil {
rid = parseRouterID(rule.Endpoint)
}
if rid.IsZero() || !rid.Equal(routerID) {
resp.Status = relay.StatusHostUnreachable
resp.WriteTo(conn)
err := fmt.Errorf("no route to host %s", host)
log.Error(err)
return err
}
}
uuid, err := uuid.NewRandom()
if err != nil {
resp.Status = relay.StatusInternalServerError
resp.WriteTo(conn)
return
}
connectorID := relay.NewConnectorID(uuid[:])
resp.Features = append(resp.Features,
&relay.TunnelFeature{
ID: connectorID,
},
)
resp.WriteTo(conn)
conn = &packetConn{conn}
clientID := fmt.Sprintf("%s@%s", host, routerID)
var stats stats.Stats
if h.stats != nil {
stats = h.stats.Stats(clientID)
}
conn = stats_wrapper.WrapConn(conn, stats)
conn = traffic_wrapper.WrapConn(
conn,
h.limiter,
clientID,
limiter.ScopeOption(limiter.ScopeClient),
limiter.ServiceOption(h.options.Service),
limiter.ClientOption(clientID),
limiter.NetworkOption(network),
limiter.SrcOption(conn.RemoteAddr().String()),
)
h.pool.Add(routerID, NewConnector(routerID, connectorID, host, LockWriter(conn), &ConnectorOptions{}))
defer h.pool.Del(routerID, host, connectorID)
if h.md.sd != nil {
err := h.md.sd.Register(ctx, &sd.Service{
ID: connectorID.String(),
Name: clientID,
Node: h.id,
Network: network,
Address: h.md.entryPoint,
})
if err != nil {
h.log.Error(err)
}
defer h.md.sd.Deregister(ctx, &sd.Service{
ID: connectorID.String(),
Name: clientID,
Node: h.id,
})
}
log.Debugf("%s/%s: router=%s, connector=%s, weight=%d established", host, network, routerID, connectorID, connectorID.Weight())
return h.routing(ctx, conn, routerID, log)
}
func (h *routerHandler) routing(ctx context.Context, conn net.Conn, routerID relay.TunnelID, log logger.Logger) error {
b := bufpool.Get(h.md.bufferSize)
defer bufpool.Put(b)
rid := routerID.String()
for {
err := func() error {
n, err := conn.Read(b)
if err != nil {
return err
}
var dstIP net.IP
if waterutil.IsIPv4(b[:n]) {
header, err := ipv4.ParseHeader(b[:n])
if err != nil {
log.Warn(err)
return nil
}
dstIP = header.Dst
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
}
dstIP = header.Dst
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
}
var route *router.Route
if r := registry.RouterRegistry().Get(rid); r != nil {
route = r.GetRoute(ctx, dstIP, router.IDOption(rid))
}
if route == nil && h.md.router != nil {
route = h.md.router.GetRoute(ctx, dstIP, router.IDOption(rid))
}
if route == nil || route.Gateway == "" {
// no route to host, discard
return nil
}
if log.IsLevelEnabled(logger.TraceLevel) {
log.Tracef("route for %s: %s -> %s", dstIP, route.Dst, route.Gateway)
}
if c := h.pool.Get(routerID, route.Gateway); c != nil {
if w := c.Writer(); w != nil {
w.Write(b[:n])
}
}
return nil
}()
if err != nil {
if err == io.EOF {
err = nil
}
return err
}
}
}
type packetConn struct {
net.Conn
}
func (c *packetConn) Read(b []byte) (n int, err error) {
var bb [2]byte
_, err = io.ReadFull(c.Conn, bb[:])
if err != nil {
return
}
dlen := int(binary.BigEndian.Uint16(bb[:]))
if len(b) >= dlen {
return io.ReadFull(c.Conn, b[:dlen])
}
buf := bufpool.Get(dlen)
defer bufpool.Put(buf)
n, err = io.ReadFull(c.Conn, buf)
copy(b, buf[:n])
return
}
func (c *packetConn) Write(b []byte) (n int, err error) {
if len(b) > math.MaxUint16 {
err = errors.New("write: data maximum exceeded")
return
}
buf := bufpool.Get(len(b) + 2)
defer bufpool.Put(buf)
binary.BigEndian.PutUint16(buf[:2], uint16(len(b)))
n = copy(buf[2:], b)
return c.Conn.Write(buf)
}
type lockWriter struct {
w io.Writer
mu sync.Mutex
}
func LockWriter(w io.Writer) io.Writer {
return &lockWriter{w: w}
}
func (w *lockWriter) Write(p []byte) (int, error) {
w.mu.Lock()
defer w.mu.Unlock()
return w.w.Write(p)
}
func (w *lockWriter) Close() error {
if closer, ok := w.w.(io.Closer); ok {
return closer.Close()
}
return nil
}
+268
View File
@@ -0,0 +1,268 @@
package router
import (
"context"
"errors"
"net"
"strconv"
"time"
"github.com/go-gost/core/handler"
"github.com/go-gost/core/limiter"
"github.com/go-gost/core/limiter/traffic"
"github.com/go-gost/core/logger"
md "github.com/go-gost/core/metadata"
"github.com/go-gost/core/observer"
"github.com/go-gost/core/service"
"github.com/go-gost/relay"
ctxvalue "github.com/go-gost/x/ctx"
limiter_util "github.com/go-gost/x/internal/util/limiter"
stats_util "github.com/go-gost/x/internal/util/stats"
rate_limiter "github.com/go-gost/x/limiter/rate"
"github.com/go-gost/x/registry"
"github.com/google/uuid"
)
var (
ErrBadVersion = errors.New("bad version")
ErrUnknownCmd = errors.New("unknown command")
ErrRouterID = errors.New("invalid router ID")
ErrRouterNotAvailable = errors.New("router not available")
ErrUnauthorized = errors.New("unauthorized")
ErrTunnelRoute = errors.New("no route to host")
)
func init() {
registry.HandlerRegistry().Register("router", NewHandler)
}
type routerHandler struct {
id string
options handler.Options
pool *ConnectorPool
epSvc service.Service
md metadata
log logger.Logger
stats *stats_util.HandlerStats
limiter traffic.TrafficLimiter
cancel context.CancelFunc
}
func NewHandler(opts ...handler.Option) handler.Handler {
options := handler.Options{}
for _, opt := range opts {
opt(&options)
}
return &routerHandler{
options: options,
}
}
func (h *routerHandler) Init(md md.Metadata) (err error) {
if err := h.parseMetadata(md); err != nil {
return err
}
uuid, err := uuid.NewRandom()
if err != nil {
return err
}
h.id = uuid.String()
h.log = h.options.Logger.WithFields(map[string]any{
"node": h.id,
})
h.pool = NewConnectorPool(h.id)
/*
for _, ro := range h.options.Recorders {
if ro.Record == xrecorder.RecorderServiceHandler {
h.ep.recorder = ro
break
}
}
*/
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 = limiter_util.NewCachedTrafficLimiter(h.options.Limiter,
limiter_util.RefreshIntervalOption(h.md.limiterRefreshInterval),
limiter_util.CleanupIntervalOption(h.md.limiterCleanupInterval),
limiter_util.ScopeOption(limiter.ScopeClient),
)
}
return nil
}
func (h *routerHandler) Handle(ctx context.Context, conn net.Conn, opts ...handler.HandleOption) (err error) {
defer conn.Close()
start := time.Now()
log := h.log.WithFields(map[string]any{
"remote": conn.RemoteAddr().String(),
"local": conn.LocalAddr().String(),
"sid": ctxvalue.SidFromContext(ctx),
})
log.Infof("%s <> %s", conn.RemoteAddr(), conn.LocalAddr())
defer func() {
log.WithFields(map[string]any{
"duration": time.Since(start),
}).Infof("%s >< %s", conn.RemoteAddr(), conn.LocalAddr())
}()
if !h.checkRateLimit(conn.RemoteAddr()) {
return rate_limiter.ErrRateLimit
}
if h.md.readTimeout > 0 {
conn.SetReadDeadline(time.Now().Add(h.md.readTimeout))
}
req := relay.Request{}
if _, err := req.ReadFrom(conn); err != nil {
return err
}
conn.SetReadDeadline(time.Time{})
resp := relay.Response{
Version: relay.Version1,
Status: relay.StatusOK,
}
if req.Version != relay.Version1 {
resp.Status = relay.StatusBadRequest
resp.WriteTo(conn)
return ErrBadVersion
}
var user, pass string
var srcAddr, dstAddr string
network := "ip"
var routerID relay.TunnelID
for _, f := range req.Features {
switch f.Type() {
case relay.FeatureUserAuth:
if feature, _ := f.(*relay.UserAuthFeature); feature != nil {
user, pass = feature.Username, feature.Password
}
case relay.FeatureAddr:
if feature, _ := f.(*relay.AddrFeature); feature != nil {
v := net.JoinHostPort(feature.Host, strconv.Itoa(int(feature.Port)))
if srcAddr != "" {
dstAddr = v
} else {
srcAddr = v
}
}
case relay.FeatureTunnel:
if feature, _ := f.(*relay.TunnelFeature); feature != nil {
routerID = feature.ID
}
case relay.FeatureNetwork:
if feature, _ := f.(*relay.NetworkFeature); feature != nil {
network = feature.Network.String()
}
}
}
if routerID.IsZero() {
resp.Status = relay.StatusBadRequest
resp.WriteTo(conn)
return ErrRouterID
}
if user != "" {
log = log.WithFields(map[string]any{"user": user})
}
if h.options.Auther != nil {
clientID, ok := h.options.Auther.Authenticate(ctx, user, pass)
if !ok {
resp.Status = relay.StatusUnauthorized
resp.WriteTo(conn)
return ErrUnauthorized
}
ctx = ctxvalue.ContextWithClientID(ctx, ctxvalue.ClientID(clientID))
}
switch req.Cmd & relay.CmdMask {
case relay.CmdAssociate:
host, _, _ := net.SplitHostPort(dstAddr)
log.Debugf("associate %s/%s -> %s", host, network, routerID)
return h.handleAssociate(ctx, conn, network, host, routerID, log)
default:
resp.Status = relay.StatusBadRequest
resp.WriteTo(conn)
return ErrUnknownCmd
}
}
// Close implements io.Closer interface.
func (h *routerHandler) Close() error {
if h.epSvc != nil {
h.epSvc.Close()
}
h.pool.Close()
if h.cancel != nil {
h.cancel()
}
return nil
}
func (h *routerHandler) 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 *routerHandler) 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:
if len(events) > 0 {
if err := h.options.Observer.Observe(ctx, events); err == nil {
events = nil
}
break
}
evs := h.stats.Events()
if err := h.options.Observer.Observe(ctx, evs); err != nil {
events = evs
}
case <-ctx.Done():
return
}
}
}
+60
View File
@@ -0,0 +1,60 @@
package router
import (
"time"
"github.com/go-gost/core/ingress"
mdata "github.com/go-gost/core/metadata"
"github.com/go-gost/core/router"
"github.com/go-gost/core/sd"
mdutil "github.com/go-gost/x/metadata/util"
"github.com/go-gost/x/registry"
)
const (
defaultTTL = 15 * time.Second
defaultBufferSize = 1500
)
type metadata struct {
readTimeout time.Duration
bufferSize int
entryPoint string
ingress ingress.Ingress
sd sd.SD
router router.Router
observerPeriod time.Duration
observerResetTraffic bool
limiterRefreshInterval time.Duration
limiterCleanupInterval time.Duration
}
func (h *routerHandler) parseMetadata(md mdata.Metadata) (err error) {
h.md.readTimeout = mdutil.GetDuration(md, "readTimeout")
h.md.bufferSize = mdutil.GetInt(md, "router.bufferSize", "bufferSize")
if h.md.bufferSize <= 0 {
h.md.bufferSize = defaultBufferSize
}
h.md.entryPoint = mdutil.GetString(md, "entrypoint")
h.md.ingress = registry.IngressRegistry().Get(mdutil.GetString(md, "ingress"))
h.md.sd = registry.SDRegistry().Get(mdutil.GetString(md, "sd"))
h.md.router = registry.RouterRegistry().Get(mdutil.GetString(md, "router"))
h.md.observerPeriod = mdutil.GetDuration(md, "observePeriod", "observer.period", "observer.observePeriod")
if h.md.observerPeriod == 0 {
h.md.observerPeriod = 5 * time.Second
}
if h.md.observerPeriod < time.Second {
h.md.observerPeriod = time.Second
}
h.md.observerResetTraffic = mdutil.GetBool(md, "observer.resetTraffic")
h.md.limiterRefreshInterval = mdutil.GetDuration(md, "limiter.refreshInterval")
h.md.limiterCleanupInterval = mdutil.GetDuration(md, "limiter.cleanupInterval")
return
}
+260
View File
@@ -0,0 +1,260 @@
package router
import (
"context"
"io"
"sync"
"time"
"github.com/go-gost/core/logger"
"github.com/go-gost/relay"
"github.com/go-gost/x/selector"
"github.com/google/uuid"
)
const (
MaxWeight uint8 = 0xff
)
type ConnectorOptions struct{}
type Connector struct {
id relay.ConnectorID
rid relay.TunnelID
host string
w io.Writer
opts *ConnectorOptions
log logger.Logger
}
func NewConnector(rid relay.TunnelID, cid relay.ConnectorID, host string, w io.Writer, opts *ConnectorOptions) *Connector {
if opts == nil {
opts = &ConnectorOptions{}
}
c := &Connector{
rid: rid,
id: cid,
host: host,
w: w,
opts: opts,
log: logger.Default().WithFields(map[string]any{
"router": rid.String(),
"connector": cid.String(),
"host": host,
}),
}
return c
}
func (c *Connector) ID() relay.ConnectorID {
return c.id
}
func (c *Connector) Writer() io.Writer {
if c == nil {
return nil
}
return c.w
}
func (c *Connector) Close() error {
if c == nil || c.w == nil {
return nil
}
if closer, ok := c.w.(io.Closer); ok {
return closer.Close()
}
return nil
}
type Router struct {
node string
id relay.TunnelID
connectors map[string][]*Connector
t time.Time
close chan struct{}
mu sync.RWMutex
}
func NewRouter(node string, rid relay.TunnelID) *Router {
r := &Router{
node: node,
id: rid,
connectors: make(map[string][]*Connector),
t: time.Now(),
close: make(chan struct{}),
}
return r
}
func (r *Router) ID() relay.TunnelID {
return r.id
}
func (r *Router) AddConnector(c *Connector) {
if c == nil {
return
}
r.mu.Lock()
defer r.mu.Unlock()
r.connectors[c.host] = append(r.connectors[c.host], c)
}
func (r *Router) GetConnector(host string) *Connector {
r.mu.RLock()
defer r.mu.RUnlock()
connectors := r.connectors[host]
if len(connectors) == 1 {
return connectors[0]
}
rw := selector.NewRandomWeighted[*Connector]()
found := false
for _, c := range connectors {
weight := c.ID().Weight()
if weight == 0 {
weight = 1
}
if weight == MaxWeight && !found {
rw.Reset()
found = true
}
if weight == MaxWeight || !found {
rw.Add(c, int(weight))
}
}
return rw.Next()
}
func (r *Router) DelConnector(host string, cid relay.ConnectorID) {
r.mu.RLock()
defer r.mu.RUnlock()
connectors := r.connectors[host]
for i, c := range connectors {
if c.id.Equal(cid) {
r.connectors[host] = append(connectors[:i], connectors[i+1:]...)
}
}
}
func (r *Router) Close() error {
r.mu.Lock()
defer r.mu.Unlock()
select {
case <-r.close:
default:
for _, cs := range r.connectors {
for _, c := range cs {
c.Close()
}
}
close(r.close)
clear(r.connectors)
}
return nil
}
type ConnectorPool struct {
node string
routers map[relay.TunnelID]*Router
mu sync.RWMutex
cancel context.CancelFunc
}
func NewConnectorPool(node string) *ConnectorPool {
p := &ConnectorPool{
node: node,
routers: make(map[relay.TunnelID]*Router),
}
return p
}
func (p *ConnectorPool) Add(rid relay.TunnelID, c *Connector) {
p.mu.Lock()
defer p.mu.Unlock()
r := p.routers[rid]
if r == nil {
r = NewRouter(p.node, rid)
p.routers[rid] = r
}
r.AddConnector(c)
}
func (p *ConnectorPool) Get(rid relay.TunnelID, host string) *Connector {
if p == nil {
return nil
}
p.mu.RLock()
defer p.mu.RUnlock()
r := p.routers[rid]
if r == nil {
return nil
}
return r.GetConnector(host)
}
func (p *ConnectorPool) Del(rid relay.TunnelID, host string, cid relay.ConnectorID) {
if p == nil {
return
}
p.mu.RLock()
defer p.mu.RUnlock()
r := p.routers[rid]
if r == nil {
return
}
r.DelConnector(host, cid)
}
func (p *ConnectorPool) Close() error {
if p == nil {
return nil
}
if p.cancel != nil {
p.cancel()
}
p.mu.Lock()
defer p.mu.Unlock()
for _, v := range p.routers {
v.Close()
}
clear(p.routers)
return nil
}
func parseRouterID(s string) (rid relay.TunnelID) {
if s == "" {
return
}
uuid, _ := uuid.Parse(s)
return relay.NewTunnelID(uuid[:])
}