Skip to content

Commit 3387a0e

Browse files
committed
docs: refresh project documentation
1 parent 4876819 commit 3387a0e

32 files changed

Lines changed: 617 additions & 1269 deletions

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ how to set up your development environment, run tests, and submit changes.
77

88
| Tool | Minimum Version | Purpose |
99
|---|---|---|
10-
| Go | 1.25+ | Build Go services (9 services, see below) |
11-
| Python | 3.11+ | Build Python services (quarantine, UI, search mediator) |
10+
| Go | 1.26.3+ | Build Go services (9 services, see below) |
11+
| Python | 3.12+ recommended | Build Python services. Quarantine package metadata still allows 3.11 for scanner compatibility. |
1212
| shellcheck | Latest | Lint shell scripts |
1313
| git | 2.x | Version control |
1414

@@ -55,7 +55,7 @@ shellcheck files/system/usr/libexec/secure-ai/*.sh
5555

5656
## Running Tests
5757

58-
### Go Tests (427 tests across 9 services)
58+
### Go Tests (429 tests across 9 services)
5959

6060
```bash
6161
for svc in airlock registry tool-firewall gpu-integrity-watch mcp-firewall \
@@ -64,7 +64,7 @@ for svc in airlock registry tool-firewall gpu-integrity-watch mcp-firewall \
6464
done
6565
```
6666

67-
### Python Tests (1112 collected tests)
67+
### Python Tests (1154 collected tests)
6868

6969
```bash
7070
pip install -r requirements-ci.txt
@@ -89,13 +89,13 @@ shellcheck files/system/usr/libexec/secure-ai/*.sh files/scripts/*.sh
8989
### Run Everything
9090

9191
```bash
92-
# Go (9 services, 427 tests)
92+
# Go (9 services, 429 tests)
9393
for svc in airlock registry tool-firewall gpu-integrity-watch mcp-firewall \
9494
policy-engine runtime-attestor integrity-monitor incident-recorder; do
9595
(cd "services/$svc" && go test -v -race ./...)
9696
done
9797

98-
# Python (1112 collected tests)
98+
# Python (1154 collected tests)
9999
PYTHONPATH=services python -m pytest tests/ -v
100100

101101
# Type check

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Open `http://127.0.0.1:8480`, go to **Models**, and click **Download** on any mo
9393
| Registry | 8470 | Go | Trusted artifact manifest, read-only model store |
9494
| Tool Firewall | 8475 | Go | Policy-gated tool invocation gateway |
9595
| Web UI | 8480 | Python | Chat, image/video generation, model management |
96-
| Airlock | 8490 | Go | Sanitized egress proxy (disabled by default) |
96+
| Airlock | 8490 | Go | Sanitized egress decision gate (disabled by default) |
9797
| Inference Worker | 8465 | llama.cpp | LLM inference (CUDA / ROCm / Vulkan / Metal / CPU) |
9898
| Diffusion Worker | 8455 | Python | Image and video generation |
9999
| Agent | 8476 | Python | Policy-bound local autopilot (deny-by-default, capability tokens) |
@@ -353,7 +353,7 @@ All CI jobs are defined in [`.github/workflows/ci.yml`](.github/workflows/ci.yml
353353
|-----------|-------------|
354354
| [Registry](docs/components/registry.md) | Trusted artifact manifest and model store |
355355
| [Tool Firewall](docs/components/tool-firewall.md) | Policy-gated tool invocation |
356-
| [Airlock](docs/components/airlock.md) | Sanitized egress proxy |
356+
| [Airlock](docs/components/airlock.md) | Sanitized egress decision gate |
357357
| [Quarantine](docs/components/quarantine.md) | 7-stage scanning pipeline |
358358
| [Agent](docs/components/agent.md) | Policy-bound local autopilot with verified supervisor |
359359
| [Search Mediator](docs/components/search-mediator.md) | Tor-routed web search |
@@ -526,7 +526,7 @@ See [docs/test-matrix.md](docs/test-matrix.md) for full breakdown.
526526
- [x] **Milestone 44** -- Auditability and documentation hardening: test-count drift CI check, CI evidence links and badges, M4/M5 terminology disambiguation, audit quick-path doc, recovery runbook, verify-release script, security/product roadmap split
527527
- [x] **Milestone 45** -- Production readiness hardening: incident persistence (file-backed), graceful shutdown for all Go services, HTTP timeouts, systemd production hardening, first-boot validation, audit log rotation, CI vulnerability scanning, production operations guide
528528
- [x] **Milestone 46** -- Operational maturity: bootstrap trust gap fix (cosign verify before rebase), CI runs on all changes (removed paths-ignore for .md), Python quality gates (ruff + bandit + split test suites), docs-validation CI job, production-readiness checklist, SLOs, release channel policy, support lifecycle, sample verification output
529-
- [x] **Milestone 47** -- CI enforcement hardening: enforced vulnerability scanning (govulncheck + pip-audit + bandit fail on HIGH/HIGH) with waiver mechanism, mypy type checking for security-sensitive services, pinned reproducible Python CI dependencies, Go 1.23→1.25 (12 stdlib CVE fixes), verification-first bootstrap docs
529+
- [x] **Milestone 47** -- CI enforcement hardening: enforced vulnerability scanning (govulncheck + pip-audit + bandit fail on HIGH/HIGH) with waiver mechanism, mypy type checking for security-sensitive services, pinned reproducible Python CI dependencies, Go 1.26.3 service CI/builders, verification-first bootstrap docs
530530
- [x] **Milestone 48** -- Production hardening: build script fail-closed (fatal errors for 12 required services + binary verification gate), incident store fsync (crash-safe persistence), GPU backend metadata recording, llama-server watchdog (Type=notify + WatchdogSec=30), model catalog externalization (YAML with fallback), circuit breaker for inter-service HTTP calls, post-upgrade model verification in Greenboot, cosign key rotation documentation (full lifecycle)
531531
- [x] **Milestone 49** -- Signed-first install path: bootstrap script configures signing policy before first rebase (eliminates unverified transport), digest-pinned install flow (CI publishes digests in build summary + release assets), first-boot setup wizard (interactive integrity verification + vault + TPM2 + health check), recovery/dev path separated into dedicated doc
532532
- [x] **Milestone 50** -- Production operations package: backup/restore scripts (full/config/logs/keys categories, age/gpg encryption, SHA256 manifest, LUKS header backup/restore), rollback decision matrix (Greenboot auto-rollback + manual criteria), 5 break-glass recovery procedures, formal data retention policy (7 data classes, disk capacity thresholds)
@@ -551,7 +551,7 @@ files/
551551
services/
552552
registry/ Go -- Trusted Registry (:8470)
553553
tool-firewall/ Go -- Policy-gated tool gateway (:8475)
554-
airlock/ Go -- Online egress proxy (:8490)
554+
airlock/ Go -- Online egress decision gate (:8490)
555555
gpu-integrity-watch/ Go -- GPU runtime verification (:8495)
556556
mcp-firewall/ Go -- MCP policy gateway (:8496)
557557
policy-engine/ Go -- Unified policy decisions (:8500)

0 commit comments

Comments
 (0)