up

docs/modules/policy/cvss-v4.md

@@ -61,3 +61,70 @@ Source advisory: `docs/product-advisories/25-Nov-2025 - Add CVSS v4.0 Score Re
 - Store conversion metadata for v3.1 sources.
 - Verify evidence CAS/DSSE on ingest; fail closed.
 - Expose metrics/alerts listed above.
+
+## Receipt model (API shape)
+- `receiptId`, `schemaVersion`, `format`, `vulnerabilityId`, `tenantId`, `createdAt/by`, `modifiedAt/by`.
+- Metric inputs: `baseMetrics`, optional `threatMetrics` and `environmentalMetrics`, optional `supplementalMetrics`.
+- Computed outputs: `scores` (base/threat/environmental/full plus `effectiveScore` and `effectiveScoreType`), `vectorString`, `severity`.
+- Policy link: `policyRef { policyId, version, hash, activatedAt }` plus `inputHash` (JCS + SHA-256) and optional `exportHash`.
+- Evidence: `evidence[]` (type, uri, description, source, collectedAt, dsseRef, isAuthoritative, isRedacted, verifiedAt, retentionClass).
+- Attestation + history: `attestationRefs[]` (DSSE envelopes), `history[]` (field, previousValue, newValue, actor, reason, referenceUri, when), `amendsReceiptId`, `supersedesReceiptId`, `isActive`.
+
+## Gateway API (Policy Engine via Gateway)
+- Base path: `/api/cvss` (Policy Gateway). Scopes: `policy.run` for create/amend; `findings.read` for read/history/policies.
+- Endpoints:
+  - `POST /api/cvss/receipts` – Create a receipt and optional DSSE envelope.
+  - `GET /api/cvss/receipts/{id}` – Fetch the latest receipt with scores, evidence, and hashes.
+  - `PUT /api/cvss/receipts/{id}/amend` – Append a history entry (e.g., policy change, evidence fix); re-sign when `signingKey` is provided.
+  - `GET /api/cvss/receipts/{id}/history` – Return ordered history entries for the receipt.
+  - `GET /api/cvss/policies` – List available `CvssPolicy` documents (id/version/hash/effective window).
+
+**Create receipt (minimal example)**
+
+```
+POST /api/cvss/receipts
+Authorization: Bearer <token>
+Content-Type: application/json
+
+{
+  "vulnerabilityId": "CVE-2025-1234",
+  "policy": {
+    "policyId": "default",
+    "version": "1.0.0",
+    "name": "Default CVSS policy",
+    "effectiveFrom": "2025-12-01T00:00:00Z",
+    "hash": "sha256:..."
+  },
+  "baseMetrics": { "av": "Network", "ac": "Low", "at": "None", "pr": "None", "ui": "None", "vc": "High", "vi": "High", "va": "High", "sc": "High", "si": "High", "sa": "High" },
+  "environmentalMetrics": { "cr": "High", "ir": "High", "ar": "Medium" },
+  "signingKey": { "keyId": "cvss-dev", "store": "local" },
+  "createdBy": "cli"
+}
+```
+
+**Response 200 (abridged)**
+
+```json
+{
+  "receiptId": "cvss-20251207-01",
+  "vectorString": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:H/SI:H/SA:H/CR:H/IR:H/AR:M",
+  "scores": { "baseScore": 9.3, "threatScore": 9.3, "environmentalScore": 9.1, "fullScore": 9.1, "effectiveScore": 9.1, "effectiveScoreType": "Environmental" },
+  "severity": "Critical",
+  "policyRef": { "policyId": "default", "version": "1.0.0", "hash": "sha256:..." },
+  "inputHash": "sha256:...",
+  "attestationRefs": ["dsse:stella.ops/cvssReceipt@v1/sha256:..."],
+  "evidence": [],
+  "history": []
+}
+```
+
+## CLI and UI usage
+- CLI (`stella cvss ...` via `src/Cli/StellaOps.Cli`):
+  - `stella cvss score --vuln CVE-2025-1234 --policy-file cvss-policy.json --vector CVSS:4.0/AV:N/... [--json]`
+  - `stella cvss show <receiptId> [--json]`
+  - `stella cvss history <receiptId> [--json]`
+  - `stella cvss export <receiptId> --format json --out cvss-receipt.json`
+  - Uses Policy Gateway `/api/cvss/...` endpoints, enforces tenant scoping via `--tenant`/profile, and reuses `CvssV4Engine` locally for vector parsing.
+- Console (`src/Web/StellaOps.Web`):
+  - Route `/cvss/receipts/:receiptId` renders a receipt viewer with score badge, vector summary, and tabs for Base/Threat/Environmental/Evidence/Policy/History.
+  - Export and "Recalculate with my env" flows reuse the same receipt payload; UI expects deterministic ordering and stable hashes.