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
listener/grpc/listener.go
+10
View File
@@ -66,6 +66,16 @@ func (l *grpcListener) Init(md md.Metadata) (err error) {
if err != nil {
return
}
if l.md.tcpKeepalive {
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.tcpKeepaliveIdle,
Interval: l.md.tcpKeepaliveInterval,
Count: l.md.tcpKeepaliveCount,
})
l.logger.Debugf("tcp keepalive enabled: idle=%v interval=%v count=%d",
l.md.tcpKeepaliveIdle, l.md.tcpKeepaliveInterval, l.md.tcpKeepaliveCount)
}
ln = proxyproto.WrapListener(l.options.ProxyProtocol, ln, 10*time.Second)
ln = metrics.WrapListener(l.options.Service, ln)
listener/grpc/metadata.go
+10 -1
View File
@@ -22,6 +22,11 @@ type metadata struct {
keepalivePermitWithoutStream bool
keepaliveMaxConnectionIdle time.Duration
mptcp bool
tcpKeepalive bool
tcpKeepaliveIdle time.Duration
tcpKeepaliveInterval time.Duration
tcpKeepaliveCount int
}
func (l *grpcListener) parseMetadata(md mdata.Metadata) (err error) {
@@ -50,8 +55,12 @@ func (l *grpcListener) parseMetadata(md mdata.Metadata) (err error) {
l.md.keepalivePermitWithoutStream = mdutil.GetBool(md, "grpc.keepalive.permitWithoutStream", "keepalive.permitWithoutStream")
l.md.keepaliveMaxConnectionIdle = mdutil.GetDuration(md, "grpc.keepalive.maxConnectionIdle", "keepalive.maxConnectionIdle")
l.md.mptcp = mdutil.GetBool(md, "mptcp")
}
l.md.mptcp = mdutil.GetBool(md, "mptcp")
l.md.tcpKeepalive = mdutil.GetBool(md, "tcp.keepalive")
l.md.tcpKeepaliveIdle = mdutil.GetDuration(md, "tcp.keepalive.idle")
l.md.tcpKeepaliveInterval = mdutil.GetDuration(md, "tcp.keepalive.interval")
l.md.tcpKeepaliveCount = mdutil.GetInt(md, "tcp.keepalive.count")
return
}
listener/http2/listener.go
+10
View File
@@ -93,6 +93,16 @@ func (l *http2Listener) Init(md md.Metadata) (err error) {
if err != nil {
return err
}
if l.md.keepalive {
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.keepaliveIdle,
Interval: l.md.keepaliveInterval,
Count: l.md.keepaliveCount,
})
l.log.Debugf("tcp keepalive enabled: idle=%v interval=%v count=%d",
l.md.keepaliveIdle, l.md.keepaliveInterval, l.md.keepaliveCount)
}
l.addr = ln.Addr()
ln = proxyproto.WrapListener(l.options.ProxyProtocol, ln, 10*time.Second)
ln = metrics.WrapListener(l.options.Service, ln)
listener/http2/metadata.go
+12
View File
@@ -1,6 +1,8 @@
package http2
import (
"time"
mdata "github.com/go-gost/core/metadata"
mdutil "github.com/go-gost/x/metadata/util"
)
@@ -12,6 +14,11 @@ const (
type metadata struct {
backlog int
mptcp bool
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (l *http2Listener) parseMetadata(md mdata.Metadata) (err error) {
@@ -25,5 +32,10 @@ func (l *http2Listener) parseMetadata(md mdata.Metadata) (err error) {
}
l.md.mptcp = mdutil.GetBool(md, "mptcp")
l.md.keepalive = mdutil.GetBool(md, "keepalive")
l.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
l.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
l.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
return
}
listener/mtcp/listener.go
+10
View File
@@ -63,6 +63,16 @@ func (l *mtcpListener) Init(md md.Metadata) (err error) {
if err != nil {
return
}
if l.md.keepalive {
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.keepaliveIdle,
Interval: l.md.keepaliveInterval,
Count: l.md.keepaliveCount,
})
l.logger.Debugf("tcp keepalive enabled: idle=%v interval=%v count=%d",
l.md.keepaliveIdle, l.md.keepaliveInterval, l.md.keepaliveCount)
}
l.logger.Debugf("pp: %d", l.options.ProxyProtocol)
listener/mtcp/metadata.go
+13 -3
View File
@@ -1,6 +1,8 @@
package mtcp
import (
"time"
md "github.com/go-gost/core/metadata"
"github.com/go-gost/x/internal/util/mux"
mdutil "github.com/go-gost/x/metadata/util"
@@ -11,9 +13,13 @@ const (
)
type metadata struct {
mptcp bool
muxCfg *mux.Config
backlog int
mptcp bool
muxCfg *mux.Config
backlog int
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (l *mtcpListener) parseMetadata(md md.Metadata) (err error) {
@@ -37,5 +43,9 @@ func (l *mtcpListener) parseMetadata(md md.Metadata) (err error) {
l.md.backlog = defaultBacklog
}
l.md.keepalive = mdutil.GetBool(md, "keepalive")
l.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
l.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
l.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
return
}
listener/mtls/listener.go
+10
View File
@@ -64,6 +64,16 @@ func (l *mtlsListener) Init(md md.Metadata) (err error) {
if err != nil {
return
}
if l.md.keepalive {
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.keepaliveIdle,
Interval: l.md.keepaliveInterval,
Count: l.md.keepaliveCount,
})
l.logger.Debugf("tcp keepalive enabled: idle=%v interval=%v count=%d",
l.md.keepaliveIdle, l.md.keepaliveInterval, l.md.keepaliveCount)
}
ln = proxyproto.WrapListener(l.options.ProxyProtocol, ln, 10*time.Second)
ln = metrics.WrapListener(l.options.Service, ln)
listener/mtls/metadata.go
+13 -4
View File
@@ -1,6 +1,8 @@
package mtls
import (
"time"
mdata "github.com/go-gost/core/metadata"
"github.com/go-gost/x/internal/util/mux"
mdutil "github.com/go-gost/x/metadata/util"
@@ -11,9 +13,13 @@ const (
)
type metadata struct {
muxCfg *mux.Config
backlog int
mptcp bool
muxCfg *mux.Config
backlog int
mptcp bool
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (l *mtlsListener) parseMetadata(md mdata.Metadata) (err error) {
@@ -32,6 +38,9 @@ func (l *mtlsListener) parseMetadata(md mdata.Metadata) (err error) {
MaxStreamBuffer: mdutil.GetInt(md, "mux.maxStreamBuffer"),
}
l.md.mptcp = mdutil.GetBool(md, "mptcp")
l.md.keepalive = mdutil.GetBool(md, "keepalive")
l.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
l.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
l.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
return
}
listener/mws/listener.go
+10
View File
@@ -109,6 +109,16 @@ func (l *mwsListener) Init(md md.Metadata) (err error) {
if err != nil {
return
}
if l.md.keepalive {
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.keepaliveIdle,
Interval: l.md.keepaliveInterval,
Count: l.md.keepaliveCount,
})
l.log.Debugf("tcp keepalive enabled: idle=%v interval=%v count=%d",
l.md.keepaliveIdle, l.md.keepaliveInterval, l.md.keepaliveCount)
}
ln = proxyproto.WrapListener(l.options.ProxyProtocol, ln, 10*time.Second)
ln = metrics.WrapListener(l.options.Service, ln)
ln = stats.WrapListener(ln, l.options.Stats)
listener/mws/metadata.go
+10
View File
@@ -28,6 +28,11 @@ type metadata struct {
muxCfg *mux.Config
mptcp bool
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (l *mwsListener) parseMetadata(md mdata.Metadata) (err error) {
@@ -67,5 +72,10 @@ func (l *mwsListener) parseMetadata(md mdata.Metadata) (err error) {
l.md.mptcp = mdutil.GetBool(md, "mptcp")
l.md.keepalive = mdutil.GetBool(md, "keepalive")
l.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
l.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
l.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
return
}
listener/ssh/listener.go
+10
View File
@@ -66,6 +66,16 @@ func (l *sshListener) Init(md md.Metadata) (err error) {
if err != nil {
return err
}
if l.md.keepalive {
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.keepaliveIdle,
Interval: l.md.keepaliveInterval,
Count: l.md.keepaliveCount,
})
l.logger.Debugf("tcp keepalive enabled: idle=%v interval=%v count=%d",
l.md.keepaliveIdle, l.md.keepaliveInterval, l.md.keepaliveCount)
}
ln = proxyproto.WrapListener(l.options.ProxyProtocol, ln, 10*time.Second)
ln = metrics.WrapListener(l.options.Service, ln)
listener/ssh/metadata.go
+11
View File
@@ -2,6 +2,7 @@ package ssh
import (
"os"
"time"
mdata "github.com/go-gost/core/metadata"
ssh_util "github.com/go-gost/x/internal/util/ssh"
@@ -19,6 +20,11 @@ type metadata struct {
authorizedKeys map[string]bool
backlog int
mptcp bool
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (l *sshListener) parseMetadata(md mdata.Metadata) (err error) {
@@ -72,5 +78,10 @@ func (l *sshListener) parseMetadata(md mdata.Metadata) (err error) {
l.md.mptcp = mdutil.GetBool(md, "mptcp")
l.md.keepalive = mdutil.GetBool(md, "keepalive")
l.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
l.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
l.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
return
}
listener/sshd/listener.go
+10
View File
@@ -74,6 +74,16 @@ func (l *sshdListener) Init(md md.Metadata) (err error) {
if err != nil {
return err
}
if l.md.keepalive {
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.keepaliveIdle,
Interval: l.md.keepaliveInterval,
Count: l.md.keepaliveCount,
})
l.logger.Debugf("tcp keepalive enabled: idle=%v interval=%v count=%d",
l.md.keepaliveIdle, l.md.keepaliveInterval, l.md.keepaliveCount)
}
ln = proxyproto.WrapListener(l.options.ProxyProtocol, ln, 10*time.Second)
ln = metrics.WrapListener(l.options.Service, ln)
listener/sshd/metadata.go
+11
View File
@@ -3,6 +3,7 @@ package ssh
import (
"fmt"
"os"
"time"
mdata "github.com/go-gost/core/metadata"
ssh_util "github.com/go-gost/x/internal/util/ssh"
@@ -21,6 +22,11 @@ type metadata struct {
authorizedKeys map[string]bool
backlog int
mptcp bool
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (l *sshdListener) parseMetadata(md mdata.Metadata) (err error) {
@@ -82,5 +88,10 @@ func (l *sshdListener) parseMetadata(md mdata.Metadata) (err error) {
l.md.mptcp = mdutil.GetBool(md, "mptcp")
l.md.keepalive = mdutil.GetBool(md, "keepalive")
l.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
l.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
l.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
return
}
listener/tcp/listener.go
+1 -22
View File
@@ -62,7 +62,7 @@ func (l *tcpListener) Init(md md.Metadata) (err error) {
}
if l.md.keepalive {
ln = newKeepaliveListener(ln, net.KeepAliveConfig{
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.keepaliveIdle,
Interval: l.md.keepaliveInterval,
@@ -112,24 +112,3 @@ func (l *tcpListener) Close() error {
return l.ln.Close()
}
// keepaliveListener applies TCP keepalive settings to every accepted connection
// before the connection enters the middleware chain.
type keepaliveListener struct {
net.Listener
cfg net.KeepAliveConfig
}
func newKeepaliveListener(ln net.Listener, cfg net.KeepAliveConfig) net.Listener {
return &keepaliveListener{Listener: ln, cfg: cfg}
}
func (l *keepaliveListener) Accept() (net.Conn, error) {
conn, err := l.Listener.Accept()
if err != nil {
return nil, err
}
if tc, ok := conn.(*net.TCPConn); ok {
tc.SetKeepAliveConfig(l.cfg)
}
return conn, nil
}
listener/tls/listener.go
+10
View File
@@ -61,6 +61,16 @@ func (l *tlsListener) Init(md md.Metadata) (err error) {
if err != nil {
return
}
if l.md.keepalive {
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.keepaliveIdle,
Interval: l.md.keepaliveInterval,
Count: l.md.keepaliveCount,
})
l.logger.Debugf("tcp keepalive enabled: idle=%v interval=%v count=%d",
l.md.keepaliveIdle, l.md.keepaliveInterval, l.md.keepaliveCount)
}
ln = proxyproto.WrapListener(l.options.ProxyProtocol, ln, 10*time.Second)
ln = metrics.WrapListener(l.options.Service, ln)
ln = stats.WrapListener(ln, l.options.Stats)
listener/tls/metadata.go
+11 -2
View File
@@ -1,16 +1,25 @@
package tls
import (
"time"
mdata "github.com/go-gost/core/metadata"
mdutil "github.com/go-gost/x/metadata/util"
)
type metadata struct {
mptcp bool
mptcp bool
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (l *tlsListener) parseMetadata(md mdata.Metadata) (err error) {
l.md.mptcp = mdutil.GetBool(md, "mptcp")
l.md.keepalive = mdutil.GetBool(md, "keepalive")
l.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
l.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
l.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
return
}
listener/ws/listener.go
+10
View File
@@ -104,6 +104,16 @@ func (l *wsListener) Init(md md.Metadata) (err error) {
if err != nil {
return
}
if l.md.keepalive {
ln = xnet.WrapKeepaliveListener(ln, net.KeepAliveConfig{
Enable: true,
Idle: l.md.keepaliveIdle,
Interval: l.md.keepaliveInterval,
Count: l.md.keepaliveCount,
})
l.log.Debugf("tcp keepalive enabled: idle=%v interval=%v count=%d",
l.md.keepaliveIdle, l.md.keepaliveInterval, l.md.keepaliveCount)
}
ln = proxyproto.WrapListener(l.options.ProxyProtocol, ln, 10*time.Second)
ln = metrics.WrapListener(l.options.Service, ln)
ln = stats.WrapListener(ln, l.options.Stats)
listener/ws/metadata.go
+10
View File
@@ -25,6 +25,11 @@ type metadata struct {
header http.Header
mptcp bool
keepalive bool
keepaliveIdle time.Duration
keepaliveInterval time.Duration
keepaliveCount int
}
func (l *wsListener) parseMetadata(md mdata.Metadata) (err error) {
@@ -54,5 +59,10 @@ func (l *wsListener) parseMetadata(md mdata.Metadata) (err error) {
l.md.mptcp = mdutil.GetBool(md, "mptcp")
l.md.keepalive = mdutil.GetBool(md, "keepalive")
l.md.keepaliveIdle = mdutil.GetDuration(md, "keepalive.idle")
l.md.keepaliveInterval = mdutil.GetDuration(md, "keepalive.interval")
l.md.keepaliveCount = mdutil.GetInt(md, "keepalive.count")
return
}