frameworks/docs/data/security-map/schema.json at develop · security-alliance/frameworks · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  "schemaVersion": "1.0.0",
  "title": "SEAL Security Map catalogue schema",
  "description": "Authoring contract for docs/data/security-map. The generator validates this shape before writing public/security-map.json.",
  "nodeIdPattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
  "requiredNodeFields": ["id", "type", "title", "summary", "domains", "status", "tags"],
  "optionalNodeFields": [
    "roles",
    "lifecycle",
    "controlClass",
    "severity",
    "severityBasis",
    "href",
    "sources",
    "aliases",
    "framework",
    "assessmentEligible",
    "deprecatedBy",
    "date",
    "datePrecision",
    "dateEnd",
    "loss"
  ],
  "requiredEdgeFields": ["source", "target", "type"],
  "optionalEdgeFields": ["rationale", "status", "sources"],
  "guidanceHref": "Internal documentation route beginning with /. Resolved against docs/pages. Must not be a URL.",
  "incidentSources": {
    "min": 1,
    "itemFields": ["url", "title", "publisher"]
  },
  "assessment": {
    "eligibleTypes": ["control"],
    "defaultEligible": false,
    "storageKey": "seal-security-map-assessment:v1",
    "legacyStorageKey": "attackSurface-posture",
    "states": [
      "not-assessed",
      "not-applicable",
      "missing",
      "planned",
      "partially-implemented",
      "implemented",
      "verified"
    ]
  },
  "generatedOutputs": [
    "public/security-map.json",
    "components/security-map/securityMap.generated.ts"
  ]
}