Skip to content

Collectors

magikh0e edited this page Nov 17, 2026 · 2 revisions

Collectors

Each [[inventory]] block names a type. Every collector is read-only, and none of them scan: they ask a device's API, run a command you wrote, or read a file another tool produced. If a collector fails (device offline, token expired), its last known versions are kept and the page marks it, so one outage doesn't make your matches disappear.

Common keys: name, aliases, keywords, enabled. Secrets always go through *_file or *_env (see Configuration).

Anything, by hand or by command

static: a product and version you type in.

[[inventory]]
type = "static"
name = "Nextcloud"
vendor = "nextcloud"
product = "nextcloud server"
version = "30.0.4"

command: run a command (over ssh too) and pull the version out with a regex. package borrows the built-in aliases for a known package name.

[[inventory]]
type = "command"
name = "OpenSSH on the VPS"
command = ["ssh", "vps", "ssh -V"]
regex = 'OpenSSH_([0-9.p]+)'
package = "openssh-server"

http_json: read a version field from any JSON endpoint.

[[inventory]]
type = "http_json"
name = "Grafana"
vendor = "grafana"
product = "grafana"
url = "https://grafana.lan/api/health"
path = "version"
verify_tls = true

Hosts and packages

dpkg: packages on a Debian or Ubuntu host. Include the os-release part and the distro's own security tracker decides fixed or affected, backported fixes included (see Matching and Statuses).

[[inventory]]
type = "dpkg"
name = "web1"
command = ["ssh", "web1", "cat /etc/os-release; echo ---; dpkg-query -W -f='${db:Status-Abbrev} ${Package} ${Version} ${source:Package}\\n'"]
# packages = "all"     # every source package; default is the ~60 cvescope has names for

Keep the ${db:Status-Abbrev} column. dpkg-query -W also lists packages that were removed but left their config files behind (rc), and without the status cvescope can't tell them from installed ones (ii). After a release upgrade there can be hundreds of those.

osquery: installed programs and packages. Two modes:

  • Live (no path): cvescope runs osqueryi itself and picks queries for the OS it finds.
    • Windows: programs, plus the exact build, update revision and release name, so Microsoft's version ranges match to the update.
    • macOS: apps and homebrew_packages.
    • Linux: deb_packages or rpm_packages, plus kernel_info.
  • Saved results (path): osqueryi --json output, osqueryd result logs, or the JSON from examples/windows-inventory.ps1 for Windows machines without osquery.
[[inventory]]
type = "osquery"                   # this machine, live

[[inventory]]
type = "osquery"
name = "nas"
command_prefix = ["ssh", "nas"]    # another host, live
# osqueryi = "/opt/osquery/bin/osqueryi"
# queries = ["SELECT name, version FROM programs"]   # replaces the defaults

[[inventory]]
type = "osquery"
path = "~/inventory/*.json"        # saved results
# programs = "all"                 # also programs with no built-in name mapping

About 50 common programs are mapped by name (browsers, archivers, VPN and remote-access clients, dev tools). programs = "all" adds the rest by their display name.

docker: the app in each running Docker or Podman container, named from its image and versioned from its tag, or from the image's version label when the tag is latest. A container with a floating tag and no version label is listed but not matched; pin a version tag to fix that. Packages inside the image are out of scope (use an SBOM tool).

[[inventory]]
type = "docker"
name = "vps"
command_prefix = ["ssh", "vps"]    # omit for the local engine
engine = "docker"                  # or "podman"
# all = true                       # include stopped containers

Reports from tools you ran

nmap_xml: every open service an nmap -sV scan identified. cvescope never runs nmap; you do, on networks you're allowed to scan.

[[inventory]]
type = "nmap_xml"
path = "~/scans/*.xml"
hosts = ["192.168.1.0/24"]         # optional filter
max_age_days = 30                  # skip stale scans
# unversioned = true               # also services nmap couldn't version (noisy)

wpscan: WordPress core, theme and plugin versions from a WPScan JSON report. whatweb: web server, PHP, CMS and JavaScript library versions from WhatWeb.

[[inventory]]
type = "wpscan"
path = "~/scans/wpscan/*.json"

[[inventory]]
type = "whatweb"
path = "~/scans/whatweb/*.json"

Appliances

proxmox: PVE itself plus every VM and container. VMs running the QEMU guest agent report their OS and kernel, so a forgotten Debian VM gets checked through the Debian tracker. Containers only report their OS type and show up with a hint to add a dpkg collector. An API token with the PVEAuditor role is enough.

[[inventory]]
type = "proxmox"
url = "https://192.168.1.10:8006"
token_file = "~/.secrets/pve-token"    # user@pve!tokenid=secret
pin_sha256 = "..."
# packages = true                      # also QEMU, LXC and the host kernel
# guests = false                       # skip the VM/container list

opnsense: OPNsense, its FreeBSD base and OpenSSL, plus OpenSSH, Unbound, dnsmasq, Suricata and other packages that matter.

[[inventory]]
type = "opnsense"
url = "https://192.168.1.1"
key_file = "~/.secrets/opnsense-key"
secret_file = "~/.secrets/opnsense-secret"
pin_sha256 = "..."

unifi: the UniFi Network application and every adopted device's firmware.

[[inventory]]
type = "unifi"
url = "https://192.168.1.1"
apikey_file = "~/.secrets/unifi-key"
pin_sha256 = "..."

pihole: Pi-hole v6 core, FTL and web versions. It logs in, reads, and logs out.

[[inventory]]
type = "pihole"
name = "pihole"
url = "https://192.168.1.2"
password_file = "~/.secrets/pihole"
pin_sha256 = "..."

homeassistant: Home Assistant Core, plus the OS and add-ons when the token is an admin token. (On Proxmox, the guest agent reports Home Assistant OS too.)

[[inventory]]
type = "homeassistant"
url = "http://homeassistant.local:8123"
token_env = "HASS_TOKEN"

Something missing? Request a collector or see Contributing.

Clone this wiki locally