bomly-plugin-govulncheck-analyzer

module
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Oct 25, 2026 License: Apache-2.0

README

bomly-plugin-govulncheck-analyzer

Go reachability analyzer for Bomly.

It runs govulncheck (as a library) over each Go module in the scan and annotates the vulnerabilities Bomly already found with reachability data: whether a vulnerable symbol is actually called from your code (symbol tier) and whether the vulnerable package is imported (package tier). Results are cached on disk under <user cache dir>/bomly/analyzers/govulncheck/ (24h TTL), keyed by lockfile fingerprint and Go toolchain version.

Safety note: "unreachable" at any tier means the analysis found no path, not that the vulnerability is safe to ignore. Use reachability to prioritize, not to dismiss.

Coverage

  • Ecosystem: Go (go.mod modules)
  • Tiers: symbol, package
  • Requires: a Go toolchain on PATH. The analyzer declares the pipeline data it needs -- a source tree, a dependency graph, and vulnerability records from a matcher -- so Bomly skips it, with a warning, when a scan cannot supply them.

Access

bomly-plugin.json declares what the analyzer touches, which Bomly shows before you enable it. It is a disclosure, not a sandbox.

Access Why
Reads project Go source and go.mod/go.sum of each module scanned
Reads and writes cache The result cache, and the Go build cache the toolchain uses
Reads and writes home The Go module cache (GOMODCACHE, ~/go/pkg/mod by default)
Writes temp Scratch space for the Go toolchain's package loading
Network vuln.go.dev The Go vulnerability database govulncheck reads
Network * The go command may download missing modules from whatever GOPROXY names
Environment GO*, HOME, PATH, XDG_CACHE_HOME, LocalAppData Go toolchain settings, finding go, and locating the user cache directory (os.UserCacheDir reads HOME, XDG_CACHE_HOME or LocalAppData by platform)
Starts go Package loading runs go list and go env

Embedded in the CLI

The Bomly CLI ships this same analyzer built in — bomly scan --analyze uses it without installing anything. This repository packages the identical module as a standalone managed plugin, for lite builds and for hosts that load analyzers as external plugins.

Install

Download the archive for your platform from the releases page, then:

bomly plugin install ./bomly-plugin-govulncheck-analyzer_<version>_<os>_<arch>.tar.gz
bomly plugin enable govulncheck
bomly scan --enrich --analyze

Configuration

The analyzer has no configuration keys. Reachability is switched on with the host's --analyze flag (or the matching config key); caching is on by default and lives under <user cache dir>/bomly/analyzers/govulncheck/ with a 24-hour TTL.

Local development

go build -o bin/bomly-plugin-govulncheck-analyzer ./cmd/bomly-plugin-govulncheck-analyzer

# Install the dev build into Bomly and scan
bomly plugin install ./bin/bomly-plugin-govulncheck-analyzer --dev
bomly plugin enable govulncheck
bomly scan --enrich --analyze

Run the tests (unit + SDK conformance + a real gRPC handshake probe):

go test ./...

License

Apache-2.0. See LICENSE and NOTICE.

Directories

Path Synopsis
cmd
bomly-plugin-govulncheck-analyzer command
Command bomly-plugin-govulncheck-analyzer serves the govulncheck reachability analyzer as a managed Bomly plugin over the HashiCorp go-plugin gRPC transport.
Command bomly-plugin-govulncheck-analyzer serves the govulncheck reachability analyzer as a managed Bomly plugin over the HashiCorp go-plugin gRPC transport.
Package plugin implements a reachability analyzer for Go modules backed by govulncheck (https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck).
Package plugin implements a reachability analyzer for Go modules backed by govulncheck (https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck).

Jump to

Keyboard shortcuts

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