Skip to content

connectors.md

Latest commit

 

History

History
40 lines (34 loc) · 1.37 KB

connectors.md

File metadata and controls

40 lines (34 loc) · 1.37 KB
Raw

Connectors (push results out)

What: deliver a finished Report to an external destination. A connector is an outbound adapter — one interface, many targets. Where: internal/connector/.

How it works

flowchart TD
    R["Report"] --> D["connector.Dispatch(ctx, report, conns…)"]
    D --> C1["Webhook → POST full JSON"]
    D --> C2["Slack → summary + findings"]
    D --> C3["SARIF-file → write .sarif (CI artifact)"]
    C1 --> R1{"2xx?"}
    C2 --> R2{"2xx?"}
    R1 -- no --> E["collect error (others still run)"]
    R2 -- no --> E
    C3 --> OK["written"]
Loading

The contract

type Connector interface {
    Name() string
    Send(ctx context.Context, r *engine.Report) error
}

Dispatch sends to every configured connector and collects errors so one failing destination never stops the others. Adding Jira / SIEM / MCP is a new file implementing this interface — nothing else changes.

Try it

dsecrat scan --sarif-out report.sarif  <target>   # CI artifact / code scanning
dsecrat scan --webhook https://ci/hook <target>   # POST full JSON report
dsecrat scan --slack   https://hooks.slack.com/…  <target>

Flags compose: one scan can print a table, write SARIF, and notify Slack at once.

Status: webhook, Slack, and SARIF-file connectors built + tested (httptest + tempfile). Jira/SIEM/MCP are planned in the platform phase.