Merge branch 'main' into feat/configurable-proxy

# Conflicts:
#	.gitignore
#	client/lib/l10n/strings_es.dart
#	client/lib/l10n/strings_ja.dart
#	client/lib/l10n/strings_ko.dart
#	client/lib/l10n/strings_ru.dart
#	docs/index.html
#	scripts/local_test.sh
This commit is contained in:
wangjia
2026-07-28 07:17:34 +08:00
46 changed files with 5136 additions and 120 deletions
+17
View File
@@ -44,6 +44,23 @@ func main() {
ctx, stop := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
defer stop()
// SIGHUP 重读节点本地配置(acl.json / warp.json)并重渲染。走 sing-box 的 SIGHUP
// 热重载路径,在线用户不掉线;重启 agent 则会冷启 sing-box,把所有人踢下线。
hup := make(chan os.Signal, 1)
signal.Notify(hup, syscall.SIGHUP)
defer signal.Stop(hup)
go func() {
for {
select {
case <-ctx.Done():
return
case <-hup:
log.Printf("[pangolin-agent] SIGHUP: re-reading node-local config (acl.json/warp.json)")
agent.SingBox().Refresh()
}
}
}()
log.Printf("[pangolin-agent] starting (control-plane=%s, version=%s)", cfg.ControlPlaneAddr, cfg.AgentVersion)
start := time.Now()
if err := agent.Run(ctx); err != nil {
+9 -1
View File
@@ -419,7 +419,15 @@ func mountV1(r chi.Router, sqlDB *sql.DB, rdb *redis.Client, nodeSvc *nodes.Serv
slog.Warn("PANGOLIN_PUBLIC_URL 未设置:国内分流(split_cn)将被静默跳过,客户端全量走隧道。" +
"如需国内直连,设为控制面对外公网基址(如 http://<公网IP>:8080)")
}
nodeAPI = httpapi.NewNodeAPI(nodeStore, nodeSvc.Hub(), nodeSvc.Load(), os.Getenv("NODE_DERIVE_KEY"), publicURL)
// 私有服务域名分流(家庭内网穿透,如 nas/git/win.yanmeiai.com):
// 逗号分隔;这些域名用系统 DNS 解析、在外强制走隧道(排在国内分流前)。
var privateSplitDomains []string
for _, d := range strings.Split(os.Getenv("PANGOLIN_PRIVATE_SPLIT_DOMAINS"), ",") {
if d = strings.TrimSpace(d); d != "" {
privateSplitDomains = append(privateSplitDomains, d)
}
}
nodeAPI = httpapi.NewNodeAPI(nodeStore, nodeSvc.Hub(), nodeSvc.Load(), os.Getenv("NODE_DERIVE_KEY"), publicURL, privateSplitDomains)
}
// 国内分流(#5)的 rule-set 静态服务:GET /v1/rules/{name}.srs(自托管,
+69 -19
View File
@@ -31,11 +31,14 @@ type Authenticator struct {
failMax int
lockDur time.Duration
sec *SecurityLog
trusted *TrustedStore
trustTTL time.Duration
// now is overridable in tests.
now func() time.Time
}
// NewAuthenticator wires an Authenticator.
// NewAuthenticator wires an Authenticator. Device-trust ("记住此设备") is
// enabled when cfg.TrustedDeviceTTL > 0.
func NewAuthenticator(store Store, sessions *SessionStore, rdb *redis.Client, cfg *Config, sec *SecurityLog) *Authenticator {
return &Authenticator{
store: store,
@@ -45,58 +48,105 @@ func NewAuthenticator(store Store, sessions *SessionStore, rdb *redis.Client, cf
failMax: cfg.LoginFailMax,
lockDur: cfg.LoginLockDuration,
sec: sec,
trusted: NewTrustedStore(rdb, cfg.TrustedDeviceTTL),
trustTTL: cfg.TrustedDeviceTTL,
now: func() time.Time { return time.Now().UTC() },
}
}
// LoginResult is the outcome of a device-aware login.
type LoginResult struct {
SID string
Session *Session
// NewTrustToken is non-empty when the caller ticked "记住此设备" and a fresh
// device-trust token was issued — the handler sets it as the trust cookie.
NewTrustToken string
// Persistent is true when this login should use a long-lived (trust-TTL)
// session + cookie instead of the short idle default.
Persistent bool
}
// Login validates username + password + TOTP and, on success, creates a
// session and returns its id. Every failure is rate-limited and recorded as a
// security event in the audit log (red line: admin records only security
// events, never routine access).
func (a *Authenticator) Login(ctx context.Context, username, password, code, remoteIP string) (sid string, sess *Session, err error) {
res, lerr := a.LoginDevice(ctx, username, password, code, remoteIP, "", false)
return res.SID, res.Session, lerr
}
// LoginDevice is the device-aware login: username + password are ALWAYS
// required; the TOTP second factor is skipped only when trustToken is a live
// trust token bound to this admin ("记住此设备"). When remember is set, a fresh
// trust token is issued and the session is made persistent (trust-TTL long).
//
// Security invariant: a trust token never substitutes for the password — a
// wrong password fails regardless of trust.
func (a *Authenticator) LoginDevice(ctx context.Context, username, password, code, remoteIP, trustToken string, remember bool) (LoginResult, error) {
locked, lerr := a.isLocked(ctx, username)
if lerr != nil {
return "", nil, fmt.Errorf("admin.Login lock check: %w", lerr)
return LoginResult{}, fmt.Errorf("admin.Login lock check: %w", lerr)
}
if locked {
a.sec.LoginLocked(ctx, username, remoteIP)
return "", nil, ErrLockedOut
return LoginResult{}, ErrLockedOut
}
admin, gerr := a.store.GetAdminByUsername(ctx, username)
if gerr != nil && !errors.Is(gerr, ErrAdminNotFound) {
return "", nil, fmt.Errorf("admin.Login lookup: %w", gerr)
return LoginResult{}, fmt.Errorf("admin.Login lookup: %w", gerr)
}
if admin == nil || admin.Status != "active" || !VerifyPassword(admin.PwHash, password) {
a.recordFail(ctx, username)
a.sec.LoginFail(ctx, username, remoteIP, "bad_password")
return "", nil, ErrInvalidCredentials
return LoginResult{}, ErrInvalidCredentials
}
secret, derr := DecryptSecret(a.secret, admin.TOTPSecretEnc)
if derr != nil {
a.recordFail(ctx, username)
a.sec.LoginFail(ctx, username, remoteIP, "totp_decrypt")
return "", nil, ErrInvalidCredentials
}
if !totp.Validate(secret, code, a.now(), 1) {
a.recordFail(ctx, username)
a.sec.LoginFail(ctx, username, remoteIP, "bad_totp")
return "", nil, ErrInvalidCredentials
// Second factor: skip only for a device already trusted by THIS admin.
if !a.trusted.Check(ctx, trustToken, admin.ID) {
secret, derr := DecryptSecret(a.secret, admin.TOTPSecretEnc)
if derr != nil {
a.recordFail(ctx, username)
a.sec.LoginFail(ctx, username, remoteIP, "totp_decrypt")
return LoginResult{}, ErrInvalidCredentials
}
if !totp.Validate(secret, code, a.now(), 1) {
a.recordFail(ctx, username)
a.sec.LoginFail(ctx, username, remoteIP, "bad_totp")
return LoginResult{}, ErrInvalidCredentials
}
}
// Success: clear counter, stamp login, create session.
a.clearFail(ctx, username)
if uerr := a.store.UpdateLastLogin(ctx, admin.ID, a.now()); uerr != nil {
return "", nil, fmt.Errorf("admin.Login update: %w", uerr)
return LoginResult{}, fmt.Errorf("admin.Login update: %w", uerr)
}
persistent := remember && a.trusted.Enabled()
var (
sid string
sess *Session
serr error
)
if persistent {
sid, sess, serr = a.sessions.CreateWithTTL(ctx, admin.ID, admin.Username, a.trustTTL)
} else {
sid, sess, serr = a.sessions.Create(ctx, admin.ID, admin.Username)
}
sid, sess, serr := a.sessions.Create(ctx, admin.ID, admin.Username)
if serr != nil {
return "", nil, serr
return LoginResult{}, serr
}
res := LoginResult{SID: sid, Session: sess, Persistent: persistent}
if remember {
if tok, terr := a.trusted.Issue(ctx, admin.ID); terr == nil {
res.NewTrustToken = tok
}
}
a.sec.LoginOK(ctx, username, remoteIP)
return sid, sess, nil
return res, nil
}
func (a *Authenticator) isLocked(ctx context.Context, username string) (bool, error) {
+15
View File
@@ -44,6 +44,12 @@ type Config struct {
// CookieSecure controls the Secure attribute on the session cookie.
// Defaults to true; only disabled explicitly for local/dev over plain HTTP.
CookieSecure bool
// TrustedDeviceTTL is how long a "记住此设备" trust lasts. Within this window
// the device (a) skips the TOTP second factor on re-login and (b) keeps a
// persistent session of the same length. Password is ALWAYS still required.
// Zero disables the feature (checkbox has no effect).
TrustedDeviceTTL time.Duration
}
// defaultInternalCIDRs are the loopback and private/ULA ranges allowed by
@@ -66,6 +72,7 @@ var defaultInternalCIDRs = []string{
// ADMIN_LOGIN_FAIL_MAX int (default 5)
// ADMIN_LOGIN_LOCK Go duration (default 15m)
// ADMIN_COOKIE_INSECURE "1" disables Secure flag (dev only)
// ADMIN_TRUSTED_DEVICE_TTL Go duration (default 720h = 30d; 0 disables)
func FromEnv() (*Config, error) {
c := &Config{
Listen: getEnvDefault("ADMIN_LISTEN", "127.0.0.1:9443"),
@@ -73,6 +80,14 @@ func FromEnv() (*Config, error) {
LoginFailMax: 5,
LoginLockDuration: 15 * time.Minute,
CookieSecure: os.Getenv("ADMIN_COOKIE_INSECURE") != "1",
TrustedDeviceTTL: 30 * 24 * time.Hour,
}
if v := os.Getenv("ADMIN_TRUSTED_DEVICE_TTL"); v != "" {
d, err := time.ParseDuration(v)
if err != nil {
return nil, fmt.Errorf("config: ADMIN_TRUSTED_DEVICE_TTL %q invalid: %w", v, err)
}
c.TrustedDeviceTTL = d
}
if err := validateListen(c.Listen); err != nil {
+39 -4
View File
@@ -61,9 +61,15 @@ func (h *Handlers) LoginSubmit(w http.ResponseWriter, r *http.Request) {
username := strings.TrimSpace(r.PostFormValue("username"))
password := r.PostFormValue("password")
code := strings.TrimSpace(r.PostFormValue("totp"))
ip := hostOnly(r.RemoteAddr)
remember := r.PostFormValue("remember") != ""
ip := realIP(r) // 经本机 caddy 反代时取 XFF 末跳,否则 TCP 对端(见 mw_ipallow.go)
sid, _, err := h.auth.Login(r.Context(), username, password, code, ip)
var trustToken string
if c, cerr := r.Cookie(TrustedDeviceCookieName); cerr == nil {
trustToken = c.Value
}
res, err := h.auth.LoginDevice(r.Context(), username, password, code, ip, trustToken, remember)
if err != nil {
flash := "用户名、密码或动态验证码有误"
if err == ErrLockedOut {
@@ -73,7 +79,14 @@ func (h *Handlers) LoginSubmit(w http.ResponseWriter, r *http.Request) {
h.render.render(w, "login", pageData{Flash: flash})
return
}
h.setSessionCookie(w, sid)
if res.Persistent {
h.setSessionCookieTTL(w, res.SID, h.cfg.TrustedDeviceTTL)
} else {
h.setSessionCookie(w, res.SID)
}
if res.NewTrustToken != "" {
h.setTrustedCookie(w, res.NewTrustToken)
}
http.Redirect(w, r, "/", http.StatusFound)
}
@@ -394,6 +407,14 @@ func (h *Handlers) writeAudit(ctx context.Context, actor, action, target, metaJS
}
func (h *Handlers) setSessionCookie(w http.ResponseWriter, sid string) {
h.setSessionCookieTTL(w, sid, h.cfg.SessionTTL)
}
// setSessionCookieTTL sets the session cookie with an explicit Max-Age. For a
// persistent ("记住此设备") session ttl is the long trust-TTL; otherwise the
// short idle default. Max-Age <= 0 would make it a session cookie, so ttl must
// be positive here.
func (h *Handlers) setSessionCookieTTL(w http.ResponseWriter, sid string, ttl time.Duration) {
http.SetCookie(w, &http.Cookie{
Name: SessionCookieName,
Value: sid,
@@ -401,7 +422,21 @@ func (h *Handlers) setSessionCookie(w http.ResponseWriter, sid string) {
HttpOnly: true,
Secure: h.cfg.CookieSecure,
SameSite: http.SameSiteStrictMode,
MaxAge: int(h.cfg.SessionTTL.Seconds()),
MaxAge: int(ttl.Seconds()),
})
}
// setTrustedCookie stores the device-trust token (HttpOnly, Secure, Strict) so
// this device can skip TOTP on future logins for the trust TTL.
func (h *Handlers) setTrustedCookie(w http.ResponseWriter, token string) {
http.SetCookie(w, &http.Cookie{
Name: TrustedDeviceCookieName,
Value: token,
Path: "/",
HttpOnly: true,
Secure: h.cfg.CookieSecure,
SameSite: http.SameSiteStrictMode,
MaxAge: int(h.cfg.TrustedDeviceTTL.Seconds()),
})
}
@@ -0,0 +1,114 @@
package admin
import (
"crypto/rand"
"net/http"
"net/http/httptest"
"net/url"
"strings"
"testing"
"time"
"github.com/alicebob/miniredis/v2"
"github.com/redis/go-redis/v9"
"github.com/wangjia/pangolin/server/internal/totp"
)
// newTrustEnv wires a full admin router with device-trust ENABLED and seeds
// one admin, returning the router and that admin's TOTP secret.
func newTrustEnv(t *testing.T) (http.Handler, string) {
t.Helper()
mr := miniredis.RunT(t)
rdb := redis.NewClient(&redis.Options{Addr: mr.Addr()})
t.Cleanup(func() { rdb.Close() })
key := make([]byte, 32)
if _, err := rand.Read(key); err != nil {
t.Fatal(err)
}
allow, _ := ParseCIDRs([]string{"127.0.0.0/8"})
cfg := &Config{
Listen: "127.0.0.1:9443", AllowCIDRs: allow, SecretKey: key,
SessionTTL: 30 * time.Minute, LoginFailMax: 3, LoginLockDuration: time.Minute,
CookieSecure: false, TrustedDeviceTTL: 30 * 24 * time.Hour,
}
store := newFakeStore()
secret := newTestAdmin(t, store, key, "alice", "s3cret-pass")
sessions := NewSessionStore(rdb, cfg.SessionTTL)
sec := NewSecurityLog(store, nil)
auth := NewAuthenticator(store, sessions, rdb, cfg, sec)
svc := Services{Codes: &fakeCodes{}, Lifecycle: &recordingLifecycle{ready: true}, Provision: &recordingProvision{ready: true}}
h, err := NewHandlers(cfg, store, sessions, auth, svc, sec, nil)
if err != nil {
t.Fatal(err)
}
return NewRouter(h, sessions, cfg, sec), secret
}
func cookieByName(resp *http.Response, name string) *http.Cookie {
for _, c := range resp.Cookies() {
if c.Name == name {
return c
}
}
return nil
}
func postLogin(t *testing.T, router http.Handler, form url.Values, cookies ...*http.Cookie) *http.Response {
t.Helper()
req := httptest.NewRequest("POST", "/login", strings.NewReader(form.Encode()))
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
req.RemoteAddr = "127.0.0.1:5000"
for _, c := range cookies {
req.AddCookie(c)
}
rr := httptest.NewRecorder()
router.ServeHTTP(rr, req)
return rr.Result()
}
// 端到端:勾选记住 → 登录成功 → 同时下发会话 cookie 与信任 cookie;
// 随后仅凭信任 cookie + 空 TOTP 再次登录成功(免二次验证)。
func TestLoginHandler_RememberThenSkipTOTP(t *testing.T) {
router, secret := newTrustEnv(t)
code, _ := totp.Code(secret, time.Now().UTC())
resp := postLogin(t, router, url.Values{
"username": {"alice"}, "password": {"s3cret-pass"},
"totp": {code}, "remember": {"1"},
})
if resp.StatusCode != http.StatusFound {
t.Fatalf("remember login: status = %d, want 302", resp.StatusCode)
}
trust := cookieByName(resp, TrustedDeviceCookieName)
if trust == nil || trust.Value == "" {
t.Fatal("remember login should set a non-empty trusted cookie")
}
if trust.MaxAge <= 0 {
t.Errorf("trusted cookie MaxAge = %d, want > 0 (persistent)", trust.MaxAge)
}
sessCookie := cookieByName(resp, SessionCookieName)
if sessCookie == nil || sessCookie.MaxAge <= int((30 * time.Minute).Seconds()) {
t.Error("remember login should set a long-lived (persistent) session cookie")
}
// 第二次:只带信任 cookie,TOTP 留空 → 成功
resp2 := postLogin(t, router, url.Values{
"username": {"alice"}, "password": {"s3cret-pass"}, "totp": {""},
}, &http.Cookie{Name: TrustedDeviceCookieName, Value: trust.Value})
if resp2.StatusCode != http.StatusFound {
t.Fatalf("trusted re-login: status = %d, want 302 (TOTP skipped)", resp2.StatusCode)
}
}
// 无信任 cookie + 空 TOTP → 401(二次验证仍强制)。
func TestLoginHandler_NoTrustEmptyTOTPRejected(t *testing.T) {
router, _ := newTrustEnv(t)
resp := postLogin(t, router, url.Values{
"username": {"alice"}, "password": {"s3cret-pass"}, "totp": {""},
})
if resp.StatusCode != http.StatusUnauthorized {
t.Fatalf("empty TOTP without trust: status = %d, want 401", resp.StatusCode)
}
}
+114
View File
@@ -0,0 +1,114 @@
package admin
import (
"context"
"crypto/rand"
"testing"
"time"
"github.com/wangjia/pangolin/server/internal/totp"
)
// newTrustAuth builds an Authenticator with device-trust ENABLED (30d).
func newTrustAuth(t *testing.T) (*Authenticator, *fakeStore, []byte) {
t.Helper()
rdb, _ := newTestRedis(t)
key := make([]byte, 32)
if _, err := rand.Read(key); err != nil {
t.Fatal(err)
}
store := newFakeStore()
cfg := &Config{
SecretKey: key, LoginFailMax: 3, LoginLockDuration: time.Minute,
SessionTTL: 30 * time.Minute, TrustedDeviceTTL: 30 * 24 * time.Hour,
}
sessions := NewSessionStore(rdb, cfg.SessionTTL)
sec := NewSecurityLog(store, nil)
return NewAuthenticator(store, sessions, rdb, cfg, sec), store, key
}
// 勾选「记住此设备」成功登录 → 返回可用于下次跳过 TOTP 的信任令牌。
func TestLoginDevice_RememberIssuesTrust(t *testing.T) {
auth, store, key := newTrustAuth(t)
secret := newTestAdmin(t, store, key, "alice", "s3cret-pass")
code, _ := totp.Code(secret, time.Now().UTC())
ctx := context.Background()
res, err := auth.LoginDevice(ctx, "alice", "s3cret-pass", code, "127.0.0.1", "", true)
if err != nil {
t.Fatalf("login: %v", err)
}
if res.NewTrustToken == "" {
t.Fatal("remember=true should issue a trust token")
}
if !res.Persistent {
t.Error("remember=true should mark session persistent")
}
// 下次:带该令牌 + 空 TOTP 也能登录(跳过二次验证)
res2, err := auth.LoginDevice(ctx, "alice", "s3cret-pass", "", "127.0.0.1", res.NewTrustToken, false)
if err != nil {
t.Fatalf("trusted re-login should skip TOTP: %v", err)
}
if res2.SID == "" {
t.Fatal("no session on trusted re-login")
}
}
// 不勾选:不签发令牌,且 TOTP 仍必填。
func TestLoginDevice_NoRememberRequiresTOTP(t *testing.T) {
auth, store, key := newTrustAuth(t)
secret := newTestAdmin(t, store, key, "alice", "s3cret-pass")
code, _ := totp.Code(secret, time.Now().UTC())
ctx := context.Background()
res, err := auth.LoginDevice(ctx, "alice", "s3cret-pass", code, "127.0.0.1", "", false)
if err != nil {
t.Fatalf("login: %v", err)
}
if res.NewTrustToken != "" {
t.Error("remember=false must not issue a trust token")
}
// 无令牌 + 空 TOTP → 拒
if _, err := auth.LoginDevice(ctx, "alice", "s3cret-pass", "", "127.0.0.1", "", false); err != ErrInvalidCredentials {
t.Errorf("untrusted device with empty TOTP should fail, got %v", err)
}
}
// 铁律:即便持有效信任令牌,密码错误一律拒(只跳过 TOTP,不跳过密码)。
func TestLoginDevice_TrustNeverSkipsPassword(t *testing.T) {
auth, store, key := newTrustAuth(t)
secret := newTestAdmin(t, store, key, "alice", "s3cret-pass")
code, _ := totp.Code(secret, time.Now().UTC())
ctx := context.Background()
res, _ := auth.LoginDevice(ctx, "alice", "s3cret-pass", code, "127.0.0.1", "", true)
if res.NewTrustToken == "" {
t.Fatal("precondition: expected trust token")
}
if _, err := auth.LoginDevice(ctx, "alice", "WRONG", "", "127.0.0.1", res.NewTrustToken, false); err != ErrInvalidCredentials {
t.Errorf("trusted device must still require correct password, got %v", err)
}
}
// 信任令牌绑定 admin:换个用户名不认(令牌属 alice,拿去登 bob 无效)。
func TestLoginDevice_TrustBoundToAdmin(t *testing.T) {
auth, store, key := newTrustAuth(t)
sa := newTestAdmin(t, store, key, "alice", "alice-pass")
_ = sa
// bob:另一个 admin,不同 ID
hash, _ := HashPassword("bob-pass")
bsecret, _ := totp.GenerateSecret()
benc, _ := EncryptSecret(key, bsecret)
store.admins["bob"] = &Admin{ID: 2, Username: "bob", PwHash: hash, TOTPSecretEnc: benc, Status: "active"}
ctx := context.Background()
acode, _ := totp.Code(sa, time.Now().UTC())
ares, _ := auth.LoginDevice(ctx, "alice", "alice-pass", acode, "127.0.0.1", "", true)
if ares.NewTrustToken == "" {
t.Fatal("precondition: alice trust token")
}
// 用 alice 的令牌 + 空 TOTP 登 bob → 应要求 TOTP(令牌对 bob 无效)
if _, err := auth.LoginDevice(ctx, "bob", "bob-pass", "", "127.0.0.1", ares.NewTrustToken, false); err != ErrInvalidCredentials {
t.Errorf("alice's trust token must not skip TOTP for bob, got %v", err)
}
}
+26
View File
@@ -3,6 +3,7 @@ package admin
import (
"net"
"net/http"
"strings"
)
// IPAllow is middleware that rejects any request whose source IP is not within
@@ -58,3 +59,28 @@ func hostOnly(remoteAddr string) string {
}
return host
}
// realIP returns the client IP for **audit logging** (admin_login_ok 等)。
//
// 与上面 IPAllow 的取址原则刻意不同:白名单闸继续只看 TCP 对端(不可伪造);
// 而审计日志要的是"人从哪来"——经本机反代(caddy mTLS 网关在同机回环上反代
// 127.0.0.1:9444)时 RemoteAddr 恒为 loopback,没有溯源价值。仅当 TCP 对端是
// loopback(即请求确实来自本机可信反代)才信 X-Forwarded-For,且取**最后一跳**
// (Caddy 把真实 TCP 对端追加在末位;更早的段可被客户端伪造预置,不可信)。
func realIP(r *http.Request) string {
peer := hostOnly(r.RemoteAddr)
ip := net.ParseIP(peer)
if ip == nil || !ip.IsLoopback() {
return peer
}
xff := r.Header.Get("X-Forwarded-For")
if xff == "" {
return peer
}
parts := strings.Split(xff, ",")
last := strings.TrimSpace(parts[len(parts)-1])
if net.ParseIP(last) == nil {
return peer
}
return last
}
+37
View File
@@ -0,0 +1,37 @@
package admin
import (
"net/http/httptest"
"testing"
)
// realIP:仅当 TCP 对端为 loopback(本机可信反代,如 caddy mTLS 网关)时才信
// X-Forwarded-For 的最后一跳;其余情况一律用 TCP 对端,防止伪造头污染审计。
func TestRealIP(t *testing.T) {
cases := []struct {
name string
remoteAddr string
xff string
want string
}{
{"直连无代理", "203.0.113.7:52011", "", "203.0.113.7"},
{"直连时伪造 XFF 不可信", "203.0.113.7:52011", "1.2.3.4", "203.0.113.7"},
{"经本机反代取 XFF 最后一跳", "127.0.0.1:38200", "198.51.100.23", "198.51.100.23"},
{"多跳取最后一跳(前段可伪造)", "127.0.0.1:38200", "6.6.6.6, 198.51.100.23", "198.51.100.23"},
{"本机反代但无 XFF 回退 loopback", "127.0.0.1:38200", "", "127.0.0.1"},
{"XFF 非法值回退", "127.0.0.1:38200", "not-an-ip", "127.0.0.1"},
{"IPv6 loopback 反代", "[::1]:38200", "198.51.100.23", "198.51.100.23"},
}
for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
r := httptest.NewRequest("POST", "/login", nil)
r.RemoteAddr = c.remoteAddr
if c.xff != "" {
r.Header.Set("X-Forwarded-For", c.xff)
}
if got := realIP(r); got != c.want {
t.Errorf("realIP(remote=%s, xff=%q) = %q, want %q", c.remoteAddr, c.xff, got, c.want)
}
})
}
}
+26 -5
View File
@@ -25,6 +25,9 @@ type Session struct {
Username string `json:"username"`
CSRFToken string `json:"csrf"`
CreatedAt time.Time `json:"created_at"`
// TTLSeconds, when > 0, overrides the store's default sliding idle TTL for
// this session (used by "记住此设备" persistent sessions). 0 = use default.
TTLSeconds int64 `json:"ttl_seconds,omitempty"`
}
// SessionStore persists admin sessions in Redis with a sliding idle TTL.
@@ -41,9 +44,15 @@ func NewSessionStore(rdb *redis.Client, ttl time.Duration) *SessionStore {
return &SessionStore{rdb: rdb, ttl: ttl}
}
// Create starts a new session for the given admin and returns the opaque
// session id (to be set as the cookie value).
// Create starts a new session with the store's default sliding idle TTL.
func (s *SessionStore) Create(ctx context.Context, adminID int64, username string) (string, *Session, error) {
return s.CreateWithTTL(ctx, adminID, username, 0)
}
// CreateWithTTL starts a new session. When ttl > 0 the session uses that TTL
// (both the initial expiry and the per-request slide) instead of the store
// default — this is how "记住此设备" keeps a device logged in for e.g. 30 days.
func (s *SessionStore) CreateWithTTL(ctx context.Context, adminID int64, username string, ttl time.Duration) (string, *Session, error) {
sid, err := randToken(32)
if err != nil {
return "", nil, err
@@ -58,12 +67,24 @@ func (s *SessionStore) Create(ctx context.Context, adminID int64, username strin
CSRFToken: csrf,
CreatedAt: time.Now().UTC(),
}
if ttl > 0 {
sess.TTLSeconds = int64(ttl / time.Second)
}
if err := s.save(ctx, sid, sess); err != nil {
return "", nil, err
}
return sid, sess, nil
}
// slideTTL is the TTL to (re)apply to a session: its own override if set,
// otherwise the store default.
func (s *SessionStore) slideTTL(sess *Session) time.Duration {
if sess != nil && sess.TTLSeconds > 0 {
return time.Duration(sess.TTLSeconds) * time.Second
}
return s.ttl
}
// Get loads a session and slides its TTL forward. Returns (nil, nil) when the
// session is absent or expired.
func (s *SessionStore) Get(ctx context.Context, sid string) (*Session, error) {
@@ -81,8 +102,8 @@ func (s *SessionStore) Get(ctx context.Context, sid string) (*Session, error) {
if err := json.Unmarshal(val, &sess); err != nil {
return nil, fmt.Errorf("admin.SessionStore.Get unmarshal: %w", err)
}
// Slide the idle timeout.
if err := s.rdb.Expire(ctx, sessionKeyPrefix+sid, s.ttl).Err(); err != nil {
// Slide the idle timeout (persistent sessions slide by their own TTL).
if err := s.rdb.Expire(ctx, sessionKeyPrefix+sid, s.slideTTL(&sess)).Err(); err != nil {
return nil, fmt.Errorf("admin.SessionStore.Get expire: %w", err)
}
return &sess, nil
@@ -101,7 +122,7 @@ func (s *SessionStore) save(ctx context.Context, sid string, sess *Session) erro
if err != nil {
return fmt.Errorf("admin.SessionStore.save: %w", err)
}
if err := s.rdb.Set(ctx, sessionKeyPrefix+sid, b, s.ttl).Err(); err != nil {
if err := s.rdb.Set(ctx, sessionKeyPrefix+sid, b, s.slideTTL(sess)).Err(); err != nil {
return fmt.Errorf("admin.SessionStore.save set: %w", err)
}
return nil
+3 -2
View File
@@ -12,9 +12,10 @@
{{if .Flash}}<div class="error">{{.Flash}}</div>{{end}}
<label>用户名<input type="text" name="username" autocomplete="username" required autofocus></label>
<label>密码<input type="password" name="password" autocomplete="current-password" required></label>
<label>动态验证码 (TOTP)<input type="text" name="totp" inputmode="numeric" autocomplete="one-time-code" pattern="[0-9]*" maxlength="6" required></label>
<label>动态验证码 (TOTP)<input type="text" name="totp" inputmode="numeric" autocomplete="one-time-code" pattern="[0-9]*" maxlength="6"></label>
<label class="checkbox"><input type="checkbox" name="remember" value="1"> 记住此设备(30 天内免动态码、保持登录)</label>
<button type="submit">登录</button>
<p class="hint">仅限内网 / SSH 隧道访问</p>
<p class="hint">仅限白名单设备(客户端证书)访问。已记住的设备可留空动态码</p>
</form>
</body>
</html>{{end}}
+74
View File
@@ -0,0 +1,74 @@
package admin
import (
"context"
"strconv"
"time"
"github.com/redis/go-redis/v9"
)
// TrustedDeviceCookieName is the cookie holding a device-trust token.
const TrustedDeviceCookieName = "admin_trusted"
// trustedKeyPrefix namespaces device-trust tokens in Redis.
const trustedKeyPrefix = "admin:trusted:"
// TrustedStore records "记住此设备" device-trust tokens in Redis.
//
// A trusted token lets a device SKIP THE TOTP SECOND FACTOR on re-login
// (password is still always required). Each token is opaque (32 bytes of
// entropy), bound to one admin id, and expires after ttl — so a flushed
// Redis, an expired token, or a mismatched admin all fail closed to
// "TOTP required".
type TrustedStore struct {
rdb *redis.Client
ttl time.Duration
}
// NewTrustedStore wires a TrustedStore. A ttl <= 0 disables the feature:
// Issue returns an empty token and Check always returns false.
func NewTrustedStore(rdb *redis.Client, ttl time.Duration) *TrustedStore {
return &TrustedStore{rdb: rdb, ttl: ttl}
}
// Enabled reports whether device-trust is active.
func (s *TrustedStore) Enabled() bool { return s != nil && s.rdb != nil && s.ttl > 0 }
// Issue mints a new trust token bound to adminID and stores it with the TTL.
// Returns "" (no error) when the feature is disabled.
func (s *TrustedStore) Issue(ctx context.Context, adminID int64) (string, error) {
if !s.Enabled() {
return "", nil
}
tok, err := randToken(32)
if err != nil {
return "", err
}
if err := s.rdb.Set(ctx, trustedKeyPrefix+tok, strconv.FormatInt(adminID, 10), s.ttl).Err(); err != nil {
return "", err
}
return tok, nil
}
// Check reports whether tok is a live trust token bound to adminID.
// Any miss (disabled, empty, unknown, expired, wrong admin) returns false.
func (s *TrustedStore) Check(ctx context.Context, tok string, adminID int64) bool {
if !s.Enabled() || tok == "" {
return false
}
v, err := s.rdb.Get(ctx, trustedKeyPrefix+tok).Result()
if err != nil {
return false
}
return v == strconv.FormatInt(adminID, 10)
}
// Revoke deletes a trust token (e.g. on explicit logout-all). A no-op when
// disabled or empty.
func (s *TrustedStore) Revoke(ctx context.Context, tok string) error {
if !s.Enabled() || tok == "" {
return nil
}
return s.rdb.Del(ctx, trustedKeyPrefix+tok).Err()
}
+108
View File
@@ -0,0 +1,108 @@
package admin
import (
"context"
"testing"
"time"
"github.com/alicebob/miniredis/v2"
"github.com/redis/go-redis/v9"
)
func newTestTrustedStore(t *testing.T) (*TrustedStore, *miniredis.Miniredis) {
t.Helper()
mr, err := miniredis.Run()
if err != nil {
t.Fatalf("miniredis: %v", err)
}
t.Cleanup(mr.Close)
rdb := redis.NewClient(&redis.Options{Addr: mr.Addr()})
return NewTrustedStore(rdb, 30*24*time.Hour), mr
}
func TestTrustedStore_IssueThenCheck(t *testing.T) {
ts, _ := newTestTrustedStore(t)
ctx := context.Background()
tok, err := ts.Issue(ctx, 7)
if err != nil {
t.Fatalf("Issue: %v", err)
}
if tok == "" {
t.Fatal("Issue returned empty token")
}
// 正确 admin 命中
if !ts.Check(ctx, tok, 7) {
t.Error("Check should accept the token for the issuing admin")
}
// 令牌绑定 admin:换个 admin id 不认
if ts.Check(ctx, tok, 8) {
t.Error("Check must reject a token bound to a different admin")
}
// 未知令牌不认
if ts.Check(ctx, "bogus-token", 7) {
t.Error("Check must reject an unknown token")
}
// 空令牌不认
if ts.Check(ctx, "", 7) {
t.Error("Check must reject an empty token")
}
}
func TestTrustedStore_Revoke(t *testing.T) {
ts, _ := newTestTrustedStore(t)
ctx := context.Background()
tok, _ := ts.Issue(ctx, 7)
if !ts.Check(ctx, tok, 7) {
t.Fatal("precondition: token should be valid")
}
if err := ts.Revoke(ctx, tok); err != nil {
t.Fatalf("Revoke: %v", err)
}
if ts.Check(ctx, tok, 7) {
t.Error("Check must reject a revoked token")
}
}
func TestTrustedStore_Expires(t *testing.T) {
mr, err := miniredis.Run()
if err != nil {
t.Fatalf("miniredis: %v", err)
}
defer mr.Close()
rdb := redis.NewClient(&redis.Options{Addr: mr.Addr()})
ts := NewTrustedStore(rdb, time.Hour)
ctx := context.Background()
tok, _ := ts.Issue(ctx, 7)
if !ts.Check(ctx, tok, 7) {
t.Fatal("precondition: token valid before expiry")
}
mr.FastForward(2 * time.Hour) // 超过 TTL
if ts.Check(ctx, tok, 7) {
t.Error("Check must reject an expired token (fail-closed)")
}
}
// TTL<=0 视为功能关闭:Issue 返回空、Check 恒 false。
func TestTrustedStore_Disabled(t *testing.T) {
mr, err := miniredis.Run()
if err != nil {
t.Fatalf("miniredis: %v", err)
}
defer mr.Close()
rdb := redis.NewClient(&redis.Options{Addr: mr.Addr()})
ts := NewTrustedStore(rdb, 0)
ctx := context.Background()
tok, err := ts.Issue(ctx, 7)
if err != nil {
t.Fatalf("Issue: %v", err)
}
if tok != "" {
t.Error("disabled store should issue empty token")
}
if ts.Check(ctx, "anything", 7) {
t.Error("disabled store should never trust")
}
}
+222
View File
@@ -0,0 +1,222 @@
package agentd
import (
"encoding/json"
"fmt"
"net/netip"
"os"
"strings"
)
// ACLTarget 描述一组「私有目的地」的匹配条件。字段名与取值直接对应 sing-box
// route rule 的同名字段:同一项内多字段是 AND,字段内多值是 OR。刻意不做自研 DSL
// —— 形状即 sing-box 语义,少一层翻译就少一类 bug。
//
// 典型两类:
// - 与公开站共用 443 的私有 vhost(brain/git) → 用 domain,依赖 sniff 取 SNI
// - 独占端口的服务(DSM 5001 / RDP 3389 / SSH 10022-10023) → 用 ip_cidr + port
type ACLTarget struct {
Domain []string `json:"domain,omitempty"`
DomainSuffix []string `json:"domain_suffix,omitempty"`
IPCIDR []string `json:"ip_cidr,omitempty"`
Port []int `json:"port,omitempty"`
}
// ACLConfig 是节点本地的私有目的地访问控制表(默认 <StateDir>/acl.json)。
// 只有 AllowDpUUIDs 里的凭证能访问 Targets 描述的目的地,其余一律 reject。
//
// 与 WarpConfig 的关键区别是失效方向:WARP 读不出来就不分流(fail-open)是安全的,
// ACL 读不出来就不拦截等于把私有服务对全体用户敞开。故本类型的 active() 语义为
// fail-closed —— 空白名单意味着「没有人」,不是「所有人」。
type ACLConfig struct {
Enabled bool `json:"enabled"`
AllowDpUUIDs []string `json:"allow_dp_uuids"`
Targets []ACLTarget `json:"targets"`
}
// LoadACLConfig 读取并解析 acl.json。文件不存在 → (nil, nil)(未配置该功能,
// 不是错误)。解析失败返回 error,由调用方决定回退到 last-good 还是告警。
func LoadACLConfig(path string) (*ACLConfig, error) {
data, err := os.ReadFile(path)
if os.IsNotExist(err) {
return nil, nil
}
if err != nil {
return nil, fmt.Errorf("agentd: read acl config %q: %w", path, err)
}
var ac ACLConfig
if err := json.Unmarshal(data, &ac); err != nil {
return nil, fmt.Errorf("agentd: parse acl config %q: %w", path, err)
}
if err := ac.validate(); err != nil {
return nil, fmt.Errorf("agentd: acl config %q: %w", path, err)
}
return &ac, nil
}
// validate 校验每个 target 的 ip_cidr/port 取值本身是否合法(与 cleanTargets 只做
// trim/lower、完全不校验取值的定位不同)。一个语法正确但语义非法的值(如
// port:70000、ip_cidr:"not-a-cidr")会被 encoding/json 顺利接受,一路渲染进
// sing-box 配置——sing-box 自己在 reload/restart 时会拒绝它并保留旧实例,但那时
// agent 早已把这份坏配置当"渲染成功"写盘,运维靠 journalctl/看 config.json 内容
// 完全看不出线上 gate 其实没生效。故必须在加载阶段就把这类值当加载失败处理,
// 使其走 fail-closed 的 last-good 回退路径,而不是让它成为渲染产物。
func (ac *ACLConfig) validate() error {
for i, t := range ac.Targets {
for _, c := range t.IPCIDR {
c = strings.TrimSpace(c)
if c == "" {
continue
}
if _, err := netip.ParsePrefix(c); err != nil {
return fmt.Errorf("target[%d] invalid ip_cidr %q: %w", i, c, err)
}
}
for _, p := range t.Port {
if p < 1 || p > 65535 {
return fmt.Errorf("target[%d] invalid port %d (must be 1-65535)", i, p)
}
}
}
return nil
}
// empty 报告该 target 是否没有任何匹配条件(没有条件的规则会匹配一切,危险)。
func (t ACLTarget) empty() bool {
return len(t.Domain) == 0 && len(t.DomainSuffix) == 0 &&
len(t.IPCIDR) == 0 && len(t.Port) == 0
}
// matchFields 把 target 转成 sing-box route rule 的匹配字段。
// 每次调用返回全新 map —— 放行与拒绝两条规则各自在其上追加 user/outbound/action,
// 共享同一对象会互相污染。
func (t ACLTarget) matchFields() map[string]any {
m := make(map[string]any, 4)
if len(t.Domain) > 0 {
m["domain"] = t.Domain
}
if len(t.DomainSuffix) > 0 {
m["domain_suffix"] = t.DomainSuffix
}
if len(t.IPCIDR) > 0 {
m["ip_cidr"] = t.IPCIDR
}
if len(t.Port) > 0 {
m["port"] = t.Port
}
return m
}
// active 报告本 ACL 是否应真正注入规则。
//
// 注意与 WarpConfig.active() 的语义差别:此处 AllowDpUUIDs 为空**不影响**返回值。
// 空白名单是一个合法且有意义的状态 ——「谁都不许访问这些目的地」。把它当作未启用
// 会造成 fail-open。唯一的关闭途径是显式 "enabled": false。
func (ac *ACLConfig) active() bool {
if ac == nil || !ac.Enabled {
return false
}
return len(ac.cleanTargets()) > 0
}
// cleanUUIDs 去空白/空项后返回白名单。
func (ac *ACLConfig) cleanUUIDs() []string {
if ac == nil {
return nil
}
out := make([]string, 0, len(ac.AllowDpUUIDs))
for _, u := range ac.AllowDpUUIDs {
if u = strings.TrimSpace(u); u != "" {
out = append(out, u)
}
}
return out
}
// cleanTargets 规范化域名(小写去空白)并丢弃无任何条件的 target。
func (ac *ACLConfig) cleanTargets() []ACLTarget {
if ac == nil {
return nil
}
out := make([]ACLTarget, 0, len(ac.Targets))
for _, t := range ac.Targets {
c := ACLTarget{
Domain: cleanHosts(t.Domain),
DomainSuffix: cleanHosts(t.DomainSuffix),
IPCIDR: cleanStrings(t.IPCIDR),
Port: t.Port,
}
if !c.empty() {
out = append(out, c)
}
}
return out
}
func cleanHosts(in []string) []string {
out := make([]string, 0, len(in))
for _, s := range in {
if s = strings.TrimSpace(strings.ToLower(s)); s != "" {
out = append(out, s)
}
}
return out
}
func cleanStrings(in []string) []string {
out := make([]string, 0, len(in))
for _, s := range in {
if s = strings.TrimSpace(s); s != "" {
out = append(out, s)
}
}
return out
}
// rules 产出 ACL 的 sing-box route 规则:每个 target 一对 —— 先放行白名单、再兜底拒绝。
//
// 顺序是安全性的一部分,不可重排:
// 1. 全部放行规则排在全部拒绝规则之前。不能按 target 交错(放行A/拒绝A/放行B/拒绝B),
// 因为 target 之间可能重叠,交错会让 B 的成员被 A 的拒绝规则先命中。
// 2. 拒绝规则不带 user 维度 —— 它要对「白名单之外的所有人」生效。
// 3. 同一 target 的放行与拒绝,目的地条件由同一个 matchFields() 生成,保证逐字相同。
// 任何不对称都会造成「我自己也被拒」或「有人漏网」。
//
// 白名单为空时只产出拒绝规则(谁都不许进),这是 fail-closed 的核心:空名单的语义是
// 「没有人」而非「所有人」。
func (ac *ACLConfig) rules() []any {
if !ac.active() {
return nil
}
uuids := ac.cleanUUIDs()
targets := ac.cleanTargets()
out := make([]any, 0, len(targets)*2)
if len(uuids) > 0 {
for _, t := range targets {
r := t.matchFields()
// auth_user(非 user):sing-box 1.13 的 route rule 里,VLESS/REALITY 入站的
// 认证用户要用 auth_user 匹配 inbound user 的 name;user 字段对 VLESS 运行时
// 不生效(仅 sing-box check 语法通过),会导致放行规则永不命中、白名单用户也
// 被兜底拒绝。已用本地真 VLESS 连接实测确认(good→通, bad→被 block)。
r["auth_user"] = uuids
r["outbound"] = directOutboundTag
out = append(out, r)
}
}
for _, t := range targets {
r := t.matchFields()
r["action"] = "reject"
out = append(out, r)
}
return out
}
// persistACL 把成功加载的 ACL 快照原子写到 path,供 agent 冷启动兜底。
func persistACL(path string, ac *ACLConfig) error {
data, err := json.MarshalIndent(ac, "", " ")
if err != nil {
return fmt.Errorf("agentd: marshal acl snapshot: %w", err)
}
return atomicWrite(path, data, 0o600)
}
+870
View File
@@ -0,0 +1,870 @@
package agentd
import (
"bytes"
"context"
"encoding/json"
"fmt"
"log"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
"time"
agentv1 "github.com/wangjia/pangolin/server/internal/pb/agentv1"
)
// captureLog 把标准库 log 包(logf 的底层输出)重定向到一个 buffer,测试结束
// (t.Cleanup)后自动还原到原输出。agentd 包内没有自己的 logger 抽象——logf 直接
// 调 log.Printf——但标准库 log 本身就是一个可重定向的现成缝隙,不需要为了可测试性
// 另外引入 logger 接口。包内测试从不并发跑(无 t.Parallel),重定向全局 log 输出
// 是安全的。
func captureLog(t *testing.T) *bytes.Buffer {
t.Helper()
var buf bytes.Buffer
orig := log.Writer()
log.SetOutput(&buf)
t.Cleanup(func() { log.SetOutput(orig) })
return &buf
}
// writeACL 把 acl.json 写到指定路径。
func writeACL(t *testing.T, path, body string) {
t.Helper()
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(path, []byte(body), 0o600); err != nil {
t.Fatal(err)
}
}
const validACL = `{
"enabled": true,
"allow_dp_uuids": ["uuid-me-1", "uuid-me-sub"],
"targets": [
{ "domain": ["brain.51yanmei.com", "git.51yanmei.com"] },
{ "ip_cidr": ["182.92.213.171/32"], "port": [5001, 3389, 10022, 10023] }
]
}`
func TestLoadACLConfig(t *testing.T) {
dir := t.TempDir()
t.Run("文件不存在返回 nil,nil(未配置,不是错误)", func(t *testing.T) {
ac, err := LoadACLConfig(filepath.Join(dir, "missing.json"))
if err != nil {
t.Fatalf("want nil error, got %v", err)
}
if ac != nil {
t.Fatalf("want nil config, got %+v", ac)
}
})
t.Run("坏 JSON 返回 error(绝不静默降级)", func(t *testing.T) {
p := filepath.Join(dir, "bad.json")
writeACL(t, p, `{"enabled": true,`)
if _, err := LoadACLConfig(p); err == nil {
t.Fatal("want error for malformed JSON, got nil")
}
})
t.Run("合法配置解析出全部字段", func(t *testing.T) {
p := filepath.Join(dir, "acl.json")
writeACL(t, p, validACL)
ac, err := LoadACLConfig(p)
if err != nil {
t.Fatal(err)
}
if !ac.Enabled {
t.Error("Enabled = false, want true")
}
if len(ac.AllowDpUUIDs) != 2 {
t.Errorf("AllowDpUUIDs len = %d, want 2", len(ac.AllowDpUUIDs))
}
if len(ac.Targets) != 2 {
t.Fatalf("Targets len = %d, want 2", len(ac.Targets))
}
if len(ac.Targets[0].Domain) != 2 {
t.Errorf("Targets[0].Domain len = %d, want 2", len(ac.Targets[0].Domain))
}
if len(ac.Targets[1].Port) != 4 {
t.Errorf("Targets[1].Port len = %d, want 4", len(ac.Targets[1].Port))
}
})
}
// active() 的语义与 WARP 相反:空白名单不等于「关闭」,而等于「谁都不许进」。
func TestACLActive_FailClosed(t *testing.T) {
cases := []struct {
name string
ac *ACLConfig
want bool
}{
{"nil 配置 → 未启用", nil, false},
{"enabled=false → 未启用(唯一的合法关闭途径)", &ACLConfig{
Enabled: false,
AllowDpUUIDs: []string{"u"},
Targets: []ACLTarget{{Domain: []string{"a.com"}}},
}, false},
{"无 target → 未启用(无从拒起)", &ACLConfig{
Enabled: true,
AllowDpUUIDs: []string{"u"},
}, false},
{"target 全为空条件 → 未启用", &ACLConfig{
Enabled: true,
Targets: []ACLTarget{{}},
}, false},
{"白名单为空但有 target → 仍启用(拒绝所有人)", &ACLConfig{
Enabled: true,
AllowDpUUIDs: nil,
Targets: []ACLTarget{{Domain: []string{"a.com"}}},
}, true},
{"完整配置 → 启用", &ACLConfig{
Enabled: true,
AllowDpUUIDs: []string{"u"},
Targets: []ACLTarget{{IPCIDR: []string{"1.2.3.4/32"}, Port: []int{443}}},
}, true},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
if got := tc.ac.active(); got != tc.want {
t.Errorf("active() = %v, want %v", got, tc.want)
}
})
}
}
func TestACLCleanHelpers(t *testing.T) {
ac := &ACLConfig{
Enabled: true,
AllowDpUUIDs: []string{" uuid-a ", "", "uuid-b"},
Targets: []ACLTarget{
{Domain: []string{" BRAIN.51yanmei.com ", ""}},
{},
{IPCIDR: []string{"1.2.3.4/32"}},
},
}
uuids := ac.cleanUUIDs()
if len(uuids) != 2 || uuids[0] != "uuid-a" || uuids[1] != "uuid-b" {
t.Errorf("cleanUUIDs() = %v, want [uuid-a uuid-b]", uuids)
}
targets := ac.cleanTargets()
if len(targets) != 2 {
t.Fatalf("cleanTargets() len = %d, want 2 (空 target 应被丢弃)", len(targets))
}
if targets[0].Domain[0] != "brain.51yanmei.com" {
t.Errorf("域名未规范化为小写去空白: %q", targets[0].Domain[0])
}
}
func TestACLTargetMatchFields(t *testing.T) {
tgt := ACLTarget{
Domain: []string{"a.com"},
IPCIDR: []string{"1.2.3.4/32"},
Port: []int{443, 5001},
}
m := tgt.matchFields()
if _, ok := m["domain"]; !ok {
t.Error("缺 domain 字段")
}
if _, ok := m["ip_cidr"]; !ok {
t.Error("缺 ip_cidr 字段")
}
if _, ok := m["port"]; !ok {
t.Error("缺 port 字段")
}
if _, ok := m["domain_suffix"]; ok {
t.Error("空的 domain_suffix 不应出现在输出里")
}
// matchFields 必须每次返回新 map,否则放行/拒绝两条规则会共享同一对象,
// 给其中一条加 "user"/"action" 会污染另一条。
m2 := tgt.matchFields()
m2["user"] = []string{"x"}
if _, ok := m["user"]; ok {
t.Error("matchFields 返回了共享 map,放行与拒绝规则会互相污染")
}
}
func TestConfigACLPaths(t *testing.T) {
c := Config{StateDir: "/etc/pangolin-agent"}.withDefaults()
if want := "/etc/pangolin-agent/acl.json"; c.ACLConfigPath != want {
t.Errorf("ACLConfigPath = %q, want %q", c.ACLConfigPath, want)
}
if want := "/etc/pangolin-agent/acl.last-good.json"; c.ACLLastGoodPath() != want {
t.Errorf("ACLLastGoodPath() = %q, want %q", c.ACLLastGoodPath(), want)
}
}
// rules() 必须产出「先全部放行、再全部拒绝」,且同一 target 两侧目的地条件逐字相同。
func TestACLRules_AllowThenDeny(t *testing.T) {
ac := &ACLConfig{
Enabled: true,
AllowDpUUIDs: []string{"uuid-me"},
Targets: []ACLTarget{
{Domain: []string{"brain.51yanmei.com"}},
{IPCIDR: []string{"182.92.213.171/32"}, Port: []int{5001}},
},
}
rules := ac.rules()
if len(rules) != 4 {
t.Fatalf("规则数 = %d, want 4 (2 target × 放行+拒绝)", len(rules))
}
// 前两条是放行:带 auth_user + outbound,不带 action
// (auth_user 而非 user:VLESS 入站运行时只认 auth_user,见 acl.go rules() 注释)
for i := 0; i < 2; i++ {
r := rules[i].(map[string]any)
if _, ok := r["auth_user"]; !ok {
t.Errorf("rules[%d] 放行规则缺 auth_user", i)
}
if _, ok := r["user"]; ok {
t.Errorf("rules[%d] 放行规则不应带 user(VLESS 不生效),应用 auth_user", i)
}
if r["outbound"] != directOutboundTag {
t.Errorf("rules[%d] outbound = %v, want %q", i, r["outbound"], directOutboundTag)
}
if _, ok := r["action"]; ok {
t.Errorf("rules[%d] 放行规则不应带 action", i)
}
}
// 后两条是拒绝:带 action=reject,不带 auth_user(对所有人生效)
for i := 2; i < 4; i++ {
r := rules[i].(map[string]any)
if r["action"] != "reject" {
t.Errorf("rules[%d] action = %v, want reject", i, r["action"])
}
if _, ok := r["auth_user"]; ok {
t.Errorf("rules[%d] 拒绝规则不应带 auth_user,否则会漏掉名单外的人", i)
}
}
// 对称性:target[0] 的放行(rules[0])与拒绝(rules[2])目的地条件必须逐字相同
allow0 := rules[0].(map[string]any)
deny0 := rules[2].(map[string]any)
if fmt.Sprint(allow0["domain"]) != fmt.Sprint(deny0["domain"]) {
t.Errorf("target0 放行/拒绝的 domain 不一致: %v vs %v", allow0["domain"], deny0["domain"])
}
allow1 := rules[1].(map[string]any)
deny1 := rules[3].(map[string]any)
if fmt.Sprint(allow1["ip_cidr"]) != fmt.Sprint(deny1["ip_cidr"]) ||
fmt.Sprint(allow1["port"]) != fmt.Sprint(deny1["port"]) {
t.Error("target1 放行/拒绝的 ip_cidr/port 不一致")
}
}
// 空白名单 → 不产出放行规则,但拒绝规则照出(fail-closed 的核心断言)。
func TestACLRules_EmptyAllowlistStillDenies(t *testing.T) {
ac := &ACLConfig{
Enabled: true,
AllowDpUUIDs: nil,
Targets: []ACLTarget{{Domain: []string{"brain.51yanmei.com"}}},
}
rules := ac.rules()
if len(rules) != 1 {
t.Fatalf("规则数 = %d, want 1 (仅拒绝)", len(rules))
}
r := rules[0].(map[string]any)
if r["action"] != "reject" {
t.Errorf("action = %v, want reject", r["action"])
}
}
// 未 active(含 nil / enabled=false)→ 无规则。
func TestACLRules_InactiveYieldsNil(t *testing.T) {
var nilACL *ACLConfig
if got := nilACL.rules(); got != nil {
t.Errorf("nil ACL rules() = %v, want nil", got)
}
off := &ACLConfig{Enabled: false, Targets: []ACLTarget{{Domain: []string{"a.com"}}}}
if got := off.rules(); got != nil {
t.Errorf("enabled=false rules() = %v, want nil", got)
}
}
// buildRoute 四态矩阵:ACL×WARP 开关的四种组合。
func TestBuildRoute_Matrix(t *testing.T) {
acl := &ACLConfig{
Enabled: true,
AllowDpUUIDs: []string{"uuid-me"},
Targets: []ACLTarget{{Domain: []string{"brain.51yanmei.com"}}},
}
warp := &WarpConfig{
Enabled: true, PrivateKey: "k", PeerPublicKey: "pk",
Endpoint: "162.159.192.1:2408", Address: []string{"172.16.0.2/32"},
Domains: []string{"reddit.com"},
}
t.Run("都关 → 不产出 route(向后兼容)", func(t *testing.T) {
if got := buildRoute(nil, nil); got != nil {
t.Errorf("buildRoute(nil,nil) = %v, want nil", got)
}
})
t.Run("仅 WARP → sniff + resolve + warp 规则", func(t *testing.T) {
r := buildRoute(nil, warp)
rules := r["rules"].([]any)
if len(rules) != 3 {
t.Fatalf("规则数 = %d, want 3", len(rules))
}
if rules[0].(map[string]any)["action"] != "sniff" {
t.Error("首条不是 sniff")
}
if rules[1].(map[string]any)["action"] != "resolve" {
t.Error("第二条不是 resolve(域名形式的目的地需要先解析才能命中后续 ip_cidr 规则)")
}
if rules[2].(map[string]any)["outbound"] != warpOutboundTag {
t.Error("第三条不是 warp 分流")
}
if r["final"] != directOutboundTag {
t.Errorf("final = %v, want %q", r["final"], directOutboundTag)
}
})
t.Run("仅 ACL → sniff + resolve + 放行 + 拒绝", func(t *testing.T) {
r := buildRoute(acl, nil)
rules := r["rules"].([]any)
if len(rules) != 4 {
t.Fatalf("规则数 = %d, want 4", len(rules))
}
if rules[0].(map[string]any)["action"] != "sniff" {
t.Error("首条不是 sniff")
}
if rules[1].(map[string]any)["action"] != "resolve" {
t.Error("第二条不是 resolve")
}
if _, ok := rules[2].(map[string]any)["auth_user"]; !ok {
t.Error("第三条不是放行规则")
}
if rules[3].(map[string]any)["action"] != "reject" {
t.Error("第四条不是拒绝规则")
}
})
t.Run("都开 → sniff + resolve + ACL(放行,拒绝) + warp,且 sniff/resolve 各只出现一次", func(t *testing.T) {
r := buildRoute(acl, warp)
rules := r["rules"].([]any)
if len(rules) != 5 {
t.Fatalf("规则数 = %d, want 5", len(rules))
}
sniffs, resolves := 0, 0
for _, x := range rules {
switch x.(map[string]any)["action"] {
case "sniff":
sniffs++
case "resolve":
resolves++
}
}
if sniffs != 1 {
t.Errorf("sniff 出现 %d 次, want 1", sniffs)
}
if resolves != 1 {
t.Errorf("resolve 出现 %d 次, want 1", resolves)
}
if rules[0].(map[string]any)["action"] != "sniff" {
t.Error("sniff 必须最先")
}
if rules[1].(map[string]any)["action"] != "resolve" {
t.Error("resolve 必须紧跟 sniff 之后")
}
// ACL 全部规则必须排在 warp 之前:被拒绝的目的地不该有机会走 warp 出口
if rules[4].(map[string]any)["outbound"] != warpOutboundTag {
t.Error("warp 规则必须排在最后")
}
if rules[3].(map[string]any)["action"] != "reject" {
t.Error("ACL 拒绝规则必须排在 warp 之前")
}
})
}
// I3:ip_cidr 目的地能被"域名形式"的请求绕过——ip_cidr 匹配的是已解析的目的地
// 地址,客户端若发送域名形式(如 nas.51yanmei.com:5001)而不先解析,ip_cidr 规则
// 不命中,请求穿透到 final:direct。route 块加 {"action":"resolve"} 让节点自己
// 解析目的地,使域名形式收敛到 ip_cidr 规则上。resolve 必须紧跟 sniff 之后、且
// 只在产出 route 块时才出现(与 sniff 同条件)。
func TestBuildRoute_ResolvePositionedRightAfterSniff(t *testing.T) {
acl := &ACLConfig{
Enabled: true,
AllowDpUUIDs: []string{"uuid-me"},
Targets: []ACLTarget{{IPCIDR: []string{"182.92.213.171/32"}, Port: []int{5001}}},
}
r := buildRoute(acl, nil)
rules := r["rules"].([]any)
if len(rules) < 2 {
t.Fatalf("规则数 = %d, 至少要有 sniff+resolve", len(rules))
}
if rules[0].(map[string]any)["action"] != "sniff" {
t.Fatal("sniff 必须最先")
}
if rules[1].(map[string]any)["action"] != "resolve" {
t.Fatal("resolve 必须紧跟 sniff 之后")
}
}
// 未配置 ACL 也未启用 WARP → 仍不产出 route 块(resolve 不该单独出现)。
func TestBuildRoute_NeverConfigured_NoResolve(t *testing.T) {
if got := buildRoute(nil, nil); got != nil {
t.Errorf("buildRoute(nil,nil) = %v, want nil", got)
}
}
// 成功加载后必须把快照落盘,否则 agent 一重启 fail-closed 就失效。
func TestACL_PersistsLastGoodOnLoad(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb.RenderConfig(); err != nil {
t.Fatal(err)
}
if _, err := os.Stat(cfg.ACLLastGoodPath()); err != nil {
t.Fatalf("last-good 未落盘: %v", err)
}
}
// acl.json 被改坏 → 规则不能消失(内存 last-good 兜底)。
func TestACL_BrokenFileKeepsInMemoryLastGood(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb.RenderConfig(); err != nil {
t.Fatal(err)
}
writeACL(t, cfg.ACLConfigPath, `{"enabled": true,`) // 手抖写坏
data, err := sb.RenderConfig()
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "reject") {
t.Fatal("acl.json 坏掉后拒绝规则消失了 —— 这是 fail-open,私有服务已敞开")
}
}
// 新 agent 实例(模拟进程重启)+ 坏 acl.json → 磁盘 last-good 兜底,规则仍在。
func TestACL_ColdStartFallsBackToDiskLastGood(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb1 := NewSingBox(cfg, nil)
sb1.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb1.RenderConfig(); err != nil {
t.Fatal(err)
}
writeACL(t, cfg.ACLConfigPath, `not json at all`)
sb2 := NewSingBox(cfg, nil) // 全新实例,内存 last-good 为空
sb2.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
data, err := sb2.RenderConfig()
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "reject") {
t.Fatal("冷启动未回退到磁盘 last-good,私有服务已敞开")
}
}
// 从未配置过(无 acl.json 也无 last-good)→ 不产出 route,且不误报。
func TestACL_NeverConfiguredYieldsNoRoute(t *testing.T) {
cfg := testConfig(t)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
data, err := sb.RenderConfig()
if err != nil {
t.Fatal(err)
}
var m map[string]any
if err := json.Unmarshal(data, &m); err != nil {
t.Fatal(err)
}
if _, ok := m["route"]; ok {
t.Error("未配置 ACL 也未启用 WARP,不应产出 route 块")
}
}
// acl.json 被删除 → 规则不能消失(内存 last-good 兜底)。
func TestACL_DeletedFileKeepsInMemoryLastGood(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb.RenderConfig(); err != nil {
t.Fatal(err)
}
if err := os.Remove(cfg.ACLConfigPath); err != nil {
t.Fatalf("failed to remove acl.json: %v", err)
}
data, err := sb.RenderConfig()
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "reject") {
t.Fatal("acl.json 被删除后拒绝规则消失了 —— 这是 fail-open,私有服务已敞开")
}
}
// Refresh() 必须能触发一次重渲染(经 debounce 循环),用于「编辑 acl.json 后
// systemctl reload pangolin-agent」而不必重启 agent(重启会冷启 sing-box 踢人)。
func TestSingBoxRefresh_TriggersRender(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
fr := &fakeRestarter{}
sb := NewSingBox(cfg, fr)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
go sb.Run(ctx)
// 等首次渲染落地(ApplyConfig 已 markDirty)
eventually(t, 2*time.Second, func() bool {
_, err := os.Stat(cfg.SingboxConfigPath)
return err == nil
}, "首次渲染写出配置")
// 断言 reloadCount 而非 count:首次渲染已冷启动过(started=true),此后的重渲染
// 一律走 Reload(SIGHUP 热重载),Restart 计数不会再增加。断言错计数器会假失败。
before := fr.reloadCount()
sb.Refresh()
eventually(t, 2*time.Second, func() bool { return fr.reloadCount() > before }, "Refresh 触发了热重载")
}
// 新 agent 实例(模拟进程重启) + 被删的 acl.json → 磁盘 last-good 兜底,规则仍在。
func TestACL_ColdStartAfterDeletedFileFallsBackToDisk(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb1 := NewSingBox(cfg, nil)
sb1.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb1.RenderConfig(); err != nil {
t.Fatal(err)
}
if err := os.Remove(cfg.ACLConfigPath); err != nil {
t.Fatalf("failed to remove acl.json: %v", err)
}
sb2 := NewSingBox(cfg, nil) // 全新实例,内存 last-good 为空
sb2.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
data, err := sb2.RenderConfig()
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "reject") {
t.Fatal("冷启动(acl.json 删除)未回退到磁盘 last-good,私有服务已敞开")
}
}
// 样例文件必须始终可被解析且产出预期规则,防止改了 ACLTarget 形状却忘了同步样例。
func TestACLExampleFileStaysValid(t *testing.T) {
path := filepath.Join("..", "..", "..", "deploy", "single-node", "acl.json.example")
ac, err := LoadACLConfig(path)
if err != nil {
t.Fatalf("样例文件解析失败 %s: %v", path, err)
}
if ac == nil {
t.Fatalf("样例文件不存在: %s", path)
}
if !ac.active() {
t.Error("样例文件应当是一份 active 的 ACL")
}
if len(ac.Targets) != 2 {
t.Errorf("样例 targets = %d, want 2", len(ac.Targets))
}
// 样例里的 uuid 是占位符,不该是真实 uuid(真实 uuid 属标识信息,不入 git)
for _, u := range ac.AllowDpUUIDs {
if !strings.HasPrefix(u, "TODO-") {
t.Errorf("样例文件混入了非占位 uuid %q —— 真实 dp_uuid 不得入 git", u)
}
}
}
// ─── C2: 手抖字段名(如 targets → targetz)不得静默关闸,也不得覆盖 last-good ──────
// 字段名手抖(targetz)→ encoding/json 忽略未知字段,Targets 变 nil,active()=false。
// 若不做特殊处理,旧代码会把这份"看似合法"的空配置当成新的 last-good 落盘,
// 把恢复用的快照也一起冲掉。正确行为:当作加载失败处理,回退 last-good,不覆盖磁盘。
func TestACL_TypoFieldWithEnabledTrue_FallsBackWithoutOverwritingLastGood(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb.RenderConfig(); err != nil {
t.Fatal(err)
}
before, err := os.ReadFile(cfg.ACLLastGoodPath())
if err != nil {
t.Fatalf("last-good 未在健康加载后落盘: %v", err)
}
// "targets" 手抖成 "targetz":JSON 仍能解析,但 Targets 字段收不到值。
writeACL(t, cfg.ACLConfigPath, `{"enabled":true,"allow_dp_uuids":["x"],"targetz":[{"domain":["a.com"]}]}`)
data, err := sb.RenderConfig()
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "reject") {
t.Fatal("字段名手抖(targetz)后拒绝规则消失了 —— 这是静默关闸,私有服务已敞开")
}
after, err := os.ReadFile(cfg.ACLLastGoodPath())
if err != nil {
t.Fatal(err)
}
if !bytes.Equal(before, after) {
t.Fatal("手抖配置覆盖了 acl.last-good.json —— 恢复用的快照被销毁了")
}
}
// 显式 enabled:false 是唯一合法的关闭方式,渲染结果必须真的没有 reject 规则;
// 但它不该覆盖磁盘上已有的 last-good 快照——否则日后 acl.json 意外损坏/丢失时,
// 回退到的将是这份"已关闭"的快照而不是最近一次真正 active 的配置。
func TestACL_ExplicitDisableDoesNotOverwriteLastGood(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb.RenderConfig(); err != nil {
t.Fatal(err)
}
before, err := os.ReadFile(cfg.ACLLastGoodPath())
if err != nil {
t.Fatalf("last-good 未在健康加载后落盘: %v", err)
}
writeACL(t, cfg.ACLConfigPath, `{"enabled": false, "allow_dp_uuids": ["x"], "targets": [{"domain":["a.com"]}]}`)
data, err := sb.RenderConfig()
if err != nil {
t.Fatal(err)
}
if strings.Contains(string(data), "reject") {
t.Fatal("enabled=false 应真正关闭 ACL,不应再产出 reject 规则")
}
after, err := os.ReadFile(cfg.ACLLastGoodPath())
if err != nil {
t.Fatal(err)
}
if !bytes.Equal(before, after) {
t.Fatal("显式 enabled=false 不该覆盖 last-good 快照,否则日后 acl.json 损坏就回不到真正 active 的配置了")
}
}
// 白名单为空但 target 有效 → 是合法的"拒绝所有人"配置,不是手抖,必须仍被当作
// last-good 持久化,且仍产出拒绝规则。防止 C2 修复对"零 target"的特判过度矫正到
// "零白名单"上。
func TestACL_EnabledWithEmptyAllowlistStillPersistsAndDenies(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, `{"enabled": true, "allow_dp_uuids": [], "targets": [{"domain": ["brain.51yanmei.com"]}]}`)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
data, err := sb.RenderConfig()
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "reject") {
t.Fatal("空白名单+有效 target 应仍产出拒绝规则(拒所有人),不该被当成手抖")
}
if _, err := os.Stat(cfg.ACLLastGoodPath()); err != nil {
t.Fatalf("空白名单(但有效 target)的配置应被当作合法 active 配置持久化为 last-good: %v", err)
}
}
// ─── I2: last-good 双失败必须大声告警,读盘错误不能被吞掉 ─────────────────────
// acl.json 缺失 + 磁盘 last-good 损坏(存在但解析不了,模拟卷挂载异常/写坏)→
// 两级兜底都失败,gate 实质消失,必须在 loadACL 的终点打 ALERT——这正是设计 §5
// "两者都失败才不产出 ACL 规则,同时打 ERROR 并告警" 要求的那一档。
//
// 注:没有采用"把两个文件都整个删掉"来复现,因为那种状态在文件系统层面与
// "这台节点从没配置过 ACL"完全无法区分(两次 os.Stat 都是 not-exist),任何仅凭
// 现有文件状态判断的实现都做不出区分;若真要区分,需要额外的持久化标记,超出本
// finding 的范围。"last-good 文件存在但损坏"则是一个可观察、可被 os.Stat 命中
// 的信号,且更贴近 §5 描述的真实故障("last-good 损坏"),故以此复现。
func TestACL_BothLastGoodFailuresAlert(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb1 := NewSingBox(cfg, nil)
sb1.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb1.RenderConfig(); err != nil {
t.Fatal(err) // acl.last-good.json 现已落盘
}
if err := os.Remove(cfg.ACLConfigPath); err != nil {
t.Fatalf("failed to remove acl.json: %v", err)
}
writeACL(t, cfg.ACLLastGoodPath(), `{"enabled": true,`) // 磁盘 last-good 也损坏
buf := captureLog(t)
sb2 := NewSingBox(cfg, nil) // 全新实例,内存 last-good 为空(模拟进程重启)
sb2.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
data, err := sb2.RenderConfig()
if err != nil {
t.Fatal(err)
}
if strings.Contains(string(data), "reject") {
t.Fatal("两级 last-good 都失败,不应该还能产出规则(此断言只是确认前提)")
}
logged := buf.String()
if !strings.Contains(logged, "ALERT") {
t.Fatalf("两级 last-good 都失败(acl.json 缺失 + 磁盘 last-good 损坏)必须打 ALERT,实际日志:\n%s", logged)
}
if !strings.Contains(logged, "ERROR reading last-good") {
t.Fatalf("读磁盘 last-good 失败的 derr 必须落日志,实际日志:\n%s", logged)
}
}
// 从未配置过 ACL(acl.json 和 last-good 都从来没存在过)→ 终点应保持安静,不误报
// ALERT。这条守着"没用这个功能的节点不该被日志刷屏"。
func TestACL_NeverConfiguredNoAlert(t *testing.T) {
cfg := testConfig(t)
buf := captureLog(t)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb.RenderConfig(); err != nil {
t.Fatal(err)
}
if logged := buf.String(); strings.Contains(logged, "ALERT") {
t.Fatalf("从未配置过 ACL 的节点不该收到 ALERT(会造成告警刷屏),实际日志:\n%s", logged)
}
}
// 降级路径(内存/磁盘 last-good 兜底成功)的日志必须带 WARN 级别标签,便于
// journalctl | grep -E 'ERROR|WARN|ALERT' 抓到"已恢复但曾经降级"的状态。
func TestACL_FallbackLogsCarryWarnLevel(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb.RenderConfig(); err != nil {
t.Fatal(err)
}
writeACL(t, cfg.ACLConfigPath, `{"enabled": true,`) // 手抖写坏,触发内存 last-good 兜底
buf := captureLog(t)
if _, err := sb.RenderConfig(); err != nil {
t.Fatal(err)
}
if logged := buf.String(); !strings.Contains(logged, "WARN falling back to in-memory") {
t.Fatalf("内存 last-good 兜底日志缺 WARN 级别标签,实际日志:\n%s", logged)
}
}
// ─── I1: 非法 ip_cidr/port 必须在加载阶段被拒绝,走 fail-closed last-good ──────
// port 超出 1-65535、ip_cidr 不是合法 CIDR,cleanTargets 此前只做 trim/lower,
// 完全不校验取值——这类配置会被当作"合法"渲染进 sing-box 配置,而 sing-box 自己
// 会在运行时(reload/restart)拒绝它、保留旧实例,导致"渲染产物落盘看起来正常,
// 但线上 gate 其实没生效"这种难排查的静默失败。加载阶段直接拒绝,让它走
// last-good 兜底(与解析失败同一条路径),而不是把坏值一路渲染出去。
func TestLoadACLConfig_RejectsInvalidPort(t *testing.T) {
dir := t.TempDir()
p := filepath.Join(dir, "acl.json")
writeACL(t, p, `{
"enabled": true,
"allow_dp_uuids": ["u"],
"targets": [{ "ip_cidr": ["182.92.213.171/32"], "port": [70000] }]
}`)
if _, err := LoadACLConfig(p); err == nil {
t.Fatal("port 70000 超出合法范围(1-65535),LoadACLConfig 应返回 error")
}
}
func TestLoadACLConfig_RejectsInvalidCIDR(t *testing.T) {
dir := t.TempDir()
p := filepath.Join(dir, "acl.json")
writeACL(t, p, `{
"enabled": true,
"allow_dp_uuids": ["u"],
"targets": [{ "ip_cidr": ["not-a-cidr"], "port": [443] }]
}`)
if _, err := LoadACLConfig(p); err == nil {
t.Fatal("ip_cidr \"not-a-cidr\" 不是合法 CIDR,LoadACLConfig 应返回 error")
}
}
// 非法配置在 loadACL 层面必须走 last-good 兜底(与解析失败同一条路径),而不是
// 被渲染进 sing-box 配置。
func TestACL_InvalidPortFallsBackToLastGood(t *testing.T) {
cfg := testConfig(t)
writeACL(t, cfg.ACLConfigPath, validACL)
sb := NewSingBox(cfg, nil)
sb.ApplyConfig(sampleSnapshot(&agentv1.Credential{DpUUID: "aaaa", Protocol: agentv1.ProtocolBoth}), true)
if _, err := sb.RenderConfig(); err != nil {
t.Fatal(err)
}
writeACL(t, cfg.ACLConfigPath, `{
"enabled": true,
"allow_dp_uuids": ["u"],
"targets": [{ "ip_cidr": ["182.92.213.171/32"], "port": [70000] }]
}`)
data, err := sb.RenderConfig()
if err != nil {
t.Fatal(err)
}
if strings.Contains(string(data), "70000") {
t.Fatal("非法 port 70000 不应该被渲染进 sing-box 配置,应走 last-good 兜底")
}
if !strings.Contains(string(data), "reject") {
t.Fatal("非法配置应走 last-good 兜底,拒绝规则不应消失")
}
}
// 产物合法性:渲染结果喂给真实 sing-box 二进制的 `check` 子命令,必须 exit 0。
// 这把设计 §9 "产物合法性" 验收项变成一条常驻测试,而不是只在上线前手工跑一次。
//
// 刻意不经 SingBox/ApplyConfig 走完整 reality/hy2 inbound(sampleSnapshot 里的
// PrivateKey/CertPath 都是占位假值,sing-box 会因证书/密钥不合法而拒绝——那是
// 另一类问题,不是本测试要盯的 ACL route 合法性)。直接调用 renderSingboxConfig,
// reality/hy2 传 nil,只产出 outbounds + ACL route,聚焦 §9 要验的东西。
func TestRenderedConfig_PassesSingBoxCheck(t *testing.T) {
singboxBin, err := exec.LookPath("sing-box")
if err != nil {
t.Skip("sing-box not installed, skipping resident config-validity check")
}
ac, err := LoadACLConfig(writeTempACL(t, validACL))
if err != nil {
t.Fatal(err)
}
data, err := renderSingboxConfig(nil, nil, nil, "test-derive-key", nil, ac)
if err != nil {
t.Fatal(err)
}
// homebrew 装的本机 sing-box 二进制没有编译 with_v2ray_api tag(生产节点上的
// 那份是),`v2ray_api` 这段实验性配置在本机会导致 check 因为"功能未编译进来"
// 而 FATAL——这与本测试要验的 ACL/route 语法合法性无关,故只为本次校验剥离它。
var m map[string]any
if err := json.Unmarshal(data, &m); err != nil {
t.Fatal(err)
}
if exp, ok := m["experimental"].(map[string]any); ok {
delete(exp, "v2ray_api")
}
data, err = json.Marshal(m)
if err != nil {
t.Fatal(err)
}
dir := t.TempDir()
cfgPath := filepath.Join(dir, "config.json")
if err := os.WriteFile(cfgPath, data, 0o600); err != nil {
t.Fatal(err)
}
out, err := exec.Command(singboxBin, "check", "-c", cfgPath).CombinedOutput()
if err != nil {
t.Fatalf("sing-box check 未通过(exit != 0): %v\n%s", err, out)
}
}
// writeTempACL 把 body 写到临时目录下的 acl.json 并返回路径。
func writeTempACL(t *testing.T, body string) string {
t.Helper()
p := filepath.Join(t.TempDir(), "acl.json")
writeACL(t, p, body)
return p
}
+20 -3
View File
@@ -5,9 +5,15 @@
// command feed by managing the local sing-box user table.
//
// No-state invariant (doc/04 §2, doc/06 §3): the agent persists ONLY the
// credential table (dp_uuid + expires_at) to disk. It keeps zero user identities,
// zero destination/DNS data and writes no access logs. A seized node leaks only
// opaque dp_uuids, never accounts.
// credential table (dp_uuid + expires_at) to disk. It keeps zero user identities
// and writes no access logs. A seized node leaks only opaque dp_uuids, never
// accounts.
//
// 例外(私有目的地 ACL):节点本地 acl.json 含一份 dp_uuid 白名单与目的地清单,
// 由运营手工维护、不经控制面。它确实让节点知道「这几个 dp_uuid 享有私有访问权」
// 以及那几个私有域名/端口 —— 这是知情接受的不变式弱化,范围仅限该文件与渲染出的
// route 规则,不涉及账户身份,也不产生任何访问日志。设计见
// docs/private-dest-acl-design.html §12。
package agentd
import (
@@ -58,6 +64,10 @@ type Config struct {
// 文件不存在 = WARP 未启用。渲染时读取,支持编辑后重启 agent 生效(#29)。
WarpConfigPath string
// ACLConfigPath 指向节点本地的私有目的地访问控制表(默认 <StateDir>/acl.json)。
// 文件不存在 = 该功能未配置。渲染时读取,SIGHUP agent 即可生效。
ACLConfigPath string
// DeriveKey keys the Hy2 password derivation (see DeriveHy2Password).
DeriveKey string
@@ -86,6 +96,9 @@ func (c Config) withDefaults() Config {
if c.WarpConfigPath == "" {
c.WarpConfigPath = filepath.Join(c.StateDir, "warp.json")
}
if c.ACLConfigPath == "" {
c.ACLConfigPath = filepath.Join(c.StateDir, "acl.json")
}
if c.HeartbeatInterval == 0 {
c.HeartbeatInterval = DefaultHeartbeatInterval
}
@@ -118,3 +131,7 @@ func (c Config) KeyPath() string { return filepath.Join(c.StateDir, "node.key"
func (c Config) CertPath() string { return filepath.Join(c.StateDir, "node.crt") }
func (c Config) CAPath() string { return filepath.Join(c.StateDir, "ca.crt") }
func (c Config) StatePath() string { return filepath.Join(c.StateDir, "state.json") }
// ACLLastGoodPath 是最近一次成功加载的 ACL 快照,供 agent 冷启动时在 acl.json
// 损坏的情况下兜底(fail-closed 跨重启成立的前提)。
func (c Config) ACLLastGoodPath() string { return filepath.Join(c.StateDir, "acl.last-good.json") }
+48 -4
View File
@@ -13,6 +13,11 @@ import (
//
// Only the opaque dp_uuid is ever written; no account identity touches the node.
//
// 例外(私有目的地 ACL):若节点配置了 acl.json,渲染出的 route 规则会含一份享有私有
// 访问权的 dp_uuid 白名单与对应的私有域名/端口。它仍不含任何账户身份(email/user_id),
// 但确实让节点知道「这几个 dp_uuid 属于同一组权限」—— 知情接受的不变式弱化,
// 设计与权衡见 docs/private-dest-acl-design.html §12。
//
// 用量统计走 v2ray_api StatsService(loopback gRPC):节点 sing-box 编入
// with_v2ray_api,stats.users 列出全部 dp_uuid → 每个用户独立的
// user>>>{dp_uuid}>>>traffic>>>uplink|downlink 计数器,agent 按用户精确读取
@@ -27,7 +32,7 @@ const (
warpOutboundTag = "warp"
)
func renderSingboxConfig(creds []Cred, reality *agentv1.RealityInbound, hy2 *agentv1.Hy2Inbound, deriveKey string, warp *WarpConfig) ([]byte, error) {
func renderSingboxConfig(creds []Cred, reality *agentv1.RealityInbound, hy2 *agentv1.Hy2Inbound, deriveKey string, warp *WarpConfig, acl *ACLConfig) ([]byte, error) {
cfg := map[string]any{
"log": map[string]any{"level": "warn", "timestamp": true},
"inbounds": buildInbounds(creds, reality, hy2, deriveKey),
@@ -47,16 +52,55 @@ func renderSingboxConfig(creds []Cred, reality *agentv1.RealityInbound, hy2 *age
},
}
// WARP 分流(#29):命中配置域名的流量走 Cloudflare WARP 干净出口,其余直连。
// warp 为 nil 或未 active 时完全不加 endpoints/route → 与旧配置逐字节一致(向后兼容)。
// WARP 分流(#29)只贡献 endpoints;route 块由 buildRoute 统一产出,因为它现在要
// 同时容纳 ACL 规则 —— 原先 cfg["route"] = warp.warpRoute() 是整块覆盖,直接赋值
// 会把对方的规则干掉。
if warp.active() {
cfg["endpoints"] = []any{warp.warpEndpoint()}
cfg["route"] = warp.warpRoute()
}
if route := buildRoute(acl, warp); route != nil {
cfg["route"] = route
}
return json.MarshalIndent(cfg, "", " ")
}
// buildRoute 合并私有目的地 ACL 与 WARP 分流,产出单一 route 块。
// 两者都未激活时返回 nil —— 不产出 route 字段,与旧配置逐字节一致(向后兼容)。
//
// 规则顺序是安全语义的一部分:
// 1. {"action":"sniff"} 唯一且最先。域名匹配依赖它取 TLS SNI(客户端多半发的是
// 已解析 IP),WARP 与 ACL 都需要,故在此统一产出一次,不由各自重复追加。
// 2. {"action":"resolve"} 紧跟 sniff 之后,同样唯一且只在产出 route 块时才出现。
// ACL 的 ip_cidr 目的地(DSM/RDP/SSH 等独占端口服务)匹配的是已解析的连接
// 目的地地址——若客户端发的是域名形式(如 nas.51yanmei.com:5001)而节点不主动
// 解析,ip_cidr 规则不命中,请求会绕过 ACL 直接落到 final:direct。resolve 让
// 节点自己解析目的地,使域名形式收敛到 ip_cidr 规则上,堵住这个绕过口子
// (I3;这也是唯一一处从"节点不知道目的地"这条不变式主动后退的地方,是知情
// 接受的取舍,见 docs/private-dest-acl-design.html §12)。
// 3. ACL 规则(放行在前、拒绝在后)整体排在 WARP 之前:被 ACL 拒绝的目的地永远
// 不该还有机会被路由到 warp 出口。
// 4. final 恒为 direct。
func buildRoute(acl *ACLConfig, warp *WarpConfig) map[string]any {
aclRules := acl.rules()
warpActive := warp.active()
if len(aclRules) == 0 && !warpActive {
return nil
}
rules := make([]any, 0, len(aclRules)+3)
rules = append(rules, map[string]any{"action": "sniff"})
rules = append(rules, map[string]any{"action": "resolve"})
rules = append(rules, aclRules...)
if warpActive {
rules = append(rules, map[string]any{
"domain_suffix": warp.cleanDomains(),
"outbound": warpOutboundTag,
})
}
return map[string]any{"rules": rules, "final": directOutboundTag}
}
// statsUsers 收集所有去重 dp_uuid,供 v2ray_api stats.users 按用户开启流量计数器。
func statsUsers(creds []Cred) []string {
seen := make(map[string]struct{}, len(creds))
+83 -1
View File
@@ -61,6 +61,10 @@ type SingBox struct {
hy2 *agentv1.Hy2Inbound
configVersion int64
// lastGoodACL 是最近一次成功加载的私有目的地 ACL。acl.json 读坏时回退到它,
// 而不是像 WARP 那样降级为「不启用」—— 对访问控制,降级即敞开。
lastGoodACL *ACLConfig
// started 标记 sing-box 是否已被本 agent 冷启动过:首次走 Restart(冷启动),
// 之后配置变更走 Reload(SIGHUP 热重载)。agent 进程重启后复位为 false,
// 下次渲染做一次冷启动以确保与渲染配置一致。
@@ -323,7 +327,80 @@ func (s *SingBox) RenderConfig() ([]byte, error) {
logf("[warp] load %s failed, WARP routing disabled: %v", s.cfg.WarpConfigPath, err)
warp = nil
}
return renderSingboxConfig(creds, reality, hy2, s.cfg.DeriveKey, warp)
return renderSingboxConfig(creds, reality, hy2, s.cfg.DeriveKey, warp, s.loadACL())
}
// loadACL 读取私有目的地 ACL,并维护 last-good 兜底。
//
// 语义刻意与 WARP 相反:WARP 读失败静默降级为「不分流」是安全的,ACL 读失败若也
// 降级为「不启用」,等于把私有服务对全体 pangolin 用户敞开,而且是静默的。故:
// - 成功 → 更新内存 last-good 并落盘,供本进程后续与下次冷启动使用
// - 失败/文件消失 → 回退内存 last-good,再回退磁盘 last-good,规则不消失
// - 两级 last-good 都没有 → 只能不产出规则(白名单与目的地清单同在一个文件,
// 文件全丢时连「该拒绝哪些目的地」都无从得知),此时必须大声告警
func (s *SingBox) loadACL() *ACLConfig {
acl, err := LoadACLConfig(s.cfg.ACLConfigPath)
switch {
case err == nil && acl != nil:
if acl.Enabled && len(acl.cleanTargets()) == 0 {
// enabled 却零 target = 几乎必然是字段名手抖(如 targets 打成 targetz)。
// encoding/json 对未知字段静默无视,这份配置"看似合法"但毫无内容——当作
// 加载失败,走下面的 last-good 兜底,绝不静默敞开、更不能拿它覆盖兜底快照。
logf("[acl] ERROR %s parsed but enabled=true yields zero targets — treating as broken, falling back", s.cfg.ACLConfigPath)
break // 落到下方 last-good 兜底(Go 的 switch 内 break 只退出 switch)
}
if acl.active() {
// 只有 active 的配置才配当 last-good:否则一次手抖既关闸又冲掉兜底。
s.mu.Lock()
s.lastGoodACL = acl
s.mu.Unlock()
if perr := persistACL(s.cfg.ACLLastGoodPath(), acl); perr != nil {
logf("[acl] persist last-good to %s failed: %v", s.cfg.ACLLastGoodPath(), perr)
}
} else {
// active() 为 false 但走到了这里,只可能是显式 enabled:false —— 合法关闭。
// 直接返回这份(空规则的)配置,不 persist,保留此前的恢复能力。
logf("[acl] gate explicitly disabled (enabled=false)")
}
return acl
case err != nil:
logf("[acl] ERROR load %s failed: %v", s.cfg.ACLConfigPath, err)
}
s.mu.Lock()
lg := s.lastGoodACL
s.mu.Unlock()
if lg != nil {
logf("[acl] WARN falling back to in-memory last-good ACL")
return lg
}
disk, derr := LoadACLConfig(s.cfg.ACLLastGoodPath())
if derr != nil {
logf("[acl] ERROR reading last-good %s: %v", s.cfg.ACLLastGoodPath(), derr)
}
if derr == nil && disk != nil {
logf("[acl] WARN falling back to on-disk last-good %s", s.cfg.ACLLastGoodPath())
s.mu.Lock()
s.lastGoodACL = disk
s.mu.Unlock()
return disk
}
// 两级 last-good 都没有可用配置。区分两种终态:
// - 这台节点从未配置过 ACL(acl.json 与 last-good 均从未存在过)→ 安静返回,
// 不刷屏告警。
// - 除此之外的任何情况(acl.json 存在但损坏/last-good 存在但损坏等)→ 私有
// 服务的访问闸实质已消失,必须大声告警(§5 "两者都失败才不产出 ACL 规则,
// 同时打 ERROR 并告警")。
_, aclStatErr := os.Stat(s.cfg.ACLConfigPath)
_, lgStatErr := os.Stat(s.cfg.ACLLastGoodPath())
neverConfigured := os.IsNotExist(aclStatErr) && os.IsNotExist(lgStatErr)
if !neverConfigured {
logf("[acl] ALERT acl.json is broken and no last-good snapshot exists — "+
"private destinations are UNPROTECTED (path=%s)", s.cfg.ACLConfigPath)
}
return nil
}
// writeAndRestart renders, writes the config file and restarts sing-box.
@@ -395,6 +472,11 @@ func (s *SingBox) markDirty() {
}
}
// Refresh 请求一次重渲染。供 agent 收到 SIGHUP 时调用,使编辑节点本地配置文件
// (acl.json / warp.json)后无需重启进程即可生效 —— 重启 agent 会让 sing-box 走
// 冷启动(Restart),把全部在线用户踢下线。
func (s *SingBox) Refresh() { s.markDirty() }
// Run drives the debounce loop: it coalesces bursts of changes within
// DebounceWindow into a single write+restart. It blocks until ctx is cancelled.
func (s *SingBox) Run(ctx context.Context) {
+2 -21
View File
@@ -6,7 +6,6 @@ import (
"net"
"os"
"strconv"
"strings"
)
// WarpConfig 描述节点上「部分域名走 Cloudflare WARP 干净出口」的分流配置(#29)。
@@ -66,15 +65,9 @@ func (wc *WarpConfig) mtu() int {
}
// cleanDomains 去空白/空项后返回域名清单(用于 domain_suffix)。
// 与 ACL 的目的地域名规范化共用 cleanHosts,避免两处逻辑漂移。
func (wc *WarpConfig) cleanDomains() []string {
out := make([]string, 0, len(wc.Domains))
for _, d := range wc.Domains {
d = strings.TrimSpace(strings.ToLower(d))
if d != "" {
out = append(out, d)
}
}
return out
return cleanHosts(wc.Domains)
}
// endpointHostPort 拆 Endpoint 为 host + port(active() 已校验可拆)。
@@ -107,15 +100,3 @@ func (wc *WarpConfig) warpEndpoint() map[string]any {
"peers": []any{peer},
}
}
// warpRoute 构造分流 route:先 sniff 取出 SNI/Host(客户端多半发的是已解析 IP,
// 不 sniff 域名规则无从命中),命中域名后缀走 warp,其余 final=direct。
func (wc *WarpConfig) warpRoute() map[string]any {
return map[string]any{
"rules": []any{
map[string]any{"action": "sniff"},
map[string]any{"domain_suffix": wc.cleanDomains(), "outbound": warpOutboundTag},
},
"final": directOutboundTag,
}
}
+51 -10
View File
@@ -15,6 +15,13 @@ type ClientConfigOpts struct {
// RulesBaseURL 是控制面对外公网基址(如 "http://node:8080"),rule_set 的 .srs
// 从 <base>/v1/rules/*.srs 下载。SplitCN 生效需此项非空(否则分流静默跳过)。
RulesBaseURL string
// PrivateSplitDomains 私有服务域名(家庭内网穿透,如 nas/git/win.yanmeiai.com,
// 服务端 env PANGOLIN_PRIVATE_SPLIT_DOMAINS 配置;空=行为完全不变):
// - DNS 改用系统解析器(在家吃到局域网 DNS 覆盖→私网 IP;在外解析出公网锚点)
// - 路由上私网结果命中 LAN 直连(在家零绕行),公网结果强制走隧道——该规则
// 必须排在国内分流(geoip-cn)之前:锚点(frps@ali)是国内 IP,否则 smartRoute
// 会把它分流成直连,被 frps 侧安全组限源(仅节点出口)拦截。
PrivateSplitDomains []string
}
// BuildClientConfig renders a complete sing-box CLIENT configuration JSON that
@@ -106,6 +113,12 @@ func BuildClientConfig(node *nodes.NodeRow, dpUUID, deriveKey string, opts Clien
"auto_route": true,
"strict_route": true,
"stack": "system",
// 私有 LAN 直连:strict_route 会在 OS 层把所有流量(含 LAN)强抓进隧道,
// 光靠 route.rules 的 ip_cidr→direct 在 macOS 不生效(direct 出站的包被
// strict_route 重新捕回隧道)。route_exclude_address 在 auto_route 层就把这些
// 网段排除出隧道,LAN 走系统直连(修「隧道开着连不上局域网/NAS/家里机器」)。
// **不含 172.16.0.0/12**:隧道自身地址与 DNS(172.19.x)在此段,排除会断 DNS。
"route_exclude_address": []string{"192.168.0.0/16", "10.0.0.0/8"},
}
// 代理出站集合:REALITY 必有;Hy2 仅在启用时加入(否则不进配置/探测组)。
@@ -126,7 +139,8 @@ func BuildClientConfig(node *nodes.NodeRow, dpUUID, deriveKey string, opts Clien
"tolerance": 50,
}
// Route: DNS 劫持 → LAN direct →(可选)国内直连 → 其余 via auto。
// Route: DNS 劫持 → LAN direct →(可选)私有域名走隧道 →(可选)国内直连 → 其余 via auto。
privateSplit := len(opts.PrivateSplitDomains) > 0
routeRules := []any{
// DNS 劫持(sing-box 1.13 action=hijack-dns,按目的端口 53 匹配,不依赖 sniff):
// 把发往隧道 DNS(172.19.0.2:53)的查询交给 sing-box DNS 模块解析。必须排在 LAN
@@ -138,6 +152,15 @@ func BuildClientConfig(node *nodes.NodeRow, dpUUID, deriveKey string, opts Clien
"outbound": "direct",
},
}
if privateSplit {
// 私有域名强制走隧道。在家不受此规则影响:系统 DNS(局域网覆盖)解析出私网 IP,
// 上面的 LAN 直连规则先命中。域名元数据靠 dns.reverse_mapping 补回(应用自行
// 解析后按 IP 连接,无回映射则此规则永不匹配、在外会掉进国内分流被限源拦截)。
routeRules = append(routeRules, map[string]any{
"domain": opts.PrivateSplitDomains,
"outbound": "auto",
})
}
route := map[string]any{
"final": "auto",
"auto_detect_interface": true,
@@ -166,24 +189,42 @@ func BuildClientConfig(node *nodes.NodeRow, dpUUID, deriveKey string, opts Clien
// DNS: remote over tunnel, local for domestic.
// sing-box 1.12+ DNS server format(type+server);旧的 address 串格式在
// 1.13 已 FATAL 拒绝(legacy DNS servers deprecated)。
dnsServers := []any{
map[string]any{"tag": "remote", "type": "tls", "server": "8.8.8.8", "detour": "auto"},
// local 不带 detour:sing-box 1.12 拒绝 DNS detour 到空 direct 出站
// (FATAL: detour to an empty direct outbound makes no sense)。
map[string]any{"tag": "local", "type": "udp", "server": "223.5.5.5"},
}
if privateSplit {
// 系统解析器(type=local,经底层物理网络):在家=路由器 DHCP 下发的局域网 DNS
// (含私有域名覆盖→私网 IP),在外=所在网络 DNS(公网记录→锚点 IP)。
// 不能用 223.5.5.5/8.8.8.8——公共 DNS 不知道家里的覆盖记录。
dnsServers = append(dnsServers, map[string]any{"tag": "dns-system", "type": "local"})
}
dns := map[string]any{
"servers": []any{
map[string]any{"tag": "remote", "type": "tls", "server": "8.8.8.8", "detour": "auto"},
// local 不带 detour:sing-box 1.12 拒绝 DNS detour 到空 direct 出站
// (FATAL: detour to an empty direct outbound makes no sense)。
map[string]any{"tag": "local", "type": "udp", "server": "223.5.5.5"},
},
"servers": dnsServers,
"final": "remote",
"strategy": "ipv4_only",
}
dnsRules := []any{}
if privateSplit {
// 私有域名规则须排在 geosite-cn 之前(优先级最高)。
dnsRules = append(dnsRules, map[string]any{
"domain": opts.PrivateSplitDomains, "server": "dns-system",
})
// 回映射:记住"哪个 IP 是哪个域名解析出来的",给后续按 IP 发起的连接补回
// 域名元数据——路由层的 domain 规则(私有域名→隧道)靠它才会命中。
dns["reverse_mapping"] = true
}
// 国内分流的 DNS 面(补 #5 数据面之外的 DNS 面):开分流时,命中 geosite-cn 的
// 国内域名用 local(223.5.5.5)直连解析,不走 remote(8.8.8.8 经隧道)。否则即便数据
// 直连,域名解析仍绕道出海(实测国内 DNS 段 200-600ms),首连凭空多一个出海 RTT。
// 复用 route.rule_set 里已定义的 geosite-cn 标签。
if splitActive {
dns["rules"] = []any{
map[string]any{"rule_set": []string{"geosite-cn"}, "server": "local"},
}
dnsRules = append(dnsRules, map[string]any{"rule_set": []string{"geosite-cn"}, "server": "local"})
}
if len(dnsRules) > 0 {
dns["rules"] = dnsRules
}
cfg := map[string]any{
@@ -91,6 +91,84 @@ func TestBuildClientConfigSplitCN(t *testing.T) {
}
}
func TestBuildClientConfigPrivateSplit(t *testing.T) {
domains := []string{"nas.yanmeiai.com", "git.yanmeiai.com", "win.yanmeiai.com"}
// 私有分流 + 国内分流同时开:验证规则齐全且顺序正确
// (LAN 直连 → 私有域名强制走隧道 → 国内直连;私有规则必须在国内直连之前,
// 否则锚点是国内 IP 会被分流成直连、被 frps 侧安全组限源拦截)。
cfg, err := BuildClientConfig(testNode(), "uuid-1", "k",
ClientConfigOpts{SplitCN: true, RulesBaseURL: "http://node:8080",
PrivateSplitDomains: domains})
if err != nil {
t.Fatal(err)
}
var m map[string]any
if err := json.Unmarshal(cfg, &m); err != nil {
t.Fatal(err)
}
// ① dns.servers 含系统解析器(type=local):在家吃到局域网 DNS 覆盖(私网IP),
// 在外用所在网络 DNS 解析出公网锚点。
dnsm := m["dns"].(map[string]any)
foundSystem := false
for _, s := range dnsm["servers"].([]any) {
sm := s.(map[string]any)
if sm["tag"] == "dns-system" && sm["type"] == "local" {
foundSystem = true
}
}
if !foundSystem {
t.Error("missing dns-system (type=local) dns server")
}
// ② dns.rules 首条 = 私有域名→dns-system(须排在 geosite-cn→local 之前)。
dnsRules := dnsm["rules"].([]any)
dr := dnsRules[0].(map[string]any)
if dr["server"] != "dns-system" || dr["domain"] == nil {
t.Errorf("dns.rules[0] should be private domains → dns-system, got %v", dr)
}
// ③ reverse_mapping 开启:应用自行解析后按 IP 连接,回映射补回域名元数据,
// 路由的 domain 规则才有效。
if dnsm["reverse_mapping"] != true {
t.Error("reverse_mapping should be true when private split is on")
}
// ④ 路由顺序:LAN 直连 < 私有域名→auto < 国内 rule_set→direct。
rules := m["route"].(map[string]any)["rules"].([]any)
lanIdx, privIdx, cnIdx := -1, -1, -1
for i, r := range rules {
rm := r.(map[string]any)
if rm["ip_cidr"] != nil && rm["outbound"] == "direct" {
lanIdx = i
}
if rm["domain"] != nil && rm["outbound"] == "auto" {
privIdx = i
}
if rm["rule_set"] != nil && rm["outbound"] == "direct" {
cnIdx = i
}
}
if lanIdx < 0 || privIdx < 0 || cnIdx < 0 {
t.Fatalf("missing rules: lan=%d priv=%d cn=%d", lanIdx, privIdx, cnIdx)
}
if !(lanIdx < privIdx && privIdx < cnIdx) {
t.Errorf("rule order wrong: lan=%d < priv=%d < cn=%d expected", lanIdx, privIdx, cnIdx)
}
// ⑤ 不配置 → 全部不出现(行为与旧版完全一致)。
cfg2, _ := BuildClientConfig(testNode(), "uuid-1", "k", ClientConfigOpts{})
var m2 map[string]any
_ = json.Unmarshal(cfg2, &m2)
dnsm2 := m2["dns"].(map[string]any)
if _, ok := dnsm2["reverse_mapping"]; ok {
t.Error("private split off: reverse_mapping should be absent")
}
if strings.Contains(string(cfg2), "dns-system") {
t.Error("private split off: dns-system should be absent")
}
}
func TestRulesHandler(t *testing.T) {
dir := t.TempDir()
if err := os.WriteFile(filepath.Join(dir, "geoip-cn.srs"), []byte("SRS"), 0o644); err != nil {
@@ -115,3 +193,45 @@ func TestRulesHandler(t *testing.T) {
t.Errorf("allowed but missing file: code=%d, want 404", code)
}
}
// TUN 入站必须把私有 LAN 网段从隧道排除(route_exclude_address),否则 strict_route
// 会在 macOS 把 LAN 强抓进隧道 → 隧道开着连不上局域网/NAS。不得含 172.16/12
// (隧道自身 172.19.x 在此段,排除会断 DNS)。
func TestBuildClientConfigLANExclude(t *testing.T) {
cfg, err := BuildClientConfig(testNode(), "uuid-1", "k", ClientConfigOpts{})
if err != nil {
t.Fatalf("build: %v", err)
}
var m map[string]any
if err := json.Unmarshal(cfg, &m); err != nil {
t.Fatalf("unmarshal: %v", err)
}
var tun map[string]any
for _, in := range m["inbounds"].([]any) {
im := in.(map[string]any)
if im["type"] == "tun" {
tun = im
break
}
}
if tun == nil {
t.Fatal("no tun inbound")
}
exRaw, ok := tun["route_exclude_address"]
if !ok {
t.Fatal("tun inbound missing route_exclude_address (LAN would be captured by strict_route)")
}
got := map[string]bool{}
for _, v := range exRaw.([]any) {
got[v.(string)] = true
}
if !got["192.168.0.0/16"] {
t.Error("route_exclude_address must contain 192.168.0.0/16")
}
if !got["10.0.0.0/8"] {
t.Error("route_exclude_address must contain 10.0.0.0/8")
}
if got["172.16.0.0/12"] {
t.Error("route_exclude_address must NOT contain 172.16.0.0/12 (tunnel DNS 172.19.x lives there)")
}
}
+10 -4
View File
@@ -42,12 +42,16 @@ type NodeAPI struct {
// rulesBaseURL 是控制面对外公网基址(PANGOLIN_PUBLIC_URL),供国内分流的
// rule_set .srs 下载用;空则分流不生效。
rulesBaseURL string
// privateSplitDomains 私有服务域名(PANGOLIN_PRIVATE_SPLIT_DOMAINS,逗号分隔),
// 见 ClientConfigOpts.PrivateSplitDomains;空则不渲染相关规则。
privateSplitDomains []string
}
// NewNodeAPI creates a NodeAPI. load may be nil (then all nodes are treated as
// data-plane healthy — agent gRPC liveness still gates status).
func NewNodeAPI(store nodes.NodeStore, hub *nodes.Hub, load nodeLoadReader, deriveKey, rulesBaseURL string) *NodeAPI {
return &NodeAPI{store: store, hub: hub, load: load, deriveKey: deriveKey, rulesBaseURL: rulesBaseURL}
func NewNodeAPI(store nodes.NodeStore, hub *nodes.Hub, load nodeLoadReader, deriveKey, rulesBaseURL string, privateSplitDomains []string) *NodeAPI {
return &NodeAPI{store: store, hub: hub, load: load, deriveKey: deriveKey,
rulesBaseURL: rulesBaseURL, privateSplitDomains: privateSplitDomains}
}
// dataPlaneHealthy reports the node's last sing-box health (default true when
@@ -315,7 +319,8 @@ func (a *NodeAPI) ConnectNode(w http.ResponseWriter, r *http.Request) {
// split_cn=1/true → 国内 IP/域名直连(#5);客户端按 smartRoute 偏好传。
splitCN := r.URL.Query().Get("split_cn") == "1" || r.URL.Query().Get("split_cn") == "true"
cfgJSON, renderErr := BuildClientConfig(node, dpUUID, a.deriveKey,
ClientConfigOpts{SplitCN: splitCN, RulesBaseURL: a.rulesBaseURL})
ClientConfigOpts{SplitCN: splitCN, RulesBaseURL: a.rulesBaseURL,
PrivateSplitDomains: a.privateSplitDomains})
if renderErr != nil {
slog.Error("connect: build client config failed", "node", nodeUUID, "err", renderErr)
apierr.WriteJSON(w, http.StatusInternalServerError, apierr.ErrInternal)
@@ -324,7 +329,8 @@ func (a *NodeAPI) ConnectNode(w http.ResponseWriter, r *http.Request) {
// 可观测:国内分流是否真正生效(split_active=两个条件都满足才渲染 rule_set)。
slog.Info("client config rendered", "node", nodeUUID, "split_cn", splitCN,
"rules_base_set", a.rulesBaseURL != "",
"split_active", splitCN && a.rulesBaseURL != "", "bytes", len(cfgJSON))
"split_active", splitCN && a.rulesBaseURL != "",
"private_split", len(a.privateSplitDomains), "bytes", len(cfgJSON))
w.Header().Set("Content-Type", "application/json; charset=utf-8")
_, _ = w.Write(cfgJSON)
@@ -51,7 +51,7 @@ func (f *fakeDisconnectStore) PersistCredential(context.Context, int64, *agentv1
func doDisconnect(t *testing.T, store *fakeDisconnectStore, body string) int {
t.Helper()
api := NewNodeAPI(store, nil, nil, "", "") // nil hub:跳过 Push,只验证凭证删除
api := NewNodeAPI(store, nil, nil, "", "", nil) // nil hub:跳过 Push,只验证凭证删除
req := httptest.NewRequest("POST", "/v1/nodes/node-1/disconnect", strings.NewReader(body))
rctx := chi.NewRouteContext()
rctx.URLParams.Add("id", "node-1")