fix: persist custom egress IP probe service (#118)

This commit is contained in:
ji ruo committed 2026-11-05 16:00:07 +08:00
1 parent d36e1c3295
commit 4868b1816f
10 files changed
+300 -36

No files matched your search

+34 -13
View File
@@ -26,12 +26,30 @@ import (
"github.com/Autumn-27/artex/traffic"
)
// defaultEgressProbes 按顺序尝试,第一个成功即停;probe_url 可覆盖,供隔离网使用。
const settingEgressProbeURL = "egress_probe_url"
// defaultEgressProbes 按顺序尝试,第一个成功即停;自定义地址为空时使用。
var defaultEgressProbes = []string{
"https://api.ipify.org?format=json", // 返回 {"ip":"1.2.3.4"}
"https://ifconfig.me/ip", // 返回纯文本 1.2.3.4
}
func (m *Manager) EgressProbeURL() string {
if m == nil || m.pg == nil {
return ""
}
raw, _, _ := m.pg.GetSetting(settingEgressProbeURL)
return strings.TrimSpace(raw)
}
// egressProbes reads settings for every probe so saves take effect without a restart.
func (m *Manager) egressProbes() []string {
if raw := m.EgressProbeURL(); raw != "" {
return []string{raw}
}
return defaultEgressProbes
}
// validateProbeURL 只放行指向"非本机、非链路本地"的绝对 http(s) 地址。
//
// 这个接口要登录,但仍要挡:agent 可能被目标页面诱导去调它,而"本机"在容器里就是 ARTEX
@@ -339,9 +357,9 @@ func egressTarget(cfg string, capture, pending bool, agentProxy, agentCA string)
// 空 = 测直连、永远返回 200 用 ok 表达结果。
func (s *Server) testEgressProxy(w http.ResponseWriter, r *http.Request) {
var req struct {
GlobalProxy string `json:"global_proxy"`
ProbeURL string `json:"probe_url"` // 可选:覆盖默认探测地址
Resume bool `json:"resume"` // manual settings probe may release paused_by_proxy tasks
GlobalProxy string `json:"global_proxy"`
ProbeURL *string `json:"probe_url"` // 省略=已保存地址;空串=默认;非空=临时覆盖
Resume bool `json:"resume"` // manual settings probe may release paused_by_proxy tasks
}
// 请求体只有一个地址,给个上限,免得被塞大 payload。
r.Body = http.MaxBytesReader(w, r.Body, 64<<10)
@@ -351,14 +369,17 @@ func (s *Server) testEgressProxy(w http.ResponseWriter, r *http.Request) {
return
}
probes := defaultEgressProbes
if u := strings.TrimSpace(req.ProbeURL); u != "" {
checked, err := validateProbeURL(u)
if err != nil {
writeErr(w, 400, err.Error())
return
probes := s.m.egressProbes()
if req.ProbeURL != nil {
probes = defaultEgressProbes
if u := strings.TrimSpace(*req.ProbeURL); u != "" {
checked, err := validateProbeURL(u)
if err != nil {
writeErr(w, 400, err.Error())
return
}
probes = []string{checked}
}
probes = []string{checked}
}
// 这三个调用决定 agent 到底会走哪条路。
@@ -391,7 +412,7 @@ func (s *Server) testEgressProxy(w http.ResponseWriter, r *http.Request) {
rep.Checks = append(rep.Checks, egressCheck{
Key: "direct",
Label: "① 直连 IP(不经过代理)",
Result: probeEgress(ctx, "", "", probes, 10*time.Second),
Result: s.runProxyProbe(ctx, "", "", probes, 10*time.Second),
})
if configuredProxy != "" {
@@ -405,7 +426,7 @@ func (s *Server) testEgressProxy(w http.ResponseWriter, r *http.Request) {
Label: "② 经全局代理的出口 IP",
// Path 是实际探测地址(经 MITM 时是 8788),排查时看这个。
Path: maskSecrets(probeAddr),
Result: probeEgress(ctx, probeAddr, probeCA, probes, timeout),
Result: s.runProxyProbe(ctx, probeAddr, probeCA, probes, timeout),
})
} else {
skipReason := "输入框为空,未配置代理"
+182
View File
@@ -0,0 +1,182 @@
package server
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"reflect"
"strings"
"testing"
"time"
)
func preserveEgressProbeSetting(t *testing.T, m *Manager) {
t.Helper()
old, existed, err := m.pg.GetSetting(settingEgressProbeURL)
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() {
if existed {
if err := m.pg.SetSetting(settingEgressProbeURL, old); err != nil {
t.Error(err)
}
} else if _, err := m.pg.Exec("DELETE FROM settings WHERE key=$1", settingEgressProbeURL); err != nil {
t.Error(err)
}
})
}
func TestEgressProbeSettingsPersistence(t *testing.T) {
m := proxyTestManager(t)
preserveEgressProbeSetting(t, m)
if _, err := m.pg.Exec("DELETE FROM settings WHERE key=$1", settingEgressProbeURL); err != nil {
t.Fatal(err)
}
dir := t.TempDir()
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, dir, dir, dir)
defer func() {
cancel()
s.Close()
}()
token, err := signJWT(s.jwtKey)
if err != nil {
t.Fatal(err)
}
request := func(method, body string, authenticated bool) *httptest.ResponseRecorder {
req := httptest.NewRequest(method, "/api/settings", strings.NewReader(body))
if authenticated {
req.Header.Set("Authorization", "Bearer "+token)
}
w := httptest.NewRecorder()
s.Handler().ServeHTTP(w, req)
return w
}
for _, method := range []string{http.MethodGet, http.MethodPut} {
if w := request(method, `{"egress_probe_url":"http://10.0.0.5/ip"}`, false); w.Code != http.StatusUnauthorized {
t.Fatalf("unauthenticated %s: %d", method, w.Code)
}
}
assertResponse := func(method, body, want string) {
t.Helper()
w := request(method, body, true)
if w.Code != http.StatusOK {
t.Fatalf("%s: status=%d body=%s", method, w.Code, w.Body.String())
}
var payload map[string]json.RawMessage
if err := json.Unmarshal(w.Body.Bytes(), &payload); err != nil {
t.Fatal(err)
}
var got string
if err := json.Unmarshal(payload[settingEgressProbeURL], &got); err != nil || got != want {
t.Fatalf("egress_probe_url=%q want=%q err=%v", got, want, err)
}
}
assertResponse(http.MethodGet, "", "")
if got := m.egressProbes(); !reflect.DeepEqual(got, defaultEgressProbes) {
t.Fatalf("default probes=%v", got)
}
const custom = "http://192.168.132.130:19000/ip"
assertResponse(http.MethodPut, `{"egress_probe_url":" `+custom+` "}`, custom)
assertResponse(http.MethodGet, "", custom)
assertResponse(http.MethodPut, `{}`, custom)
assertResponse(http.MethodPut, `{"egress_probe_url":null}`, custom)
for _, invalid := range []string{"ftp://example.com/ip", "/relative", "http://127.0.0.1:8787", "http://169.254.169.254/latest", "http://[::1]/"} {
body, _ := json.Marshal(map[string]string{settingEgressProbeURL: invalid})
if w := request(http.MethodPut, string(body), true); w.Code != http.StatusBadRequest {
t.Fatalf("invalid URL %q accepted: %d %s", invalid, w.Code, w.Body.String())
}
assertResponse(http.MethodGet, "", custom)
}
// A fresh manager must read the persisted value, without sharing runtime state.
reloaded := proxyTestManager(t)
if got := reloaded.egressProbes(); !reflect.DeepEqual(got, []string{custom}) {
t.Fatalf("reloaded probes=%v", got)
}
assertResponse(http.MethodPut, `{"egress_probe_url":" "}`, "")
if got := reloaded.egressProbes(); !reflect.DeepEqual(got, defaultEgressProbes) {
t.Fatalf("cleared probes=%v", got)
}
}
func TestEgressProbeSavedAndTemporaryURLs(t *testing.T) {
m := proxyTestManager(t)
preserveEgressProbeSetting(t, m)
const saved = "http://10.0.0.5/ip"
if err := m.pg.SetSetting(settingEgressProbeURL, saved); err != nil {
t.Fatal(err)
}
s := &Server{m: m}
for _, tc := range []struct {
name string
body string
want []string
}{
{"navbar uses saved", `{}`, []string{saved}},
{"null uses saved", `{"probe_url":null}`, []string{saved}},
{"unsaved override", `{"probe_url":" https://example.com/ip "}`, []string{"https://example.com/ip"}},
{"empty previews defaults", `{"probe_url":""}`, defaultEgressProbes},
{"whitespace previews defaults", `{"probe_url":" "}`, defaultEgressProbes},
{"global proxy uses saved", `{"global_proxy":"http://10.0.0.9:8080"}`, []string{saved}},
} {
t.Run(tc.name, func(t *testing.T) {
calls := 0
s.proxyProbe = func(_ context.Context, _, _ string, probes []string, _ time.Duration) egressProbeResult {
calls++
if !reflect.DeepEqual(probes, tc.want) {
t.Fatalf("probes=%v want=%v", probes, tc.want)
}
return egressProbeResult{OK: true, ExitIP: "203.0.113.7", Probes: []egressAttempt{}}
}
w := httptest.NewRecorder()
s.testEgressProxy(w, httptest.NewRequest(http.MethodPost, "/api/settings/proxy/test", strings.NewReader(tc.body)))
wantCalls := 1
if strings.Contains(tc.body, "global_proxy") {
wantCalls = 2
}
if w.Code != http.StatusOK || calls != wantCalls {
t.Fatalf("status=%d calls=%d body=%s", w.Code, calls, w.Body.String())
}
if got := m.EgressProbeURL(); got != saved {
t.Fatalf("temporary probe changed saved setting: %q", got)
}
})
}
s.proxyProbe = func(context.Context, string, string, []string, time.Duration) egressProbeResult {
t.Fatal("invalid URL must not send a probe")
return egressProbeResult{}
}
w := httptest.NewRecorder()
s.testEgressProxy(w, httptest.NewRequest(http.MethodPost, "/api/settings/proxy/test", strings.NewReader(`{"probe_url":"http://127.0.0.1"}`)))
if w.Code != http.StatusBadRequest {
t.Fatalf("invalid probe status=%d", w.Code)
}
}
func TestProxyPoolHealthUsesSavedEgressProbe(t *testing.T) {
m := proxyTestManager(t)
preserveEgressProbeSetting(t, m)
const custom = "http://10.0.0.5/ip"
if err := m.pg.SetSetting(settingEgressProbeURL, custom); err != nil {
t.Fatal(err)
}
m.globalProxy = "http://proxy.example:8080"
m.proxyPool = &proxyPoolState{active: "a", entries: []proxyPoolEntry{{
ProxyPoolEntry: ProxyPoolEntry{ID: "a", Enabled: true}, RawURL: m.globalProxy,
}}}
s := &Server{m: m, ctx: context.Background(), proxyPoolProbeSem: make(chan struct{}, proxyPoolMaxProbeConcurrency)}
calls := 0
s.proxyProbe = func(_ context.Context, _, _ string, probes []string, _ time.Duration) egressProbeResult {
calls++
if !reflect.DeepEqual(probes, []string{custom}) {
t.Errorf("health probes=%v want=%s", probes, custom)
}
return egressProbeResult{Error: "offline test"}
}
s.proxyPoolTickLocked(true)
if calls != 1 {
t.Fatalf("health probe calls=%d", calls)
}
}
+5 -5
View File
@@ -145,7 +145,7 @@ func (s *Server) handleProxyFailure(taskID string, cause error) {
if s.handleProxyPoolFailure(cause) {
return
}
if probe := s.runProxyProbe(s.ctx, s.m.GlobalProxy(), "", defaultEgressProbes, 10*time.Second); probe.OK {
if probe := s.runProxyProbe(s.ctx, s.m.GlobalProxy(), "", s.m.egressProbes(), 10*time.Second); probe.OK {
return
}
s.pauseProxyTask(taskID, cause)
@@ -200,7 +200,7 @@ func (s *Server) handleProxyTrafficFailure(cause error) {
}
// Confirm the saved global proxy itself before pausing. MITM RequestError can
// also represent a target-side failure, and those must not pause a task.
if probe := probeEgress(context.Background(), s.m.GlobalProxy(), "", defaultEgressProbes, 10*time.Second); probe.OK {
if probe := probeEgress(context.Background(), s.m.GlobalProxy(), "", s.m.egressProbes(), 10*time.Second); probe.OK {
return
}
for _, t := range s.m.List() {
@@ -219,7 +219,7 @@ func (s *Server) handleProxyToolFailure(ctx context.Context, cause error) {
if !isGlobalProxyDialFailure(cause) || strings.TrimSpace(s.m.GlobalProxy()) == "" {
return
}
if probe := probeEgress(context.Background(), s.m.GlobalProxy(), "", defaultEgressProbes, 10*time.Second); probe.OK {
if probe := probeEgress(context.Background(), s.m.GlobalProxy(), "", s.m.egressProbes(), 10*time.Second); probe.OK {
return
}
if info := agent.RunInfoFrom(ctx); info.TaskID > 0 {
@@ -302,7 +302,7 @@ func (s *Server) proxyReconnectTick() {
if !claimed {
continue
}
res := s.runProxyProbe(context.Background(), s.m.GlobalProxy(), "", defaultEgressProbes, 10*time.Second)
res := s.runProxyProbe(context.Background(), s.m.GlobalProxy(), "", s.m.egressProbes(), 10*time.Second)
if res.OK {
s.proxyReconnectSuccessWithGuards(map[string]proxyReconnectGuard{
t.ID: {generation: round, attempt: attempt, checkAttempt: true},
@@ -431,7 +431,7 @@ func (s *Server) testTaskProxy(w http.ResponseWriter, r *http.Request) {
s.proxyReconnectSuccessWithGuards(guards, nil)
return
}
res := s.runProxyProbe(r.Context(), proxy, "", defaultEgressProbes, 10*time.Second)
res := s.runProxyProbe(r.Context(), proxy, "", s.m.egressProbes(), 10*time.Second)
if res.OK {
s.proxyReconnectSuccessWithGuards(guards, nil)
}
+3 -3
View File
@@ -578,7 +578,7 @@ func (s *Server) proxyPoolTickLocked(forceHealth bool) proxyPoolTickOutcome {
return
}
defer func() { <-sem }()
res := s.runProxyProbe(serverContext(s), e.RawURL, "", defaultEgressProbes, proxyPoolProbeTimeout)
res := s.runProxyProbe(serverContext(s), e.RawURL, "", s.m.egressProbes(), proxyPoolProbeTimeout)
s.m.markProxyProbe(e.ID, res)
probeMu.Lock()
probeResults[e.ID] = res.OK
@@ -695,7 +695,7 @@ func (s *Server) handleProxyPoolFailure(cause error) bool {
if cur == "" {
return false
}
res := s.runProxyProbe(serverContext(s), cur, "", defaultEgressProbes, proxyPoolProbeTimeout)
res := s.runProxyProbe(serverContext(s), cur, "", s.m.egressProbes(), proxyPoolProbeTimeout)
if res.OK {
return false
}
@@ -1134,7 +1134,7 @@ func (s *Server) testProxyPoolEntry(w http.ResponseWriter, r *http.Request) {
id := r.PathValue("id")
for _, e := range s.m.proxyPoolEntries() {
if e.ID == id && e.Enabled && strings.TrimSpace(e.RawURL) != "" {
res := s.runProxyProbe(r.Context(), e.RawURL, "", defaultEgressProbes, proxyPoolProbeTimeout)
res := s.runProxyProbe(r.Context(), e.RawURL, "", s.m.egressProbes(), proxyPoolProbeTimeout)
s.m.markProxyProbe(id, res)
if res.OK {
s.reconcileProxyPoolAfterProbe(id == s.m.proxyPoolActiveID())
+20
View File
@@ -3699,6 +3699,7 @@ func (s *Server) settingsPayload() map[string]any {
"proxy_reconnect_max_attempts": func() int { n, _ := s.proxyReconnectConfig(); return n }(),
"proxy_reconnect_interval_seconds": func() int { _, d := s.proxyReconnectConfig(); return int(d / time.Second) }(),
"show_egress_ip": s.m.pg.GetBool(settingShowEgressIP, false),
"egress_probe_url": s.m.EgressProbeURL(),
"python_interpreter": strings.TrimSpace(pyStored), // 用户/自动设的值(空=用运行时检测)
"workers": s.m.Workers(), // 并发工作 agent 数(默认3);对之后启动的任务生效
"worker_pools": s.m.WorkerPools(), // 非空时按池顺序绑定 worker 会话
@@ -3791,6 +3792,7 @@ func (s *Server) putSettings(w http.ResponseWriter, r *http.Request) {
ProxyReconnectMax *int `json:"proxy_reconnect_max_attempts"`
ProxyReconnectInterval *int `json:"proxy_reconnect_interval_seconds"`
ShowEgressIP *bool `json:"show_egress_ip"` // 在顶栏显示直连/全局代理出口 IP;默认关
EgressProbeURL *string `json:"egress_probe_url"` // null=不改;空串=默认公共探测服务
PythonInterp *string `json:"python_interpreter"` // 自定义脚本工具的 python 解释器路径
Workers *int `json:"workers"` // 并发工作 agent 数(>0);对之后启动的任务生效
WorkerPools *[]WorkerPool `json:"worker_pools"`
@@ -3816,6 +3818,18 @@ func (s *Server) putSettings(w http.ResponseWriter, r *http.Request) {
writeErr(w, 400, err.Error())
return
}
if req.EgressProbeURL != nil {
value := strings.TrimSpace(*req.EgressProbeURL)
if value != "" {
checked, err := validateProbeURL(value)
if err != nil {
writeErr(w, 400, err.Error())
return
}
value = checked
}
req.EgressProbeURL = &value
}
if req.ConstraintsInjectPlanner != nil {
if err := s.m.pg.SetBool(settingConstraintsInjectPlanner, *req.ConstraintsInjectPlanner); err != nil {
writeErr(w, 500, err.Error())
@@ -4060,6 +4074,12 @@ func (s *Server) putSettings(w http.ResponseWriter, r *http.Request) {
default:
}
}
if req.EgressProbeURL != nil {
if err := s.m.pg.SetSetting(settingEgressProbeURL, *req.EgressProbeURL); err != nil {
writeErr(w, 500, err.Error())
return
}
}
if req.ShowEgressIP != nil {
if err := s.m.pg.SetBool(settingShowEgressIP, *req.ShowEgressIP); err != nil {
writeErr(w, 500, err.Error())