Compare commits

..
Author SHA1 Message Date
BaaRai 7f3edf9bfe fix(agent): noise prompt states what the capture proxy paces
The low-and-slow block said that commands launched through Bash are not paced. With traffic capture on, Bash commands that use the capture proxy are now paced by rate and jitter; raw scanners and commands that bypass the proxy are not, so the rate flags remain the brake.
2026-11-15 01:23:56 +01:00
BaaRai 2e55615713 feat(traffic): pace Bash requests at the capture proxy
With traffic capture on, the Bash proxy URL carries a marker userinfo. The recording proxy drops Proxy-Authorization from every request before it is forwarded or recorded; when the value is the marker it marks the client connection, and every later request on it, including those inside its CONNECT tunnel, waits for the per-host token and jitter of the current noise profile (egress.Wait) and is counted, with a bounded wait. WebFetch, the http custom tools and enrich keep the unmarked URL, which egress already paces, so nothing is paced twice. Off paces nothing. Best effort: only clients that honour the proxy are covered, with capture on.
2026-11-15 00:57:13 +01:00
BaaRai 251ab680cc Merge pull request #233 from BaaRai/feat/noise-profile-runtime
feat(egress): change the noise profile at runtime
2026-11-15 00:14:23 +01:00
BaaRai ac6e2b3c44 feat(egress): change the noise profile at runtime
The egress governor is now a current governor that SetProfile swaps: new requests use the new one, requests in flight finish on the old one, and one package-level ticker logs the counters of the current governor. WebFetch, the http custom tools and the enrich probe resolve it per request, and the agent prompt block reads the current profile. The noise_profile setting (off, quiet, balanced, aggressive) is applied at startup and wins over ARTEX_NOISE_PROFILE, which stays the fallback; PUT /api/settings validates, stores and applies it without rebuilding agents, and GET /api/settings/noise returns the per-host counters without resetting them. System settings gets a Target noise card.
2026-11-14 23:30:06 +01:00
BaaRai 97b0fdced6 Merge pull request #232 from BaaRai/feat/intercept-risk-batch
feat(intercept): deterministic risk score and batch approval
2026-11-14 23:03:57 +01:00
25 changed files with 1227 additions and 53 deletions
+5
View File
@@ -4,6 +4,11 @@ All notable changes to this project are documented in this file. The format is b
## [Unreleased]
### Added
- **Noise profile at runtime**: System settings has a **Target noise** card. It sets the profile (`off`, `quiet`, `balanced`, `aggressive`) through the `noise_profile` setting, which takes precedence over `ARTEX_NOISE_PROFILE`. The change applies to the next WebFetch, http custom tool and enrich request, and to the next agent prompt, without a restart. The card also shows the per-host counters, which `GET /api/settings/noise` returns.
- **Bash requests paced through the capture proxy**: with traffic capture on, the Bash proxy URL carries a marker userinfo. The recording proxy paces each request of a marked connection by the noise profile's per-host rate and jitter, and counts it, before it goes upstream. This applies inside CONNECT tunnels too. WebFetch, the http custom tools and enrich keep the unmarked URL and are not paced twice. The proxy now drops `Proxy-Authorization` from every request it forwards or records. This is best effort: only clients that honour the proxy are covered, with capture on.
### Changed
- **Untrusted-output boundary is now on by default**: Norma frames tool results for the worker, planner, chat and main agent unless `ARTEX_UNTRUSTED_BOUNDARY` is set to `0`, `false`, `off` or `no`. It was opt-in via `ARTEX_UNTRUSTED_BOUNDARY=1` in 0.6.0 (#166).
+9 -2
View File
@@ -405,8 +405,15 @@ flight), `aggressive` = 20 req/s (burst 40, 4 in flight). A profile adds jitter,
429/503 (honours `Retry-After`, bounded retries, GET/HEAD/OPTIONS only), deduplicates identical
in-flight GETs and caches them briefly (60/30/10 s; never POST/PUT/PATCH/DELETE), and logs a
per-host noise line each minute. `ARTEX_TARGET_USER_AGENT` sets a User-Agent on target requests
that carry none. Bash-launched tools are not paced yet; the low-and-slow prompt block supplies
their rate flags.
that carry none. With traffic capture on, Bash commands that use the proxy (curl, wget,
python-requests) are paced too, per host by the same rate and jitter, and counted in the same
per-host lines. The in-flight caps, retries and cache apply only to ARTEX's own requests. This is
best effort, not a security boundary. Raw scanners such as nmap are not paced, and neither is a
command that bypasses the proxy (`--noproxy`, a removed proxy variable). With capture off,
nothing launched from Bash is paced. The low-and-slow prompt block supplies the rate flags in
every case.
The **Target noise** card in System settings sets the profile at runtime (no restart) and shows the
per-host counters; once saved, that setting takes precedence over `ARTEX_NOISE_PROFILE`.
**Low-and-slow agent guidance (off by default)**: when a noise profile is set, the planner, worker,
main agent and chat agents receive a code-owned prompt block with the profile's per-host limits and
+6 -5
View File
@@ -14,10 +14,11 @@ import (
// prompts stay byte-for-byte unchanged by default.
const noiseProfileHeader = "[Noise profile: "
// noiseProfileBlock returns the low-and-slow guidance for the active noise
// profile (ARTEX_NOISE_PROFILE), or "" when the profile is off. The text is
// code-owned and carries no target data.
func noiseProfileBlock() string { return renderNoiseProfile(egress.ProfileFromEnv()) }
// noiseProfileBlock returns the low-and-slow guidance for the current noise
// profile (the noise_profile setting, else ARTEX_NOISE_PROFILE), or "" when the
// profile is off. It is read at each prompt build, so a changed setting shows in
// the next prompt. The text is code-owned and carries no target data.
func noiseProfileBlock() string { return renderNoiseProfile(egress.CurrentProfile()) }
// renderNoiseProfile renders the block for one profile. It is pure: tests cover
// every profile without touching the environment.
@@ -63,6 +64,6 @@ func renderNoiseProfile(p egress.Profile) string {
fmt.Fprintf(&b, "- sqlmap: --delay=%s --threads=1\n", delaySec)
fmt.Fprintf(&b, "For any other tool, stay at or below %d requests per second per host, at most %s in flight, and at least %d ms between requests, using the tool's own rate or delay flag. Keep bbot within the same limits with its own rate settings, and do not enable active modules the program policy does not allow.\n", rps, inFlight, delayMS)
b.WriteString("Prefer passive and read-only checks; test one host at a time; do not run two scanners against the same host in parallel; on 429 or 503 stop and back off; never raise the rate to meet a deadline.\n")
b.WriteString("ARTEX paces its own WebFetch, http custom tool and enrich traffic with this profile, but commands launched through Bash are not paced: these flags are the only brake.\n")
b.WriteString("ARTEX paces its own WebFetch, http custom tool and enrich traffic with this profile. With traffic capture on, Bash commands that use the capture proxy (curl, wget, python-requests) are paced too, by rate and jitter; raw scanners such as nmap and commands that bypass the proxy are not. These flags remain the brake: do not rely on the proxy.\n")
return b.String()
}
+16 -11
View File
@@ -41,7 +41,7 @@ func TestRenderNoiseProfileTable(t *testing.T) {
fmt.Sprintf("- dalfox scan: --rate-limit %d --workers %d", c.rps, c.conc),
fmt.Sprintf("- sqlmap: --delay=%s --threads=1", c.sql),
fmt.Sprintf("at least %d ms between requests", c.delay),
"commands launched through Bash are not paced",
"ARTEX paces its own WebFetch, http custom tool and enrich traffic with this profile. With traffic capture on, Bash commands that use the capture proxy (curl, wget, python-requests) are paced too, by rate and jitter; raw scanners such as nmap and commands that bypass the proxy are not. These flags remain the brake: do not rely on the proxy.",
} {
if !strings.Contains(got, want) {
t.Errorf("%s: missing %q in:\n%s", c.name, want, got)
@@ -59,18 +59,23 @@ func TestPromptBuildersNoiseBlock(t *testing.T) {
"mainagent": func() string { return mainAgentSystem("goal", "/data", "/work") },
"chat": func() string { return chatSystem("auto", "/data", "/work") },
}
for _, env := range []string{"", "off"} {
t.Setenv("ARTEX_NOISE_PROFILE", env)
prev := egress.CurrentProfile()
t.Cleanup(func() { egress.SetProfile(prev) })
// The block follows the current profile, not the environment.
t.Setenv("ARTEX_NOISE_PROFILE", "aggressive")
egress.SetProfile(egress.Profile{Name: "off"})
for name, build := range builders {
if got := build(); strings.Contains(got, noiseProfileHeader) {
t.Errorf("%s with profile off contains the noise block", name)
}
}
for _, profile := range []string{"quiet", "balanced"} {
egress.SetProfile(egress.Profiles[profile])
for name, build := range builders {
if got := build(); strings.Contains(got, noiseProfileHeader) {
t.Errorf("%s with profile %q contains the noise block", name, env)
got := build()
if !strings.Contains(got, noiseProfileHeader+profile) || strings.Contains(got, noiseProfileHeader+"aggressive") {
t.Errorf("%s after SetProfile(%s) is missing its block or shows the env profile", name, profile)
}
}
}
t.Setenv("ARTEX_NOISE_PROFILE", "quiet")
for name, build := range builders {
if got := build(); !strings.Contains(got, noiseProfileHeader+"quiet") {
t.Errorf("%s with quiet is missing the noise block", name)
}
}
}
+23
View File
@@ -49,3 +49,26 @@ func TestProxyEnvInjectsCAWhenRecording(t *testing.T) {
}
}
}
// Only the recording proxy (a CA is present) gets the pace marker; the global
// proxy of the capture-off path is passed as configured.
func TestProxyEnvMarksOnlyTheRecordingProxy(t *testing.T) {
proxyVars := map[string]bool{"HTTP_PROXY": true, "HTTPS_PROXY": true, "ALL_PROXY": true}
check := func(env []string, want, what string) {
t.Helper()
n := 0
for _, e := range env {
if k, v, _ := strings.Cut(e, "="); proxyVars[strings.ToUpper(k)] {
n++
if v != want {
t.Errorf("%s: %s, want %s", what, e, want)
}
}
}
if n != 6 {
t.Errorf("%s: %d proxy variables, want 6", what, n)
}
}
check(proxyEnv("http://127.0.0.1:8788", "/data/ca.pem"), "http://artex-pace:artex-pace@127.0.0.1:8788", "capture on")
check(proxyEnv("http://u:p@10.0.0.1:3128", ""), "http://u:p@10.0.0.1:3128", "capture off")
}
+5 -5
View File
@@ -27,11 +27,12 @@ func withWebFetch(ctx context.Context, tools []actool.CoreTool, proxy, caCert st
gated := scoped && scope.Enabled != nil && scope.Enabled()
webFetch := actool.NewWebFetch(actool.WebFetchConfig{Proxy: proxy, CACert: caCert, CheckRedirect: intercept.RedirectCheck("WebFetch"),
DialContext: intercept.PinnedDialer("WebFetch", scoped), DisableDirectRetry: gated})
return append(tools[:len(tools):len(tools)], governedFetch{webFetch, egressGovernor()})
return append(tools[:len(tools):len(tools)], governedFetch{webFetch})
}
// egressGovernor is the governor of WebFetch; a test may pin it.
var egressGovernor = egress.Shared
// egressGovernor resolves the governor of a WebFetch call, once per call so a
// changed noise profile applies to the next call; a test may pin it.
var egressGovernor = egress.Current
// governedFetch runs each WebFetch call as one send under the egress governor
// (off by default; then the call runs unchanged). Under a noise profile it
@@ -42,7 +43,6 @@ var egressGovernor = egress.Shared
// 429/503 is not retried.
type governedFetch struct {
actool.CoreTool
g *egress.Governor
}
func (f governedFetch) Call(ctx context.Context, input json.RawMessage, tc *actool.ToolContext) (actool.Result, error) {
@@ -56,7 +56,7 @@ func (f governedFetch) Call(ctx context.Context, input json.RawMessage, tc *acto
if err != nil || u.Host == "" {
return f.CoreTool.Call(ctx, input, tc) // the tool reports the bad URL
}
return egress.Do(f.g, ctx, u, func() (actool.Result, error) {
return egress.Do(egressGovernor(), ctx, u, func() (actool.Result, error) {
return f.CoreTool.Call(ctx, input, tc)
})
}
+5 -1
View File
@@ -27,7 +27,11 @@ func TestWebFetchProfileDoesNotCache(t *testing.T) {
checks.Add(1)
return nil
}})
tool := governedFetch{inner, egress.New(egress.Profiles["balanced"])}
balanced := egress.New(egress.Profiles["balanced"])
old := egressGovernor
egressGovernor = func() *egress.Governor { return balanced }
t.Cleanup(func() { egressGovernor = old })
tool := governedFetch{inner}
ctx := intercept.WithTargetScope(t.Context(), intercept.TargetScope{TaskID: "7"})
for range 2 {
res, err := tool.Call(ctx, json.RawMessage(fetchInputJSON(pair.start)), &actool.ToolContext{})
+10
View File
@@ -11,6 +11,7 @@ import (
"time"
"github.com/Autumn-27/artex/db"
"github.com/Autumn-27/artex/egress"
"github.com/Autumn-27/artex/intercept"
"github.com/Autumn-27/norma/agentcore"
"github.com/Autumn-27/norma/harness"
@@ -212,10 +213,19 @@ func (w *Worker) SetWebSearch(o WebSearchOpts) { w.webSearch = o }
// honor the proxy vars. ALL_PROXY is set too so a socks5 egress proxy (which curl
// only reads from ALL_PROXY, not HTTP(S)_PROXY) works in the capture-off path.
// Empty proxyAddr → nil (direct, unchanged env).
//
// With a MITM CA (capture on) the proxy URL carries the pace marker userinfo
// (egress.MarkProxyURL): the recording proxy then paces this connection's
// requests by the noise profile. Only Bash gets the marker; WebFetch, the http
// custom tools and enrich keep the plain URL, since egress paces them already.
// The global proxy (capture off) is left as configured.
func proxyEnv(proxyAddr, caCert string) []string {
if proxyAddr == "" {
return nil
}
if caCert != "" {
proxyAddr = egress.MarkProxyURL(proxyAddr)
}
env := []string{
"HTTP_PROXY=" + proxyAddr, "HTTPS_PROXY=" + proxyAddr,
"http_proxy=" + proxyAddr, "https_proxy=" + proxyAddr,
+179
View File
@@ -0,0 +1,179 @@
package egress
import (
"net/http"
"net/http/httptest"
"net/url"
"runtime"
"sync"
"testing"
)
// keepProfile restores the process profile after a test that changes it.
func keepProfile(t *testing.T) {
prev := CurrentProfile()
t.Cleanup(func() { SetProfile(prev) })
}
func TestSetProfileConcurrentAndConsistent(t *testing.T) {
keepProfile(t)
names := []string{"off", "quiet", "balanced", "aggressive"}
var wg sync.WaitGroup
for i := range 8 {
wg.Add(1)
go func() {
defer wg.Done()
for j := range 200 {
p, _ := ProfileByName(names[(i+j)%len(names)])
SetProfile(p)
if g := Current(); g == nil || g.Profile().Name == "" {
t.Errorf("Current() = %v during swaps", g)
return
}
_ = CurrentProfile()
}
}()
}
wg.Wait()
for _, name := range names {
p, _ := ProfileByName(name)
g := SetProfile(p)
if Current() != g || CurrentProfile().Name != name || Current().Profile() != CurrentProfile() {
t.Fatalf("after SetProfile(%s): Current=%p want %p, CurrentProfile=%q", name, Current(), g, CurrentProfile().Name)
}
}
}
// A request in flight keeps the governor it started on: its release frees the
// old governor's slots, and the new governor starts with no counter.
func TestSetProfileInFlightFinishesOnOldGovernor(t *testing.T) {
keepProfile(t)
old := SetProfile(open)
release, err := old.acquire(t.Context(), "a.example")
if err != nil {
t.Fatal(err)
}
fresh := SetProfile(Profiles["balanced"])
if Current() != fresh || len(fresh.Snapshot()) != 0 {
t.Fatalf("new governor: current=%p fresh=%p snapshot=%v", Current(), fresh, fresh.Snapshot())
}
if s := old.Snapshot(); len(s) != 1 || s[0].Inflight != 1 {
t.Fatalf("old governor before release: %+v", s)
}
release()
if s := old.Snapshot(); len(s) != 1 || s[0].Inflight != 0 || s[0].RPM != 1 || s[0].PeakInflight != 1 {
t.Fatalf("old governor after release: %+v", s)
}
}
type recordRT struct{ got *http.Request }
func (r *recordRT) RoundTrip(req *http.Request) (*http.Response, error) {
r.got = req
return &http.Response{StatusCode: 204, Body: http.NoBody, Request: req}, nil
}
// Off stays a strict passthrough, through Transport and Dynamic alike.
func TestOffIsPassthroughAfterSetProfile(t *testing.T) {
keepProfile(t)
t.Setenv("ARTEX_TARGET_USER_AGENT", "artex-test/1")
off, ok := ProfileByName("OFF")
if !ok || off.Name != "off" || off.UserAgent != "" {
t.Fatalf("ProfileByName(OFF) = %+v %v", off, ok)
}
SetProfile(off)
base := &recordRT{}
if tr := Current().Transport("x", base); tr != http.RoundTripper(base) {
t.Fatalf("off Transport = %T, want the base itself", tr)
}
req := httptest.NewRequest(http.MethodGet, "http://a.example/", nil)
if _, err := Dynamic("x", base).RoundTrip(req); err != nil || base.got != req || req.Header.Get("User-Agent") != "" {
t.Fatalf("off Dynamic: err=%v same request=%v UA=%q", err, base.got == req, req.Header.Get("User-Agent"))
}
if len(Current().Snapshot()) != 0 {
t.Fatalf("off counted a request: %v", Current().Snapshot())
}
// Any other profile carries the user agent.
if p, _ := ProfileByName("balanced"); p.UserAgent != "artex-test/1" {
t.Fatalf("balanced UserAgent = %q", p.UserAgent)
}
if _, ok := ProfileByName(""); ok {
t.Fatal(`ProfileByName("") accepted`)
}
if _, ok := ProfileByName("loud"); ok {
t.Fatal(`ProfileByName("loud") accepted`)
}
}
// Dynamic resolves the governor per request: a client built before
// SetProfile is paced by the new profile.
func TestDynamicFollowsSetProfile(t *testing.T) {
keepProfile(t)
srv := newServer(t, 0, nil)
SetProfile(Profile{Name: "off"})
client := &http.Client{Transport: Dynamic("ns", nil)}
get := func() {
t.Helper()
resp, err := client.Get(srv.URL)
if err != nil {
t.Fatal(err)
}
resp.Body.Close()
}
get()
g := SetProfile(open)
get()
get()
if s := g.Snapshot(); len(s) != 1 || s[0].RPM != 2 {
t.Fatalf("snapshot after switch: %+v", s)
}
}
// Snapshot reads the counters without starting a new minute; report does.
func TestSnapshotDoesNotReset(t *testing.T) {
g := New(open)
srv := newServer(t, 0, nil)
tr := g.Transport("ns", nil)
for range 3 {
req, _ := http.NewRequest(http.MethodGet, srv.URL, nil)
resp, err := tr.RoundTrip(req)
if err != nil {
t.Fatal(err)
}
resp.Body.Close()
}
want := HostNoise{Host: HostKey(srvURL(t, srv.URL)), RPM: 3, PeakRPM: 3, PeakInflight: 1}
for range 2 {
if s := g.Snapshot(); len(s) != 1 || s[0] != want {
t.Fatalf("snapshot = %+v, want [%+v]", s, want)
}
}
g.report()
if s := g.Snapshot(); len(s) != 1 || s[0].RPM != 0 || s[0].PeakRPM != 3 {
t.Fatalf("snapshot after report = %+v, want rpm 0 and peak 3", s)
}
}
// SetProfile never starts a goroutine of its own: one ticker serves every
// governor.
func TestSetProfileStartsNoGoroutine(t *testing.T) {
keepProfile(t)
SetProfile(Profiles["quiet"]) // the reporter is running from here on
before := runtime.NumGoroutine()
for range 50 {
SetProfile(Profiles["balanced"])
SetProfile(Profile{Name: "off"})
}
if after := runtime.NumGoroutine(); after > before {
t.Fatalf("goroutines %d -> %d after 100 SetProfile calls", before, after)
}
}
func srvURL(t *testing.T, raw string) *url.URL {
t.Helper()
u, err := url.Parse(raw)
if err != nil {
t.Fatal(err)
}
return u
}
+124 -22
View File
@@ -1,6 +1,7 @@
// Package egress is the governor the platform-owned HTTP requests to a target
// pass through (WebFetch, the http custom tools, the enrich probe). A noise
// profile (ARTEX_NOISE_PROFILE) sets every lever: a token bucket, a jitter and a
// profile (the noise_profile setting, else ARTEX_NOISE_PROFILE; SetProfile
// changes it at runtime) sets every lever: a token bucket, a jitter and a
// concurrency cap per host, a global concurrency cap, backoff on 429/503, and,
// for the GET requests of one task, coalescing and a short cache. The default
// profile, off, is a strict passthrough: requests and timing are unchanged.
@@ -22,6 +23,7 @@ import (
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
"unicode"
@@ -54,42 +56,91 @@ var Profiles = map[string]Profile{
"aggressive": {Name: "aggressive", RPS: 20, Burst: 40, MaxPerHost: 4, MaxGlobal: 32, Jitter: 0.1, CacheTTL: 10 * time.Second, MaxRetries: 2, BaseDelay: 500 * time.Millisecond, MaxDelay: 10 * time.Second},
}
// ProfileFromEnv returns the profile ARTEX_NOISE_PROFILE names; unset, "off" or
// unknown is off.
func ProfileFromEnv() Profile {
name := strings.ToLower(strings.TrimSpace(os.Getenv("ARTEX_NOISE_PROFILE")))
p, ok := Profiles[name]
if !ok {
if name != "" && name != "off" {
log.Printf("[egress] ARTEX_NOISE_PROFILE=%q is not off, quiet, balanced or aggressive; using off", name)
}
return Profile{Name: "off"}
// ProfileByName returns the profile name names (off, quiet, balanced or
// aggressive, any case); ok is false for any other name, "" included. A profile
// other than off carries ARTEX_TARGET_USER_AGENT; off stays a strict passthrough.
func ProfileByName(name string) (p Profile, ok bool) {
name = strings.ToLower(strings.TrimSpace(name))
if name == "off" {
return Profile{Name: "off"}, true
}
if p, ok = Profiles[name]; !ok {
return Profile{Name: "off"}, false
}
if ua := strings.TrimSpace(os.Getenv("ARTEX_TARGET_USER_AGENT")); strings.ContainsFunc(ua, unicode.IsControl) {
log.Printf("[egress] ARTEX_TARGET_USER_AGENT contains a control character; ignored")
} else {
p.UserAgent = ua
}
return p, true
}
// ProfileFromEnv returns the profile ARTEX_NOISE_PROFILE names; unset, "off" or
// unknown is off.
func ProfileFromEnv() Profile {
name := strings.TrimSpace(os.Getenv("ARTEX_NOISE_PROFILE"))
p, ok := ProfileByName(name)
if !ok && name != "" {
log.Printf("[egress] ARTEX_NOISE_PROFILE=%q is not off, quiet, balanced or aggressive; using off", name)
}
return p
}
// Shared is the one governor of the process, built from the environment on
// first use; WebFetch, the http custom tools and the enrich probe all use it.
// Under a profile it logs the noise counter of each host once a minute.
var Shared = sync.OnceValue(func() *Governor {
g := New(ProfileFromEnv())
// current is the governor new requests use. SetProfile replaces it; a request
// already in flight keeps the governor it started on, so its slots are
// released where they were taken.
var (
current atomic.Pointer[Governor]
initCurrent sync.Once
reporterOnce sync.Once
)
// Current returns the governor of the process: the one SetProfile published
// last, or, before any SetProfile, one built from the environment on first use.
// WebFetch, the http custom tools and the enrich probe resolve it per request.
func Current() *Governor {
if g := current.Load(); g != nil {
return g
}
initCurrent.Do(func() {
g := New(ProfileFromEnv())
if current.CompareAndSwap(nil, g) {
log.Printf("[egress] noise profile: %s", g.p.Name)
}
startReporter()
})
return current.Load()
}
// CurrentProfile is the profile of Current.
func CurrentProfile() Profile { return Current().p }
// SetProfile builds a governor for p and publishes it: new requests use it,
// requests in flight finish on the previous one. The counters start afresh.
func SetProfile(p Profile) *Governor {
g := New(p)
current.Store(g)
log.Printf("[egress] noise profile: %s", g.p.Name)
if !g.off() {
startReporter()
return g
}
// startReporter starts the one package-level ticker that logs, once a minute,
// the noise counter of each host of the current governor. SetProfile never
// starts another.
func startReporter() {
reporterOnce.Do(func() {
go func() {
for range time.Tick(time.Minute) {
for _, l := range g.report() {
t := time.NewTicker(time.Minute)
defer t.Stop()
for range t.C {
for _, l := range Current().report() {
log.Print(l)
}
}
}()
}
return g
})
})
}
// Governor holds the per-host state and the per-task response cache.
type Governor struct {
@@ -123,6 +174,9 @@ func New(p Profile) *Governor {
func (g *Governor) off() bool { return g.p.RPS <= 0 }
// Profile is the profile g was built for.
func (g *Governor) Profile() Profile { return g.p }
// HostKey is the lowercased host, with the port when it is not the default.
func HostKey(u *url.URL) string {
h, p := strings.ToLower(u.Hostname()), u.Port()
@@ -240,6 +294,35 @@ func (g *Governor) report() []string {
return out
}
// HostNoise is the noise counter of one host: the current minute (RPM,
// DuplicatesAvoided, PeakInflight), the peak per minute so far, and the
// requests in flight now.
type HostNoise struct {
Host string `json:"host"`
RPM int `json:"rpm"`
PeakRPM int `json:"peak_rpm"`
PeakInflight int `json:"peak_inflight"`
Inflight int `json:"inflight"`
DuplicatesAvoided int `json:"duplicates_avoided"`
}
// Snapshot returns the counter of every host that has sent or deduplicated a
// request, sorted by host. Unlike report it starts no new minute.
func (g *Governor) Snapshot() []HostNoise {
g.mu.Lock()
defer g.mu.Unlock()
out := []HostNoise{}
for key, h := range g.hosts {
if h.sent == 0 && h.dupes == 0 && h.inflight == 0 && h.peakRPM == 0 {
continue
}
out = append(out, HostNoise{Host: key, RPM: h.sent, PeakRPM: max(h.peakRPM, h.sent),
PeakInflight: h.peakInflight, Inflight: h.inflight, DuplicatesAvoided: h.dupes})
}
sort.Slice(out, func(i, j int) bool { return out[i].Host < out[j].Host })
return out
}
var errNotShared = errors.New("egress: response not shared")
// share runs fn once for the concurrent callers of key and keeps its value for
@@ -344,6 +427,25 @@ type transport struct {
base http.RoundTripper
}
// Dynamic returns base (nil: http.DefaultTransport) governed by the governor
// current at each request, for a client built once and kept: a later
// SetProfile applies to its next request. Off, the request goes to base as is.
func Dynamic(namespace string, base http.RoundTripper) http.RoundTripper {
if base == nil {
base = http.DefaultTransport
}
return dynamicTransport{namespace, base}
}
type dynamicTransport struct {
namespace string
base http.RoundTripper
}
func (d dynamicTransport) RoundTrip(req *http.Request) (*http.Response, error) {
return Current().Transport(d.namespace, d.base).RoundTrip(req)
}
const maxSharedBody = 2 << 20 // a larger response is neither coalesced nor cached
func (t *transport) RoundTrip(req *http.Request) (*http.Response, error) {
+67
View File
@@ -0,0 +1,67 @@
package egress
import (
"context"
"encoding/base64"
"net/url"
"strings"
)
// Bash commands reach targets through the recording proxy, outside the clients
// this package governs. With traffic capture on, the proxy URL in their
// environment carries a marker userinfo (MarkProxyURL). The proxy paces each
// request of a marked client connection with Wait, and leaves unmarked
// connections alone: WebFetch, the http custom tools and the enrich probe use
// the plain proxy URL and are already paced by their governor, so no request
// is paced twice. Best effort, not a security boundary: a command that ignores
// the proxy, or drops the marker, is not paced.
// PaceUser is the user and password of the marker userinfo.
const PaceUser = "artex-pace"
// MarkProxyURL returns raw with the marker userinfo. raw is returned unchanged
// when it does not parse or already carries a userinfo.
func MarkProxyURL(raw string) string {
u, err := url.Parse(raw)
if err != nil || u.Host == "" || u.User != nil {
return raw
}
u.User = url.UserPassword(PaceUser, PaceUser)
return u.String()
}
// IsPaceMarker reports whether a Proxy-Authorization value is Basic
// credentials for PaceUser.
func IsPaceMarker(proxyAuthorization string) bool {
scheme, enc, ok := strings.Cut(strings.TrimSpace(proxyAuthorization), " ")
if !ok || !strings.EqualFold(scheme, "Basic") {
return false
}
dec, err := base64.StdEncoding.DecodeString(strings.TrimSpace(enc))
if err != nil {
return false
}
user, _, _ := strings.Cut(string(dec), ":")
return user == PaceUser
}
// Wait paces one request to hostKey under the current profile. See
// Governor.Wait.
func Wait(ctx context.Context, hostKey string) error { return Current().Wait(ctx, hostKey) }
// Wait takes a token of the host's bucket plus the jitter, as a governed request
// does, and counts the request in the host's noise counter. It takes no
// in-flight slot, and nothing is cached, coalesced or retried. Off, it returns
// at once and counts nothing. An error means ctx ended first; the request is
// counted either way, since the caller sends it regardless.
func (g *Governor) Wait(ctx context.Context, hostKey string) error {
if g.off() {
return nil
}
h := g.host(hostKey)
err := sleep(ctx, g.reserve(h)+g.jitter())
g.mu.Lock()
h.sent++
g.mu.Unlock()
return err
}
+85
View File
@@ -0,0 +1,85 @@
package egress
import (
"context"
"encoding/base64"
"errors"
"testing"
"time"
)
func TestMarkProxyURL(t *testing.T) {
for in, want := range map[string]string{
"http://127.0.0.1:8788": "http://artex-pace:artex-pace@127.0.0.1:8788",
"http://u:p@127.0.0.1:8788": "http://u:p@127.0.0.1:8788",
"": "",
"127.0.0.1:8788": "127.0.0.1:8788",
"socks5://proxy.example.test:1080": "socks5://artex-pace:artex-pace@proxy.example.test:1080",
} {
if got := MarkProxyURL(in); got != want {
t.Errorf("MarkProxyURL(%q) = %q, want %q", in, got, want)
}
}
}
func TestIsPaceMarker(t *testing.T) {
enc := func(s string) string { return base64.StdEncoding.EncodeToString([]byte(s)) }
for v, want := range map[string]bool{
"Basic " + enc("artex-pace:artex-pace"): true,
"basic " + enc("artex-pace:x"): true,
"Basic " + enc("user:pass"): false,
"Bearer " + enc("artex-pace:artex-pace"): false,
"Basic !!!": false,
"Basic": false,
"": false,
} {
if got := IsPaceMarker(v); got != want {
t.Errorf("IsPaceMarker(%q) = %v, want %v", v, got, want)
}
}
}
func TestWait(t *testing.T) {
if err := New(Profile{Name: "off"}).Wait(t.Context(), "a.example"); err != nil {
t.Fatalf("off Wait: %v", err)
}
off := New(Profile{Name: "off"})
_ = off.Wait(t.Context(), "a.example")
if s := off.Snapshot(); len(s) != 0 {
t.Fatalf("off counted: %v", s)
}
// 10 req/s, burst 1, no jitter: the second Wait takes ~100 ms.
g := New(Profile{Name: "test", RPS: 10, Burst: 1, MaxPerHost: 1, MaxGlobal: 1})
start := time.Now()
for range 2 {
if err := g.Wait(t.Context(), "a.example"); err != nil {
t.Fatal(err)
}
}
if d := time.Since(start); d < 80*time.Millisecond {
t.Fatalf("two Waits at 10 req/s took %v", d)
}
if s := g.Snapshot(); len(s) != 1 || s[0].RPM != 2 || s[0].Inflight != 0 || s[0].PeakInflight != 0 {
t.Fatalf("snapshot after Wait = %+v, want rpm 2 and no in-flight slot", s)
}
// A wait past the context's end returns its error and still counts.
slow := New(Profile{Name: "test", RPS: 0.5, Burst: 1, MaxPerHost: 1, MaxGlobal: 1})
_ = slow.Wait(t.Context(), "b.example")
ctx, cancel := context.WithTimeout(t.Context(), 20*time.Millisecond)
defer cancel()
if err := slow.Wait(ctx, "b.example"); !errors.Is(err, context.DeadlineExceeded) {
t.Fatalf("bounded Wait: %v, want DeadlineExceeded", err)
}
if s := slow.Snapshot(); len(s) != 1 || s[0].RPM != 2 {
t.Fatalf("snapshot after a timed-out Wait = %+v, want rpm 2", s)
}
// The package Wait uses the current profile.
keepProfile(t)
SetProfile(Profile{Name: "off"})
if err := Wait(t.Context(), "c.example"); err != nil || len(Current().Snapshot()) != 0 {
t.Fatalf("package Wait under off: err=%v snapshot=%v", err, Current().Snapshot())
}
}
+3 -2
View File
@@ -99,7 +99,8 @@ func New(as *db.AssetStore, proxy func() string, workers int) *Engine {
// probe without a scope is refused. When the scope's gate is on, the probe
// connects to the target itself, without the proxy, so that the dialer decides
// on the target and connects only to the addresses a pin covers. Every request
// goes through the shared egress governor (the noise profile; off by default).
// goes through the egress governor current at that request (the noise profile;
// off by default), so a changed profile applies without rebuilding the client.
func buildClient(proxy func() string) *http.Client {
tr := &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
@@ -120,7 +121,7 @@ func buildClient(proxy func() string) *http.Client {
}
}
return &http.Client{
Transport: egress.Shared().Transport("enrich", tr),
Transport: egress.Dynamic("enrich", tr),
Timeout: httpTimeout,
// cap redirects; keep them within scope by re-checking at probe time
CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse },
+4 -3
View File
@@ -566,13 +566,14 @@ func (s *Server) runHTTPTool(ctx context.Context, key string, execRaw json.RawMe
client := &http.Client{Timeout: timeoutOr(spec.TimeoutMs, 30000)}
// Every redirect hop goes through the target gate, as the rendered URL did.
client.CheckRedirect = intercept.RedirectCheck(key)
// The shared egress governor paces every request and redirect hop per host
// under the noise profile (off by default: the base transport itself).
// The current egress governor paces every request and redirect hop per host
// under the noise profile (off by default: the base transport itself). It is
// resolved per request, so a changed profile applies to the next call.
var base http.RoundTripper = http.DefaultTransport
if tr := s.httpToolTransport(ctx, key, spec); tr != nil {
base = tr
}
client.Transport = egress.Shared().Transport(key, base)
client.Transport = egress.Current().Transport(key, base)
resp, err := client.Do(req)
if err != nil {
return actool.Errorf("request failed: " + err.Error()), nil
+5
View File
@@ -19,6 +19,7 @@ import (
"github.com/Autumn-27/artex/agent"
"github.com/Autumn-27/artex/config"
pgdb "github.com/Autumn-27/artex/db"
"github.com/Autumn-27/artex/egress"
"github.com/Autumn-27/artex/enrich"
"github.com/Autumn-27/artex/guard"
"github.com/Autumn-27/artex/intercept"
@@ -304,6 +305,9 @@ const (
// when on, the four agent kinds wired into the platform (planner/worker/main
// agent/chat) have context compaction taken over by noa, replacing the built-in compaction. Read once per run; toggling affects only runs started afterwards.
settingNoaCompaction = "noa_compaction"
// Target noise profile (off|quiet|balanced|aggressive). When stored it wins over
// ARTEX_NOISE_PROFILE, which stays the fallback; applied at startup and on PUT.
settingNoiseProfile = "noise_profile"
// defaultWebSearchBackend is used when web search is on but no backend was picked.
defaultWebSearchBackend = "ddgs"
// deepSeekWebSearchBackend borrows the active LLM profile instead of its own
@@ -401,6 +405,7 @@ func NewManager(dir, proxyAddr string) (*Manager, error) {
pg.Close()
return nil, fmt.Errorf("recover finding retests: %w", err)
}
egress.SetProfile(startupNoiseProfile(pg))
if err := pg.EnsureLLMRecordsTable(); err != nil {
log.Printf("[llmrec] create table: %v", err)
}
+32
View File
@@ -0,0 +1,32 @@
package server
import (
"log"
"net/http"
"github.com/Autumn-27/artex/db"
"github.com/Autumn-27/artex/egress"
)
// startupNoiseProfile is the noise profile to apply at startup: the stored
// noise_profile setting when there is a valid one, else ARTEX_NOISE_PROFILE.
func startupNoiseProfile(pg *db.DB) egress.Profile {
v, ok, err := pg.GetSetting(settingNoiseProfile)
if err != nil {
log.Printf("[egress] read %s setting: %v; using ARTEX_NOISE_PROFILE", settingNoiseProfile, err)
}
if ok {
if p, valid := egress.ProfileByName(v); valid {
return p
}
log.Printf("[egress] stored %s=%q is not off, quiet, balanced or aggressive; using ARTEX_NOISE_PROFILE", settingNoiseProfile, v)
}
return egress.ProfileFromEnv()
}
// noiseStatus returns the current noise profile and the per-host counters of
// its governor, read without starting a new minute.
func (s *Server) noiseStatus(w http.ResponseWriter, r *http.Request) {
g := egress.Current()
writeJSON(w, 200, map[string]any{"profile": g.Profile().Name, "hosts": g.Snapshot()})
}
+125
View File
@@ -0,0 +1,125 @@
package server
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
"github.com/Autumn-27/artex/egress"
)
func TestNoiseProfileSettingHTTP(t *testing.T) {
skipWithoutDSN(t)
prev := egress.CurrentProfile()
t.Cleanup(func() { egress.SetProfile(prev) })
t.Setenv("ARTEX_NOISE_PROFILE", "quiet")
t.Setenv("ARTEX_TARGET_USER_AGENT", "artex-noise-test/1")
m, err := NewManager(t.TempDir(), "")
if err != nil {
t.Fatal(err)
}
defer m.Close()
clear := func() {
if _, err := m.pg.Exec(`DELETE FROM settings WHERE key=$1`, settingNoiseProfile); err != nil {
t.Error(err)
}
}
clear()
defer clear() // before m.Close
// Precedence: no setting -> env; a valid setting wins; an invalid one falls back to env.
if p := startupNoiseProfile(m.pg); p.Name != "quiet" {
t.Fatalf("no setting: %q, want env quiet", p.Name)
}
if err := m.pg.SetSetting(settingNoiseProfile, "balanced"); err != nil {
t.Fatal(err)
}
m2, err := NewManager(t.TempDir(), "")
if err != nil {
t.Fatal(err)
}
m2.Close()
if p := egress.CurrentProfile(); p.Name != "balanced" || p.UserAgent != "artex-noise-test/1" {
t.Fatalf("NewManager with setting balanced applied %+v", p)
}
if err := m.pg.SetSetting(settingNoiseProfile, "loud"); err != nil {
t.Fatal(err)
}
if p := startupNoiseProfile(m.pg); p.Name != "quiet" {
t.Fatalf("invalid setting: %q, want env quiet", p.Name)
}
if err := m.pg.SetSetting(settingNoiseProfile, "balanced"); err != nil {
t.Fatal(err)
}
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, t.TempDir(), t.TempDir(), t.TempDir())
defer stopTestServer(t, s, cancel)
token, err := signJWT(s.jwtKey)
if err != nil {
t.Fatal(err)
}
do := func(method, path, body string) (int, map[string]any) {
t.Helper()
req := httptest.NewRequest(method, path, strings.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
rec := httptest.NewRecorder()
s.Handler().ServeHTTP(rec, req)
var out map[string]any
_ = json.Unmarshal(rec.Body.Bytes(), &out)
return rec.Code, out
}
egress.SetProfile(egress.Profiles["balanced"])
if code, out := do(http.MethodGet, "/api/settings", ""); code != 200 || out["noise_profile"] != "balanced" {
t.Fatalf("GET settings: %d noise_profile=%v", code, out["noise_profile"])
}
if code, out := do(http.MethodPut, "/api/settings", `{"noise_profile":"Aggressive"}`); code != 200 || out["noise_profile"] != "aggressive" {
t.Fatalf("PUT aggressive: %d noise_profile=%v", code, out["noise_profile"])
}
if v, _, _ := m.pg.GetSetting(settingNoiseProfile); v != "aggressive" || egress.CurrentProfile().Name != "aggressive" {
t.Fatalf("after PUT: stored %q, current %q", v, egress.CurrentProfile().Name)
}
for _, bad := range []string{`{"noise_profile":"loud"}`, `{"noise_profile":""}`, `{"noise_profile":1}`} {
if code, _ := do(http.MethodPut, "/api/settings", bad); code != 400 {
t.Errorf("PUT %s: %d, want 400", bad, code)
}
}
if code, out := do(http.MethodPut, "/api/settings", `{"noise_profile":null}`); code != 200 || out["noise_profile"] != "aggressive" {
t.Fatalf("PUT null: %d noise_profile=%v, want unchanged", code, out["noise_profile"])
}
if v, _, _ := m.pg.GetSetting(settingNoiseProfile); v != "aggressive" || egress.CurrentProfile().Name != "aggressive" {
t.Fatalf("after invalid and null PUTs: stored %q, current %q", v, egress.CurrentProfile().Name)
}
// The noise endpoint reads the current governor's counters.
target := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
defer target.Close()
req, _ := http.NewRequest(http.MethodGet, target.URL, nil)
resp, err := egress.Current().Transport("noise-test", nil).RoundTrip(req)
if err != nil {
t.Fatal(err)
}
resp.Body.Close()
code, out := do(http.MethodGet, "/api/settings/noise", "")
hosts, _ := out["hosts"].([]any)
if code != 200 || out["profile"] != "aggressive" || len(hosts) != 1 {
t.Fatalf("GET noise: %d %v", code, out)
}
host, _ := hosts[0].(map[string]any)
for _, key := range []string{"host", "rpm", "peak_rpm", "peak_inflight", "inflight", "duplicates_avoided"} {
if _, ok := host[key]; !ok {
t.Errorf("noise host misses %q: %v", key, host)
}
}
if host["host"] != strings.TrimPrefix(target.URL, "http://") || host["rpm"] != float64(1) || host["inflight"] != float64(0) {
t.Fatalf("noise host = %v", host)
}
// A second read does not reset the minute.
if _, again := do(http.MethodGet, "/api/settings/noise", ""); again["hosts"].([]any)[0].(map[string]any)["rpm"] != float64(1) {
t.Fatalf("second GET noise reset the counter: %v", again)
}
}
+20
View File
@@ -22,6 +22,7 @@ import (
"github.com/Autumn-27/artex/agent"
"github.com/Autumn-27/artex/db"
"github.com/Autumn-27/artex/egress"
"github.com/Autumn-27/artex/intercept"
"github.com/Autumn-27/artex/llmpool"
"github.com/Autumn-27/artex/llmrec"
@@ -833,6 +834,7 @@ func (s *Server) Handler() http.Handler {
mux.HandleFunc("GET /api/llm/records/{id}", s.pgGetLLMRecord)
mux.HandleFunc("GET /api/settings", s.getSettings)
mux.HandleFunc("PUT /api/settings", s.putSettings)
mux.HandleFunc("GET /api/settings/noise", s.noiseStatus) // current noise profile + per-host counters (no reset)
// Vulnerability IM push. Channels are "multi-instance + per-instance filter rules" resources, so they get their own group of
// REST endpoints instead of being stuffed into the flat /api/settings key-value store.
mux.HandleFunc("GET /api/notify/meta", s.notifyMeta)
@@ -3528,6 +3530,8 @@ func (s *Server) settingsPayload() map[string]any {
// Render limits of IM messages; 0 = no truncation.
"notify_summary_max_runes": limits.SummaryRunes,
"notify_assets_max_shown": limits.AssetsShown,
// Effective target noise profile (off by default): the stored setting, else ARTEX_NOISE_PROFILE.
"noise_profile": egress.CurrentProfile().Name,
}
}
@@ -3603,11 +3607,27 @@ func (s *Server) putSettings(w http.ResponseWriter, r *http.Request) {
// Render limits of IM messages: summary characters (0-4000) and asset names listed (0-50); 0 = no truncation.
NotifySummaryMaxRunes *int `json:"notify_summary_max_runes"`
NotifyAssetsMaxShown *int `json:"notify_assets_max_shown"`
// Target noise profile: off|quiet|balanced|aggressive; null = unchanged. Applies to the next request, no agent rebuild.
NoiseProfile *string `json:"noise_profile"`
}
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeErr(w, 400, err.Error())
return
}
// Validated before any other field is written, so a bad value changes nothing.
var noise egress.Profile
if req.NoiseProfile != nil {
var ok bool
if noise, ok = egress.ProfileByName(*req.NoiseProfile); !ok {
writeErr(w, 400, "noise_profile must be off, quiet, balanced or aggressive")
return
}
if err := s.m.pg.SetSetting(settingNoiseProfile, noise.Name); err != nil {
writeErr(w, 500, err.Error())
return
}
egress.SetProfile(noise)
}
// A masked placeholder echoed back keeps the stored secret, like null.
req.BraveKey, req.TavilyKey = keepIfMasked(req.BraveKey), keepIfMasked(req.TavilyKey)
req.WebSearchProxy, req.GlobalProxy = keepIfMasked(req.WebSearchProxy), keepIfMasked(req.GlobalProxy)
+63
View File
@@ -0,0 +1,63 @@
package traffic
import (
"context"
"log"
"net/http"
"time"
"github.com/Autumn-27/artex/egress"
mproxy "github.com/lqqyt2423/go-mitmproxy/proxy"
)
// paceWaitMax bounds the pacing wait of one request. Past it the request is
// sent unpaced: pacing never blocks a command indefinitely.
const paceWaitMax = 30 * time.Second
// Requestheaders runs for every request the proxy sees: the CONNECT that opens
// a tunnel, each request inside an intercepted tunnel, and each plain-HTTP
// request. The recording proxy takes no credentials, so a Proxy-Authorization
// header is only ever meant for it (clients send the proxy URL's userinfo
// there): it is dropped here, before anything is forwarded, and never reaches
// the target or the recording. When it carries the pace marker
// (egress.PaceUser), the client connection is marked; every request on it,
// including those inside its tunnel, is then paced by the current noise
// profile before it goes upstream. Unmarked connections are not paced here.
func (s *sink) Requestheaders(f *mproxy.Flow) {
if f.Request == nil || f.ConnContext == nil || f.ConnContext.ClientConn == nil {
return
}
id := f.ConnContext.ClientConn.Id
if egress.IsPaceMarker(f.Request.Header.Get("Proxy-Authorization")) {
s.paced.Store(id, struct{}{})
}
f.Request.Header.Del("Proxy-Authorization")
if f.Request.Method == http.MethodConnect || f.Request.URL == nil {
return
}
if _, marked := s.paced.Load(id); marked {
pace(f)
}
}
// ClientDisconnected forgets a closed connection's mark.
func (s *sink) ClientDisconnected(c *mproxy.ClientConn) {
if c != nil {
s.paced.Delete(c.Id)
}
}
// pace waits for the request's host under the current noise profile, bounded
// by paceWaitMax and by the request's own context. Off returns at once.
func pace(f *mproxy.Flow) {
ctx := context.Background()
if raw := f.Request.Raw(); raw != nil {
ctx = raw.Context()
}
ctx, cancel := context.WithTimeout(ctx, paceWaitMax)
defer cancel()
host := egress.HostKey(f.Request.URL)
if err := egress.Wait(ctx, host); err != nil {
log.Printf("[traffic] pacing a Bash request to %s stopped waiting (%v); sending it unpaced", host, err)
}
}
+262
View File
@@ -0,0 +1,262 @@
package traffic
import (
"crypto/tls"
"crypto/x509"
"io"
"net"
"net/http"
"net/http/httptest"
"net/url"
"os"
"strings"
"sync"
"testing"
"time"
"github.com/Autumn-27/artex/egress"
mproxy "github.com/lqqyt2423/go-mitmproxy/proxy"
)
// startProxy runs a real recording proxy on a free loopback port and returns it
// with its sink and URL. extra addons run after the recording sink.
func startProxy(t *testing.T, extra ...mproxy.Addon) (*Traffic, *sink, string) {
t.Helper()
ln, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatal(err)
}
addr := ln.Addr().String()
ln.Close()
tr, err := Open(t.TempDir(), addr)
if err != nil {
t.Fatal(err)
}
s := tr.proxy.Addons[0].(*sink)
for _, a := range extra {
tr.proxy.AddAddon(a)
}
go func() { _ = tr.Start() }()
t.Cleanup(func() {
_ = tr.proxy.Close()
_ = tr.Close()
})
deadline := time.Now().Add(5 * time.Second)
for {
c, err := net.Dial("tcp", addr)
if err == nil {
c.Close()
break
}
if time.Now().After(deadline) {
t.Fatalf("proxy did not listen on %s: %v", addr, err)
}
time.Sleep(10 * time.Millisecond)
}
return tr, s, "http://" + addr
}
// proxyClient is a curl-like client: it sends the proxy URL's userinfo as
// Proxy-Authorization on CONNECT and on plain-HTTP requests, and trusts the CA.
func proxyClient(t *testing.T, tr *Traffic, proxyURL string) *http.Client {
t.Helper()
pem, err := os.ReadFile(tr.CACertPath())
if err != nil {
t.Fatal(err)
}
pool := x509.NewCertPool()
if !pool.AppendCertsFromPEM(pem) {
t.Fatal("no CA in", tr.CACertPath())
}
u, _ := url.Parse(proxyURL)
return &http.Client{Transport: &http.Transport{Proxy: http.ProxyURL(u), TLSClientConfig: &tls.Config{RootCAs: pool}}}
}
// probe records the ClientConn of each request the proxy sees, after the sink.
type probe struct {
mproxy.BaseAddon
mu sync.Mutex
conn map[string]string // "METHOD url" -> ClientConn.Id
}
func (p *probe) Requestheaders(f *mproxy.Flow) {
p.mu.Lock()
defer p.mu.Unlock()
if p.conn == nil {
p.conn = map[string]string{}
}
p.conn[f.Request.Method+" "+f.Request.URL.String()] = f.ConnContext.ClientConn.Id.String()
}
func get(t *testing.T, c *http.Client, u string) {
t.Helper()
resp, err := c.Get(u)
if err != nil {
t.Fatal(err)
}
_, _ = io.Copy(io.Discard, resp.Body)
resp.Body.Close()
if resp.StatusCode != 200 {
t.Fatalf("GET %s: %d", u, resp.StatusCode)
}
}
func markedCount(s *sink) int {
n := 0
s.paced.Range(func(any, any) bool { n++; return true })
return n
}
func hostRPM(host string) int {
for _, h := range egress.Current().Snapshot() {
if h.Host == host {
return h.RPM
}
}
return 0
}
// A marked client (the Bash proxy URL) is paced and counted, through a CONNECT
// tunnel and on plain HTTP; an unmarked one (WebFetch, custom tools, enrich)
// is not paced here. No Proxy-Authorization reaches a target or the recording,
// every exchange is recorded, and a closed connection loses its mark.
func TestBashPacingThroughProxy(t *testing.T) {
prev := egress.CurrentProfile()
t.Cleanup(func() { egress.SetProfile(prev) })
// 2 req/s, burst 1, no jitter: from the second request on, each waits 500 ms.
egress.SetProfile(egress.Profile{Name: "test", RPS: 2, Burst: 1, MaxPerHost: 1, MaxGlobal: 8})
var mu sync.Mutex
leaked := map[string]string{}
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if v := r.Header.Get("Proxy-Authorization"); v != "" {
mu.Lock()
leaked[r.URL.Path] = v
mu.Unlock()
}
_, _ = io.WriteString(w, "ok")
})
marked := httptest.NewServer(handler)
defer marked.Close()
unmarked := httptest.NewServer(handler)
defer unmarked.Close()
tlsSrv := httptest.NewTLSServer(handler)
defer tlsSrv.Close()
// The MITM leaf for a bare IP has no IP SAN: address the TLS target by name.
tlsURL := strings.Replace(tlsSrv.URL, "127.0.0.1", "localhost", 1)
p := &probe{}
tr, s, proxyURL := startProxy(t, p)
bash := proxyClient(t, tr, egress.MarkProxyURL(proxyURL))
plain := proxyClient(t, tr, proxyURL)
start := time.Now()
for range 3 {
get(t, bash, marked.URL+"/bash")
}
if d := time.Since(start); d < 900*time.Millisecond {
t.Fatalf("3 marked requests to one host took %v, want >= 1s of pacing", d)
}
if n := hostRPM(strings.TrimPrefix(marked.URL, "http://")); n != 3 {
t.Fatalf("egress counter for the marked host = %d, want 3", n)
}
for range 3 {
get(t, plain, unmarked.URL+"/plain")
}
if n := hostRPM(strings.TrimPrefix(unmarked.URL, "http://")); n != 0 {
t.Fatalf("unmarked requests were paced by the proxy: counter %d, want 0", n)
}
get(t, bash, tlsURL+"/tls1")
get(t, bash, tlsURL+"/tls2")
tlsHost := strings.TrimPrefix(tlsURL, "https://")
if n := hostRPM(tlsHost); n != 2 {
t.Fatalf("egress counter for the tunnelled host = %d, want 2", n)
}
p.mu.Lock()
connectID := p.conn["CONNECT //"+tlsHost]
inner1, inner2 := p.conn["GET "+tlsURL+"/tls1"], p.conn["GET "+tlsURL+"/tls2"]
p.mu.Unlock()
if connectID == "" || inner1 != connectID || inner2 != connectID {
t.Fatalf("tunnel flows do not share the CONNECT's connection: connect=%q inner=%q,%q", connectID, inner1, inner2)
}
mu.Lock()
if len(leaked) != 0 {
t.Fatalf("Proxy-Authorization reached the target: %v", leaked)
}
mu.Unlock()
rows, err := tr.Search("", 0, 100)
if err != nil || len(rows) != 8 {
t.Fatalf("recorded %d exchanges (err %v), want 8", len(rows), err)
}
for _, r := range rows {
req, _, err := tr.Get(r.ID)
if err != nil || strings.Contains(strings.ToLower(req), "proxy-authorization") {
t.Fatalf("recorded request %s keeps Proxy-Authorization (err %v):\n%s", r.ID, err, req)
}
}
if markedCount(s) == 0 {
t.Fatal("no connection marked")
}
bash.CloseIdleConnections()
plain.CloseIdleConnections()
deadline := time.Now().Add(5 * time.Second)
for markedCount(s) != 0 {
if time.Now().After(deadline) {
t.Fatalf("%d marks left after the clients closed", markedCount(s))
}
time.Sleep(10 * time.Millisecond)
}
}
// Off: a marked request is neither paced nor counted.
func TestBashPacingOff(t *testing.T) {
prev := egress.CurrentProfile()
t.Cleanup(func() { egress.SetProfile(prev) })
egress.SetProfile(egress.Profile{Name: "off"})
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
defer srv.Close()
tr, _, proxyURL := startProxy(t)
bash := proxyClient(t, tr, egress.MarkProxyURL(proxyURL))
for range 3 {
get(t, bash, srv.URL+"/")
}
if snap := egress.Current().Snapshot(); len(snap) != 0 {
t.Fatalf("off counted marked requests: %v", snap)
}
}
// The sink drops Proxy-Authorization from every request and marks only on the
// pace marker; a disconnect clears the mark.
func TestSinkStripsAndMarks(t *testing.T) {
prev := egress.CurrentProfile()
t.Cleanup(func() { egress.SetProfile(prev) })
egress.SetProfile(egress.Profile{Name: "off"})
s := &sink{}
flow := func(method, auth string, conn *mproxy.ClientConn) *mproxy.Flow {
u, _ := url.Parse("http://a.example/")
h := http.Header{}
if auth != "" {
h.Set("Proxy-Authorization", auth)
}
return &mproxy.Flow{Request: &mproxy.Request{Method: method, URL: u, Header: h}, ConnContext: &mproxy.ConnContext{ClientConn: conn}}
}
f := flow(http.MethodGet, "Basic dXNlcjpwYXNz", &mproxy.ClientConn{}) // user:pass, not the marker
s.Requestheaders(f)
if f.Request.Header.Get("Proxy-Authorization") != "" || markedCount(s) != 0 {
t.Fatalf("foreign credentials: header %q, marks %d", f.Request.Header.Get("Proxy-Authorization"), markedCount(s))
}
conn := &mproxy.ClientConn{}
conn.Id[0] = 1
f = flow(http.MethodConnect, "Basic YXJ0ZXgtcGFjZTphcnRleC1wYWNl", conn) // artex-pace:artex-pace
s.Requestheaders(f)
if f.Request.Header.Get("Proxy-Authorization") != "" || markedCount(s) != 1 {
t.Fatalf("marker on CONNECT: header %q, marks %d", f.Request.Header.Get("Proxy-Authorization"), markedCount(s))
}
s.ClientDisconnected(conn)
if markedCount(s) != 0 {
t.Fatal("mark kept after disconnect")
}
}
+4 -2
View File
@@ -383,10 +383,12 @@ func (t *Traffic) stopping() bool {
}
func (t *Traffic) DB() *sql.DB { return t.db }
// sink is the go-mitmproxy addon that records completed exchanges.
// sink is the go-mitmproxy addon that records completed exchanges, and paces
// the requests of client connections marked for pacing (see pace.go).
type sink struct {
mproxy.BaseAddon
t *Traffic
t *Traffic
paced sync.Map // ClientConn.Id of a marked connection -> struct{}
}
func (s *sink) Response(f *mproxy.Flow) {
@@ -0,0 +1,153 @@
"use client";
import * as React from "react";
import { GaugeIcon, RefreshCwIcon } from "lucide-react";
import { toast } from "sonner";
import { Button } from "@/components/ui/button";
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card";
import { Label } from "@/components/ui/label";
import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@/components/ui/select";
import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from "@/components/ui/table";
import { api } from "@/lib/api";
import type { NoiseProfileName, NoiseStatus } from "@/lib/types";
// Mirrors egress.Profiles in egress/egress.go; the jitter of one send is
// min(Jitter/RPS, 250 ms).
const profiles: { value: NoiseProfileName; label: string; limits: string }[] = [
{ value: "off", label: "Off", limits: "Off: requests and their timing are unchanged, and nothing is counted." },
{
value: "quiet",
label: "Quiet",
limits:
"2 req/s per host (burst 4), 1 in flight per host, 8 overall, jitter up to 250 ms, identical GETs of a task cached 60 s, up to 3 retries on 429/503.",
},
{
value: "balanced",
label: "Balanced",
limits:
"5 req/s per host (burst 10), 2 in flight per host, 16 overall, jitter up to 40 ms, identical GETs of a task cached 30 s, up to 3 retries on 429/503.",
},
{
value: "aggressive",
label: "Aggressive",
limits:
"20 req/s per host (burst 40), 4 in flight per host, 32 overall, jitter up to 5 ms, identical GETs of a task cached 10 s, up to 2 retries on 429/503.",
},
];
// NoiseProfileCard sets the target noise profile and shows the per-host
// counters of the current minute.
export function NoiseProfileCard() {
const [status, setStatus] = React.useState<NoiseStatus | null>(null);
const [loading, setLoading] = React.useState(false);
const [saving, setSaving] = React.useState(false);
const refresh = React.useCallback(() => {
setLoading(true);
api
.noiseStatus()
.then(setStatus)
.catch((e) => toast.error(`Failed to load the noise counters: ${(e as Error).message}`))
.finally(() => setLoading(false));
}, []);
React.useEffect(() => {
refresh();
}, [refresh]);
const save = (value: NoiseProfileName) => {
setSaving(true);
api
.setSettings({ noise_profile: value })
.then(() => {
toast.success(`Noise profile set to ${value}`);
refresh();
})
.catch((e) => toast.error(`Save failed: ${(e as Error).message}`))
.finally(() => setSaving(false));
};
const current = profiles.find((p) => p.value === status?.profile) ?? profiles[0];
return (
<Card className="mb-4 break-inside-avoid md:mb-6">
<CardHeader>
<CardTitle className="flex items-center gap-2 text-base">
<GaugeIcon className="size-4" />
Target noise
</CardTitle>
<CardDescription>
Paces the requests ARTEX itself sends to targets (WebFetch, http custom tools, the enrich probe) and sets the
low-and-slow guidance in agent prompts. With traffic capture on, Bash commands that use the proxy (curl,
wget, python-requests…) are paced too, by rate and jitter only: the in-flight, cache and retry limits apply
to ARTEX's own requests. Raw scanners such as nmap, and commands that bypass the proxy, are not paced; this
is best effort, not a security boundary. This setting takes precedence over ARTEX_NOISE_PROFILE and applies
to the next request.
</CardDescription>
</CardHeader>
<CardContent className="flex flex-col gap-4">
<div className="flex items-center justify-between gap-4">
<Label htmlFor="noise-profile" className="text-sm font-normal text-muted-foreground">
Profile
</Label>
<Select
value={status?.profile ?? ""}
disabled={!status || saving}
onValueChange={(v) => save(v as NoiseProfileName)}
>
<SelectTrigger id="noise-profile" className="w-48 shrink-0">
<SelectValue placeholder="Loading…" />
</SelectTrigger>
<SelectContent>
{profiles.map((p) => (
<SelectItem key={p.value} value={p.value}>
{p.label}
</SelectItem>
))}
</SelectContent>
</Select>
</div>
<p className="text-muted-foreground text-xs">{current.limits}</p>
<div className="flex items-center justify-between gap-4">
<span className="font-medium text-sm">Hosts, current minute</span>
<Button variant="outline" size="sm" onClick={refresh} disabled={loading}>
<RefreshCwIcon data-icon="inline-start" className={loading ? "animate-spin" : undefined} />
Refresh
</Button>
</div>
{status?.hosts.length ? (
<Table aria-label="Noise counters per host">
<TableHeader>
<TableRow>
<TableHead>Host</TableHead>
<TableHead className="text-right">RPM</TableHead>
<TableHead className="text-right">Peak RPM</TableHead>
<TableHead className="text-right">In flight (peak)</TableHead>
<TableHead className="text-right">Duplicates</TableHead>
</TableRow>
</TableHeader>
<TableBody>
{status.hosts.map((h) => (
<TableRow key={h.host}>
<TableCell className="max-w-48 truncate font-mono text-xs" title={h.host}>
{h.host}
</TableCell>
<TableCell className="text-right">{h.rpm}</TableCell>
<TableCell className="text-right">{h.peak_rpm}</TableCell>
<TableCell className="text-right">
{h.inflight} ({h.peak_inflight})
</TableCell>
<TableCell className="text-right">{h.duplicates_avoided}</TableCell>
</TableRow>
))}
</TableBody>
</Table>
) : (
<p className="text-muted-foreground text-sm">
{status?.profile === "off" ? "Off counts no request." : "No paced request yet."}
</p>
)}
</CardContent>
</Card>
);
}
@@ -15,6 +15,8 @@ import { api } from "@/lib/api";
import { CHAT_SEND_MODE_OPTIONS, type ChatSendMode, setChatSendMode, useChatSendMode } from "@/lib/chat-send-mode";
import type { Settings } from "@/lib/types";
import { NoiseProfileCard } from "./noise-profile-card";
export default function SystemSettingsPage() {
const [trafficCapture, setTrafficCapture] = React.useState(false);
const [agentTrafficBinding, setAgentTrafficBinding] = React.useState(false);
@@ -292,6 +294,8 @@ export default function SystemSettingsPage() {
</CardContent>
</Card>
<NoiseProfileCard />
<Card className="mb-4 break-inside-avoid md:mb-6">
<CardHeader>
<CardTitle className="flex items-center gap-2 text-base">
+1
View File
@@ -826,6 +826,7 @@ export const api = {
// ---- app settings (runtime toggles) ----
settings: () => get<Settings>(`/settings`),
setSettings: (patch: Partial<Settings>) => put<Settings>(`/settings`, patch),
noiseStatus: () => get<import("@/lib/types").NoiseStatus>(`/settings/noise`),
// Run a real "test" search with the given (or saved) config to verify it works.
testWebSearch: (patch: {
web_search_backend?: string;
+17
View File
@@ -962,6 +962,23 @@ export interface Settings {
// Render limits of IM messages; 0 = no truncation. The backend answers 400 outside the bounds.
notify_summary_max_runes?: number; // summary characters per finding, 0-4000, default 120
notify_assets_max_shown?: number; // asset names listed per finding, 0-50, default 3
// Target noise profile; the stored setting wins over ARTEX_NOISE_PROFILE. Applies to the next request.
noise_profile?: NoiseProfileName;
}
export type NoiseProfileName = "off" | "quiet" | "balanced" | "aggressive";
// GET /api/settings/noise: the current profile and its per-host counters (current minute, no reset).
export interface NoiseStatus {
profile: NoiseProfileName;
hosts: {
host: string;
rpm: number;
peak_rpm: number;
peak_inflight: number;
inflight: number;
duplicates_avoided: number;
}[];
}
// ---- Vulnerability IM push ----