Skip to main content

The best reachability engine for Python: tells you which dependency vulnerabilities are actually reachable from your own code.

Project description

VulnAdvisor

Stop scanning, start triaging.

VulnAdvisor is an open-source CLI that tells you which of your Python dependency vulnerabilities are actually reachable from your own code — ranked by real-world exploit likelihood (EPSS + CISA KEV) and explained in plain English.

It runs locally. Your source code never leaves your machine, and there is no telemetry. Network calls are only to public vulnerability/risk APIs (OSV, GitHub Advisory, EPSS, CISA KEV) and, optionally, your own LLM key.

In our reproducible benchmark, reachability triage cuts a naive scanner's findings by ~54% with zero missed reachable criticals — see benchmarks/REPORT.md.

Install

pip install vulnadvisor
# or run without installing:
uvx vulnadvisor --help

Requires Python 3.12+.

Quickstart (under 5 minutes)

Point it at any Python project that has a requirements.txt (or a lockfile):

uvx vulnadvisor scan examples/quickstart

You'll get one three-card finding per vulnerability, highest priority first:

  • Card A — Attack story: plain-English explanation specific to the finding.
  • Card B — Risk: a Red/Yellow/Green badge from the EPSS+KEV-driven priority.
  • Card C — Action: the verdict, the deterministic priority, the exact upgrade command, and the reachability tier with its evidence (the import site or, when known, the call path).

In the bundled examples/quickstart, PyYAML is imported and used, so its advisories are surfaced as IMPORTED with the import site — actionable. The declared-but-unused requests is deprioritized (no path from your code). That split — flag what you use, demote what you don't — is the triage.

Tip: for the most precise NOT-IMPORTED verdicts, install VulnAdvisor into the same environment as your project (pip install vulnadvisor in your project venv) so it can read installed package metadata to map distributions to import names with high confidence. Run in isolation (uvx) and a dependency it can't confidently map stays the cautious DYNAMIC-UNKNOWN.

Function-level call paths (IMPORTED-AND-CALLED)

The strongest tier — a concrete path from your code to the vulnerable symbol — needs the advisory→vulnerable-symbol dataset. Build it once (queries OSV fix commits locally):

vulnadvisor backfill --top 50      # or: vulnadvisor backfill pyyaml jinja2 ...

When the symbol an advisory patched is one your code calls directly, the next scan upgrades the finding to IMPORTED-AND-CALLED and prints the path (e.g. main -> parse -> yaml.load). Advisories whose fix touches only library-internal symbols reached via a public API stay at IMPORTED (sound: we never claim a call we can't prove) — improving that linkage is on the roadmap.

Plain-English explanations (optional)

Card A uses a deterministic template by default. Export an Anthropic key to get an LLM-written "attack story" (priority stays deterministic — the model only explains, it never changes the number):

export ANTHROPIC_API_KEY=sk-...
vulnadvisor scan .            # Card A now reads like a senior engineer wrote it
vulnadvisor scan . --no-explain   # turn it off

Reachability tiers (the noise-killer)

Every finding carries a confidence tier — VulnAdvisor never gives a binary "reachable / not":

  • IMPORTED-AND-CALLED — a concrete call path to the vulnerable symbol exists (function-level).
  • IMPORTED — the package is imported by your code (evidence: the import site, file:line).
  • DYNAMIC-UNKNOWN — dynamic import/exec, reflection, unreadable files, or an uncertain import-name mapping mean usage cannot be ruled out. Never treated as safe.
  • NOT-IMPORTED — the package is never imported. The only confidently-safe tier; these are deprioritized and labeled "No path from your code".

Soundness is the rule: a false "you're safe" can cause a breach, so anything uncertain escalates to DYNAMIC-UNKNOWN rather than being silently downgraded. Reflective getattr dispatch is resolved with optional Pyright type info, and framework-routed handlers (FastAPI routes, Django URLconf views and @receiver signals) are recognized as entry points so the call path is rooted at the real handler.

Priority scoring (deterministic)

Priority is computed by code and is fully reproducible — no randomness, no clock, no I/O. The optional LLM layer only explains a finding; it never changes the number.

Given a CVSS base severity (0–10), an EPSS exploit probability (0–1), and CISA KEV membership:

sev  = severity / 10
risk = 0.6 * epss + 0.4 * sev      # when EPSS is known
risk = sev                         # when EPSS is unknown (severity is not zeroed out)
value = round(100 * risk, 1)       # 0–100 priority

EPSS is weighted above severity because triage is about real-world exploit likelihood. Soundness guards: KEV dominates (a known-exploited vuln is floored to 90/CRITICAL), and an unknown CVSS falls back to a moderate default (5.0, flagged) rather than being scored as 0.

Bands → verdicts:

Score Band Verdict
≥ 90 CRITICAL Fix now
70–89.9 HIGH Fix this sprint
40–69.9 MEDIUM Plan a fix
15–39.9 LOW Monitor
< 15 INFO Deprioritize

Runtime coverage overlay (--coverage)

Static analysis tells you a finding is reachable; a test run can tell you its code actually executes. Feed VulnAdvisor a coverage.py JSON report and it marries the two — shrinking the ambiguous tiers with proof instead of optimism:

coverage run --branch -m pytest          # your existing test suite
coverage json -o coverage.json           # line OR branch coverage both work
vulnadvisor scan . --coverage coverage.json

For each finding, VulnAdvisor adds a runtime annotation shown alongside the static tier (it never replaces it):

  • RUNTIME-CONFIRMED — coverage proves a line tied to the finding (an import site, a call-path step, or a taint sink/flow location) executed. An ambiguous IMPORTED / DYNAMIC-UNKNOWN / POSSIBLE-FLOW finding now carries runtime proof.
  • not-observed — the suite covered the finding's files but ran none of its lines. This is advisory only: a test suite is not production, so it never downgrades a tier (the soundness rule holds — false "you're safe" is release-blocking).

The overlay is escalation-only and deterministic: it adds evidence but never changes a tier, a priority score, or the ranking. Coverage of files outside the scanned project is ignored, and a malformed coverage report is a clean usage error, never a crash. The annotation appears in the terminal Card C, in the JSON report (additive runtime object), and in SARIF result properties.

Validated fixes (vulnadvisor fix)

For a first-party (SAST) finding, VulnAdvisor can ask a language model for the smallest safe patch and then prove it on a throwaway copy of your project — the patch must apply, keep the code parsing/linting/type-checking, pass your tests, and make the finding disappear from a fresh scan without introducing a new one. Only a fully validated patch is shown; otherwise you get an honest "no safe fix found". The working tree is never touched unless you pass --apply.

The fix loop is provider-flexible — any OpenAI-compatible key works, so a free OpenRouter key is enough; an Anthropic key is no longer required. The provider is detected from the key prefix (sk-or- → OpenRouter, sk-ant- → Anthropic, sk-/sk-proj- → OpenAI), read in this order (first present wins): OPENROUTER_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY.

export OPENROUTER_API_KEY=sk-or-...        # a free OpenRouter key works
vulnadvisor fix app/views.py:42:command-injection           # print the validated diff
vulnadvisor fix app/views.py:42:command-injection --apply   # write it to your tree
vulnadvisor fix --provider openrouter --model openrouter/auto app/views.py:42:command-injection

Override the provider with --provider {openrouter,openai,anthropic} and the model with --model (or the VULNADVISOR_MODEL env var). The single network call goes to your own chosen endpoint; every validation step is local, so your code never leaves the machine otherwise.

One-click PR suggestions (no GitHub App)

vulnadvisor suggest posts those validated fixes as in-line GitHub suggestion comments — the ones a reviewer commits with one click — straight from GitHub Actions using the built-in GITHUB_TOKEN. No GitHub App, no webhook, no platform: a workflow with pull-requests: write and a model-key secret is enough.

permissions:
  contents: read
  pull-requests: write
jobs:
  vulnadvisor:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - run: pip install vulnadvisor
      - name: Suggest validated fixes on the pull request
        if: github.event_name == 'pull_request'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENROUTER_API_KEY: ${{ secrets.OPENROUTER_API_KEY }}   # a free OpenRouter key works
        run: vulnadvisor suggest

suggest reads the pull request and head commit from the Actions event payload, scans, validates a patch for each finding, and posts only the cleanly-appliable ones. The review is always a comment — never a "request changes", never an auto-commit. Re-runs prune and repost our own suggestions, so a finding you've fixed has its suggestion removed in place. Outside a pull request it is a no-op; use --dry-run to preview the comments without posting. The only network calls are to your model key and to GitHub; your source code stays in CI.

Output formats & CI gating

vulnadvisor scan PATH --format {terminal,json,sarif}:

  • terminal (default) — the three-card view.
  • json — a stable machine report (schema_version 1.1): tool, degraded_sources, summary, and findings[] ordered by descending priority (each with dependency, advisory, EPSS, KEV, score, reachability + call paths, and the minimal safe fix command).
  • sarif — valid SARIF 2.1.0, so results show up in the GitHub Security tab, ordered by our triage priority.

--fail-on <band|score> sets the exit code: the scan exits 1 when any finding meets or exceeds the threshold (a band name like high, or a number 0100), else 0. Invalid values are a usage error (exit 2).

GitHub Actions

- name: VulnAdvisor reachability triage
  run: |
    pipx install vulnadvisor
    vulnadvisor scan . --format sarif --fail-on high > results.sarif
- uses: github/codeql-action/upload-sarif@v3
  if: always()
  with:
    sarif_file: results.sarif

Privacy

VulnAdvisor is built for environments where source code must not leave the machine:

  • No telemetry, no analytics, no phone-home. Ever.
  • Source code is analyzed locally; only dependency names/versions are sent to public advisory APIs (OSV, GitHub Advisory, EPSS, CISA KEV), cached in a local SQLite database.
  • The optional LLM layers (Card A explanations and vulnadvisor fix) are the only calls to a non-public service, use your own key (ANTHROPIC_API_KEY for explanations; OpenRouter / OpenAI / Anthropic for fix), and send only the finding metadata they need. They are off unless you set a key, and --no-explain disables the explanation layer entirely.

Develop

uv sync
uv run ruff check && uv run ruff format --check
uv run mypy --strict src
uv run pytest

See CONTRIBUTING.md. Run the noise-reduction benchmark with uv run python -m benchmarks.

License

Apache-2.0. © VulnAdvisor contributors.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vulnadvisor-1.0.5.tar.gz (6.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vulnadvisor-1.0.5-py3-none-any.whl (196.5 kB view details)

Uploaded Python 3

File details

Details for the file vulnadvisor-1.0.5.tar.gz.

File metadata

  • Download URL: vulnadvisor-1.0.5.tar.gz
  • Upload date:
  • Size: 6.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vulnadvisor-1.0.5.tar.gz
Algorithm Hash digest
SHA256 042de7621fdd3080d9063391cbb234f945c0e70128a87a24ab2ecd44431987b8
MD5 9432dfe0079f6fb08f37307513c0583f
BLAKE2b-256 929b494c438b7e64095d1a7521cfbb9a6557b18f44eabeb5ab527f7174ed3e52

See more details on using hashes here.

File details

Details for the file vulnadvisor-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: vulnadvisor-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 196.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vulnadvisor-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c5af17eea5bee0ea037241b5a8b0cbf9303626b4072f6a79d742a6557ff1944d
MD5 812ba64a318a3f610dddac806a43418e
BLAKE2b-256 bde94d6b987d92c7001323f2d9044663c71533804cfdd517d106cdaafa6c1476

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page