draugr

module
v0.125.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2026 License: Apache-2.0

README

Draugr

Run Trivy, Semgrep, Gitleaks and more from one file. Get one SARIF report and one verdict.

CI OpenSSF Scorecard OpenSSF Best Practices Latest release License

Describe your app. Draugr figures out the rest.

Every application carries problems nobody put there on purpose: a library that turned out to have a hole in it, a password committed by accident, a server setting that leaves a door open. Draugr finds them, works out which ones actually matter for your app, and answers the question you are really asking before a release. is this safe to ship?

It runs the established open-source scanners for you, Trivy, Semgrep, Gitleaks and others, so there is nothing to choose between, wire up, or read five of. You describe what you built, once, in one file: where the repositories are, what images it builds, what it exposes, what infrastructure it runs on. Draugr picks the checks that apply, runs the right tool for each, and produces evidence you can hand to somebody else. Bring the scanners you already pay for, or use the open-source defaults.

Findings are ranked, not listed. A scanner's "critical" describes a flaw in the abstract. How bad it could be at its worst, anywhere. The same flaw is act-now in the service strangers can reach and backlog in the internal tool three people use, and no scanner can tell those apart because the difference is in the file you wrote, not in the code. And draugr diff gates a pull request on new findings only, so inheriting two hundred existing ones does not block every change.

Quickstart · See it in action · What it checks · In your pipeline · Documentation · What Draugr doesn't promise · Security

See it in action

Priority (P1–P4) is not severity. Severity says how bad a flaw is at its worst, anywhere. Priority weighs that against how exposed and how important the part of your app it sits in is, which no scanner can work out, because it is not in the code.

draugr-dev/draugr-demo is a deliberately vulnerable app wired to Draugr: every control lights up, findings land in the repo's Security → Code scanning tab, and its example pull requests show the new-vs-fixed diff.

Quickstart

curl -fsSL https://draugr.dev/install.sh | sh

Installs to ~/.local/bin, no sudo. It verifies before it installs and says which checks ran, the archive's SHA-256 against the release checksums.txt, plus the cosign signature on that file when cosign is on your PATH, and installs nothing if a check fails. The script is readable in the repo; other routes, including Homebrew and go install, are in the install guide.

draugr tools install     # fetch the scanners, pinned and verified
draugr scan .            # scan this repo with sensible defaults
draugr init              # or scaffold a draugr.saga.yaml to customize

Then describe what you actually ship:

project: my-app
release:
  version: "1.0"
config:
  controls:
    images:
      enabled: true
components:
  - name: web
    images:
      - image: alpine:3.19
draugr scan draugr.saga.yaml            # console summary; exits non-zero on fail
draugr scan draugr.saga.yaml -o out/    # also writes report.json + results.sarif
draugr scan draugr.saga.yaml --format markdown   # or html, junit, json, sarif

Your editor already knows this file. Draugr's JSON Schema is registered with SchemaStore, so any *.saga.yaml gets completion, hover docs and typo warnings on open with nothing to configure.

Or let discovery write the descriptor for you:

draugr survey github repos --org my-org -o draugr.saga.yaml
draugr survey k8s images --namespace prod -o draugr.saga.yaml

Full walkthrough: quickstart.

What it checks

Eleven controls, each backed by a tool Draugr executes rather than bundles, so every scanner stays under its own license, and you can swap it.

Control Looks for By default
sca known flaws in the libraries you depend on Trivy, Grype and Mend opt-in
secrets passwords and keys committed by accident, history included Gitleaks
sast patterns in the code you wrote that let somebody in Semgrep, gosec opt-in for Go
iac settings that leave a door open, in Terraform, Kubernetes and Dockerfiles Trivy
images what is baked into your container images Trivy, Grype opt-in
licenses terms attached to code you did not write Trivy
dast problems only visible from outside a running app Nuclei, authenticated, and from an OpenAPI spec
headers how your site answers a browser native
tls certificates and encryption native
infrastructure your Kubernetes cluster, against the CIS benchmarks native, kube-bench opt-in
threats whether anything you talk to is on a public blocklist abuse.ch URLhaus

Every scanner, what it sends and whose terms it carries: integrations catalog.

Alongside them: content-hash caching, an SBOM per repository and image, KEV/EPSS enrichment, per-control gate thresholds, and suppressions that stay in the report with the reason someone gave rather than disappearing.

In your pipeline

The first-party GitHub Action installs Draugr, provisions the scanners, and hands the merged SARIF to code scanning, one clean Draugr tool in the Security tab:

permissions:
  contents: read
  security-events: write

steps:
  - uses: actions/checkout@v4
  - id: draugr
    uses: draugr-dev/draugr@v0     # pin @vX.Y.Z for reproducible CI
    with:
      saga: draugr.saga.yaml
      tools: true                  # provision the scanners the controls need
  - if: always()                   # publish findings even when the gate fails
    uses: github/codeql-action/upload-sarif@v3
    with:
      sarif_file: ${{ steps.draugr.outputs.sarif }}

GitHub Actions · GitLab, an include, GitLab's own report formats, a sticky merge-request comment · Azure Pipelines, a step template

From an AI coding assistant. Ask one to check a change and it will, using whatever scanner it finds over a scope it chose. draugr mcp serves Draugr over the Model Context Protocol so it reads your committed descriptor instead, and scanning is off by default, because it clones repositories and runs external tools.

claude mcp add draugr -- draugr mcp

See use Draugr from an AI coding assistant.

Documentation

Documentation index →

What Draugr doesn't promise

A passing verdict means the controls you configured found nothing they were looking for. It is not a statement that your software is secure. It is silent about anything your descriptor does not declare, controls you did not enable, and whatever the underlying scanners miss. License findings are information, not legal advice. Draugr is provided under Apache-2.0 without warranty.

The details, including whose terms the scanners carry and your responsibility for authorization when scanning live endpoints: scope and disclaimer.

Security & supply chain

A security tool should hold itself to what it checks. Draugr does:

  • Standard output. Every finding is normalized to SARIF 2.1.0 (OASIS), so results flow into GitHub / GitLab / Azure DevOps code scanning and any SARIF-aware tool.

  • Signed releases + provenance, release archives' checksums.txt is keyless-signed with cosign (Sigstore) into a checksums.txt.sigstore.json bundle, and each release publishes SLSA build-provenance attestations (gh attestation verify …); verify before installing (recipe).

  • SBOMs. A Syft SBOM is published for every release archive.

  • Verified tooling, draugr tools install fetches scanners pinned by SHA-256 and, where the upstream signs them, verifies the cosign signature too, and cosign itself is installable, so verification is self-sufficient.

  • We scan ourselves. Draugr runs on its own repo every PR (dogfood self-scan), and we track our supply-chain posture with the OpenSSF Scorecard (badge above).

    That card reports SAST: 0, and it is worth saying why we are leaving it there. Static analysis does run on this repository: Semgrep and gosec through Draugr's own sast control on every scan, and gosec again inside golangci-lint on every pull request. Scorecard looks for a specific set of tools it recognizes, and ours are not in it.

    Adding a third static analyzer purely to move the number would be the same thing as writing tests that touch code without asserting anything, a metric improved without the property behind it improving. We would rather the score be wrong and the analysis be real. If you want to check the analysis rather than the score, the findings are in the repository's Security tab, uploaded by the scan itself.

  • Report a vulnerability. See SECURITY.md.

Development

Requires Go 1.26+. make build builds ./bin/draugr; make gate runs the full local gate, fmt, vet, lint, race tests with coverage, and govulncheck. See CONTRIBUTING.md.

License

Draugr is licensed under the Apache License 2.0.

Directories

Path Synopsis
cmd
draugr command
Command draugr is the Draugr CLI: developer-first, descriptor-driven security and compliance qualification.
Command draugr is the Draugr CLI: developer-first, descriptor-driven security and compliance qualification.
internal
builtins
Package builtins assembles the default registry of controllers and scanners that ship with Draugr.
Package builtins assembles the default registry of controllers and scanners that ship with Draugr.
ciguard
Package ciguard holds assertions about this repository's own CI configuration.
Package ciguard holds assertions about this repository's own CI configuration.
cli
Package cli assembles the Draugr command-line interface on top of Cobra.
Package cli assembles the Draugr command-line interface on top of Cobra.
controllers
Package controllers holds Draugr's built-in controllers (e.g.
Package controllers holds Draugr's built-in controllers (e.g.
feeds
Package feeds fetches and caches the exploitability datasets Draugr can enrich findings with: CISA's Known Exploited Vulnerabilities catalog and FIRST's EPSS scores.
Package feeds fetches and caches the exploitability datasets Draugr can enrich findings with: CISA's Known Exploited Vulnerabilities catalog and FIRST's EPSS scores.
git
Package git provides repository checkouts for scanners that operate on source trees.
Package git provides repository checkouts for scanners that operate on source trees.
mcp
Package mcp exposes Draugr to AI coding agents over the Model Context Protocol.
Package mcp exposes Draugr to AI coding agents over the Model Context Protocol.
mendapi
Package mendapi is the client for Mend's v1.3 API: the half of a Mend scan that returns findings.
Package mendapi is the client for Mend's v1.3 API: the half of a Mend scan that returns findings.
netpolicy
Package netpolicy holds one answer to one question: may this process reach the network?
Package netpolicy holds one answer to one question: may this process reach the network?
observability
Package observability provides Draugr's logging and telemetry foundations: structured logging via log/slog and distributed tracing via OpenTelemetry.
Package observability provides Draugr's logging and telemetry foundations: structured logging via log/slog and distributed tracing via OpenTelemetry.
sagafetch
Package sagafetch fetches Saga fragments held in other repositories.
Package sagafetch fetches Saga fragments held in other repositories.
sbom
Package sbom generates Software Bills of Materials by shelling out to Syft.
Package sbom generates Software Bills of Materials by shelling out to Syft.
scanners
Package scanners holds Draugr's built-in scanners, which wrap individual security tools and normalize their output to SARIF.
Package scanners holds Draugr's built-in scanners, which wrap individual security tools and normalize their output to SARIF.
scanpolicy
Package scanpolicy holds the scoring choices a scan makes, so every entry point into Draugr makes the same ones.
Package scanpolicy holds the scoring choices a scan makes, so every entry point into Draugr makes the same ones.
schemagen
Package schemagen keeps the Saga JSON Schema's knowledge of controls in step with the registry that actually answers for them.
Package schemagen keeps the Saga JSON Schema's knowledge of controls in step with the registry that actually answers for them.
schemagen/gen command
Command gen rewrites the Saga JSON Schema's generated sections from the plugin registry.
Command gen rewrites the Saga JSON Schema's generated sections from the plugin registry.
selfupdate
Package selfupdate updates the running draugr binary to a released version.
Package selfupdate updates the running draugr binary to a released version.
surfaces
Package surfaces maps what a descriptor declares to the controls that look at it.
Package surfaces maps what a descriptor declares to the controls that look at it.
surveyors
Package surveyors holds Draugr's built-in surveyors.
Package surveyors holds Draugr's built-in surveyors.
toolexec
Package toolexec runs the external tools Draugr orchestrates, and reports what it ran.
Package toolexec runs the external tools Draugr orchestrates, and reports what it ran.
tools
Package tools describes the external command-line scanners Draugr orchestrates and detects whether they are installed.
Package tools describes the external command-line scanners Draugr orchestrates and detects whether they are installed.
tools/cmd/pinbump command
Command pinbump moves one pinned scanner to a new version and records what that version hashes to.
Command pinbump moves one pinned scanner to a new version and records what that version hashes to.
version
Package version carries build metadata, injected at link time via -ldflags.
Package version carries build metadata, injected at link time via -ldflags.
vexload
Package vexload resolves the VEX sources a descriptor names into documents a run can apply.
Package vexload resolves the VEX sources a descriptor names into documents a run can apply.
pkg
cache
Package cache stores scan results keyed by content hash so unchanged targets are not re-scanned.
Package cache stores scan results keyed by content hash so unchanged targets are not re-scanned.
ci
Package ci reports the continuous-integration job a scan is running in.
Package ci reports the continuous-integration job a scan is running in.
config
Package config is Draugr's machine- and organization-level configuration, kept apart from the Saga on purpose.
Package config is Draugr's machine- and organization-level configuration, kept apart from the Saga on purpose.
diff
Package diff compares two Draugr scan results and classifies every finding as new, fixed, or unchanged, the security delta of a change (typically a PR's head vs the base branch).
Package diff compares two Draugr scan results and classifies every finding as new, fixed, or unchanged, the security delta of a change (typically a PR's head vs the base branch).
engine
Package engine orchestrates a run: it expands a Saga into scan jobs (controllers × components), executes them with bounded parallelism, and aggregates each control's results.
Package engine orchestrates a run: it expands a Saga into scan jobs (controllers × components), executes them with bounded parallelism, and aggregates each control's results.
exploit
Package exploit enriches a finding's severity with real-world exploitability signals: CISA KEV (Known Exploited Vulnerabilities, confirmed exploited in the wild) and FIRST EPSS (Exploit Prediction Scoring System, probability of exploitation).
Package exploit enriches a finding's severity with real-world exploitability signals: CISA KEV (Known Exploited Vulnerabilities, confirmed exploited in the wild) and FIRST EPSS (Exploit Prediction Scoring System, probability of exploitation).
norn
Package norn evaluates scan results against policy to produce a verdict (pass/fail) per control and overall.
Package norn evaluates scan results against policy to produce a verdict (pass/fail) per control and overall.
plugin
Package plugin is the Draugr plugin SDK.
Package plugin is the Draugr plugin SDK.
prioritization
Package prioritization turns a finding's severity and its component's risk classification (exposure × business criticality) into a single Priority band.
Package prioritization turns a finding's severity and its component's risk classification (exposure × business criticality) into a single Priority band.
publish
Package publish delivers rendered reports (report.Artifact) to destinations.
Package publish delivers rendered reports (report.Artifact) to destinations.
report
Package report renders a scan result in a chosen format.
Package report renders a scan result in a chosen format.
saga
Package saga defines the Draugr descriptor ("Saga"), the declarative account of an application's security surface (repositories, images, hosts, infrastructure) plus the controller configuration that drives a scan.
Package saga defines the Draugr descriptor ("Saga"), the declarative account of an application's security surface (repositories, images, hosts, infrastructure) plus the controller configuration that drives a scan.
sarif
Package sarif provides Draugr's result currency: a pragmatic model of SARIF 2.1.0 findings, plus merge and deduplication.
Package sarif provides Draugr's result currency: a pragmatic model of SARIF 2.1.0 findings, plus merge and deduplication.
sbom
Package sbom is the Software Bill of Materials surface: the document type a run produces and the contract for producing one.
Package sbom is the Software Bill of Materials surface: the document type a run produces and the contract for producing one.
skald
Package skald renders scan results and verdicts into evidence: a JSON summary and merged SARIF.
Package skald renders scan results and verdicts into evidence: a JSON summary and merged SARIF.
surveyor
Package surveyor is the discovery framework: plugins that inspect an environment and return Saga fragments, which are merged so the descriptor can write itself.
Package surveyor is the discovery framework: plugins that inspect an environment and return Saga fragments, which are merged so the descriptor can write itself.
tooladapter
Package tooladapter turns an external command-line security tool into a Draugr Scanner declaratively: describe how to build the command for a target, and the adapter runs it and parses its SARIF output.
Package tooladapter turns an external command-line security tool into a Draugr Scanner declaratively: describe how to build the command for a target, and the adapter runs it and parses its SARIF output.
tui
Package tui holds the terminal-presentation rules Draugr applies everywhere it writes for a person: when color is allowed, what the colors mean, and how to link to more detail.
Package tui holds the terminal-presentation rules Draugr applies everywhere it writes for a person: when color is allowed, what the colors mean, and how to link to more detail.
vex
Package vex reads OpenVEX documents somebody else wrote.
Package vex reads OpenVEX documents somebody else wrote.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL