docs consolidation work
This commit is contained in:
@@ -58,9 +58,10 @@
|
|||||||
|------------|:----:|:---------:|:----------:|-------|
|
|------------|:----:|:---------:|:----------:|-------|
|
||||||
| CVE Lookup via Local DB | ✅ | ✅ | ✅ | |
|
| CVE Lookup via Local DB | ✅ | ✅ | ✅ | |
|
||||||
| Licence-Risk Detection | ⏳ | ⏳ | ⏳ | Q4-2025 |
|
| Licence-Risk Detection | ⏳ | ⏳ | ⏳ | Q4-2025 |
|
||||||
| **Language Analyzers (All 8)** | | | | |
|
| **Language Analyzers (All 11)** | | | | |
|
||||||
| — .NET/C#, Java, Go, Python | ✅ | ✅ | ✅ | |
|
| — .NET/C#, Java, Go, Python | ✅ | ✅ | ✅ | |
|
||||||
| — Node.js, Ruby, Bun, Native | ✅ | ✅ | ✅ | |
|
| — Node.js, Ruby, Bun, Deno | ✅ | ✅ | ✅ | |
|
||||||
|
| — PHP, Rust, Native binaries | ✅ | ✅ | ✅ | |
|
||||||
| **Progressive Fidelity Modes** | | | | |
|
| **Progressive Fidelity Modes** | | | | |
|
||||||
| — Quick Mode | ✅ | ✅ | ✅ | |
|
| — Quick Mode | ✅ | ✅ | ✅ | |
|
||||||
| — Standard Mode | ✅ | ✅ | ✅ | |
|
| — Standard Mode | ✅ | ✅ | ✅ | |
|
||||||
@@ -423,7 +424,7 @@
|
|||||||
### Free Tier (33 scans/day)
|
### Free Tier (33 scans/day)
|
||||||
**Target:** Individual developers, OSS contributors, evaluation
|
**Target:** Individual developers, OSS contributors, evaluation
|
||||||
|
|
||||||
- All language analyzers (8 languages)
|
- All language analyzers (11 languages)
|
||||||
- All regional crypto (FIPS/eIDAS/GOST/SM/PQ)
|
- All regional crypto (FIPS/eIDAS/GOST/SM/PQ)
|
||||||
- Full VEX processing + VEX Hub + Conflict Studio
|
- Full VEX processing + VEX Hub + Conflict Studio
|
||||||
- SSO/SAML/OIDC authentication
|
- SSO/SAML/OIDC authentication
|
||||||
|
|||||||
@@ -1,204 +1,204 @@
|
|||||||
# SYSTEM REQUIREMENTS SPECIFICATION
|
# SYSTEM REQUIREMENTS SPECIFICATION
|
||||||
Stella Ops · self‑hosted supply‑chain‑security platform
|
Stella Ops · self‑hosted supply‑chain‑security platform
|
||||||
|
|
||||||
> **Audience** – core maintainers and external contributors who need an
|
> **Audience** – core maintainers and external contributors who need an
|
||||||
> authoritative checklist of *what* the software must do (functional
|
> authoritative checklist of *what* the software must do (functional
|
||||||
> requirements) and *how well* it must do it (non‑functional
|
> requirements) and *how well* it must do it (non‑functional
|
||||||
> requirements). Implementation details belong in Module Specs
|
> requirements). Implementation details belong in Module Specs
|
||||||
> or ADRs—**not here**.
|
> or ADRs—**not here**.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 1 · Purpose & Scope
|
## 1 · Purpose & Scope
|
||||||
|
|
||||||
This SRS defines everything the **v0.1.0‑alpha** release of _Stella Ops_ must do, **including the Free‑tier daily quota of {{ quota_token }} SBOM scans per token**.
|
This SRS defines everything the **v0.1.0‑alpha** release of _Stella Ops_ must do, **including the Free‑tier daily quota of {{ quota_token }} SBOM scans per token**.
|
||||||
Scope includes core platform, CLI, UI, quota layer, and plug‑in host; commercial or closed‑source extensions are explicitly out‑of‑scope.
|
Scope includes core platform, CLI, UI, quota layer, and plug‑in host; commercial or closed‑source extensions are explicitly out‑of‑scope.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 2 · References
|
## 2 · References
|
||||||
|
|
||||||
* [overview.md](overview.md) – market gap & problem statement
|
* [overview.md](overview.md) – market gap & problem statement
|
||||||
* [03_VISION.md](03_VISION.md) – north‑star, KPIs, quarterly themes
|
* [03_VISION.md](03_VISION.md) – north‑star, KPIs, quarterly themes
|
||||||
* [07_HIGH_LEVEL_ARCHITECTURE.md](07_HIGH_LEVEL_ARCHITECTURE.md) – context & data flow diagrams
|
* [07_HIGH_LEVEL_ARCHITECTURE.md](07_HIGH_LEVEL_ARCHITECTURE.md) – context & data flow diagrams
|
||||||
* [modules/platform/architecture-overview.md](modules/platform/architecture-overview.md) – component APIs & plug‑in contracts
|
* [modules/platform/architecture-overview.md](modules/platform/architecture-overview.md) – component APIs & plug‑in contracts
|
||||||
* [09_API_CLI_REFERENCE.md](09_API_CLI_REFERENCE.md) – REST & CLI surface
|
* [09_API_CLI_REFERENCE.md](09_API_CLI_REFERENCE.md) – REST & CLI surface
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 3 · Definitions & Acronyms
|
## 3 · Definitions & Acronyms
|
||||||
|
|
||||||
| Term | Meaning |
|
| Term | Meaning |
|
||||||
|------|---------|
|
|------|---------|
|
||||||
| **SBOM** | Software Bill of Materials |
|
| **SBOM** | Software Bill of Materials |
|
||||||
| **Delta SBOM** | Partial SBOM covering only image layers not previously analysed |
|
| **Delta SBOM** | Partial SBOM covering only image layers not previously analysed |
|
||||||
| **Registry** | Anonymous, read‑only Docker Registry v2 hosted internally |
|
| **Registry** | Anonymous, read‑only Docker Registry v2 hosted internally |
|
||||||
| **OPA** | Open Policy Agent (Rego policy engine) |
|
| **OPA** | Open Policy Agent (Rego policy engine) |
|
||||||
| **Muting Policy** | Rule that downgrades or ignores specific findings |
|
| **Muting Policy** | Rule that downgrades or ignores specific findings |
|
||||||
| **SLSA** | Supply‑chain Levels for Software Artifacts (provenance framework) |
|
| **SLSA** | Supply‑chain Levels for Software Artifacts (provenance framework) |
|
||||||
| **Rekor** | Sigstore transparency log for signatures |
|
| **Rekor** | Sigstore transparency log for signatures |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 4 · Overall System Description
|
## 4 · Overall System Description
|
||||||
|
|
||||||
The platform consists of:
|
The platform consists of:
|
||||||
|
|
||||||
* **Stella Ops Backend** – REST API, queue, policy engine, DB.
|
* **Stella Ops Backend** – REST API, queue, policy engine, DB.
|
||||||
* **StellaOps.Registry** – internal container registry for agents.
|
* **StellaOps.Registry** – internal container registry for agents.
|
||||||
* **Stella CLI** – extracts SBOMs; supports multi‑format & delta.
|
* **Stella CLI** – extracts SBOMs; supports multi‑format & delta.
|
||||||
* **Zastava Agent** – enforcement hook for admission‑control scenarios.
|
* **Zastava Agent** – enforcement hook for admission‑control scenarios.
|
||||||
* **Web UI** – React/Next.js SPA consuming backend APIs.
|
* **Web UI** – Angular 17 SPA consuming backend APIs.
|
||||||
* **Plug‑ins** – hot‑load binaries extending scanners, attestations, etc.
|
* **Plug‑ins** – hot‑load binaries extending scanners, attestations, etc.
|
||||||
|
|
||||||
All services run in Docker Compose or Kubernetes with optional Internet
|
All services run in Docker Compose or Kubernetes with optional Internet
|
||||||
access.
|
access.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 5 · Functional Requirements (FR)
|
## 5 · Functional Requirements (FR)
|
||||||
|
|
||||||
### 5.1 Core Scanning
|
### 5.1 Core Scanning
|
||||||
|
|
||||||
| ID | Requirement | Priority | Verification |
|
| ID | Requirement | Priority | Verification |
|
||||||
|----|-------------|----------|--------------|
|
|----|-------------|----------|--------------|
|
||||||
| F‑1 | System SHALL ingest **Trivy‑JSON, SPDX‑JSON, CycloneDX‑JSON** files. | MUST | UT‑SBOM‑001 |
|
| F‑1 | System SHALL ingest **Trivy‑JSON, SPDX‑JSON, CycloneDX‑JSON** files. | MUST | UT‑SBOM‑001 |
|
||||||
| F‑2 | System SHALL **auto‑detect** SBOM type when `sbomType` param omitted. | MUST | UT‑SBOM‑002 |
|
| F‑2 | System SHALL **auto‑detect** SBOM type when `sbomType` param omitted. | MUST | UT‑SBOM‑002 |
|
||||||
| F‑3 | System SHALL **cache analysed layers** and reuse them in subsequent scans. | MUST | IT‑CACHE‑001 |
|
| F‑3 | System SHALL **cache analysed layers** and reuse them in subsequent scans. | MUST | IT‑CACHE‑001 |
|
||||||
| F‑4 | System SHALL **enforce a soft limit of {{ quota_token }} scans per token per UTC day**. | MUST | IT‑QUOTA‑001 |
|
| F‑4 | System SHALL **enforce a soft limit of {{ quota_token }} scans per token per UTC day**. | MUST | IT‑QUOTA‑001 |
|
||||||
| F‑4a | Remaining quota SHALL be **persisted in Redis** under key `quota:<token>:<yyyy‑mm‑dd>`. | MUST | UT‑QUOTA‑REDIS |
|
| F‑4a | Remaining quota SHALL be **persisted in Valkey** under key `quota:<token>:<yyyy‑mm‑dd>`. | MUST | UT‑QUOTA‑VALKEY |
|
||||||
| F‑4b | Exhausted quota SHALL trigger **HTTP 429** with `Retry‑After` header (UTC midnight). | MUST | IT‑QUOTA‑002 |
|
| F‑4b | Exhausted quota SHALL trigger **HTTP 429** with `Retry‑After` header (UTC midnight). | MUST | IT‑QUOTA‑002 |
|
||||||
| F‑4c | When quota is ≤ 40 % remaining, **UI banner** MUST turn yellow and show count‑down. | SHOULD | UI‑E2E‑005 |
|
| F‑4c | When quota is ≤ 40 % remaining, **UI banner** MUST turn yellow and show count‑down. | SHOULD | UI‑E2E‑005 |
|
||||||
| F‑4d | `/quota` endpoint SHALL return JSON `{"limit":{{ quota_token }} ,"remaining":N,"resetsAt":"<ISO‑8601>"}`. | SHOULD | API‑DOC‑003 |
|
| F‑4d | `/quota` endpoint SHALL return JSON `{"limit":{{ quota_token }} ,"remaining":N,"resetsAt":"<ISO‑8601>"}`. | SHOULD | API‑DOC‑003 |
|
||||||
| F‑5 | Policy engine SHALL evaluate **YAML rules** against scan results. | MUST | UT‑POL‑001 |
|
| F‑5 | Policy engine SHALL evaluate **YAML rules** against scan results. | MUST | UT‑POL‑001 |
|
||||||
| F‑6 | Hot‑pluggable .NET plug‑ins SHALL be loadable **without service restart**. | MUST | IT‑PLUGIN‑001 |
|
| F‑6 | Hot‑pluggable .NET plug‑ins SHALL be loadable **without service restart**. | MUST | IT‑PLUGIN‑001 |
|
||||||
| F‑7 | CLI (`stella scan`) SHOULD exit **non‑zero** when CVSS≥7 vulnerabilities found. | SHOULD | CL‑INT‑003 |
|
| F‑7 | CLI (`stella scan`) SHOULD exit **non‑zero** when CVSS≥7 vulnerabilities found. | SHOULD | CL‑INT‑003 |
|
||||||
| *(… all previously documented F‑8 – F‑12 rows retained unchanged …)* |
|
| *(… all previously documented F‑8 – F‑12 rows retained unchanged …)* |
|
||||||
|
|
||||||
|
|
||||||
### 5.2 Internal Docker Repository
|
### 5.2 Internal Docker Repository
|
||||||
|
|
||||||
| Ref | Requirement |
|
| Ref | Requirement |
|
||||||
|-----|-------------|
|
|-----|-------------|
|
||||||
| **FR‑REPO‑1** | Platform SHALL include **StellaOps.Registry** exposing Docker Registry v2 API (ports 5000/443). |
|
| **FR‑REPO‑1** | Platform SHALL include **StellaOps.Registry** exposing Docker Registry v2 API (ports 5000/443). |
|
||||||
| **FR‑REPO‑2** | Registry SHALL allow anonymous, *read‑only* pulls for at least three images:<br>• `stella/sbom‑builder`<br>• `stella/cli`<br>• `stella/zastava`. |
|
| **FR‑REPO‑2** | Registry SHALL allow anonymous, *read‑only* pulls for at least three images:<br>• `stella/sbom‑builder`<br>• `stella/cli`<br>• `stella/zastava`. |
|
||||||
| **FR‑REPO‑3** | Registry MAY enable optional basic‑auth without code changes. |
|
| **FR‑REPO‑3** | Registry MAY enable optional basic‑auth without code changes. |
|
||||||
|
|
||||||
### 5.3 SBOM Generation & Handling
|
### 5.3 SBOM Generation & Handling
|
||||||
|
|
||||||
| Ref | Requirement |
|
| Ref | Requirement |
|
||||||
|-----|-------------|
|
|-----|-------------|
|
||||||
| **FR‑SBOM‑1** | SBOM builder SHALL produce Trivy‑JSON **and** at least one additional format: SPDX‑JSON and CycloneDX‑JSON. |
|
| **FR‑SBOM‑1** | SBOM builder SHALL produce Trivy‑JSON **and** at least one additional format: SPDX‑JSON and CycloneDX‑JSON. |
|
||||||
| **FR‑SBOM‑2** | For every generated SBOM, builder SHALL create a side‑car file `<image>.sbom.type` containing the format identifier. |
|
| **FR‑SBOM‑2** | For every generated SBOM, builder SHALL create a side‑car file `<image>.sbom.type` containing the format identifier. |
|
||||||
| **FR‑SBOM‑3** | Stella CLI SHALL read the `.sbom.type` file and include `sbomType` parameter when uploading. |
|
| **FR‑SBOM‑3** | Stella CLI SHALL read the `.sbom.type` file and include `sbomType` parameter when uploading. |
|
||||||
| **FR‑SBOM‑4** | Backend SHALL auto‑detect SBOM type when parameter is missing. |
|
| **FR‑SBOM‑4** | Backend SHALL auto‑detect SBOM type when parameter is missing. |
|
||||||
| **FR‑SBOM‑5** | UI Settings SHALL expose a dropdown to select default SBOM format (system‑wide fallback). |
|
| **FR‑SBOM‑5** | UI Settings SHALL expose a dropdown to select default SBOM format (system‑wide fallback). |
|
||||||
|
|
||||||
#### 5.3.1 Delta SBOM (layer reuse)
|
#### 5.3.1 Delta SBOM (layer reuse)
|
||||||
|
|
||||||
| Ref | Requirement |
|
| Ref | Requirement |
|
||||||
|-----|-------------|
|
|-----|-------------|
|
||||||
| **FR‑DELTA‑1** | Builder SHALL compute SHA256 digests of each image layer and POST array to `/layers/missing`; response time ≤ 20 ms (P95). |
|
| **FR‑DELTA‑1** | Builder SHALL compute SHA256 digests of each image layer and POST array to `/layers/missing`; response time ≤ 20 ms (P95). |
|
||||||
| **FR‑DELTA‑2** | Builder SHALL generate SBOM **only** for layers returned as “missing”. |
|
| **FR‑DELTA‑2** | Builder SHALL generate SBOM **only** for layers returned as “missing”. |
|
||||||
| **FR‑DELTA‑3** | End‑to‑end warm scan time (image differing by ≤ 2 layers) SHALL be ≤ 1 s (P95). |
|
| **FR‑DELTA‑3** | End‑to‑end warm scan time (image differing by ≤ 2 layers) SHALL be ≤ 1 s (P95). |
|
||||||
|
|
||||||
### 5.4 Policy as Code (Muting & Expiration)
|
### 5.4 Policy as Code (Muting & Expiration)
|
||||||
|
|
||||||
| Ref | Requirement |
|
| Ref | Requirement |
|
||||||
|-----|-------------|
|
|-----|-------------|
|
||||||
| **FR‑POLICY‑1** | Backend SHALL store policies as YAML by default, convertible to Rego for advanced use‑cases. |
|
| **FR‑POLICY‑1** | Backend SHALL store policies as YAML by default, convertible to Rego for advanced use‑cases. |
|
||||||
| **FR‑POLICY‑2** | Each policy change SHALL create an immutable history record (timestamp, actor, diff). |
|
| **FR‑POLICY‑2** | Each policy change SHALL create an immutable history record (timestamp, actor, diff). |
|
||||||
| **FR‑POLICY‑3** | REST endpoints `/policy/import`, `/policy/export`, `/policy/validate` SHALL accept YAML or Rego payloads. |
|
| **FR‑POLICY‑3** | REST endpoints `/policy/import`, `/policy/export`, `/policy/validate` SHALL accept YAML or Rego payloads. |
|
||||||
| **FR‑POLICY‑4** | Web UI Policies tab SHALL provide Monaco editor with linting for YAML and Rego. |
|
| **FR‑POLICY‑4** | Web UI Policies tab SHALL provide Monaco editor with linting for YAML and Rego. |
|
||||||
| **FR‑POLICY‑5** | **StellaOps.MutePolicies** module SHALL expose CLI `stella policies apply --file scan‑policy.yaml`. |
|
| **FR‑POLICY‑5** | **StellaOps.MutePolicies** module SHALL expose CLI `stella policies apply --file scan‑policy.yaml`. |
|
||||||
|
|
||||||
### 5.5 SLSA Attestations & Rekor (TODO > 6 mo)
|
### 5.5 SLSA Attestations & Rekor (TODO > 6 mo)
|
||||||
|
|
||||||
| Ref | Requirement |
|
| Ref | Requirement |
|
||||||
|-----|-------------|
|
|-----|-------------|
|
||||||
| **FR‑SLSA‑1** | **TODO** – Generate provenance in SLSA‑Provenance v0.2 for each SBOM. |
|
| **FR‑SLSA‑1** | **TODO** – Generate provenance in SLSA‑Provenance v0.2 for each SBOM. |
|
||||||
| **FR‑REKOR‑1** | **TODO** – Sign SBOM hashes and upload to local Rekor mirror; verify during scan. |
|
| **FR‑REKOR‑1** | **TODO** – Sign SBOM hashes and upload to local Rekor mirror; verify during scan. |
|
||||||
|
|
||||||
### 5.6 CLI & API Interface
|
### 5.6 CLI & API Interface
|
||||||
|
|
||||||
| Ref | Requirement |
|
| Ref | Requirement |
|
||||||
|-----|-------------|
|
|-----|-------------|
|
||||||
| **FR‑CLI‑1** | CLI `stella scan` SHALL accept `--sbom-type {trivy,spdx,cyclonedx,auto}`. |
|
| **FR‑CLI‑1** | CLI `stella scan` SHALL accept `--sbom-type {trivy,spdx,cyclonedx,auto}`. |
|
||||||
| **FR‑API‑1** | API `/scan` SHALL accept `sbomType` query/body field (optional). |
|
| **FR‑API‑1** | API `/scan` SHALL accept `sbomType` query/body field (optional). |
|
||||||
| **FR‑API‑2** | API `/layers/missing` SHALL accept JSON array of digests and return JSON array of missing digests. |
|
| **FR‑API‑2** | API `/layers/missing` SHALL accept JSON array of digests and return JSON array of missing digests. |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 6 · Non‑Functional Requirements (NFR)
|
## 6 · Non‑Functional Requirements (NFR)
|
||||||
|
|
||||||
| Ref | Category | Requirement |
|
| Ref | Category | Requirement |
|
||||||
|-----|----------|-------------|
|
|-----|----------|-------------|
|
||||||
| **NFR‑PERF‑1** | Performance | P95 cold scan ≤ 5 s; warm ≤ 1 s (see **FR‑DELTA‑3**). |
|
| **NFR‑PERF‑1** | Performance | P95 cold scan ≤ 5 s; warm ≤ 1 s (see **FR‑DELTA‑3**). |
|
||||||
| **NFR‑PERF‑2** | Throughput | System shall sustain 60 concurrent scans on 8‑core node without queue depth >10. |
|
| **NFR‑PERF‑2** | Throughput | System shall sustain 60 concurrent scans on 8‑core node without queue depth >10. |
|
||||||
| **NFR‑AVAIL‑1** | Availability | All services shall start offline; any Internet call must be optional. |
|
| **NFR‑AVAIL‑1** | Availability | All services shall start offline; any Internet call must be optional. |
|
||||||
| **NFR-SCAL-1** | Scalability | Horizontal scaling via Kubernetes replicas for backend, Redis Sentinel, PostgreSQL cluster. |
|
| **NFR-SCAL-1** | Scalability | Horizontal scaling via Kubernetes replicas for backend, Valkey cluster, PostgreSQL cluster. |
|
||||||
| **NFR‑SEC‑1** | Security | All inter‑service traffic shall use TLS or localhost sockets. |
|
| **NFR‑SEC‑1** | Security | All inter‑service traffic shall use TLS or localhost sockets. |
|
||||||
| **NFR‑COMP‑1** | Compatibility | Platform shall run on x86‑64 Linux kernel ≥ 5.10; Windows agents (TODO > 6 mo) must support Server 2019+. |
|
| **NFR‑COMP‑1** | Compatibility | Platform shall run on x86‑64 Linux kernel ≥ 5.10; Windows agents (TODO > 6 mo) must support Server 2019+. |
|
||||||
| **NFR‑I18N‑1** | Internationalisation | UI must support EN and at least one additional locale (Cyrillic). |
|
| **NFR‑I18N‑1** | Internationalisation | UI must support EN and at least one additional locale (Cyrillic). |
|
||||||
| **NFR‑OBS‑1** | Observability | Export Prometheus metrics for scan duration, queue length, policy eval duration. |
|
| **NFR‑OBS‑1** | Observability | Export Prometheus metrics for scan duration, queue length, policy eval duration. |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 7 Acceptance Criteria <a id="7-acceptance-criteria"></a>
|
## 7 Acceptance Criteria <a id="7-acceptance-criteria"></a>
|
||||||
|
|
||||||
1. Issue {{ quota_token }} `/scan` calls; next returns random slow down and `Retry‑After`.
|
1. Issue {{ quota_token }} `/scan` calls; next returns random slow down and `Retry‑After`.
|
||||||
2. Redis failure during test → API returns **0 remaining** & warns in logs.
|
2. Valkey failure during test → API returns **0 remaining** & warns in logs.
|
||||||
3. UI banner activates at 133 remaining; clears next UTC midnight.
|
3. UI banner activates at 133 remaining; clears next UTC midnight.
|
||||||
|
|
||||||
---
|
---
|
||||||
## 8 · System Interfaces
|
## 8 · System Interfaces
|
||||||
|
|
||||||
### 8.1 External APIs
|
### 8.1 External APIs
|
||||||
|
|
||||||
*(This is the complete original table, plus new `/quota` row.)*
|
*(This is the complete original table, plus new `/quota` row.)*
|
||||||
|
|
||||||
| Path | Method | Auth | Quota | Description |
|
| Path | Method | Auth | Quota | Description |
|
||||||
|------|--------|------|-------|-------------|
|
|------|--------|------|-------|-------------|
|
||||||
| `/scan` | POST | Bearer | ✅ | Submit SBOM or `imageRef` for scanning. |
|
| `/scan` | POST | Bearer | ✅ | Submit SBOM or `imageRef` for scanning. |
|
||||||
| `/quota` | GET | Bearer | ❌ | Return remaining quota for current token. |
|
| `/quota` | GET | Bearer | ❌ | Return remaining quota for current token. |
|
||||||
| `/policy/rules` | GET/PUT | Bearer+RBAC | ❌ | CRUD YAML or Rego policies. |
|
| `/policy/rules` | GET/PUT | Bearer+RBAC | ❌ | CRUD YAML or Rego policies. |
|
||||||
| `/plugins` | POST/GET | Bearer+Admin | ❌ | Upload or list plug‑ins. |
|
| `/plugins` | POST/GET | Bearer+Admin | ❌ | Upload or list plug‑ins. |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
GET /quota
|
GET /quota
|
||||||
Authorization: Bearer <token>
|
Authorization: Bearer <token>
|
||||||
|
|
||||||
200 OK
|
200 OK
|
||||||
{
|
{
|
||||||
"limit": {{ quota_token }},
|
"limit": {{ quota_token }},
|
||||||
"remaining": 121,
|
"remaining": 121,
|
||||||
"resetsAt": "2025-07-14T23:59:59Z"
|
"resetsAt": "2025-07-14T23:59:59Z"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## 9 · Assumptions & Constraints
|
## 9 · Assumptions & Constraints
|
||||||
|
|
||||||
* Hardware reference: 8 vCPU, 8 GB RAM, NVMe SSD.
|
* Hardware reference: 8 vCPU, 8 GB RAM, NVMe SSD.
|
||||||
* PostgreSQL and Redis run co-located unless horizontal scaling enabled.
|
* PostgreSQL and Valkey run co-located unless horizontal scaling enabled.
|
||||||
* All docker images tagged `latest` are immutable (CI process locks digests).
|
* All docker images tagged `latest` are immutable (CI process locks digests).
|
||||||
* Rego evaluation runs in embedded OPA Go‑library (no external binary).
|
* Rego evaluation runs in embedded OPA Go‑library (no external binary).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 10 · Future Work (Beyond 12 Months)
|
## 10 · Future Work (Beyond 12 Months)
|
||||||
|
|
||||||
* Rekor transparency log cross‑cluster replication.
|
* Rekor transparency log cross‑cluster replication.
|
||||||
* AI‑assisted false‑positive triage plug‑in.
|
* AI‑assisted false‑positive triage plug‑in.
|
||||||
* Cluster‑wide injection for live runtime scanning.
|
* Cluster‑wide injection for live runtime scanning.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 11 · Revision History
|
## 11 · Revision History
|
||||||
|
|
||||||
| Version | Date | Notes |
|
| Version | Date | Notes |
|
||||||
|---------|------|-------|
|
|---------|------|-------|
|
||||||
| **v1.2** | 11‑Jul‑2025 | Commercial references removed; plug‑in contract (§ 3.3) and new NFR categories added; added User Classes & Traceability. |
|
| **v1.2** | 11‑Jul‑2025 | Commercial references removed; plug‑in contract (§ 3.3) and new NFR categories added; added User Classes & Traceability. |
|
||||||
| v1.1 | 11‑Jul‑2025 | Split out RU‑specific items; OSS scope |
|
| v1.1 | 11‑Jul‑2025 | Split out RU‑specific items; OSS scope |
|
||||||
| v1.0 | 09‑Jul‑2025 | Original unified SRS |
|
| v1.0 | 09‑Jul‑2025 | Original unified SRS |
|
||||||
|
|
||||||
*(End of System Requirements Specification v1.2‑core)*
|
*(End of System Requirements Specification v1.2‑core)*
|
||||||
|
|||||||
@@ -47,20 +47,20 @@ Approval is recorded via Git forge review or a signed commit trailer
|
|||||||
|
|
||||||
## 4 · Release authority & provenance 🔏
|
## 4 · Release authority & provenance 🔏
|
||||||
|
|
||||||
* Every tag is **co‑signed by at least one Security Maintainer**.
|
* Every tag is **co‑signed by at least one Security Maintainer**.
|
||||||
* CI emits a **signed SPDX SBOM** + **Cosign provenance**.
|
* CI emits a **signed SPDX SBOM** + **Cosign provenance**.
|
||||||
* Release cadence is fixed – see [public Road‑map](05_ROADMAP.md).
|
* Release cadence is fixed – see [Release Engineering Playbook](13_RELEASE_ENGINEERING_PLAYBOOK.md).
|
||||||
* Security fixes may create out‑of‑band `x.y.z‑hotfix` tags.
|
* Security fixes may create out‑of‑band `x.y.z‑hotfix` tags.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 5 · Escalation lanes 🚦
|
## 5 · Escalation lanes 🚦
|
||||||
|
|
||||||
| Situation | Escalation |
|
| Situation | Escalation |
|
||||||
|-----------|------------|
|
|-----------|------------|
|
||||||
| Technical deadlock | **Maintainer Summit** (recorded & published) |
|
| Technical deadlock | **Maintainer Summit** (recorded & published) |
|
||||||
| Security bug | Follow [Security Policy](13_SECURITY_POLICY.md) |
|
| Security bug | Follow [Security Policy](13_SECURITY_POLICY.md) |
|
||||||
| Code of Conduct violation | See `12_CODE_OF_CONDUCT.md` escalation ladder |
|
| Code of Conduct violation | See `12_CODE_OF_CONDUCT.md` escalation ladder |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -90,4 +90,4 @@ section directly.)*
|
|||||||
| `@alice` | Core scanner • Security | 2025‑04 |
|
| `@alice` | Core scanner • Security | 2025‑04 |
|
||||||
| `@bob` | UI • Docs | 2025‑06 |
|
| `@bob` | UI • Docs | 2025‑06 |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -82,22 +82,22 @@ See `docs/24_OFFLINE_KIT.md` for packaging and offline verification workflows.
|
|||||||
## Deploy and Install References
|
## Deploy and Install References
|
||||||
|
|
||||||
- Deployment configuration and health checks: `docs/deploy/console.md`.
|
- Deployment configuration and health checks: `docs/deploy/console.md`.
|
||||||
- Container install recipes: `docs/install/docker.md`.
|
- Container install recipes: `docs/operations/console-docker-install.md`.
|
||||||
|
|
||||||
## Detailed References
|
## Detailed References
|
||||||
|
|
||||||
Operator-facing deep dives (Console):
|
Operator-facing deep dives (Console):
|
||||||
|
|
||||||
- `docs/console/airgap.md`
|
- `docs/console/airgap.md`
|
||||||
- `docs/console/admin-tenants.md`
|
- `docs/console/admin-tenants.md`
|
||||||
- `docs/console/forensics.md`
|
- `docs/console/forensics.md`
|
||||||
- `docs/console/observability.md`
|
- `docs/console/observability.md`
|
||||||
|
|
||||||
UX and interaction contracts:
|
UX and interaction contracts:
|
||||||
|
|
||||||
- `docs/ux/TRIAGE_UX_GUIDE.md`
|
- `docs/ux/TRIAGE_UX_GUIDE.md`
|
||||||
|
|
||||||
## Related Docs
|
## Related Docs
|
||||||
|
|
||||||
- `docs/16_VEX_CONSENSUS_GUIDE.md`
|
- `docs/16_VEX_CONSENSUS_GUIDE.md`
|
||||||
- `docs/20_VULNERABILITY_EXPLORER_GUIDE.md`
|
- `docs/20_VULNERABILITY_EXPLORER_GUIDE.md`
|
||||||
|
|||||||
@@ -461,8 +461,8 @@ The scanner enforces the same fair‑use limits offline:
|
|||||||
* **Free JWT:** {{ quota\_token }} scans per UTC day
|
* **Free JWT:** {{ quota\_token }} scans per UTC day
|
||||||
|
|
||||||
Soft reminder at 200 scans; throttle above the ceiling but **never block**.
|
Soft reminder at 200 scans; throttle above the ceiling but **never block**.
|
||||||
See the detailed rules in
|
See the quota enforcement flow in
|
||||||
[`33_333_QUOTA_OVERVIEW.md`](33_333_QUOTA_OVERVIEW.md).
|
[`30_QUOTA_ENFORCEMENT_FLOW1.md`](30_QUOTA_ENFORCEMENT_FLOW1.md).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# Legal FAQ — Free‑Tier Quota & AGPL Compliance
|
# Legal FAQ — Free‑Tier Quota & AGPL Compliance
|
||||||
|
|
||||||
> **Operational behaviour (limits, counters, delays) is documented in
|
> **Operational behaviour (limits, counters, delays) is documented in
|
||||||
> [`33_333_QUOTA_OVERVIEW.md`](33_333_QUOTA_OVERVIEW.md).**
|
> [`30_QUOTA_ENFORCEMENT_FLOW1.md`](30_QUOTA_ENFORCEMENT_FLOW1.md).**
|
||||||
> This page covers only the legal aspects of offering Stella Ops as a
|
> This page covers only the legal aspects of offering Stella Ops as a
|
||||||
> service or embedding it into another product while the free‑tier limits are
|
> service or embedding it into another product while the free‑tier limits are
|
||||||
> in place.
|
> in place.
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Quota Enforcement — Flow Diagram (rev 2.1)
|
# Quota Enforcement — Flow Diagram (rev 2.1)
|
||||||
|
|
||||||
> **Scope** – this document explains *how* the free‑tier limits are enforced
|
> **Scope** – this document explains *how* the free‑tier limits are enforced
|
||||||
> inside the scanner service. For policy rationale and legal aspects see
|
> inside the scanner service. For policy rationale and legal aspects, see
|
||||||
> [`33_333_QUOTA_OVERVIEW.md`](33_333_QUOTA_OVERVIEW.md).
|
> [`29_LEGAL_FAQ_QUOTA.md`](29_LEGAL_FAQ_QUOTA.md).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -26,10 +26,10 @@
|
|||||||
sequenceDiagram
|
sequenceDiagram
|
||||||
participant C as Client
|
participant C as Client
|
||||||
participant API as Scanner API
|
participant API as Scanner API
|
||||||
participant REDIS as Redis (quota)
|
participant VALKEY as Valkey (quota)
|
||||||
C->>API: /scan
|
C->>API: /scan
|
||||||
API->>REDIS: INCR quota:<key>
|
API->>VALKEY: INCR quota:<key>
|
||||||
REDIS-->>API: new_count
|
VALKEY-->>API: new_count
|
||||||
alt new_count ≤ L_active
|
alt new_count ≤ L_active
|
||||||
API-->>C: 202 Accepted (no delay)
|
API-->>C: 202 Accepted (no delay)
|
||||||
else new_count ≤ L_active + 30
|
else new_count ≤ L_active + 30
|
||||||
@@ -45,7 +45,7 @@ sequenceDiagram
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 2 · Redis key layout
|
## 2 · Valkey key layout
|
||||||
|
|
||||||
| Key pattern | TTL | Description |
|
| Key pattern | TTL | Description |
|
||||||
| ---------------------- | ---- | --------------------------------- |
|
| ---------------------- | ---- | --------------------------------- |
|
||||||
@@ -53,7 +53,7 @@ sequenceDiagram
|
|||||||
| `quota:tid:<sha256>` | 24 h | Token quota per *hashed* token‑ID |
|
| `quota:tid:<sha256>` | 24 h | Token quota per *hashed* token‑ID |
|
||||||
| `quota:ip:<sha256>:ts` | 24 h | First‑seen timestamp (ISO 8601) |
|
| `quota:ip:<sha256>:ts` | 24 h | First‑seen timestamp (ISO 8601) |
|
||||||
|
|
||||||
Keys share a common TTL for efficient mass expiry via `redis-cli --scan`.
|
Keys share a common TTL for efficient mass expiry via `valkey-cli --scan`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -405,7 +405,7 @@ docker compose -f docker-compose.dev.yaml down
|
|||||||
|
|
||||||
# 2. Remove database volumes
|
# 2. Remove database volumes
|
||||||
docker volume rm compose_postgres-data
|
docker volume rm compose_postgres-data
|
||||||
docker volume rm compose_mongo-data
|
docker volume rm compose_valkey-data
|
||||||
|
|
||||||
# 3. Restart platform (will recreate volumes and databases)
|
# 3. Restart platform (will recreate volumes and databases)
|
||||||
docker compose -f docker-compose.dev.yaml up -d
|
docker compose -f docker-compose.dev.yaml up -d
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ This directory contains documentation that has been superseded, deprecated, or c
|
|||||||
| Directory | Reason | Canonical Location |
|
| Directory | Reason | Canonical Location |
|
||||||
|-----------|--------|-------------------|
|
|-----------|--------|-------------------|
|
||||||
| `orchestrator-legacy/` | Parallel directory consolidated | `docs/modules/orchestrator/` |
|
| `orchestrator-legacy/` | Parallel directory consolidated | `docs/modules/orchestrator/` |
|
||||||
|
| `stubs/` | Empty placeholder files archived | N/A |
|
||||||
|
|
||||||
## Policy
|
## Policy
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@
|
|||||||
# ─────────────────────────────────────────────────────────────────────────────
|
# ─────────────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
dotnet: "10 LTS" # Runs on .NET 10 (LTS channel)
|
dotnet: "10 LTS" # Runs on .NET 10 (LTS channel)
|
||||||
angular: "20" # Front‑end framework major
|
angular: "17" # Front‑end framework major (17.3.x)
|
||||||
quota_anon: 33 # Anonymous daily scans
|
quota_anon: 33 # Anonymous daily scans
|
||||||
quota_token: 333 # Daily scans with free JWT
|
quota_token: 333 # Daily scans with free JWT
|
||||||
slowdown: "5–60 s" # Delay window after exceeding quota
|
slowdown: "5–60 s" # Delay window after exceeding quota
|
||||||
|
|||||||
@@ -10,4 +10,4 @@ The Aggregation-Only Contract keeps ingestion services deterministic and policy-
|
|||||||
|
|
||||||
For detailed roles and ownership boundaries, see `AGENTS.md` at the repo root and the module-specific dossiers under `docs/modules/<module>/architecture.md`.
|
For detailed roles and ownership boundaries, see `AGENTS.md` at the repo root and the module-specific dossiers under `docs/modules/<module>/architecture.md`.
|
||||||
|
|
||||||
Need the full contract? Read the [Aggregation-Only Contract reference](../ingestion/aggregation-only-contract.md) for schemas, error codes, and migration guidance.
|
Need the full contract? Read the [Aggregation-Only Contract reference](aggregation-only-contract.md) for schemas, error codes, and migration guidance.
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
> **Audience:** Concelier/Excititor service owners, Platform guild, QA
|
> **Audience:** Concelier/Excititor service owners, Platform guild, QA
|
||||||
|
|
||||||
The Aggregation-Only Contract (AOC) guard library enforces the canonical ingestion
|
The Aggregation-Only Contract (AOC) guard library enforces the canonical ingestion
|
||||||
rules described in `docs/ingestion/aggregation-only-contract.md`. Service owners
|
rules described in `docs/aoc/aggregation-only-contract.md`. Service owners
|
||||||
should use the guard whenever raw advisory or VEX payloads are accepted so that
|
should use the guard whenever raw advisory or VEX payloads are accepted so that
|
||||||
forbidden fields are rejected long before they reach PostgreSQL.
|
forbidden fields are rejected long before they reach PostgreSQL.
|
||||||
|
|
||||||
|
|||||||
@@ -539,7 +539,7 @@ Returns rule hit sequence:
|
|||||||
- `policy.run.completed` – emitted with `runId`, `policyId`, `mode`, `stats`, `determinismHash`.
|
- `policy.run.completed` – emitted with `runId`, `policyId`, `mode`, `stats`, `determinismHash`.
|
||||||
- `policy.run.failed` – includes error code, retry count, guidance.
|
- `policy.run.failed` – includes error code, retry count, guidance.
|
||||||
- `policy.lifecycle.*` – mirrored from lifecycle APIs (see [Lifecycle guide](../policy/lifecycle.md)).
|
- `policy.lifecycle.*` – mirrored from lifecycle APIs (see [Lifecycle guide](../policy/lifecycle.md)).
|
||||||
- Webhook registration occurs via `/api/policy/webhooks` (future work, reserved). For now, integrate with Notifier streams documented in `/docs/notifications/*`.
|
- Webhook registration occurs via `/api/policy/webhooks` (future work, reserved). For now, integrate with Notifier streams documented in `/docs/modules/notify/`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -19,13 +19,13 @@ flowchart LR
|
|||||||
identity[IIdentityProviderPlugin
|
identity[IIdentityProviderPlugin
|
||||||
(password & bootstrap flows)]
|
(password & bootstrap flows)]
|
||||||
store[StandardUserCredentialStore
|
store[StandardUserCredentialStore
|
||||||
(Mongo collections)]
|
(PostgreSQL auth schema)]
|
||||||
capability[Capability Metadata
|
capability[Capability Metadata
|
||||||
(password, bootstrap, clientProvisioning)]
|
(password, bootstrap, clientProvisioning)]
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph External["External Systems"]
|
subgraph External["External Systems"]
|
||||||
mongo[(MongoDB cluster
|
postgres[(PostgreSQL cluster
|
||||||
credential + lockout state)]
|
credential + lockout state)]
|
||||||
audit[(Audit Sink / Event Bus)]
|
audit[(Audit Sink / Event Bus)]
|
||||||
secrets[Offline Secrets Bundle
|
secrets[Offline Secrets Bundle
|
||||||
@@ -40,7 +40,7 @@ credential + lockout state)]
|
|||||||
registrar --> identity
|
registrar --> identity
|
||||||
identity --> store
|
identity --> store
|
||||||
identity --> audit
|
identity --> audit
|
||||||
store --> mongo
|
store --> postgres
|
||||||
options --> secrets
|
options --> secrets
|
||||||
secrets --> registrar
|
secrets --> registrar
|
||||||
api --> identity
|
api --> identity
|
||||||
|
|||||||
@@ -76,7 +76,7 @@
|
|||||||
</g>
|
</g>
|
||||||
<g class="node-small">
|
<g class="node-small">
|
||||||
<rect x="690" y="170" width="220" height="46" rx="12" ry="12" />
|
<rect x="690" y="170" width="220" height="46" rx="12" ry="12" />
|
||||||
<text x="700" y="198">MongoDB cluster</text>
|
<text x="700" y="198">PostgreSQL cluster</text>
|
||||||
<text class="annotation" x="700" y="216">credential & lockout state</text>
|
<text class="annotation" x="700" y="216">credential & lockout state</text>
|
||||||
</g>
|
</g>
|
||||||
<g class="node-small">
|
<g class="node-small">
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 5.0 KiB |
@@ -131,7 +131,7 @@
|
|||||||
"security-ops"
|
"security-ops"
|
||||||
],
|
],
|
||||||
"policy_links": [
|
"policy_links": [
|
||||||
"docs/uncertainty/README.md"
|
"docs/reachability/uncertainty-entropy.md"
|
||||||
],
|
],
|
||||||
"uncertainty_gate": "U2-medium"
|
"uncertainty_gate": "U2-medium"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ Status key:
|
|||||||
| UI capability | CLI command(s) | Status | Notes / Tasks |
|
| UI capability | CLI command(s) | Status | Notes / Tasks |
|
||||||
|---------------|----------------|--------|---------------|
|
|---------------|----------------|--------|---------------|
|
||||||
| Login / token cache status (`/console/profile`) | `stella auth login`, `stella auth status`, `stella auth whoami` | ✅ Available | Command definitions in `CommandFactory.BuildAuthCommand`. |
|
| Login / token cache status (`/console/profile`) | `stella auth login`, `stella auth status`, `stella auth whoami` | ✅ Available | Command definitions in `CommandFactory.BuildAuthCommand`. |
|
||||||
| Fresh-auth challenge for sensitive actions | `stella auth fresh-auth` | ✅ Available | Referenced in `docs/15_UI_GUIDE.md` (Admin). |
|
| Fresh-auth challenge for sensitive actions | `stella auth fresh-auth` | ✅ Available | Referenced in `docs/15_UI_GUIDE.md` (Admin). |
|
||||||
| Tenant switcher (UI shell) | `--tenant` flag across CLI commands | ✅ Available | All multi-tenant commands require explicit `--tenant`. |
|
| Tenant switcher (UI shell) | `--tenant` flag across CLI commands | ✅ Available | All multi-tenant commands require explicit `--tenant`. |
|
||||||
| Tenant creation / suspension | *(pending CLI)* | 🟩 Planned | No `stella auth tenant *` commands yet – track via `CLI-TEN-47-001` (scopes & tenancy). |
|
| Tenant creation / suspension | *(pending CLI)* | 🟩 Planned | No `stella auth tenant *` commands yet – track via `CLI-TEN-47-001` (scopes & tenancy). |
|
||||||
|
|
||||||
@@ -142,12 +142,12 @@ The script should emit a parity report that feeds into the Downloads workspace (
|
|||||||
|
|
||||||
## 11 · References
|
## 11 · References
|
||||||
|
|
||||||
- `docs/15_UI_GUIDE.md` – console workflow overview for parity context.
|
- `docs/15_UI_GUIDE.md` – console workflow overview for parity context.
|
||||||
- `/docs/install/docker.md` – CLI parity section for deployments.
|
- `/docs/operations/console-docker-install.md` – CLI parity section for deployments.
|
||||||
- `/docs/observability/ui-telemetry.md` – telemetry metrics referencing CLI checks.
|
- `/docs/observability/ui-telemetry.md` – telemetry metrics referencing CLI checks.
|
||||||
- `/docs/security/console-security.md` – security metrics & CLI parity expectations.
|
- `/docs/security/console-security.md` – security metrics & CLI parity expectations.
|
||||||
- `src/Cli/StellaOps.Cli/TASKS.md` – authoritative status for CLI backlog.
|
- `src/Cli/StellaOps.Cli/TASKS.md` – authoritative status for CLI backlog.
|
||||||
- `/docs/updates/2025-10-28-docs-guild.md` – coordination note for Authority/Security follow-up.
|
- `/docs/implplan/archived/updates/2025-10-28-docs-guild.md` – coordination note for Authority/Security follow-up.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -134,7 +134,7 @@ clients:
|
|||||||
|
|
||||||
## 7 · References
|
## 7 · References
|
||||||
|
|
||||||
- [Aggregation-Only Contract reference](../ingestion/aggregation-only-contract.md)
|
- [Aggregation-Only Contract reference](../aoc/aggregation-only-contract.md)
|
||||||
- [Authority scopes & tenancy](../security/authority-scopes.md)
|
- [Authority scopes & tenancy](../security/authority-scopes.md)
|
||||||
- [Observability guide](../observability/observability.md)
|
- [Observability guide](../observability/observability.md)
|
||||||
- [CLI AOC commands](../modules/cli/guides/cli-reference.md)
|
- [CLI AOC commands](../modules/cli/guides/cli-reference.md)
|
||||||
|
|||||||
@@ -81,7 +81,7 @@ Each card below pairs the headline capability with the evidence that backs it an
|
|||||||
- **Evidence:** `docs/task-packs/spec.md` and `docs/task-packs/registry.md`; architecture contract in `docs/modules/taskrunner/architecture.md`; runbook in `docs/task-packs/runbook.md`.
|
- **Evidence:** `docs/task-packs/spec.md` and `docs/task-packs/registry.md`; architecture contract in `docs/modules/taskrunner/architecture.md`; runbook in `docs/task-packs/runbook.md`.
|
||||||
- **Why it matters:** Security teams get auditable, air-gap-friendly automation with human approvals and provable provenance, reusing the same workflows online or offline.
|
- **Why it matters:** Security teams get auditable, air-gap-friendly automation with human approvals and provable provenance, reusing the same workflows online or offline.
|
||||||
|
|
||||||
## 13. Evidence-Grade Testing and Deterministic Gates (2026-12)
|
## 13. Evidence-Grade Testing and Deterministic Gates (2025-12)
|
||||||
- **What it is:** A model-driven test taxonomy and CI lanes that make determinism, offline behavior, and contract stability continuously provable.
|
- **What it is:** A model-driven test taxonomy and CI lanes that make determinism, offline behavior, and contract stability continuously provable.
|
||||||
- **Evidence:** `docs/testing/testing-strategy-models.md` and the catalog in `docs/testing/TEST_CATALOG.yml` define required test types per module; `docs/19_TEST_SUITE_OVERVIEW.md` lists the gated lanes.
|
- **Evidence:** `docs/testing/testing-strategy-models.md` and the catalog in `docs/testing/TEST_CATALOG.yml` define required test types per module; `docs/19_TEST_SUITE_OVERVIEW.md` lists the gated lanes.
|
||||||
- **Why it matters:** Regression-proof audits and predictable CI gates ensure that evidence, not assumptions, drives releases.
|
- **Why it matters:** Regression-proof audits and predictable CI gates ensure that evidence, not assumptions, drives releases.
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ Attestor moves signed evidence through the trust chain by accepting DSSE bundles
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ Authority is the platform OIDC/OAuth2 control plane that mints short-lived, send
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ CI module collects reproducible pipeline recipes for builds, tests, and release
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ The `stella` CLI is the operator-facing Swiss army knife for scans, exports, pol
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
> **Audience:** DevEx engineers, operators, and CI authors integrating the `stella` CLI with Aggregation-Only Contract (AOC) workflows.
|
> **Audience:** DevEx engineers, operators, and CI authors integrating the `stella` CLI with Aggregation-Only Contract (AOC) workflows.
|
||||||
> **Scope:** Command synopsis, options, exit codes, and offline considerations for `stella sources ingest --dry-run` and `stella aoc verify` as introduced in Sprint 19.
|
> **Scope:** Command synopsis, options, exit codes, and offline considerations for `stella sources ingest --dry-run` and `stella aoc verify` as introduced in Sprint 19.
|
||||||
|
|
||||||
Both commands are designed to enforce the AOC guardrails documented in the [aggregation-only reference](../../../ingestion/aggregation-only-contract.md) and the [architecture overview](../architecture.md). They consume Authority-issued tokens with tenant scopes and never mutate ingestion stores.
|
Both commands are designed to enforce the AOC guardrails documented in the [aggregation-only reference](../../../aoc/aggregation-only-contract.md) and the [architecture overview](../architecture.md). They consume Authority-issued tokens with tenant scopes and never mutate ingestion stores.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -416,7 +416,7 @@ Additional notes:
|
|||||||
|
|
||||||
## 5 · Related references
|
## 5 · Related references
|
||||||
|
|
||||||
- [Aggregation-Only Contract reference](../../../ingestion/aggregation-only-contract.md)
|
- [Aggregation-Only Contract reference](../../../aoc/aggregation-only-contract.md)
|
||||||
- [Architecture overview](../../platform/architecture-overview.md)
|
- [Architecture overview](../../platform/architecture-overview.md)
|
||||||
- [Console operator guide](../../../15_UI_GUIDE.md)
|
- [Console operator guide](../../../15_UI_GUIDE.md)
|
||||||
- [Authority scopes](../../authority/architecture.md)
|
- [Authority scopes](../../authority/architecture.md)
|
||||||
|
|||||||
@@ -103,7 +103,7 @@ See the [CLI Consolidation Migration Guide](../../../../cli/cli-consolidation-mi
|
|||||||
|
|
||||||
## Related Documentation
|
## Related Documentation
|
||||||
|
|
||||||
- [Aggregation-Only Contract Reference](../../../../ingestion/aggregation-only-contract.md)
|
- [Aggregation-Only Contract Reference](../../../../aoc/aggregation-only-contract.md)
|
||||||
- [CLI Reference](../cli-reference.md)
|
- [CLI Reference](../cli-reference.md)
|
||||||
- [Container Deployment Guide](../../../../deploy/containers.md)
|
- [Container Deployment Guide](../../../../deploy/containers.md)
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ Concelier ingests signed advisories from dozens of sources and converts them int
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ Concelier ingests signed advisories from dozens of sources and converts them int
|
|||||||
- Exporter packages (`StellaOps.Concelier.Exporter.*`).
|
- Exporter packages (`StellaOps.Concelier.Exporter.*`).
|
||||||
|
|
||||||
## Recent updates
|
## Recent updates
|
||||||
- **2025-11-07:** Paragraph-anchored `/advisories/{advisoryKey}/chunks` endpoint shipped for Advisory AI paragraph retrieval. Details and rollout notes live in [`../../updates/2025-11-07-concelier-advisory-chunks.md`](../../updates/2025-11-07-concelier-advisory-chunks.md).
|
- **2025-11-07:** Paragraph-anchored `/advisories/{advisoryKey}/chunks` endpoint shipped for Advisory AI paragraph retrieval. Details and rollout notes live in [`../../implplan/archived/updates/2025-11-07-concelier-advisory-chunks.md`](../../implplan/archived/updates/2025-11-07-concelier-advisory-chunks.md).
|
||||||
|
|
||||||
## Integrations & dependencies
|
## Integrations & dependencies
|
||||||
- PostgreSQL (schema `vuln`) for canonical observations and schedules.
|
- PostgreSQL (schema `vuln`) for canonical observations and schedules.
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Implementation plan — Concelier
|
# Implementation plan — Concelier
|
||||||
|
|
||||||
## Delivery timeline
|
## Delivery timeline
|
||||||
- **Phase 1 — Guardrails & schema**
|
- **Phase 1 — Guardrails & schema**
|
||||||
Stand up Mongo JSON validators for `advisory_raw` and `vex_raw`, wire the `AOCWriteGuard` repository interceptor, and seed deterministic linkset builders. Freeze legacy normalisation paths and migrate callers to the new raw schema.
|
Stand up PostgreSQL JSON schema validators for `advisory_raw` and `vex_raw`, wire the `AOCWriteGuard` repository interceptor, and seed deterministic linkset builders. Freeze legacy normalisation paths and migrate callers to the new raw schema.
|
||||||
- **Phase 2 — API & observability**
|
- **Phase 2 — API & observability**
|
||||||
Publish ingestion and verification endpoints (`POST /ingest/*`, `GET /advisories.raw`, `POST /aoc/verify`) with Authority scopes, expose telemetry (`aoc_violation_total`, guard spans, structured logs), and ensure Offline Kit packaging captures validator deployment steps.
|
Publish ingestion and verification endpoints (`POST /ingest/*`, `GET /advisories.raw`, `POST /aoc/verify`) with Authority scopes, expose telemetry (`aoc_violation_total`, guard spans, structured logs), and ensure Offline Kit packaging captures validator deployment steps.
|
||||||
- **Phase 3 — Experience polish**
|
- **Phase 3 — Experience polish**
|
||||||
@@ -10,7 +10,7 @@
|
|||||||
|
|
||||||
## Work breakdown by component
|
## Work breakdown by component
|
||||||
- **Concelier WebService & worker**
|
- **Concelier WebService & worker**
|
||||||
- Add Mongo validators and unique indexes over `(tenant, source.vendor, upstream.upstream_id, upstream.content_hash)`.
|
- Add PostgreSQL validators and unique indexes over `(tenant, source.vendor, upstream.upstream_id, upstream.content_hash)`.
|
||||||
- Implement write interceptors rejecting forbidden fields, missing provenance, or merge attempts.
|
- Implement write interceptors rejecting forbidden fields, missing provenance, or merge attempts.
|
||||||
- Deterministically compute linksets and persist canonical JSON payloads.
|
- Deterministically compute linksets and persist canonical JSON payloads.
|
||||||
- Introduce `/ingest/advisory`, `/advisories/raw*`, and `/aoc/verify` surfaces guarded by `advisory:*` and `aoc:verify` scopes.
|
- Introduce `/ingest/advisory`, `/advisories/raw*`, and `/aoc/verify` surfaces guarded by `advisory:*` and `aoc:verify` scopes.
|
||||||
@@ -34,13 +34,13 @@
|
|||||||
- Seed fixtures and run `stella aoc verify` against snapshots in pipeline gating.
|
- Seed fixtures and run `stella aoc verify` against snapshots in pipeline gating.
|
||||||
|
|
||||||
## Documentation deliverables
|
## Documentation deliverables
|
||||||
- Update `docs/ingestion/aggregation-only-contract.md` with guard invariants, schemas, error codes, and migration guidance.
|
- Update `docs/aoc/aggregation-only-contract.md` with guard invariants, schemas, error codes, and migration guidance.
|
||||||
- Refresh `docs/modules/concelier/operations/*.md` (mirror, conflict-resolution, authority audit) with validator rollouts and observability dashboards.
|
- Refresh `docs/modules/concelier/operations/*.md` (mirror, conflict-resolution, authority audit) with validator rollouts and observability dashboards.
|
||||||
- Cross-link Authority scope definitions, CLI reference, Console sources guide, and observability runbooks to the AOC guard changes.
|
- Cross-link Authority scope definitions, CLI reference, Console sources guide, and observability runbooks to the AOC guard changes.
|
||||||
- Ensure Offline Kit documentation captures validator bootstrap and verify workflows.
|
- Ensure Offline Kit documentation captures validator bootstrap and verify workflows.
|
||||||
|
|
||||||
## Acceptance criteria
|
## Acceptance criteria
|
||||||
- Mongo validators and runtime guards reject forbidden fields and missing provenance with the documented `ERR_AOC_00x` codes.
|
- PostgreSQL validators and runtime guards reject forbidden fields and missing provenance with the documented `ERR_AOC_00x` codes.
|
||||||
- Linksets and supersedes chains are deterministic; rerunning ingestion over identical payloads yields byte-identical documents.
|
- Linksets and supersedes chains are deterministic; rerunning ingestion over identical payloads yields byte-identical documents.
|
||||||
- CLI `stella aoc verify` exits non-zero on seeded violations and zero on clean datasets; Console dashboards show real-time guard status.
|
- CLI `stella aoc verify` exits non-zero on seeded violations and zero on clean datasets; Console dashboards show real-time guard status.
|
||||||
- Export Center consumes advisory datasets without relying on legacy normalised fields.
|
- Export Center consumes advisory datasets without relying on legacy normalised fields.
|
||||||
@@ -56,18 +56,18 @@
|
|||||||
- **Unit**: guard rejection paths, provenance enforcement, idempotent insertions, linkset determinism.
|
- **Unit**: guard rejection paths, provenance enforcement, idempotent insertions, linkset determinism.
|
||||||
- **Property**: fuzz upstream payloads to guarantee no forbidden fields emerge.
|
- **Property**: fuzz upstream payloads to guarantee no forbidden fields emerge.
|
||||||
- **Integration**: batch ingest (50k advisories, mixed VEX fixtures), verifying zero guard violations and consistent supersedes.
|
- **Integration**: batch ingest (50k advisories, mixed VEX fixtures), verifying zero guard violations and consistent supersedes.
|
||||||
- **Contract**: Policy Engine consumers verify raw-only reads; Export Center consumes canonical datasets.
|
- **Contract**: Policy Engine consumers verify raw-only reads; Export Center consumes canonical datasets.
|
||||||
- **End-to-end**: ingest/verify flow with CLI + Console actions to confirm observability and guard reporting.
|
- **End-to-end**: ingest/verify flow with CLI + Console actions to confirm observability and guard reporting.
|
||||||
|
|
||||||
## Definition of done
|
## Definition of done
|
||||||
- Validators deployed and verified in staging/offline environments.
|
- Validators deployed and verified in staging/offline environments.
|
||||||
- Runtime guards, CLI/Console workflows, and CI linting all active.
|
- Runtime guards, CLI/Console workflows, and CI linting all active.
|
||||||
- Observability dashboards and runbooks updated; metrics visible.
|
- Observability dashboards and runbooks updated; metrics visible.
|
||||||
- Documentation updates merged; Offline Kit instructions published.
|
- Documentation updates merged; Offline Kit instructions published.
|
||||||
- ./TASKS.md reflects status transitions; cross-module dependencies acknowledged in ../../TASKS.md.
|
- ./TASKS.md reflects status transitions; cross-module dependencies acknowledged in ../../TASKS.md.
|
||||||
|
|
||||||
## Readiness checkpoints (2025-11-25)
|
## Readiness checkpoints (2025-11-25)
|
||||||
- Sprint 110 attestation chain validated: `/internal/attestations/verify` endpoint and evidence bundle tests green (`TestResults/concelier-attestation/web.trx`, `core.trx`).
|
- Sprint 110 attestation chain validated: `/internal/attestations/verify` endpoint and evidence bundle tests green (`TestResults/concelier-attestation/web.trx`, `core.trx`).
|
||||||
- Link-Not-Merge cache + console consumption docs frozen (see `operations/lnm-cache-plan.md`, `operations/console-lnm-consumption.md`); cache headers remain deterministic.
|
- Link-Not-Merge cache + console consumption docs frozen (see `operations/lnm-cache-plan.md`, `operations/console-lnm-consumption.md`); cache headers remain deterministic.
|
||||||
- Observation events transport reviewed; backlog guardrails and NATS/air-gap guidance updated in `operations/observation-events.md`.
|
- Observation events transport reviewed; backlog guardrails and NATS/air-gap guidance updated in `operations/observation-events.md`.
|
||||||
- Next gating dependency: TaskRunner contract drop (sprint 0157 blockers) before wiring approvals/pack ingest flows into Concelier.
|
- Next gating dependency: TaskRunner contract drop (sprint 0157 blockers) before wiring approvals/pack ingest flows into Concelier.
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ _Frozen v1 (add-only) — approved 2025-11-17 for CONCELIER-LNM-21-001/002/101._
|
|||||||
- Frozen v1 as of 2025-11-17; further schema changes must go through ADR + sprint gating (CONCELIER-LNM-22x+).
|
- Frozen v1 as of 2025-11-17; further schema changes must go through ADR + sprint gating (CONCELIER-LNM-22x+).
|
||||||
- Canonical JSON Schemas + signed manifest live in `docs/modules/concelier/schemas/` (advisory observation, linkset, offline bundle). Verify with `openssl dgst -sha256 -verify schema-signing-pub.pem -signature schema.manifest.sig schema.manifest.json`.
|
- Canonical JSON Schemas + signed manifest live in `docs/modules/concelier/schemas/` (advisory observation, linkset, offline bundle). Verify with `openssl dgst -sha256 -verify schema-signing-pub.pem -signature schema.manifest.sig schema.manifest.json`.
|
||||||
|
|
||||||
## Observation document (Mongo JSON Schema excerpt)
|
## Observation document (PostgreSQL JSON Schema excerpt)
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"bsonType": "object",
|
"bsonType": "object",
|
||||||
@@ -152,11 +152,11 @@ When an advisory source publishes a revised version of an advisory:
|
|||||||
- Deterministic sort: observations sorted by `source, advisoryId, fetchedAt` before hashing.
|
- Deterministic sort: observations sorted by `source, advisoryId, fetchedAt` before hashing.
|
||||||
- Conflicts are additive only and now carry optional `sourceIds[]` to trace which upstream sources produced divergent values.
|
- Conflicts are additive only and now carry optional `sourceIds[]` to trace which upstream sources produced divergent values.
|
||||||
|
|
||||||
## Indexes (Mongo)
|
## Indexes (PostgreSQL)
|
||||||
- Observations: `{ tenantId:1, source:1, advisoryId:1, provenance.fetchedAt:-1 }` (compound for ingest); `{ provenance.sourceArtifactSha:1 }` unique to avoid dup writes.
|
- Observations: `{ tenantId:1, source:1, advisoryId:1, provenance.fetchedAt:-1 }` (compound for ingest); `{ provenance.sourceArtifactSha:1 }` unique to avoid dup writes.
|
||||||
- Linksets: `{ tenantId:1, advisoryId:1, source:1 }` unique; `{ observations:1 }` sparse for reverse lookups.
|
- Linksets: `{ tenantId:1, advisoryId:1, source:1 }` unique; `{ observations:1 }` sparse for reverse lookups.
|
||||||
|
|
||||||
## Collections
|
## Tables
|
||||||
- `advisory_observations` — raw per-source docs (immutable).
|
- `advisory_observations` — raw per-source docs (immutable).
|
||||||
- `advisory_linksets` — derived normalized aggregates with observation pointers and hashes.
|
- `advisory_linksets` — derived normalized aggregates with observation pointers and hashes.
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ See `docs/samples/lnm/observation-ghsa.json` and `docs/samples/lnm/linkset-ghsa.
|
|||||||
|
|
||||||
## Approval path
|
## Approval path
|
||||||
1) Architecture + Concelier Core review this document.
|
1) Architecture + Concelier Core review this document.
|
||||||
2) If accepted, freeze JSON Schema and roll into `src/Concelier/__Libraries/StellaOps.Concelier.Storage.Mongo` migrations.
|
2) If accepted, freeze JSON Schema and roll into `src/Concelier/__Libraries/StellaOps.Concelier.Storage.Postgres` migrations.
|
||||||
3) Update consumers (policy/CLI/export) to read from linksets only; deprecate Merge endpoints.
|
3) Update consumers (policy/CLI/export) to read from linksets only; deprecate Merge endpoints.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
# DevOps agent guide
|
# DevOps agent guide
|
||||||
|
|
||||||
## Mission
|
## Mission
|
||||||
The DevOps module captures release, deployment, and migration playbooks that keep StellaOps deterministic across environments.
|
The DevOps module captures release, deployment, and migration playbooks that keep StellaOps deterministic across environments.
|
||||||
|
|
||||||
## Advisory Handling
|
## Advisory Handling
|
||||||
- Any new/updated advisory triggers immediate doc + sprint updates (no approval).
|
- Any new/updated advisory triggers immediate doc + sprint updates (no approval).
|
||||||
- Update high-level + detailed docs; inline only short snippets; put runnable/long code in `docs/benchmarks/**` or `tests/**` (deterministic/offline) and link.
|
- Update high-level + detailed docs; inline only short snippets; put runnable/long code in `docs/benchmarks/**` or `tests/**` (deterministic/offline) and link.
|
||||||
- Add tasks + Execution Log entries in relevant `SPRINT_*.md` with doc paths/owners; add risks if schema/feed/transparency caps apply.
|
- Add tasks + Execution Log entries in relevant `SPRINT_*.md` with doc paths/owners; add risks if schema/feed/transparency caps apply.
|
||||||
- Check archived advisories; mark supersedes/extends if overlapping.
|
- Check archived advisories; mark supersedes/extends if overlapping.
|
||||||
- Defaults: hybrid reachability, deterministic/frozen feeds; act first, report after.
|
- Defaults: hybrid reachability, deterministic/frozen feeds; act first, report after.
|
||||||
|
|
||||||
## Key docs
|
## Key docs
|
||||||
- [Module README](./README.md)
|
- [Module README](./README.md)
|
||||||
@@ -24,7 +24,7 @@ The DevOps module captures release, deployment, and migration playbooks that kee
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
_Last updated: 2025-10-11_
|
_Last updated: 2025-10-11_
|
||||||
|
|
||||||
|
> **Note (2025-12):** This runbook is obsolete. MongoDB was fully removed in Sprint 4400 and replaced with PostgreSQL. The migration functionality described here was executed during the transition period and is no longer applicable. Retained for historical reference only.
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
The SemVer style migration populates the new `normalizedVersions` field on advisory documents and ensures
|
The SemVer style migration populates the new `normalizedVersions` field on advisory documents and ensures
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ This runbook describes how to promote a new release across the supported deploym
|
|||||||
| `stable` | `deploy/releases/2025.09-stable.yaml` | `deploy/helm/stellaops/values-stage.yaml`, `deploy/helm/stellaops/values-prod.yaml` | `deploy/compose/docker-compose.stage.yaml`, `deploy/compose/docker-compose.prod.yaml` |
|
| `stable` | `deploy/releases/2025.09-stable.yaml` | `deploy/helm/stellaops/values-stage.yaml`, `deploy/helm/stellaops/values-prod.yaml` | `deploy/compose/docker-compose.stage.yaml`, `deploy/compose/docker-compose.prod.yaml` |
|
||||||
| `airgap` | `deploy/releases/2025.09-airgap.yaml` | `deploy/helm/stellaops/values-airgap.yaml` | `deploy/compose/docker-compose.airgap.yaml` |
|
| `airgap` | `deploy/releases/2025.09-airgap.yaml` | `deploy/helm/stellaops/values-airgap.yaml` | `deploy/compose/docker-compose.airgap.yaml` |
|
||||||
|
|
||||||
Infrastructure components (MongoDB, MinIO, RustFS) are pinned in the release manifests and inherited by the deployment profiles. Supporting dependencies such as `nats` remain on upstream LTS tags; review `deploy/compose/*.yaml` for the authoritative set.
|
Infrastructure components (PostgreSQL, Valkey, MinIO, RustFS) are pinned in the release manifests and inherited by the deployment profiles. Supporting dependencies such as `nats` remain on upstream LTS tags; review `deploy/compose/*.yaml` for the authoritative set.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -48,8 +48,8 @@ Infrastructure components (MongoDB, MinIO, RustFS) are pinned in the release man
|
|||||||
```
|
```
|
||||||
Archive the resulting `out/offline-kit/metadata/debug-store.json` alongside the kit bundle.
|
Archive the resulting `out/offline-kit/metadata/debug-store.json` alongside the kit bundle.
|
||||||
|
|
||||||
5. **Review compatibility matrix**
|
5. **Review compatibility matrix**
|
||||||
Confirm MongoDB, MinIO, and RustFS versions in the release manifest match platform SLOs. The default targets are `mongo@sha256:c258…`, `minio@sha256:14ce…`, `rustfs:2025.10.0-edge`.
|
Confirm PostgreSQL, Valkey, MinIO, and RustFS versions in the release manifest match platform SLOs. The default targets are `postgres:16-alpine`, `valkey:8.0`, `minio@sha256:14ce…`, `rustfs:2025.10.0-edge`.
|
||||||
|
|
||||||
6. **Create a rollback bookmark**
|
6. **Create a rollback bookmark**
|
||||||
Record the current Helm revision (`helm history stellaops -n stellaops`) and compose tag (`git describe --tags`) before applying changes.
|
Record the current Helm revision (`helm history stellaops -n stellaops`) and compose tag (`git describe --tags`) before applying changes.
|
||||||
|
|||||||
@@ -1,8 +1,10 @@
|
|||||||
# Launch Cutover Runbook - Stella Ops
|
# Launch Cutover Runbook - Stella Ops
|
||||||
|
|
||||||
_Document owner: DevOps Guild (2025-10-26)_
|
_Document owner: DevOps Guild (2025-10-26)_
|
||||||
_Scope:_ Full-platform launch from staging to production for release `2025.09.2`.
|
_Scope:_ Full-platform launch from staging to production for release `2025.09.2`.
|
||||||
|
|
||||||
|
> **Note (2025-12):** This document reflects the state at initial launch. Since then, MongoDB has been fully removed (Sprint 4400) and replaced with PostgreSQL. MinIO references now use RustFS. Redis references now use Valkey. See current deployment docs in `deploy/` for up-to-date configuration.
|
||||||
|
|
||||||
## 1. Roles and Communication
|
## 1. Roles and Communication
|
||||||
|
|
||||||
| Role | Primary | Backup | Contact |
|
| Role | Primary | Backup | Contact |
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ Excititor converts heterogeneous VEX feeds into raw observations and linksets th
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -6,17 +6,17 @@ Excititor converts heterogeneous VEX feeds into raw observations and linksets th
|
|||||||
- Chunk API documentation remains blocked until CI is green and a pinned OpenAPI spec + deterministic samples are available.
|
- Chunk API documentation remains blocked until CI is green and a pinned OpenAPI spec + deterministic samples are available.
|
||||||
- Sprint tracker `docs/implplan/SPRINT_0333_0001_0001_docs_modules_excititor.md` and module `TASKS.md` mirror status.
|
- Sprint tracker `docs/implplan/SPRINT_0333_0001_0001_docs_modules_excititor.md` and module `TASKS.md` mirror status.
|
||||||
- Observability/runbook assets remain in `operations/observability.md` and `observability/` (timeline, locker manifests); dashboards stay offline-import friendly.
|
- Observability/runbook assets remain in `operations/observability.md` and `observability/` (timeline, locker manifests); dashboards stay offline-import friendly.
|
||||||
- Prior updates (2025-11-05): Link-Not-Merge readiness and consensus beta note (`../../updates/2025-11-05-excitor-consensus-beta.md`), observability guide additions, DSSE packaging guidance, and Policy/CLI follow-ups tracked in SPRINT_200.
|
- Prior updates (2025-11-05): Link-Not-Merge readiness and consensus beta note (`../../implplan/archived/updates/2025-11-05-excitor-consensus-beta.md`), observability guide additions, DSSE packaging guidance, and Policy/CLI follow-ups tracked in SPRINT_200.
|
||||||
- Link-Not-Merge readiness: release note [Excitor consensus beta](../../updates/2025-11-05-excitor-consensus-beta.md) captures how Excititor feeds power the Excititor consensus beta (sample payload in [consensus JSON](../../vex/consensus-json.md)).
|
- Link-Not-Merge readiness: release note [Excitor consensus beta](../../implplan/archived/updates/2025-11-05-excitor-consensus-beta.md) captures how Excititor feeds power the Excititor consensus beta (sample payload in [consensus JSON](../../vex/consensus-json.md)).
|
||||||
- Added [observability guide](operations/observability.md) describing the evidence metrics emitted by `EXCITITOR-AIAI-31-003` (request counters, statement histogram, signature status, guard violations) so Ops/Lens can alert on misuse.
|
- Added [observability guide](operations/observability.md) describing the evidence metrics emitted by `EXCITITOR-AIAI-31-003` (request counters, statement histogram, signature status, guard violations) so Ops/Lens can alert on misuse.
|
||||||
- README now points policy/UI teams to the upcoming consensus integration work.
|
- README now points policy/UI teams to the upcoming consensus integration work.
|
||||||
- DSSE packaging for consensus bundles and Export Center hooks are documented in the [beta release note](../../updates/2025-11-05-excitor-consensus-beta.md); operators mirroring Excititor exports must verify detached JWS artefacts (`bundle.json.jws`) alongside each bundle.
|
- DSSE packaging for consensus bundles and Export Center hooks are documented in the [beta release note](../../implplan/archived/updates/2025-11-05-excitor-consensus-beta.md); operators mirroring Excititor exports must verify detached JWS artefacts (`bundle.json.jws`) alongside each bundle.
|
||||||
- Follow-ups called out in the release note (Policy weighting knobs `POLICY-ENGINE-30-101`, CLI verb `CLI-VEX-30-002`) remain in-flight and are tracked in `/docs/implplan/SPRINT_200_documentation_process.md`.
|
- Follow-ups called out in the release note (Policy weighting knobs `POLICY-ENGINE-30-101`, CLI verb `CLI-VEX-30-002`) remain in-flight and are tracked in `/docs/implplan/SPRINT_200_documentation_process.md`.
|
||||||
|
|
||||||
## Release references
|
## Release references
|
||||||
- Consensus beta payload reference: [docs/vex/consensus-json.md](../../vex/consensus-json.md)
|
- Consensus beta payload reference: [docs/vex/consensus-json.md](../../vex/consensus-json.md)
|
||||||
- Export Center offline packaging: [docs/modules/export-center/devportal-offline.md](../export-center/devportal-offline.md)
|
- Export Center offline packaging: [docs/modules/export-center/devportal-offline.md](../export-center/devportal-offline.md)
|
||||||
- Historical release log: [docs/updates/](../../updates/)
|
- Historical release log: [docs/implplan/archived/updates/](../../implplan/archived/updates/)
|
||||||
|
|
||||||
## Responsibilities
|
## Responsibilities
|
||||||
- Fetch OpenVEX/CSAF/CycloneDX statements via restart-only connectors.
|
- Fetch OpenVEX/CSAF/CycloneDX statements via restart-only connectors.
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||||
"$id": "https://stellaops.dev/schemas/excititor/vex_raw.schema.json",
|
"$id": "https://stellaops.dev/schemas/excititor/vex_raw.schema.json",
|
||||||
"title": "Excititor VEX Raw Document",
|
"title": "Excititor VEX Raw Document",
|
||||||
|
"$comment": "Note (2025-12): The gridFsObjectId field is legacy. Since Sprint 4400, all large content is stored in PostgreSQL with RustFS. This field exists only for backward compatibility with migrated data.",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": true,
|
"additionalProperties": true,
|
||||||
"required": ["_id", "providerId", "format", "sourceUri", "retrievedAt", "digest"],
|
"required": ["_id", "providerId", "format", "sourceUri", "retrievedAt", "digest"],
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# VEX Observation Model (`vex_observations`)
|
# VEX Observation Model (`vex_observations`)
|
||||||
|
|
||||||
> Authored 2025-11-14 for Sprint 120 (`EXCITITOR-LNM-21-001`). This document is the canonical schema description for Excititor’s immutable observation records. It unblocks downstream documentation tasks (`DOCS-LNM-22-002`) and aligns the WebService/Worker data structures with Mongo persistence.
|
> Authored 2025-11-14 for Sprint 120 (`EXCITITOR-LNM-21-001`). This document is the canonical schema description for Excititor's immutable observation records. It unblocks downstream documentation tasks (`DOCS-LNM-22-002`) and aligns the WebService/Worker data structures with PostgreSQL persistence.
|
||||||
|
|
||||||
Excititor ingests heterogeneous VEX statements, normalizes them under the Aggregation-Only Contract (AOC), and persists each normalized statement as a **VEX observation**. These observations are the source of truth for:
|
Excititor ingests heterogeneous VEX statements, normalizes them under the Aggregation-Only Contract (AOC), and persists each normalized statement as a **VEX observation**. These observations are the source of truth for:
|
||||||
|
|
||||||
@@ -15,7 +15,7 @@ All observation documents are immutable. New information creates a new observati
|
|||||||
|
|
||||||
| Aspect | Value |
|
| Aspect | Value |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| Collection | `vex_observations` (Mongo) |
|
| Table | `vex_observations` (PostgreSQL) |
|
||||||
| Upstream generator | `VexObservationProjectionService` (WebService) and Worker normalization pipeline |
|
| Upstream generator | `VexObservationProjectionService` (WebService) and Worker normalization pipeline |
|
||||||
| Primary key | `{tenant, observationId}` |
|
| Primary key | `{tenant, observationId}` |
|
||||||
| Required indexes | `{tenant, vulnerabilityId}`, `{tenant, productKey}`, `{tenant, document.digest}`, `{tenant, providerId, status}` |
|
| Required indexes | `{tenant, vulnerabilityId}`, `{tenant, productKey}`, `{tenant, document.digest}`, `{tenant, providerId, status}` |
|
||||||
@@ -114,7 +114,7 @@ All observation documents are immutable. New information creates a new observati
|
|||||||
2. **Sorted collections** – arrays (`anchors`, `purls`, `cpes`) are sorted lexicographically before persistence.
|
2. **Sorted collections** – arrays (`anchors`, `purls`, `cpes`) are sorted lexicographically before persistence.
|
||||||
3. **Guard metadata** – `aoc.guardVersion` records the guard library version (`docs/aoc/guard-library.md`), enabling audits.
|
3. **Guard metadata** – `aoc.guardVersion` records the guard library version (`docs/aoc/guard-library.md`), enabling audits.
|
||||||
4. **Signatures** – only verification metadata proven by the Worker is stored; WebService never recomputes trust.
|
4. **Signatures** – only verification metadata proven by the Worker is stored; WebService never recomputes trust.
|
||||||
5. **Time normalization** – all timestamps stored as UTC ISO-8601 strings (Mongo `DateTime`).
|
5. **Time normalization** – all timestamps stored as UTC ISO-8601 strings (PostgreSQL `timestamptz`).
|
||||||
|
|
||||||
## API mapping
|
## API mapping
|
||||||
|
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ Export Center packages reproducible evidence bundles (JSON, Trivy DB, mirror) wi
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -16,8 +16,8 @@ This reference describes the Export Center API introduced in Export Center Phase
|
|||||||
- `export:download` for bundle downloads and manifests.
|
- `export:download` for bundle downloads and manifests.
|
||||||
- **Tenant context:** Provide `X-Stella-Tenant` when the token carries multiple tenants; defaults to token tenant otherwise.
|
- **Tenant context:** Provide `X-Stella-Tenant` when the token carries multiple tenants; defaults to token tenant otherwise.
|
||||||
- **Idempotency:** Mutating endpoints accept `Idempotency-Key` (UUID). Retrying with the same key returns the original result.
|
- **Idempotency:** Mutating endpoints accept `Idempotency-Key` (UUID). Retrying with the same key returns the original result.
|
||||||
- **Rate limits and quotas:** Responses include `X-Stella-Quota-Limit`, `X-Stella-Quota-Remaining`, and `X-Stella-Quota-Reset`. Exceeding quotas returns `429 Too Many Requests` with `ERR_EXPORT_QUOTA`.
|
- **Rate limits and quotas:** Responses include `X-Stella-Quota-Limit`, `X-Stella-Quota-Remaining`, and `X-Stella-Quota-Reset`. Exceeding quotas returns `429 Too Many Requests` with `ERR_EXPORT_QUOTA`.
|
||||||
- **Integrity headers (downloads):** `Digest: sha-256=<base64>`, `X-Stella-Signature: dsse-b64=<payload>`, and `X-Stella-Immutability: true` accompany bundle/manifest downloads; clients must validate before use.
|
- **Integrity headers (downloads):** `Digest: sha-256=<base64>`, `X-Stella-Signature: dsse-b64=<payload>`, and `X-Stella-Immutability: true` accompany bundle/manifest downloads; clients must validate before use.
|
||||||
- **Content negotiation:** Requests and responses use `application/json; charset=utf-8` unless otherwise stated. Downloads stream binary content with profile-specific media types.
|
- **Content negotiation:** Requests and responses use `application/json; charset=utf-8` unless otherwise stated. Downloads stream binary content with profile-specific media types.
|
||||||
- **SSE:** Event streams set `Content-Type: text/event-stream` and keep connections alive with comment heartbeats every 15 seconds.
|
- **SSE:** Event streams set `Content-Type: text/event-stream` and keep connections alive with comment heartbeats every 15 seconds.
|
||||||
|
|
||||||
@@ -101,29 +101,29 @@ Scopes: export:profile:manage
|
|||||||
**Request**
|
**Request**
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"profileId": "prof-airgap-mirror",
|
"profileId": "prof-airgap-mirror",
|
||||||
"name": "Airgap Mirror Weekly",
|
"name": "Airgap Mirror Weekly",
|
||||||
"kind": "mirror",
|
"kind": "mirror",
|
||||||
"variant": "full",
|
"variant": "full",
|
||||||
"include": ["advisories", "vex", "sboms", "policy"],
|
"include": ["advisories", "vex", "sboms", "policy"],
|
||||||
"distribution": ["http", "object"],
|
"distribution": ["http", "object"],
|
||||||
"encryption": {
|
"encryption": {
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"recipientKeys": ["age1tenantkey..."],
|
"recipientKeys": ["age1tenantkey..."],
|
||||||
"strict": false
|
"strict": false
|
||||||
},
|
},
|
||||||
"retention": {"mode": "days", "value": 30},
|
"retention": {"mode": "days", "value": 30},
|
||||||
"limits": {
|
"limits": {
|
||||||
"maxActiveRuns": 4,
|
"maxActiveRuns": 4,
|
||||||
"maxQueuedRuns": 50,
|
"maxQueuedRuns": 50,
|
||||||
"backpressureMode": "reject"
|
"backpressureMode": "reject"
|
||||||
},
|
},
|
||||||
"approval": {
|
"approval": {
|
||||||
"required": false
|
"required": false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Response 201**
|
**Response 201**
|
||||||
|
|
||||||
@@ -192,24 +192,24 @@ Scopes: export:run
|
|||||||
{
|
{
|
||||||
"runId": "run-20251029-01",
|
"runId": "run-20251029-01",
|
||||||
"status": "pending",
|
"status": "pending",
|
||||||
"profileId": "prof-json-raw",
|
"profileId": "prof-json-raw",
|
||||||
"createdAt": "2025-10-29T12:12:11Z",
|
"createdAt": "2025-10-29T12:12:11Z",
|
||||||
"createdBy": "user:ops",
|
"createdBy": "user:ops",
|
||||||
"selectors": { "...": "..." },
|
"selectors": { "...": "..." },
|
||||||
"links": {
|
"links": {
|
||||||
"self": "/api/export/runs/run-20251029-01",
|
"self": "/api/export/runs/run-20251029-01",
|
||||||
"events": "/api/export/runs/run-20251029-01/events"
|
"events": "/api/export/runs/run-20251029-01/events"
|
||||||
},
|
},
|
||||||
"quotas": {
|
"quotas": {
|
||||||
"maxActiveRuns": 4,
|
"maxActiveRuns": 4,
|
||||||
"maxQueuedRuns": 50,
|
"maxQueuedRuns": 50,
|
||||||
"backpressureMode": "reject"
|
"backpressureMode": "reject"
|
||||||
},
|
},
|
||||||
"approval": {
|
"approval": {
|
||||||
"required": false
|
"required": false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4.2 List runs
|
### 4.2 List runs
|
||||||
|
|
||||||
@@ -231,15 +231,15 @@ Response fields:
|
|||||||
|
|
||||||
| Field | Description |
|
| Field | Description |
|
||||||
|-------|-------------|
|
|-------|-------------|
|
||||||
| `status` | `pending`, `running`, `success`, `failed`, `canceled`. |
|
| `status` | `pending`, `running`, `success`, `failed`, `canceled`. |
|
||||||
| `progress` | Object with `adapters`, `bytesWritten`, `recordsProcessed`. |
|
| `progress` | Object with `adapters`, `bytesWritten`, `recordsProcessed`. |
|
||||||
| `errorCode` | Populated when `status=failed` (`signing`, `distribution`, etc). |
|
| `errorCode` | Populated when `status=failed` (`signing`, `distribution`, etc). |
|
||||||
| `policySnapshotId` | Returned for policy-aware profiles. |
|
| `policySnapshotId` | Returned for policy-aware profiles. |
|
||||||
| `distributions` | List of available distribution descriptors (type, location, sha256, expiresAt). |
|
| `distributions` | List of available distribution descriptors (type, location, sha256, expiresAt). |
|
||||||
| `rerunHash` | SHA-256 over sorted `contents[*].digest`; used for determinism checks. |
|
| `rerunHash` | SHA-256 over sorted `contents[*].digest`; used for determinism checks. |
|
||||||
| `integrity` | Expected HTTP headers (`Digest`, `X-Stella-Signature`, `X-Stella-Immutability`) and OCI annotations (`io.stellaops.export.*`). |
|
| `integrity` | Expected HTTP headers (`Digest`, `X-Stella-Signature`, `X-Stella-Immutability`) and OCI annotations (`io.stellaops.export.*`). |
|
||||||
| `quotas` | Active limits/backpressure settings returned with the run. |
|
| `quotas` | Active limits/backpressure settings returned with the run. |
|
||||||
| `approval` | Cross-tenant approval ticket when selectors span multiple tenants/wildcards. |
|
| `approval` | Cross-tenant approval ticket when selectors span multiple tenants/wildcards. |
|
||||||
|
|
||||||
### 4.4 Cancel a run
|
### 4.4 Cancel a run
|
||||||
|
|
||||||
@@ -294,16 +294,16 @@ GET /api/export/runs/{runId}/download
|
|||||||
Scopes: export:download
|
Scopes: export:download
|
||||||
```
|
```
|
||||||
|
|
||||||
Streams the primary bundle (tarball, zip, or profile-specific layout). Headers:
|
Streams the primary bundle (tarball, zip, or profile-specific layout). Headers:
|
||||||
|
|
||||||
- `Content-Disposition: attachment; filename="export-run-20251029-01.tar.zst"`
|
- `Content-Disposition: attachment; filename="export-run-20251029-01.tar.zst"`
|
||||||
- `Digest: sha-256=<base64>` (EC5)
|
- `Digest: sha-256=<base64>` (EC5)
|
||||||
- `X-Stella-Signature: dsse-b64:<payload>` (EC3/EC5)
|
- `X-Stella-Signature: dsse-b64:<payload>` (EC3/EC5)
|
||||||
- `X-Stella-Immutability: true`
|
- `X-Stella-Immutability: true`
|
||||||
- `X-Export-Size: 73482019`
|
- `X-Export-Size: 73482019`
|
||||||
- `X-Export-Encryption: age` (when mirror encryption enabled)
|
- `X-Export-Encryption: age` (when mirror encryption enabled)
|
||||||
|
|
||||||
Supports HTTP range requests for resume functionality. If no bundle exists yet, responds `409` with `ERR_EXPORT_007`.
|
Supports HTTP range requests for resume functionality. If no bundle exists yet, responds `409` with `ERR_EXPORT_007`.
|
||||||
|
|
||||||
### 6.2 Manifest download
|
### 6.2 Manifest download
|
||||||
|
|
||||||
@@ -312,8 +312,8 @@ GET /api/export/runs/{runId}/manifest
|
|||||||
Scopes: export:download
|
Scopes: export:download
|
||||||
```
|
```
|
||||||
|
|
||||||
Returns signed `export.json`. To fetch the detached signature, append `?signature=true`.
|
Returns signed `export.json`. To fetch the detached signature, append `?signature=true`.
|
||||||
- Integrity annotations are mirrored in response headers (`Digest`, `X-Stella-Signature`, `X-Stella-Immutability`) and in the manifest `integrity` block to keep rerun-hash deterministic.
|
- Integrity annotations are mirrored in response headers (`Digest`, `X-Stella-Signature`, `X-Stella-Immutability`) and in the manifest `integrity` block to keep rerun-hash deterministic.
|
||||||
|
|
||||||
### 6.3 Provenance download
|
### 6.3 Provenance download
|
||||||
|
|
||||||
@@ -322,7 +322,7 @@ GET /api/export/runs/{runId}/provenance
|
|||||||
Scopes: export:download
|
Scopes: export:download
|
||||||
```
|
```
|
||||||
|
|
||||||
Returns signed `provenance.json`. Supports `?signature=true`. Provenance includes attestation subject digests, policy snapshot ids, adapter versions, and KMS key identifiers.
|
Returns signed `provenance.json`. Supports `?signature=true`. Provenance includes attestation subject digests, policy snapshot ids, adapter versions, and KMS key identifiers.
|
||||||
|
|
||||||
### 6.4 Distribution descriptors
|
### 6.4 Distribution descriptors
|
||||||
|
|
||||||
@@ -356,6 +356,6 @@ Payload includes `targetUrl`, `events` (e.g., `run.succeeded`), and optional sec
|
|||||||
- [Export Center Architecture](architecture.md)
|
- [Export Center Architecture](architecture.md)
|
||||||
- [Export Center Profiles](profiles.md)
|
- [Export Center Profiles](profiles.md)
|
||||||
- [Export Center CLI Guide](cli.md) *(companion document)*
|
- [Export Center CLI Guide](cli.md) *(companion document)*
|
||||||
- [Aggregation-Only Contract reference](../../ingestion/aggregation-only-contract.md)
|
- [Aggregation-Only Contract reference](../../aoc/aggregation-only-contract.md)
|
||||||
|
|
||||||
> **Imposed rule:** Work of this type or tasks of this type on this component must also be applied everywhere else it should be applied.
|
> **Imposed rule:** Work of this type or tasks of this type on this component must also be applied everywhere else it should be applied.
|
||||||
|
|||||||
@@ -144,20 +144,20 @@ stella export provenance run-20251029-01 --output manifests/provenance.json
|
|||||||
|
|
||||||
Retrieves the signed provenance file. `--signature` behaves like the manifest command.
|
Retrieves the signed provenance file. `--signature` behaves like the manifest command.
|
||||||
|
|
||||||
### 4.4 `stella export verify`
|
### 4.4 `stella export verify`
|
||||||
|
|
||||||
```
|
```
|
||||||
stella export verify run-20251029-01 \
|
stella export verify run-20251029-01 \
|
||||||
--manifest manifests/export.json \
|
--manifest manifests/export.json \
|
||||||
--provenance manifests/provenance.json \
|
--provenance manifests/provenance.json \
|
||||||
--key keys/acme-export.pub
|
--key keys/acme-export.pub
|
||||||
```
|
```
|
||||||
|
|
||||||
Wrapper around `cosign verify`. Returns exit `0` when signatures and digests validate. Exit `20` when verification fails.
|
Wrapper around `cosign verify`. Returns exit `0` when signatures and digests validate. Exit `20` when verification fails.
|
||||||
|
|
||||||
Integrity and determinism checks (EC1–EC10):
|
Integrity and determinism checks (EC1–EC10):
|
||||||
- `stella export manifest` and `provenance` commands emit `Digest`/`X-Stella-Signature` headers; cache them for rerun-hash validation.
|
- `stella export manifest` and `provenance` commands emit `Digest`/`X-Stella-Signature` headers; cache them for rerun-hash validation.
|
||||||
- Offline kits: run `docs/modules/export-center/operations/verify-export-kit.sh <kit_dir>` to assert rerunHash, integrity headers vs OCI annotations, quotas/backpressure block, approvals, and log metadata in provenance.
|
- Offline kits: run `docs/modules/export-center/operations/verify-export-kit.sh <kit_dir>` to assert rerunHash, integrity headers vs OCI annotations, quotas/backpressure block, approvals, and log metadata in provenance.
|
||||||
|
|
||||||
## 5. CI recipe (GitHub Actions example)
|
## 5. CI recipe (GitHub Actions example)
|
||||||
|
|
||||||
@@ -230,6 +230,6 @@ Exit codes above 100 are reserved for future profile-specific tooling.
|
|||||||
- [Export Center Profiles](profiles.md)
|
- [Export Center Profiles](profiles.md)
|
||||||
- [Export Center API reference](api.md)
|
- [Export Center API reference](api.md)
|
||||||
- [Export Center Architecture](architecture.md)
|
- [Export Center Architecture](architecture.md)
|
||||||
- [Aggregation-Only Contract reference](../../ingestion/aggregation-only-contract.md)
|
- [Aggregation-Only Contract reference](../../aoc/aggregation-only-contract.md)
|
||||||
|
|
||||||
> **Imposed rule:** Work of this type or tasks of this type on this component must also be applied everywhere else it should be applied.
|
> **Imposed rule:** Work of this type or tasks of this type on this component must also be applied everywhere else it should be applied.
|
||||||
|
|||||||
@@ -92,11 +92,11 @@ delta/
|
|||||||
manifest.diff.json # summary of counts, hashes, base export metadata
|
manifest.diff.json # summary of counts, hashes, base export metadata
|
||||||
```
|
```
|
||||||
|
|
||||||
- **Base lookup:** The worker verifies that the base export is reachable (download path or OCI reference). If missing, the run fails with `ERR_EXPORT_BASE_MISSING`.
|
- **Base lookup:** The worker verifies that the base export is reachable (download path or OCI reference). If missing, the run fails with `ERR_EXPORT_BASE_MISSING`.
|
||||||
- **Change detection:** Uses deterministic hashing of normalized records to compute additions/updates. Indexes are regenerated only for affected subjects.
|
- **Change detection:** Uses deterministic hashing of normalized records to compute additions/updates. Indexes are regenerated only for affected subjects.
|
||||||
- **Application order:** Consumers apply deltas sequentially. A `resetBaseline=true` flag instructs them to drop cached state and apply the bundle as a full refresh.
|
- **Application order:** Consumers apply deltas sequentially. A `resetBaseline=true` flag instructs them to drop cached state and apply the bundle as a full refresh.
|
||||||
- **Tombstones required:** Every removal must emit a tombstone entry plus the `removed` list; deltas without tombstones fail verification (`verify-export-kit.sh`).
|
- **Tombstones required:** Every removal must emit a tombstone entry plus the `removed` list; deltas without tombstones fail verification (`verify-export-kit.sh`).
|
||||||
- **Integrity headers:** Each delta bundle exports `Digest`, `X-Stella-Signature`, and `X-Stella-Immutability` derived from the OCI annotation `io.stellaops.export.manifest-digest`. Consumers must validate before applying.
|
- **Integrity headers:** Each delta bundle exports `Digest`, `X-Stella-Signature`, and `X-Stella-Immutability` derived from the OCI annotation `io.stellaops.export.manifest-digest`. Consumers must validate before applying.
|
||||||
|
|
||||||
Example `manifest.diff.json` (delta):
|
Example `manifest.diff.json` (delta):
|
||||||
|
|
||||||
@@ -182,40 +182,40 @@ sequenceDiagram
|
|||||||
3. Re-run integrity checks (`mirror verify <path>`).
|
3. Re-run integrity checks (`mirror verify <path>`).
|
||||||
- **Audit logging:** Export Center logs `mirror.bundle.created`, `mirror.delta.applied`, and `mirror.encryption.enabled` events. Consume them in the central observability pipeline.
|
- **Audit logging:** Export Center logs `mirror.bundle.created`, `mirror.delta.applied`, and `mirror.encryption.enabled` events. Consume them in the central observability pipeline.
|
||||||
|
|
||||||
## 7. Validation checklist (Trivy / mirror bundles)
|
## 7. Validation checklist (Trivy / mirror bundles)
|
||||||
|
|
||||||
- Download and verify:
|
- Download and verify:
|
||||||
- `stella export download <exportId> --format mirror`
|
- `stella export download <exportId> --format mirror`
|
||||||
- `stella export verify <exportId>`
|
- `stella export verify <exportId>`
|
||||||
- Delta ordering:
|
- Delta ordering:
|
||||||
- Ensure `manifest.diff.json.baseExportId` exists locally before applying delta.
|
- Ensure `manifest.diff.json.baseExportId` exists locally before applying delta.
|
||||||
- Track applied order in `appliedExportIds.log`.
|
- Track applied order in `appliedExportIds.log`.
|
||||||
- Trivy adapter (if enabled):
|
- Trivy adapter (if enabled):
|
||||||
- `stella export trivy-validate --bundle mirror-YYYYMMDD.tar.zst --policy ./policies/export-center.rego`
|
- `stella export trivy-validate --bundle mirror-YYYYMMDD.tar.zst --policy ./policies/export-center.rego`
|
||||||
- Dry-run import:
|
- Dry-run import:
|
||||||
- `stella export mirror-validate --bundle mirror-YYYYMMDD.tar.zst --dry-run`
|
- `stella export mirror-validate --bundle mirror-YYYYMMDD.tar.zst --dry-run`
|
||||||
- Post-import checks:
|
- Post-import checks:
|
||||||
- Recompute SHA256 for `manifest.yaml` and a sample data file; compare to manifest.
|
- Recompute SHA256 for `manifest.yaml` and a sample data file; compare to manifest.
|
||||||
- Run `mirror verify` (Offline Kit) and confirm zero mismatches.
|
- Run `mirror verify` (Offline Kit) and confirm zero mismatches.
|
||||||
- Confirm OCI annotations `io.stellaops.export.profile/run/manifest-digest/provenance-ref` match the bundle being applied.
|
- Confirm OCI annotations `io.stellaops.export.profile/run/manifest-digest/provenance-ref` match the bundle being applied.
|
||||||
|
|
||||||
## 8. Troubleshooting
|
## 8. Troubleshooting
|
||||||
|
|
||||||
| Symptom | Meaning | Action |
|
| Symptom | Meaning | Action |
|
||||||
|---------|---------|--------|
|
|---------|---------|--------|
|
||||||
| `ERR_EXPORT_BASE_MISSING` | Base export not available | Republish base bundle or rebuild as full export. |
|
| `ERR_EXPORT_BASE_MISSING` | Base export not available | Republish base bundle or rebuild as full export. |
|
||||||
| Delta applies but mirror misses entries | Deltas applied out of order | Rebuild from last full bundle and reapply in sequence. |
|
| Delta applies but mirror misses entries | Deltas applied out of order | Rebuild from last full bundle and reapply in sequence. |
|
||||||
| Decryption fails | Recipient key mismatch or corrupted bundle | Confirm key distribution and re-download bundle. |
|
| Decryption fails | Recipient key mismatch or corrupted bundle | Confirm key distribution and re-download bundle. |
|
||||||
| Verification errors | Signature mismatch | Do not import; regenerate bundle and investigate signing pipeline. |
|
| Verification errors | Signature mismatch | Do not import; regenerate bundle and investigate signing pipeline. |
|
||||||
| Manifest hash mismatch | Files changed after extraction | Re-extract bundle and re-run verification; check storage tampering. |
|
| Manifest hash mismatch | Files changed after extraction | Re-extract bundle and re-run verification; check storage tampering. |
|
||||||
|
|
||||||
## 9. References
|
## 9. References
|
||||||
|
|
||||||
- [Export Center Overview](overview.md)
|
- [Export Center Overview](overview.md)
|
||||||
- [Export Center Architecture](architecture.md)
|
- [Export Center Architecture](architecture.md)
|
||||||
- [Export Center API reference](api.md)
|
- [Export Center API reference](api.md)
|
||||||
- [Export Center CLI Guide](cli.md)
|
- [Export Center CLI Guide](cli.md)
|
||||||
- [Concelier mirror runbook](../concelier/operations/mirror.md)
|
- [Concelier mirror runbook](../concelier/operations/mirror.md)
|
||||||
- [Aggregation-Only Contract reference](../../ingestion/aggregation-only-contract.md)
|
- [Aggregation-Only Contract reference](../../aoc/aggregation-only-contract.md)
|
||||||
|
|
||||||
> **Imposed rule:** Work of this type or tasks of this type on this component must also be applied everywhere else it should be applied.
|
> **Imposed rule:** Work of this type or tasks of this type on this component must also be applied everywhere else it should be applied.
|
||||||
|
|||||||
@@ -11,17 +11,17 @@ The Export Center packages StellaOps evidence and policy overlays into reproduci
|
|||||||
- Runbook execution for recovery, retention, and compliance.
|
- Runbook execution for recovery, retention, and compliance.
|
||||||
- Coordination with DevOps validation (cosign + `trivy module db import` smoke tests).
|
- Coordination with DevOps validation (cosign + `trivy module db import` smoke tests).
|
||||||
|
|
||||||
Related documentation:
|
Related documentation:
|
||||||
|
|
||||||
- `docs/modules/export-center/overview.md`
|
- `docs/modules/export-center/overview.md`
|
||||||
- `docs/modules/export-center/architecture.md`
|
- `docs/modules/export-center/architecture.md`
|
||||||
- `docs/modules/export-center/profiles.md`
|
- `docs/modules/export-center/profiles.md`
|
||||||
- `docs/modules/export-center/trivy-adapter.md`
|
- `docs/modules/export-center/trivy-adapter.md`
|
||||||
- `docs/modules/export-center/mirror-bundles.md`
|
- `docs/modules/export-center/mirror-bundles.md`
|
||||||
- `docs/modules/export-center/api.md`
|
- `docs/modules/export-center/api.md`
|
||||||
- `docs/modules/export-center/cli.md`
|
- `docs/modules/export-center/cli.md`
|
||||||
- `docs/modules/export-center/operations/kms-envelope-pattern.md`
|
- `docs/modules/export-center/operations/kms-envelope-pattern.md`
|
||||||
- `docs/modules/export-center/operations/risk-bundle-provider-matrix.md`
|
- `docs/modules/export-center/operations/risk-bundle-provider-matrix.md`
|
||||||
|
|
||||||
## 2. Contacts & tooling
|
## 2. Contacts & tooling
|
||||||
|
|
||||||
@@ -199,7 +199,7 @@ If encryption enabled, decrypt using age or AES key before verification.
|
|||||||
- `docs/modules/export-center/trivy-adapter.md`
|
- `docs/modules/export-center/trivy-adapter.md`
|
||||||
- `docs/modules/export-center/mirror-bundles.md`
|
- `docs/modules/export-center/mirror-bundles.md`
|
||||||
- `ops/devops/TASKS.md` (`DEVOPS-EXPORT-36-001`, `DEVOPS-EXPORT-37-001`)
|
- `ops/devops/TASKS.md` (`DEVOPS-EXPORT-36-001`, `DEVOPS-EXPORT-37-001`)
|
||||||
- `docs/ingestion/aggregation-only-contract.md`
|
- `docs/aoc/aggregation-only-contract.md`
|
||||||
- `docs/24_OFFLINE_KIT.md`
|
- `docs/24_OFFLINE_KIT.md`
|
||||||
|
|
||||||
> **Imposed rule:** Work of this type or tasks of this type on this component must also be applied everywhere else it should be applied.
|
> **Imposed rule:** Work of this type or tasks of this type on this component must also be applied everywhere else it should be applied.
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ Refer to `docs/modules/export-center/architecture.md` (Sprint 35 task) for compo
|
|||||||
- **Signing and encryption.** Manifests and payloads are signed using the platform KMS. Mirror profiles support optional in-bundle encryption (age/AES-GCM) with key wrapping.
|
- **Signing and encryption.** Manifests and payloads are signed using the platform KMS. Mirror profiles support optional in-bundle encryption (age/AES-GCM) with key wrapping.
|
||||||
- **Determinism.** Identical inputs yield identical bundles. Timestamps serialize in UTC ISO-8601; manifests include content hashes for audit replay.
|
- **Determinism.** Identical inputs yield identical bundles. Timestamps serialize in UTC ISO-8601; manifests include content hashes for audit replay.
|
||||||
|
|
||||||
See `docs/security/policy-governance.md` and `docs/ingestion/aggregation-only-contract.md` for broader guardrail context.
|
See `docs/security/policy-governance.md` and `docs/aoc/aggregation-only-contract.md` for broader guardrail context.
|
||||||
|
|
||||||
## Operating it offline
|
## Operating it offline
|
||||||
- **Offline Kit integration.** Air-gapped deployments receive pre-built export profiles and object storage layout templates through the Offline Kit bundles.
|
- **Offline Kit integration.** Air-gapped deployments receive pre-built export profiles and object storage layout templates through the Offline Kit bundles.
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ Graph module (upcoming) will power graph-indexed queries for SBOM relationships,
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ Notify evaluates operator-defined rules against platform events and dispatches c
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -28,25 +28,25 @@ Notify (Notifications Studio) converts platform events into tenant-scoped alerts
|
|||||||
Status for these items is tracked in `src/Notifier/StellaOps.Notifier/TASKS.md` and sprint plans; update this README once tasks merge.
|
Status for these items is tracked in `src/Notifier/StellaOps.Notifier/TASKS.md` and sprint plans; update this README once tasks merge.
|
||||||
|
|
||||||
## Key docs & release alignment
|
## Key docs & release alignment
|
||||||
- [`docs/notifications/overview.md`](../../notifications/overview.md) — summary of capabilities, imposed rules, and customer journey.
|
- [`overview.md`](overview.md) — summary of capabilities, imposed rules, and customer journey.
|
||||||
- [`docs/notifications/architecture.md`](../../notifications/architecture.md) — Notifications Studio runtime view (published 2025-10-29).
|
- [`architecture.md`](architecture.md) / [`architecture-detail.md`](architecture-detail.md) — Notifications Studio runtime view.
|
||||||
- [`docs/notifications/rules.md`](../../notifications/rules.md) — declarative matcher syntax and evaluation order.
|
- [`rules.md`](rules.md) — declarative matcher syntax and evaluation order.
|
||||||
- [`docs/notifications/digests.md`](../../notifications/digests.md) — digest windows, coalescing logic, and delivery samples.
|
- [`digests.md`](digests.md) — digest windows, coalescing logic, and delivery samples.
|
||||||
- [`docs/notifications/templates.md`](../../notifications/templates.md) — template helpers, localisation, and redaction guidelines.
|
- [`templates.md`](templates.md) — template helpers, localisation, and redaction guidelines.
|
||||||
- [`docs/updates/2025-10-29-notify-docs.md`](../../updates/2025-10-29-notify-docs.md) — latest release note; follow-ups remain to validate connector metadata, quiet-hours semantics, and simulation payloads once Sprint 39 drops land.
|
- [`docs/implplan/archived/updates/2025-10-29-notify-docs.md`](../../implplan/archived/updates/2025-10-29-notify-docs.md) — latest release note; follow-ups remain to validate connector metadata, quiet-hours semantics, and simulation payloads once Sprint 39 drops land.
|
||||||
|
|
||||||
## Integrations & dependencies
|
## Integrations & dependencies
|
||||||
- **Storage:** PostgreSQL (schema `notify`) for rules, channels, deliveries, digests, and throttles; Valkey for worker coordination.
|
- **Storage:** PostgreSQL (schema `notify`) for rules, channels, deliveries, digests, and throttles; Valkey for worker coordination.
|
||||||
- **Queues:** Valkey Streams or NATS JetStream for ingestion, throttling, and DLQs (`notify.dlq`).
|
- **Queues:** Valkey Streams or NATS JetStream for ingestion, throttling, and DLQs (`notify.dlq`).
|
||||||
- **Authority:** OpTok-protected APIs, DPoP-backed CLI/UI scopes (`notify.viewer`, `notify.operator`, `notify.admin`), and secret references for channel credentials.
|
- **Authority:** OpTok-protected APIs, DPoP-backed CLI/UI scopes (`notify.viewer`, `notify.operator`, `notify.admin`), and secret references for channel credentials.
|
||||||
- **Observability:** Prometheus metrics (`notify.sent_total`, `notify.failed_total`, `notify.digest_coalesced_total`, etc.), OTEL traces, and dashboards documented in `docs/notifications/architecture.md#12-observability-prometheus--otel`.
|
- **Observability:** Prometheus metrics (`notify.sent_total`, `notify.failed_total`, `notify.digest_coalesced_total`, etc.), OTEL traces, and dashboards documented in `architecture-detail.md`.
|
||||||
|
|
||||||
## Operational notes
|
## Operational notes
|
||||||
- Schema fixtures live in `./resources/schemas`; event and delivery samples live in `./resources/samples` for contract tests and UI mocks.
|
- Schema fixtures live in `./resources/schemas`; event and delivery samples live in `./resources/samples` for contract tests and UI mocks.
|
||||||
- Offline Kit bundles ship plug-ins, default templates, and seed rules; update manifests under `ops/offline-kit/` when connectors change.
|
- Offline Kit bundles ship plug-ins, default templates, and seed rules; update manifests under `ops/offline-kit/` when connectors change.
|
||||||
- Dashboards and alert references depend on `DEVOPS-NOTIFY-39-002`; coordinate before renaming metrics or labels.
|
- Dashboards and alert references depend on `DEVOPS-NOTIFY-39-002`; coordinate before renaming metrics or labels.
|
||||||
- Observability assets: `operations/observability.md` and `operations/dashboards/notify-observability.json` (offline import).
|
- Observability assets: `operations/observability.md` and `operations/dashboards/notify-observability.json` (offline import).
|
||||||
- When releasing new rule or connector features, mirror guidance into `docs/notifications/*.md` and checklists in `docs/updates/2025-10-29-notify-docs.md` until the follow-ups are closed.
|
- When releasing new rule or connector features, update guidance in this directory and related checklists until the follow-ups are closed.
|
||||||
|
|
||||||
## Epic alignment
|
## Epic alignment
|
||||||
- **Epic 11 – Notifications Studio:** notifications workspace, preview tooling, immutable delivery ledger, throttling/digest controls, and forthcoming correlation/simulation features.
|
- **Epic 11 – Notifications Studio:** notifications workspace, preview tooling, immutable delivery ledger, throttling/digest controls, and forthcoming correlation/simulation features.
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ Last updated: 2025-11-25 (Docs Tasks Md.V · DOCS-NOTIFY-40-001)
|
|||||||
All endpoints require `Authorization: Bearer <token>` and `X-Stella-Tenant` header. Responses use the common error envelope (`docs/api/overview.md`). Paths are rooted at `/api/v1/notify`.
|
All endpoints require `Authorization: Bearer <token>` and `X-Stella-Tenant` header. Responses use the common error envelope (`docs/api/overview.md`). Paths are rooted at `/api/v1/notify`.
|
||||||
|
|
||||||
## Channels
|
## Channels
|
||||||
- `POST /channels` — create channel. Body matches `notifications/channels.md` schema. Returns `201` + channel.
|
- `POST /channels` — create channel. Body matches `channels.md` schema. Returns `201` + channel.
|
||||||
- `GET /channels` — list channels (deterministic order: type ASC, id ASC). Supports `type` filter.
|
- `GET /channels` — list channels (deterministic order: type ASC, id ASC). Supports `type` filter.
|
||||||
- `GET /channels/{id}` — fetch single channel.
|
- `GET /channels/{id}` — fetch single channel.
|
||||||
- `DELETE /channels/{id}` — soft-delete; fails if referenced by active rules unless `force=true` query.
|
- `DELETE /channels/{id}` — soft-delete; fails if referenced by active rules unless `force=true` query.
|
||||||
@@ -18,7 +18,7 @@ All endpoints require `Authorization: Bearer <token>` and `X-Stella-Tenant` head
|
|||||||
- `POST /rules:preview` — dry-run rule against sample event; returns matched actions and rendered templates.
|
- `POST /rules:preview` — dry-run rule against sample event; returns matched actions and rendered templates.
|
||||||
|
|
||||||
## Policies & escalations
|
## Policies & escalations
|
||||||
- `POST /policies/escalations` — create escalation policy (see `notifications/escalations.md`).
|
- `POST /policies/escalations` — create escalation policy (see `escalations.md`).
|
||||||
- `GET /policies/escalations` — list policies.
|
- `GET /policies/escalations` — list policies.
|
||||||
|
|
||||||
## Deliveries & digests
|
## Deliveries & digests
|
||||||
@@ -63,7 +63,7 @@ Failures during evaluation are logged with correlation IDs and surfaced through
|
|||||||
## 3. Rendering & connectors
|
## 3. Rendering & connectors
|
||||||
|
|
||||||
- **Template resolution.** The renderer picks the template in this order: action template → channel default template → locale fallback → built-in minimal template. Locale negotiation reduces `en-US` to `en-us`.
|
- **Template resolution.** The renderer picks the template in this order: action template → channel default template → locale fallback → built-in minimal template. Locale negotiation reduces `en-US` to `en-us`.
|
||||||
- **Helpers & partials.** Exposed helpers mirror the list in [`notifications/templates.md`](templates.md#3-variables-helpers-and-context). Plug-ins may register additional helpers but must remain deterministic and side-effect free.
|
- **Helpers & partials.** Exposed helpers mirror the list in [`templates.md`](templates.md#3-variables-helpers-and-context). Plug-ins may register additional helpers but must remain deterministic and side-effect free.
|
||||||
- **Attestation lifecycle suite.** Sprint 171 introduced dedicated `tmpl-attest-*` templates for verification failures, expiring attestations, key rotations, and transparency anomalies (see [`templates.md` §7](templates.md#7-attestation--signing-lifecycle-templates-notify-attest-74-001)). Rule actions referencing those templates must populate the attestation context fields so channels stay consistent online/offline.
|
- **Attestation lifecycle suite.** Sprint 171 introduced dedicated `tmpl-attest-*` templates for verification failures, expiring attestations, key rotations, and transparency anomalies (see [`templates.md` §7](templates.md#7-attestation--signing-lifecycle-templates-notify-attest-74-001)). Rule actions referencing those templates must populate the attestation context fields so channels stay consistent online/offline.
|
||||||
- **Rendering output.** `NotifyDeliveryRendered` captures:
|
- **Rendering output.** `NotifyDeliveryRendered` captures:
|
||||||
- `channelType`, `format`, `locale`
|
- `channelType`, `format`, `locale`
|
||||||
@@ -7,22 +7,22 @@ Close NR1–NR10 by defining contracts, evidence, and deterministic test hooks f
|
|||||||
|
|
||||||
| ID | Requirement | Evidence to publish | Deterministic tests/fixtures |
|
| ID | Requirement | Evidence to publish | Deterministic tests/fixtures |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| NR1 | Versioned JSON Schemas for event envelopes, rules, templates, channels, receipts, and webhooks; DSSE-signed catalog with canonical hash recipe (BLAKE3-256 over normalized JSON). | `docs/notifications/schemas/notify-schemas-catalog.json` + `.dsse.json`; `docs/notifications/schemas/inputs.lock` capturing digests and canonicalization flags. | Golden canonicalization harness under `tests/notifications/Schemas/SchemaCanonicalizationTests.cs` using frozen inputs + hash assertions. |
|
| NR1 | Versioned JSON Schemas for event envelopes, rules, templates, channels, receipts, and webhooks; DSSE-signed catalog with canonical hash recipe (BLAKE3-256 over normalized JSON). | `docs/modules/notify/schemas/notify-schemas-catalog.json` + `.dsse.json`; `docs/modules/notify/schemas/inputs.lock` capturing digests and canonicalization flags. | Golden canonicalization harness under `tests/notifications/Schemas/SchemaCanonicalizationTests.cs` using frozen inputs + hash assertions. |
|
||||||
| NR2 | Tenant scoping + approvals for high-impact rules (escalations, PII, cross-tenant fan-out). Every API and receipt carries `tenant_id`; RBAC/approvals enforced. | RBAC/approval matrix (`docs/notifications/security/tenant-approvals.md`) listing actions × roles × required approvals. | API contract tests in `StellaOps.Notifier.Tests/TenantScopeTests.cs` plus integration fixtures with mixed-tenant payloads (should reject). |
|
| NR2 | Tenant scoping + approvals for high-impact rules (escalations, PII, cross-tenant fan-out). Every API and receipt carries `tenant_id`; RBAC/approvals enforced. | RBAC/approval matrix (`docs/modules/notify/security/tenant-approvals.md`) listing actions × roles × required approvals. | API contract tests in `StellaOps.Notifier.Tests/TenantScopeTests.cs` plus integration fixtures with mixed-tenant payloads (should reject). |
|
||||||
| NR3 | Deterministic rendering/localization: stable merge-field ordering, UTC ISO-8601 timestamps, locale whitelist, hashed previews recorded in ledger. | Rendering fixture pack `docs/notifications/fixtures/rendering/*.json`; hash ledger samples `docs/notifications/fixtures/rendering/index.ndjson` with BLAKE3 digests. | `StellaOps.Notifier.Tests/RenderingDeterminismTests.cs` compares golden bodies/subjects across locales/timezones; seeds fixed RNG/time. |
|
| NR3 | Deterministic rendering/localization: stable merge-field ordering, UTC ISO-8601 timestamps, locale whitelist, hashed previews recorded in ledger. | Rendering fixture pack `docs/modules/notify/fixtures/rendering/*.json`; hash ledger samples `docs/modules/notify/fixtures/rendering/index.ndjson` with BLAKE3 digests. | `StellaOps.Notifier.Tests/RenderingDeterminismTests.cs` compares golden bodies/subjects across locales/timezones; seeds fixed RNG/time. |
|
||||||
| NR4 | Quotas/backpressure/DLQ: per-tenant/channel quotas, burst budgets, enqueue gating, DLQ schema with redrive + idempotent keys; metrics/alerts for backlog/DLQ growth. | Quota policy `docs/notifications/operations/quotas.md`; DLQ schema `docs/notifications/schemas/dlq-notify.schema.json`. | Worker tests `StellaOps.Notifier.Tests/BackpressureAndDlqTests.cs` validating quota enforcement, DLQ insertion, redrive idempotency. |
|
| NR4 | Quotas/backpressure/DLQ: per-tenant/channel quotas, burst budgets, enqueue gating, DLQ schema with redrive + idempotent keys; metrics/alerts for backlog/DLQ growth. | Quota policy `docs/modules/notify/operations/quotas.md`; DLQ schema `docs/modules/notify/schemas/dlq-notify.schema.json`. | Worker tests `StellaOps.Notifier.Tests/BackpressureAndDlqTests.cs` validating quota enforcement, DLQ insertion, redrive idempotency. |
|
||||||
| NR5 | Retry & idempotency: canonical `delivery_id` (UUIDv7) + dedupe key (event×rule×channel); bounded exponential backoff with jitter; idempotent connectors; ignore out-of-order acks. | Retry matrix `docs/notifications/operations/retries.md`; connector idempotency checklist. | `StellaOps.Notifier.Tests/RetryPolicyTests.cs` + connector harness fixtures demonstrating dedupe across duplicate events. |
|
| NR5 | Retry & idempotency: canonical `delivery_id` (UUIDv7) + dedupe key (event×rule×channel); bounded exponential backoff with jitter; idempotent connectors; ignore out-of-order acks. | Retry matrix `docs/modules/notify/operations/retries.md`; connector idempotency checklist. | `StellaOps.Notifier.Tests/RetryPolicyTests.cs` + connector harness fixtures demonstrating dedupe across duplicate events. |
|
||||||
| NR6 | Webhook/ack security: HMAC or mTLS/DPoP required; signed ack URLs/tokens with nonce, expiry, audience, single-use; per-tenant allowlists for domains/paths. | Security policy `docs/notifications/security/webhook-ack-hardening.md`; sample signed-ack token format + validation steps. | Negative-path tests `StellaOps.Notifier.Tests/WebhookSecurityTests.cs` covering wrong HMAC, replayed nonce, expired token, disallowed domain. |
|
| NR6 | Webhook/ack security: HMAC or mTLS/DPoP required; signed ack URLs/tokens with nonce, expiry, audience, single-use; per-tenant allowlists for domains/paths. | Security policy `docs/modules/notify/security/webhook-ack-hardening.md`; sample signed-ack token format + validation steps. | Negative-path tests `StellaOps.Notifier.Tests/WebhookSecurityTests.cs` covering wrong HMAC, replayed nonce, expired token, disallowed domain. |
|
||||||
| NR7 | Redaction & PII limits: classify template fields; redact secrets/PII in storage/logs; hash sensitive values; size/field allowlists; previews/logs default to redacted variant. | Redaction catalog `docs/notifications/security/redaction-catalog.md`; sample redacted payloads `docs/notifications/fixtures/redaction/*.json`. | `StellaOps.Notifier.Tests/RedactionTests.cs` asserting stored/preview payloads match redacted expectations. |
|
| NR7 | Redaction & PII limits: classify template fields; redact secrets/PII in storage/logs; hash sensitive values; size/field allowlists; previews/logs default to redacted variant. | Redaction catalog `docs/modules/notify/security/redaction-catalog.md`; sample redacted payloads `docs/modules/notify/fixtures/redaction/*.json`. | `StellaOps.Notifier.Tests/RedactionTests.cs` asserting stored/preview payloads match redacted expectations. |
|
||||||
| NR8 | Observability SLO alerts: SLOs for delivery latency/success/backlog/DLQ age; standard metrics names; dashboards/alerts/runbooks; traces include tenant/rule/channel IDs with sampling rules. | Dashboard JSON `docs/notifications/operations/dashboards/notify-slo.json`; alert rules `docs/notifications/operations/alerts/notify-slo-alerts.yaml`; runbook link. | `StellaOps.Notifier.Tests/ObservabilityContractsTests.cs` verifying metric names/labels; trace exemplar fixture `docs/notifications/fixtures/traces/sample-trace.json`. |
|
| NR8 | Observability SLO alerts: SLOs for delivery latency/success/backlog/DLQ age; standard metrics names; dashboards/alerts/runbooks; traces include tenant/rule/channel IDs with sampling rules. | Dashboard JSON `docs/modules/notify/operations/dashboards/notify-slo.json`; alert rules `docs/modules/notify/operations/alerts/notify-slo-alerts.yaml`; runbook link. | `StellaOps.Notifier.Tests/ObservabilityContractsTests.cs` verifying metric names/labels; trace exemplar fixture `docs/modules/notify/fixtures/traces/sample-trace.json`. |
|
||||||
| NR9 | Offline notify-kit with DSSE: bundle schemas, rules/templates, connector configs, verify script, hash list, time-anchor hook; deterministic packaging flags; tenant/env scoping; DSSE-signed manifest. | Manifest `offline/notifier/notify-kit.manifest.json`, DSSE `offline/notifier/notify-kit.manifest.dsse.json`, hash list `offline/notifier/artifact-hashes.json`, verify script `offline/notifier/verify_notify_kit.sh`. | Determinism check `tests/offline/NotifyKitDeterminismTests.sh` (shell) verifying hash list, DSSE, scope enforcement, packaging flags. |
|
| NR9 | Offline notify-kit with DSSE: bundle schemas, rules/templates, connector configs, verify script, hash list, time-anchor hook; deterministic packaging flags; tenant/env scoping; DSSE-signed manifest. | Manifest `offline/notifier/notify-kit.manifest.json`, DSSE `offline/notifier/notify-kit.manifest.dsse.json`, hash list `offline/notifier/artifact-hashes.json`, verify script `offline/notifier/verify_notify_kit.sh`. | Determinism check `tests/offline/NotifyKitDeterminismTests.sh` (shell) verifying hash list, DSSE, scope enforcement, packaging flags. |
|
||||||
| NR10 | Mandatory simulations & evidence before activation: dry-run against frozen fixtures; DSSE-signed simulation results attached to approvals; regression tests per high-impact rule/template change. | Simulation report `docs/notifications/simulations/<rule-id>-report.json` + DSSE; approval evidence log `docs/notifications/simulations/index.ndjson`. | `StellaOps.Notifier.Tests/SimulationGateTests.cs` enforcing simulation requirement and evidence linkage before `active=true`. |
|
| NR10 | Mandatory simulations & evidence before activation: dry-run against frozen fixtures; DSSE-signed simulation results attached to approvals; regression tests per high-impact rule/template change. | Simulation report `docs/modules/notify/simulations/<rule-id>-report.json` + DSSE; approval evidence log `docs/modules/notify/simulations/index.ndjson`. | `StellaOps.Notifier.Tests/SimulationGateTests.cs` enforcing simulation requirement and evidence linkage before `active=true`. |
|
||||||
|
|
||||||
## Delivery + governance hooks
|
## Delivery + governance hooks
|
||||||
- Add the above evidence paths to the NOTIFY-GAPS-171-014 task in `docs/implplan/SPRINT_0171_0001_0001_notifier_i.md` and mirror status in `src/Notifier/StellaOps.Notifier/TASKS.md`.
|
- Add the above evidence paths to the NOTIFY-GAPS-171-014 task in `docs/implplan/SPRINT_0171_0001_0001_notifier_i.md` and mirror status in `src/Notifier/StellaOps.Notifier/TASKS.md`.
|
||||||
- When artifacts land, append TRX/fixture links in the sprint **Execution Log** and reference this doc under **Decisions & Risks**.
|
- When artifacts land, append TRX/fixture links in the sprint **Execution Log** and reference this doc under **Decisions & Risks**.
|
||||||
- Offline kit artefacts must mirror mirror/offline packaging rules (deterministic flags, time-anchor hook, PQ dual-sign toggle) already used by Mirror/Offline sprints.
|
- Offline kit artefacts must mirror mirror/offline packaging rules (deterministic flags, time-anchor hook, PQ dual-sign toggle) already used by Mirror/Offline sprints.
|
||||||
- Simulation evidence lives in `docs/notifications/simulations/` (index.ndjson + per-rule reports) and is validated by contract tests under `Contracts/PolicyDocsCompletenessTests.cs`.
|
- Simulation evidence lives in `docs/modules/notify/simulations/` (index.ndjson + per-rule reports) and is validated by contract tests under `Contracts/PolicyDocsCompletenessTests.cs`.
|
||||||
- Contract tests under `Contracts/` verify schema catalog ↔ DSSE alignment, fixture hashes, simulation index presence, and offline kit manifest/DSSE consistency.
|
- Contract tests under `Contracts/` verify schema catalog ↔ DSSE alignment, fixture hashes, simulation index presence, and offline kit manifest/DSSE consistency.
|
||||||
|
|
||||||
## Next steps
|
## Next steps
|
||||||
@@ -3,5 +3,5 @@
|
|||||||
- Per-tenant quotas: 500 deliveries/minute default; channel overrides: webhook 200/min, email 120/min, chat 240/min.
|
- Per-tenant quotas: 500 deliveries/minute default; channel overrides: webhook 200/min, email 120/min, chat 240/min.
|
||||||
- Burst budget: 2x quota for 60 seconds, then hard clamp.
|
- Burst budget: 2x quota for 60 seconds, then hard clamp.
|
||||||
- Backpressure: reject enqueue when backlog > quota*10 or DLQ growth > 5%/min.
|
- Backpressure: reject enqueue when backlog > quota*10 or DLQ growth > 5%/min.
|
||||||
- DLQ schema: `docs/notifications/schemas/dlq-notify.schema.json`; redrive requires idempotent `delivery_id`/`dedupe_key`.
|
- DLQ schema: `docs/modules/notify/schemas/dlq-notify.schema.json`; redrive requires idempotent `delivery_id`/`dedupe_key`.
|
||||||
- Metrics to alert: backlog depth, DLQ depth, redrive success rate, enqueue reject count.
|
- Metrics to alert: backlog depth, DLQ depth, redrive success rate, enqueue reject count.
|
||||||
@@ -19,12 +19,12 @@ Notifications Studio turns raw platform events into concise, tenant-scoped alert
|
|||||||
|
|
||||||
| Capability | What it does | Key docs |
|
| Capability | What it does | Key docs |
|
||||||
|------------|--------------|----------|
|
|------------|--------------|----------|
|
||||||
| Rules engine | Declarative matchers for event kinds, severities, namespaces, VEX context, KEV flags, and more. | [`notifications/rules.md`](rules.md) |
|
| Rules engine | Declarative matchers for event kinds, severities, namespaces, VEX context, KEV flags, and more. | [rules.md](rules.md) |
|
||||||
| Channel catalog | Slack, Teams, Email, Webhook connectors loaded via restart-time plug-ins; metadata stored without secrets. | [`notifications/architecture.md`](architecture.md) |
|
| Channel catalog | Slack, Teams, Email, Webhook connectors loaded via restart-time plug-ins; metadata stored without secrets. | [architecture.md](architecture.md) |
|
||||||
| Templates | Locale-aware, deterministic rendering via safe helpers; channel defaults plus tenant-specific overrides, including the attestation lifecycle suite (`tmpl-attest-*`). | [`notifications/templates.md`](templates.md#7-attestation--signing-lifecycle-templates-notify-attest-74-001) |
|
| Templates | Locale-aware, deterministic rendering via safe helpers; channel defaults plus tenant-specific overrides, including the attestation lifecycle suite (`tmpl-attest-*`). | [templates.md](templates.md#7-attestation--signing-lifecycle-templates-notify-attest-74-001) |
|
||||||
| Digests | Coalesce bursts into periodic summaries with deterministic IDs and audit trails. | [`notifications/digests.md`](digests.md) |
|
| Digests | Coalesce bursts into periodic summaries with deterministic IDs and audit trails. | [digests.md](digests.md) |
|
||||||
| Delivery ledger | Tracks rendered payload hashes, attempts, throttles, and outcomes for every action. | [`modules/notify/architecture.md`](../modules/notify/architecture.md#7-data-model) |
|
| Delivery ledger | Tracks rendered payload hashes, attempts, throttles, and outcomes for every action. | [architecture.md](architecture.md#7-data-model) |
|
||||||
| Ack tokens | DSSE-signed acknowledgement tokens with webhook allowlists and escalation guardrails enforced by Authority. | [`modules/notify/architecture.md`](../modules/notify/architecture.md#81-ack-tokens--escalation-workflows) |
|
| Ack tokens | DSSE-signed acknowledgement tokens with webhook allowlists and escalation guardrails enforced by Authority. | [architecture.md](architecture.md#81-ack-tokens--escalation-workflows) |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -81,24 +81,24 @@ Each rule requires at least one action. Actions are deduplicated and sorted by `
|
|||||||
| `throttle` | ISO8601 duration? | Optional throttle TTL (`PT300S`, `PT1H`). Prevents duplicate deliveries when the same idempotency hash appears before expiry. |
|
| `throttle` | ISO8601 duration? | Optional throttle TTL (`PT300S`, `PT1H`). Prevents duplicate deliveries when the same idempotency hash appears before expiry. |
|
||||||
| `locale` | string? | BCP-47 tag (stored lower-case). Template lookup falls back to channel locale then `en-us`. |
|
| `locale` | string? | BCP-47 tag (stored lower-case). Template lookup falls back to channel locale then `en-us`. |
|
||||||
| `enabled` | bool | Disabled actions skip rendering but remain stored. |
|
| `enabled` | bool | Disabled actions skip rendering but remain stored. |
|
||||||
| `metadata` | map<string,string> | Connector-specific hints (priority, layout, etc.). |
|
| `metadata` | map<string,string> | Connector-specific hints (priority, layout, etc.). |
|
||||||
|
|
||||||
### 4.0 Attestation lifecycle templates
|
### 4.0 Attestation lifecycle templates
|
||||||
|
|
||||||
Rules targeting attestation/signing events (`attestor.verification.failed`, `attestor.attestation.expiring`, `authority.keys.revoked`, `attestor.transparency.anomaly`) must reference the dedicated template keys documented in [`notifications/templates.md` §7](templates.md#7-attestation--signing-lifecycle-templates-notify-attest-74-001) so payloads remain deterministic across channels and Offline Kits:
|
Rules targeting attestation/signing events (`attestor.verification.failed`, `attestor.attestation.expiring`, `authority.keys.revoked`, `attestor.transparency.anomaly`) must reference the dedicated template keys documented in [`templates.md` §7](templates.md#7-attestation--signing-lifecycle-templates-notify-attest-74-001) so payloads remain deterministic across channels and Offline Kits:
|
||||||
|
|
||||||
| Event kind | Required template key | Notes |
|
| Event kind | Required template key | Notes |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `attestor.verification.failed` | `tmpl-attest-verify-fail` | Include failure code, Rekor UUID/index, last good attestation link. |
|
| `attestor.verification.failed` | `tmpl-attest-verify-fail` | Include failure code, Rekor UUID/index, last good attestation link. |
|
||||||
| `attestor.attestation.expiring` | `tmpl-attest-expiry-warning` | Surface issued/expires timestamps, time remaining, renewal instructions. |
|
| `attestor.attestation.expiring` | `tmpl-attest-expiry-warning` | Surface issued/expires timestamps, time remaining, renewal instructions. |
|
||||||
| `authority.keys.revoked` / `authority.keys.rotated` | `tmpl-attest-key-rotation` | List rotation batch ID, impacted services, remediation steps. |
|
| `authority.keys.revoked` / `authority.keys.rotated` | `tmpl-attest-key-rotation` | List rotation batch ID, impacted services, remediation steps. |
|
||||||
| `attestor.transparency.anomaly` | `tmpl-attest-transparency-anomaly` | Highlight Rekor/witness metadata and anomaly classification. |
|
| `attestor.transparency.anomaly` | `tmpl-attest-transparency-anomaly` | Highlight Rekor/witness metadata and anomaly classification. |
|
||||||
|
|
||||||
Locale-specific variants keep the same template key while varying `locale`; rule actions shouldn't create ad-hoc templates for these events.
|
Locale-specific variants keep the same template key while varying `locale`; rule actions shouldn't create ad-hoc templates for these events.
|
||||||
|
|
||||||
### 4.1 Evaluation order
|
### 4.1 Evaluation order
|
||||||
|
|
||||||
1. Verify channel exists and is enabled; disabled channels mark the delivery as `Dropped`.
|
1. Verify channel exists and is enabled; disabled channels mark the delivery as `Dropped`.
|
||||||
2. Apply throttle idempotency key: `hash(ruleId|actionId|event.kind|scope.digest|delta.hash|dayBucket)`. Hits are logged as `Throttled`.
|
2. Apply throttle idempotency key: `hash(ruleId|actionId|event.kind|scope.digest|delta.hash|dayBucket)`. Hits are logged as `Throttled`.
|
||||||
3. If the action defines a digest window other than `instant`, append the event to the open window and defer delivery until flush.
|
3. If the action defines a digest window other than `instant`, append the event to the open window and defer delivery until flush.
|
||||||
4. When delivery proceeds, the renderer resolves the template, locale, and metadata before invoking the connector.
|
4. When delivery proceeds, the renderer resolves the template, locale, and metadata before invoking the connector.
|
||||||
@@ -3,4 +3,4 @@
|
|||||||
- Classify merge fields: identifiers (hash), secrets (strip), PII (mask), operational metadata (retain).
|
- Classify merge fields: identifiers (hash), secrets (strip), PII (mask), operational metadata (retain).
|
||||||
- Storage and previews must use redacted forms by default; full bodies allowed only with `Notify.Audit` permission.
|
- Storage and previews must use redacted forms by default; full bodies allowed only with `Notify.Audit` permission.
|
||||||
- Log payloads must omit secrets; hashes use BLAKE3-256 over UTF-8 normalized values.
|
- Log payloads must omit secrets; hashes use BLAKE3-256 over UTF-8 normalized values.
|
||||||
- Fixtures under `docs/notifications/fixtures/redaction/` show expected redacted shapes for templates and receipts.
|
- Fixtures under `docs/modules/notify/fixtures/redaction/` show expected redacted shapes for templates and receipts.
|
||||||
@@ -81,6 +81,6 @@ Purpose: define the payload emitted by Telemetry SLO evaluators toward Notifier
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Evidence to surface in sprint tasks
|
### Evidence to surface in sprint tasks
|
||||||
- File: `docs/notifications/slo-webhook-schema.md` (this document).
|
- File: `docs/modules/notify/slo-webhook-schema.md` (this document).
|
||||||
- Sample payload (canonical) and validation checklist above.
|
- Sample payload (canonical) and validation checklist above.
|
||||||
- Dependencies: upstream Telemetry evaluator must emit `metric.labels` sanitized; Notifier to persist `id` for idempotency.
|
- Dependencies: upstream Telemetry evaluator must emit `metric.labels` sanitized; Notifier to persist `id` for idempotency.
|
||||||
@@ -17,7 +17,7 @@ Platform module describes cross-cutting architecture, contracts, and guardrails
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
> **Ownership:** Architecture Guild • Docs Guild
|
> **Ownership:** Architecture Guild • Docs Guild
|
||||||
> **Audience:** Service owners, platform engineers, solution architects
|
> **Audience:** Service owners, platform engineers, solution architects
|
||||||
> **Related:** [High-Level Architecture](../../07_HIGH_LEVEL_ARCHITECTURE.md), [Concelier Architecture](../concelier/architecture.md), [Policy Engine Architecture](../policy/architecture.md), [Aggregation-Only Contract](../../ingestion/aggregation-only-contract.md)
|
> **Related:** [High-Level Architecture](../../07_HIGH_LEVEL_ARCHITECTURE.md), [Concelier Architecture](../concelier/architecture.md), [Policy Engine Architecture](../policy/architecture.md), [Aggregation-Only Contract](../../aoc/aggregation-only-contract.md)
|
||||||
|
|
||||||
This dossier summarises the end-to-end runtime topology after the Aggregation-Only Contract (AOC) rollout. It highlights where raw facts live, how ingest services enforce guardrails, and how downstream components consume those facts to derive policy decisions and user-facing experiences.
|
This dossier summarises the end-to-end runtime topology after the Aggregation-Only Contract (AOC) rollout. It highlights where raw facts live, how ingest services enforce guardrails, and how downstream components consume those facts to derive policy decisions and user-facing experiences.
|
||||||
|
|
||||||
@@ -158,13 +158,13 @@ sequenceDiagram
|
|||||||
|
|
||||||
- **Offline Kit:** Packages raw PostgreSQL snapshots (`advisory_raw`, `vex_raw`) plus guard configuration and CLI verifier binaries so air-gapped sites can re-run AOC checks before promotion.
|
- **Offline Kit:** Packages raw PostgreSQL snapshots (`advisory_raw`, `vex_raw`) plus guard configuration and CLI verifier binaries so air-gapped sites can re-run AOC checks before promotion.
|
||||||
- **Recovery:** Supersedes chains allow rollback to prior revisions without mutating rows. Disaster exercises must rehearse restoring from snapshot, replaying logical replication into Policy Engine, and re-validating guard compliance.
|
- **Recovery:** Supersedes chains allow rollback to prior revisions without mutating rows. Disaster exercises must rehearse restoring from snapshot, replaying logical replication into Policy Engine, and re-validating guard compliance.
|
||||||
- **Migration:** Legacy normalised fields are moved to temporary views during cutover; ingestion runtime removes writes once guard-enforced path is live (see [Migration playbook](../../ingestion/aggregation-only-contract.md#8-migration-playbook)).
|
- **Migration:** Legacy normalised fields are moved to temporary views during cutover; ingestion runtime removes writes once guard-enforced path is live (see [Migration playbook](../../aoc/aggregation-only-contract.md#8-migration-playbook)).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 5 · Replay CAS & deterministic bundles
|
## 5 · Replay CAS & deterministic bundles
|
||||||
|
|
||||||
- **Replay CAS:** Content-addressed storage lives under `cas://replay/<sha256-prefix>/<digest>.tar.zst`. Writers must use [StellaOps.Replay.Core](../../src/__Libraries/StellaOps.Replay.Core/AGENTS.md) helpers to ensure lexicographic file ordering, POSIX mode normalisation (0644/0755), LF newlines, zstd level 19 compression, and shard-by-prefix CAS URIs (`BuildCasUri`). Bundle metadata (size, hash, created) feeds the platform-wide `replay_bundles` collection defined in `docs/data/replay_schema.md`.
|
- **Replay CAS:** Content-addressed storage lives under `cas://replay/<sha256-prefix>/<digest>.tar.zst`. Writers must use [StellaOps.Replay.Core](../../src/__Libraries/StellaOps.Replay.Core/AGENTS.md) helpers to ensure lexicographic file ordering, POSIX mode normalisation (0644/0755), LF newlines, zstd level 19 compression, and shard-by-prefix CAS URIs (`BuildCasUri`). Bundle metadata (size, hash, created) feeds the platform-wide `replay_bundles` collection defined in `docs/db/replay-schema.md`.
|
||||||
- **Artifacts:** Each recorded scan stores three bundles:
|
- **Artifacts:** Each recorded scan stores three bundles:
|
||||||
1. `manifest.json` (canonical JSON, hashed and signed via DSSE).
|
1. `manifest.json` (canonical JSON, hashed and signed via DSSE).
|
||||||
2. `inputbundle.tar.zst` (feeds, policies, tools, environment snapshot).
|
2. `inputbundle.tar.zst` (feeds, policies, tools, environment snapshot).
|
||||||
@@ -179,14 +179,14 @@ sequenceDiagram
|
|||||||
|
|
||||||
## 6 · References
|
## 6 · References
|
||||||
|
|
||||||
- [Aggregation-Only Contract reference](../../ingestion/aggregation-only-contract.md)
|
- [Aggregation-Only Contract reference](../../aoc/aggregation-only-contract.md)
|
||||||
- [Concelier architecture](../concelier/architecture.md)
|
- [Concelier architecture](../concelier/architecture.md)
|
||||||
- [Excititor architecture](../excititor/architecture.md)
|
- [Excititor architecture](../excititor/architecture.md)
|
||||||
- [Policy Engine architecture](../policy/architecture.md)
|
- [Policy Engine architecture](../policy/architecture.md)
|
||||||
- [Authority service](../authority/architecture.md)
|
- [Authority service](../authority/architecture.md)
|
||||||
- [Replay specification](../../replay/DETERMINISTIC_REPLAY.md)
|
- [Replay specification](../../replay/DETERMINISTIC_REPLAY.md)
|
||||||
- [Replay developer guide](../../replay/DEVS_GUIDE_REPLAY.md)
|
- [Replay developer guide](../../replay/DEVS_GUIDE_REPLAY.md)
|
||||||
- [Replay schema](../../data/replay_schema.md) *(pending)*
|
- [Replay schema](../../db/replay-schema.md)
|
||||||
- [Replay test strategy](../../replay/TEST_STRATEGY.md) *(draft)*
|
- [Replay test strategy](../../replay/TEST_STRATEGY.md) *(draft)*
|
||||||
- [Observability standards (upcoming)](../../observability/policy.md) – interim reference for telemetry naming.
|
- [Observability standards (upcoming)](../../observability/policy.md) – interim reference for telemetry naming.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ This module aggregates cross-cutting contracts and guardrails that every StellaO
|
|||||||
## Anchors
|
## Anchors
|
||||||
- High-level system view: `../../07_HIGH_LEVEL_ARCHITECTURE.md`
|
- High-level system view: `../../07_HIGH_LEVEL_ARCHITECTURE.md`
|
||||||
- Platform overview: `architecture-overview.md`
|
- Platform overview: `architecture-overview.md`
|
||||||
- Aggregation-Only Contract: `../ingestion/aggregation-only-contract.md` (referenced across ingestion/observability docs)
|
- Aggregation-Only Contract: `../../aoc/aggregation-only-contract.md` (referenced across ingestion/observability docs)
|
||||||
|
|
||||||
## Scope
|
## Scope
|
||||||
- **Identity & tenancy**: Authority-issued OpToks, tenant scoping, RBAC, short TTLs; see Authority module docs.
|
- **Identity & tenancy**: Authority-issued OpToks, tenant scoping, RBAC, short TTLs; see Authority module docs.
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ Policy Engine compiles and evaluates Stella DSL policies deterministically, prod
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
> **Ownership:** Policy Guild • Platform Guild
|
> **Ownership:** Policy Guild • Platform Guild
|
||||||
> **Services:** `StellaOps.Policy.Engine` (Minimal API + worker host)
|
> **Services:** `StellaOps.Policy.Engine` (Minimal API + worker host)
|
||||||
> **Data Stores:** PostgreSQL (`policy.*` schemas for packs, runs, exceptions, receipts), Object storage (explain bundles), optional queue
|
> **Data Stores:** PostgreSQL (`policy.*` schemas for packs, runs, exceptions, receipts), Object storage (explain bundles), optional queue
|
||||||
> **Related docs:** [Policy overview](../../policy/overview.md), [DSL](../../policy/dsl.md), [SPL v1](../../policy/spl-v1.md), [Lifecycle](../../policy/lifecycle.md), [Runtime](../../policy/runtime.md), [Governance](../../policy/governance.md), [REST API](../../policy/api.md), [Policy CLI](../cli/guides/policy.md), [Architecture overview](../platform/architecture-overview.md), [AOC reference](../../ingestion/aggregation-only-contract.md)
|
> **Related docs:** [Policy overview](../../policy/overview.md), [DSL](../../policy/dsl.md), [SPL v1](../../policy/spl-v1.md), [Lifecycle](../../policy/lifecycle.md), [Runtime](../../policy/runtime.md), [Governance](../../policy/governance.md), [REST API](../../policy/api.md), [Policy CLI](../cli/guides/policy.md), [Architecture overview](../platform/architecture-overview.md), [AOC reference](../../aoc/aggregation-only-contract.md)
|
||||||
|
|
||||||
This dossier describes the internal structure of the Policy Engine service delivered in Epic 2. It focuses on module boundaries, deterministic evaluation, orchestration, and integration contracts with Concelier, Excititor, SBOM Service, Authority, Scheduler, and Observability stacks.
|
This dossier describes the internal structure of the Policy Engine service delivered in Epic 2. It focuses on module boundaries, deterministic evaluation, orchestration, and integration contracts with Concelier, Excititor, SBOM Service, Authority, Scheduler, and Observability stacks.
|
||||||
|
|
||||||
@@ -111,7 +111,7 @@ Key notes:
|
|||||||
| **Authority Client** (`Authority/`) | Acquire tokens, enforce scopes, perform DPoP key rotation. | Only service identity uses `effective:write`. |
|
| **Authority Client** (`Authority/`) | Acquire tokens, enforce scopes, perform DPoP key rotation. | Only service identity uses `effective:write`. |
|
||||||
| **DSL Compiler** (`Dsl/`) | Parse, canonicalise, IR generation, checksum caching. | Uses Roslyn-like pipeline; caches by `policyId+version+hash`. |
|
| **DSL Compiler** (`Dsl/`) | Parse, canonicalise, IR generation, checksum caching. | Uses Roslyn-like pipeline; caches by `policyId+version+hash`. |
|
||||||
| **Selection Layer** (`Selection/`) | Batch SBOM ↔ advisory ↔ VEX joiners; apply equivalence tables; support incremental cursors. | Deterministic ordering (SBOM → advisory → VEX). |
|
| **Selection Layer** (`Selection/`) | Batch SBOM ↔ advisory ↔ VEX joiners; apply equivalence tables; support incremental cursors. | Deterministic ordering (SBOM → advisory → VEX). |
|
||||||
| **Evaluator** (`Evaluation/`) | Execute IR with first-match semantics, compute severity/trust/reachability weights, record rule hits, and emit a unified confidence score with factor breakdown (reachability/runtime/VEX/provenance/policy). | Stateless; all inputs provided by selection layer. |
|
| **Evaluator** (`Evaluation/`) | Execute IR with first-match semantics, compute severity/trust/reachability weights, record rule hits, and emit a unified confidence score with factor breakdown (reachability/runtime/VEX/provenance/policy). | Stateless; all inputs provided by selection layer. |
|
||||||
| **Signals** (`Signals/`) | Normalizes reachability, trust, entropy, uncertainty, runtime hits into a single dictionary passed to Evaluator; supplies default `unknown` values when signals missing. Entropy penalties are derived from Scanner `layer_summary.json`/`entropy.report.json` (K=0.5, cap=0.3, block at image opaque ratio > 0.15 w/ unknown provenance) and exported via `policy_entropy_penalty_value` / `policy_entropy_image_opaque_ratio`; SPL scope `entropy.*` exposes `penalty`, `image_opaque_ratio`, `blocked`, `warned`, `capped`, `top_file_opaque_ratio`. | Aligns with `signals.*` namespace in DSL. |
|
| **Signals** (`Signals/`) | Normalizes reachability, trust, entropy, uncertainty, runtime hits into a single dictionary passed to Evaluator; supplies default `unknown` values when signals missing. Entropy penalties are derived from Scanner `layer_summary.json`/`entropy.report.json` (K=0.5, cap=0.3, block at image opaque ratio > 0.15 w/ unknown provenance) and exported via `policy_entropy_penalty_value` / `policy_entropy_image_opaque_ratio`; SPL scope `entropy.*` exposes `penalty`, `image_opaque_ratio`, `blocked`, `warned`, `capped`, `top_file_opaque_ratio`. | Aligns with `signals.*` namespace in DSL. |
|
||||||
| **Materialiser** (`Materialization/`) | Upsert effective findings, append history, manage explain bundle exports. | PostgreSQL transactions per SBOM chunk. |
|
| **Materialiser** (`Materialization/`) | Upsert effective findings, append history, manage explain bundle exports. | PostgreSQL transactions per SBOM chunk. |
|
||||||
| **Orchestrator** (`Runs/`) | Change-stream ingestion, fairness, retry/backoff, queue writer. | Works with Scheduler Models DTOs. |
|
| **Orchestrator** (`Runs/`) | Change-stream ingestion, fairness, retry/backoff, queue writer. | Works with Scheduler Models DTOs. |
|
||||||
@@ -203,150 +203,150 @@ Determinism guard instrumentation wraps the evaluator, rejecting access to forbi
|
|||||||
|
|
||||||
All payloads are immutable and include analyzer fingerprints (`scanner.native@sha256:...`, `policyEngine@sha256:...`) so replay tooling can recompute identical digests. Determinism tests cover both the OpenVEX JSON and the DSSE payload bytes.
|
All payloads are immutable and include analyzer fingerprints (`scanner.native@sha256:...`, `policyEngine@sha256:...`) so replay tooling can recompute identical digests. Determinism tests cover both the OpenVEX JSON and the DSSE payload bytes.
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 6.2 · Trust Lattice Policy Gates
|
### 6.2 · Trust Lattice Policy Gates
|
||||||
|
|
||||||
The Policy Engine evaluates Trust Lattice gates after claim score merging to enforce trust-based constraints on VEX verdicts.
|
The Policy Engine evaluates Trust Lattice gates after claim score merging to enforce trust-based constraints on VEX verdicts.
|
||||||
|
|
||||||
#### Gate Interface
|
#### Gate Interface
|
||||||
|
|
||||||
```csharp
|
```csharp
|
||||||
public interface IPolicyGate
|
public interface IPolicyGate
|
||||||
{
|
{
|
||||||
Task<GateResult> EvaluateAsync(
|
Task<GateResult> EvaluateAsync(
|
||||||
MergeResult mergeResult,
|
MergeResult mergeResult,
|
||||||
PolicyGateContext context,
|
PolicyGateContext context,
|
||||||
CancellationToken ct = default);
|
CancellationToken ct = default);
|
||||||
}
|
}
|
||||||
|
|
||||||
public sealed record GateResult
|
public sealed record GateResult
|
||||||
{
|
{
|
||||||
public required string GateName { get; init; }
|
public required string GateName { get; init; }
|
||||||
public required bool Passed { get; init; }
|
public required bool Passed { get; init; }
|
||||||
public string? Reason { get; init; }
|
public string? Reason { get; init; }
|
||||||
public ImmutableDictionary<string, object> Details { get; init; }
|
public ImmutableDictionary<string, object> Details { get; init; }
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Available Gates
|
#### Available Gates
|
||||||
|
|
||||||
| Gate | Purpose | Configuration Key |
|
| Gate | Purpose | Configuration Key |
|
||||||
|------|---------|-------------------|
|
|------|---------|-------------------|
|
||||||
| **MinimumConfidenceGate** | Reject verdicts below confidence threshold per environment | `gates.minimumConfidence` |
|
| **MinimumConfidenceGate** | Reject verdicts below confidence threshold per environment | `gates.minimumConfidence` |
|
||||||
| **UnknownsBudgetGate** | Fail scan if unknowns exceed budget | `gates.unknownsBudget` |
|
| **UnknownsBudgetGate** | Fail scan if unknowns exceed budget | `gates.unknownsBudget` |
|
||||||
| **SourceQuotaGate** | Prevent single-source dominance without corroboration | `gates.sourceQuota` |
|
| **SourceQuotaGate** | Prevent single-source dominance without corroboration | `gates.sourceQuota` |
|
||||||
| **ReachabilityRequirementGate** | Require reachability proof for critical CVEs | `gates.reachabilityRequirement` |
|
| **ReachabilityRequirementGate** | Require reachability proof for critical CVEs | `gates.reachabilityRequirement` |
|
||||||
| **EvidenceFreshnessGate** | Reject stale evidence below freshness threshold | `gates.evidenceFreshness` |
|
| **EvidenceFreshnessGate** | Reject stale evidence below freshness threshold | `gates.evidenceFreshness` |
|
||||||
|
|
||||||
#### MinimumConfidenceGate
|
#### MinimumConfidenceGate
|
||||||
|
|
||||||
Requires minimum confidence threshold for suppression verdicts:
|
Requires minimum confidence threshold for suppression verdicts:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
gates:
|
gates:
|
||||||
minimumConfidence:
|
minimumConfidence:
|
||||||
enabled: true
|
enabled: true
|
||||||
thresholds:
|
thresholds:
|
||||||
production: 0.75 # High bar for production
|
production: 0.75 # High bar for production
|
||||||
staging: 0.60 # Moderate for staging
|
staging: 0.60 # Moderate for staging
|
||||||
development: 0.40 # Permissive for dev
|
development: 0.40 # Permissive for dev
|
||||||
applyToStatuses:
|
applyToStatuses:
|
||||||
- not_affected
|
- not_affected
|
||||||
- fixed
|
- fixed
|
||||||
```
|
```
|
||||||
|
|
||||||
- **Behavior**: `affected` status bypasses this gate (conservative default).
|
- **Behavior**: `affected` status bypasses this gate (conservative default).
|
||||||
- **Result**: `confidence_below_threshold` when verdict confidence < environment threshold.
|
- **Result**: `confidence_below_threshold` when verdict confidence < environment threshold.
|
||||||
|
|
||||||
#### UnknownsBudgetGate
|
#### UnknownsBudgetGate
|
||||||
|
|
||||||
Limits exposure to unknown/unscored dependencies:
|
Limits exposure to unknown/unscored dependencies:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
gates:
|
gates:
|
||||||
unknownsBudget:
|
unknownsBudget:
|
||||||
enabled: true
|
enabled: true
|
||||||
maxUnknownCount: 5
|
maxUnknownCount: 5
|
||||||
maxCumulativeUncertainty: 2.0
|
maxCumulativeUncertainty: 2.0
|
||||||
escalateOnExceed: true
|
escalateOnExceed: true
|
||||||
```
|
```
|
||||||
|
|
||||||
- **Behavior**: Fails when unknowns exceed count limit OR cumulative uncertainty exceeds budget.
|
- **Behavior**: Fails when unknowns exceed count limit OR cumulative uncertainty exceeds budget.
|
||||||
- **Cumulative uncertainty**: `sum(1 - ClaimScore)` across all verdicts.
|
- **Cumulative uncertainty**: `sum(1 - ClaimScore)` across all verdicts.
|
||||||
|
|
||||||
#### SourceQuotaGate
|
#### SourceQuotaGate
|
||||||
|
|
||||||
Prevents single-source verdicts without corroboration:
|
Prevents single-source verdicts without corroboration:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
gates:
|
gates:
|
||||||
sourceQuota:
|
sourceQuota:
|
||||||
enabled: true
|
enabled: true
|
||||||
maxInfluencePercent: 60
|
maxInfluencePercent: 60
|
||||||
corroborationDelta: 0.10
|
corroborationDelta: 0.10
|
||||||
requireCorroboration: true
|
requireCorroboration: true
|
||||||
```
|
```
|
||||||
|
|
||||||
- **Behavior**: Fails when single source provides > 60% of verdict weight AND no second source is within delta (0.10).
|
- **Behavior**: Fails when single source provides > 60% of verdict weight AND no second source is within delta (0.10).
|
||||||
- **Rationale**: Ensures critical decisions have multi-source validation.
|
- **Rationale**: Ensures critical decisions have multi-source validation.
|
||||||
|
|
||||||
#### ReachabilityRequirementGate
|
#### ReachabilityRequirementGate
|
||||||
|
|
||||||
Requires reachability proof for high-severity vulnerabilities:
|
Requires reachability proof for high-severity vulnerabilities:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
gates:
|
gates:
|
||||||
reachabilityRequirement:
|
reachabilityRequirement:
|
||||||
enabled: true
|
enabled: true
|
||||||
applySeverities:
|
applySeverities:
|
||||||
- critical
|
- critical
|
||||||
- high
|
- high
|
||||||
exemptStatuses:
|
exemptStatuses:
|
||||||
- not_affected
|
- not_affected
|
||||||
bypassReasons:
|
bypassReasons:
|
||||||
- component_not_present
|
- component_not_present
|
||||||
```
|
```
|
||||||
|
|
||||||
- **Behavior**: Fails when CRITICAL/HIGH CVE marked `not_affected` lacks reachability proof (unless bypass reason applies).
|
- **Behavior**: Fails when CRITICAL/HIGH CVE marked `not_affected` lacks reachability proof (unless bypass reason applies).
|
||||||
|
|
||||||
#### Gate Registry
|
#### Gate Registry
|
||||||
|
|
||||||
Gates are registered via DI and evaluated in sequence:
|
Gates are registered via DI and evaluated in sequence:
|
||||||
|
|
||||||
```csharp
|
```csharp
|
||||||
public interface IPolicyGateRegistry
|
public interface IPolicyGateRegistry
|
||||||
{
|
{
|
||||||
IEnumerable<IPolicyGate> GetEnabledGates(string environment);
|
IEnumerable<IPolicyGate> GetEnabledGates(string environment);
|
||||||
Task<GateEvaluationResult> EvaluateAllAsync(
|
Task<GateEvaluationResult> EvaluateAllAsync(
|
||||||
MergeResult mergeResult,
|
MergeResult mergeResult,
|
||||||
PolicyGateContext context,
|
PolicyGateContext context,
|
||||||
CancellationToken ct = default);
|
CancellationToken ct = default);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Gate Metrics
|
#### Gate Metrics
|
||||||
|
|
||||||
- `policy_gate_evaluations_total{gate,result}` — Count of gate evaluations by outcome
|
- `policy_gate_evaluations_total{gate,result}` — Count of gate evaluations by outcome
|
||||||
- `policy_gate_failures_total{gate,reason}` — Count of gate failures by reason
|
- `policy_gate_failures_total{gate,reason}` — Count of gate failures by reason
|
||||||
- `policy_gate_latency_seconds{gate}` — Gate evaluation latency histogram
|
- `policy_gate_latency_seconds{gate}` — Gate evaluation latency histogram
|
||||||
|
|
||||||
#### Gate Implementation Reference
|
#### Gate Implementation Reference
|
||||||
|
|
||||||
| Gate | Source File |
|
| Gate | Source File |
|
||||||
|------|-------------|
|
|------|-------------|
|
||||||
| MinimumConfidenceGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/MinimumConfidenceGate.cs` |
|
| MinimumConfidenceGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/MinimumConfidenceGate.cs` |
|
||||||
| UnknownsBudgetGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/UnknownsBudgetGate.cs` |
|
| UnknownsBudgetGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/UnknownsBudgetGate.cs` |
|
||||||
| SourceQuotaGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/SourceQuotaGate.cs` |
|
| SourceQuotaGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/SourceQuotaGate.cs` |
|
||||||
| ReachabilityRequirementGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/ReachabilityRequirementGate.cs` |
|
| ReachabilityRequirementGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/ReachabilityRequirementGate.cs` |
|
||||||
| EvidenceFreshnessGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/EvidenceFreshnessGate.cs` |
|
| EvidenceFreshnessGate | `src/Policy/__Libraries/StellaOps.Policy/Gates/EvidenceFreshnessGate.cs` |
|
||||||
|
|
||||||
See `etc/policy-gates.yaml.sample` for complete gate configuration options.
|
See `etc/policy-gates.yaml.sample` for complete gate configuration options.
|
||||||
|
|
||||||
**Related Documentation:**
|
**Related Documentation:**
|
||||||
- [Trust Lattice Specification](../excititor/trust-lattice.md)
|
- [Trust Lattice Specification](../excititor/trust-lattice.md)
|
||||||
- [Verdict Manifest Specification](../authority/verdict-manifest.md)
|
- [Verdict Manifest Specification](../authority/verdict-manifest.md)
|
||||||
---
|
---
|
||||||
|
|
||||||
## 7 · Security & Tenancy
|
## 7 · Security & Tenancy
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
# Provcache Module
|
# Provcache Module
|
||||||
|
|
||||||
|
> **Status: Planned** — This module is documented for upcoming implementation in Sprint 8200. The design is finalized but source code does not yet exist.
|
||||||
|
|
||||||
> Provenance Cache — Maximizing Trust Evidence Density
|
> Provenance Cache — Maximizing Trust Evidence Density
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ The registry module issues scoped pull tokens for mirrored container registries
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ Scanner analyses container images layer-by-layer, producing deterministic SBOM f
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Scheduler detects advisory/VEX deltas, computes impact windows, and orchestrates
|
|||||||
5. On completion, set status to `DONE` in both the sprint file and `TASKS.md`; if paused, revert to `TODO` and add a brief note.
|
5. On completion, set status to `DONE` in both the sprint file and `TASKS.md`; if paused, revert to `TODO` and add a brief note.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see `../../ingestion/aggregation-only-contract.md`).
|
- Honour the Aggregation-Only Contract where applicable (see `../../aoc/aggregation-only-contract.md`).
|
||||||
- No undocumented schema or API contract changes; document deltas in architecture or implementation_plan.
|
- No undocumented schema or API contract changes; document deltas in architecture or implementation_plan.
|
||||||
- Keep Offline Kit parity—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity—document air-gapped workflows for any new feature.
|
||||||
- Prefer deterministic fixtures and avoid machine-specific artefacts in examples.
|
- Prefer deterministic fixtures and avoid machine-specific artefacts in examples.
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ Signer validates callers, enforces Proof-of-Entitlement, and produces signed DSS
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ Telemetry module captures deployment and operations guidance for the shared obse
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ The Console presents operator dashboards for scans, policies, VEX evidence, runt
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Zastava monitors running workloads, verifies supply chain posture, and enforces
|
|||||||
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
|
||||||
|
|
||||||
## Guardrails
|
## Guardrails
|
||||||
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
|
- Honour the Aggregation-Only Contract where applicable (see ../../aoc/aggregation-only-contract.md).
|
||||||
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
|
||||||
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
|
||||||
- Update runbooks/observability assets when operational characteristics change.
|
- Update runbooks/observability assets when operational characteristics change.
|
||||||
|
|||||||
@@ -66,15 +66,15 @@ stellaops/zastava-agent # System service; watch Docker events; observer on
|
|||||||
"imageRef": "ghcr.io/acme/api@sha256:abcd…",
|
"imageRef": "ghcr.io/acme/api@sha256:abcd…",
|
||||||
"owner": { "kind": "Deployment", "name": "api" }
|
"owner": { "kind": "Deployment", "name": "api" }
|
||||||
},
|
},
|
||||||
"process": {
|
"process": {
|
||||||
"pid": 12345,
|
"pid": 12345,
|
||||||
"entrypoint": ["/entrypoint.sh", "--serve"],
|
"entrypoint": ["/entrypoint.sh", "--serve"],
|
||||||
"entryTrace": [
|
"entryTrace": [
|
||||||
{"file":"/entrypoint.sh","line":3,"op":"exec","target":"/usr/bin/python3"},
|
{"file":"/entrypoint.sh","line":3,"op":"exec","target":"/usr/bin/python3"},
|
||||||
{"file":"<argv>","op":"python","target":"/opt/app/server.py"}
|
{"file":"<argv>","op":"python","target":"/opt/app/server.py"}
|
||||||
],
|
],
|
||||||
"buildId": "9f3a1cd4c0b7adfe91c0e3b51d2f45fb0f76a4c1"
|
"buildId": "9f3a1cd4c0b7adfe91c0e3b51d2f45fb0f76a4c1"
|
||||||
},
|
},
|
||||||
"loadedLibs": [
|
"loadedLibs": [
|
||||||
{ "path": "/lib/x86_64-linux-gnu/libssl.so.3", "inode": 123456, "sha256": "…"},
|
{ "path": "/lib/x86_64-linux-gnu/libssl.so.3", "inode": 123456, "sha256": "…"},
|
||||||
{ "path": "/usr/lib/x86_64-linux-gnu/libcrypto.so.3", "inode": 123457, "sha256": "…"}
|
{ "path": "/usr/lib/x86_64-linux-gnu/libcrypto.so.3", "inode": 123457, "sha256": "…"}
|
||||||
@@ -116,35 +116,35 @@ stellaops/zastava-agent # System service; watch Docker events; observer on
|
|||||||
],
|
],
|
||||||
"decision": "Allow|Deny",
|
"decision": "Allow|Deny",
|
||||||
"ttlSeconds": 300
|
"ttlSeconds": 300
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2.3 Schema negotiation & hashing guarantees
|
### 2.3 Schema negotiation & hashing guarantees
|
||||||
|
|
||||||
* Every payload is wrapped in an envelope with `schemaVersion` set to `"<schema>@v<major>.<minor>"`. Version negotiation keeps the **major** line in lockstep (`zastava.runtime.event@v1.x`, `zastava.admission.decision@v1.x`) and selects the highest mutually supported **minor**. If no overlap exists, the local default (`@v1.0`) is used.
|
* Every payload is wrapped in an envelope with `schemaVersion` set to `"<schema>@v<major>.<minor>"`. Version negotiation keeps the **major** line in lockstep (`zastava.runtime.event@v1.x`, `zastava.admission.decision@v1.x`) and selects the highest mutually supported **minor**. If no overlap exists, the local default (`@v1.0`) is used.
|
||||||
* Components use the shared `ZastavaContractVersions` helper for parsing/negotiation and the canonical JSON serializer to guarantee identical byte sequences prior to hashing, ensuring multihash IDs such as `sha256-<base64url>` are reproducible across observers, webhooks, and backend jobs.
|
* Components use the shared `ZastavaContractVersions` helper for parsing/negotiation and the canonical JSON serializer to guarantee identical byte sequences prior to hashing, ensuring multihash IDs such as `sha256-<base64url>` are reproducible across observers, webhooks, and backend jobs.
|
||||||
* Schema evolution rules: backwards-compatible fields append to the end of the canonical property order; breaking changes bump the **major** and require dual-writer/reader rollout per deployment playbook.
|
* Schema evolution rules: backwards-compatible fields append to the end of the canonical property order; breaking changes bump the **major** and require dual-writer/reader rollout per deployment playbook.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 3) Observer — node agent (DaemonSet)
|
## 3) Observer — node agent (DaemonSet)
|
||||||
|
|
||||||
### 3.1 Responsibilities
|
### 3.1 Responsibilities
|
||||||
|
|
||||||
* **Watch** container lifecycle (start/stop) via CRI (`/run/containerd/containerd.sock` gRPC read‑only) or `/var/log/containers/*.log` tail fallback.
|
* **Watch** container lifecycle (start/stop) via CRI (`/run/containerd/containerd.sock` gRPC read‑only) or `/var/log/containers/*.log` tail fallback.
|
||||||
* **Resolve** container → image digest, mount point rootfs.
|
* **Resolve** container → image digest, mount point rootfs.
|
||||||
* **Trace entrypoint**: attach **short‑lived** nsenter/exec to PID 1 in container, parse shell for `exec` chain (bounded depth), record **terminal program**.
|
* **Trace entrypoint**: attach **short‑lived** nsenter/exec to PID 1 in container, parse shell for `exec` chain (bounded depth), record **terminal program**.
|
||||||
* **Sample loaded libs**: read `/proc/<pid>/maps` and `exe` symlink to collect **actually loaded** DSOs; compute **sha256** for each mapped file (bounded count/size).
|
* **Sample loaded libs**: read `/proc/<pid>/maps` and `exe` symlink to collect **actually loaded** DSOs; compute **sha256** for each mapped file (bounded count/size).
|
||||||
* **Record GNU build-id**: parse `NT_GNU_BUILD_ID` from `/proc/<pid>/exe` and attach the normalized hex to runtime events for symbol/debug-store correlation.
|
* **Record GNU build-id**: parse `NT_GNU_BUILD_ID` from `/proc/<pid>/exe` and attach the normalized hex to runtime events for symbol/debug-store correlation.
|
||||||
* **Posture check** (cheap):
|
* **Posture check** (cheap):
|
||||||
|
|
||||||
* Image signature presence (if cosign policies are local; else ask backend).
|
* Image signature presence (if cosign policies are local; else ask backend).
|
||||||
* SBOM **referrers** presence (HEAD to registry, optional).
|
* SBOM **referrers** presence (HEAD to registry, optional).
|
||||||
* Rekor UUID known (query Scanner.WebService by image digest).
|
* Rekor UUID known (query Scanner.WebService by image digest).
|
||||||
* **Publish runtime events** to Scanner.WebService `/runtime/events` (batch & compress).
|
* **Publish runtime events** to Scanner.WebService `/runtime/events` (batch & compress).
|
||||||
* **Request delta scan** if: no SBOM in catalog OR base differs from known baseline.
|
* **Request delta scan** if: no SBOM in catalog OR base differs from known baseline.
|
||||||
|
|
||||||
### 3.2 Privileges & mounts (K8s)
|
### 3.2 Privileges & mounts (K8s)
|
||||||
|
|
||||||
* **SecurityContext:** `runAsUser: 0`, `readOnlyRootFilesystem: true`, `allowPrivilegeEscalation: false`.
|
* **SecurityContext:** `runAsUser: 0`, `readOnlyRootFilesystem: true`, `allowPrivilegeEscalation: false`.
|
||||||
* **Capabilities:** `CAP_SYS_PTRACE` (optional if using nsenter trace), `CAP_DAC_READ_SEARCH`.
|
* **Capabilities:** `CAP_SYS_PTRACE` (optional if using nsenter trace), `CAP_DAC_READ_SEARCH`.
|
||||||
@@ -154,22 +154,22 @@ stellaops/zastava-agent # System service; watch Docker events; observer on
|
|||||||
* `/run/containerd/containerd.sock` (or CRI‑O socket)
|
* `/run/containerd/containerd.sock` (or CRI‑O socket)
|
||||||
* `/var/lib/containerd/io.containerd.runtime.v2.task` (rootfs paths & pids)
|
* `/var/lib/containerd/io.containerd.runtime.v2.task` (rootfs paths & pids)
|
||||||
* **Networking:** cluster‑internal egress to Scanner.WebService only.
|
* **Networking:** cluster‑internal egress to Scanner.WebService only.
|
||||||
* **Rate limits:** hard caps for bytes hashed and file count per container to avoid noisy tenants.
|
* **Rate limits:** hard caps for bytes hashed and file count per container to avoid noisy tenants.
|
||||||
|
|
||||||
### 3.3 Event batching
|
### 3.3 Event batching
|
||||||
|
|
||||||
* Buffer ND‑JSON; flush by **N events** or **2 s**.
|
* Buffer ND‑JSON; flush by **N events** or **2 s**.
|
||||||
* Backpressure: local disk ring buffer (50 MB default) if Scanner is temporarily unavailable; drop oldest after cap with **metrics** and **warning** event.
|
* Backpressure: local disk ring buffer (50 MB default) if Scanner is temporarily unavailable; drop oldest after cap with **metrics** and **warning** event.
|
||||||
|
|
||||||
### 3.4 Build-id capture & validation workflow
|
### 3.4 Build-id capture & validation workflow
|
||||||
|
|
||||||
1. When Observer sees a `CONTAINER_START` it dereferences `/proc/<pid>/exe`, extracts the `NT_GNU_BUILD_ID` note, normalises it to lower-case hex, and sends it as `process.buildId` in the runtime envelope.
|
1. When Observer sees a `CONTAINER_START` it dereferences `/proc/<pid>/exe`, extracts the `NT_GNU_BUILD_ID` note, normalises it to lower-case hex, and sends it as `process.buildId` in the runtime envelope.
|
||||||
2. Scanner.WebService persists the observation and propagates the most recent hashes into `/policy/runtime` responses (`buildIds` list) and policy caches consumed by the webhook/CLI.
|
2. Scanner.WebService persists the observation and propagates the most recent hashes into `/policy/runtime` responses (`buildIds` list) and policy caches consumed by the webhook/CLI.
|
||||||
3. Release engineering copies the matching `.debug` files into the bundle (`debug/.build-id/<aa>/<rest>.debug`) and publishes `debug/debug-manifest.json` with per-hash digests. Offline Kit packaging reuses those artefacts verbatim (see `ops/offline-kit/mirror_debug_store.py`).
|
3. Release engineering copies the matching `.debug` files into the bundle (`debug/.build-id/<aa>/<rest>.debug`) and publishes `debug/debug-manifest.json` with per-hash digests. Offline Kit packaging reuses those artefacts verbatim (see `ops/offline-kit/mirror_debug_store.py`).
|
||||||
4. Operators resolve symbols by either:
|
4. Operators resolve symbols by either:
|
||||||
* calling `stellaops-cli runtime policy test --image <digest>` to read the current `buildIds` and then fetching the corresponding `.debug` file from the bundle/offline mirror, or
|
* calling `stellaops-cli runtime policy test --image <digest>` to read the current `buildIds` and then fetching the corresponding `.debug` file from the bundle/offline mirror, or
|
||||||
* piping the hash into `debuginfod-find debuginfo <buildId>` when a `debuginfod` service is wired against the mirrored tree.
|
* piping the hash into `debuginfod-find debuginfo <buildId>` when a `debuginfod` service is wired against the mirrored tree.
|
||||||
5. Missing hashes indicate stripped binaries without GNU notes; operators should trigger a rebuild with `-Wl,--build-id` or register a fallback symbol package as described in the runtime operations runbook.
|
5. Missing hashes indicate stripped binaries without GNU notes; operators should trigger a rebuild with `-Wl,--build-id` or register a fallback symbol package as described in the runtime operations runbook.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -221,20 +221,20 @@ sequenceDiagram
|
|||||||
|
|
||||||
`POST /api/v1/scanner/runtime/events` *(OpTok + DPoP/mTLS)*
|
`POST /api/v1/scanner/runtime/events` *(OpTok + DPoP/mTLS)*
|
||||||
|
|
||||||
* Validates event schema; enforces rate caps by tenant/node; persists to **Mongo** (`runtime.events` capped collection or regular with TTL).
|
* Validates event schema; enforces rate caps by tenant/node; persists to **PostgreSQL** (`runtime.events` table with TTL-based retention).
|
||||||
* Performs **correlation**:
|
* Performs **correlation**:
|
||||||
|
|
||||||
* Attach nearest **image SBOM** (inventory/usage) and **BOM‑Index** if known.
|
* Attach nearest **image SBOM** (inventory/usage) and **BOM‑Index** if known.
|
||||||
* If unknown/missing, schedule **delta scan** and return `202 Accepted`.
|
* If unknown/missing, schedule **delta scan** and return `202 Accepted`.
|
||||||
* Emits **derived signals** (usedByEntrypoint per component based on `/proc/<pid>/maps`).
|
* Emits **derived signals** (usedByEntrypoint per component based on `/proc/<pid>/maps`).
|
||||||
|
|
||||||
### 5.2 Policy decision API (for webhook)
|
### 5.2 Policy decision API (for webhook)
|
||||||
|
|
||||||
`POST /api/v1/scanner/policy/runtime`
|
`POST /api/v1/scanner/policy/runtime`
|
||||||
|
|
||||||
The webhook reuses the shared runtime stack (`AddZastavaRuntimeCore` + `IZastavaAuthorityTokenProvider`) so OpTok caching, DPoP enforcement, and telemetry behave identically to the observer plane.
|
The webhook reuses the shared runtime stack (`AddZastavaRuntimeCore` + `IZastavaAuthorityTokenProvider`) so OpTok caching, DPoP enforcement, and telemetry behave identically to the observer plane.
|
||||||
|
|
||||||
Request:
|
Request:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -273,44 +273,44 @@ Response:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
zastava:
|
zastava:
|
||||||
mode:
|
mode:
|
||||||
observer: true
|
observer: true
|
||||||
webhook: true
|
webhook: true
|
||||||
backend:
|
backend:
|
||||||
baseAddress: "https://scanner-web.internal"
|
baseAddress: "https://scanner-web.internal"
|
||||||
policyPath: "/api/v1/scanner/policy/runtime"
|
policyPath: "/api/v1/scanner/policy/runtime"
|
||||||
requestTimeoutSeconds: 5
|
requestTimeoutSeconds: 5
|
||||||
allowInsecureHttp: false
|
allowInsecureHttp: false
|
||||||
runtime:
|
runtime:
|
||||||
authority:
|
authority:
|
||||||
issuer: "https://authority.internal"
|
issuer: "https://authority.internal"
|
||||||
clientId: "zastava-observer"
|
clientId: "zastava-observer"
|
||||||
audience: ["scanner","zastava"]
|
audience: ["scanner","zastava"]
|
||||||
scopes:
|
scopes:
|
||||||
- "api:scanner.runtime.write"
|
- "api:scanner.runtime.write"
|
||||||
refreshSkewSeconds: 120
|
refreshSkewSeconds: 120
|
||||||
requireDpop: true
|
requireDpop: true
|
||||||
requireMutualTls: true
|
requireMutualTls: true
|
||||||
allowStaticTokenFallback: false
|
allowStaticTokenFallback: false
|
||||||
staticTokenPath: null # Optional bootstrap secret
|
staticTokenPath: null # Optional bootstrap secret
|
||||||
tenant: "tenant-01"
|
tenant: "tenant-01"
|
||||||
environment: "prod"
|
environment: "prod"
|
||||||
deployment: "cluster-a"
|
deployment: "cluster-a"
|
||||||
logging:
|
logging:
|
||||||
includeScopes: true
|
includeScopes: true
|
||||||
includeActivityTracking: true
|
includeActivityTracking: true
|
||||||
staticScope:
|
staticScope:
|
||||||
plane: "runtime"
|
plane: "runtime"
|
||||||
metrics:
|
metrics:
|
||||||
meterName: "StellaOps.Zastava"
|
meterName: "StellaOps.Zastava"
|
||||||
meterVersion: "1.0.0"
|
meterVersion: "1.0.0"
|
||||||
commonTags:
|
commonTags:
|
||||||
cluster: "prod-cluster"
|
cluster: "prod-cluster"
|
||||||
engine: "auto" # containerd|cri-o|docker|auto
|
engine: "auto" # containerd|cri-o|docker|auto
|
||||||
procfs: "/host/proc"
|
procfs: "/host/proc"
|
||||||
collect:
|
collect:
|
||||||
entryTrace: true
|
entryTrace: true
|
||||||
loadedLibs: true
|
loadedLibs: true
|
||||||
maxLibs: 256
|
maxLibs: 256
|
||||||
maxHashBytesPerContainer: 64_000_000
|
maxHashBytesPerContainer: 64_000_000
|
||||||
maxDepth: 48
|
maxDepth: 48
|
||||||
@@ -327,49 +327,49 @@ zastava:
|
|||||||
eventsPerSecond: 50
|
eventsPerSecond: 50
|
||||||
burst: 200
|
burst: 200
|
||||||
perNodeQueue: 10_000
|
perNodeQueue: 10_000
|
||||||
security:
|
security:
|
||||||
mounts:
|
mounts:
|
||||||
containerdSock: "/run/containerd/containerd.sock:ro"
|
containerdSock: "/run/containerd/containerd.sock:ro"
|
||||||
proc: "/proc:/host/proc:ro"
|
proc: "/proc:/host/proc:ro"
|
||||||
runtimeState: "/var/lib/containerd:ro"
|
runtimeState: "/var/lib/containerd:ro"
|
||||||
```
|
```
|
||||||
|
|
||||||
> Implementation note: both `zastava-observer` and `zastava-webhook` call `services.AddZastavaRuntimeCore(configuration, "<component>")` during start-up to bind the `zastava:runtime` section, enforce validation, and register canonical log scopes + meters.
|
> Implementation note: both `zastava-observer` and `zastava-webhook` call `services.AddZastavaRuntimeCore(configuration, "<component>")` during start-up to bind the `zastava:runtime` section, enforce validation, and register canonical log scopes + meters.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 7) Security posture
|
## 7) Security posture
|
||||||
|
|
||||||
* **AuthN/Z**: Authority OpToks (DPoP preferred) to backend; webhook does **not** require client auth from API server (K8s handles).
|
* **AuthN/Z**: Authority OpToks (DPoP preferred) to backend; webhook does **not** require client auth from API server (K8s handles).
|
||||||
* **Least privileges**: read‑only host mounts; optional `CAP_SYS_PTRACE`; **no** host networking; **no** write mounts.
|
* **Least privileges**: read‑only host mounts; optional `CAP_SYS_PTRACE`; **no** host networking; **no** write mounts.
|
||||||
* **Isolation**: never exec untrusted code; nsenter only to **read** `/proc/<pid>`.
|
* **Isolation**: never exec untrusted code; nsenter only to **read** `/proc/<pid>`.
|
||||||
* **Data minimization**: do not exfiltrate env vars or command arguments unless policy explicitly enables diagnostic mode.
|
* **Data minimization**: do not exfiltrate env vars or command arguments unless policy explicitly enables diagnostic mode.
|
||||||
* **Rate limiting**: per‑node caps; per‑tenant caps at backend.
|
* **Rate limiting**: per‑node caps; per‑tenant caps at backend.
|
||||||
* **Hard caps**: bytes hashed, files inspected, depth of shell parsing.
|
* **Hard caps**: bytes hashed, files inspected, depth of shell parsing.
|
||||||
* **Authority guardrails**: `AddZastavaRuntimeCore` binds `zastava.runtime.authority` and refuses tokens without `aud:<tenant>` scope; optional knobs (`requireDpop`, `requireMutualTls`, `allowStaticTokenFallback`) emit structured warnings when relaxed.
|
* **Authority guardrails**: `AddZastavaRuntimeCore` binds `zastava.runtime.authority` and refuses tokens without `aud:<tenant>` scope; optional knobs (`requireDpop`, `requireMutualTls`, `allowStaticTokenFallback`) emit structured warnings when relaxed.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 8) Metrics, logs, tracing
|
## 8) Metrics, logs, tracing
|
||||||
|
|
||||||
**Observer**
|
**Observer**
|
||||||
|
|
||||||
* `zastava.runtime.events.total{kind}`
|
* `zastava.runtime.events.total{kind}`
|
||||||
* `zastava.runtime.backend.latency.ms{endpoint="events"}`
|
* `zastava.runtime.backend.latency.ms{endpoint="events"}`
|
||||||
* `zastava.proc_maps.samples.total{result}`
|
* `zastava.proc_maps.samples.total{result}`
|
||||||
* `zastava.entrytrace.depth{p99}`
|
* `zastava.entrytrace.depth{p99}`
|
||||||
* `zastava.hash.bytes.total`
|
* `zastava.hash.bytes.total`
|
||||||
* `zastava.buffer.drops.total`
|
* `zastava.buffer.drops.total`
|
||||||
|
|
||||||
**Webhook**
|
**Webhook**
|
||||||
|
|
||||||
* `zastava.admission.decisions.total{decision}`
|
* `zastava.admission.decisions.total{decision}`
|
||||||
* `zastava.runtime.backend.latency.ms{endpoint="policy"}`
|
* `zastava.runtime.backend.latency.ms{endpoint="policy"}`
|
||||||
* `zastava.admission.cache.hits.total`
|
* `zastava.admission.cache.hits.total`
|
||||||
* `zastava.backend.failures.total`
|
* `zastava.backend.failures.total`
|
||||||
|
|
||||||
**Logs** (structured): node, pod, image digest, decision, reasons.
|
**Logs** (structured): node, pod, image digest, decision, reasons.
|
||||||
**Tracing**: spans for observe→batch→post; webhook request→resolve→respond.
|
**Tracing**: spans for observe→batch→post; webhook request→resolve→respond.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -486,20 +486,20 @@ webhooks:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 15) Roadmap
|
## 15) Roadmap
|
||||||
|
|
||||||
* **eBPF** option for syscall/library load tracing (kernel‑level, opt‑in).
|
* **eBPF** option for syscall/library load tracing (kernel‑level, opt‑in).
|
||||||
* **Windows containers** support (ETW providers, loaded modules).
|
* **Windows containers** support (ETW providers, loaded modules).
|
||||||
* **Network posture** checks: listening ports vs policy.
|
* **Network posture** checks: listening ports vs policy.
|
||||||
* **Live **used‑by‑entrypoint** synthesis**: send compact bitset diff to backend to tighten Usage view.
|
* **Live **used‑by‑entrypoint** synthesis**: send compact bitset diff to backend to tighten Usage view.
|
||||||
* **Admission dry‑run** dashboards (simulate block lists before enforcing).
|
* **Admission dry‑run** dashboards (simulate block lists before enforcing).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 16) Observability (stub)
|
## 16) Observability (stub)
|
||||||
|
|
||||||
- Runbook + dashboard placeholder for offline import: `operations/observability.md`, `operations/dashboards/zastava-observability.json`.
|
- Runbook + dashboard placeholder for offline import: `operations/observability.md`, `operations/dashboards/zastava-observability.json`.
|
||||||
- Metrics to surface: admission latency p95/p99, allow/deny counts, Surface.Env miss rate, Surface.Secrets failures, Surface.FS cache freshness, drift events.
|
- Metrics to surface: admission latency p95/p99, allow/deny counts, Surface.Env miss rate, Surface.Secrets failures, Surface.FS cache freshness, drift events.
|
||||||
- Health endpoints: `/health/liveness`, `/health/readiness`, `/status`, `/surface/fs/cache/status` (see runbook).
|
- Health endpoints: `/health/liveness`, `/health/readiness`, `/status`, `/surface/fs/cache/status` (see runbook).
|
||||||
- Alert hints: deny spikes, latency > 800ms p99, cache freshness lag > 10m, any secrets failure.
|
- Alert hints: deny spikes, latency > 800ms p99, cache freshness lag > 10m, any secrets failure.
|
||||||
|
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user