Repository navigation
Open
Description
Status: DRAFT / RFC — needs refinement before implementation. Captures a direction from the #486 discussion; the design sketch and open questions below are starting points, not decisions.
Motivation
Today Bowire binds to exactly one OAST interaction server: a single Bowire:Oast:Server config value → one InteractshClient session per workbench process (see OastWorkbenchSession, #486). Real use wants several at once:
- a locally-spawned catcher for same-host / dev testing (no DNS delegation needed),
- the org's hosted
oast.bowire.iofor genuine external OOB (Infra: stand up oast.bowire.io — the hosted OAST interaction server (#35 Phase 2f) #485), - a self-hosted or third-party interactsh instance a team already runs.
Two usage variants surfaced in discussion, and we likely want both:
- Connect to a remote / standalone server — already possible via
--oast-server(single). Generalise to several selectable servers. - Spawn + stop LOCAL catcher instances from the workbench UI — start/stop a
bowire oast servecatcher without leaving the UI. There is a direct precedent: the reverse-proxy / mock servers are started/stopped/listed from the workbench viaReverseProxyRegistry+ the tools endpoints (/api/tools/reverse-proxy/*). An OAST instance registry would mirror that.
Design sketch (to refine)
- Config: single
Bowire:Oast:Server→ a named-instance list (e.g.Bowire:Oast:Instances:[]with{ name, url, token }), plus a default. - Registry: an
OastInstanceRegistrysingleton holding N sessions (remote) and N spawned local catchers, modelled onReverseProxyRegistry(lifetime tied to the host; spawned catchers die with the process). - Endpoints:
/api/security/oast/instances(list),.../instancesPOST (add remote / spawn local),.../instances/{id}DELETE (remove / stop), and the existing allocate/poll become per-instance (.../instances/{id}/allocate|poll). - UI: an instance picker in the OAST panel; "spawn local catcher" + "add remote server" actions; per-instance payload list + live feed.
- Scanner:
--oast-serverstays the single-instance shortcut; the workbench selects an active instance for manual work.
Constraints / gotchas
- A locally-spawned catcher only catches callbacks that reach it — same-host / dev only. External OOB (a real target calling back) still needs a DNS-delegated server (Infra: stand up oast.bowire.io — the hosted OAST interaction server (#35 Phase 2f) #485). The UI must say this plainly so a local catcher isn't mistaken for real external coverage.
- Ports 53/80 for a local catcher: privilege + conflict (systemd-resolved holds :53 on Linux). A local catcher may need high ports and only work for loopback tests.
- Session lifetime / idle eviction is per-instance; the Security rail: manual OAST/pen-test surface — generate a callback payload + watch interactions live #486 self-heal (re-register on 401) must hold per session.
- Auth (
--oast-token) is per-instance.
Open questions (the "needs refinement" part)
- Per-workspace instances vs one global set?
- Persist configured instances across restarts, or session-only like today?
- Default-instance selection + what the scanner uses when several exist.
- Does this same instance surface double as a rail-agnostic OOB inspector (requestbin / webhook.site style)? OAST's primitive is cross-cutting (it lives in the neutral
Kuestenlogik.Bowire.Oastpackage, likeBowire.Telemetry/Bowire.Map), so a non-security use — egress/firewall testing, webhook debugging, DNS-resolver testing — could share the registry + feed. If so, the endpoints may belong at/api/oast/*(not/api/security/oast/*) with the security rail merely embedding the panel via the__bowireOastglobal seam.
Related
- Infra: stand up oast.bowire.io — the hosted OAST interaction server (#35 Phase 2f) #485 — stand up the hosted
oast.bowire.io(one such remote instance). - Security rail: manual OAST/pen-test surface — generate a callback payload + watch interactions live #486 — the single-instance manual panel (shipped).
- Nuclei template compat — OAST + non-HTTP transports (Phase 2f + 2g) #35 — OAST (Phase 2f).
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
- StatusShow more project fieldsBacklog
Activity