Repository navigation
Installation
- Python 3.11 or newer. No third-party packages.
-
git, for the PoC-in-GitHub index (optional: turnsources.github_pocoff without it). - About 800 MB of disk for the database, kept outside the repo.
pip install git+https://github.com/magikh0e/cvescopeOr clone it and run it from the checkout with python -m cvescope:
git clone https://github.com/magikh0e/cvescope && cd cvescope
pip install .cvescope init # writes a starter config to your user config dir
# edit it: add [[inventory]] blocks (see Collectors)
cvescope sync # downloads the feeds, collects inventory, matches
cvescope report # act-now and watch tiers in the terminal
cvescope serve # the page at http://127.0.0.1:8096/The first sync downloads about 750 MB: the full CVE List snapshot (imported once, then kept
up to date with small daily deltas) and the PoC-in-GitHub index. Expect a few minutes.
Every feed's first load counts as history, so the first sync raises no alerts. From then on, only real changes come through: a CVE you run getting added to KEV, picking up an exploit, and so on.
examples/demo.toml describes a small, badly patched, made-up network (old Jenkins, TeamCity,
FortiOS, Apache 2.4.49 and friends) and keeps its data in its own folder:
cvescope --config examples/demo.toml sync
cvescope --config examples/demo.toml serve # http://127.0.0.1:8098/It needs its own full sync (the same ~750 MB) because it never touches your real database.
| What | Linux / macOS | Windows |
|---|---|---|
| Config |
~/.config/cvescope/config.toml (or ./cvescope.toml) |
%APPDATA%\cvescope\config.toml |
| Database and caches | ~/.local/share/cvescope/ |
%LOCALAPPDATA%\cvescope\ |
--config PATH or the CVESCOPE_CONFIG environment variable points at a different config, and
data_dir = "..." in the config moves the database.
pip install --upgrade git+https://github.com/magikh0e/cvescopeRelease notes say when an upgrade benefits from a one-time cvescope sync --rebaseline, which
re-imports the CVE List (for example, 0.2.0 started indexing package names).