fix(webui): Server 读侧超时(防 Slowloris)+ 反向判据守住流式不被腰斩

http.Server 原本**一个超时都没设**(只有 Handler)。后果是 Slowloris:
攻击者只占连接不发完整请求头,每个连接挂几 KB。MaxHeaderBytes 限的是
头部**大小**,「慢慢发」不占大小、不受它约束,几百个连接就能耗尽 fd。

## 为什么不是「把超时都设上」

webui 有一条长连接 SSE(/api/v1/chat/events)与可跑 300s 的流式
/v1/chat/completions。WriteTimeout 是「从请求开始到响应写完」的**总预算**,
会把它们腰斩 —— 表现为 SSE 每隔一段时间断一次、前端疯狂重连。而这类
回归在功能测试里很难立刻发现。

所以只设读侧三项,各管一段:

  ReadHeaderTimeout 20s —— 请求头必须按时发完,Slowloris 的正解
  ReadTimeout       60s —— 读完整请求(含 body)的预算,防慢速上传
  IdleTimeout      120s —— keep-alive 空闲连接(另两项都管不到)
  WriteTimeout        0 —— **刻意不设**(见上)

## 判据(3 条,含一条反向判据)

- TestServerHasReadSideTimeouts:三个读侧超时都必须 > 0
- TestServerHasNoWriteTimeout:**反向**钉住 WriteTimeout 必须保持 0,
  防止将来有人「顺手补全超时」把 SSE 弄坏
- TestSSEConnectionSurvivesBeyondReadTimeout:SSE 连接确实活过读侧窗口

反向判据看着琐碎,但它守的正是「这次没做的那件事」——
不加 WriteTimeout 是个**决定**,不是疏漏,所以要用判据把决定固定下来。

变异验证:补上 WriteTimeout:30s → 反向判据判红;
去掉 ReadHeaderTimeout → 前向判据判红。

测试脚手架注意:newServerForTest 绑 127.0.0.1:0(内核分配空闲端口),
绝不用 :8080 —— 那是生产端口(见 a752ae1)。

全量:35 包全绿。
This commit is contained in:
JianFeeeee
2026-09-26 10:00:27 +08:00
parent 35df6f4366
commit 3273c507b3
2 changed files with 129 additions and 1 deletions

View File

@ -1,7 +1,9 @@
package webui
import (
"bufio"
"bytes"
"net"
"net/http"
"net/http/httptest"
"strconv"
@ -318,3 +320,108 @@ func TestParseTrustedProxies(t *testing.T) {
t.Error("空白配置应返回 nil(保守默认:不采信 XFF)")
}
}
// ===== Server 超时:Slowloris 防护,但不能误杀流式 =====
//
// http.Server 原本**一个超时都没设**(只有 Handler)。后果是 Slowloris:
// 攻击者只占连接不发完整请求头,每个连接挂几 KB,Go 默认不主动断
// (MaxHeaderBytes 限了头部大小,但「慢慢发」不占头部大小),
// 几百个连接就能耗尽 fd。
//
// ★ 但不能图省事直接加 WriteTimeout:webui 有一条**长连接** SSE
// (/api/v1/chat/events)与流式 /v1/chat/completions(可跑 300s)。
// WriteTimeout 是**从请求开始到响应写完**的总预算,会把它们全部腰斩
// (表现为 SSE 每 30s 断一次、前端疯狂重连)。
//
// 判据钉住该设的与不该设的。
func TestServerHasReadSideTimeouts(t *testing.T) {
p := newServerForTest(t)
srv := p.server
if srv == nil {
t.Fatal("server 未初始化")
}
// ReadHeaderTimeout 是 Slowloris 的正解:头在规定时间内没发完就断。
if srv.ReadHeaderTimeout <= 0 {
t.Errorf("ReadHeaderTimeout = %v,必须 > 0(无此值时 Slowloris 可挂住连接)",
srv.ReadHeaderTimeout)
}
// IdleTimeout 覆盖 keep-alive 空闲连接(ReadHeaderTimeout 管不到)。
if srv.IdleTimeout <= 0 {
t.Errorf("IdleTimeout = %v,必须 > 0(keep-alive 空闲连接会无限累积)", srv.IdleTimeout)
}
// ReadTimeout 限制「读完整请求」的<E3808D><E79A84>间(含 body),防慢速上传。
if srv.ReadTimeout <= 0 {
t.Errorf("ReadTimeout = %v,必须 > 0(慢速上传会长期占用连接)", srv.ReadTimeout)
}
}
// ★ 反向判据:WriteTimeout 必须为 0(保持流式不被腰斩)。
// 这是「不该设的超时」,同样要钉住 —— 否则将来有人「顺手补全」就把
// SSE 与流式端点弄坏了,而这类回归在功能测试里很难立刻发现。
func TestServerHasNoWriteTimeout(t *testing.T) {
p := newServerForTest(t)
if got := p.server.WriteTimeout; got != 0 {
t.Errorf("WriteTimeout = %v,应为 0 —— 它会腰斩 SSE(/api/v1/chat/events)"+
"与流式 /v1/chat/completions(可跑 300s),表现为 SSE 每隔一段时间断一次",
got)
}
}
// SSE 端点必须真的能长时间保持连接(判据的正面一侧)。
// 短于 WriteTimeout 的观察窗口即可(不需要真等 30s)。
func TestSSEConnectionSurvivesBeyondReadTimeout(t *testing.T) {
srv, _, _ := newOpenAITestServer(t)
// 连上 SSE,观察它至少活过 ReadHeaderTimeout(证明没有被读侧超时误杀)
req, _ := http.NewRequest(http.MethodGet, srv.URL+"/api/v1/chat/events", nil)
req.Header.Set("X-API-Key", testAuthAPIKey)
req.Header.Set("Accept", "text/event-stream")
resp, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatalf("SSE 连接失败: %v", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
t.Fatalf("SSE 应 200,实际 %d", resp.StatusCode)
}
// 试着读一点:能读到(哪怕是心跳/注释行)说明连接是活的
rd := bufio.NewReader(resp.Body)
done := make(chan bool, 1)
go func() {
_, err := rd.ReadString('\n')
done <- err == nil
}()
select {
case ok := <-done:
if !ok {
t.Error("SSE 首读即失败(连接被立即关闭)")
}
case <-time.After(5 * time.Second):
// 没数据也算活:SSE 空闲时不发帧是正常的,关键是连接没断。
_ = resp.Body.Close()
}
}
// newServerForTest 起一个 webui 插件实例(走真实 Start),用于检查 server 配置。
func newServerForTest(t *testing.T) *Plugin {
t.Helper()
cfgReg := internalConfig.NewConfigRegistry("")
seedWebUIConfig(cfgReg)
// 绑到空闲端口:绝不能用 :8080,那是生产端口(见 a752ae1 的教训)
probe, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatal(err)
}
addr := probe.Addr().String()
probe.Close()
cfgReg.PluginConfig("webui").Set("addr", addr)
p := &Plugin{name: "webui", mux: http.NewServeMux()}
s := testSDK(sdk.SDKConfig{Settings: sdk.NewSettings("webui", cfgReg)})
if err := p.Start(s); err != nil {
t.Fatalf("启动 webui 失败: %v", err)
}
t.Cleanup(func() { _ = p.Stop() })
return p
}

View File

@ -11,6 +11,7 @@ import (
"os"
"path/filepath"
"strings"
"time"
"gitcode.com/JianFeeeee/HomeAgent/internal/plugin"
sdk "gitcode.com/JianFeeeee/HomeAgent/internal/sdk"
@ -324,7 +325,27 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
if _, port, err := net.SplitHostPort(ln.Addr().String()); err == nil {
p.handler.hostPort = ":" + port
}
p.server = &http.Server{Handler: p.handler.Handler()}
// 超时配置。为什么不"全设上"(读侧全设、写侧全不设):
//
// 读侧必须有超时,否则 Slowloris —— 攻击者只占连接不发完整请求头,
// 每个连接挂几 KB。MaxHeaderBytes 限的是头部**大小**,"慢慢发"不占大小,
// 因此不受它约束;几百个连接就能耗尽 fd。这里三个读侧超时分别覆盖:
// ReadHeaderTimeout —— 请求头必须在此时间内发完(Slowloris 的正解)
// ReadTimeout —— 读完整请求(含 body)的预算,防慢速上传
// IdleTimeout —— keep-alive 空闲连接(另外两个都管不到)
//
// 写侧**刻意不设**:webui 有长连接 SSE(/api/v1/chat/events)与可跑
// 300s 的流式 /v1/chat/completions。WriteTimeout 是"从请求开始到响应
// 写完"的**总预算**,会把它们腰斩(表现为 SSE 每隔一段时间断一次、
// 前端疯狂重连)—— 这类回归很难在功能测试里立刻发现,所以有专门
// 的反向判据钉住它必须保持为 0。
p.server = &http.Server{
Handler: p.handler.Handler(),
ReadHeaderTimeout: 20 * time.Second,
ReadTimeout: 60 * time.Second,
IdleTimeout: 120 * time.Second,
// WriteTimeout 保持 0(见上方说明)
}
go func() {
if err := p.server.Serve(ln); err != nil && err != http.ErrServerClosed {
log.Printf("[webui] server error: %v", err)