docs consolidation and others
This commit is contained in:
36
docs/modules/airgap/schemas/av-report.schema.json
Normal file
36
docs/modules/airgap/schemas/av-report.schema.json
Normal file
@@ -0,0 +1,36 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://stellaops.local/airgap/av-report.schema.json",
|
||||
"title": "Offline AV/YARA Scan Report",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["scanner", "scannerVersion", "startedAt", "completedAt", "status", "artifacts"],
|
||||
"properties": {
|
||||
"scanner": { "type": "string" },
|
||||
"scannerVersion": { "type": "string" },
|
||||
"startedAt": { "type": "string", "format": "date-time" },
|
||||
"completedAt": { "type": "string", "format": "date-time" },
|
||||
"status": { "type": "string", "enum": ["clean", "findings", "error"] },
|
||||
"signature": { "type": "string", "description": "Optional detached signature over this report (base64)" },
|
||||
"artifacts": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["path", "sha256", "result"],
|
||||
"properties": {
|
||||
"path": { "type": "string" },
|
||||
"sha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" },
|
||||
"result": { "type": "string", "enum": ["clean", "suspicious", "malicious", "error"] },
|
||||
"yaraRules": { "type": "array", "items": { "type": "string" }, "uniqueItems": true },
|
||||
"notes": { "type": "string" }
|
||||
}
|
||||
},
|
||||
"uniqueItems": true
|
||||
},
|
||||
"errors": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" }
|
||||
}
|
||||
}
|
||||
}
|
||||
123
docs/modules/airgap/schemas/manifest.schema.json
Normal file
123
docs/modules/airgap/schemas/manifest.schema.json
Normal file
@@ -0,0 +1,123 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://stellaops.local/airgap/manifest.schema.json",
|
||||
"title": "Offline Kit Manifest",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"schemaVersion",
|
||||
"bundleId",
|
||||
"tenant",
|
||||
"environment",
|
||||
"createdAt",
|
||||
"stalenessWindowHours",
|
||||
"replayPolicy",
|
||||
"tools",
|
||||
"feeds",
|
||||
"policies",
|
||||
"chunks",
|
||||
"hashes"
|
||||
],
|
||||
"properties": {
|
||||
"schemaVersion": { "type": "string", "pattern": "^1\\.\\d+\\.\\d+$" },
|
||||
"bundleId": { "type": "string", "pattern": "^offline-kit:[A-Za-z0-9._:-]+$" },
|
||||
"tenant": { "type": "string", "minLength": 1 },
|
||||
"environment": { "type": "string", "enum": ["prod", "stage", "dev", "test"] },
|
||||
"createdAt": { "type": "string", "format": "date-time" },
|
||||
"stalenessWindowHours": { "type": "integer", "minimum": 0 },
|
||||
"replayPolicy": { "type": "string", "enum": ["hash-only", "full-recompute", "policy-freeze"] },
|
||||
"tools": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["name", "version", "sha256"],
|
||||
"properties": {
|
||||
"name": { "type": "string" },
|
||||
"version": { "type": "string" },
|
||||
"sha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" }
|
||||
}
|
||||
},
|
||||
"uniqueItems": true
|
||||
},
|
||||
"feeds": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["name", "snapshot", "sha256"],
|
||||
"properties": {
|
||||
"name": { "type": "string" },
|
||||
"snapshot": { "type": "string" },
|
||||
"sha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" },
|
||||
"stalenessHours": { "type": "integer", "minimum": 0 }
|
||||
}
|
||||
},
|
||||
"uniqueItems": true
|
||||
},
|
||||
"policies": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["name", "version", "sha256"],
|
||||
"properties": {
|
||||
"name": { "type": "string" },
|
||||
"version": { "type": "string" },
|
||||
"sha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" }
|
||||
}
|
||||
},
|
||||
"uniqueItems": true
|
||||
},
|
||||
"chunks": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["path", "sha256", "size"],
|
||||
"properties": {
|
||||
"path": { "type": "string" },
|
||||
"sha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" },
|
||||
"size": { "type": "integer", "minimum": 0 },
|
||||
"kind": { "type": "string", "enum": ["advisory", "sbom", "vex", "policy", "graph", "tooling", "other"] }
|
||||
}
|
||||
},
|
||||
"uniqueItems": true
|
||||
},
|
||||
"avScan": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["status"],
|
||||
"properties": {
|
||||
"status": { "type": "string", "enum": ["not_run", "clean", "findings"] },
|
||||
"scanner": { "type": "string" },
|
||||
"scanAt": { "type": "string", "format": "date-time" },
|
||||
"reportPath": { "type": "string" },
|
||||
"reportSha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" }
|
||||
}
|
||||
},
|
||||
"hashes": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["manifestSha256", "bundleSha256"],
|
||||
"properties": {
|
||||
"manifestSha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" },
|
||||
"bundleSha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" }
|
||||
}
|
||||
},
|
||||
"signatures": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["type", "keyId", "signature"],
|
||||
"properties": {
|
||||
"type": { "type": "string", "enum": ["dsse", "jws-detached"] },
|
||||
"keyId": { "type": "string" },
|
||||
"signature": { "type": "string" },
|
||||
"envelopeDigest": { "type": "string", "pattern": "^sha256:[A-Fa-f0-9]{64}$" }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
55
docs/modules/airgap/schemas/receipt.schema.json
Normal file
55
docs/modules/airgap/schemas/receipt.schema.json
Normal file
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://stellaops.local/airgap/receipt.schema.json",
|
||||
"title": "AirGap Ingress/Egress Receipt",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"schemaVersion",
|
||||
"receiptId",
|
||||
"direction",
|
||||
"bundleId",
|
||||
"tenant",
|
||||
"operator",
|
||||
"occurredAt",
|
||||
"decision",
|
||||
"hashes"
|
||||
],
|
||||
"properties": {
|
||||
"schemaVersion": { "type": "string", "pattern": "^1\\.\\d+\\.\\d+$" },
|
||||
"receiptId": { "type": "string", "pattern": "^receipt:[A-Za-z0-9._:-]+$" },
|
||||
"direction": { "type": "string", "enum": ["ingress", "egress"] },
|
||||
"bundleId": { "type": "string", "pattern": "^offline-kit:[A-Za-z0-9._:-]+$" },
|
||||
"tenant": { "type": "string", "minLength": 1 },
|
||||
"operator": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["id", "role"],
|
||||
"properties": {
|
||||
"id": { "type": "string" },
|
||||
"role": { "type": "string" }
|
||||
}
|
||||
},
|
||||
"occurredAt": { "type": "string", "format": "date-time" },
|
||||
"decision": { "type": "string", "enum": ["allow", "deny", "quarantine"] },
|
||||
"hashes": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["bundleSha256", "manifestSha256"],
|
||||
"properties": {
|
||||
"bundleSha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" },
|
||||
"manifestSha256": { "type": "string", "pattern": "^[A-Fa-f0-9]{64}$" }
|
||||
}
|
||||
},
|
||||
"dsse": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"envelopeDigest": { "type": "string", "pattern": "^sha256:[A-Fa-f0-9]{64}$" },
|
||||
"signer": { "type": "string" },
|
||||
"rekorUuid": { "type": "string" }
|
||||
}
|
||||
},
|
||||
"notes": { "type": "string" }
|
||||
}
|
||||
}
|
||||
43
docs/modules/airgap/schemas/time-anchor-schema.json
Normal file
43
docs/modules/airgap/schemas/time-anchor-schema.json
Normal file
@@ -0,0 +1,43 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"title": "StellaOps Time Anchor",
|
||||
"type": "object",
|
||||
"required": ["anchorTime", "source", "format", "tokenDigest"],
|
||||
"properties": {
|
||||
"anchorTime": {
|
||||
"description": "UTC timestamp asserted by the time token (RFC3339/ISO-8601)",
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"source": {
|
||||
"description": "Logical source of the time token (e.g., roughtime",
|
||||
"type": "string",
|
||||
"enum": ["roughtime", "rfc3161"]
|
||||
},
|
||||
"format": {
|
||||
"description": "Payload format identifier (e.g., draft-roughtime-v1, rfc3161)",
|
||||
"type": "string"
|
||||
},
|
||||
"tokenDigest": {
|
||||
"description": "SHA-256 of the raw time token bytes, hex-encoded",
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-fA-F]{64}$"
|
||||
},
|
||||
"signatureFingerprint": {
|
||||
"description": "Fingerprint of the signer key (hex); optional until trust roots finalized",
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-fA-F]{16,128}$"
|
||||
},
|
||||
"verification": {
|
||||
"description": "Result of local verification (if performed)",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {"type": "string", "enum": ["unknown", "passed", "failed"]},
|
||||
"reason": {"type": "string"}
|
||||
},
|
||||
"required": ["status"],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
}
|
||||
20
docs/modules/airgap/schemas/time-anchor-trust-roots.json
Normal file
20
docs/modules/airgap/schemas/time-anchor-trust-roots.json
Normal file
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"version": 1,
|
||||
"roughtime": [
|
||||
{
|
||||
"name": "stellaops-test-roughtime",
|
||||
"publicKeyBase64": "dGVzdC1yb3VnaHRpbWUtcHViLWtleQ==",
|
||||
"validFrom": "2025-01-01T00:00:00Z",
|
||||
"validTo": "2026-01-01T00:00:00Z"
|
||||
}
|
||||
],
|
||||
"rfc3161": [
|
||||
{
|
||||
"name": "stellaops-test-tsa",
|
||||
"certificatePem": "-----BEGIN CERTIFICATE-----\nMIIBszCCAVmgAwIBAgIUYPXPLACEHOLDERKEYm7ri5bzsYqvSwwDQYJKoZIhvcNAQELBQAwETEPMA0GA1UEAwwGU3RlbGxhMB4XDTI1MDEwMTAwMDAwMFoXDTI2MDEwMTAwMDAwMFowETEPMA0GA1UEAwwGU3RlbGxhMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEPLACEHOLDERuQjVekA7gQtaQ6UiI4bYbw2bG8xwDthQqLehCDXXWix9TAAEbnII1xF4Zk12Y0wUjiJB82H4x6HTDY0Hes74AUFyi0A39p0Y0ffSZlnzCwzmxrSYzYHbpbb8WZKGa+jUzBRMB0GA1UdDgQWBBSPLACEHOLDERRoKdqaLKv8Bf+FfoUzAfBgNVHSMEGDAWgBSPLACEHOLDERRoKdqaLKv8Bf+FfoUzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQCPLACEHOLDER\n-----END CERTIFICATE-----",
|
||||
"validFrom": "2025-01-01T00:00:00Z",
|
||||
"validTo": "2026-01-01T00:00:00Z",
|
||||
"fingerprintSha256": "0000000000000000000000000000000000000000000000000000000000000000"
|
||||
}
|
||||
]
|
||||
}
|
||||
9
docs/modules/airgap/schemas/time-config-sample.json
Normal file
9
docs/modules/airgap/schemas/time-config-sample.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"AirGap": {
|
||||
"TenantId": "tenant-default",
|
||||
"Staleness": {
|
||||
"WarningSeconds": 3600,
|
||||
"BreachSeconds": 7200
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user