@mitre/hdf-schema 3.6.0 → 3.7.0-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -2
- package/dist/go/hdf.go +20 -12
- package/dist/index.js +28 -28
- package/dist/schemas/hdf-amendments.schema.json +95 -48
- package/dist/schemas/hdf-baseline.schema.json +100 -53
- package/dist/schemas/hdf-comparison.schema.json +177 -130
- package/dist/schemas/hdf-evidence-package.schema.json +96 -49
- package/dist/schemas/hdf-plan.schema.json +101 -54
- package/dist/schemas/hdf-requirement-change-event.schema.json +167 -120
- package/dist/schemas/hdf-results.schema.json +153 -106
- package/dist/schemas/hdf-system.schema.json +116 -69
- package/dist/ts/hdf.d.ts +12 -2
- package/dist/ts/hdf.ts +12 -2
- package/package.json +2 -2
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-system/v3.
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-system/v3.7.0",
|
|
4
4
|
"title": "HDF System",
|
|
5
5
|
"description": "Describes a system's authorization boundary, components, and interconnections. Maps to OSCAL SSP system-characteristics and FedRAMP system inventory.",
|
|
6
6
|
"type": "object",
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"externalReferences": {
|
|
14
14
|
"type": "array",
|
|
15
15
|
"items": {
|
|
16
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
16
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/External_Reference"
|
|
17
17
|
},
|
|
18
18
|
"description": "Optional references to external artifacts describing this system's threat environment or context (CTI/STIX, BOMs, advisories, or any URI-addressable artifact). Inert context; see External_Reference."
|
|
19
19
|
},
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"description": "Stable UUID (RFC 4122) for this system. Enables cross-document correlation independent of file location. Optional in casual use, expected in production documents."
|
|
24
24
|
},
|
|
25
25
|
"owner": {
|
|
26
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
26
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Identity",
|
|
27
27
|
"description": "Team or individual responsible for this system's authorization and compliance. Maps to OSCAL responsible-party with role 'system-owner'."
|
|
28
28
|
},
|
|
29
29
|
"name": {
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
"description": "Description of the system's purpose and mission."
|
|
45
45
|
},
|
|
46
46
|
"authorizationStatus": {
|
|
47
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.
|
|
47
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.7.0#/$defs/Authorization_Status",
|
|
48
48
|
"description": "Current Authorization to Operate (ATO) status."
|
|
49
49
|
},
|
|
50
50
|
"authorizationDate": {
|
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
"description": "Date the current authorization status was granted. ISO 8601 format."
|
|
54
54
|
},
|
|
55
55
|
"categorizationLevel": {
|
|
56
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.
|
|
56
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.7.0#/$defs/Categorization_Level",
|
|
57
57
|
"description": "FIPS 199 security categorization (impact level)."
|
|
58
58
|
},
|
|
59
59
|
"boundaryDescription": {
|
|
@@ -64,28 +64,28 @@
|
|
|
64
64
|
"type": "array",
|
|
65
65
|
"minItems": 1,
|
|
66
66
|
"items": {
|
|
67
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.
|
|
67
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.7.0#/$defs/Component"
|
|
68
68
|
},
|
|
69
69
|
"description": "System components within the authorization boundary. Uses the full polymorphic Component type with stable identity (componentId), external references, and generalized BOM attachment (boms[])."
|
|
70
70
|
},
|
|
71
71
|
"controlDesignations": {
|
|
72
72
|
"type": "array",
|
|
73
73
|
"items": {
|
|
74
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.
|
|
74
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.7.0#/$defs/Control_Designation"
|
|
75
75
|
},
|
|
76
76
|
"description": "Declares which controls are common, hybrid, or system-specific, and which component provides them. Maps to NIST SP 800-53 control designations and OSCAL leveraged-authorizations."
|
|
77
77
|
},
|
|
78
78
|
"dataFlows": {
|
|
79
79
|
"type": "array",
|
|
80
80
|
"items": {
|
|
81
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.
|
|
81
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.7.0#/$defs/Data_Flow"
|
|
82
82
|
},
|
|
83
83
|
"description": "Inter-component data flows describing how components communicate. Supports local, cross-system, and external flows. Replaces the interconnections[] field."
|
|
84
84
|
},
|
|
85
85
|
"boms": {
|
|
86
86
|
"type": "array",
|
|
87
87
|
"items": {
|
|
88
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/bom/v3.
|
|
88
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/bom/v3.7.0#/$defs/Bom"
|
|
89
89
|
},
|
|
90
90
|
"description": "System-scoped Bills of Materials whose subject is the authorization boundary rather than a single component (e.g. a SaaSBOM of services, a KBOM of cluster inventory, an OBOM). Component-scoped BOMs (SBOM, ai-model) attach on the component instead. See primitives/bom.schema.json."
|
|
91
91
|
},
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
"description": "Optional key-value labels for grouping and querying systems."
|
|
98
98
|
},
|
|
99
99
|
"integrity": {
|
|
100
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
100
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.7.0#/$defs/Integrity",
|
|
101
101
|
"description": "Cryptographic integrity information for verifying this system document has not been tampered with."
|
|
102
102
|
},
|
|
103
103
|
"version": {
|
|
@@ -105,7 +105,7 @@
|
|
|
105
105
|
"description": "Version of this system document."
|
|
106
106
|
},
|
|
107
107
|
"generator": {
|
|
108
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
108
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.7.0#/$defs/Generator",
|
|
109
109
|
"description": "Information about the tool that generated this system document."
|
|
110
110
|
}
|
|
111
111
|
},
|
|
@@ -158,9 +158,9 @@
|
|
|
158
158
|
}
|
|
159
159
|
],
|
|
160
160
|
"$defs": {
|
|
161
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
161
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0": {
|
|
162
162
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
163
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
163
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0",
|
|
164
164
|
"title": "HDF Common Primitives",
|
|
165
165
|
"description": "Shared building blocks used by hdf-results and hdf-baseline schemas.",
|
|
166
166
|
"$defs": {
|
|
@@ -600,6 +600,24 @@
|
|
|
600
600
|
"type",
|
|
601
601
|
"data"
|
|
602
602
|
],
|
|
603
|
+
"if": {
|
|
604
|
+
"properties": {
|
|
605
|
+
"encoding": {
|
|
606
|
+
"const": "base64"
|
|
607
|
+
}
|
|
608
|
+
},
|
|
609
|
+
"required": [
|
|
610
|
+
"encoding"
|
|
611
|
+
]
|
|
612
|
+
},
|
|
613
|
+
"then": {
|
|
614
|
+
"properties": {
|
|
615
|
+
"data": {
|
|
616
|
+
"pattern": "^[0-9A-Za-z+/]+={0,2}$",
|
|
617
|
+
"contentEncoding": "base64"
|
|
618
|
+
}
|
|
619
|
+
}
|
|
620
|
+
},
|
|
603
621
|
"properties": {
|
|
604
622
|
"type": {
|
|
605
623
|
"type": "string",
|
|
@@ -616,7 +634,8 @@
|
|
|
616
634
|
},
|
|
617
635
|
"data": {
|
|
618
636
|
"type": "string",
|
|
619
|
-
"
|
|
637
|
+
"minLength": 1,
|
|
638
|
+
"description": "The evidence content. For screenshots/files: base64-encoded data or URL. For code/logs: the raw text. For URLs: the URL string. Must not be empty. When encoding is 'base64', data must be bare base64 matching ^[0-9A-Za-z+/]+={0,2}$ (OSCAL's Base64Datatype): no data: URI prefix, URL, or line breaks."
|
|
620
639
|
},
|
|
621
640
|
"description": {
|
|
622
641
|
"type": "string",
|
|
@@ -628,7 +647,7 @@
|
|
|
628
647
|
},
|
|
629
648
|
"encoding": {
|
|
630
649
|
"type": "string",
|
|
631
|
-
"description": "Encoding used for the data. Example: 'base64', 'utf-8'."
|
|
650
|
+
"description": "Encoding used for the data. Example: 'base64', 'utf-8'. The value 'base64' (exactly, lowercase) requires data to be bare base64."
|
|
632
651
|
},
|
|
633
652
|
"size": {
|
|
634
653
|
"type": "number",
|
|
@@ -692,6 +711,7 @@
|
|
|
692
711
|
}
|
|
693
712
|
}
|
|
694
713
|
],
|
|
714
|
+
"$comment": "Examples, in order: 1) base64-encoded PNG screenshot with full capture provenance; 2) raw configuration text; 3) log excerpt; 4) URL to an external ticket; 5) base64-encoded file captured by an automated system.",
|
|
695
715
|
"description": "Supporting evidence for a finding or override, such as screenshots, code samples, log excerpts, or URLs.",
|
|
696
716
|
"title": "Evidence"
|
|
697
717
|
},
|
|
@@ -769,6 +789,13 @@
|
|
|
769
789
|
"status"
|
|
770
790
|
],
|
|
771
791
|
"properties": {
|
|
792
|
+
"title": {
|
|
793
|
+
"type": "string",
|
|
794
|
+
"minLength": 1,
|
|
795
|
+
"pattern": "^[^ \\t\\n\\r]([^\\n\\r]*[^ \\t\\n\\r])?$",
|
|
796
|
+
"$comment": "The pattern is OSCAL's StringDatatype (\\S(.*\\S)?) as its XSD defines \\S and '.', spelled with explicit classes so ECMA-262 and Go regexp engines agree: \\S and '.' differ between them on CR and non-ASCII whitespace.",
|
|
797
|
+
"description": "Short single-line label for this milestone, suitable where a consumer needs a title (for example an OSCAL POA&M remediation or task). No line breaks, and no leading or trailing whitespace. The description remains the full text of the milestone; the title does not replace it."
|
|
798
|
+
},
|
|
772
799
|
"description": {
|
|
773
800
|
"type": "string",
|
|
774
801
|
"description": "Description of this milestone or task."
|
|
@@ -798,6 +825,25 @@
|
|
|
798
825
|
"description": "Identity of who completed this milestone."
|
|
799
826
|
}
|
|
800
827
|
},
|
|
828
|
+
"examples": [
|
|
829
|
+
{
|
|
830
|
+
"title": "Deploy OpenSSH 9.8p1",
|
|
831
|
+
"description": "Upgrade OpenSSH to 9.8p1 on every RHEL 9 host in the web tier to remediate CVE-2024-6387, then restart sshd during the Saturday maintenance window.",
|
|
832
|
+
"estimatedCompletion": "2026-10-31T00:00:00Z",
|
|
833
|
+
"status": "inProgress"
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
"description": "Isolate the affected host on a restricted VLAN until the vendor patch is available.",
|
|
837
|
+
"estimatedCompletion": "2026-09-05T00:00:00Z",
|
|
838
|
+
"status": "completed",
|
|
839
|
+
"completedAt": "2026-09-04T14:30:00Z",
|
|
840
|
+
"completedBy": {
|
|
841
|
+
"identifier": "network-admin@example.com",
|
|
842
|
+
"type": "email"
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
],
|
|
846
|
+
"$comment": "Examples, in order: 1) titled milestone in progress — the title is the short label, the description the full remediation text; 2) untitled completed milestone with completion provenance — title is optional, and a consumer needing one derives it.",
|
|
801
847
|
"description": "A milestone or task within a POA&M remediation plan.",
|
|
802
848
|
"title": "Milestone"
|
|
803
849
|
},
|
|
@@ -1087,7 +1133,7 @@
|
|
|
1087
1133
|
"description": "Whether the requirement is mandatory within its baseline.\n\nDistinct from severity (risk weight) and status (lifecycle state).\n\nMaps cleanly onto: FedRAMP rev5 OSCAL 'CORE' prop, FedRAMP 20x inline 'Optional:' markers, CMMC sublevel rows, and CIS Implementation Group memberships (IG1/IG2/IG3 may carry richer semantics; layer those onto props[]/tags{}).\n\nOptional: when omitted, consumers should treat the requirement as 'required' by convention."
|
|
1088
1134
|
}
|
|
1089
1135
|
},
|
|
1090
|
-
"$comment": "Examples, in order: 1) v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape
|
|
1136
|
+
"$comment": "Examples, in order: 1) v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape for backward compatibility; 2) v3.2 example populating all three classification fields. controlType=technical because AC-3 is enforced via configuration, not policy text. verificationMethod=automated because a check exists. applicability=required because this is a CORE control in the source baseline; 3) v3.2 example for a manual-by-design requirement. FedRAMP 20x KSIs are statement-form: code is omitted (not null) and verificationMethod=manual-by-design distinguishes this from 'automation could exist but doesn't yet'. controlType=policy because this is an authored governance statement; 4) v3.2 example for a STIG rule lacking a <fix>. Differs from manual-by-design: automation should exist, just not yet. applicability=advisory used here because the source format flagged it as recommended-but-not-mandatory; CIS-style IG memberships and FedRAMP 'Optional:' markers map onto applicability=optional or advisory similarly.",
|
|
1091
1137
|
"examples": [
|
|
1092
1138
|
{
|
|
1093
1139
|
"id": "SV-238196",
|
|
@@ -1223,9 +1269,9 @@
|
|
|
1223
1269
|
}
|
|
1224
1270
|
}
|
|
1225
1271
|
},
|
|
1226
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.
|
|
1272
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.7.0": {
|
|
1227
1273
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1228
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.
|
|
1274
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.7.0",
|
|
1229
1275
|
"title": "HDF System Primitives",
|
|
1230
1276
|
"description": "Types for describing system architecture, authorization boundaries, and components.",
|
|
1231
1277
|
"$defs": {
|
|
@@ -1276,7 +1322,7 @@
|
|
|
1276
1322
|
"description": "Rationale for why this override is needed."
|
|
1277
1323
|
},
|
|
1278
1324
|
"approvedBy": {
|
|
1279
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1325
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Identity",
|
|
1280
1326
|
"description": "Identity of the person or system that approved this override."
|
|
1281
1327
|
}
|
|
1282
1328
|
},
|
|
@@ -1358,9 +1404,9 @@
|
|
|
1358
1404
|
}
|
|
1359
1405
|
}
|
|
1360
1406
|
},
|
|
1361
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.
|
|
1407
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.7.0": {
|
|
1362
1408
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1363
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.
|
|
1409
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.7.0",
|
|
1364
1410
|
"title": "HDF Component Primitives",
|
|
1365
1411
|
"description": "First-class system component with identity, polymorphic type, generalized BOM attachment (boms[]), and system-binding properties. Components are the successor to Targets, adding stable identity (componentId), external system cross-references, and manifest inventory (SBOM, AI model/dataset, and reserved future BOM kinds).",
|
|
1366
1412
|
"$defs": {
|
|
@@ -1406,7 +1452,7 @@
|
|
|
1406
1452
|
"description": "Description of this component's role or purpose."
|
|
1407
1453
|
},
|
|
1408
1454
|
"owner": {
|
|
1409
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1455
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Identity",
|
|
1410
1456
|
"description": "Team or individual responsible for this component. Enables per-component ownership when different teams manage different parts of a system."
|
|
1411
1457
|
},
|
|
1412
1458
|
"externalIds": {
|
|
@@ -1426,14 +1472,14 @@
|
|
|
1426
1472
|
"boms": {
|
|
1427
1473
|
"type": "array",
|
|
1428
1474
|
"items": {
|
|
1429
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/bom/v3.
|
|
1475
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/bom/v3.7.0#/$defs/Bom"
|
|
1430
1476
|
},
|
|
1431
1477
|
"description": "Component-scoped Bills of Materials (SBOM, ai-model, dataset, or any reserved bomType), each carried by passthrough (ref/document) or normalized. Replaces the former sbom/sbomRef/sbomFormat trio; a component may carry several BOMs (e.g. an SBOM plus an ai-model BOM). See primitives/bom.schema.json."
|
|
1432
1478
|
},
|
|
1433
1479
|
"integrity": {
|
|
1434
1480
|
"type": "array",
|
|
1435
1481
|
"items": {
|
|
1436
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1482
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Checksum"
|
|
1437
1483
|
},
|
|
1438
1484
|
"description": "Cryptographic integrity of this component's underlying artifact — model weights or shards, dataset archive, container image, or package bytes.\n\nAn array supports multi-file/sharded artifacts.\n\nThis is the single, generic home for artifact/subject integrity across all component types (it replaced the former per-type Container_Image digest and Artifact checksum fields).\n\nDistinct from BOM-document integrity (Bom.hashes[]) and from the document tamper-evidence Integrity type."
|
|
1439
1485
|
},
|
|
@@ -1447,12 +1493,12 @@
|
|
|
1447
1493
|
"inputOverrides": {
|
|
1448
1494
|
"type": "array",
|
|
1449
1495
|
"items": {
|
|
1450
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.
|
|
1496
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.7.0#/$defs/Input_Override"
|
|
1451
1497
|
},
|
|
1452
1498
|
"description": "System-specific overrides for baseline input values."
|
|
1453
1499
|
},
|
|
1454
1500
|
"targetSelector": {
|
|
1455
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.
|
|
1501
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.7.0#/$defs/Target_Selector",
|
|
1456
1502
|
"description": "Label selector to match targets belonging to this component during migration. Targets with matching labels are automatically included."
|
|
1457
1503
|
}
|
|
1458
1504
|
},
|
|
@@ -1735,7 +1781,7 @@
|
|
|
1735
1781
|
"const": "cloudAccount"
|
|
1736
1782
|
},
|
|
1737
1783
|
"provider": {
|
|
1738
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1784
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Cloud_Provider",
|
|
1739
1785
|
"description": "Cloud provider."
|
|
1740
1786
|
},
|
|
1741
1787
|
"accountId": {
|
|
@@ -1774,7 +1820,7 @@
|
|
|
1774
1820
|
"const": "cloudResource"
|
|
1775
1821
|
},
|
|
1776
1822
|
"provider": {
|
|
1777
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1823
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Cloud_Provider",
|
|
1778
1824
|
"description": "Cloud provider."
|
|
1779
1825
|
},
|
|
1780
1826
|
"resourceType": {
|
|
@@ -2073,9 +2119,9 @@
|
|
|
2073
2119
|
}
|
|
2074
2120
|
}
|
|
2075
2121
|
},
|
|
2076
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/bom/v3.
|
|
2122
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/bom/v3.7.0": {
|
|
2077
2123
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2078
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/bom/v3.
|
|
2124
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/bom/v3.7.0",
|
|
2079
2125
|
"title": "HDF BOM Primitives",
|
|
2080
2126
|
"description": "Generalized Bill-of-Materials / manifest representation.\n\nOne extensible Bom shape, discriminated by bomType, carries any manifest kind (SBOM, AI model/dataset, and reserved future kinds) either by passthrough (opaque ref/embed of the native document) or normalized (converted into HDF's queryable shape).\n\nSubject identity (name, version, componentId) is inherited from the host component or system — the BOM never re-owns it.\n\nSee ADR-0001.",
|
|
2081
2127
|
"$defs": {
|
|
@@ -2131,7 +2177,7 @@
|
|
|
2131
2177
|
"hashes": {
|
|
2132
2178
|
"type": "array",
|
|
2133
2179
|
"items": {
|
|
2134
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2180
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Checksum"
|
|
2135
2181
|
},
|
|
2136
2182
|
"description": "Integrity of the carried BOM *document* itself (the referenced/embedded manifest file), NOT the integrity of the BOM's subject artifact. Subject/artifact integrity (model weights, dataset archive) is a component-level concern, not carried here. Subject identity is inherited from the host component/system; per-node identity lives in the type-extension."
|
|
2137
2183
|
},
|
|
@@ -2543,9 +2589,9 @@
|
|
|
2543
2589
|
}
|
|
2544
2590
|
}
|
|
2545
2591
|
},
|
|
2546
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.
|
|
2592
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.7.0": {
|
|
2547
2593
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2548
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.
|
|
2594
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.7.0",
|
|
2549
2595
|
"title": "HDF Data Flow Primitives",
|
|
2550
2596
|
"description": "Types for describing data flows between components within a system and across system boundaries. Data flows model network connections, API calls, database queries, and other inter-component communication.",
|
|
2551
2597
|
"$defs": {
|
|
@@ -2702,9 +2748,9 @@
|
|
|
2702
2748
|
}
|
|
2703
2749
|
}
|
|
2704
2750
|
},
|
|
2705
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
2751
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.7.0": {
|
|
2706
2752
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2707
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
2753
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.7.0",
|
|
2708
2754
|
"title": "HDF Extension Primitives",
|
|
2709
2755
|
"description": "Extension types for waivers, attestations, generators, and integrity.",
|
|
2710
2756
|
"$defs": {
|
|
@@ -2734,20 +2780,20 @@
|
|
|
2734
2780
|
"externalReferences": {
|
|
2735
2781
|
"type": "array",
|
|
2736
2782
|
"items": {
|
|
2737
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2783
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/External_Reference"
|
|
2738
2784
|
},
|
|
2739
2785
|
"description": "Optional references to the external artifacts behind this override (e.g. the STIX bundle/object or CTI feed motivating an E:A riskAdjustment). Inert context distinct from `evidence`; see External_Reference. Symmetric with Standalone_Override.externalReferences for the inline (results-embedded) override carrier."
|
|
2740
2786
|
},
|
|
2741
2787
|
"type": {
|
|
2742
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
2788
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.7.0#/$defs/Override_Type",
|
|
2743
2789
|
"description": "The type of override applied to this requirement."
|
|
2744
2790
|
},
|
|
2745
2791
|
"status": {
|
|
2746
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
2792
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.7.0#/$defs/Result_Status",
|
|
2747
2793
|
"description": "The new status this override sets for the requirement. Optional when only impact is being overridden."
|
|
2748
2794
|
},
|
|
2749
2795
|
"impact": {
|
|
2750
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
2796
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.7.0#/$defs/Impact_Override",
|
|
2751
2797
|
"description": "Override to the requirement's impact score. At least one of status or impact must be set."
|
|
2752
2798
|
},
|
|
2753
2799
|
"reason": {
|
|
@@ -2755,7 +2801,7 @@
|
|
|
2755
2801
|
"description": "Explanation for why this override was applied."
|
|
2756
2802
|
},
|
|
2757
2803
|
"appliedBy": {
|
|
2758
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2804
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Identity",
|
|
2759
2805
|
"description": "Identity of who applied this override. For simple cases, use type 'simple' with just an identifier."
|
|
2760
2806
|
},
|
|
2761
2807
|
"appliedAt": {
|
|
@@ -2769,27 +2815,27 @@
|
|
|
2769
2815
|
"description": "Timestamp when this override expires and must be reviewed/renewed. REQUIRED - no permanent overrides allowed. ISO 8601 format."
|
|
2770
2816
|
},
|
|
2771
2817
|
"signature": {
|
|
2772
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2818
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Signature",
|
|
2773
2819
|
"description": "Optional digital signature for enhanced trust and non-repudiation. Supports hardware security tokens (PKCS#11/PKCS#12), Yubikeys, GPG keys, passkeys, and other signing methods."
|
|
2774
2820
|
},
|
|
2775
2821
|
"evidence": {
|
|
2776
2822
|
"type": "array",
|
|
2777
2823
|
"items": {
|
|
2778
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2824
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Evidence"
|
|
2779
2825
|
},
|
|
2780
2826
|
"description": "Supporting evidence for this override, such as screenshots demonstrating manual verification for attestations."
|
|
2781
2827
|
},
|
|
2782
2828
|
"previousChecksum": {
|
|
2783
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2829
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Checksum",
|
|
2784
2830
|
"description": "SHA-256 checksum of the previous amendment in chronological order. Each amendment's checksum is recorded by the NEXT one, so editing an amendment in place is detectable — provided a later amendment is chained to it. It is NOT tamper-proof: the final amendment, the document envelope, deleted trailing amendments, and a chain that has been stripped or recomputed wholesale are all outside what it can detect. Use signature for non-repudiation. Omitted on the first amendment on a requirement."
|
|
2785
2831
|
},
|
|
2786
2832
|
"cvss": {
|
|
2787
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.
|
|
2833
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.7.0#/$defs/Cvss",
|
|
2788
2834
|
"$comment": "When present alongside impact.value on a riskAdjustment override, impact.value should be approximately cvss.computedScore / 10.0. Soft consistency rule — validators may warn but should not error. The cvss block makes Environmental/Threat enrichment auditable.",
|
|
2789
2835
|
"description": "Structured CVSS scoring data backing this override. Captures the rubric (which Environmental/Threat metrics the consumer modified, the recomputed score) used to justify a riskAdjustment. For other override types this is optional context."
|
|
2790
2836
|
},
|
|
2791
2837
|
"justification": {
|
|
2792
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
2838
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.7.0#/$defs/Justification",
|
|
2793
2839
|
"description": "Structured controlled-vocabulary classification for why this override applies. Complements (does not replace) the free-text 'reason' field. Most useful on falsePositive and attestation overrides where the structured category enables filtering and lossless round-trip with VEX / OSCAL / FedRAMP DR. See the Justification primitive for the precedent vocabulary and rationale."
|
|
2794
2840
|
}
|
|
2795
2841
|
},
|
|
@@ -2882,7 +2928,7 @@
|
|
|
2882
2928
|
"evidence": [
|
|
2883
2929
|
{
|
|
2884
2930
|
"type": "screenshot",
|
|
2885
|
-
"data": "
|
|
2931
|
+
"data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
|
|
2886
2932
|
"description": "Screenshot showing firewall configuration",
|
|
2887
2933
|
"mimeType": "image/png",
|
|
2888
2934
|
"encoding": "base64",
|
|
@@ -2925,7 +2971,7 @@
|
|
|
2925
2971
|
"description": "Detailed explanation of the plan, including what actions will be taken."
|
|
2926
2972
|
},
|
|
2927
2973
|
"appliedBy": {
|
|
2928
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2974
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Identity",
|
|
2929
2975
|
"description": "Identity of who created this POA&M. For simple cases, use type 'simple' with just an identifier."
|
|
2930
2976
|
},
|
|
2931
2977
|
"appliedAt": {
|
|
@@ -2941,23 +2987,23 @@
|
|
|
2941
2987
|
"milestones": {
|
|
2942
2988
|
"type": "array",
|
|
2943
2989
|
"items": {
|
|
2944
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2990
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Milestone"
|
|
2945
2991
|
},
|
|
2946
2992
|
"description": "Optional array of milestones tracking progress toward completion."
|
|
2947
2993
|
},
|
|
2948
2994
|
"signature": {
|
|
2949
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2995
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Signature",
|
|
2950
2996
|
"description": "Optional digital signature for enhanced trust and non-repudiation."
|
|
2951
2997
|
},
|
|
2952
2998
|
"evidence": {
|
|
2953
2999
|
"type": "array",
|
|
2954
3000
|
"items": {
|
|
2955
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
3001
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Evidence"
|
|
2956
3002
|
},
|
|
2957
3003
|
"description": "Supporting evidence for this POA&M, such as documentation of compensating controls or mitigation implementation."
|
|
2958
3004
|
},
|
|
2959
3005
|
"previousChecksum": {
|
|
2960
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
3006
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Checksum",
|
|
2961
3007
|
"description": "SHA-256 checksum of the previous amendment in chronological order. Each amendment's checksum is recorded by the NEXT one, so editing an amendment in place is detectable — provided a later amendment is chained to it. It is NOT tamper-proof: the final amendment, the document envelope, deleted trailing amendments, and a chain that has been stripped or recomputed wholesale are all outside what it can detect. Use signature for non-repudiation. Omitted on the first amendment on a requirement."
|
|
2962
3008
|
}
|
|
2963
3009
|
},
|
|
@@ -3110,7 +3156,7 @@
|
|
|
3110
3156
|
},
|
|
3111
3157
|
"properties": {
|
|
3112
3158
|
"algorithm": {
|
|
3113
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
3159
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Hash_Algorithm",
|
|
3114
3160
|
"description": "The hash algorithm used for the checksum."
|
|
3115
3161
|
},
|
|
3116
3162
|
"checksum": {
|
|
@@ -3143,9 +3189,9 @@
|
|
|
3143
3189
|
}
|
|
3144
3190
|
}
|
|
3145
3191
|
},
|
|
3146
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
3192
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.7.0": {
|
|
3147
3193
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3148
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
3194
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.7.0",
|
|
3149
3195
|
"title": "HDF Amendment Primitives",
|
|
3150
3196
|
"description": "Types for waivers, attestations, and POA&Ms that modify requirement compliance status.",
|
|
3151
3197
|
"$defs": {
|
|
@@ -3256,7 +3302,7 @@
|
|
|
3256
3302
|
"externalReferences": {
|
|
3257
3303
|
"type": "array",
|
|
3258
3304
|
"items": {
|
|
3259
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
3305
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/External_Reference"
|
|
3260
3306
|
},
|
|
3261
3307
|
"description": "Optional references to the external artifacts behind this override (e.g. the STIX bundle/object, advisory, or CTI feed that motivated it). Inert context distinct from `evidence`; see External_Reference."
|
|
3262
3308
|
},
|
|
@@ -3266,6 +3312,7 @@
|
|
|
3266
3312
|
},
|
|
3267
3313
|
"requirementId": {
|
|
3268
3314
|
"type": "string",
|
|
3315
|
+
"minLength": 1,
|
|
3269
3316
|
"description": "The ID of the requirement being amended. Must match a requirement ID in the referenced baseline."
|
|
3270
3317
|
},
|
|
3271
3318
|
"baselineRef": {
|
|
@@ -3273,7 +3320,7 @@
|
|
|
3273
3320
|
"description": "Name of the baseline containing the requirement. Required when the system has multiple baselines with potentially overlapping requirement IDs."
|
|
3274
3321
|
},
|
|
3275
3322
|
"status": {
|
|
3276
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
3323
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.7.0#/$defs/Result_Status",
|
|
3277
3324
|
"description": "The new status this amendment sets. Optional when only impact is being overridden."
|
|
3278
3325
|
},
|
|
3279
3326
|
"impact": {
|
|
@@ -3285,7 +3332,7 @@
|
|
|
3285
3332
|
"description": "Justification for this amendment."
|
|
3286
3333
|
},
|
|
3287
3334
|
"appliedBy": {
|
|
3288
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
3335
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Identity",
|
|
3289
3336
|
"description": "Identity of who applied this amendment."
|
|
3290
3337
|
},
|
|
3291
3338
|
"appliedAt": {
|
|
@@ -3301,20 +3348,20 @@
|
|
|
3301
3348
|
"evidence": {
|
|
3302
3349
|
"type": "array",
|
|
3303
3350
|
"items": {
|
|
3304
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
3351
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Evidence"
|
|
3305
3352
|
},
|
|
3306
3353
|
"description": "Supporting evidence (screenshots, logs, URLs, documents)."
|
|
3307
3354
|
},
|
|
3308
3355
|
"signature": {
|
|
3309
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
3356
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Signature",
|
|
3310
3357
|
"description": "Digital signature for non-repudiation."
|
|
3311
3358
|
},
|
|
3312
3359
|
"previousChecksum": {
|
|
3313
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
3360
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Checksum",
|
|
3314
3361
|
"description": "SHA-256 checksum of the prior amendment in chronological order. Each amendment's checksum is recorded by the NEXT one, so editing an amendment in place is detectable — provided a later amendment is chained to it. It is NOT tamper-proof: the final amendment, the document envelope, deleted trailing amendments, and a chain that has been stripped or recomputed wholesale are all outside what it can detect. Use signature for non-repudiation. Omitted on the first amendment."
|
|
3315
3362
|
},
|
|
3316
3363
|
"cvss": {
|
|
3317
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.
|
|
3364
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.7.0#/$defs/Cvss",
|
|
3318
3365
|
"$comment": "When present alongside impact.value on a riskAdjustment override, impact.value should be approximately cvss.computedScore / 10.0. Soft consistency rule — validators may warn but should not error. The cvss block makes Environmental/Threat enrichment auditable.",
|
|
3319
3366
|
"description": "Structured CVSS scoring data backing this override. Captures the rubric (which Environmental/Threat metrics the consumer modified, the recomputed score) used to justify a riskAdjustment. For other override types this is optional context."
|
|
3320
3367
|
},
|
|
@@ -3325,7 +3372,7 @@
|
|
|
3325
3372
|
"milestones": {
|
|
3326
3373
|
"type": "array",
|
|
3327
3374
|
"items": {
|
|
3328
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
3375
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.7.0#/$defs/Milestone"
|
|
3329
3376
|
},
|
|
3330
3377
|
"description": "Remediation milestones (primarily for POA&M type amendments)."
|
|
3331
3378
|
},
|
|
@@ -3342,7 +3389,7 @@
|
|
|
3342
3389
|
"affectedPackages": {
|
|
3343
3390
|
"type": "array",
|
|
3344
3391
|
"items": {
|
|
3345
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.
|
|
3392
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.7.0#/$defs/Affected_Package"
|
|
3346
3393
|
},
|
|
3347
3394
|
"description": "Software packages this amendment is scoped to, distinct from componentRef (which scopes to an HDF-internal Component by UUID).\n\nUse when the source amendment format references packages by purl/cpe/name+version — e.g., VEX `affects[]` / `products[]`, OSCAL POA&M `subjects[]`, FedRAMP component-aware amendments.\n\nSymmetric with Evaluated_Requirement.affectedPackages, which scopes findings to the same package vocabulary.\n\nWhen omitted, the amendment applies system-wide (or only to componentRef when that is set)."
|
|
3348
3395
|
}
|
|
@@ -3475,9 +3522,9 @@
|
|
|
3475
3522
|
}
|
|
3476
3523
|
}
|
|
3477
3524
|
},
|
|
3478
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
3525
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.7.0": {
|
|
3479
3526
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3480
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
3527
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.7.0",
|
|
3481
3528
|
"title": "HDF Result Primitives",
|
|
3482
3529
|
"description": "Types for representing assessment results and statuses.",
|
|
3483
3530
|
"$defs": {
|
|
@@ -3608,9 +3655,9 @@
|
|
|
3608
3655
|
}
|
|
3609
3656
|
}
|
|
3610
3657
|
},
|
|
3611
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.
|
|
3658
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.7.0": {
|
|
3612
3659
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3613
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.
|
|
3660
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.7.0",
|
|
3614
3661
|
"title": "HDF CVSS Primitives",
|
|
3615
3662
|
"description": "Types for representing CVSS (Common Vulnerability Scoring System) data attached to assessment findings. Supports CVSS v2.0, v3.0, v3.1, and v4.0 metric groups (Base, Threat, Environmental, Supplemental).",
|
|
3616
3663
|
"$defs": {
|
|
@@ -3807,9 +3854,9 @@
|
|
|
3807
3854
|
}
|
|
3808
3855
|
}
|
|
3809
3856
|
},
|
|
3810
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.
|
|
3857
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.7.0": {
|
|
3811
3858
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3812
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.
|
|
3859
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.7.0",
|
|
3813
3860
|
"title": "HDF Affected Package Primitives",
|
|
3814
3861
|
"description": "Types for representing the software package(s) affected by a vulnerability finding.",
|
|
3815
3862
|
"$defs": {
|
package/dist/ts/hdf.d.ts
CHANGED
|
@@ -1016,7 +1016,9 @@ export interface Evidence {
|
|
|
1016
1016
|
capturedBy?: Identity;
|
|
1017
1017
|
/**
|
|
1018
1018
|
* The evidence content. For screenshots/files: base64-encoded data or URL. For code/logs:
|
|
1019
|
-
* the raw text. For URLs: the URL string.
|
|
1019
|
+
* the raw text. For URLs: the URL string. Must not be empty. When encoding is 'base64',
|
|
1020
|
+
* data must be bare base64 matching ^[0-9A-Za-z+/]+={0,2}$ (OSCAL's Base64Datatype): no
|
|
1021
|
+
* data: URI prefix, URL, or line breaks.
|
|
1020
1022
|
*/
|
|
1021
1023
|
data: string;
|
|
1022
1024
|
/**
|
|
@@ -1024,7 +1026,8 @@ export interface Evidence {
|
|
|
1024
1026
|
*/
|
|
1025
1027
|
description?: string;
|
|
1026
1028
|
/**
|
|
1027
|
-
* Encoding used for the data. Example: 'base64', 'utf-8'.
|
|
1029
|
+
* Encoding used for the data. Example: 'base64', 'utf-8'. The value 'base64' (exactly,
|
|
1030
|
+
* lowercase) requires data to be bare base64.
|
|
1028
1031
|
*/
|
|
1029
1032
|
encoding?: string;
|
|
1030
1033
|
/**
|
|
@@ -1159,6 +1162,13 @@ export interface Milestone {
|
|
|
1159
1162
|
* Current status of this milestone.
|
|
1160
1163
|
*/
|
|
1161
1164
|
status: MilestoneStatus;
|
|
1165
|
+
/**
|
|
1166
|
+
* Short single-line label for this milestone, suitable where a consumer needs a title (for
|
|
1167
|
+
* example an OSCAL POA&M remediation or task). No line breaks, and no leading or trailing
|
|
1168
|
+
* whitespace. The description remains the full text of the milestone; the title does not
|
|
1169
|
+
* replace it.
|
|
1170
|
+
*/
|
|
1171
|
+
title?: string;
|
|
1162
1172
|
[property: string]: any;
|
|
1163
1173
|
}
|
|
1164
1174
|
/**
|