mirror of
https://github.com/norandom/OpenUltraSAST.git
synced 2026-10-18 12:39:28 +00:00
contributor-scan 2.5. VAmPI's `host='0.0.0.0'` is now reported exactly once, at app.py:17:<module>. Before task 2.2 it was reported eight times in eight files that do not contain it; after 2.2 it was reported nowhere. Two causes, one shape: nothing could ask about module-level code. **The main-guard marker is not a function.** `__main__` is what the mapper emits for `if __name__ == '__main__':`. Sent to the engine as a function name it matched nothing, because a CPG calls a file's top-level code `<module>` -- verified against the VAmPI CPG rather than assumed. The region model translates the marker, which is the one place that turns what the mapper meant into what the scanner asks. **A function-scoped file had no region for its module body.** Settings, route registration and globals live in no function, and every region's query filters by function name. A file-level region beside the handlers would report each handler's findings a second time, which is why the earlier rule dropped it as "a second full-file pass". A module-scope region PARTITIONS the file instead of overlapping it. That only became cheap after batching: before it, a region was a JVM. Two things this needed to be correct rather than merely present: - A module method spans its whole file, so the taint query's line-range containment made `<module>` the parent of every function in it. Under module scope, membership is direct -- otherwise the module region reports every handler's sinks again, which is the duplication the old rule was avoiding. - A module body is not a handler. The marker-derived region inherited the handler families and entailed a missing authorization check on the main guard: a finding with no possible remediation. Caught by the first repository run that had the region, and now covered by a test. bind address 8 wrong files -> 0 -> 1, at app.py:17:<module> regions 22 -> 25 entailed 8 -> 9 query time 37.4s -> 41.3s peak RSS 827MB -> 823MB cost $0.0067 -> $0.0068 Three more regions for four seconds and no more model calls: the budget is a total and was already spent, so regions_unasked rose 17 -> 20 -- those regions got the free pass and are reported as unasked, not as clean. `<module>` is Joern's Python name for a module body; JavaScript uses `:program`, so this is verified for Python only. Gates byte-identical. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]> Claude-Session: https://claude.ai/code/session_01T7XD7x5KonMdmGRkp63EQG
16 KiB
16 KiB
Implementation Plan: contributor-scan
Guidance for the implementing agent
- The predecessor's lesson, in one line. Five bugs in
model-grounded-detectionshared one shape: a taint-specific assumption applied to every family, each caught by a measurement rather than a check. Before you finish any change to a routing rule, a matching rule, or a per-family question, grep for its siblings and fix them in the same commit. The most expensive instance cost a 19-minute run that returned an identical number, and only the identity revealed the bug. - Run the whole CI list before pushing, not the parts you remember:
ruff format --check .,ruff check .,mypy src/openultrasast,pytest, the three gates,compileall src tests, andpytest -m semantic. CI was red for most of a session becauseruff checkpassing was taken as evidence thatruff format --checkwould. - The gate baseline is the safety net.
benchmarks/measurements/2026-09-06-gate-baseline.txt. Run all three gates before and after every task. The model layer is additive: if a gate moves, you changed something that was never meant to change. - RED first, one commit per task, selective
git add. - Zero-dependency core. Copy the capability-probe pattern in
semantic/extra.pyandcpg/capability.py. - Do not modify
model/pipeline,taint,dominance,config_value,specsorcandidates. They are built and measured. If a change looks necessary, it belongs in its own commit with its own measurement.
Group 1 — Wire it (gate-protected)
-
1.1 Regions from entry points
model/regions.py:ScanRegion(path, function, families, rank, source)andregions_for(entries, targets, *, taxonomy, language_of). Rank from whatEntryPointRecordalready carries (access_level,trust_boundary) — do not invent a new signal. File-level fallback when a target has no entry point, withsource="file_fallback". Families from region shape and language, via the existingtaint_specs/dominance_specs/config_specs.- Sibling audit (Req 8.5): family routing now exists in three places —
ceiling.py's harness,pipeline._arbitrate, and here. Check all three agree before finishing. - Observable: a region is produced per entry point; a target with no entry point yields a file region marked as such; no region carries a family whose spec is absent for its language.
- Requirements: 2.1, 2.2, 2.3, 2.4, 8.5
-
1.2 The repository driver
model/scan.py:ScanBudget,ModelScanResult,scan_repository(...). One CPG per run, reused across regions. Regions in rank order; budget decremented per model call and checked before each; the remainder counted intoregions_unjudged. Findings ordered by rung, then rank.- Observable: one
backend.buildcall for many regions; a budget of N yields at most N model calls and a non-zeroregions_unjudged; ordering putsmodel_entailedabovesuspicion; a failed CPG build yields an empty result withcpg_build_failed, never an exception. - Redaction (Req 8.3) is inherited from
model/pipeline, which redacts every prompt; a test asserts the driver adds no unredacted path of its own. - Requirements: 3.1, 3.2, 3.3, 3.4, 3.5, 8.3
- Depends: 1.1
-
1.3 The MAP stage
- Wire
scan_repositoryintocli.pyinsideStage.MAP, mirroring_check_obligations: takesentry_pointsandtargets, returns findings merged additively beside the pattern, overlay and obligation findings. A[model]config block (enabled, budget, max regions), zero-dep, conservative defaults. Payload into the manifest withby_rung, cost and elapsed. - Observable: a scan on a repo with Joern present reports findings carrying rungs; the same scan with
OPENULTRASAST_JOERN_PROBE=offis identical to today's output plus acpg_unavailabledegradation; the three gates are byte-identical. - The
[model]block is capability-detected like every other optional plane (Req 8.4): core staysdependencies = [], and the engine, endpoint and execution tier each degrade to a recorded reason. - Requirements: 1.1, 1.2, 1.3, 1.4, 1.5, 8.4
- Depends: 1.2
- Wire
-
1.4 Batch the queries — one Joern invocation per scan, not one per region and family
- Why this is in group 1 rather than group 2. Wiring 1.3 exposed that the cost model in the design was
half right. One CPG per scan was the right call, but every query is its own
joern --scriptJVM launch of roughly 30 seconds, and the driver issues one per region per family. A single ten-line Python file admits six families and therefore takes six launches and over three minutes. At 100 regions that is ~5 hours; at 1000, ~50. Task 2.2's go/no-go would not have been a measurement, only arithmetic. - Extend
cpg/backend.pywith a batched call: one invocation carrying many (region, family, spec) requests and returning rows keyed back to each. The.scscripts already take parameter lists; they take a list of requests instead.model/scan.pycollects the work first, issues one call, then arbitrates from the rows. - Keep the seam. The subprocess boundary stays the only Joern touch-point (predecessor Req 4.5). Server mode would keep a JVM warm but adds a process model and weakens that promise; batching needs neither.
- The arbiters do not change.
taint,dominance,config_valueandpipelinetake rows and are already measured; if this task needs to edit one, that is a signal the batching is leaking into them. - Observable: a scan over N regions issues one
joern --scriptinvocation, not N×families; the same fixture produces the same findings and rungs as the unbatched path, asserted against a recorded baseline; the ten-line scan drops from minutes to seconds. - Requirements: 3.5, 4.2, 4.3
- Depends: 1.3
- Why this is in group 1 rather than group 2. Wiring 1.3 exposed that the cost model in the design was
half right. One CPG per scan was the right call, but every query is its own
Group 2 — Scale it (the phase that can reshape the rest)
-
2.1 A pinned known-vulnerable checkout
benchmarks/repos/<name>.toml: url, commit, the known CVE, the file and function it lives in, licence. Start with one small enough to iterate on. Fetch is explicit and offline-by-default, like the pointer pairs.- Observable: the recipe resolves to a checkout; CI never fetches it.
- Requirements: 4.1
- Depends: 1.3
-
2.2 The first repository measurement
- Run the full scan against that checkout and commit the artifact: CPG build time, query time and total
scan wall-clock as three separate numbers, peak memory, findings by rung, cost,
regions_unjudged, and whether the known CVE was found and at which rung. The build/query split is separated because 2.3 is decided on that ratio and cannot be decided on a single wall-clock figure. If the repository cannot be processed in its envelope, record the stage it failed at. - This is the go/no-go for the shape of the rest: if one CPG per repository is infeasible, the region and budget design changes and phases 3–6 should not be built on it first.
- Observable: the artifact exists with every field; the reading states go or no-go and why.
- Requirements: 4.2, 4.3, 4.4, 4.5
- Depends: 2.1
- Run the full scan against that checkout and commit the artifact: CPG build time, query time and total
scan wall-clock as three separate numbers, peak memory, findings by rung, cost,
-
2.3 Decide on Joern server mode, on 2.2's numbers
- Joern offers
--serverwith--server-host,--server-portand basic auth: one warm JVM with the CPG loaded once, and queries in milliseconds after that. It would remove the three-to-four JVM starts (~100s) that remain per scan now that 1.4 has batched the queries. - Deliberately sequenced after the measurement, because deciding it now would be optimising before measuring. Batching already moved query cost from O(regions) to O(1) per scan; whether the remaining floor matters is a ratio 2.2 produces and nothing before it does. If a real CPG build takes ten minutes, a 100s query floor is noise and server mode buys nothing. If the build is thirty seconds, the floor is 3x the build and server mode is the obvious next move.
- Costs to weigh against that ratio: process lifecycle (start, health, shutdown, orphan reaping -- stray
JVMs had to be killed by hand twice while building the batching); the seam weakening from "the subprocess
is the only Joern touch-point" to "subprocess or HTTP client", which is the promise that has kept the
backend replaceable; and that a CPGQL endpoint evaluates Scala, so it is arbitrary code execution on the
analysis host -- acceptable inside the shipped container, which runs
network_mode: none, and much less so as a port listening on a contributor's laptop. - Observable: a recorded decision that cites 2.2's build-time-to-query-time split. A preference does not close this task; a ratio does.
- Requirements: 4.2
- Depends: 2.2
- Joern offers
-
2.4 A region that spans the flow, not just a function
- 2.2's finding, and the one that reshapes the phase. VAmPI-SQLI is a request parameter reaching
get_by_username(username), passed toUser.get_user(username)in another module, interpolated into a query and executed. Source and sink are in different functions, regions are per-function, and a repository scan does not treat parameters as untrusted -- so neither region sees both ends and the engine is silent on the most ordinary shape a real injection bug has. - The CPG already has the call graph;
reachableByFlowsis not function-bounded. What is bounded is the QUESTION the driver asks. So the work is in the region model and the query scope, not in the arbiter: a region should be able to name an entry point and admit sinks reachable from it, with the file scope from 2.2 kept so the answer is still attributable. - Watch the cost: an unbounded interprocedural question over a large repository is how this gets slow again. Measure it on vampi first, then on the envelope checkout.
- Observable: VAmPI-SQLI entailed or corroborated at
models/user_model.py:get_user, with the scan's wall-clock and the entailed-finding count recorded against 2.2's numbers. - Requirements: 4.4, 8.1
- Depends: 2.2
- 2.2's finding, and the one that reshapes the phase. VAmPI-SQLI is a request parameter reaching
-
2.5 Module-level regions the engine can actually ask about
- A setting in
if __name__ == '__main__':belongs to a region the mapper callsapp.py:__main__, but Joern names that method<module>. The function filter matches nothing, so module-level configuration is invisible. Before 2.2's file scoping it was worse, not better: the literal was reported eight times in eight files that do not contain it. - Observable:
app.py:17'shost='0.0.0.0'reported exactly once, at that location. - Requirements: 4.4
- Depends: 2.2
- A setting in
-
2.6 Access control that does not entail every public endpoint
- 7 of 9 VAmPI handlers were entailed, including
register_userandget_all_users, which are meant to be unauthenticated. The dominance rule -- unguarded, with guarded siblings -- was calibrated on pairs where a guarded twin always existed. At repository scale every public endpoint has guarded siblings. - This is a precision question and needs a precision measurement: on a real repository, what fraction of entailed access-control findings are endpoints that genuinely require authorisation? Do not tune it against VAmPI alone; that is how the +16% overfitting gap in Req 8 happened.
- Observable: a recorded precision figure before and after, on more than one checkout.
- Requirements: 8.1, 8.2
- Depends: 2.2
- 7 of 9 VAmPI handlers were entailed, including
-
2.7 A dominance witness that names its line
- Access-control sites read
api_views/users.py:?:update_password. Taint and config witnesses carry(line N); dominance does not, so its findings have no line and a contributor cannot open them. - Observable: every entailed finding in a repository scan has an integer line.
- Requirements: 5.1
- Depends: 2.2
- Access-control sites read
Group 3 — Ship it
-
3.1 Contributor output
model/report.py: a scan summary — counts per rung, the top findings with witness andpath:line, and a plain statement of whatsuspicionmeans (the model could not confirm it). Findings to the writable output only.- Observable: a scan produces a summary readable without opening JSON; every finding shows rung, witness and location; nothing is written into the analysed tree.
- Keeps the disciplines already built into
model/report.py(Req 8.1, 8.2): per-slice rows with the real-world slice deciding, a refused bare aggregate, and the overfitting gap published beside any headline — absent rather than zero when a slice is missing. - Requirements: 5.1, 5.2, 5.3, 5.4, 8.1, 8.2
- Depends: 1.3
-
3.2 Build and verify the image
docker compose build, then run a real scan through it and through the shell wrapper. The Dockerfile and compose exist and are syntax-valid; the image has never been built, so nothing about it is proven.- Observable: the image builds;
TARGET=<repo> docker compose run --rm ousast scan /targetproduces the same findings as a native run; the target mount is read-only; the network is off by default. - Requirements: 6.1, 6.2, 6.3, 6.4, 6.5
- Depends: 3.1
Group 4 — Close the deferred decisions
-
4.1 The memory-family decision
- Either reach
memorythrough an adopted execution tier, or record explicitly that C memory-safety is out of scope. 173 of the 176 real-world CVE pairs sit idle behind a stub; the decision gates Req 9.2. - Observable: the decision and its reason are recorded where a later reader finds them; if out of scope, the corpus says so per slice.
- Requirements: 7.1, 7.3
- Either reach
-
4.2 Retire
evidence_level- It duplicates
rungin intent. Retire it, or record why both are kept. Note the legacy valuestatic_corroborationcomes from the flat-IR overlay, which Req 4.4 of the predecessor demotes to the suspicion band — so a straight rename would overstate it. - Observable: one vocabulary, or a recorded reason for two; SARIF and JSON consumers considered.
- Requirements: 7.2, 7.3
- It duplicates
Group 5 — Grow the corpus
-
5.1 PHP/WordPress slice
- Plugin and core weaknesses.
php2cpgneeds a PHP interpreter, which the image provides. Validate on a sample that the model can read the pairs before vendoring — the OWASP harvest found 238 and vendored 40 for exactly this reason. - Observable: a sample measurement precedes vendoring; only categories the model can arbitrate are vendored; the slice reports as its own row; every pair states a licence.
- Requirements: 9.1, 9.4, 9.5, 9.6, 9.7
- Depends: 3.2
- Plugin and core weaknesses.
-
5.2 More vibe-code pairs
- The slice where the stated audience works, currently 35 pairs. Same read-check discipline.
- Requirements: 9.3, 9.4, 9.5, 9.6, 9.7
-
5.3 Real-world C library CVEs
- libpng and the image libraries, OpenSSH, libpam, kernel modules. Gated on 4.1: until the memory decision closes these would join 173 idle pairs.
- Requirements: 9.2, 9.4, 9.5, 9.6
- Depends: 4.1
Group 6 — Regression baselines
- 6.1 Repository baseline and delta
- A committed baseline per pinned checkout; a delta report on fact-table or query changes showing findings gained, lost and rung movements. An unexplained loss of a previously-entailed finding is a regression to investigate, not a number to accept. The baseline records the engine version, because a CPG engine change moves every verdict.
- Requirements: 10.1, 10.2, 10.3, 10.4
- Depends: 2.2
Task-plan review notes
- Group 1 must land and pass review before group 2: measuring an unwired pipeline is what produced a session's worth of harness-only numbers.
- Task 1.4 was added after 1.3 was wired, when a ten-line scan took three minutes. It belongs in group 1 because group 1's promise is a working scan, and a scan that cannot finish on a real repository is not one. Finding it here rather than in 2.2 is the argument for wiring before measuring.
- Task 2.2 is a go/no-go. If one CPG per repository is infeasible, stop and redesign the region/budget model rather than building groups 3–6 on an assumption.
- Group 5 is deliberately last. The corpus is not the binding constraint today — reachability is — and 198 of 238 OWASP pairs were left unvendored precisely because volume without readability makes every number worse.