Skip to main content

Air-Gapped Deployment

Objective​

Deploy and operate Cyprob EE in restricted networks without direct internet connectivity while preserving security and operational reliability.

Deployment Principles​

  • At runtime the appliance contacts one host, updates.cyprob.io, for engine updates, the plugin feed and the CVE feed. It sends no telemetry.
  • That host can be replaced by an internal mirror, so the appliance does not need direct internet access.
  • Repeatable install: the OVA is the full install. Updates and rollback run through the built-in updater.
  • Verifiable integrity at every handoff: the OVA ships with a .sha256 file and a GPG .asc signature, engine updates use an ed25519-signed manifest plus a SHA-256 of the binary, and the plugin feed uses a signed index.

Scope​

This guide covers:

  • Appliance preparation and transfer
  • Installation and first validation
  • Update cycle
  • Rollback checkpoints

Required Artifacts (Prepared in Connected Zone)​

  • The Cyprob appliance OVA (cyprob-appliance-v<version>.ova) with its .sha256 and .asc files. No other manifests are needed: the OVA is the full install, and database migrations are built into the binary and run when the service starts.
  • A Cyprob license key. It is checked on the appliance, with no call home. No secrets need to be prepared: the appliance makes its own database password and encryption key on first boot.

1. Prepare the Appliance (Connected Zone)​

  • Download the OVA, its .sha256 and its .asc from the link Cyprob sends you.
  • Verify the OVA against its .sha256 (sha256sum -c) and its .asc (gpg --verify) before you transfer it.

2. Transfer to Restricted Zone​

  • Use approved secure media/process.
  • Record transfer event and operator identity.
  • Validate hashes again before import.

3. Import and Install​

  • Deploy the OVA on VMware ESXi or vSphere (4 vCPU and 8 GB RAM by default). The appliance runs Ubuntu 24.04 with a local PostgreSQL database.
  • Point the feed settings at your internal mirror: updater.manifest_url, updater.plugin_feed_url and updater.cve_feed_manifest_url. Leave the defaults if the appliance may reach updates.cyprob.io through a proxy. Signature keys stay pinned in the product, so a mirror cannot inject content.
  • Power on the VM; the cyprob-ee@server service starts on boot and serves the console on port 8080.
  • Run health checks and baseline smoke validation.

4. First-Run Validation​

Minimum validation after installation:

  • GET http://<appliance>:8080/readyz returns 200 OK (/healthz only shows that the process is up).
  • The setup wizard is complete, login works and org context is available.
  • The plugin feed has synced from updates.cyprob.io or your mirror. Until it has, scans are refused with PLUGIN_FEED_NOT_READY.
  • One scan can be started and completed.
  • Findings are retrievable.
  • One report can be generated/downloaded.

5. Update Cycle​

For each update window:

  • Take a VM snapshot.
  • Start the update from the System Update page. The built-in updater fetches the signed manifest and binary from updates.cyprob.io or the mirror set in updater.manifest_url.
  • Re-run smoke tests.
  • For rollback, the updater keeps the previous binary as cyprob.old and the config as config.yaml.pre-update; the VM snapshot is the simplest full fallback.

A fully disconnected appliance, with neither internet access nor a mirror, can only be updated by deploying a new OVA.

Operational Controls for Air-Gapped Environments​

  • Change window required for updates.
  • Use your change process for applying an update; the product has no two-person approval for updates.
  • Audit logging is on by default for admin and security actions. Platform admins can read it and export it as CSV. Rows are removed by the retention policy, so copy the export to write-once storage if you need immutability.
  • Back up the PostgreSQL database (pg_dump cyprob_ee), /etc/cyprob/ and /var/lib/cyprob/secrets.key. Without that key a restored database cannot decrypt stored credentials or the SMTP password. The product has no built-in backup; a VM snapshot is the simplest full copy.

Limitations and Clarifications​

  • "Air-gapped ready" does not mean "no maintenance": plugin and CVE content arrive only through feed sync from updates.cyprob.io or a mirror. There is no file import for the plugin feed; only the CVE database can be loaded from a file (cyprob cve import).
  • A new appliance cannot run its first scan until the plugin feed has synced.
  • Time synchronization must be provided by the customer environment.
  • The appliance serves plain HTTP on port 8080; put your own TLS-terminating proxy in front of it.
  • Your SMTP relay, LDAP directory or OIDC provider, and the internal feed mirror must be reachable from the appliance. Audit data leaves the appliance only as a CSV export.

Evidence Checklist​

  • Artifact hash verification records retained.
  • Install/update execution logs retained.
  • Health + first-scan validation evidence retained.
  • Rollback procedure tested at least once in non-production.

Next Action​

Continue with Security Model to define trust boundaries and control expectations in restricted deployments.