bomly-plugin-pyreach-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-pyreach-analyzer

Python reachability analyzer for Bomly.

It scans your project's Python sources for import statements, maps imported modules to their distributions, and annotates the vulnerabilities Bomly already found with package-tier reachability: whether the vulnerable distribution is actually imported by your code. Results are cached on disk under <user cache dir>/bomly/analyzers/pyreach/ (24h TTL).

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: Python (pip, Pipenv, Poetry, uv, PDM)
  • Tiers: package
  • Requires: a source tree, a dependency graph, and vulnerability records from a matcher; Bomly skips the analyzer, with a warning, when a scan cannot supply them. No Python interpreter is needed.

Access

bomly-plugin.json declares what the analyzer touches, which Bomly shows before you enable it. It is a disclosure, not a sandbox. The import scanner is written in Go and runs in-process, so the analyzer starts no processes and makes no network calls.

Access Why
Reads project The .py sources it scans for imports, and the project files (pyproject.toml, lockfiles, requirements*.txt, ...) that mark a project root
Reads any Finding a project root walks upward from each candidate path (package locations and the scan target) to the nearest directory holding one of those files, which can be above the scan target
Reads and writes cache The result cache under <user cache dir>/bomly/analyzers/pyreach/
Environment HOME, XDG_CACHE_HOME, LocalAppData Locating the user cache directory (os.UserCacheDir: XDG_CACHE_HOME or HOME on Linux, HOME on macOS, LocalAppData on Windows)

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-pyreach-analyzer_<version>_<os>_<arch>.tar.gz
bomly plugin enable pyreach
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/pyreach/ with a 24-hour TTL.

Local development

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

# Install the dev build into Bomly and scan
bomly plugin install ./bin/bomly-plugin-pyreach-analyzer --dev
bomly plugin enable pyreach
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-pyreach-analyzer command
Command bomly-plugin-pyreach-analyzer serves the pyreach reachability analyzer as a managed Bomly plugin over the HashiCorp go-plugin gRPC transport.
Command bomly-plugin-pyreach-analyzer serves the pyreach reachability analyzer as a managed Bomly plugin over the HashiCorp go-plugin gRPC transport.
Package plugin implements a Tier-3 (package-level) reachability analyzer for Python packages.
Package plugin implements a Tier-3 (package-level) reachability analyzer for Python packages.

Jump to

Keyboard shortcuts

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