Skip to main content

AI-native VMware compliance and baseline enforcement

Project description

vmware-harden

Disclaimer: Community-maintained open-source project. Not affiliated with, endorsed by, or sponsored by VMware, Inc. or Broadcom Inc. "VMware", "vSphere", "ESXi", and "NSX" are trademarks of Broadcom. Source code is publicly auditable at github.com/vmware-skills/VMware-Harden under the MIT license.

English | 中文

AI-native VMware compliance and baseline enforcement. Sibling to the vmware-* skill family.

  • Read-only against vSphere: all 6 MCP tools carry the [READ] marker and none mutate managed VMware infrastructure; scan_target writes only to the local twin DB (a cache of its own observations). See Read-only by design.

GA family member (since v1.5.18)

Production-ready compliance platform with 8 built-in baselines (CIS ESXi 8.0 + 9.0, vSphere SCG v8 + v9, 等保 2.0 三级, PCI-DSS 4.0, EU NIS2, BSI IT-Grundschutz) carrying 87 rules, multi-vCenter Twin, drift detection, LLM Remediation Advisor, MCP server with 6 audited tools, web dashboard, and vmware-harden doctor environment diagnostics.

Quickstart

uv tool install vmware-harden

# List built-in baselines
vmware-harden baseline list

# Run a scan
vmware-harden scan --target <vcenter-name> --baseline cis-vmware-esxi-8.0-subset

# Or use 等保 2.0 三级 (国内合规独家)
vmware-harden scan --target <vc> --baseline dengbao-2.0-level3-vmware

# View results
vmware-harden report
vmware-harden drift

# Generate remediation suggestions
export ANTHROPIC_API_KEY=...  # optional; falls back to mock without
vmware-harden advise --all-critical

# Web dashboard
vmware-harden web --port 8080  # → http://127.0.0.1:8080

Offline / Air-Gapped Install (from source)

This project uses the modern PEP 517 build system (hatchling), so there is no setup.py by design — that is expected, not a missing file. If you cloned the source and hit ERROR: File "setup.py" or "setup.cfg" not found ... editable mode currently requires a setuptools-based build, your pip is older than 21.3 and cannot do an editable (-e) install with a non-setuptools backend. Editable mode is a developer convenience, not needed to run the tool — do one of:

# From the source tree — a normal (non-editable) install builds a wheel:
pip install .              # NOT  pip install -e .

# ...or upgrade pip first, and editable works too:
pip install --upgrade pip && pip install -e .

For a truly air-gapped host, build the wheels on a connected machine and copy them over — the target then needs no network:

# On a connected machine, collect this package + its dependencies as wheels:
pip wheel . -w dist        # → dist/*.whl   (or: uv build, for just this package)

# Copy dist/ to the air-gapped host, then install offline:
pip install --no-index --find-links dist vmware-harden

Read-Only by Design

vmware-harden is read-only against vSphere and NSX — all 6 MCP tools carry the [READ] marker, and none mutate managed VMware infrastructure. scan_target writes only to the local twin DB (~/.vmware-harden/twin.duckdb), a cache of its own observations rather than managed infrastructure. Remediation is never applied by this skill; it is deferred to vmware-pilot, which provides approval gating and audit trails for write operations.

Built-in baselines

Baseline Rules Applies to Source
cis-vmware-esxi-8.0-subset 20 host CIS Benchmark v1.0
vsphere-scg-v8-subset 15 host, vm VMware vcf-security-and-compliance-guidelines
dengbao-2.0-level3-vmware 20 host, vm, datastore, dfw_rule GB/T 22239-2019 三级
pci-dss-4.0-vmware 10 host, dfw_rule PCI-DSS v4.0
eu-nis2-vmware 12 host, dfw_rule EU NIS2 Directive (Articles 21/23, Annex I)
bsi-itgs-basisabsicherung-vmware 10 host BSI IT-Grundschutz (OPS.1.1.4 + SYS.1.1)
cis-vmware-esxi-9.0-subset 20 host Inherits cis-vmware-esxi-8.0-subset via extends:
vsphere-scg-v9-subset 15 host, vm Inherits vsphere-scg-v8-subset via extends:

baseline list returns 8 IDs: the 6 rule-bearing baselines above (87 rules total) plus the two v9 aliases, which carry no rules of their own and resolve to their v8 parent's.

VCF 9.0 / 9.1 Compatibility

The existing baselines (cis-vmware-esxi-8.0-subset, vsphere-scg-v8, dengbao-2.0-level3-vmware, pci-dss-4.0-vmware) scan VCF 9.0 / 9.1 clusters successfully — most rules target host advanced settings stable across 8.x → 9.x. cis-vmware-esxi-9.0-subset and vsphere-scg-v9-subset ship today as extends: aliases of their v8 parents — same rules, a v9-named ID to scan and report under. Rules specific to 9.x will be added to them as Broadcom publishes the v9 guides.

Official Broadcom References

Custom baselines

vmware-harden baseline validate ./my-strict.yaml
vmware-harden baseline import ./my-strict.yaml --name my-strict-cis
vmware-harden scan --target <vc> --baseline my-strict-cis

YAML supports extends: for inheriting from a built-in baseline. See skills/vmware-harden/references/cli-reference.md.

MCP server

vmware-harden mcp  # stdio MCP server (legacy alias: vmware-harden-mcp)

Configure your MCP client with one of examples/mcp-configs/*.json. 6 read-only tools: list_baselines, list_violations, get_remediation, list_drift_events, get_baseline_rules, scan_target.

Architecture

  • Estate Digital Twin — DuckDB single file at ~/.vmware-harden/twin.duckdb. Multi-target safe via target prefix on all node IDs.
  • Collectors — lazy-import sibling vmware-* skills (no spawn overhead). All scans are READ; writes deferred to vmware-pilot.
  • Baseline schema — Pydantic v2, strict (extra="forbid"), extends: inheritance, user-dir override.
  • Drift — pure diff function with optional persistence; auto-runs after every scan.
  • Advisor — LLM-driven Suggestion generation; Anthropic provider with prompt caching; mock fallback for tests / no-API-key environments.
  • Audit — every MCP tool wrapped with @vmware_tool from family vmware-policy.
  • Web — FastAPI + Jinja2 + Tailwind/HTMX/ECharts CDN.

Lab regression

export VMWARE_HARDEN_LAB_TARGET=<your-vc>
pytest tests/eval/regression -v -m lab

Family

  • vmware-aiops — host inventory + ops (used by harden's HostCollector)
  • vmware-monitor — read-only counterpart
  • vmware-storage — datastore inventory
  • vmware-nsx-security — DFW inventory
  • vmware-pilot — execute remediations (writes; out of scope for harden)
  • vmware-policy@vmware_tool audit decorator

Acceptance criteria (v1.5.18 GA)

  • 221 tests passing
  • Bandit: 0 issues at any severity
  • All 6 MCP tools audited
  • SKILL.md ≤ 3000 words, family-convention compliant
  • SECURITY.md with 6 elements + Broadcom disclaimer
  • 8 built-in baselines (87 rules across 6 rule-bearing sets + 2 v9 aliases)
  • vmware-harden doctor for environment diagnostics
  • GA member of vmware-* family (version-aligned at 1.5.28)

References

  • Family CLAUDE.md: CLAUDE.md at the monorepo root

License

MIT

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

vmware_harden-1.8.8.tar.gz (331.3 kB view details)

Uploaded Source

Built Distribution

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

vmware_harden-1.8.8-py3-none-any.whl (91.8 kB view details)

Uploaded Python 3

File details

Details for the file vmware_harden-1.8.8.tar.gz.

File metadata

  • Download URL: vmware_harden-1.8.8.tar.gz
  • Upload date:
  • Size: 331.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.12

File hashes

Hashes for vmware_harden-1.8.8.tar.gz
Algorithm Hash digest
SHA256 6d3cb3ee17da62af1811497385bf4142919f0d569d9f472653a98327cf287ed1
MD5 9830804cd5a6e2ba1116fdf10c1b9db7
BLAKE2b-256 51964a91b1ced03362a2c2e58ca4c92addbc22bde1331c6cb079cedfaa518445

See more details on using hashes here.

File details

Details for the file vmware_harden-1.8.8-py3-none-any.whl.

File metadata

  • Download URL: vmware_harden-1.8.8-py3-none-any.whl
  • Upload date:
  • Size: 91.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.12

File hashes

Hashes for vmware_harden-1.8.8-py3-none-any.whl
Algorithm Hash digest
SHA256 10ccd92ea5d2f3759b48a7fdb00d41861342bf4dd5246278fe257a6f16ea85a4
MD5 9755902371b991d098eba94e73873593
BLAKE2b-256 062a178f703b5fef78ab7a77bbda8d9d3230f6d6ab9060132d6ebe689435d728

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