Compare commits

...
Author SHA1 Message Date
BaaRai a866f3752f docs: rewrite README and refresh screenshots 2026-11-14 21:40:40 +01:00
BaaRai 481dd1c3f2 Merge pull request #230 from BaaRai/perf/coverage-graph
perf(db): batch coverage-graph lookups and index icp scope probes
2026-11-14 21:40:14 +01:00
BaaRai 30c787d690 perf(db): batch coverage-graph lookups and index icp scope probes
BuildCoverageGraph issued one QueryRow per connector root domain and one per company: 221 statements for a task scoped by 800 subdomains over 200 roots and 20 companies. Fetch them with one ANY() query each. The coverage target join probes task_scope once per asset, and the icp branch fell back to uq_task_scope_v2 with only kind as index condition; migration 0003 adds a partial index on task_scope(value) for icp rows. Large-fixture invariants test and benchmark included.
2026-11-14 21:16:49 +01:00
BaaRai 430950570c Merge pull request #152 from xulytiengviet/patch-1
Create SECURITY.md
2026-11-14 20:57:08 +01:00
BaaRai f8bc149872 Merge pull request #225 from err0rgod/docs/fix-stale-postgres-docs
docs: correct stale database and boundary references
2026-11-14 20:57:03 +01:00
BaaRai f3a8e82d29 docs(security): point reports to the BaaRai repository and drop placeholders
Replace the [owner] placeholder and the unfilled email and PGP lines with GitHub Security Advisories as the sole reporting channel. Replace the 0.4/0.5 support table with the latest release line, and turn the response timeframes into best-effort goals.
2026-11-14 20:47:28 +01:00
BaaRai e300f85987 Merge pull request #229 from BaaRai/ci/race-server
ci: run ./server under the race detector
2026-11-14 19:57:20 +01:00
BaaRai dfa0e8a566 ci: run ./server under the race detector
The server suite now passes go test -race against postgres, and its test teardown no longer leaks live servers (#227, #228). Add ./server to the go test -race step; the DSN and -p 1 are unchanged.
2026-11-14 19:11:10 +01:00
BaaRai 9b20a46eba Merge pull request #228 from BaaRai/fix/flaky-server-tests
test(server): fix flaky SkillGaps, notify digest and TempDir cleanup tests
2026-11-14 19:03:16 +01:00
BaaRai 8c8ae97400 test(server): join every live test server before its TempDir cleanup
New restores every unfinished task in the shared database and runs its planner, worker and deadline loops on the server context. Tests that passed context.Background() never stopped or joined them, so they kept writing under the manager TempDir after the test returned and the TempDir cleanup failed with directory not empty. Add stopTestServer, which cancels the context, waits for each task to go quiescent, joins its loops, the archive worker and the side-question writer, and defer it right after New in every test that started a live server.
2026-11-14 18:21:52 +01:00
BaaRai 149151919f test(server): join restored task loops before TestTaskDetailReturnsListMetrics cleanup
New restores every unfinished task in the shared database and runs its planner and worker loops on the server context. They kept writing transcripts under the TempDir after the test returned, so the TempDir cleanup failed with directory not empty. Cancel the context, wait for each task to go quiescent, and join its loops before m.Close and the TempDir cleanup.
2026-11-14 16:21:31 +01:00
BaaRai 5cdb720122 test(server): stop leaked fixtures from polluting later tests
TestMgmtAPI never closed its manager, so the notifier and task-archive workers started by New(context.Background()) kept claiming other tests digest batches and archive jobs. TestTaskOutcomeCard left a skill_usage miss row behind (the table has no foreign keys), which outranked TestSkillGapsReport fixture from the fourth -count iteration on.
2026-11-14 15:44:52 +01:00
BaaRai ae792126dc Merge pull request #227 from BaaRai/fix/agent-hook-race
agent: synchronise package-level hooks (data races under -race)
2026-11-14 15:01:30 +01:00
BaaRai 54ff51177d agent: guard prompt and wrap-up override hooks against concurrent access
PromptOverride, WrapupOverride, WrapupMaxTurnsOverride,
WrapupTaskTimeoutOverride and WrapupTaskTimeoutTurnsOverride are wired
in server.New while restored tasks may already render prompts and build
settlement configs on other goroutines. go test -race ./server reported
races between server.New (server.go:195/207/215) and agent.renderSystem /
resolveWrapup / resolveWrapupTurns.

Same treatment as the tool hooks: unexported variables behind a
sync.RWMutex (one for the prompt hook, one shared by the four wrap-up
hooks), Set* setters and getters, and readers that copy the function
value under the lock and call it outside. A nil hook still means the
built-in default.

TestAgentHooksConcurrentSwap now covers all eight hooks.
2026-11-14 14:19:13 +01:00
BaaRai 37f2573a53 agent: guard ToolAugment/ToolResolve hooks against concurrent access
server wiring (wireAgentAugment, wireTools) assigned the package-level
hooks agent.ToolAugment and agent.ToolResolve while restored tasks could
already be running AugmentTools on other goroutines. go test -race ./server
reported this as a DATA RACE between agent.AugmentTools and
server.wireAgentAugment.

Each hook is now an unexported variable behind a sync.RWMutex, with a
setter (SetToolAugment, SetToolResolve) and a getter (ToolAugment(),
ToolResolve()). AugmentTools copies the function value through the getter
and calls it outside the lock. A nil hook still means no augmentation /
no resolution, as before.

FindingTrafficBindingEnabled is wired in the same server/assembly.go code
and read on the same AugmentTools path, so it gets the same treatment.

Adds TestAugmentToolsHooksConcurrentSwap, which runs AugmentTools while
the setters swap the hooks, so -race catches an unsynchronised access
without depending on test ordering.
2026-11-14 13:46:03 +01:00
BaaRai 5cb44fb969 Merge pull request #226 from BaaRai/feat/versioned-migrations
db: versioned migrations runner with schema_migrations
2026-11-14 13:19:38 +01:00
BaaRai f3b9f6f688 db: refuse a pending migration older than the newest applied one
applyMigrations now fails closed, before any write, when a pending
migration has a version below the highest version recorded in
schema_migrations: migrations must be appended, never inserted.
2026-11-14 13:10:57 +01:00
BaaRai 1da0d07222 db: versioned migrations runner with schema_migrations
Move the llm_records and llm_usage DDL out of Go constants into embedded
files db/migrations/0001_llm_records.sql and 0002_llm_usage.sql (byte-for-byte
the old constants). Open now applies pending migrations after schema.sql and
before seedBuiltins, under the existing schema advisory lock and on the
lock-holding connection. Each migration runs in its own transaction with its
schema_migrations row (version, name, SHA-256 checksum, applied_at).

Open fails closed when the database has a version missing from the binary, or
an applied migration whose file name or checksum changed. A failing migration
is rolled back and blocks startup; earlier ones stay applied.

EnsureLLMRecordsTable and EnsureLLMUsageTable re-run the embedded files and
keep their transaction-level schema lock; Open never calls them.
2026-11-14 12:52:34 +01:00
err0rgod 622b7490e0 docs: finish the post-SQLite data-directory wording
Update the Dockerfile, Compose file and upgrade note to describe what ./data and ./keys actually hold now that the graph stores are PostgreSQL.
2026-11-14 16:58:39 +05:30
BaaRai 8f3f0c54f8 Merge pull request #224 from BaaRai/fix/archive-restore-normalize-url
db: normalise archived asset URLs on restore
2026-11-14 12:27:39 +01:00
err0rgod b6e863c746 docs: correct stale database and boundary references
- describe the graph stores as PostgreSQL in the entrypoint and agent package
- document that -data holds the traffic index, task files and transcripts
- add an Unreleased note for the untrusted-output boundary default flip
- use a placeholder version in the README/build.sh release examples
2026-11-14 16:55:11 +05:30
BaaRai 2e43b423ee db: normalise archived asset URLs on restore
restoreArchiveAssets inserted archived service and endpoint rows with
their raw url, and findArchiveAssetNaturalID matched on that raw value.
An archive taken before normalizeURL dropped userinfo therefore restored
http://user:pass@host in clear and duplicated the existing clean row.

Pass row["url"] through normalizeURL for service and endpoint rows
before the natural-identity lookup, so the lookup reuses the clean row
and an insert stores the normalised URL. Other columns keep their
archived values.
2026-11-14 12:17:33 +01:00
BaaRai 8bb4ca0745 Merge pull request #223 from BaaRai/fix/store-normalize-userinfo
db: drop URL userinfo in normalizeURL before storing assets.url
2026-11-14 12:06:44 +01:00
Long Ngo 33078a7d35 Create SECURITY.md 2026-11-06 14:01:04 +07:00
69 changed files with 2668 additions and 917 deletions
+5 -3
View File
@@ -45,8 +45,9 @@ jobs:
# keeps the database state deterministic.
run: go test -p 1 ./...
- name: go test -race
# Race detector on the packages that pass under -race today. ./server is
# left out until it has been checked with -race against postgres.
# Race detector on the packages that pass under -race today. ./server
# joined once its suite was checked with -race against postgres and its
# test teardown fixed (#227, #228).
# Its own database: the plain run above leaves rows behind and the db tests
# are not idempotent across runs (duplicate llm_profiles names).
env:
@@ -54,7 +55,8 @@ jobs:
run: >-
go test -race -p 1 ./agent ./cmd/artex ./config ./db ./evidence ./guard
./intercept ./llmpool ./llmrec ./mcphttp ./notify ./sidequestion ./traffic
./intercept ./llmpool ./llmrec ./mcphttp ./notify ./server ./sidequestion
./traffic
shell:
runs-on: ubuntu-latest
+6
View File
@@ -2,6 +2,12 @@
All notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
## [Unreleased]
### 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).
## [0.6.0] - 2026-11-12
Machine-checked finding verification (S1), intercept decisions traced to their actor, configurable notification limits, prompt hardening and goal guards from the #124 agentic audit, the target gate (S3b phase 1 and step 2.1, off by default and API-only), intent claim leases, and checksum-verified tool downloads in the Docker image.
+1 -1
View File
@@ -178,7 +178,7 @@ COPY --from=build /out/artex /app/artex
COPY start.sh /app/start.sh
RUN chmod +x /app/artex /app/start.sh && mkdir -p /app/keys
COPY skills/ /app/skills/
# persistence points: data/ (SQLite, task files) and keys/ (jwt.key, via ARTEX_JWT_KEY_DIR)
# persistence points: data/ (traffic index, task files, transcripts) and keys/ (jwt.key, secret.key, via ARTEX_JWT_KEY_DIR)
VOLUME ["/app/data", "/app/keys"]
EXPOSE 8787 8788
ENTRYPOINT ["/app/start.sh"]
+495 -325
View File
@@ -1,88 +1,279 @@
<div align="center">
<img src="web/public/logo.svg" width="84" alt="ARTEX logo" />
# ARTEX
AI autonomous penetration testing system (Go backend + Next.js frontend)
**Autonomous penetration testing that keeps its receipts.**
Self-hosted multi-agent offensive security. A planner explores, workers run real tools,
and every finding stays bound to the assets and HTTP traffic that prove it.
Fork of [ARTEX by Autumn-27](https://github.com/Autumn-27) · English translation of the Chinese source · maintained publicly under AGPL-3.0
[![Release](https://img.shields.io/github/v/release/BaaRai/ARTEX?label=release&color=6b34db)](https://github.com/BaaRai/ARTEX/releases)
[![License](https://img.shields.io/github/license/BaaRai/ARTEX?color=6b34db)](LICENSE)
[![CI](https://github.com/BaaRai/ARTEX/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/BaaRai/ARTEX/actions/workflows/ci.yml)
[![Go](https://img.shields.io/github/go-mod/go-version/BaaRai/ARTEX?color=6b34db)](go.mod)
[Quick start](#quick-start) · [Screenshots](#screenshots) · [How it works](#how-it-works) · [Install](#installation) · [Configuration](#configuration) · [Security](SECURITY.md)
</div>
<a href="https://trendshift.io/repositories/316805?utm_source=trendshift-badge&amp;utm_medium=badge&amp;utm_campaign=badge-trendshift-316805" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/316805/daily?language=Go" alt="BaaRai%2FARTEX | Trendshift" width="250" height="55"/></a>
---
ARTEX is a self-hosted, LLM-driven penetration testing platform. It is not a chat wrapper around
a scanner: a planner splits a goal into intents, workers execute them with real tools, and the
results are written back into **two linked graphs**: one for what you know about the target, one
for how the test is progressing. Every finding can carry the captured request and response that
justify it, and every autonomous action passes through scope rules, approval gates and budgets.
- **It explores, it doesn't chat.** Goal decomposition, intent dispatch, worker execution and
write-back form a closed loop that keeps advancing until the goal is proven.
- **Two graphs, one audit trail.** The shared asset graph says *what exists*; the per-task
exploration graph says *what was tried, what it produced, and why*. Anchors link the two.
- **Findings with evidence.** A recording MITM proxy and a browser extension capture real traffic;
findings, evidence quotes and retests are tied to the exact request/response.
- **Autonomy with brakes.** Human-in-the-loop approvals, argv-prefix rules, scope/deny gates,
token and turn budgets, a target noise governor, and prompt-injection framing on tool output.
- **Self-hosted and model-agnostic.** One Go binary with the Next.js UI embedded, PostgreSQL,
your own Anthropic/OpenAI-compatible endpoint, or a local Ollama.
---
## Quick start
```bash
git clone https://github.com/BaaRai/ARTEX.git
cd ARTEX
cp .env.example .env # set POSTGRES_PASSWORD (and optionally an LLM key)
docker compose up -d --build # builds from this checkout, starts PostgreSQL
```
Open **http://localhost:8787**. On the first visit `/setup` asks for the one-time setup token
printed at startup:
```bash
docker compose logs artex | grep "Setup token"
```
> There is no prebuilt Docker image to pull: the image is always built from your checkout.
> For all installation paths (script, binaries, source, release archives), see [Installation](#installation).
---
## Screenshots
| Dashboard (overview / token usage / activity stream) | Task list |
| Tasks | Findings |
| :---: | :---: |
| ![Dashboard](screenshots/dashboard.png) | ![Tasks](screenshots/tasks.png) |
| ![Tasks](screenshots/tasks.png) | ![Findings](screenshots/findings.png) |
| Task · execution (sessions / tool calls) | Exploration graph |
| Task execution: sessions and tool calls | Exploration graph |
| :---: | :---: |
| ![Execution](screenshots/sessions.png) | ![Exploration graph](screenshots/graph.png) |
| Findings | Assets |
| Asset coverage graph | Traffic recording |
| :---: | :---: |
| ![Findings](screenshots/findings.png) | ![Assets](screenshots/assets.png) |
| ![Asset coverage graph](screenshots/assets_test.png) | ![Traffic](screenshots/traffic.png) |
| Asset coverage graph (force-directed layout · tested highlights · node collapse/expand) |
| :---: |
| ![Asset coverage graph](screenshots/assets_test.png) |
| Traffic recording | Human-in-the-loop chat |
| Human-in-the-loop chat | Interception approvals |
| :---: | :---: |
| ![Traffic](screenshots/traffic.png) | ![Chat](screenshots/chat.png) |
| ![Chat](screenshots/chat.png) | ![Interception](screenshots/intercept.png) |
| Agent management | LLM configuration |
<details>
<summary>More screenshots (assets, agents, LLM, logs)</summary>
| Assets | Agent management |
| :---: | :---: |
| ![Agent](screenshots/agents.png) | ![LLM](screenshots/llm.png) |
| ![Assets](screenshots/assets.png) | ![Agent](screenshots/agents.png) |
| Interception approvals | Backend logs |
| LLM configuration | Backend logs |
| :---: | :---: |
| ![Interception](screenshots/intercept.png) | ![Logs](screenshots/logs.png) |
| ![LLM](screenshots/llm.png) | ![Logs](screenshots/logs.png) |
</details>
---
## Approval record details
## How it works
The global "Approval Records", the in-task "Interception Approvals", and the approval cards in conversations all support expanding to view details. The display structure references the
[AegisHook approval details component](https://github.com/RuoJi6/AegisHook/blob/main/web/src/components/CallDetail.vue), reusing ARTEX's components and theme:
### Dual-graph architecture: exploration graph + asset graph
## Argv prefix rules
ARTEX separates *what the goals are* from *how far testing has progressed* into two independent
graphs linked by anchors:
Besides `string` and `regex`, an interception rule can use `match_type: argv` (Bash only, `match_target: tool_input`). Its pattern is a JSON array of 1 to 8 tokens, for example `["git","push"]`, with no empty token, no token starting with `-` and no shell metacharacter or space.
- **Asset graph (shared across tasks).** One source of truth for `root_domain / subdomain / ip /
service / app / endpoint`, owned by companies. Parent-child relationships and deduplication keys
are computed by the program; agents only submit raw observations.
- **Exploration graph (per task).** The task's reasoning and progress: `goal / intent / fact /
finding / hint` nodes connected by `spawns / derived_from / yields / proves` edges into a lineage
chain.
- **Anchors link them.** `exploration_anchors(node_id, asset_id)` ties intents, facts and findings
to concrete assets: which assets a direction touched, and which intents tested a given asset.
This also powers **asset test coverage** and the coverage graph.
- **It is a prefix rule.** The command is parsed (mvdan.cc/sh, Bash grammar, as the Bash tool runs `bash -c`) and must be one simple command: no pipe, list (`;`, `&&`, `||`), redirection, prefix assignment, subshell, background job, no wrapper program (`command`, `builtin`, `env`, `exec`, `eval`), and no command or process substitution or parameter expansion anywhere. Its prefix (program plus subcommands, from a code-owned arity table: `git push`, `npm run build`, `nmap`) must equal the pattern exactly. Any other form does not match, and the normal flow (judge, approval) continues.
- **Flags are ignored by construction.** `["git","push"]` also covers `git push --force`; a flag before the subcommand (`git -C /repo push`) matches nothing. An allowed prefix does not cover what the program does internally.
- An argv rule takes its place in the priority order like any rule, and the target gate still runs after an argv allow.
```mermaid
flowchart LR
subgraph EG["Exploration graph (per-task · advance chain)"]
direction TB
G["goal"]
I1["intent A"]
F1["fact"]
I2["intent B"]
FD["finding (vulnerability)"]
G -->|spawns| I1
I1 -->|yields| F1
F1 -->|derived_from| I2
I2 -->|proves| FD
end
subgraph AG["Asset graph (globally shared · source of truth)"]
direction TB
RD["root_domain"]
SD["subdomain"]
SV["service"]
EP["endpoint"]
RD --> SD --> SV --> EP
end
I1 -. anchor .-> SD
F1 -. anchor .-> SV
I2 -. anchor .-> EP
FD -. anchor .-> EP
```
The **planner** reads the exploration graph, judges goals, and dispatches intents only when there
is an uncovered direction; a **worker** claims one intent, executes it, writes assets/facts/findings
back into both graphs, then stops.
## Traffic capture browser extension
### The engine loop
The bundled browser extension (`extension/`) turns your own browsing into agent-visible evidence: log into an authenticated target once (captchas, email OTP and 2FA included), and the captured requests/responses land in ARTEX's traffic store like proxy-recorded traffic, ready to search and bind to findings:
The engine is event-driven: any graph change wakes the planner, workers claim and execute intents,
write-back triggers the next round, until `prove_goal` closes the task.
- Load the unpacked extension from `extension/` (Chrome/Edge, Developer Mode → Load unpacked);
- In the popup, set your ARTEX URL and token, then press **Start capture** on the tab you are browsing;
- Use the site normally; text requests/responses are batched to `POST /api/traffic/ingest` (authenticated). Binary bodies (images, fonts) are skipped, bodies are truncated at 256 KiB, batches are capped at 50 entries;
- Press **Stop** when done. Everything stays in your local traffic store.
```mermaid
sequenceDiagram
autonumber
participant EV as graph-change debounce
participant P as planner
participant FR as frontier intent queue
participant W as worker
participant PX as recording proxy
participant DB as dual graphs + activity
## Asset sync (ScopeSentry)
EV-->>P: wake up
P->>DB: read situation (graph_overview prefetch + coverage/scope)
P->>FR: dispatch 0..N intents (with asset_ids)
Note over P,FR: most wake-ups dispatch 0 (no new direction means done)
W->>FR: claimNext claims one intent
W->>DB: fetch the raw assets of the intent's asset_ids
W->>PX: real tool execution (Kali / Bash / HTTP)
PX-->>W: response (fully traced + CA verified)
W->>DB: write back fact / asset / finding + per-step activity
DB-->>EV: graph change
EV-->>P: wake again (closed loop)
```
Sync asset data directly from [ScopeSentry](https://github.com/Autumn-27/ScopeSentry), avoiding duplicate collection:
### Durable attack chains, shared worker memory
- On the "**Asset Sync**" page, enter the ScopeSentry address and API Key to connect the data source;
- Choose the targets and asset types to sync by **project** or **task** (domains / subdomains / IPs / ports / sites / endpoints…);
- One-click import, merged by company asset scope, straight into ARTEX's asset graph for agents to explore.
Real attack chains are multi-step and ordered (find an injection → get credentials → move
laterally). The planner keeps a **todolist retained per task across wake-ups**: it records the
chain once, then dispatches the next step only when its prerequisites are satisfied by facts.
Workers can also **search each other's execution traces** (`search_all_worker_traces`,
`list_worker_traces`, `get_worker_trace`). Observations that never became formal facts (an error
message, a response snippet, a hidden parameter) are still reusable by the next worker, while each
worker remains confined to the intent it claimed.
---
## Features
### Evidence, not chat logs
- **Recording MITM proxy** (`:8788`) with a generated CA: every Bash/HTTP tool call is traced, and
request/response evidence can be bound to a finding.
- **Browser extension** (`extension/`) for authenticated targets: log in once (captcha, email OTP,
2FA included), capture the session, and the requests/responses land in the same traffic store.
<details>
<summary>Using the traffic capture extension</summary>
- Load the unpacked extension from `extension/` (Chrome/Edge: Developer Mode → Load unpacked);
- In the popup, set your ARTEX URL and token, then press **Start capture** on the tab you are
browsing;
- Use the site normally; text requests/responses are batched to `POST /api/traffic/ingest`
(authenticated). Binary bodies (images, fonts) are skipped, bodies are truncated at 256 KiB,
batches are capped at 50 entries;
- Press **Stop** when done. Everything stays in your local traffic store.
</details>
- **Verified findings**: findings carry a POE level, a verification status and a note; a finding is
`verified` only when a bound proof/response and verbatim evidence quotes support it. Gzip/deflate
bodies are decoded before the quote check.
- **Vulnerability retest loop**: a dedicated `retester` agent re-runs a finding with optional fixed
version/conditions, records `Still reproducible / Fixed / Cannot confirm`, and can move the
finding to `Fixed` automatically. Original evidence and reports are preserved.
- **Reports and exports**: findings, evidence and task archives, with traffic snapshots kept
encrypted at rest.
### Control without slowing down
- **Interception gate**: every tool call can require human approval, with rules by `string`,
`regex` or **argv prefix**. An argv rule is a JSON array of 1 to 8 tokens (Bash only, for
example `["git","push"]`); it matches only a single simple command whose parsed prefix equals
the pattern exactly. Pipes, lists, redirections, prefix assignments, subshells, background jobs,
wrapper programs and command/parameter substitutions do not match; flags are ignored by
construction (`["git","push"]` covers `git push --force`, but `git -C /repo push` matches
nothing). Each approval records who decided: `human`, `rule`, `model` or `system`.
- **Scope and target gate**: scope rows define the coverage denominator; assets outside the
declared scope are not explored. The target gate (off by default, API-only) can refuse
destinations that were not approved.
- **Budgets**: `ARTEX_TASK_BUDGET_TOKENS` / `ARTEX_TASK_BUDGET_TURNS` cap a whole task (planner and
workers); `ARTEX_INTENT_BUDGET_TOKENS` / `ARTEX_INTENT_BUDGET_TURNS` cap one worker run. Near the
limit the task enters a forced wrap-up; a worker is not started when the remaining budget cannot
cover it. Budgets are in memory: a restart starts fresh.
- **Noise governor**: `ARTEX_NOISE_PROFILE=quiet|balanced|aggressive` paces requests ARTEX sends to
targets (per-host rate, burst, in-flight limit, jitter, backoff on 429/503, short GET caching).
With a profile set, agents also receive low-and-slow flags for the installed scanners.
- **Untrusted-output boundary (on by default)**: tool results are framed between nonce-tagged
markers so the model treats them as data, not instructions. Disable with
`ARTEX_UNTRUSTED_BOUNDARY=0`.
### Assets and coverage
- **Coverage ledger and force-directed coverage graph**: in-scope assets are highlighted as tested
or untested, with linked intents, facts and findings per node.
- **Company-scoped asset graph**: shared across tasks, deduplicated by the program, with
domain → subdomain → service → endpoint containment.
- **ScopeSentry sync**: pull asset data from a
[ScopeSentry](https://github.com/Autumn-27/ScopeSentry) instance by project or task, merged by
company scope into the asset graph for agents to explore.
<details>
<summary>Syncing from ScopeSentry</summary>
- On the **Asset Sync** page, enter the ScopeSentry address and API key;
- Choose the targets and asset types by **project** or **task** (domains / subdomains / IPs /
ports / sites / endpoints…);
- Import: rows are merged by company asset scope and become part of the asset graph.
</details>
- **Task categories, templates, relations and archives** for repeatable engagements.
### Platform
- **LLM profiles with failover**: Anthropic, OpenAI, OpenAI-compatible relays and keyless Ollama;
multiple profiles per task with automatic failover.
- **Token accounting**: per-task and per-session usage, cache reads/writes, and an LLM record view
for every call.
- **MCP servers, skills, memory and a workspace**: extend the agent with remote tools and reusable
prompt/playbook material.
- **Single binary**: the Next.js UI is embedded with `go:embed`; PostgreSQL is the only external
dependency.
---
## Installation
> Requires a **PostgreSQL** database; exploration requires an **LLM** (`ANTHROPIC_API_KEY` or `OPENAI_API_KEY`, which can also be configured in the UI).
> Requires **PostgreSQL**; exploration requires an **LLM** (`ANTHROPIC_API_KEY` or
> `OPENAI_API_KEY`, also configurable in the UI).
### Option 1: one-click install script (recommended)
@@ -92,184 +283,92 @@ cd ARTEX
./install.sh
```
The script will: detect / auto-install Docker → then let you choose **① all-Docker** or **② local build and run**:
The script detects or installs Docker, then offers **① all-Docker** (writes `.env`, runs
`docker compose up -d --build`) or **② local build and run** (generates `config.json`, builds the
embedded binary, starts it).
- **① All-Docker**: enter a Postgres password (press Enter for a random one) → auto-writes `.env` → `docker compose up -d --build` (the image is built from this checkout).
- **② Local run**: choose a database (connect to an existing one / start one with Docker) → generates `config.json` → `go` builds the embedded single binary → starts.
Open **http://localhost:8787**; `/setup` asks for the one-time setup token printed at startup
(`docker compose logs artex | grep "Setup token"`).
Once installed, open **http://localhost:8787** (on first entry, `/setup` sets the admin password).
`/setup` asks for a one-time setup token: while no password is set, the backend prints it at startup in its log (`docker compose logs artex | grep "Setup token"`, or the terminal running `./start.sh`).
The web UI is published on `127.0.0.1` by default. To reach it from another machine, or from Windows when ARTEX runs inside WSL, set `ARTEX_BIND_ADDR=0.0.0.0` in `.env` (the setup token still protects the first-run claim), or keep loopback and use a reverse proxy or an SSH tunnel.
The UI listens on `127.0.0.1` by default. To reach it from another machine (or from Windows when
ARTEX runs inside WSL), set `ARTEX_BIND_ADDR=0.0.0.0` in `.env` (the setup token still protects the
first-run claim), or keep loopback and use a reverse proxy or SSH tunnel.
### Option 2: Docker Compose (manual)
```bash
git clone https://github.com/BaaRai/ARTEX.git
cd ARTEX
cp .env.example .env # set POSTGRES_PASSWORD, optionally ANTHROPIC_API_KEY
docker compose up -d --build # builds artex from this checkout + starts postgres
cp .env.example .env # set POSTGRES_PASSWORD, optionally ANTHROPIC_API_KEY
docker compose up -d --build
# → http://localhost:8787
```
> The image is built locally. There is no published image to pull: the previous
> default pointed at a third-party namespace that no longer hosts this project.
The image includes a scanner toolchain (`nmap`, `nuclei`, `httpx`, `katana`, `ffuf`, `dalfox`,
`sqlmap`, `ripgrep`, `curl`, `npm`, …); `./skills` and `./data` are persisted via bind mounts.
The image already includes common tools (ripgrep/curl/vim/npm/nmap…); `./skills` and `./data` are persisted via bind mounts.
For remote MCP you can choose `http` (Streamable HTTP) or `sse` (legacy SSE) in system settings.
Legacy SSE servers usually establish the event stream with `GET /sse` and receive JSON-RPC over
`/message?sessionId=...`; configure the URL as `/sse` and send `Authorization: Bearer <token>`.
For remote MCP, you can choose `http` (Streamable HTTP) or `sse` (legacy SSE) in system settings.
Legacy SSE servers usually establish the event stream with `GET /sse`, then receive JSON-RPC requests via the
`/message?sessionId=...` returned by the server; when configuring, set the URL to `/sse` and the request header as
`Authorization=Bearer <token>`.
### Option 3: prebuilt binaries (Releases)
### Option 3: download prebuilt binaries (Releases)
Download the zip for your platform from [Releases](https://github.com/BaaRai/ARTEX/releases); after extracting you get `artex` + `start.sh` (`start.bat` on Windows) + `skills/` + `config.example.json`:
Download the zip for your platform from [Releases](https://github.com/BaaRai/ARTEX/releases). It
contains `artex`, `start.sh` (`start.bat` on Windows), `skills/` and `config.example.json`:
```bash
cp config.example.json config.json # fill in the database connection
./start.sh # → http://localhost:8787
```
> Please start with `start.sh` / `start.bat` instead of running `./artex` directly. It is a daemon script: if the process crashes, it restarts it after a backoff.
> To keep it running in the background: `nohup ./start.sh >artex.log 2>&1 &`.
Start with `start.sh` / `start.bat`, not `./artex`: it is a daemon script that restarts the process
after a backoff. To keep it in the background: `nohup ./start.sh >artex.log 2>&1 &`.
#### Verifying a release
Each release attaches `SHA256SUMS` and a CycloneDX SBOM, `artex-<tag>.cdx.json` (Go modules embedded in the linux/amd64 binary, the frontend `package-lock.json`, and `go.mod`/`go.sum`), next to the zips. The zips also carry a GitHub build provenance attestation. Releases published before this was added have neither the SBOM nor the attestation.
Each release attaches `SHA256SUMS` and a CycloneDX SBOM, `artex-<tag>.cdx.json` (Go modules in the
linux/amd64 binary, the frontend `package-lock.json`, `go.mod`/`go.sum`), next to the zips. The zips
also carry a GitHub build provenance attestation. Releases published before this was added have
neither.
```bash
sha256sum -c SHA256SUMS # add --ignore-missing if you downloaded only some zips
gh attestation verify <zip> --repo BaaRai/ARTEX # provenance: built by this repository's release workflow
gh attestation verify <zip> --repo BaaRai/ARTEX # built by this repository's release workflow
```
### Option 4: build the single binary from source
```bash
# 1) frontend static export
cd web && npm ci && npm run build:static && cd ..
# 2) copy into the embed directory
cp -r web/out server/webui/dist
# 3) build (only -tags embedui embeds the frontend)
CGO_ENABLED=0 go build -tags embedui -o artex ./cmd/artex
./start.sh
```
### Option 5: build cross-platform release archives
Only `-tags embedui` embeds the frontend into the binary.
`build.sh` first builds and embeds the frontend, then strips debug info via the Go linker, and compresses the release files into zips. Release mode generates zips for Linux amd64/arm64, macOS amd64/arm64, and Windows amd64 by default:
### Option 5: cross-platform release archives
`build.sh` builds and embeds the frontend, strips debug info, and writes zips for Linux
amd64/arm64, macOS amd64/arm64 and Windows amd64 by default:
```bash
./build.sh --release
# output: dist/artex-0.3.3-*.zip
```
# output: dist/artex-<version>-*.zip
UPX self-extracting binaries may be incompatible with some Linux kernels, virtualization environments, or security policies, so they are disabled by default. Use `ARTEX_TARGETS` to customize the targets; when you have confirmed the target runtime is compatible, explicitly pass `--upx` to further shrink the binary:
```bash
ARTEX_TARGETS=linux/amd64,windows/amd64 ./build.sh --release
./build.sh --target linux/amd64 --upx
```
---
## Backups
`scripts/backup.sh` dumps the Postgres database (and optionally the data
directory) with timestamped output and rotation:
```bash
scripts/backup.sh --with-data # db dump + data/ archive, keep 14
scripts/backup.sh --keep 7 # db only, keep 7
```
Restore a dump into a running stack:
```bash
gunzip -c backups/artex-db-<timestamp>.sql.gz | docker compose exec -T postgres \
psql -U "$POSTGRES_USER" -d "$POSTGRES_DB"
```
Stored secrets (LLM API keys and proxies, MCP env, task credentials,
notification channel config, the Brave and Tavily search keys, the web search
and global proxies, the execution spec of custom tools) are encrypted in the database with the key in `keys/secret.key`
(generated at first start, mode 0600, next to `jwt.key`). **A database backup
without that key can no longer restore those secrets**: back up `keys/` with the
dump, separately. Deployments without a persistent disk set `ARTEX_SECRET_KEY`
(32 bytes, base64 or hex, e.g. `openssl rand -base64 32`) instead. ARTEX refuses
to start when the database holds encrypted secrets and no key is available.
Daily cron example (03:20, operator crontab):
```
20 3 * * * cd /path/to/ARTEX && scripts/backup.sh --with-data >> backups/backup.log 2>&1
```
## Updating and upgrading
> Upgrading only swaps the program and never touches data: the Postgres volume `pgdata`, `./data` (SQLite, task files, etc.), `./keys` (jwt.key), and `./skills` are all preserved. **No manual database migration is needed**: `artex` idempotently re-runs `schema.sql` on every start (with `ADD COLUMN` / `CREATE INDEX IF NOT EXISTS`), i.e. "restart equals migrate". It is still recommended to back up `./data` and the database before upgrading.
**Update banner (opt-in, off by default)**: start ARTEX with `ARTEX_UPDATE_CHECK=1` to have the backend ask the public GitHub releases API for the latest ARTEX tag, at most once per 24 hours (cached in memory; a failed check is not retried within that window). When the release is newer than the running version, the web UI shows a small dismissible strip linking to the Releases page. The request sends only the `User-Agent: artex-update-check` header. Unset, ARTEX makes no update request and shows no banner.
### Upgrading from a clone made before 2026-10-23
The repository history was rewritten that day to drop a personal email address from the commit metadata. A clone made before then cannot fast-forward, and `./update.sh` now stops instead of silently rebuilding stale code. Recover once, then upgrade normally:
```bash
git stash # only if you have local changes
git fetch origin
git reset --hard origin/main
git stash pop # only if you stashed
```
Your data is not affected: `./data`, the `pgdata` volume and `./skills` are not part of the git history.
### Option 1: one-click update script
```bash
cd ARTEX
./update.sh
```
The script first optionally `git pull`s the latest code, then lets you choose **① Docker update** or **② local build update** (matching `install.sh`):
- **① Docker**: rebuilds the image from this checkout → `docker compose build artex` → `docker compose up -d artex` (restarting migrates the schema automatically).
- **② Local**: rebuild the frontend static assets → recompile `./artex` (restart the process for it to take effect).
### Option 2: Docker Compose (manual)
```bash
cd ARTEX
git pull # update compose / scripts
docker compose build artex # rebuild the image from this checkout
docker compose up -d artex # recreate the container → schema migrates automatically
docker image prune -f # clean up old images (optional)
```
### Option 3: prebuilt binaries (Releases)
Download the new version's zip from [Releases](https://github.com/BaaRai/ARTEX/releases), stop the old process, then overwrite `artex` and `skills/` (keep your `config.json` and `data/`), and restart:
```bash
cp -r <extracted dir>/skills ./ && cp <extracted dir>/artex ./
./start.sh
```
### Option 4: build from source
```bash
git pull
cd web && npm ci && npm run build:static && cd ..
cp -r web/out server/webui/dist
CGO_ENABLED=0 go build -tags embedui -o artex ./cmd/artex
# restart ./start.sh
```
UPX is disabled by default: self-extracting binaries may be incompatible with some kernels,
virtualization environments or security policies. Pass `--upx` only after confirming the target
runtime supports it.
---
## Configuration
**Database** (`config.json`, or override with the `ARTEX_PG_DSN` environment variable):
**Database** (`config.json`, or the `ARTEX_PG_DSN` environment variable):
```json
{
@@ -281,28 +380,60 @@ CGO_ENABLED=0 go build -tags embedui -o artex ./cmd/artex
}
```
**LLM**: `export ANTHROPIC_API_KEY=sk-...` (or `OPENAI_API_KEY`); you can also fill it in on the UI's "LLM Configuration" page — which can add a local Ollama server as a keyless provider (format "Ollama", base URL default `http://127.0.0.1:11434/v1`, models loaded from the server).
Optional: `ARTEX_LLM_PROVIDER` (anthropic | openai | openai-responses | ollama) / `ARTEX_LLM_MODEL` / `ARTEX_LLM_BASE_URL` / `ARTEX_LLM_PROXY`.
**LLM**: `export ANTHROPIC_API_KEY=sk-...` (or `OPENAI_API_KEY`), or configure it in the UI's
"LLM Configuration" page, which can also add a local Ollama server as a keyless provider (format
"Ollama", default base URL `http://127.0.0.1:11434/v1`). Optional:
`ARTEX_LLM_PROVIDER` (`anthropic | openai | openai-responses | ollama`), `ARTEX_LLM_MODEL`,
`ARTEX_LLM_BASE_URL`, `ARTEX_LLM_PROXY`.
**Base URL**: for the Anthropic format, enter the host **without** a `/v1` suffix (e.g. `https://api.anthropic.com`) — the provider appends `/v1/messages` itself, so a base ending in `/v1` becomes `https://api.anthropic.com/v1/v1/messages`. OpenAI-format providers append `/chat/completions` (or `/responses` for the `openai-responses` format), so their base **does** end in `/v1` (e.g. `https://api.openai.com/v1`).
**Base URL gotcha**: for the Anthropic format, enter the host **without** `/v1` (for example
`https://api.anthropic.com`); ARTEX appends `/v1/messages`. OpenAI-format providers append
`/chat/completions` (or `/responses` for `openai-responses`), so their base **does** end in `/v1`
(for example `https://api.openai.com/v1`).
**Concurrency**: the number of work agents per task is configured in "System Settings" (default 3).
**Concurrency**: work agents per task, in "System Settings" (default 3).
**Untrusted-output boundary (on by default)**: tool results for the worker, planner, chat and main agent are framed between nonce-tagged markers so the model treats them as data, not instructions. Unset or empty, the boundary is on; set `ARTEX_UNTRUSTED_BOUNDARY=0` (or `false` / `off` / `no`) to disable it. Measured cost: about 154 bytes per tool result plus one system note.
**Untrusted-output boundary (on by default)**: tool results for the worker, planner, chat and main
agent are framed between nonce-tagged markers so the model treats them as data, not instructions.
Unset or empty, the boundary is on; set `ARTEX_UNTRUSTED_BOUNDARY=0` (or `false` / `off` / `no`) to
disable it. Cost: about 154 bytes per tool result plus one system note.
**Noise profile (off by default)**: `ARTEX_NOISE_PROFILE` paces the requests ARTEX itself sends to targets (WebFetch, http custom tools, the enrich probe). Unset or `off`, nothing changes: no limit, no cache. Set `quiet` (2 req/s per host, burst 4, 1 in flight), `balanced` (5 req/s, burst 10, 2 in flight) or `aggressive` (20 req/s, burst 40, 4 in flight), e.g. `ARTEX_NOISE_PROFILE=balanced` in `.env` or the environment. A profile also adds a small jitter, backs off on 429/503 (honouring `Retry-After`, bounded retries, GET/HEAD/OPTIONS only), and, for the http custom tools and the enrich probe, merges identical in-flight GETs of one task (per tool) and caches them briefly (60/30/10 s; never POST, PUT, PATCH or DELETE; WebFetch is paced only), and logs a per-host noise line each minute. `ARTEX_TARGET_USER_AGENT` sets a User-Agent on target requests that carry none, under a profile; empty keeps the current one. Tools launched through Bash are not paced yet.
**Noise profile (off by default)**: `ARTEX_NOISE_PROFILE` paces the requests ARTEX sends to targets
(WebFetch, HTTP custom tools, the enrich probe). Unset or `off` keeps today's behaviour: no limit,
no cache. `quiet` = 2 req/s per host (burst 4, 1 in flight), `balanced` = 5 req/s (burst 10, 2 in
flight), `aggressive` = 20 req/s (burst 40, 4 in flight). A profile adds jitter, backs off on
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.
**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 exact rate/delay flags for the scanners installed in the image (`nmap`, `nuclei`, `httpx`, `katana`, `ffuf`, `dalfox`, `sqlmap`). It tells them to test one host at a time, to back off on 429/503 and never to raise the rate to meet a deadline. Unset or `off`, the block is empty and every prompt is unchanged. Commands launched through Bash are not paced by the governor, so these flags are the brake for scanners.
**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
exact rate/delay flags for the installed scanners. It tells them to test one host at a time, back
off on 429/503 and never raise the rate to meet a deadline.
**Run budgets (off by default)**: `ARTEX_TASK_BUDGET_TOKENS` and `ARTEX_TASK_BUDGET_TURNS` cap a task's total spend (its planner rounds and all its workers); `ARTEX_INTENT_BUDGET_TOKENS` and `ARTEX_INTENT_BUDGET_TURNS` cap one worker run. Unset or `0` means unlimited, and nothing changes. A worker is not started when the remaining task budget cannot cover its estimated cost (the average of the task's finished workers, else 50000 tokens and 10 turns). When the remaining budget reaches the wrap-up reserve (the larger of 5% and 20000 tokens, and 2 turns), the task enters a forced wrap-up: the planner writes a summary and the final goal judgment, and workers may only write back (`record_fact`, `insert_assets`, `report_finding`, `update_finding_report`). The task then ends `done` if its goals are met, otherwise `timeout`. Budgets are kept in memory: a restart, or a revive of a finished task, starts a fresh budget. Each planner round logs a `[budget]` line. Practical floor: below 50000 tokens a task gets no worker; from 50000 to about 70000 it typically gets one worker and then the wrap-up. Pick a budget well above 70000 tokens for real exploration.
**Run budgets (off by default)**: `ARTEX_TASK_BUDGET_TOKENS` / `ARTEX_TASK_BUDGET_TURNS` cap a
task's total spend (planner rounds and workers); `ARTEX_INTENT_BUDGET_TOKENS` /
`ARTEX_INTENT_BUDGET_TURNS` cap one worker run. Unset or `0` means unlimited. A worker is not
started when the remaining task budget cannot cover its estimated cost (the average of finished
workers, else 50,000 tokens and 10 turns). Near the wrap-up reserve (the larger of 5% and 20,000
tokens, and 2 turns) the task enters a forced wrap-up: the planner writes a summary and final goal
judgment, and workers may only write back. The task then ends `done` if its goals are met, else
`timeout`. Practical floor: below 50,000 tokens no worker starts; 50,000-70,000 typically gives one
worker then wrap-up; pick well above 70,000 for real exploration.
**Common flags**: `./start.sh -addr :8787 -proxy :8788` (`-addr` frontend+API, `-proxy` traffic recording proxy). The startup script passes arguments through to `artex` verbatim.
**Common flags**: `./start.sh -addr :8787 -proxy :8788` (`-addr` frontend/API, `-proxy` traffic
recording proxy).
### Reverse proxy deployment (HTTPS / only exposing 443)
### Reverse proxy deployment (HTTPS / exposing only 443)
The frontend and API/SSE are served by the same backend port (8787; the binary listens on `127.0.0.1:8787` by default, the Docker container on `:8787` published on `127.0.0.1`), and the realtime activity stream uses the **same-origin** address by default, so **there is no need to configure `NEXT_PUBLIC_SSE_BASE`**: just expose 443 publicly and keep 8787 on the internal network.
The frontend, API and SSE stream share port 8787 (the binary listens on `127.0.0.1:8787` by
default; the Docker container publishes on `127.0.0.1`), and the activity stream is same-origin by
default, so **no `NEXT_PUBLIC_SSE_BASE` is needed**: expose 443 and keep 8787 internal.
SSE is a long-lived connection with continuous pushes, so the reverse proxy **must disable buffering**, otherwise the browser connects but never receives events (the activity stream spins forever). Nginx example:
SSE keeps a long-lived connection with continuous pushes, so the proxy **must disable buffering**;
otherwise the browser connects but never receives events. Nginx example:
```nginx
server {
@@ -326,33 +457,138 @@ server {
}
```
**Login rate limit behind a proxy**: login allows 10 attempts per minute per client IP. Behind a proxy every request comes from the proxy's address, so without further setup all users share one budget and an attacker who fails 10 logins blocks everyone, admin included, for up to 15 minutes. To avoid that, keep the `X-Forwarded-For` line above and set `ARTEX_TRUSTED_PROXIES` (comma-separated CIDRs, empty by default) to the address ARTEX sees the proxy connect from:
**Login rate limit behind a proxy**: login allows 10 attempts per minute per client IP. Behind a
proxy every request comes from the proxy's address, so without further setup all users share one
budget and an attacker who fails 10 logins blocks everyone, admin included, for up to 15 minutes.
Keep the `X-Forwarded-For` line and set `ARTEX_TRUSTED_PROXIES` (comma-separated CIDRs, empty by
default) to the address ARTEX sees the proxy connect from:
- **nginx and ARTEX both on the host** (binary, `./start.sh`): the peer is `127.0.0.1`. Start ARTEX with `ARTEX_TRUSTED_PROXIES=127.0.0.1/32`.
- **nginx on the host, ARTEX in Docker** (`docker-compose.yml`): the connection reaches the container from the Docker bridge gateway (a `172.x` address), not from `127.0.0.1`. Find it with `docker network inspect artex_default --format '{{(index .IPAM.Config 0).Gateway}}'` (the network is `<project directory>_default`; `docker network ls` lists it), put `ARTEX_TRUSTED_PROXIES=<gateway>/32` in `.env`, and run `docker compose up -d`.
- **nginx and ARTEX both on the host** (binary, `./start.sh`): the peer is `127.0.0.1`; start ARTEX
with `ARTEX_TRUSTED_PROXIES=127.0.0.1/32`.
- **nginx on the host, ARTEX in Docker** (`docker-compose.yml`): the connection reaches the
container from the Docker bridge gateway (a `172.x` address), not from `127.0.0.1`. Find it with
`docker network inspect artex_default --format '{{(index .IPAM.Config 0).Gateway}}'` (the network
is `<project directory>_default`), put `ARTEX_TRUSTED_PROXIES=<gateway>/32` in `.env`, then
`docker compose up -d`.
For a peer in that list, ARTEX reads `X-Forwarded-For` from the right and takes the first address that is not a trusted proxy; from any other peer the header is ignored. Trust only addresses of proxies you run: a trusted peer can claim any client address.
For a peer in that list, ARTEX reads `X-Forwarded-For` from the right and takes the first address
that is not a trusted proxy; from any other peer the header is ignored. Trust only proxies you run:
a trusted peer can claim any client address.
> Only when SSE needs a different origin from the page (e.g. a dedicated subdomain) should you set `NEXT_PUBLIC_SSE_BASE` **at build time** (this variable is baked into the static bundle during `next build`; setting it at container runtime has no effect).
> Only when SSE needs a different origin from the page (e.g. a dedicated subdomain) should you set
> `NEXT_PUBLIC_SSE_BASE` **at build time** (it is baked into the static bundle during `next build`;
> setting it at container runtime has no effect).
---
## Operations
### Backups
`scripts/backup.sh` dumps the Postgres database (and optionally the data directory) with
timestamped output and rotation:
```bash
scripts/backup.sh --with-data # db dump + data/ archive, keep 14
scripts/backup.sh --keep 7 # db only, keep 7
```
Restore into a running stack:
```bash
gunzip -c backups/artex-db-<timestamp>.sql.gz | docker compose exec -T postgres \
psql -U "$POSTGRES_USER" -d "$POSTGRES_DB"
```
Stored secrets (LLM API keys and proxies, MCP env, task credentials, notification channel config,
Brave/Tavily search keys, web search and global proxies, the execution spec of custom tools) are
encrypted in the database with the key in `keys/secret.key` (generated at first start, mode 0600,
next to `jwt.key`). **A database backup without that key cannot restore those secrets**: back up
`keys/` with the dump, separately. Deployments without a persistent disk set
`ARTEX_SECRET_KEY` (32 bytes, base64 or hex, e.g. `openssl rand -base64 32`). ARTEX refuses to start
when the database holds encrypted secrets and no key is available.
Daily cron example (03:20, operator crontab):
```
20 3 * * * cd /path/to/ARTEX && scripts/backup.sh --with-data >> backups/backup.log 2>&1
```
### Updating and upgrading
> Upgrading swaps the program and never touches data: the Postgres volume `pgdata`, `./data`
> (traffic index, task files, transcripts), `./keys` (`jwt.key`, `secret.key`) and `./skills` are
> preserved. **No manual database step is needed**: on every start ARTEX applies its embedded
> `schema.sql` baseline, then any pending numbered migration from `db/migrations/`, in order, each
> in its own transaction. Restarting the new binary is the upgrade. Back up `./data`, `keys/` and
> the database before upgrading.
**Update banner (opt-in, off by default)**: start ARTEX with `ARTEX_UPDATE_CHECK=1` to ask the
public GitHub releases API for the latest tag, at most once per 24 hours (cached in memory; a
failed check is not retried within that window). When the release is newer, the web UI shows a
dismissible strip linking to Releases. The request sends only `User-Agent: artex-update-check`.
Unset, ARTEX makes no update request and shows no banner.
#### Upgrading from a clone made before 2026-10-23
The repository history was rewritten that day to drop a personal email address from the commit
metadata. A clone made before then cannot fast-forward, and `./update.sh` now stops instead of
silently rebuilding stale code. Recover once, then upgrade normally:
```bash
git stash # only if you have local changes
git fetch origin
git reset --hard origin/main
git stash pop # only if you stashed
```
Your data is unaffected: `./data`, the `pgdata` volume and `./skills` are not part of git history.
#### Option 1: one-click update script
```bash
cd ARTEX
./update.sh
```
The script optionally `git pull`s, then offers **① Docker update** (`docker compose build artex` →
`docker compose up -d artex`) or **② local build update** (rebuild the frontend static assets, then
recompile `./artex`; restart the process for it to take effect).
#### Option 2: Docker Compose (manual)
```bash
cd ARTEX
git pull
docker compose build artex
docker compose up -d artex
docker image prune -f # optional
```
#### Option 3: prebuilt binaries
Download the new zip, stop the old process, overwrite `artex` and `skills/` (keep `config.json` and
`data/`), then restart:
```bash
cp -r <extracted dir>/skills ./ && cp <extracted dir>/artex ./
./start.sh
```
#### Option 4: build from source
```bash
git pull
cd web && npm ci && npm run build:static && cd ..
cp -r web/out server/webui/dist
CGO_ENABLED=0 go build -tags embedui -o artex ./cmd/artex
# restart ./start.sh
```
---
## Development
### Manual vulnerability retesting
The "Retest" tab on the task details page lets you page through the task's vulnerabilities, review past conclusions and evidence, and manually start a retest. After starting, the current tab keeps its place and shows a spinner with "Retesting"; once the fix is confirmed, the vulnerability status is updated accordingly.
Click "Retest" in the actions area of any row in the vulnerability list, or click "Start Retest" in the "Vulnerability Retest" area of the vulnerability details; fill in the optional fixed version, test conditions, or limits, and the system creates an independent retest agent session while keeping the current page. The flat list, group-by-task, and asset views all support this entry point; while a retest is running, a spinner and "Retesting" are shown: click to enter the corresponding session to watch, and it reverts to "Retest" when finished. Retesting does not require restarting the original scan task; conclusions are "Still reproducible", "Fixed", or "Cannot confirm", and each conclusion, evidence, and session link is saved in the vulnerability details.
On first start, the new backend pre-creates an editable "Vulnerability Retest" (`retester`) agent; you can configure its prompt, LLM, run budget, and tools in Agent management. It uses its bound LLM by default, or the global active configuration when unbound. When a retest session completes successfully with a "Fixed" conclusion, the system automatically sets the vulnerability's handling status to "Fixed"; running, failed, stopped, or other conclusions keep the original status. Original evidence and reports are always preserved. You can also manually select "Fixed" from the status dropdown. While the same vulnerability is being retested, the existing session is reused; after a stop, failure, or service restart, you can start it again.
In this version, history is viewed via vulnerability details and sessions; it is not yet included in vulnerability report exports or task archive packages, and is not automatically linked to traffic captures. Demo mode only generates clearly labeled simulated records and never requests real targets.
### Running and testing locally
```bash
./dev.sh # backend(:8787) + traffic proxy(:8788) + frontend next dev(:5173) → http://localhost:5173
```
@@ -364,11 +600,14 @@ In this version, history is viewed via vulnerability details and sessions; it is
---
## System architecture
## Architecture
ARTEX is an **LLM multi-agent-driven autonomous penetration testing system**: a Go monolithic backend (with embedded Next.js frontend) + PostgreSQL; agent capabilities are provided by the [`norma`](https://github.com/Autumn-27/norma) SDK (`agentcore` / `tool` / `permission` / `harness` / `memory` / `transcript`). At its core is a **dual-graph architecture**, plus two autonomy mechanisms built around it: **process-level information exchange between workers** and the **planner's multi-round shared todolist that stabilizes attack chains**.
### Overall layering
ARTEX is an **LLM multi-agent-driven autonomous penetration testing system**: a Go monolithic
backend (with the Next.js UI embedded) + PostgreSQL. Agent capabilities come from the
[`norma`](https://github.com/Autumn-27/norma) SDK (`agentcore` / `tool` / `permission` / `harness` /
`memory` / `transcript`). At its core is the **dual-graph architecture**, plus two autonomy
mechanisms: **process-level information exchange between workers** and the **planner's multi-round
shared todolist**.
```mermaid
flowchart TB
@@ -417,158 +656,89 @@ flowchart TB
| Layer | Responsibility |
| --- | --- |
| **Frontend** | Next.js static export, embedded into the single binary via `go:embed`; visualizes tasks/assets/exploration graph/coverage graph, human-in-the-loop chat |
| **server** | `net/http` routing + JWT auth + SSE; `Manager` owns the lifecycle of tasks, engines, and DB stores |
| **Frontend** | Next.js static export embedded via `go:embed`; tasks, assets, exploration and coverage graphs, traffic, human-in-the-loop chat |
| **server** | `net/http` routing, JWT auth, SSE; `Manager` owns tasks, engines and DB stores |
| **engine** | One `plannerLoop` + N worker goroutines per task; intent claiming, timeout/pause/drain |
| **agent** | goals / planner / worker / mainagent; `ToolSet` exposes the dual graphs as LLM tools |
| **db** | Postgres persistence of the dual graphs (pgx); the schema is embedded via `go:embed` and idempotently applied on every start |
| **db** | PostgreSQL persistence (pgx); embedded schema and numbered migrations applied at startup |
| **Supporting** | Recording MITM proxy, approval gate, async enrichment, MCP/skills/memory/report |
### Dual-graph architecture: exploration graph + asset graph
The system splits "**what the goals are**" and "**how far testing has progressed**" into two mutually independent graphs linked by anchors:
- **Asset Graph (globally shared)**: a single source of truth for assets shared across tasks. Nodes are `root_domain / subdomain / ip / service / app / endpoint`, owned by companies; the parent-child relationships domain→subdomain→service→endpoint and the dedup keys are all computed by the program: agents only submit raw information.
- **Exploration Graph (per-task)**: the "thinking and advancing" process of one task. Nodes are `goal` / `intent` / `fact` / `finding (vulnerability)` / `hint`, connected by edges like `spawns / derived_from / yields / proves` into a **lineage chain**, answering "which directions derive from which facts, and what they produced".
- **The two graphs are linked by anchors**: `exploration_anchors(node_id, asset_id)` anchors intents/facts/vulnerabilities to concrete assets: so you can see which assets an exploration direction hits, and conversely look up from a given asset which intents tested it in this task and which facts were derived. This also powers **asset test coverage** and the **asset coverage graph** (in-scope assets + tested highlights).
```mermaid
flowchart LR
subgraph EG["Exploration graph (per-task · advance chain)"]
direction TB
G["goal"]
I1["intent A"]
F1["fact"]
I2["intent B"]
FD["finding (vulnerability)"]
G -->|spawns| I1
I1 -->|yields| F1
F1 -->|derived_from| I2
I2 -->|proves| FD
end
subgraph AG["Asset graph (globally shared · source of truth)"]
direction TB
RD["root_domain"]
SD["subdomain"]
SV["service"]
EP["endpoint"]
RD --> SD --> SV --> EP
end
I1 -. anchor .-> SD
F1 -. anchor .-> SV
I2 -. anchor .-> EP
FD -. anchor .-> EP
```
> Division of labor: the **planner** reads the exploration graph's situation, judges goals, and dispatches **intents** into the frontier only when there are uncovered new directions; a **worker** claims **one intent**, executes with real tools, writes new assets/facts/vulnerabilities back into both graphs, then stops. The asset graph is shared facts; the exploration graph is the per-task advance chain.
### Engine and intent lifecycle (the closed loop of one exploration)
The engine is an **event-driven** closed loop: any graph change wakes the planner, the planner dispatches intents, workers claim and execute intents and write back, and the write-back triggers the next round, until the goal is proven (`prove_goal`).
```mermaid
sequenceDiagram
autonumber
participant EV as graph-change debounce
participant P as planner
participant FR as frontier intent queue
participant W as worker
participant PX as recording proxy
participant DB as dual graphs + activity
EV-->>P: wake up
P->>DB: read situation (graph_overview prefetch + coverage/scope)
P->>FR: dispatch 0..N intents (with asset_ids)
Note over P,FR: most wake-ups dispatch 0 (no new direction means done)
W->>FR: claimNext claims one intent
W->>DB: fetch the raw assets of the intent's asset_ids as initial information
W->>PX: real tool execution (Kali / Bash / HTTP)
PX-->>W: response (fully traced + CA verified)
W->>DB: write back fact / asset / finding + per-step activity
DB-->>EV: graph change
EV-->>P: wake again (closed loop)
```
### Process-level information exchange between workers
During a deep exploration, many valuable observations (an error, a response snippet, a hidden parameter) appear in a worker's **execution process** but may never be written as formal facts. To avoid duplicate work and let workers on the chain stand on each other's shoulders, workers can **search processes across works**:
- `search_all_worker_traces(q)`: keyword-search the **execution processes of other works in this task** (automatically excluding the steps of your own intent); hits carry `intent_id`;
- `list_worker_traces` / `get_worker_trace(intent_id, step_ids=[…])`: first see which works have run, then fetch the full content of specific steps of a given work for detailed exchange.
This way, even before a corresponding fact exists on the exploration graph, later workers can reuse observations from others' processes: **information flows between workers at "execution process" granularity**, while the boundary stays the same (each worker still only works on the intent it claimed).
```mermaid
flowchart LR
WA["worker A (intent #12)"] -->|"per-step activity"| ACT[("exploration graph · activity process store")]
WB["worker B (intent #34)"] -->|"per-step activity"| ACT
WC["worker C (intent #56)"] ==>|"1) search_all_worker_traces(q)"| ACT
ACT ==>|"2) hits on A/B steps (self excluded)"| WC
WC ==>|"3) get_worker_trace(id, step_ids)"| ACT
ACT ==>|"4) returns full process content"| WC
```
### The planner's multi-round shared todolist → stable attack chains
Real attack chains are usually **multi-step sequences with dependencies** (e.g.: find an injection point → obtain credentials → move laterally → escalate privileges); dispatching them all in parallel at once would only cause chaos. The planner therefore keeps a **planning todolist that is retained per task and shared across wake-ups**:
- The planner is event-driven, woken on every graph change, but **each wake-up is a brand-new session**; the shared todolist lets it **record a serial exploitation chain once**, then **dispatch intents step by step by dependency** over subsequent rounds, instead of pre-expanding the whole chain in a single round;
- Each round only dispatches intents for next steps whose "prerequisite steps are complete and the facts they depend on exist", and updates the list as progress happens (marking steps satisfied by facts as done).
```mermaid
flowchart TB
subgraph TODO["Shared todolist (retained per task · persists across wake-ups)"]
direction LR
T1["1 injection point [done]"]
T2["2 get credentials [in progress]"]
T3["3 lateral movement [pending prerequisite]"]
T4["4 privilege escalation [pending prerequisite]"]
T1 -.prerequisite met.-> T2 -.-> T3 -.-> T4
end
R1["round 1 wake-up dispatch intent ①"] --> T1
R2["round 2 (① produced a fact) dispatch intent ②"] --> T2
R3["round 3 (② produced a fact) dispatch intent ③"] --> T3
```
Thus, even in an "event-driven + stateless session" environment, the attack chain still **advances steadily, without repetition or reordering**: this is the key to ARTEX autonomously completing multi-step exploitation chains.
---
## References
## Security
https://github.com/oritera/Cairn
Please report vulnerabilities privately through GitHub Security Advisories; see
[SECURITY.md](SECURITY.md).
Operational security properties:
- **Secrets at rest**: LLM keys/proxies, MCP environment, task credentials, notification config,
search keys, proxies, custom-tool execution specs and traffic evidence snapshots are encrypted
with AES-256-GCM using `keys/secret.key` (or `ARTEX_SECRET_KEY`). ARTEX refuses to start when
encrypted data exists and no usable key is available.
- **First-run claim**: `/setup` requires a one-time token printed at startup; the UI binds to
`127.0.0.1` by default.
- **Login protection**: 10 attempts per minute per client IP, with `ARTEX_TRUSTED_PROXIES` for
correct client attribution behind a reverse proxy.
- **Untrusted tool output**: framed as data for every agent by default (prompt-injection boundary).
- **Release integrity**: SHA-256 sums, CycloneDX SBOM and GitHub build provenance attestations for
release archives.
---
## References and prior art
- [Cairn](https://github.com/oritera/Cairn)
- Approval-details UI inspired by [AegisHook](https://github.com/RuoJi6/AegisHook)
---
## License and disclaimer
### Open source license
This project is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**; see the [LICENSE](LICENSE) file in the repository root for the full terms.
This project is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**; see the
[LICENSE](LICENSE) file for the full terms.
This means anyone may freely use, modify, and distribute this project, but **derivative works must also be open-sourced under AGPL-3.0**; in particular, **if you modify this project and provide it to users over a network (e.g. deployed as an online service), you must also make the corresponding complete source code available to those users**.
Anyone may use, modify and distribute this project, but **derivative works must also be open-sourced
under AGPL-3.0**; in particular, **if you modify this project and provide it to users over a
network (for example as an online service), you must make the corresponding complete source code
available to those users**.
> ⚠️ **Important**: the open source license itself does not restrict how the software is used. The "Usage restrictions" and "Disclaimer" below are additional terms and a solemn statement from the maintainers to users, so please abide by them.
> **Important**: the open source license does not restrict how the software is used. The usage
> restrictions and disclaimer below are additional terms from the maintainers.
**ARTEX is an offensive-security tool. Use it only against systems you own, or that you are explicitly authorized to test (your own lab, your organization's assets, or a bug bounty / vulnerability disclosure program's targets within its published scope and rules of engagement). Any use without authorization is a violation of these terms.**
**ARTEX is an offensive-security tool. Use it only against systems you own, or that you are
explicitly authorized to test (your own lab, your organization's assets, or a bug bounty /
vulnerability disclosure program's targets within its published scope and rules of engagement).
Any use without authorization violates these terms.**
### Permitted use
- **Read, learn, and study this project's source code**;
- Run it against **systems you own** or in **isolated lab environments**;
- Run it against **authorized bug bounty / vulnerability disclosure program targets**, within their published scope and rules of engagement;
- Read, learn and study this project's source code;
- Run it against systems you own or in isolated lab environments;
- Run it against authorized bug bounty / vulnerability disclosure targets, within their published
scope and rules of engagement;
- Academic research and code review.
### Prohibited actions
- **It is strictly forbidden to scan, probe, exploit, or attack any website, online service, or networked system without the explicit authorization of its owner**;
- It is strictly forbidden to test outside a program's published scope, or in violation of its rules of engagement;
- It is strictly forbidden to use this tool for illegal intrusion, data theft, extortion, denial of service, or any destructive or criminal activity;
- It is strictly forbidden to use this tool for anything that violates the laws and regulations of your country/region.
- Scanning, probing, exploiting or attacking any website, online service or networked system
without the explicit authorization of its owner;
- Testing outside a program's published scope, or in violation of its rules of engagement;
- Illegal intrusion, data theft, extortion, denial of service, or any destructive or criminal
activity;
- Any use that violates the laws and regulations of your country or region.
### Compliance responsibility
Users must comply with all laws and regulations of their country/region regarding cybersecurity, data protection, and computer crime. **All legal liability and consequences arising from the use of this tool are borne by the user.**
Users must comply with all laws and regulations of their country or region regarding cybersecurity,
data protection and computer crime. **All legal liability and consequences arising from the use of
this tool are borne by the user.**
### Disclaimer
This project is provided "as is", without any express or implied warranty. The authors and contributors are not liable for any direct or indirect loss, data loss, system damage, or legal disputes caused by the use of this tool (whether used properly or not). **Downloading, installing, or using this project means you have read, understood, and agreed to all of the above terms.**
This project is provided "as is", without any express or implied warranty. The authors and
contributors are not liable for any direct or indirect loss, data loss, system damage or legal
dispute caused by the use of this tool (whether used properly or not). **Downloading, installing or
using this project means you have read, understood and agreed to all of the above terms.**
+81
View File
@@ -0,0 +1,81 @@
# Security Policy
## Supported Versions
ARTEX is an autonomous penetration-testing tool. Security fixes are provided only for the latest official release line. The `main` branch is not considered a stable release and may change at any time.
Only the latest release line receives security fixes. Older releases do not receive fixes; please upgrade to the latest release.
Notes:
- Please upgrade to the latest release before reporting a vulnerability.
- Forks, custom builds from arbitrary commits, and modified versions are not covered by official support.
## Reporting a Vulnerability
**Do not open a public issue for a security vulnerability.**
Report through **GitHub Security Advisories**: **Security** tab → **Report a vulnerability** in the `BaaRai/ARTEX` repository. This is the only reporting channel.
Please include:
- A description of the vulnerability and its expected impact.
- The ARTEX version and/or commit hash.
- Runtime environment (OS, Docker/local, PostgreSQL, LLM provider, etc.).
- Minimal reproduction steps (PoC).
- Logs, screenshots, or sample traffic with **sensitive data removed**.
- Suggested remediation, if available.
**Do not send** real third-party data, credentials, tokens, customer data, or unredacted sensitive content.
## Scope and Authorized Testing
ARTEX is an offensive-security tool. Test only against:
- Your own ARTEX deployment in a lab or local environment;
- Systems you own;
- Targets explicitly authorized in writing (bug bounty, pentest contract, etc.).
Testing, scanning, or exploiting third-party systems without explicit authorization is strictly prohibited. Reports that violate this principle may be closed without action.
## What to Expect
This is an open-source project maintained on a best-effort basis. We aim to acknowledge a report within about a week and keep you updated, but we cannot guarantee specific response or fix timeframes.
## If a Report Is Accepted
- We will open a private **GitHub Security Advisory** for coordination.
- We will identify the release containing the fix when it is published.
- We may request a **CVE** if the vulnerability qualifies.
- We will credit you or your organization in the advisory if you wish.
- Default disclosure timing: **90 days** after a fix is available, or earlier by mutual agreement. If the vulnerability is being exploited in the wild, we may disclose earlier.
## If a Report Is Declined
We will explain the reason, for example:
- It is not a security vulnerability but intended behavior.
- It is outside ARTEX’s scope (e.g., an issue in an LLM provider, PostgreSQL, Docker, or a browser).
- There is insufficient information to reproduce it.
- The report only states that “the tool can be misused” without identifying a specific technical flaw in ARTEX.
Where appropriate, we may convert the report into a public hardening issue or feature request.
## Out of Scope
The following are generally **not** considered ARTEX security vulnerabilities:
- Attacks or scans against systems you do not own or are not authorized to test.
- Self-XSS, spam, or brute-force without real impact.
- Large-scale DoS/DDoS or resource-exhaustion attacks.
- Social engineering targeting maintainers or users.
- Issues that exist only in third-party dependencies and do not affect ARTEX.
- Reports that “ARTEX can be used to attack systems” when the user has valid authorization — this is the nature of a penetration-testing tool, not a vulnerability.
- Missing headers or hardening configuration without a concrete security impact.
## Safe Harbor
We welcome ethical security research. If you follow this policy and test only within authorized scope, we will not pursue legal action against you for good-faith research. This does not exempt you from applicable laws in your jurisdiction.
## Disclosure Policy
- Do not publicly disclose vulnerability details before a fix is available or before the coordinated disclosure period ends.
- Do not publish a public PoC without maintainer consent.
- If you do not receive a response within a reasonable time, please ping the contact channel above before disclosing.
Thank you for helping make ARTEX safer.
+30 -7
View File
@@ -6,6 +6,7 @@ import (
"fmt"
"log"
"runtime/debug"
"sync"
actool "github.com/Autumn-27/norma/tool"
)
@@ -23,15 +24,36 @@ type DeferredInfo struct {
UnlockSkill func(skillName string)
}
// ToolAugment, if set, returns the EXTRA tools an agent should see beyond its
// built-in base set — the agent's visible skills (packed into one Skill meta-tool)
// ToolAugmentFunc is the ToolAugment hook. If set, it returns the EXTRA tools
// an agent should see beyond its built-in base set — the agent's visible skills (packed into one Skill meta-tool)
// and visible MCP servers (expanded to mcp__server__tool). It also returns the
// DeferredInfo describing how those MCP tools are deferred/gated. The server wires
// it to the PG agent_visibility table. cleanup releases any spawned MCP clients.
//
// When nil, agents run with only their built-in tools — behavior is unchanged
// until a user assigns a skill/MCP to the agent in the UI.
var ToolAugment func(ctx context.Context, agentKey string) (extra []actool.CoreTool, def DeferredInfo, cleanup func())
type ToolAugmentFunc func(ctx context.Context, agentKey string) (extra []actool.CoreTool, def DeferredInfo, cleanup func())
// The hook is set by server wiring while restored tasks may already be
// assembling tools on other goroutines, so every access goes through the lock.
var (
toolAugmentMu sync.RWMutex
toolAugment ToolAugmentFunc
)
// SetToolAugment installs (or, with nil, removes) the ToolAugment hook.
func SetToolAugment(f ToolAugmentFunc) {
toolAugmentMu.Lock()
toolAugment = f
toolAugmentMu.Unlock()
}
// ToolAugment returns the current ToolAugment hook, or nil when none is set.
func ToolAugment() ToolAugmentFunc {
toolAugmentMu.RLock()
defer toolAugmentMu.RUnlock()
return toolAugment
}
// AugmentTools returns base plus the agent's visible skill/MCP tools, the
// DeferredInfo, and a cleanup func the caller must defer (closes MCP clients).
@@ -42,10 +64,11 @@ func AugmentTools(ctx context.Context, agentKey string, base []actool.CoreTool)
cleanup = func() {}
out = base
)
if ToolAugment != nil {
// Copy each hook once under its lock, then call it outside the lock.
if augment := ToolAugment(); augment != nil {
var extra []actool.CoreTool
var cl func()
extra, def, cl = ToolAugment(ctx, agentKey)
extra, def, cl = augment(ctx, agentKey)
if cl != nil {
cleanup = cl
}
@@ -57,8 +80,8 @@ func AugmentTools(ctx context.Context, agentKey string, base []actool.CoreTool)
// agent isn't bound to (or that are disabled) and swap in overridden
// descriptions/schemas + default injection. MCP/skill/host tools have no row
// and pass through untouched, so deferred/unlock wiring stays consistent.
if ToolResolve != nil {
out = ToolResolve(ctx, agentKey, out)
if resolve := ToolResolve(); resolve != nil {
out = resolve(ctx, agentKey, out)
}
// Tool RAG (off by default): lexical projection of the bound list; only removes.
out = applyToolRAG(ctx, agentKey, out, def.Deferred, bm25Score)
+87
View File
@@ -0,0 +1,87 @@
package agent
import (
"context"
"sync"
"testing"
actool "github.com/Autumn-27/norma/tool"
)
// Server wiring installs the hooks while restored tasks may already be assembling
// tools, rendering prompts and building settlement configs on other goroutines.
// Readers and writers run concurrently here, so under -race any unsynchronised
// hook access is reported regardless of scheduling.
func TestAgentHooksConcurrentSwap(t *testing.T) {
oldAugment, oldResolve, oldPolicy := ToolAugment(), ToolResolve(), FindingTrafficBindingEnabled()
oldPrompt, oldWrapup, oldWrapupTurns := PromptOverride(), WrapupOverride(), WrapupMaxTurnsOverride()
oldTimeout, oldTimeoutTurns := WrapupTaskTimeoutOverride(), WrapupTaskTimeoutTurnsOverride()
t.Cleanup(func() {
SetToolAugment(oldAugment)
SetToolResolve(oldResolve)
SetFindingTrafficBindingEnabled(oldPolicy)
SetPromptOverride(oldPrompt)
SetWrapupOverride(oldWrapup)
SetWrapupMaxTurnsOverride(oldWrapupTurns)
SetWrapupTaskTimeoutOverride(oldTimeout)
SetWrapupTaskTimeoutTurnsOverride(oldTimeoutTurns)
})
augment := func(context.Context, string) ([]actool.CoreTool, DeferredInfo, func()) {
return nil, DeferredInfo{}, nil
}
resolve := func(_ context.Context, _ string, in []actool.CoreTool) []actool.CoreTool { return in }
policy := func() bool { return false }
text := func(string) (string, bool) { return "", false }
turns := func(string) (int, bool) { return 0, false }
setAll := func(on bool) {
if on {
SetToolAugment(augment)
SetToolResolve(resolve)
SetFindingTrafficBindingEnabled(policy)
SetPromptOverride(text)
SetWrapupOverride(text)
SetWrapupMaxTurnsOverride(turns)
SetWrapupTaskTimeoutOverride(text)
SetWrapupTaskTimeoutTurnsOverride(turns)
return
}
SetToolAugment(nil)
SetToolResolve(nil)
SetFindingTrafficBindingEnabled(nil)
SetPromptOverride(nil)
SetWrapupOverride(nil)
SetWrapupMaxTurnsOverride(nil)
SetWrapupTaskTimeoutOverride(nil)
SetWrapupTaskTimeoutTurnsOverride(nil)
}
const rounds = 200
var wg sync.WaitGroup
for range 4 {
wg.Go(func() {
for range rounds {
out, _, cleanup := AugmentTools(context.Background(), "worker", nil)
cleanup()
if len(out) != 0 {
t.Errorf("AugmentTools(nil base) = %d tools, want 0", len(out))
return
}
if got := renderSystem("planner", "DEFAULT", PlannerVars{}); got != "DEFAULT" {
t.Errorf("renderSystem = %q, want the default", got)
return
}
if st := wrapupSettlementForTask("worker", nil, true); st.Prompt != WrapupDefault("worker") {
t.Errorf("settlement prompt = %q, want the default", st.Prompt)
return
}
}
})
}
wg.Go(func() {
for range rounds {
setAll(true)
setAll(false)
}
})
wg.Wait()
}
+3 -3
View File
@@ -51,9 +51,9 @@ func TestReportFindingOptionalTrafficWithoutCapture(t *testing.T) {
}
func TestReportFindingAtomicContract(t *testing.T) {
old := FindingTrafficBindingEnabled
FindingTrafficBindingEnabled = func() bool { return true }
t.Cleanup(func() { FindingTrafficBindingEnabled = old })
old := FindingTrafficBindingEnabled()
SetFindingTrafficBindingEnabled(func() bool { return true })
t.Cleanup(func() { SetFindingTrafficBindingEnabled(old) })
d := testDB(t)
defer d.Close()
task, err := d.CreateTask("report contract", "fixture", nil, 0, 0)
+22 -2
View File
@@ -3,6 +3,7 @@ package agent
import (
"encoding/json"
"fmt"
"sync"
"github.com/Autumn-27/artex/db"
actool "github.com/Autumn-27/norma/tool"
@@ -13,10 +14,29 @@ const findingIDGuidance = "\n\n**Finding ID conventions**: finding_id is the sta
// The server supplies the persisted setting. A missing setting/host is off.
// Consulted at assembly and again on writes so an already-running session
// cannot keep binding after the user switches the feature off.
var FindingTrafficBindingEnabled func() bool
// Guarded by a lock for the same reason as the tool hooks.
var (
findingTrafficBindingMu sync.RWMutex
findingTrafficBindingHook func() bool
)
// SetFindingTrafficBindingEnabled installs (or, with nil, removes) the hook.
func SetFindingTrafficBindingEnabled(f func() bool) {
findingTrafficBindingMu.Lock()
findingTrafficBindingHook = f
findingTrafficBindingMu.Unlock()
}
// FindingTrafficBindingEnabled returns the current hook, or nil when none is set.
func FindingTrafficBindingEnabled() func() bool {
findingTrafficBindingMu.RLock()
defer findingTrafficBindingMu.RUnlock()
return findingTrafficBindingHook
}
func findingTrafficBindingEnabled() bool {
return FindingTrafficBindingEnabled != nil && FindingTrafficBindingEnabled()
f := FindingTrafficBindingEnabled()
return f != nil && f()
}
// Applied after ToolResolve: user descriptions and prompts remain intact, while
+11 -7
View File
@@ -10,19 +10,23 @@ import (
)
func TestFindingWorkflowSharedAssemblyAndSwitch(t *testing.T) {
oldPolicy, oldResolve, oldAugment := FindingTrafficBindingEnabled, ToolResolve, ToolAugment
t.Cleanup(func() { FindingTrafficBindingEnabled, ToolResolve, ToolAugment = oldPolicy, oldResolve, oldAugment })
ToolAugment = nil
oldPolicy, oldResolve, oldAugment := FindingTrafficBindingEnabled(), ToolResolve(), ToolAugment()
t.Cleanup(func() {
SetFindingTrafficBindingEnabled(oldPolicy)
SetToolResolve(oldResolve)
SetToolAugment(oldAugment)
})
SetToolAugment(nil)
on := false
FindingTrafficBindingEnabled = func() bool { return on }
SetFindingTrafficBindingEnabled(func() bool { return on })
ts := NewToolSet(nil, "fixture")
ToolResolve = func(_ context.Context, _ string, base []actool.CoreTool) []actool.CoreTool {
SetToolResolve(func(_ context.Context, _ string, base []actool.CoreTool) []actool.CoreTool {
out := make([]actool.CoreTool, len(base))
for i, tool := range base {
out[i] = DecorateTool(tool, "CUSTOM DESCRIPTION", tool.InputSchema())
}
return out
}
})
for _, role := range []string{"worker", "planner", "mainagent", "auto", "pentest", "custom-agent"} {
for _, enabled := range []bool{false, true, false} {
on = enabled
@@ -59,7 +63,7 @@ func TestFindingWorkflowSharedAssemblyAndSwitch(t *testing.T) {
}
}
on = true
ToolResolve = func(context.Context, string, []actool.CoreTool) []actool.CoreTool { return nil }
SetToolResolve(func(context.Context, string, []actool.CoreTool) []actool.CoreTool { return nil })
out, def, cleanup := AugmentTools(t.Context(), "planner", []actool.CoreTool{ts.addFinding()})
defer cleanup()
if len(out) != 0 || def.FindingGuidance != "" {
+22 -3
View File
@@ -2,6 +2,7 @@ package agent
import (
"bytes"
"sync"
"text/template"
"time"
)
@@ -10,7 +11,25 @@ import (
// key and whether one exists. The server wires it to the PG agent_prompts table.
// When nil or no override exists, agents use their built-in default prompt — so
// behavior is identical until a user edits a prompt in the UI.
var PromptOverride func(agentKey string) (string, bool)
// Guarded by a lock: server wiring can run while agents render prompts.
var (
promptOverrideMu sync.RWMutex
promptOverride func(agentKey string) (string, bool)
)
// SetPromptOverride installs (or, with nil, removes) the PromptOverride hook.
func SetPromptOverride(f func(agentKey string) (string, bool)) {
promptOverrideMu.Lock()
promptOverride = f
promptOverrideMu.Unlock()
}
// PromptOverride returns the current hook, or nil when none is set.
func PromptOverride() func(agentKey string) (string, bool) {
promptOverrideMu.RLock()
defer promptOverrideMu.RUnlock()
return promptOverride
}
// Prompt-variable structs — fields mirror each agent's catalog (docs §5a) so a
// user template referencing a catalog variable renders; referencing anything else
@@ -38,8 +57,8 @@ func nowStr() string { return time.Now().Format("2006-01-02 15:04:05 MST") }
// the DB body.
func renderSystem(agentKey, def string, vars any) string {
tmpl := def
if PromptOverride != nil {
if t, ok := PromptOverride(agentKey); ok && t != "" {
if override := PromptOverride(); override != nil {
if t, ok := override(agentKey); ok && t != "" {
tmpl = t
}
}
+8 -8
View File
@@ -18,9 +18,9 @@ func TestPromptSeedsDoNotCarryInjectionBlock(t *testing.T) {
// tail: the #49 block for the roles that read target output, the untrusted-data
// rule for the planner and the cold-digest compactor.
func TestInjectionTailSurvivesPromptOverride(t *testing.T) {
prev := PromptOverride
t.Cleanup(func() { PromptOverride = prev })
PromptOverride = func(string) (string, bool) { return "BARE BODY", true }
prev := PromptOverride()
t.Cleanup(func() { SetPromptOverride(prev) })
SetPromptOverride(func(string) (string, bool) { return "BARE BODY", true })
content := map[string]string{
"worker": workerSystem("", "", "/data", "/run"),
@@ -64,8 +64,8 @@ func TestInjectionTailSurvivesPromptOverride(t *testing.T) {
// A body that already carries the block (a DB row seeded before the move) does
// not get it twice; the code defaults carry it exactly once.
func TestInjectionTailNotDuplicated(t *testing.T) {
prev := PromptOverride
t.Cleanup(func() { PromptOverride = prev })
prev := PromptOverride()
t.Cleanup(func() { SetPromptOverride(prev) })
render := func() map[string]string {
return map[string]string{
@@ -78,16 +78,16 @@ func TestInjectionTailNotDuplicated(t *testing.T) {
}
}
PromptOverride = func(string) (string, bool) {
SetPromptOverride(func(string) (string, bool) {
return "LEGACY BODY\n\n" + untrustedContentRules + "\n\nMore rules.", true
}
})
for role, sys := range render() {
if n := strings.Count(sys, untrustedContentRules); n != 1 {
t.Errorf("legacy %s: untrusted-content block rendered %d times, want 1", role, n)
}
}
PromptOverride = nil
SetPromptOverride(nil)
for role, sys := range render() {
if n := strings.Count(sys, untrustedContentRules); n != 1 {
t.Errorf("default %s: untrusted-content block rendered %d times, want 1", role, n)
+12 -12
View File
@@ -10,15 +10,15 @@ import (
// (chat) agent prompt referencing it renders the live server time each turn, rather
// than failing template execution and falling back to DefaultAssistantPrompt.
func TestChatNowVarRenders(t *testing.T) {
prev := PromptOverride
defer func() { PromptOverride = prev }()
prev := PromptOverride()
defer func() { SetPromptOverride(prev) }()
PromptOverride = func(key string) (string, bool) {
SetPromptOverride(func(key string) (string, bool) {
if key == "tec_benchmark" {
return "Current time: {{.Now}}", true
}
return "", false
}
})
out := chatSystem("tec_benchmark", "/app/data", "/tmp/x")
if !strings.Contains(out, "Current time: ") {
@@ -34,12 +34,12 @@ func TestChatNowVarRenders(t *testing.T) {
// a custom prompt referencing it renders the server data root (s.m.dir), rather
// than failing template execution and falling back to DefaultAssistantPrompt.
func TestChatDataDirVarRenders(t *testing.T) {
prev := PromptOverride
defer func() { PromptOverride = prev }()
prev := PromptOverride()
defer func() { SetPromptOverride(prev) }()
PromptOverride = func(key string) (string, bool) {
SetPromptOverride(func(key string) (string, bool) {
return "Data root: {{.DataDir}}", true
}
})
out := chatSystem("tec_benchmark", "/app/data", "/tmp/x")
if !strings.Contains(out, "Data root: /app/data") {
@@ -50,12 +50,12 @@ func TestChatDataDirVarRenders(t *testing.T) {
// TestChatUnknownVarFallsBack verifies an out-of-catalog {{.X}} still degrades
// safely to the default assistant prompt (never a half-rendered prompt).
func TestChatUnknownVarFallsBack(t *testing.T) {
prev := PromptOverride
defer func() { PromptOverride = prev }()
prev := PromptOverride()
defer func() { SetPromptOverride(prev) }()
PromptOverride = func(key string) (string, bool) {
SetPromptOverride(func(key string) (string, bool) {
return "References a nonexistent variable: {{.Bogus}}", true
}
})
out := chatSystem("whatever", "/app/data", "/tmp/x")
if strings.Contains(out, "References a nonexistent variable") {
+8 -8
View File
@@ -6,27 +6,27 @@ import (
)
func TestRenderSystemOverrideAndFallback(t *testing.T) {
t.Cleanup(func() { PromptOverride = nil })
t.Cleanup(func() { SetPromptOverride(nil) })
// no override → built-in default
PromptOverride = nil
SetPromptOverride(nil)
if got := renderSystem("planner", "DEFAULT", PlannerVars{Goal: "g"}); got != "DEFAULT" {
t.Fatalf("no override should give default, got %q", got)
}
// override → rendered with vars
PromptOverride = func(k string) (string, bool) {
SetPromptOverride(func(k string) (string, bool) {
if k == "planner" {
return "Goal:{{.Goal}} Scope:{{.Scope}}", true
}
return "", false
}
})
if got := renderSystem("planner", "DEFAULT", PlannerVars{Goal: "capture X", Scope: "*.x.com"}); got != "Goal:capture X Scope:*.x.com" {
t.Fatalf("override render: %q", got)
}
// override referencing a non-catalog var → execution error → fallback to default
PromptOverride = func(k string) (string, bool) { return "{{.NotInCatalog}}", true }
SetPromptOverride(func(k string) (string, bool) { return "{{.NotInCatalog}}", true })
if got := renderSystem("planner", "DEFAULT", PlannerVars{Goal: "x"}); got != "DEFAULT" {
t.Fatalf("bad var should fall back to default, got %q", got)
}
@@ -34,7 +34,7 @@ func TestRenderSystemOverrideAndFallback(t *testing.T) {
// full plannerSystem path: DB body [A] is honored, then the code-owned tail
// [C] (intermediate artifact output rules) is ALWAYS appended — editing the body
// can't drop it.
PromptOverride = func(k string) (string, bool) { return "PLANNER {{.Goal}}", true }
SetPromptOverride(func(k string) (string, bool) { return "PLANNER {{.Goal}}", true })
got := plannerSystem("capture X", "/data", "/data")
if !strings.HasPrefix(got, "PLANNER capture X") {
t.Fatalf("plannerSystem body not honored: %q", got)
@@ -48,9 +48,9 @@ func TestRenderSystemOverrideAndFallback(t *testing.T) {
// the traffic_* tools exist), [C] artifact spec always present. The trafficTool
// block is gated on the CA (arg 2), NOT on ProxyAddr — a global egress proxy
// with capture off routes traffic but records nothing.
PromptOverride = func(k string) (string, bool) {
SetPromptOverride(func(k string) (string, bool) {
return "{{if .ProxyAddr}}via proxy {{.ProxyAddr}}{{else}}manual{{end}}", true
}
})
recording := workerSystem("127.0.0.1:8080", "/ca.pem", "/data", "/data")
if !strings.HasPrefix(recording, "via proxy 127.0.0.1:8080") {
t.Fatalf("worker proxy branch body: %q", recording)
+1 -1
View File
@@ -1,5 +1,5 @@
// Package agent wires real LLM-driven planner and work agents (on top of the
// agent-core SDK) to the dual SQLite graph. See the ARTEX architecture design doc
// agent-core SDK) to the dual PostgreSQL graph. See the ARTEX architecture design doc
// §4.3 (planner) and §4.4 (work agent).
//
// Provider configuration is read from the environment so the system runs with
+24 -2
View File
@@ -3,6 +3,7 @@ package agent
import (
"context"
"encoding/json"
"sync"
actool "github.com/Autumn-27/norma/tool"
)
@@ -121,13 +122,34 @@ func BuiltinToolSeeds() []ToolSeed {
return out
}
// ToolResolve, if set, post-processes an agent's fully-assembled tool list against
// ToolResolveFunc is the ToolResolve hook. If set, it post-processes an agent's
// fully-assembled tool list against
// the DB tools table: it drops tools not bound to this agent (or globally disabled)
// and wraps the rest so the model sees the DB-overridden description/schema and
// default inputs get injected. Tools with no matching DB row (MCP/skill/host tools
// like traffic) pass through untouched. nil = tools unchanged. Wired in
// server/assembly.go.
var ToolResolve func(ctx context.Context, agentKey string, tools []actool.CoreTool) []actool.CoreTool
type ToolResolveFunc func(ctx context.Context, agentKey string, tools []actool.CoreTool) []actool.CoreTool
// Guarded like toolAugment: wiring can run while tasks assemble tools.
var (
toolResolveMu sync.RWMutex
toolResolve ToolResolveFunc
)
// SetToolResolve installs (or, with nil, removes) the ToolResolve hook.
func SetToolResolve(f ToolResolveFunc) {
toolResolveMu.Lock()
toolResolve = f
toolResolveMu.Unlock()
}
// ToolResolve returns the current ToolResolve hook, or nil when none is set.
func ToolResolve() ToolResolveFunc {
toolResolveMu.RLock()
defer toolResolveMu.RUnlock()
return toolResolve
}
// DecorateTool wraps t so Description()/InputSchema() report the DB overrides and
// Call() injects scalar parameter defaults (from schema's "default" props) whenever
+10 -5
View File
@@ -82,12 +82,17 @@ func TestToolRAGCoreKeptAndKRespected(t *testing.T) {
// The projection runs after ToolResolve, so a tool the binding/enabled filter
// dropped is never selected even when it is the best lexical match.
func TestToolRAGNeverSelectsUnboundOrDisabled(t *testing.T) {
oldResolve, oldAugment, oldPolicy := ToolResolve, ToolAugment, FindingTrafficBindingEnabled
t.Cleanup(func() { ToolResolve, ToolAugment, FindingTrafficBindingEnabled = oldResolve, oldAugment, oldPolicy })
ToolAugment, FindingTrafficBindingEnabled = nil, nil
oldResolve, oldAugment, oldPolicy := ToolResolve(), ToolAugment(), FindingTrafficBindingEnabled()
t.Cleanup(func() {
SetToolResolve(oldResolve)
SetToolAugment(oldAugment)
SetFindingTrafficBindingEnabled(oldPolicy)
})
SetToolAugment(nil)
SetFindingTrafficBindingEnabled(nil)
t.Setenv(toolRAGEnv, "on")
t.Setenv(toolRAGTopKEnv, "2")
ToolResolve = func(_ context.Context, _ string, in []actool.CoreTool) []actool.CoreTool {
SetToolResolve(func(_ context.Context, _ string, in []actool.CoreTool) []actool.CoreTool {
var out []actool.CoreTool
for _, tool := range in {
if tool.Name() != "sql_injection_exploit" {
@@ -95,7 +100,7 @@ func TestToolRAGNeverSelectsUnboundOrDisabled(t *testing.T) {
}
}
return out
}
})
base := append(ragCatalog(25), ragTool("sql_injection_exploit", "Exploit SQL injection in web login form", "url"))
out, _, cleanup := AugmentTools(WithToolQuery(t.Context(), ragQuery), "worker", base)
defer cleanup()
+76 -14
View File
@@ -2,6 +2,7 @@ package agent
import (
"strings"
"sync"
"github.com/Autumn-27/norma/harness"
)
@@ -17,15 +18,47 @@ import (
// [prompt body] is editable; which tools are disabled and how many turns the
// wrap-up itself gets are code-fixed policy.
// WrapupOverride, if set, returns the stored wrap-up prompt for an agent key and
// wrapupHooksMu guards the four wrap-up hooks in this file: server wiring can run
// while agents build their settlement config on other goroutines.
var wrapupHooksMu sync.RWMutex
// wrapupOverride, if set, returns the stored wrap-up prompt for an agent key and
// whether a non-empty one exists. Wired by the server to the agents table (like
// PromptOverride for system prompts). nil / empty → the built-in default is used.
var WrapupOverride func(agentKey string) (string, bool)
var wrapupOverride func(agentKey string) (string, bool)
// WrapupMaxTurnsOverride, if set, returns the admin-configured turn budget for the
// SetWrapupOverride installs (or, with nil, removes) the WrapupOverride hook.
func SetWrapupOverride(f func(agentKey string) (string, bool)) {
wrapupHooksMu.Lock()
wrapupOverride = f
wrapupHooksMu.Unlock()
}
// WrapupOverride returns the current hook, or nil when none is set.
func WrapupOverride() func(agentKey string) (string, bool) {
wrapupHooksMu.RLock()
defer wrapupHooksMu.RUnlock()
return wrapupOverride
}
// wrapupMaxTurnsOverride, if set, returns the admin-configured turn budget for the
// wrap-up phase of an agent and whether a positive one exists. Wired to the agents
// table. nil / ≤0 → the built-in per-agent default (wrapupTurnDefaults) is used.
var WrapupMaxTurnsOverride func(agentKey string) (int, bool)
var wrapupMaxTurnsOverride func(agentKey string) (int, bool)
// SetWrapupMaxTurnsOverride installs (or, with nil, removes) the WrapupMaxTurnsOverride hook.
func SetWrapupMaxTurnsOverride(f func(agentKey string) (int, bool)) {
wrapupHooksMu.Lock()
wrapupMaxTurnsOverride = f
wrapupHooksMu.Unlock()
}
// WrapupMaxTurnsOverride returns the current hook, or nil when none is set.
func WrapupMaxTurnsOverride() func(agentKey string) (int, bool) {
wrapupHooksMu.RLock()
defer wrapupHooksMu.RUnlock()
return wrapupMaxTurnsOverride
}
// Built-in default wrap-up prompts, keyed by agent key. worker reuses the
// historically hardcoded settleWrapUpPrompt (defined in worker.go); planner and
@@ -75,8 +108,8 @@ func WrapupTurnsDefault(agentKey string) int {
// resolveWrapup returns the effective wrap-up prompt: the DB override (if set and
// non-empty) over the built-in default.
func resolveWrapup(agentKey string) string {
if WrapupOverride != nil {
if t, ok := WrapupOverride(agentKey); ok && strings.TrimSpace(t) != "" {
if override := WrapupOverride(); override != nil {
if t, ok := override(agentKey); ok && strings.TrimSpace(t) != "" {
return t
}
}
@@ -86,8 +119,8 @@ func resolveWrapup(agentKey string) string {
// resolveWrapupTurns returns the effective wrap-up turn budget: a positive DB
// override over the built-in per-agent default.
func resolveWrapupTurns(agentKey string) int {
if WrapupMaxTurnsOverride != nil {
if v, ok := WrapupMaxTurnsOverride(agentKey); ok && v > 0 {
if override := WrapupMaxTurnsOverride(); override != nil {
if v, ok := override(agentKey); ok && v > 0 {
return v
}
}
@@ -117,11 +150,40 @@ func wrapupSettlement(agentKey string, disabledTools []string) *harness.Settleme
// WrapupTaskTimeoutOverride / …TurnsOverride: DB overrides for the task-timeout
// wrap-up prompt and turns (wired to agents.task_timeout_wrapup_prompt /
// _max_turns, worker/planner only).
// Guarded by wrapupHooksMu, like the per-run hooks above.
var (
WrapupTaskTimeoutOverride func(agentKey string) (string, bool)
WrapupTaskTimeoutTurnsOverride func(agentKey string) (int, bool)
wrapupTaskTimeoutOverride func(agentKey string) (string, bool)
wrapupTaskTimeoutTurnsOverride func(agentKey string) (int, bool)
)
// SetWrapupTaskTimeoutOverride installs (or, with nil, removes) the hook.
func SetWrapupTaskTimeoutOverride(f func(agentKey string) (string, bool)) {
wrapupHooksMu.Lock()
wrapupTaskTimeoutOverride = f
wrapupHooksMu.Unlock()
}
// WrapupTaskTimeoutOverride returns the current hook, or nil when none is set.
func WrapupTaskTimeoutOverride() func(agentKey string) (string, bool) {
wrapupHooksMu.RLock()
defer wrapupHooksMu.RUnlock()
return wrapupTaskTimeoutOverride
}
// SetWrapupTaskTimeoutTurnsOverride installs (or, with nil, removes) the hook.
func SetWrapupTaskTimeoutTurnsOverride(f func(agentKey string) (int, bool)) {
wrapupHooksMu.Lock()
wrapupTaskTimeoutTurnsOverride = f
wrapupHooksMu.Unlock()
}
// WrapupTaskTimeoutTurnsOverride returns the current hook, or nil when none is set.
func WrapupTaskTimeoutTurnsOverride() func(agentKey string) (int, bool) {
wrapupHooksMu.RLock()
defer wrapupHooksMu.RUnlock()
return wrapupTaskTimeoutTurnsOverride
}
var taskTimeoutWrapupDefaults = map[string]string{
"worker": workerTaskTimeoutDefault,
"planner": plannerTaskTimeoutDefault,
@@ -141,8 +203,8 @@ func TaskTimeoutWrapupDefault(agentKey string) string {
// string means this agent has no task-timeout prompt (not worker/planner) — the
// caller should then fall back to the per-run prompt.
func resolveTaskTimeoutWrapup(agentKey string) string {
if WrapupTaskTimeoutOverride != nil {
if t, ok := WrapupTaskTimeoutOverride(agentKey); ok && strings.TrimSpace(t) != "" {
if override := WrapupTaskTimeoutOverride(); override != nil {
if t, ok := override(agentKey); ok && strings.TrimSpace(t) != "" {
return t
}
}
@@ -150,8 +212,8 @@ func resolveTaskTimeoutWrapup(agentKey string) string {
}
func resolveTaskTimeoutTurns(agentKey string) int {
if WrapupTaskTimeoutTurnsOverride != nil {
if v, ok := WrapupTaskTimeoutTurnsOverride(agentKey); ok && v > 0 {
if override := WrapupTaskTimeoutTurnsOverride(); override != nil {
if v, ok := override(agentKey); ok && v > 0 {
return v
}
}
+2 -2
View File
@@ -8,7 +8,7 @@
# ARTEX_TARGET_OS=linux One target OS in single-target mode.
# ARTEX_TARGET_ARCH=amd64 One target arch in single-target mode.
# ARTEX_TARGETS=linux/amd64,... Comma-separated targets for multi-target mode.
# ARTEX_BUILD_VERSION=v0.3.3 Version embedded in the binary and archive name.
# ARTEX_BUILD_VERSION=vX.Y.Z Version embedded in the binary and archive name.
# ARTEX_OUTPUT=/path/to/artex Explicit binary path in single-target mode.
# ARTEX_OUTPUT_DIR=dist Directory for default binary paths.
# ARTEX_PACKAGE=1 Create a zip archive for each target.
@@ -97,7 +97,7 @@ if [ -z "${ARTEX_BUILD_VERSION:-}" ]; then
ARTEX_BUILD_VERSION="dev"
fi
fi
# Release tags are commonly passed as v0.3.3; keep the binary version consistent.
# Release tags are commonly passed with a v prefix; keep the binary version consistent.
ARTEX_BUILD_VERSION="${ARTEX_BUILD_VERSION#v}"
ARTEX_OUTPUT_DIR="${ARTEX_OUTPUT_DIR:-dist}"
ARTEX_PACKAGE_DIR="${ARTEX_PACKAGE_DIR:-$ARTEX_OUTPUT_DIR}"
+2 -2
View File
@@ -1,4 +1,4 @@
// Command artex runs the ARTEX backend: the dual SQLite graph stores,
// Command artex runs the ARTEX backend: the dual PostgreSQL graph stores,
// the event-driven exploration engine, and the JSON HTTP API consumed by the
// shadcn/ui frontend.
package main
@@ -50,7 +50,7 @@ func main() {
func run() int {
var (
addr = flag.String("addr", "127.0.0.1:8787", "HTTP listen address")
dataDir = flag.String("data", filepath.Join(config.BaseDir(), "data"), "data directory for SQLite stores (default: data/ next to the executable)")
dataDir = flag.String("data", filepath.Join(config.BaseDir(), "data"), "runtime data directory: traffic index, task files, transcripts (default: data/ next to the executable)")
proxy = flag.String("proxy", "127.0.0.1:8788", "traffic recording proxy address (empty to disable)")
)
flag.Parse()
+6 -50
View File
@@ -153,57 +153,13 @@ type LLMRecord struct {
RawResponse string `json:"raw_response,omitempty"`
}
const llmRecordsSchema = `
CREATE TABLE IF NOT EXISTS llm_records (
id BIGSERIAL PRIMARY KEY,
ts TIMESTAMPTZ DEFAULT now(),
model TEXT,
profile_name TEXT,
session_id TEXT,
task_id TEXT,
worker TEXT,
latency_ms INTEGER,
input_tokens INTEGER,
output_tokens INTEGER,
cache_read INTEGER,
cache_write INTEGER,
status TEXT,
error TEXT,
request_body TEXT,
response_body TEXT,
raw_request TEXT,
raw_response TEXT
);
CREATE INDEX IF NOT EXISTS idx_llm_records_ts ON llm_records(ts);
CREATE INDEX IF NOT EXISTS idx_llm_records_session ON llm_records(session_id);
`
// llmRecordsMigrate adds new columns to existing tables.
const llmRecordsMigrate = `
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS task_id TEXT;
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS worker TEXT;
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS profile_name TEXT;
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS raw_request TEXT;
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS raw_response TEXT;
`
// EnsureLLMRecordsTable creates the llm_records table if it does not exist.
// EnsureLLMRecordsTable creates the llm_records table if it does not exist, by
// re-running the idempotent migration 0001_llm_records.sql. Open already applies
// it through the migration runner; this stays for callers that want the table
// guaranteed. It takes the schema lock in its own transaction, so it must not be
// called while Open holds that lock.
func (d *DB) EnsureLLMRecordsTable() error {
tx, err := d.Begin()
if err != nil {
return err
}
defer tx.Rollback() //nolint:errcheck
if err := coordinateWithSchemaMigration(tx); err != nil {
return err
}
if _, err := tx.Exec(llmRecordsSchema); err != nil {
return err
}
if _, err := tx.Exec(llmRecordsMigrate); err != nil {
return err
}
return tx.Commit()
return d.execEmbeddedMigration(llmRecordsMigration)
}
// InsertLLMRecord stores one LLM call record.
+198
View File
@@ -0,0 +1,198 @@
package db
import (
"fmt"
"strings"
"testing"
)
// largeCoverageFixture is a task scoped by 800 subdomains spread over 200 root
// domains and 20 companies, with 1,000 services, 1,200 endpoints and 2,000
// anchored facts. Every tenth root has no asset row, so the graph needs both
// real and synthetic ("r:<domain>") connector roots.
type largeCoverageFixture struct {
taskID, expID int64
suffix string
}
const (
lcRoots = 200
lcCompanies = 20
lcSubs = 800
lcServices = 1000
lcEndpoints = 1200
lcFacts = 2000
)
func seedLargeCoverageFixture(tb testing.TB, d *DB) largeCoverageFixture {
tb.Helper()
task, err := d.CreateTask("large coverage graph", "large coverage graph", nil, 0, 0)
if err != nil {
tb.Fatal(err)
}
f := largeCoverageFixture{taskID: task.ID, expID: task.ExplorationID, suffix: fmt.Sprintf("lc%d", task.ID)}
tb.Cleanup(func() {
_, _ = d.Exec(`DELETE FROM explorations WHERE id=$1`, f.expID)
_ = d.DeleteTask(f.taskID)
_, _ = d.Exec(`DELETE FROM assets WHERE root_domain LIKE '%-'||$1||'.cov.test'`, f.suffix)
_, _ = d.Exec(`DELETE FROM companies WHERE nkey LIKE 'lcco-'||$1||'-%'`, f.suffix)
})
exec := func(q string, args ...any) {
tb.Helper()
if _, err := d.Exec(q, args...); err != nil {
tb.Fatalf("%v\n%s", err, q)
}
}
// root g: r<g>-<suffix>.cov.test, company 1+(g-1)%lcCompanies.
// subdomain i: s<i>.<root 1+(i-1)%lcRoots>.
exec(`INSERT INTO companies(name,nkey)
SELECT 'large co '||g||' '||$1, 'lcco-'||$1||'-'||g FROM generate_series(1,$2) g`, f.suffix, lcCompanies)
exec(`INSERT INTO assets(type,domain,root_domain,company_id)
SELECT 'root_domain', 'r'||g||'-'||$1||'.cov.test', 'r'||g||'-'||$1||'.cov.test',
(SELECT id FROM companies WHERE nkey='lcco-'||$1||'-'||(1+(g-1)%$3))
FROM generate_series(1,$2) g WHERE g%10<>0`, f.suffix, lcRoots, lcCompanies)
exec(`INSERT INTO assets(type,domain,root_domain,company_id)
SELECT 'subdomain', 's'||i||'.r'||r||'-'||$1||'.cov.test', 'r'||r||'-'||$1||'.cov.test',
(SELECT id FROM companies WHERE nkey='lcco-'||$1||'-'||(1+(r-1)%$4))
FROM generate_series(1,$3) i, LATERAL (SELECT 1+(i-1)%$2 AS r) x`, f.suffix, lcRoots, lcSubs, lcCompanies)
// service j hangs off subdomain 1+(j-1)%lcSubs: port 443 for the first
// lcSubs services, 8443 for the rest.
exec(`INSERT INTO assets(type,service_type,url,domain,root_domain,port,company_id)
SELECT 'service','http', 'https://'||s.domain||':'||p||'/', s.domain, s.root_domain, p, s.company_id
FROM generate_series(1,$2) j
CROSS JOIN LATERAL (SELECT CASE WHEN j<=$3 THEN 443 ELSE 8443 END AS p) port
JOIN assets s ON s.type='subdomain' AND s.root_domain LIKE '%-'||$1||'.cov.test'
AND s.domain LIKE 's'||(1+(j-1)%$3)||'.%'`, f.suffix, lcServices, lcSubs)
exec(`INSERT INTO assets(type,url,method,domain,root_domain,port,company_id)
SELECT 'endpoint', 'https://'||s.domain||'/p/'||k, 'GET', s.domain, s.root_domain, 443, s.company_id
FROM generate_series(1,$2) k
JOIN assets s ON s.type='subdomain' AND s.root_domain LIKE '%-'||$1||'.cov.test'
AND s.domain LIKE 's'||(1+(k-1)%$3)||'.%'`, f.suffix, lcEndpoints, lcSubs)
exec(`INSERT INTO task_scope(task_id,kind,domain,source)
SELECT $1,'subdomain',domain,'manual' FROM assets
WHERE type='subdomain' AND root_domain LIKE '%-'||$2||'.cov.test'`, f.taskID, f.suffix)
exec(`INSERT INTO exploration_nodes(exploration_id,kind,state,payload)
SELECT $1,'fact','confirmed',jsonb_build_object('summary','large coverage fact '||g) FROM generate_series(1,$2) g`, f.expID, lcFacts)
exec(`WITH fn AS (
SELECT id, row_number() OVER (ORDER BY id) rn FROM exploration_nodes
WHERE exploration_id=$1 AND kind='fact' AND payload->>'summary' LIKE 'large coverage fact %'),
an AS (
SELECT id, row_number() OVER (ORDER BY id) rn FROM assets
WHERE type<>'root_domain' AND root_domain LIKE '%-'||$2||'.cov.test')
INSERT INTO exploration_anchors(node_id,asset_id) SELECT fn.id, an.id FROM fn JOIN an USING (rn)`, f.expID, f.suffix)
exec(`ANALYZE assets, task_scope, exploration_nodes, exploration_anchors, companies`)
return f
}
func TestBuildCoverageGraphLargeInvariants(t *testing.T) {
d, err := Open(testDSN(t))
if err != nil {
t.Skipf("postgres unavailable (%v) - skipping", err)
}
t.Cleanup(func() { d.Close() })
f := seedLargeCoverageFixture(t, d)
g, err := d.Assets().BuildCoverageGraph(f.taskID, f.expID)
if err != nil {
t.Fatal(err)
}
const (
syntheticRoots = lcRoots / 10
realRoots = lcRoots - syntheticRoots
inScope = lcSubs + lcServices + lcEndpoints
wantNodes = inScope + lcRoots + lcCompanies
// subdomain→root, service→subdomain, endpoint→service (port 443), and
// real root→company; a synthetic root has no company.
wantEdges = lcSubs + lcServices + lcEndpoints + realRoots
)
if len(g.Nodes) != wantNodes || len(g.Edges) != wantEdges {
t.Fatalf("graph size: nodes=%d edges=%d, want %d/%d", len(g.Nodes), len(g.Edges), wantNodes, wantEdges)
}
byKey := make(map[string]CoverageGraphNode, len(g.Nodes))
kinds := map[string]int{}
var tested, scoped, synthetic, realConnector int
for _, n := range g.Nodes {
if _, dup := byKey[n.Key]; dup {
t.Fatalf("duplicate node key %q", n.Key)
}
byKey[n.Key] = n
kinds[n.Kind]++
if n.Tested {
tested++
}
if n.InScope {
scoped++
}
switch {
case strings.HasPrefix(n.Key, "r:"):
synthetic++
if n.Kind != "root_domain" || n.InScope || n.AssetID != 0 || n.Key != "r:"+n.Domain {
t.Fatalf("synthetic root: %+v", n)
}
case n.Kind == "root_domain":
realConnector++
if n.InScope || n.AssetID == 0 || n.CompanyID == 0 {
t.Fatalf("connector root: %+v", n)
}
case n.Kind == "company":
if n.InScope || n.Label == "" || n.Key != companyKey(n.CompanyID) {
t.Fatalf("company node: %+v", n)
}
}
}
if kinds["subdomain"] != lcSubs || kinds["service"] != lcServices || kinds["endpoint"] != lcEndpoints ||
kinds["root_domain"] != lcRoots || kinds["company"] != lcCompanies {
t.Fatalf("node kinds: %v", kinds)
}
if synthetic != syntheticRoots || realConnector != realRoots {
t.Fatalf("connector roots: synthetic=%d real=%d, want %d/%d", synthetic, realConnector, syntheticRoots, realRoots)
}
if scoped != inScope || tested != lcFacts {
t.Fatalf("in_scope=%d tested=%d, want %d/%d", scoped, tested, inScope, lcFacts)
}
seenEdge := map[CoverageGraphEdge]bool{}
for _, e := range g.Edges {
src, okSrc := byKey[e.Src]
dst, okDst := byKey[e.Dst]
if !okSrc || !okDst || e.Src == e.Dst {
t.Fatalf("edge %+v points to a missing node", e)
}
if seenEdge[e] {
t.Fatalf("duplicate edge %+v", e)
}
seenEdge[e] = true
want := map[string]string{"subdomain": "root_domain", "service": "subdomain", "endpoint": "service", "root_domain": "company"}[src.Kind]
if dst.Kind != want {
t.Fatalf("edge %s(%s) -> %s(%s), want parent kind %s", e.Src, src.Kind, e.Dst, dst.Kind, want)
}
}
}
// BenchmarkBuildCoverageGraphLarge locks in the cost of the coverage graph on
// the large fixture (statement count and query plan). No time assertion.
func BenchmarkBuildCoverageGraphLarge(b *testing.B) {
dsn, _, err := DSN()
if err != nil {
b.Skipf("no database config (%v) - skipping", err)
}
d, err := Open(dsn)
if err != nil {
b.Skipf("postgres unavailable (%v) - skipping", err)
}
b.Cleanup(func() { d.Close() })
f := seedLargeCoverageFixture(b, d)
store := d.Assets()
b.ResetTimer()
for i := 0; i < b.N; i++ {
g, err := store.BuildCoverageGraph(f.taskID, f.expID)
if err != nil {
b.Fatal(err)
}
if len(g.Nodes) == 0 {
b.Fatal("empty graph")
}
}
}
+23 -1
View File
@@ -1,6 +1,15 @@
// Package db is the PostgreSQL data source for ARTEX (replacing the old graph
// single-file SQLite). It opens the connection, applies the schema, and seeds
// the built-in agents and variable catalog.
//
// Schema changes:
// - schema.sql remains the idempotent base, executed on every startup.
// - Any new DDL goes in a numbered migration, migrations/NNNN_slug.sql.
// Open applies pending migrations once, in version order, and records
// each in schema_migrations with the SHA-256 of its file.
// - A published migration is never edited: Open refuses to start when an
// applied migration's checksum no longer matches its file. Fix forward
// with a new migration instead.
package db
import (
@@ -9,6 +18,7 @@ import (
_ "embed"
"errors"
"fmt"
"io/fs"
"net/url"
"os"
"strings"
@@ -153,8 +163,15 @@ func ensureDatabase(dsn string) error {
return nil
}
// Open connects, applies the schema (idempotent), and seeds builtin rows.
// Open connects, applies the schema (idempotent) and the embedded versioned
// migrations, and seeds builtin rows.
func Open(dsn string) (*DB, error) {
return openWithMigrations(dsn, migrationsFS())
}
// openWithMigrations is Open with the migration set as a parameter, so tests
// can pass an fstest.MapFS.
func openWithMigrations(dsn string, migrations fs.FS) (*DB, error) {
if err := ensureDatabase(dsn); err != nil {
return nil, err
}
@@ -187,6 +204,11 @@ func Open(dsn string) (*DB, error) {
if err := applySchemaWithRetry(context.Background(), conn, time.Sleep); err != nil {
return fmt.Errorf("apply schema: %w", err)
}
// Runs on conn, the lock holder; it must not call EnsureLLM*Table,
// whose own lock request would wait on conn forever.
if err := applyMigrations(context.Background(), conn, migrations); err != nil {
return fmt.Errorf("apply migrations: %w", err)
}
if err := d.seedBuiltins(); err != nil {
return fmt.Errorf("seed builtins: %w", err)
}
+9 -3
View File
@@ -1,11 +1,12 @@
package db
import (
"io/fs"
"testing"
)
// The raw-body columns were added after release, so existing installs only get
// them through llmRecordsMigrate. This runs the real migration against the dev
// them through the ALTERs in 0001_llm_records.sql. This runs the real migration against the dev
// PG on a table stripped back to its pre-upgrade shape, inside a transaction
// that is always rolled back — PG does transactional DDL, so nothing persists.
func TestLLMRecordsMigrateAddsRawColumnsToOldTable(t *testing.T) {
@@ -17,6 +18,11 @@ func TestLLMRecordsMigrateAddsRawColumnsToOldTable(t *testing.T) {
if err := d.EnsureLLMRecordsTable(); err != nil {
t.Fatalf("ensure: %v", err)
}
content, err := fs.ReadFile(migrationsFS(), llmRecordsMigration)
if err != nil {
t.Fatal(err)
}
llmRecordsMigrateSQL := string(content)
tx, err := d.Begin()
if err != nil {
@@ -28,7 +34,7 @@ func TestLLMRecordsMigrateAddsRawColumnsToOldTable(t *testing.T) {
if _, err := tx.Exec(`ALTER TABLE llm_records DROP COLUMN IF EXISTS raw_request, DROP COLUMN IF EXISTS raw_response`); err != nil {
t.Fatalf("simulate old table: %v", err)
}
if _, err := tx.Exec(llmRecordsMigrate); err != nil {
if _, err := tx.Exec(llmRecordsMigrateSQL); err != nil {
t.Fatalf("migrate: %v", err)
}
@@ -45,7 +51,7 @@ func TestLLMRecordsMigrateAddsRawColumnsToOldTable(t *testing.T) {
}
// Re-running must stay a no-op (the migration runs on every startup).
if _, err := tx.Exec(llmRecordsMigrate); err != nil {
if _, err := tx.Exec(llmRecordsMigrateSQL); err != nil {
t.Fatalf("migrate is not idempotent: %v", err)
}
+4 -34
View File
@@ -26,41 +26,11 @@ type LLMUsage struct {
Status string `json:"status"` // ok | error
}
const llmUsageSchema = `
CREATE TABLE IF NOT EXISTS llm_usage (
id BIGSERIAL PRIMARY KEY,
ts TIMESTAMPTZ NOT NULL DEFAULT now(),
task_id TEXT,
exploration_id BIGINT,
worker TEXT,
model TEXT,
profile_name TEXT,
latency_ms INTEGER,
input_tokens INTEGER NOT NULL DEFAULT 0,
output_tokens INTEGER NOT NULL DEFAULT 0,
cache_read INTEGER NOT NULL DEFAULT 0,
cache_write INTEGER NOT NULL DEFAULT 0,
status TEXT
);
CREATE INDEX IF NOT EXISTS idx_llm_usage_task ON llm_usage(task_id);
CREATE INDEX IF NOT EXISTS idx_llm_usage_model ON llm_usage(task_id, model);
CREATE INDEX IF NOT EXISTS idx_llm_usage_exp ON llm_usage(exploration_id);
`
// EnsureLLMUsageTable creates the llm_usage metering table if it does not exist.
// EnsureLLMUsageTable creates the llm_usage metering table if it does not exist,
// by re-running the idempotent migration 0002_llm_usage.sql (see
// EnsureLLMRecordsTable for the locking rule).
func (d *DB) EnsureLLMUsageTable() error {
tx, err := d.Begin()
if err != nil {
return err
}
defer tx.Rollback() //nolint:errcheck
if err := coordinateWithSchemaMigration(tx); err != nil {
return err
}
if _, err := tx.Exec(llmUsageSchema); err != nil {
return err
}
return tx.Commit()
return d.execEmbeddedMigration(llmUsageMigration)
}
// InsertLLMUsage appends one metering row. Best-effort: callers log and continue on
+217
View File
@@ -0,0 +1,217 @@
package db
import (
"context"
"crypto/sha256"
"database/sql"
"embed"
"encoding/hex"
"fmt"
"io/fs"
"path"
"regexp"
"sort"
"strconv"
)
// Versioned migrations, applied by Open after schema.sql (rules in the package
// comment, db.go).
//
//go:embed migrations/*.sql
var embeddedMigrationFiles embed.FS
// Embedded migration files that EnsureLLMRecordsTable / EnsureLLMUsageTable
// re-run on demand.
const (
llmRecordsMigration = "0001_llm_records.sql"
llmUsageMigration = "0002_llm_usage.sql"
)
// migrationsFS is the embedded migrations directory, rooted so file names are
// the bare NNNN_slug.sql names.
func migrationsFS() fs.FS {
sub, err := fs.Sub(embeddedMigrationFiles, "migrations")
if err != nil {
panic(err) // the embed pattern guarantees the directory exists
}
return sub
}
const schemaMigrationsTable = `
CREATE TABLE IF NOT EXISTS schema_migrations (
version INTEGER PRIMARY KEY,
name TEXT,
checksum TEXT,
applied_at TIMESTAMPTZ DEFAULT now()
);
`
var migrationNameRE = regexp.MustCompile(`^([0-9]{4})_[a-z0-9_]+\.sql$`)
type migration struct {
version int
name string // file name, e.g. 0001_llm_records.sql
sql string
checksum string // hex SHA-256 of the file content
}
// loadMigrations reads every *.sql file at the root of fsys, sorted by version.
// A .sql file that does not follow NNNN_slug.sql, or a duplicated version, is
// an error so a typo cannot silently skip a migration.
func loadMigrations(fsys fs.FS) ([]migration, error) {
entries, err := fs.ReadDir(fsys, ".")
if err != nil {
return nil, fmt.Errorf("read migrations: %w", err)
}
var out []migration
seen := map[int]string{}
for _, e := range entries {
if e.IsDir() || path.Ext(e.Name()) != ".sql" {
continue
}
m := migrationNameRE.FindStringSubmatch(e.Name())
if m == nil {
return nil, fmt.Errorf("migration file %s: name must be NNNN_slug.sql", e.Name())
}
version, _ := strconv.Atoi(m[1])
if version == 0 {
return nil, fmt.Errorf("migration file %s: version must be > 0", e.Name())
}
if prev, dup := seen[version]; dup {
return nil, fmt.Errorf("migration version %04d is used by both %s and %s", version, prev, e.Name())
}
seen[version] = e.Name()
content, err := fs.ReadFile(fsys, e.Name())
if err != nil {
return nil, fmt.Errorf("read migration %s: %w", e.Name(), err)
}
sum := sha256.Sum256(content)
out = append(out, migration{version: version, name: e.Name(), sql: string(content), checksum: hex.EncodeToString(sum[:])})
}
sort.Slice(out, func(i, j int) bool { return out[i].version < out[j].version })
return out, nil
}
// applyMigrations brings the database up to the migrations in fsys. conn must
// be the connection that holds the schema advisory lock (see Open); every
// statement runs on it, so nothing here waits on that lock again.
//
// It fails closed before applying anything when the database records a version
// this binary does not ship, or an applied migration whose name or checksum
// differs from the file, or a pending migration is older than the newest
// applied one. Each pending migration then runs in its own
// transaction together with its schema_migrations row; a failure rolls that one
// back and stops, leaving earlier migrations applied.
func applyMigrations(ctx context.Context, conn *sql.Conn, fsys fs.FS) error {
migrations, err := loadMigrations(fsys)
if err != nil {
return err
}
if _, err := conn.ExecContext(ctx, schemaMigrationsTable); err != nil {
return fmt.Errorf("create schema_migrations: %w", err)
}
type appliedRow struct{ name, checksum string }
applied := map[int]appliedRow{}
rows, err := conn.QueryContext(ctx, `SELECT version, COALESCE(name,''), COALESCE(checksum,'') FROM schema_migrations ORDER BY version`)
if err != nil {
return fmt.Errorf("read schema_migrations: %w", err)
}
var appliedVersions []int
for rows.Next() {
var v int
var r appliedRow
if err := rows.Scan(&v, &r.name, &r.checksum); err != nil {
rows.Close()
return fmt.Errorf("read schema_migrations: %w", err)
}
applied[v] = r
appliedVersions = append(appliedVersions, v)
}
if err := rows.Close(); err != nil {
return fmt.Errorf("read schema_migrations: %w", err)
}
if err := rows.Err(); err != nil {
return fmt.Errorf("read schema_migrations: %w", err)
}
byVersion := map[int]migration{}
for _, m := range migrations {
byVersion[m.version] = m
}
for _, v := range appliedVersions {
r := applied[v]
m, ok := byVersion[v]
if !ok {
return fmt.Errorf("migration %04d (%s) is applied in the database but missing from this binary", v, r.name)
}
if r.name != m.name {
return fmt.Errorf("migration %04d: database records file %s but this binary has %s", v, r.name, m.name)
}
if r.checksum != m.checksum {
return fmt.Errorf("migration %04d (%s): checksum changed since it was applied (database %s, file %s); published migrations must not be edited", v, m.name, r.checksum, m.checksum)
}
}
// A pending version below the newest applied one would run out of order on
// this database: refuse it before writing anything.
if len(appliedVersions) > 0 {
maxVersion := appliedVersions[len(appliedVersions)-1]
for _, m := range migrations {
if _, done := applied[m.version]; !done && m.version < maxVersion {
return fmt.Errorf("migration %s (%04d) is older than the applied migration %s (%04d); migrations must be appended, never inserted",
m.name, m.version, applied[maxVersion].name, maxVersion)
}
}
}
for _, m := range migrations {
if _, done := applied[m.version]; done {
continue
}
if err := applyMigration(ctx, conn, m); err != nil {
return fmt.Errorf("migration %04d (%s): %w", m.version, m.name, err)
}
}
return nil
}
func applyMigration(ctx context.Context, conn *sql.Conn, m migration) error {
tx, err := conn.BeginTx(ctx, nil)
if err != nil {
return err
}
defer tx.Rollback() //nolint:errcheck // no-op after Commit
// No args: pgx sends it over the simple protocol, which allows several statements.
if _, err := tx.ExecContext(ctx, m.sql); err != nil {
return err
}
if _, err := tx.ExecContext(ctx, `INSERT INTO schema_migrations(version, name, checksum) VALUES ($1, $2, $3)`, m.version, m.name, m.checksum); err != nil {
return fmt.Errorf("record: %w", err)
}
return tx.Commit()
}
// execEmbeddedMigration re-runs one embedded (idempotent) migration file in its
// own transaction under the schema lock. It does not touch schema_migrations.
// The lock is taken on a pooled connection, so this must never be called from
// inside Open's withSchemaMigrationLock callback: it would wait on the lock
// that callback's connection holds.
func (d *DB) execEmbeddedMigration(name string) error {
content, err := fs.ReadFile(migrationsFS(), name)
if err != nil {
return err
}
tx, err := d.Begin()
if err != nil {
return err
}
defer tx.Rollback() //nolint:errcheck
if err := coordinateWithSchemaMigration(tx); err != nil {
return err
}
if _, err := tx.Exec(string(content)); err != nil {
return err
}
return tx.Commit()
}
+415
View File
@@ -0,0 +1,415 @@
package db
import (
"crypto/sha256"
"database/sql"
"encoding/hex"
"io/fs"
"net/url"
"strings"
"testing"
"testing/fstest"
"time"
)
func TestLoadMigrationsValidation(t *testing.T) {
ms, err := loadMigrations(fstest.MapFS{
"0010_b.sql": {Data: []byte("SELECT 10;")},
"0002_a.sql": {Data: []byte("SELECT 2;")},
"README.md": {Data: []byte("not a migration")},
})
if err != nil {
t.Fatal(err)
}
if len(ms) != 2 || ms[0].version != 2 || ms[1].version != 10 {
t.Fatalf("want versions [2 10], got %+v", ms)
}
sum := sha256.Sum256([]byte("SELECT 2;"))
if ms[0].checksum != hex.EncodeToString(sum[:]) || ms[0].name != "0002_a.sql" {
t.Fatalf("migration 0002 = %+v", ms[0])
}
for name, fsys := range map[string]fstest.MapFS{
"bad name": {"2_a.sql": {Data: []byte("SELECT 1;")}},
"duplicate version": {"0001_a.sql": {Data: []byte("SELECT 1;")}, "0001_b.sql": {Data: []byte("SELECT 1;")}},
} {
if _, err := loadMigrations(fsys); err == nil {
t.Errorf("%s: want error", name)
}
}
}
// scratchDSN returns the DSN of a new, empty database named after the test
// database plus suffix, dropped again when the test ends.
func scratchDSN(t *testing.T, suffix string) string {
t.Helper()
u, err := url.Parse(testDSN(t))
if err != nil || strings.Trim(u.Path, "/") == "" {
t.Skipf("DSN has no database name — skipping")
}
name := strings.TrimPrefix(u.Path, "/") + "_mig_" + suffix
admin := *u
admin.Path = "/postgres"
conn, err := sql.Open("pgx", admin.String())
if err != nil {
t.Skipf("postgres unavailable (%v) — skipping", err)
}
if err := conn.Ping(); err != nil {
conn.Close()
t.Skipf("postgres unavailable (%v) — skipping", err)
}
drop := func() error {
_, err := conn.Exec(`DROP DATABASE IF EXISTS "` + name + `" WITH (FORCE)`)
return err
}
if err := drop(); err != nil {
t.Fatalf("drop leftover %s: %v", name, err)
}
t.Cleanup(func() {
if err := drop(); err != nil {
t.Errorf("drop %s: %v", name, err)
}
conn.Close()
})
u.Path = "/" + name
return u.String()
}
// withEmbedded returns the embedded migrations plus extra files.
func withEmbedded(t *testing.T, extra fstest.MapFS) fstest.MapFS {
t.Helper()
out := fstest.MapFS{}
for _, name := range []string{llmRecordsMigration, llmUsageMigration} {
content, err := fs.ReadFile(migrationsFS(), name)
if err != nil {
t.Fatal(err)
}
out[name] = &fstest.MapFile{Data: content}
}
for name, f := range extra {
out[name] = f
}
return out
}
type appliedMigration struct {
version int
name, checksum string
appliedAt time.Time
}
func readApplied(t *testing.T, d *DB) []appliedMigration {
t.Helper()
rows, err := d.Query(`SELECT version, name, checksum, applied_at FROM schema_migrations ORDER BY version`)
if err != nil {
t.Fatal(err)
}
defer rows.Close()
var out []appliedMigration
for rows.Next() {
var m appliedMigration
if err := rows.Scan(&m.version, &m.name, &m.checksum, &m.appliedAt); err != nil {
t.Fatal(err)
}
out = append(out, m)
}
if err := rows.Err(); err != nil {
t.Fatal(err)
}
return out
}
// assertEmbeddedApplied checks that both LLM tables exist and that every
// embedded migration is recorded with the SHA-256 of its file.
func assertEmbeddedApplied(t *testing.T, d *DB) []appliedMigration {
t.Helper()
for _, table := range []string{"llm_records", "llm_usage"} {
var exists bool
if err := d.QueryRow(`SELECT to_regclass($1) IS NOT NULL`, table).Scan(&exists); err != nil {
t.Fatal(err)
}
if !exists {
t.Errorf("table %s missing after Open", table)
}
}
applied := readApplied(t, d)
want := []struct {
version int
name string
}{{1, llmRecordsMigration}, {2, llmUsageMigration}, {3, "0003_task_scope_icp_index.sql"}}
if len(applied) != len(want) {
t.Fatalf("schema_migrations = %+v, want versions 1 to 3", applied)
}
for i, w := range want {
content, err := fs.ReadFile(migrationsFS(), w.name)
if err != nil {
t.Fatal(err)
}
sum := sha256.Sum256(content)
got := applied[i]
if got.version != w.version || got.name != w.name || got.checksum != hex.EncodeToString(sum[:]) {
t.Errorf("schema_migrations row %d = %+v, want version %d name %s checksum %x", i, got, w.version, w.name, sum)
}
}
return applied
}
// assertReopenIsNoop opens dsn again and checks that no migration row was added
// or re-applied, then that both Ensure functions stay idempotent.
func assertReopenIsNoop(t *testing.T, dsn string, before []appliedMigration) {
t.Helper()
d, err := Open(dsn)
if err != nil {
t.Fatalf("second Open: %v", err)
}
defer d.Close()
after := assertEmbeddedApplied(t, d)
for i := range before {
if !after[i].appliedAt.Equal(before[i].appliedAt) {
t.Errorf("migration %04d applied_at changed: %v -> %v", before[i].version, before[i].appliedAt, after[i].appliedAt)
}
}
for range 2 {
if err := d.EnsureLLMRecordsTable(); err != nil {
t.Fatalf("EnsureLLMRecordsTable after Open: %v", err)
}
if err := d.EnsureLLMUsageTable(); err != nil {
t.Fatalf("EnsureLLMUsageTable after Open: %v", err)
}
}
if got := readApplied(t, d); len(got) != len(before) {
t.Errorf("Ensure functions changed schema_migrations: %+v", got)
}
}
// TestOpenRecordsEmbeddedMigrations runs against the package test database:
// fresh on a first run, already migrated on a second run.
func TestOpenRecordsEmbeddedMigrations(t *testing.T) {
dsn := testDSN(t)
d, err := Open(dsn)
if err != nil {
t.Skipf("postgres unavailable (%v) — skipping", err)
}
applied := assertEmbeddedApplied(t, d)
d.Close()
assertReopenIsNoop(t, dsn, applied)
}
func TestOpenMigratesFreshDatabase(t *testing.T) {
dsn := scratchDSN(t, "fresh")
d, err := Open(dsn)
if err != nil {
t.Fatalf("Open: %v", err)
}
applied := assertEmbeddedApplied(t, d)
d.Close()
assertReopenIsNoop(t, dsn, applied)
}
// An install that predates schema_migrations already has both tables (created
// by the Ensure functions, possibly without the later llm_records columns).
// Open must adopt them: run 0001/0002 over them and record both.
func TestOpenAdoptsExistingTablesWithoutSchemaMigrations(t *testing.T) {
dsn := scratchDSN(t, "legacy")
d, err := openWithMigrations(dsn, fstest.MapFS{})
if err != nil {
t.Fatalf("Open without migrations: %v", err)
}
if err := d.EnsureLLMRecordsTable(); err != nil {
t.Fatal(err)
}
if err := d.EnsureLLMUsageTable(); err != nil {
t.Fatal(err)
}
for _, q := range []string{
`ALTER TABLE llm_records DROP COLUMN raw_request, DROP COLUMN raw_response`,
`INSERT INTO llm_records(model) VALUES ('legacy')`,
`INSERT INTO llm_usage(model, status) VALUES ('legacy', 'ok')`,
`DROP TABLE schema_migrations`,
} {
if _, err := d.Exec(q); err != nil {
t.Fatalf("%s: %v", q, err)
}
}
d.Close()
d, err = Open(dsn)
if err != nil {
t.Fatalf("Open on existing tables: %v", err)
}
applied := assertEmbeddedApplied(t, d)
var records, usage, rawCols int
if err := d.QueryRow(`SELECT count(*) FROM llm_records WHERE model='legacy'`).Scan(&records); err != nil {
t.Fatal(err)
}
if err := d.QueryRow(`SELECT count(*) FROM llm_usage WHERE model='legacy'`).Scan(&usage); err != nil {
t.Fatal(err)
}
if err := d.QueryRow(`SELECT count(*) FROM information_schema.columns
WHERE table_name='llm_records' AND column_name IN ('raw_request','raw_response')`).Scan(&rawCols); err != nil {
t.Fatal(err)
}
if records != 1 || usage != 1 || rawCols != 2 {
t.Errorf("after adopt: llm_records legacy rows=%d llm_usage legacy rows=%d raw columns=%d, want 1 1 2", records, usage, rawCols)
}
d.Close()
assertReopenIsNoop(t, dsn, applied)
}
// probeMigration records how many migrations were already applied when it
// ran, and fails if it ever runs twice (CREATE TABLE without IF NOT EXISTS).
var probeMigration = &fstest.MapFile{Data: []byte(`
CREATE TABLE migration_probe (applied_before INTEGER);
INSERT INTO migration_probe SELECT count(*) FROM schema_migrations;
`)}
func TestMigrationsApplyNewVersionOnceInOrder(t *testing.T) {
dsn := scratchDSN(t, "order")
fsys := withEmbedded(t, fstest.MapFS{"0003_probe.sql": probeMigration})
for pass := 1; pass <= 2; pass++ {
d, err := openWithMigrations(dsn, fsys)
if err != nil {
t.Fatalf("pass %d: %v", pass, err)
}
applied := readApplied(t, d)
if len(applied) != 3 || applied[2].version != 3 || applied[2].name != "0003_probe.sql" {
t.Fatalf("pass %d: schema_migrations = %+v", pass, applied)
}
var runs, before int
if err := d.QueryRow(`SELECT count(*), max(applied_before) FROM migration_probe`).Scan(&runs, &before); err != nil {
t.Fatal(err)
}
if runs != 1 || before != 2 {
t.Fatalf("pass %d: probe ran %d times with %d migrations before it, want 1 and 2", pass, runs, before)
}
d.Close()
}
}
func TestMigrationsFailClosed(t *testing.T) {
dsn := scratchDSN(t, "closed")
d, err := openWithMigrations(dsn, withEmbedded(t, fstest.MapFS{"0003_probe.sql": probeMigration}))
if err != nil {
t.Fatal(err)
}
d.Close()
cases := []struct {
name string
fsys fs.FS
want []string
}{
{"checksum changed", withEmbedded(t, fstest.MapFS{"0003_probe.sql": {Data: append([]byte("-- edited\n"), probeMigration.Data...)}}),
[]string{"0003", "0003_probe.sql", "checksum"}},
{"version missing from binary", withEmbedded(t, fstest.MapFS{}),
[]string{"0003", "0003_probe.sql", "missing from this binary"}},
{"name changed", withEmbedded(t, fstest.MapFS{"0003_renamed.sql": probeMigration}),
[]string{"0003", "0003_probe.sql", "0003_renamed.sql"}},
}
for _, c := range cases {
d, err := openWithMigrations(dsn, c.fsys)
if err == nil {
d.Close()
t.Errorf("%s: Open succeeded, want error", c.name)
continue
}
for _, w := range c.want {
if !strings.Contains(err.Error(), w) {
t.Errorf("%s: error %q does not mention %q", c.name, err, w)
}
}
}
}
func TestFailingMigrationRollsBackAndBlocksOpen(t *testing.T) {
dsn := scratchDSN(t, "fail")
fsys := withEmbedded(t, fstest.MapFS{
"0003_probe.sql": probeMigration,
"0004_broken.sql": {Data: []byte(`
CREATE TABLE migration_broken (x INTEGER);
SELECT 1/0;
`)},
})
d, err := openWithMigrations(dsn, fsys)
if err == nil {
d.Close()
t.Fatal("Open succeeded with a failing migration")
}
if !strings.Contains(err.Error(), "0004") || !strings.Contains(err.Error(), "0004_broken.sql") {
t.Errorf("error %q does not name the failing migration", err)
}
// Inspect with the migrations that succeeded: earlier ones stay applied,
// the failing one left nothing behind.
d, err = openWithMigrations(dsn, withEmbedded(t, fstest.MapFS{"0003_probe.sql": probeMigration}))
if err != nil {
t.Fatal(err)
}
defer d.Close()
applied := readApplied(t, d)
if len(applied) != 3 || applied[2].version != 3 {
t.Fatalf("schema_migrations = %+v, want versions 1..3", applied)
}
var broken bool
if err := d.QueryRow(`SELECT to_regclass('migration_broken') IS NOT NULL`).Scan(&broken); err != nil {
t.Fatal(err)
}
if broken {
t.Error("migration_broken exists: the failed migration was not rolled back")
}
}
// A database already at 0003 must refuse a binary that adds 0002 below it,
// before writing anything.
func TestMigrationsRefuseOutOfOrderVersion(t *testing.T) {
dsn := scratchDSN(t, "outoforder")
records, err := fs.ReadFile(migrationsFS(), llmRecordsMigration)
if err != nil {
t.Fatal(err)
}
d, err := openWithMigrations(dsn, fstest.MapFS{
llmRecordsMigration: {Data: records},
"0003_probe.sql": probeMigration,
})
if err != nil {
t.Fatal(err)
}
before := readApplied(t, d)
d.Close()
if len(before) != 2 || before[0].version != 1 || before[1].version != 3 {
t.Fatalf("setup schema_migrations = %+v, want versions 1 and 3", before)
}
d, err = openWithMigrations(dsn, withEmbedded(t, fstest.MapFS{"0003_probe.sql": probeMigration}))
if err == nil {
d.Close()
t.Fatal("Open succeeded with 0002 pending below applied 0003")
}
for _, w := range []string{llmUsageMigration, "(0002)", "0003_probe.sql", "(0003)", "never inserted"} {
if !strings.Contains(err.Error(), w) {
t.Errorf("error %q does not mention %q", err, w)
}
}
raw, err := sql.Open("pgx", dsn)
if err != nil {
t.Fatal(err)
}
defer raw.Close()
after := readApplied(t, &DB{raw})
if len(after) != len(before) {
t.Fatalf("schema_migrations changed: before %+v, after %+v", before, after)
}
for i := range before {
if after[i].version != before[i].version || after[i].checksum != before[i].checksum || !after[i].appliedAt.Equal(before[i].appliedAt) {
t.Errorf("schema_migrations row %d changed: before %+v, after %+v", i, before[i], after[i])
}
}
var usage bool
if err := raw.QueryRow(`SELECT to_regclass('llm_usage') IS NOT NULL`).Scan(&usage); err != nil {
t.Fatal(err)
}
if usage {
t.Error("llm_usage exists: the refused 0002 migration ran")
}
}
+29
View File
@@ -0,0 +1,29 @@
CREATE TABLE IF NOT EXISTS llm_records (
id BIGSERIAL PRIMARY KEY,
ts TIMESTAMPTZ DEFAULT now(),
model TEXT,
profile_name TEXT,
session_id TEXT,
task_id TEXT,
worker TEXT,
latency_ms INTEGER,
input_tokens INTEGER,
output_tokens INTEGER,
cache_read INTEGER,
cache_write INTEGER,
status TEXT,
error TEXT,
request_body TEXT,
response_body TEXT,
raw_request TEXT,
raw_response TEXT
);
CREATE INDEX IF NOT EXISTS idx_llm_records_ts ON llm_records(ts);
CREATE INDEX IF NOT EXISTS idx_llm_records_session ON llm_records(session_id);
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS task_id TEXT;
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS worker TEXT;
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS profile_name TEXT;
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS raw_request TEXT;
ALTER TABLE llm_records ADD COLUMN IF NOT EXISTS raw_response TEXT;
+19
View File
@@ -0,0 +1,19 @@
CREATE TABLE IF NOT EXISTS llm_usage (
id BIGSERIAL PRIMARY KEY,
ts TIMESTAMPTZ NOT NULL DEFAULT now(),
task_id TEXT,
exploration_id BIGINT,
worker TEXT,
model TEXT,
profile_name TEXT,
latency_ms INTEGER,
input_tokens INTEGER NOT NULL DEFAULT 0,
output_tokens INTEGER NOT NULL DEFAULT 0,
cache_read INTEGER NOT NULL DEFAULT 0,
cache_write INTEGER NOT NULL DEFAULT 0,
status TEXT
);
CREATE INDEX IF NOT EXISTS idx_llm_usage_task ON llm_usage(task_id);
CREATE INDEX IF NOT EXISTS idx_llm_usage_model ON llm_usage(task_id, model);
CREATE INDEX IF NOT EXISTS idx_llm_usage_exp ON llm_usage(exploration_id);
@@ -0,0 +1,9 @@
-- The coverage target CTE (contextCoverageCTE / covTargetCTE / scopeTargetCTE)
-- joins assets to task_scope on an OR of per-kind predicates. PostgreSQL plans it
-- as one BitmapOr probe of task_scope per asset. Every branch had an index except
-- kind='icp', which fell back to uq_task_scope_v2 with only "kind = 'icp'" as the
-- index condition (task_id is the leading column), so each probe walked the
-- whole unique index: about 70% of the buffer hits of the coverage-graph query on
-- a 3,000-asset task scoped by 800 subdomains. This partial index makes the icp
-- probe an equality lookup on value.
CREATE INDEX IF NOT EXISTS idx_ts_icp ON task_scope(value) WHERE kind = 'icp';
+8
View File
@@ -447,6 +447,14 @@ func restoreArchiveAssets(tx *sql.Tx, taskID int64, raw json.RawMessage) (map[in
row["company_source"] = "explicit"
warnings = append(warnings, fmt.Sprintf("asset %d's company %d has been deleted; restored as unaffiliated", oldID, companyID))
}
// Archives taken before normalizeURL stripped userinfo can hold
// http://user:pass@host URLs. Normalise like the live upserts so the
// restore neither stores the credential nor misses the clean row.
if typeName, _ := row["type"].(string); typeName == "service" || typeName == "endpoint" {
if rawURL, ok := row["url"].(string); ok {
row["url"] = normalizeURL(rawURL)
}
}
if existing, found, err := findArchiveAssetNaturalID(tx, row); err != nil {
return nil, nil, err
} else if found {
+284
View File
@@ -0,0 +1,284 @@
package db
import (
"encoding/json"
"fmt"
"strings"
"testing"
)
const restoreURLHost = "restore-userinfo.example"
// bigintArray renders ids as a PostgreSQL array literal for a $n::bigint[] cast.
func bigintArray(ids ...int64) string {
parts := make([]string, len(ids))
for i, id := range ids {
parts[i] = fmt.Sprint(id)
}
return "{" + strings.Join(parts, ",") + "}"
}
// archivedAssetRows exports live asset rows the way SnapshotTaskArchive does,
// so the restore tests start from realistic archive JSON.
func archivedAssetRows(t *testing.T, d *DB, ids ...int64) []map[string]any {
t.Helper()
raw, _, err := queryArchiveRows(d, `SELECT asset.* FROM assets asset WHERE asset.id = ANY($1::bigint[]) ORDER BY asset.id`, bigintArray(ids...))
if err != nil {
t.Fatal(err)
}
rows, err := decodeArchiveRows(raw)
if err != nil {
t.Fatal(err)
}
if len(rows) != len(ids) {
t.Fatalf("exported %d archive rows, want %d", len(rows), len(ids))
}
return rows
}
// restoreArchivedAssets runs restoreArchiveAssets on rows in a committed tx.
func restoreArchivedAssets(t *testing.T, d *DB, taskID int64, rows []map[string]any) map[int64]int64 {
t.Helper()
raw, err := json.Marshal(rows)
if err != nil {
t.Fatal(err)
}
tx, err := d.Begin()
if err != nil {
t.Fatal(err)
}
defer tx.Rollback() //nolint:errcheck
mapping, _, err := restoreArchiveAssets(tx, taskID, raw)
if err != nil {
t.Fatal(err)
}
if err := tx.Commit(); err != nil {
t.Fatal(err)
}
return mapping
}
func restoreURLCleanup(d *DB) {
d.Exec(`DELETE FROM assets WHERE url LIKE '%` + restoreURLHost + `%' OR domain LIKE '%` + restoreURLHost + `' OR root_domain = '` + restoreURLHost + `' OR ip = '198.51.100.231'`) //nolint:errcheck
}
func countRestoreURLRows(t *testing.T, d *DB, assetType, cleanURL string) int {
t.Helper()
var n int
if err := d.QueryRow(`SELECT count(*) FROM assets WHERE type=$1 AND (url=$2 OR url LIKE '%@%' || $3::text || '%')`, assetType, cleanURL, restoreURLHost).Scan(&n); err != nil {
t.Fatal(err)
}
return n
}
func assertNoRestoreURLCredential(t *testing.T, d *DB, id int64) {
t.Helper()
var row string
if err := d.QueryRow(`SELECT row_to_json(a)::text FROM assets a WHERE id=$1`, id).Scan(&row); err != nil {
t.Fatal(err)
}
for _, secret := range []string{"alice", "bob", "s3cr3t"} {
if strings.Contains(row, secret) {
t.Fatalf("restored asset %d still carries %q: %s", id, secret, row)
}
}
}
func TestRestoreArchiveAssetsStripsURLUserinfo(t *testing.T) {
d, av2, _ := testSetup(t)
defer d.Close()
restoreURLCleanup(d)
defer restoreURLCleanup(d)
const taskID = int64(880000001)
svcURL := "http://" + restoreURLHost + ":8080/admin"
epURL := "https://api." + restoreURLHost + "/users?id=1"
svcID, err := av2.UpsertHTTPService(UpsertHTTPServiceReq{URL: svcURL, TaskID: taskID})
if err != nil {
t.Fatal(err)
}
epID, err := av2.UpsertEndpoint(UpsertEndpointReq{URL: epURL, Method: "GET", TaskID: taskID})
if err != nil {
t.Fatal(err)
}
rows := archivedAssetRows(t, d, svcID, epID)
// Simulate an archive taken before normalizeURL dropped userinfo.
rows[0]["url"] = "http://alice:s3cr3t-one@" + restoreURLHost + ":8080/admin"
rows[1]["url"] = "https://bob:s3cr3t-two@api." + restoreURLHost + "/users?id=1"
archived := map[string]map[string]any{"service": {}, "endpoint": {}}
for _, row := range rows {
typeName := row["type"].(string)
for _, key := range []string{"domain", "root_domain", "port", "service_name", "method"} {
archived[typeName][key] = row[key]
}
}
if _, err := d.Exec(`DELETE FROM assets WHERE id = ANY($1::bigint[])`, bigintArray(svcID, epID)); err != nil {
t.Fatal(err)
}
mapping := restoreArchivedAssets(t, d, taskID, rows)
for oldID, wantURL := range map[int64]string{svcID: svcURL, epID: epURL} {
newID := mapping[oldID]
if newID == 0 {
t.Fatalf("asset %d was not restored: %v", oldID, mapping)
}
var gotURL, typeName string
var domain, rootDomain, serviceName, method *string
var port *int64
if err := d.QueryRow(`SELECT url,type,domain,root_domain,port,service_name,method FROM assets WHERE id=$1`, newID).
Scan(&gotURL, &typeName, &domain, &rootDomain, &port, &serviceName, &method); err != nil {
t.Fatal(err)
}
if gotURL != wantURL {
t.Fatalf("restored %s url=%q, want %q", typeName, gotURL, wantURL)
}
assertNoRestoreURLCredential(t, d, newID)
// Only url is normalised: the other columns keep the archived values.
want := archived[typeName]
got := map[string]any{"domain": domain, "root_domain": rootDomain, "port": port, "service_name": serviceName, "method": method}
for key, value := range got {
gotJSON, _ := json.Marshal(value)
wantJSON, _ := json.Marshal(want[key])
if string(gotJSON) != string(wantJSON) {
t.Errorf("%s %s=%s, want archived %s", typeName, key, gotJSON, wantJSON)
}
}
if n := countRestoreURLRows(t, d, typeName, wantURL); n != 1 {
t.Fatalf("%s rows for %q = %d, want 1", typeName, wantURL, n)
}
}
}
func TestRestoreArchiveAssetsReusesCleanURLRow(t *testing.T) {
d, av2, _ := testSetup(t)
defer d.Close()
restoreURLCleanup(d)
defer restoreURLCleanup(d)
const liveTaskID, archivedTaskID = int64(880000002), int64(880000003)
svcURL := "http://" + restoreURLHost + ":8080/admin"
epURL := "https://api." + restoreURLHost + "/users?id=1"
svcID, err := av2.UpsertHTTPService(UpsertHTTPServiceReq{URL: svcURL, TaskID: liveTaskID})
if err != nil {
t.Fatal(err)
}
epID, err := av2.UpsertEndpoint(UpsertEndpointReq{URL: epURL, Method: "GET", TaskID: liveTaskID})
if err != nil {
t.Fatal(err)
}
rows := archivedAssetRows(t, d, svcID, epID)
// The archived rows are other, older rows whose url still carries userinfo.
rows[0]["id"], rows[0]["url"] = int64(990000101), "http://alice:s3cr3t-one@"+restoreURLHost+":8080/admin"
rows[1]["id"], rows[1]["url"] = int64(990000102), "https://bob:s3cr3t-two@api."+restoreURLHost+"/users?id=1"
for _, row := range rows {
row["task_ids"] = []any{archivedTaskID}
}
mapping := restoreArchivedAssets(t, d, archivedTaskID, rows)
for oldID, existingID := range map[int64]int64{990000101: svcID, 990000102: epID} {
if mapping[oldID] != existingID {
t.Fatalf("archived asset %d mapped to %d, want existing clean row %d", oldID, mapping[oldID], existingID)
}
var taskIDs string
if err := d.QueryRow(`SELECT task_ids::text FROM assets WHERE id=$1`, existingID).Scan(&taskIDs); err != nil {
t.Fatal(err)
}
if want := bigintArray(liveTaskID, archivedTaskID); taskIDs != want {
t.Fatalf("asset %d task_ids=%s, want %s", existingID, taskIDs, want)
}
assertNoRestoreURLCredential(t, d, existingID)
var leftover int
if err := d.QueryRow(`SELECT count(*) FROM assets WHERE id=$1`, oldID).Scan(&leftover); err != nil {
t.Fatal(err)
}
if leftover != 0 {
t.Fatalf("archived asset %d inserted beside the clean row", oldID)
}
}
if n := countRestoreURLRows(t, d, "service", svcURL); n != 1 {
t.Fatalf("service rows = %d, want 1", n)
}
if n := countRestoreURLRows(t, d, "endpoint", epURL); n != 1 {
t.Fatalf("endpoint rows = %d, want 1", n)
}
}
func TestRestoreArchiveAssetsDedupsURLAcrossCredentials(t *testing.T) {
d, av2, _ := testSetup(t)
defer d.Close()
restoreURLCleanup(d)
defer restoreURLCleanup(d)
const taskID = int64(880000004)
svcURL := "http://" + restoreURLHost + ":8080/admin"
svcID, err := av2.UpsertHTTPService(UpsertHTTPServiceReq{URL: svcURL, TaskID: taskID})
if err != nil {
t.Fatal(err)
}
first := archivedAssetRows(t, d, svcID)[0]
second := archivedAssetRows(t, d, svcID)[0]
if _, err := d.Exec(`DELETE FROM assets WHERE id=$1`, svcID); err != nil {
t.Fatal(err)
}
first["id"], first["url"] = int64(990000201), "http://alice:s3cr3t-one@"+restoreURLHost+":8080/admin"
second["id"], second["url"] = int64(990000202), "http://bob:s3cr3t-two@"+restoreURLHost+":8080/admin"
mapping := restoreArchivedAssets(t, d, taskID, []map[string]any{first, second})
if mapping[990000201] == 0 || mapping[990000201] != mapping[990000202] {
t.Fatalf("credential variants restored as separate rows: %v", mapping)
}
if n := countRestoreURLRows(t, d, "service", svcURL); n != 1 {
t.Fatalf("service rows = %d, want exactly 1", n)
}
assertNoRestoreURLCredential(t, d, mapping[990000201])
}
func TestRestoreArchiveAssetsLeavesDomainAndIPURLUntouched(t *testing.T) {
d, av2, _ := testSetup(t)
defer d.Close()
restoreURLCleanup(d)
defer restoreURLCleanup(d)
const taskID = int64(880000005)
domainID, err := av2.UpsertRootDomain(UpsertRootDomainReq{Domain: restoreURLHost, TaskID: taskID})
if err != nil {
t.Fatal(err)
}
ipID, err := av2.UpsertIP(UpsertIPReq{IP: "198.51.100.231", TaskID: taskID})
if err != nil {
t.Fatal(err)
}
rows := archivedAssetRows(t, d, domainID, ipID)
// A url normalizeURL would rewrite proves the normalisation is scoped to
// service and endpoint rows.
const oddURL = "HTTP://Restore-Userinfo.example/"
for _, row := range rows {
row["url"] = oddURL
}
want := map[int64][]any{}
for _, row := range rows {
id, _ := jsonInt64(row["id"])
want[id] = []any{row["type"], row["domain"], row["root_domain"], row["ip"]}
}
if _, err := d.Exec(`DELETE FROM assets WHERE id = ANY($1::bigint[])`, bigintArray(domainID, ipID)); err != nil {
t.Fatal(err)
}
mapping := restoreArchivedAssets(t, d, taskID, rows)
for oldID, fields := range want {
var typeName string
var domain, rootDomain, ip, gotURL *string
if err := d.QueryRow(`SELECT type,domain,root_domain,ip,url FROM assets WHERE id=$1`, mapping[oldID]).
Scan(&typeName, &domain, &rootDomain, &ip, &gotURL); err != nil {
t.Fatal(err)
}
got, _ := json.Marshal([]any{typeName, domain, rootDomain, ip})
wantJSON, _ := json.Marshal(fields)
if string(got) != string(wantJSON) {
t.Errorf("asset %d restored as %s, want %s", oldID, got, wantJSON)
}
if gotURL == nil || *gotURL != oddURL {
t.Errorf("%s asset url changed to %v, want %q", typeName, gotURL, oddURL)
}
}
}
+62 -17
View File
@@ -4,6 +4,7 @@ import (
"database/sql"
"fmt"
"net"
"sort"
"strconv"
"strings"
)
@@ -534,16 +535,44 @@ ORDER BY a.id`, taskID)
}
}
}
// One query for every missing root instead of one per root.
roots := make([]string, 0, len(missingRoots))
for root := range missingRoots {
var id, companyID int64
err := s.db.QueryRow(`SELECT id, COALESCE(company_id,0) FROM assets
WHERE type='root_domain' AND domain=$1 LIMIT 1`, root).Scan(&id, &companyID)
roots = append(roots, root)
}
sort.Strings(roots)
type rootRow struct{ id, companyID int64 }
rootRows := map[string]rootRow{}
if len(roots) > 0 {
rrows, err := s.db.Query(`SELECT domain, id, COALESCE(company_id,0) FROM assets
WHERE type='root_domain' AND domain=ANY($1::text[]) ORDER BY id`, roots)
if err != nil {
return nil, err
}
for rrows.Next() {
var domain string
var r rootRow
if err := rrows.Scan(&domain, &r.id, &r.companyID); err != nil {
rrows.Close()
return nil, err
}
if _, ok := rootRows[domain]; !ok {
rootRows[domain] = r
}
}
err = rrows.Err()
rrows.Close()
if err != nil {
return nil, err
}
}
for _, root := range roots {
var node CoverageGraphNode
if err == nil && id > 0 {
node = CoverageGraphNode{Key: assetKey(id), Kind: "root_domain", AssetID: id,
CompanyID: companyID, Domain: root, Label: root}
if companyID > 0 {
companyIDs[companyID] = true
if r, ok := rootRows[root]; ok && r.id > 0 {
node = CoverageGraphNode{Key: assetKey(r.id), Kind: "root_domain", AssetID: r.id,
CompanyID: r.companyID, Domain: root, Label: root}
if r.companyID > 0 {
companyIDs[r.companyID] = true
}
} else {
node = CoverageGraphNode{Key: "r:" + root, Kind: "root_domain", Domain: root, Label: root}
@@ -552,18 +581,34 @@ WHERE type='root_domain' AND domain=$1 LIMIT 1`, root).Scan(&id, &companyID)
rootByDomain[root] = node.Key
}
// Company nodes for every referenced company id — always gray context.
// Company nodes for every referenced company id — always gray context. One
// query for all of them; an id with no company row gets no node.
ids := make([]int64, 0, len(companyIDs))
for id := range companyIDs {
key := companyKey(id)
if _, ok := byKey[key]; ok {
continue
if _, ok := byKey[companyKey(id)]; !ok {
ids = append(ids, id)
}
var name string
if err := s.db.QueryRow(`SELECT name FROM companies WHERE id=$1`, id).Scan(&name); err != nil {
continue
}
if len(ids) > 0 {
crows, err := s.db.Query(`SELECT id, name FROM companies WHERE id=ANY($1::bigint[]) ORDER BY id`, ids)
if err != nil {
return nil, err
}
for crows.Next() {
var id int64
var name string
if err := crows.Scan(&id, &name); err != nil {
crows.Close()
return nil, err
}
add(CoverageGraphNode{Key: companyKey(id), Kind: "company", CompanyID: id,
Label: name, AssetID: 0})
}
err = crows.Err()
crows.Close()
if err != nil {
return nil, err
}
add(CoverageGraphNode{Key: key, Kind: "company", CompanyID: id,
Label: name, AssetID: 0})
}
// Derived containment edges (only when the parent node exists).
+2 -2
View File
@@ -54,10 +54,10 @@ services:
- "${ARTEX_BIND_ADDR:-127.0.0.1}:8787:8787"
- "127.0.0.1:8788:8788"
volumes:
# Bind the data directory (SQLite, task files, etc.) to data/ in the project root,
# Bind the runtime data directory (traffic index, task files, transcripts, etc.) to data/ in the project root,
# so it is easy to inspect/back up on the host and survives container rebuilds.
- ./data:/app/data
# JWT signing key (jwt.key), kept out of data/, which the file manager browses.
# JWT signing key and secret key (jwt.key, secret.key), kept out of data/, which the file manager browses.
# Persisting it keeps users signed in across container rebuilds.
- ./keys:/app/keys
# Mount skills/ from the project root into the container (overriding the image's built-in /app/skills);
Binary file not shown.

Before

Width:  |  Height:  |  Size: 195 KiB

After

Width:  |  Height:  |  Size: 182 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 141 KiB

After

Width:  |  Height:  |  Size: 149 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 195 KiB

After

Width:  |  Height:  |  Size: 143 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 146 KiB

After

Width:  |  Height:  |  Size: 342 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 348 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 341 KiB

After

Width:  |  Height:  |  Size: 380 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 436 KiB

After

Width:  |  Height:  |  Size: 295 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 162 KiB

After

Width:  |  Height:  |  Size: 278 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 330 KiB

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 202 KiB

After

Width:  |  Height:  |  Size: 163 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 276 KiB

After

Width:  |  Height:  |  Size: 352 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 231 KiB

After

Width:  |  Height:  |  Size: 181 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 356 KiB

After

Width:  |  Height:  |  Size: 385 KiB

+5 -5
View File
@@ -29,7 +29,7 @@ const mcpUntrustedNote = "\nOutput of this tool may contain attacker-controlled
// capture is on) to add to EVERY agent's base list — the DB tools table then
// filters them per-agent binding. Empty/nil → no host tools this run (capture off).
func wireAgentAugment(pg *db.DB, skillDir string, hostTools func() ([]actool.CoreTool, map[string][]string)) {
agent.ToolAugment = func(ctx context.Context, agentKey string) ([]actool.CoreTool, agent.DeferredInfo, func()) {
agent.SetToolAugment(func(ctx context.Context, agentKey string) ([]actool.CoreTool, agent.DeferredInfo, func()) {
a, err := pg.GetAgentByKey(agentKey)
if err != nil || a == nil {
return nil, agent.DeferredInfo{}, nil
@@ -188,7 +188,7 @@ func wireAgentAugment(pg *db.DB, skillDir string, hostTools func() ([]actool.Cor
UnlockSkill: unlockSkill,
}
return extra, def, cleanup
}
})
}
func idSet(ids []int64) map[int64]bool {
@@ -222,7 +222,7 @@ func seedPrompts(pg *db.DB) {
// flag and, if kept, wrapped so the model sees the DB-overridden description/schema
// and default params get injected. MCP/skill/host tools have no row and pass through.
func wireTools(pg *db.DB, domainReg map[string]actool.CoreTool) {
agent.FindingTrafficBindingEnabled = func() bool { return pg.GetBool(settingAgentTrafficBinding, false) }
agent.SetFindingTrafficBindingEnabled(func() bool { return pg.GetBool(settingAgentTrafficBinding, false) })
// Seed the built-in domain tools (first-insert only; DO NOTHING preserves edits).
// No startup prune: rows we didn't seed are left alone so future user-defined
// custom tools (system=false, added via the UI) survive restarts.
@@ -248,7 +248,7 @@ func wireTools(pg *db.DB, domainReg map[string]actool.CoreTool) {
// interactive_shell is on, so Bash points at shell_open for interactive programs
// without ever referencing a tool that isn't injected (§14.1/§14.2).
const bashInteractiveShellNote = "\n\nPrograms that need [interactive input] (msfconsole / interactive ssh login / REPLs like mysql, psql, python / password or yes/no prompts / nc reverse shells) must not use Bash (it has no stdin and would hang); open an interactive session with shell_open instead (and shell_close when done). One-shot, non-interactive commands still use Bash."
agent.ToolResolve = func(ctx context.Context, agentKey string, tools []actool.CoreTool) []actool.CoreTool {
agent.SetToolResolve(func(ctx context.Context, agentKey string, tools []actool.CoreTool) []actool.CoreTool {
rows, err := pg.ListTools()
if err != nil {
log.Printf("[tools] failed to read tools table, passing through with code defaults: %v", err)
@@ -333,7 +333,7 @@ func wireTools(pg *db.DB, domainReg map[string]actool.CoreTool) {
}
}
return out
}
})
}
func contains(ss []string, v string) bool {
+3 -3
View File
@@ -49,7 +49,7 @@ func TestAssembleVisibleSkill(t *testing.T) {
}
wireAgentAugment(pg, skillDir, nil)
t.Cleanup(func() { agent.ToolAugment = nil })
t.Cleanup(func() { agent.SetToolAugment(nil) })
ag, _ := pg.GetAgentByKey("planner")
if ag == nil {
@@ -65,7 +65,7 @@ func TestAssembleVisibleSkill(t *testing.T) {
t.Cleanup(func() { _ = pg.SetAgentSkillVisibility(ag.ID, orig) })
// before: skill not visible → no Skill meta-tool
extra, _, cleanup := agent.ToolAugment(context.Background(), "planner")
extra, _, cleanup := agent.ToolAugment()(context.Background(), "planner")
cleanup()
if hasSkillTool(extra) {
t.Fatalf("expected no Skill meta-tool before the skill is made visible")
@@ -78,7 +78,7 @@ func TestAssembleVisibleSkill(t *testing.T) {
t.Cleanup(func() { _ = pg.ToggleSkillVisibility(ag.ID, skillName, false) })
// after: the Skill meta-tool is packed in
extra, _, cleanup = agent.ToolAugment(context.Background(), "planner")
extra, _, cleanup = agent.ToolAugment()(context.Background(), "planner")
defer cleanup()
if !hasSkillTool(extra) {
t.Fatalf("expected the Skill meta-tool after making the skill visible")
+6 -2
View File
@@ -18,7 +18,9 @@ func TestChatUnavailableReasonDistinguishesStates(t *testing.T) {
}
defer m.Close()
td := t.TempDir()
s := New(context.Background(), m, td, td, td)
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, td, td, td)
defer stopTestServer(t, s, cancel)
// Start from a clean profile table; other tests in the shared DB may have left rows.
existing, _ := m.pg.ListProfiles()
@@ -68,7 +70,9 @@ func TestResolveChatAgentHonoursConversationProfile(t *testing.T) {
}
defer m.Close()
td := t.TempDir()
s := New(context.Background(), m, td, td, td)
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, td, td, td)
defer stopTestServer(t, s, cancel)
// Force the global fallback to nil so a non-nil result can ONLY come from the
// conversation's own profile — this is exactly the situation the user hit
+3 -1
View File
@@ -24,7 +24,9 @@ func TestCoreTaskLifecyclePG(t *testing.T) {
}
defer m.Close()
td := t.TempDir()
s := New(context.Background(), m, td, td, td)
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, td, td, td)
defer stopTestServer(t, s, cancel)
h := s.Handler()
tok, err := signJWT(s.jwtKey)
if err != nil {
+2 -2
View File
@@ -24,7 +24,7 @@ func TestRecordFactSourceSchemaUpgrade(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
cancel()
s := New(ctx, m, t.TempDir(), t.TempDir(), t.TempDir())
t.Cleanup(func() { agent.ToolResolve = nil })
t.Cleanup(func() { agent.SetToolResolve(nil) })
pg := m.pg
old, err := pg.GetTool("record_fact")
@@ -96,7 +96,7 @@ func TestRecordFactSourceSchemaUpgrade(t *testing.T) {
// serves it to the worker.
func resolvedRecordFactProps(t *testing.T) map[string]any {
t.Helper()
tools := agent.ToolResolve(context.Background(), "worker", agent.NewToolSet(nil, "").WorkerTools())
tools := agent.ToolResolve()(context.Background(), "worker", agent.NewToolSet(nil, "").WorkerTools())
for _, tl := range tools {
if tl.Name() == "record_fact" {
props, _ := tl.InputSchema()["properties"].(map[string]any)
+8 -6
View File
@@ -55,16 +55,18 @@ func newRetestServer(t *testing.T) (*Server, int64) {
if err != nil {
t.Fatal(err)
}
oldAugment, oldResolve, oldPrompt := agent.ToolAugment, agent.ToolResolve, agent.PromptOverride
agent.ToolAugment = func(context.Context, string) ([]actool.CoreTool, agent.DeferredInfo, func()) {
oldAugment, oldResolve, oldPrompt := agent.ToolAugment(), agent.ToolResolve(), agent.PromptOverride()
agent.SetToolAugment(func(context.Context, string) ([]actool.CoreTool, agent.DeferredInfo, func()) {
return s.findingRetestTools(), agent.DeferredInfo{}, func() {}
}
agent.ToolResolve = nil
agent.PromptOverride = func(string) (string, bool) { return agent.RetesterDefaultPrompt, true }
})
agent.SetToolResolve(nil)
agent.SetPromptOverride(func(string) (string, bool) { return agent.RetesterDefaultPrompt, true })
t.Cleanup(func() {
cancel()
waitRetestIdle(t, s)
agent.ToolAugment, agent.ToolResolve, agent.PromptOverride = oldAugment, oldResolve, oldPrompt
agent.SetToolAugment(oldAugment)
agent.SetToolResolve(oldResolve)
agent.SetPromptOverride(oldPrompt)
_, _ = pg.Exec(`DELETE FROM conversations WHERE id IN (SELECT conversation_id FROM finding_retests WHERE finding_id=$1)`, fid)
_, _ = pg.DeleteFinding(fid)
pg.Close()
+3 -1
View File
@@ -67,7 +67,9 @@ func TestInheritedActivityDetailAndRelationDeletion(t *testing.T) {
t.Fatal(err)
}
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
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)
+6 -2
View File
@@ -50,7 +50,9 @@ SELECT id,'completed','fixed','{}'::jsonb FROM findings WHERE task_id=$1 AND nam
t.Fatal(err)
}
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
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)
@@ -144,7 +146,9 @@ VALUES ($1,'xss','Reflected XSS','reflected in search','high','confirmed')`, tas
t.Fatal(err)
}
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
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)
+7 -1
View File
@@ -18,8 +18,14 @@ func TestMgmtAPI(t *testing.T) {
if m.pg == nil {
t.Skip("postgres unavailable — skipping management API test")
}
// New starts the notifier and task-archive workers on context.Background();
// closing the pool stops them from claiming later tests' digest batches
// and archive jobs.
defer m.Close()
td := t.TempDir()
s := New(context.Background(), m, td, td, td)
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, td, td, td)
defer stopTestServer(t, s, cancel)
h := s.Handler()
tok, err := signJWT(s.jwtKey)
if err != nil {
+10 -10
View File
@@ -192,7 +192,7 @@ func New(ctx context.Context, m *Manager, skillDir string, dataDir string, keyDi
// Wire DB-stored prompt templates into the agents (new design plan §3.3 / §5a). With no
// override row, agents keep their built-in defaults — behavior is unchanged.
if m.pg != nil {
agent.PromptOverride = func(key string) (string, bool) {
agent.SetPromptOverride(func(key string) (string, bool) {
a, err := m.pg.GetAgentByKey(key)
if err != nil || a == nil {
return "", false
@@ -202,38 +202,38 @@ func New(ctx context.Context, m *Manager, skillDir string, dataDir string, keyDi
return "", false
}
return t, true
}
})
// Wire DB-stored wrap-up (settlement) prompts. Empty column → built-in default.
agent.WrapupOverride = func(key string) (string, bool) {
agent.SetWrapupOverride(func(key string) (string, bool) {
a, err := m.pg.GetAgentByKey(key)
if err != nil || a == nil || a.WrapupPrompt == "" {
return "", false
}
return a.WrapupPrompt, true
}
})
// Wire DB-stored wrap-up turn budgets. 0 / missing → built-in per-agent default.
agent.WrapupMaxTurnsOverride = func(key string) (int, bool) {
agent.SetWrapupMaxTurnsOverride(func(key string) (int, bool) {
a, err := m.pg.GetAgentByKey(key)
if err != nil || a == nil || a.WrapupMaxTurns <= 0 {
return 0, false
}
return a.WrapupMaxTurns, true
}
})
// Wire DB-stored TASK-TIMEOUT wrap-up prompt/turns (worker/planner). Empty/0 → default.
agent.WrapupTaskTimeoutOverride = func(key string) (string, bool) {
agent.SetWrapupTaskTimeoutOverride(func(key string) (string, bool) {
a, err := m.pg.GetAgentByKey(key)
if err != nil || a == nil || a.TaskTimeoutWrapupPrompt == "" {
return "", false
}
return a.TaskTimeoutWrapupPrompt, true
}
agent.WrapupTaskTimeoutTurnsOverride = func(key string) (int, bool) {
})
agent.SetWrapupTaskTimeoutTurnsOverride(func(key string) (int, bool) {
a, err := m.pg.GetAgentByKey(key)
if err != nil || a == nil || a.TaskTimeoutWrapupMaxTurns <= 0 {
return 0, false
}
return a.TaskTimeoutWrapupMaxTurns, true
}
})
wireAgentAugment(m.pg, s.skillDir, s.hostTools) // wire visible skills/MCP + traffic/orchestration host tools into the agent toolset
domainReg := buildDomainReg(m.Assets())
wireTools(m.pg, domainReg) // built-in tools table: filter per agent + override description/schema + inject defaults
+3 -1
View File
@@ -33,7 +33,9 @@ INSERT INTO skill_usage(skill,agent_key,task_id,found) VALUES
t.Fatal(err)
}
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
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)
+3 -1
View File
@@ -21,7 +21,9 @@ func TestTaskCategoryBatchRoute(t *testing.T) {
defer m.Close()
td := t.TempDir()
s := New(context.Background(), m, td, td, td)
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, td, td, td)
defer stopTestServer(t, s, cancel)
h := s.Handler()
token, err := signJWT(s.jwtKey)
if err != nil {
+3 -1
View File
@@ -16,7 +16,9 @@ func TestWorkerControlRoutes(t *testing.T) {
defer m.Close()
td := t.TempDir()
s := New(context.Background(), m, td, td, td)
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, td, td, td)
defer stopTestServer(t, s, cancel)
h := s.Handler()
token, err := signJWT(s.jwtKey)
if err != nil {
+3 -1
View File
@@ -38,7 +38,9 @@ VALUES ($1,'goal','{}','met'), ($1,'goal','{}','open')`, task.ExpID); err != nil
t.Fatal(err)
}
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
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)
+6 -2
View File
@@ -24,7 +24,9 @@ func TestTaskMetadataPatchReturnsRenameAndPin(t *testing.T) {
}
taskID, _ := strconv.ParseInt(task.ID, 10, 64)
defer func() { _ = m.pg.DeleteTask(taskID) }()
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
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)
@@ -66,7 +68,9 @@ func TestConversationBatchDeleteReportsMissing(t *testing.T) {
t.Skipf("postgres unavailable (%v) — skipping", err)
}
defer m.Close()
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, t.TempDir(), t.TempDir(), t.TempDir())
defer stopTestServer(t, s, cancel)
first, err := m.pg.CreateConversation("mainagent", "batch-http-first", nil)
if err != nil {
t.Fatal(err)
+6 -1
View File
@@ -23,6 +23,9 @@ func TestTaskOutcomeCard(t *testing.T) {
}
taskID, _ := strconv.ParseInt(task.ID, 10, 64)
defer func() { _ = m.pg.DeleteTask(taskID) }()
// skill_usage has no foreign keys, so DeleteTask leaves these rows behind,
// and their misses would outrank TestSkillGapsReport's fixture in later runs.
defer func() { _, _ = m.pg.Exec(`DELETE FROM skill_usage WHERE task_id=$1`, taskID) }()
if _, err := m.pg.Exec(`
INSERT INTO findings(task_id,vulnclass,name,severity,status) VALUES
@@ -57,7 +60,9 @@ INSERT INTO skill_usage(skill,task_id,found) VALUES ('api-recon',$1,true),('grap
t.Fatal(err)
}
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
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)
+2 -2
View File
@@ -23,7 +23,7 @@ func TestTaskScopeDescriptionUpgrade(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
cancel()
s := New(ctx, m, t.TempDir(), t.TempDir(), t.TempDir())
t.Cleanup(func() { agent.ToolResolve = nil })
t.Cleanup(func() { agent.SetToolResolve(nil) })
pg := m.pg
var want string
@@ -84,7 +84,7 @@ func TestTaskScopeDescriptionUpgrade(t *testing.T) {
// ToolResolve serves it to the planner.
func resolvedTaskScopeDescription(t *testing.T) string {
t.Helper()
tools := agent.ToolResolve(context.Background(), "planner", agent.NewToolSet(nil, "").PlannerTools())
tools := agent.ToolResolve()(context.Background(), "planner", agent.NewToolSet(nil, "").PlannerTools())
for _, tl := range tools {
if tl.Name() == "add_task_scope" {
return tl.Description()
+6 -2
View File
@@ -20,7 +20,9 @@ func TestTaskTemplateHTTPCRUD(t *testing.T) {
t.Skipf("postgres unavailable (%v) — skipping", err)
}
defer m.Close()
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, t.TempDir(), t.TempDir(), t.TempDir())
defer stopTestServer(t, s, cancel)
h := s.Handler()
token, err := signJWT(s.jwtKey)
if err != nil {
@@ -90,7 +92,9 @@ func TestConversationPatchReturnsPinState(t *testing.T) {
t.Skipf("postgres unavailable (%v) — skipping", err)
}
defer m.Close()
s := New(context.Background(), m, t.TempDir(), t.TempDir(), t.TempDir())
ctx, cancel := context.WithCancel(context.Background())
s := New(ctx, m, t.TempDir(), t.TempDir(), t.TempDir())
defer stopTestServer(t, s, cancel)
conversation, err := m.pg.CreateConversation("mainagent", "pin through http", nil)
if err != nil {
t.Fatal(err)
+27
View File
@@ -0,0 +1,27 @@
package server
import (
"context"
"testing"
"time"
)
// stopTestServer cancels a test server's context and joins what New started.
// New restores every unfinished task in the shared database and runs its
// planner, worker and deadline loops, which write under m.dir. Call it with
// defer right after New, so it runs before m.Close and the TempDir cleanups.
func stopTestServer(t *testing.T, s *Server, cancel context.CancelFunc) {
t.Helper()
cancel()
for _, task := range s.m.List() {
s.engine.BeginDelete(task.ID)
waitCtx, waitCancel := context.WithTimeout(context.Background(), 30*time.Second)
if err := s.waitTaskQuiescent(waitCtx, task.ID); err != nil {
t.Errorf("task %s still running at teardown: %v", task.ID, err)
}
waitCancel()
s.engine.StopTask(task.ID)
}
s.archiveWG.Wait()
<-s.side.done
}
+4 -4
View File
@@ -33,7 +33,7 @@ func TestWireTools(t *testing.T) {
defer pg.Close()
wireTools(pg, nil) // nil domainReg: test only covers filter/decoration, not injection
t.Cleanup(func() { agent.ToolResolve = nil })
t.Cleanup(func() { agent.SetToolResolve(nil) })
// Prevent interactive-shell Bash decoration: if the worker agent has
// interactive_shell=true in the DB, ToolResolve would append a note to
// Bash's description. Disable that for this test so the undecorated
@@ -52,7 +52,7 @@ func TestWireTools(t *testing.T) {
base := append(ts.WorkerTools(), actool.DefaultTools()...)
ctx := context.Background()
worker := names(agent.ToolResolve(ctx, "worker", base))
worker := names(agent.ToolResolve()(ctx, "worker", base))
if _, ok := worker["record_fact"]; !ok {
t.Error("worker lost record_fact")
}
@@ -65,7 +65,7 @@ func TestWireTools(t *testing.T) {
t.Error("Bash should pass through undecorated, but description changed")
}
// planner is not bound to record_fact → resolving a base that contains it drops it.
planner := names(agent.ToolResolve(ctx, "planner", base))
planner := names(agent.ToolResolve()(ctx, "planner", base))
if _, ok := planner["record_fact"]; ok {
t.Error("planner should not get record_fact (not bound)")
}
@@ -85,7 +85,7 @@ func TestWireTools(t *testing.T) {
t.Fatal(err)
}
worker2 := names(agent.ToolResolve(ctx, "worker", base))
worker2 := names(agent.ToolResolve()(ctx, "worker", base))
got := worker2["record_fact"]
if got == nil {
t.Fatal("record_fact missing after edit")
+6 -6
View File
@@ -10,12 +10,12 @@ import { cn } from "@/lib/utils";
// Mock demo: no backend SSE, so stuff in a few sample log lines.
const MOCK_LOGS: LogLine[] = [
{ seq: 1, ts: "2026-07-26T03:55:00Z", level: "info", tag: "engine", text: "ARTEX v0.1.0 backend listening on :8787 (workers=3)" },
{ seq: 2, ts: "2026-07-26T03:55:01Z", level: "info", tag: "config", text: "LLM configured from DB: anthropic / claude-opus-4-8" },
{ seq: 3, ts: "2026-07-26T03:56:10Z", level: "info", tag: "planner", text: "task t-acme-web: planning round 3, generated intent i-4" },
{ seq: 4, ts: "2026-07-26T03:57:00Z", level: "warn", tag: "guard", text: "block bash: target out of bounds, out.evil.example is not in scope" },
{ seq: 5, ts: "2026-07-26T03:57:30Z", level: "info", tag: "work#1", text: "report_finding: Default Credentials (high) saved to database" },
{ seq: 6, ts: "2026-07-26T03:58:20Z", level: "error", tag: "work#3", text: "intercept: mysqldump matched a destructive rule, awaiting manual approval" },
{ seq: 1, ts: "2026-11-14T03:55:00Z", level: "info", tag: "engine", text: "ARTEX v0.6.0 backend listening on :8787 (workers=3)" },
{ seq: 2, ts: "2026-11-14T03:55:01Z", level: "info", tag: "config", text: "LLM configured from DB: anthropic / claude-opus-4-8" },
{ seq: 3, ts: "2026-11-14T03:56:10Z", level: "info", tag: "planner", text: "task t-acme-web: planning round 3, generated intent i-4" },
{ seq: 4, ts: "2026-11-14T03:57:00Z", level: "warn", tag: "guard", text: "block bash: target out of bounds, out.evil.example is not in scope" },
{ seq: 5, ts: "2026-11-14T03:57:30Z", level: "info", tag: "work#1", text: "report_finding: Default Credentials (high) saved to database" },
{ seq: 6, ts: "2026-11-14T03:58:20Z", level: "error", tag: "work#3", text: "intercept: mysqldump matched a destructive rule, awaiting manual approval" },
];
const levelTone: Record<LogLine["level"], string> = {
+355 -351
View File
File diff suppressed because it is too large Load Diff