go-gost/x
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: extend TCP keepalive support to all TCP-based listeners and dialers

Browse Source 
Add configurable TCP keepalive (keepalive, keepalive.idle,
keepalive.interval, keepalive.count) to all TCP-based transport types:
tls, mtls, mtcp, ws/wss, mws/mwss, http2, ssh, sshd listeners and
tls, mtls, mtcp, ws/wss, mws/mwss, ssh, sshd dialers.

For types that already use "keepalive" for an app-level protocol
(grpc listener/dialer, ws/mws dialers, ssh/sshd dialers), the TCP
keepalive parameters are exposed under the tcp.keepalive.* prefix to
avoid ambiguity.

Also extract shared helpers into internal/net/keepalive.go:
- WrapKeepaliveListener: applies KeepAliveConfig on every accepted TCPConn
- ApplyKeepalive: applies KeepAliveConfig to a single TCPConn

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Andrew Beresford
2026-05-08 14:23:51 +01:00
parent cf70a0cbe1
commit ac99425002
36 changed files with 383 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dialer/grpc/dialer.go
+10
View File
@@ -8,6 +8,7 @@ import (
"github.com/go-gost/core/dialer"
md "github.com/go-gost/core/metadata"
xctx "github.com/go-gost/x/ctx"
xnet "github.com/go-gost/x/internal/net"
"github.com/go-gost/x/internal/net/proxyproto"
pb "github.com/go-gost/x/internal/util/grpc/proto"
"github.com/go-gost/x/registry"
@@ -78,6 +79,15 @@ func (d *grpcDialer) Dial(ctx context.Context, addr string, opts ...dialer.DialO
return nil, err
}
if d.md.tcpKeepalive {
xnet.ApplyKeepalive(conn, net.KeepAliveConfig{
Enable: true,
Idle: d.md.tcpKeepaliveIdle,
Interval: d.md.tcpKeepaliveInterval,
Count: d.md.tcpKeepaliveCount,
})
}
conn = proxyproto.WrapClientConn(
d.options.ProxyProtocol,
xctx.SrcAddrFromContext(ctx),
dialer/grpc/metadata.go
+10
View File
@@ -16,6 +16,11 @@ type metadata struct {
keepaliveTimeout time.Duration
keepalivePermitWithoutStream bool
minConnectTimeout time.Duration
tcpKeepalive bool
tcpKeepaliveIdle time.Duration
tcpKeepaliveInterval time.Duration
tcpKeepaliveCount int
}
func (d *grpcDialer) parseMetadata(md mdata.Metadata) (err error) {
@@ -39,5 +44,10 @@ func (d *grpcDialer) parseMetadata(md mdata.Metadata) (err error) {
d.md.minConnectTimeout = 30 * time.Second
}
d.md.tcpKeepalive = mdutil.GetBool(md, "tcp.keepalive")
d.md.tcpKeepaliveIdle = mdutil.GetDuration(md, "tcp.keepalive.idle")
d.md.tcpKeepaliveInterval = mdutil.GetDuration(md, "tcp.keepalive.interval")
d.md.tcpKeepaliveCount = mdutil.GetInt(md, "tcp.keepalive.count")
return
}
dialer/mtcp/dialer.go
+10
View File
@@ -11,6 +11,7 @@ import (
"github.com/go-gost/core/logger"
md "github.com/go-gost/core/metadata"
xctx "github.com/go-gost/x/ctx"
xnet "github.com/go-gost/x/internal/net"
"github.com/go-gost/x/internal/net/proxyproto"
"github.com/go-gost/x/internal/util/mux"
"github.com/go-gost/x/registry"
@@ -74,6 +75,15 @@ func (d *mtcpDialer) Dial(ctx context.Context, addr string, opts ...dialer.DialO
return
}
if d.md.keepalive {
xnet.ApplyKeepalive(conn, net.KeepAliveConfig{
Enable: true,
Idle: d.md.keepaliveIdle,
Interval: d.md.keepaliveInterval,
Count: d.md.keepaliveCount,
})
}
conn = proxyproto.WrapClientConn(
d.options.ProxyProtocol,
xctx.SrcAddrFromContext(ctx),
dialer/mtcp/metadata.go
+10
View File
@@ -11,11 +11,21 @@ import (
type metadata struct {
handshakeTimeout time.Duration
muxCfg *mux.Config
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (d *mtcpDialer) parseMetadata(md mdata.Metadata) (err error) {
d.md.handshakeTimeout = mdutil.GetDuration(md, "handshakeTimeout")
d.md.keepalive = mdutil.GetBool(md, "keepalive")
d.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
d.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
d.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
d.md.muxCfg = &mux.Config{
Version: mdutil.GetInt(md, "mux.version"),
KeepAliveInterval: mdutil.GetDuration(md, "mux.keepaliveInterval"),
dialer/mtls/dialer.go
+10
View File
@@ -12,6 +12,7 @@ import (
"github.com/go-gost/core/logger"
md "github.com/go-gost/core/metadata"
xctx "github.com/go-gost/x/ctx"
xnet "github.com/go-gost/x/internal/net"
"github.com/go-gost/x/internal/net/proxyproto"
"github.com/go-gost/x/internal/util/mux"
"github.com/go-gost/x/registry"
@@ -75,6 +76,15 @@ func (d *mtlsDialer) Dial(ctx context.Context, addr string, opts ...dialer.DialO
return
}
if d.md.keepalive {
xnet.ApplyKeepalive(conn, net.KeepAliveConfig{
Enable: true,
Idle: d.md.keepaliveIdle,
Interval: d.md.keepaliveInterval,
Count: d.md.keepaliveCount,
})
}
conn = proxyproto.WrapClientConn(
d.options.ProxyProtocol,
xctx.SrcAddrFromContext(ctx),
dialer/mtls/metadata.go
+10
View File
@@ -11,11 +11,21 @@ import (
type metadata struct {
handshakeTimeout time.Duration
muxCfg *mux.Config
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (d *mtlsDialer) parseMetadata(md mdata.Metadata) (err error) {
d.md.handshakeTimeout = mdutil.GetDuration(md, "handshakeTimeout")
d.md.keepalive = mdutil.GetBool(md, "keepalive")
d.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
d.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
d.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
d.md.muxCfg = &mux.Config{
Version: mdutil.GetInt(md, "mux.version"),
KeepAliveInterval: mdutil.GetDuration(md, "mux.keepaliveInterval"),
dialer/mws/dialer.go
+10
View File
@@ -12,6 +12,7 @@ import (
"github.com/go-gost/core/logger"
md "github.com/go-gost/core/metadata"
xctx "github.com/go-gost/x/ctx"
xnet "github.com/go-gost/x/internal/net"
"github.com/go-gost/x/internal/net/proxyproto"
"github.com/go-gost/x/internal/util/mux"
ws_util "github.com/go-gost/x/internal/util/ws"
@@ -89,6 +90,15 @@ func (d *mwsDialer) Dial(ctx context.Context, addr string, opts ...dialer.DialOp
return
}
if d.md.tcpKeepalive {
xnet.ApplyKeepalive(conn, net.KeepAliveConfig{
Enable: true,
Idle: d.md.tcpKeepaliveIdle,
Interval: d.md.tcpKeepaliveInterval,
Count: d.md.tcpKeepaliveCount,
})
}
conn = proxyproto.WrapClientConn(
d.options.ProxyProtocol,
xctx.SrcAddrFromContext(ctx),
dialer/mws/metadata.go
+10
View File
@@ -27,6 +27,11 @@ type metadata struct {
header http.Header
keepaliveInterval time.Duration
muxCfg *mux.Config
tcpKeepalive bool
tcpKeepaliveIdle time.Duration
tcpKeepaliveInterval time.Duration
tcpKeepaliveCount int
}
func (d *mwsDialer) parseMetadata(md mdata.Metadata) (err error) {
@@ -67,5 +72,10 @@ func (d *mwsDialer) parseMetadata(md mdata.Metadata) (err error) {
}
}
d.md.tcpKeepalive = mdutil.GetBool(md, "tcp.keepalive")
d.md.tcpKeepaliveIdle = mdutil.GetDuration(md, "tcp.keepalive.idle")
d.md.tcpKeepaliveInterval = mdutil.GetDuration(md, "tcp.keepalive.interval")
d.md.tcpKeepaliveCount = mdutil.GetInt(md, "tcp.keepalive.count")
return
}
dialer/ssh/dialer.go
+9
View File
@@ -9,6 +9,7 @@ import (
"github.com/go-gost/core/dialer"
md "github.com/go-gost/core/metadata"
xctx "github.com/go-gost/x/ctx"
xnet "github.com/go-gost/x/internal/net"
"github.com/go-gost/x/internal/net/proxyproto"
ssh_util "github.com/go-gost/x/internal/util/ssh"
"github.com/go-gost/x/registry"
@@ -70,6 +71,14 @@ func (d *sshDialer) Dial(ctx context.Context, addr string, opts ...dialer.DialOp
if err != nil {
return
}
if d.md.tcpKeepalive {
xnet.ApplyKeepalive(conn, net.KeepAliveConfig{
Enable: true,
Idle: d.md.tcpKeepaliveIdle,
Interval: d.md.tcpKeepaliveInterval,
Count: d.md.tcpKeepaliveCount,
})
}
if d.md.handshakeTimeout > 0 {
conn.SetDeadline(time.Now().Add(d.md.handshakeTimeout))
defer conn.SetDeadline(time.Time{})
dialer/ssh/metadata.go
+10
View File
@@ -19,6 +19,11 @@ type metadata struct {
keepaliveInterval time.Duration
keepaliveTimeout time.Duration
keepaliveRetries int
tcpKeepalive bool
tcpKeepaliveIdle time.Duration
tcpKeepaliveInterval time.Duration
tcpKeepaliveCount int
}
func (d *sshDialer) parseMetadata(md mdata.Metadata) (err error) {
@@ -66,5 +71,10 @@ func (d *sshDialer) parseMetadata(md mdata.Metadata) (err error) {
d.md.keepaliveRetries = mdutil.GetInt(md, "keepalive.retries")
}
d.md.tcpKeepalive = mdutil.GetBool(md, "tcp.keepalive")
d.md.tcpKeepaliveIdle = mdutil.GetDuration(md, "tcp.keepalive.idle")
d.md.tcpKeepaliveInterval = mdutil.GetDuration(md, "tcp.keepalive.interval")
d.md.tcpKeepaliveCount = mdutil.GetInt(md, "tcp.keepalive.count")
return
}
dialer/sshd/dialer.go
+9
View File
@@ -10,6 +10,7 @@ import (
"github.com/go-gost/core/dialer"
md "github.com/go-gost/core/metadata"
xctx "github.com/go-gost/x/ctx"
xnet "github.com/go-gost/x/internal/net"
"github.com/go-gost/x/internal/net/proxyproto"
ssh_util "github.com/go-gost/x/internal/util/ssh"
"github.com/go-gost/x/registry"
@@ -72,6 +73,14 @@ func (d *sshdDialer) Dial(ctx context.Context, addr string, opts ...dialer.DialO
if err != nil {
return
}
if d.md.tcpKeepalive {
xnet.ApplyKeepalive(conn, net.KeepAliveConfig{
Enable: true,
Idle: d.md.tcpKeepaliveIdle,
Interval: d.md.tcpKeepaliveInterval,
Count: d.md.tcpKeepaliveCount,
})
}
if d.md.handshakeTimeout > 0 {
conn.SetDeadline(time.Now().Add(d.md.handshakeTimeout))
dialer/sshd/metadata.go
+11
View File
@@ -19,6 +19,11 @@ type metadata struct {
keepaliveInterval time.Duration
keepaliveTimeout time.Duration
keepaliveRetries int
tcpKeepalive bool
tcpKeepaliveIdle time.Duration
tcpKeepaliveInterval time.Duration
tcpKeepaliveCount int
}
func (d *sshdDialer) parseMetadata(md mdata.Metadata) (err error) {
@@ -64,5 +69,11 @@ func (d *sshdDialer) parseMetadata(md mdata.Metadata) (err error) {
d.md.keepaliveTimeout = mdutil.GetDuration(md, "keepalive.timeout")
d.md.keepaliveRetries = mdutil.GetInt(md, "keepalive.retries")
}
d.md.tcpKeepalive = mdutil.GetBool(md, "tcp.keepalive")
d.md.tcpKeepaliveIdle = mdutil.GetDuration(md, "tcp.keepalive.idle")
d.md.tcpKeepaliveInterval = mdutil.GetDuration(md, "tcp.keepalive.interval")
d.md.tcpKeepaliveCount = mdutil.GetInt(md, "tcp.keepalive.count")
return
}
dialer/tls/dialer.go
+10
View File
@@ -10,6 +10,7 @@ import (
"github.com/go-gost/core/logger"
md "github.com/go-gost/core/metadata"
xctx "github.com/go-gost/x/ctx"
xnet "github.com/go-gost/x/internal/net"
"github.com/go-gost/x/internal/net/proxyproto"
"github.com/go-gost/x/registry"
)
@@ -51,6 +52,15 @@ func (d *tlsDialer) Dial(ctx context.Context, addr string, opts ...dialer.DialOp
d.log.Error(err)
}
if d.md.keepalive {
xnet.ApplyKeepalive(conn, net.KeepAliveConfig{
Enable: true,
Idle: d.md.keepaliveIdle,
Interval: d.md.keepaliveInterval,
Count: d.md.keepaliveCount,
})
}
conn = proxyproto.WrapClientConn(
d.options.ProxyProtocol,
xctx.SrcAddrFromContext(ctx),
dialer/tls/metadata.go
+10
View File
@@ -9,6 +9,11 @@ import (
type metadata struct {
handshakeTimeout time.Duration
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (d *tlsDialer) parseMetadata(md mdata.Metadata) (err error) {
@@ -18,5 +23,10 @@ func (d *tlsDialer) parseMetadata(md mdata.Metadata) (err error) {
d.md.handshakeTimeout = mdutil.GetDuration(md, handshakeTimeout)
d.md.keepalive = mdutil.GetBool(md, "keepalive")
d.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
d.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
d.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
return
}
dialer/ws/dialer.go
+10
View File
@@ -9,6 +9,7 @@ import (
"github.com/go-gost/core/dialer"
md "github.com/go-gost/core/metadata"
xctx "github.com/go-gost/x/ctx"
xnet "github.com/go-gost/x/internal/net"
"github.com/go-gost/x/internal/net/proxyproto"
ws_util "github.com/go-gost/x/internal/util/ws"
"github.com/go-gost/x/registry"
@@ -64,6 +65,15 @@ func (d *wsDialer) Dial(ctx context.Context, addr string, opts ...dialer.DialOpt
d.options.Logger.Error(err)
}
if d.md.tcpKeepalive {
xnet.ApplyKeepalive(conn, net.KeepAliveConfig{
Enable: true,
Idle: d.md.tcpKeepaliveIdle,
Interval: d.md.tcpKeepaliveInterval,
Count: d.md.tcpKeepaliveCount,
})
}
conn = proxyproto.WrapClientConn(
d.options.ProxyProtocol,
xctx.SrcAddrFromContext(ctx),
dialer/ws/metadata.go
+10
View File
@@ -25,6 +25,11 @@ type metadata struct {
header http.Header
keepaliveInterval time.Duration
tcpKeepalive bool
tcpKeepaliveIdle time.Duration
tcpKeepaliveInterval time.Duration
tcpKeepaliveCount int
}
func (d *wsDialer) parseMetadata(md mdata.Metadata) (err error) {
@@ -56,5 +61,10 @@ func (d *wsDialer) parseMetadata(md mdata.Metadata) (err error) {
}
}
d.md.tcpKeepalive = mdutil.GetBool(md, "tcp.keepalive")
d.md.tcpKeepaliveIdle = mdutil.GetDuration(md, "tcp.keepalive.idle")
d.md.tcpKeepaliveInterval = mdutil.GetDuration(md, "tcp.keepalive.interval")
d.md.tcpKeepaliveCount = mdutil.GetInt(md, "tcp.keepalive.count")
return
}