@mitre/hdf-schema 3.3.2 → 3.4.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.
@@ -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-amendments/v3.3.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/hdf-amendments/v3.4.0",
4
4
  "title": "HDF Amendments",
5
5
  "description": "Waivers, attestations, and POA&Ms that modify requirement compliance status or impact. Amendments are standalone documents that can be applied to results via merge operations.",
6
6
  "type": "object",
@@ -29,18 +29,18 @@
29
29
  "description": "URI to the hdf-system document these amendments apply to."
30
30
  },
31
31
  "appliedBy": {
32
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
32
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Identity",
33
33
  "description": "Default identity of who created this amendments document. Individual overrides may specify their own appliedBy."
34
34
  },
35
35
  "approvedBy": {
36
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
36
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Identity",
37
37
  "description": "Identity of the authorizing official who approved these amendments."
38
38
  },
39
39
  "overrides": {
40
40
  "type": "array",
41
41
  "minItems": 1,
42
42
  "items": {
43
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Standalone_Override"
43
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.4.0#/$defs/Standalone_Override"
44
44
  },
45
45
  "description": "The set of amendments (waivers, attestations, POA&Ms, and other overrides)."
46
46
  },
@@ -52,11 +52,11 @@
52
52
  "description": "Optional key-value labels for grouping and querying amendments."
53
53
  },
54
54
  "integrity": {
55
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Integrity",
55
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.4.0#/$defs/Integrity",
56
56
  "description": "Cryptographic integrity information for verifying this amendments document has not been tampered with."
57
57
  },
58
58
  "signature": {
59
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
59
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Signature",
60
60
  "description": "Document-level digital signature covering all amendments."
61
61
  },
62
62
  "version": {
@@ -64,7 +64,7 @@
64
64
  "description": "Version of this amendments document."
65
65
  },
66
66
  "generator": {
67
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Generator",
67
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.4.0#/$defs/Generator",
68
68
  "description": "Information about the tool that generated this document."
69
69
  }
70
70
  },
@@ -101,9 +101,9 @@
101
101
  }
102
102
  ],
103
103
  "$defs": {
104
- "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0": {
104
+ "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0": {
105
105
  "$schema": "https://json-schema.org/draft/2020-12/schema",
106
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0",
106
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0",
107
107
  "title": "HDF Common Primitives",
108
108
  "description": "Shared building blocks used by hdf-results and hdf-baseline schemas.",
109
109
  "$defs": {
@@ -112,9 +112,10 @@
112
112
  "enum": [
113
113
  "sha256",
114
114
  "sha384",
115
- "sha512"
115
+ "sha512",
116
+ "blake3"
116
117
  ],
117
- "description": "Supported cryptographic hash algorithms for checksums and integrity verification.",
118
+ "description": "Supported cryptographic hash algorithms for checksums and integrity verification. blake3 covers container-image and other artifact digests that use it.",
118
119
  "title": "Hash Algorithm"
119
120
  },
120
121
  "Requirement_Group": {
@@ -375,10 +376,11 @@
375
376
  "email",
376
377
  "username",
377
378
  "system",
379
+ "agent",
378
380
  "simple",
379
381
  "other"
380
382
  ],
381
- "description": "The type of identifier. Use 'email' for email addresses, 'username' for user accounts, 'system' for automated systems, 'simple' for basic string identifiers without additional classification, or 'other' for custom identity systems."
383
+ "description": "The type of identifier. Use 'email' for email addresses, 'username' for user accounts, 'system' for deterministic non-interactive automation (CI jobs, cron, scanners), 'agent' for an AI/LLM agent acting with autonomy — kept distinct from 'system' so auditors can apply AI-specific scrutiny (e.g. 'an LLM proposed this' vs a deterministic job) and satisfy AI-source disclosure under frameworks like the EU AI Act and NIST AI RMF, 'simple' for basic string identifiers without additional classification, or 'other' for custom identity systems."
382
384
  },
383
385
  "description": {
384
386
  "type": "string",
@@ -399,6 +401,11 @@
399
401
  "type": "system",
400
402
  "identifier": "automated-scanner-01",
401
403
  "description": "Nightly compliance scan pipeline"
404
+ },
405
+ {
406
+ "type": "agent",
407
+ "identifier": "cve-enrichment-bot/v0.4.2",
408
+ "description": "OpenAI GPT-4 via internal CVE-enrichment tool; proposes environmental CVSS for human review"
402
409
  }
403
410
  ],
404
411
  "description": "Represents an identity that performed an action, such as capturing evidence or applying an override.",
@@ -886,7 +893,7 @@
886
893
  },
887
894
  "examples": [
888
895
  {
889
- "$comment": "v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape under v3.3.0 (backward compatibility).",
896
+ "$comment": "v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape under v3.4.0 (backward compatibility).",
890
897
  "id": "SV-238196",
891
898
  "title": "The Ubuntu operating system must enforce password complexity",
892
899
  "impact": 0.5,
@@ -1023,9 +1030,9 @@
1023
1030
  }
1024
1031
  }
1025
1032
  },
1026
- "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0": {
1033
+ "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.4.0": {
1027
1034
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1028
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0",
1035
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.4.0",
1029
1036
  "title": "HDF Amendment Primitives",
1030
1037
  "description": "Types for waivers, attestations, and POA&Ms that modify requirement compliance status.",
1031
1038
  "$defs": {
@@ -1146,7 +1153,7 @@
1146
1153
  "description": "Name of the baseline containing the requirement. Required when the system has multiple baselines with potentially overlapping requirement IDs."
1147
1154
  },
1148
1155
  "status": {
1149
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
1156
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.4.0#/$defs/Result_Status",
1150
1157
  "description": "The new status this amendment sets. Optional when only impact is being overridden."
1151
1158
  },
1152
1159
  "impact": {
@@ -1158,7 +1165,7 @@
1158
1165
  "description": "Justification for this amendment."
1159
1166
  },
1160
1167
  "appliedBy": {
1161
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1168
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Identity",
1162
1169
  "description": "Identity of who applied this amendment."
1163
1170
  },
1164
1171
  "appliedAt": {
@@ -1174,20 +1181,20 @@
1174
1181
  "evidence": {
1175
1182
  "type": "array",
1176
1183
  "items": {
1177
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
1184
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Evidence"
1178
1185
  },
1179
1186
  "description": "Supporting evidence (screenshots, logs, URLs, documents)."
1180
1187
  },
1181
1188
  "signature": {
1182
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
1189
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Signature",
1183
1190
  "description": "Digital signature for non-repudiation."
1184
1191
  },
1185
1192
  "previousChecksum": {
1186
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
1193
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Checksum",
1187
1194
  "description": "Checksum of the prior amendment in the chain. Creates a tamper-evident linked list. Null for the first amendment."
1188
1195
  },
1189
1196
  "cvss": {
1190
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
1197
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.4.0#/$defs/Cvss",
1191
1198
  "$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.",
1192
1199
  "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."
1193
1200
  },
@@ -1198,7 +1205,7 @@
1198
1205
  "milestones": {
1199
1206
  "type": "array",
1200
1207
  "items": {
1201
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
1208
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Milestone"
1202
1209
  },
1203
1210
  "description": "Remediation milestones (primarily for POA&M type amendments)."
1204
1211
  },
@@ -1215,7 +1222,7 @@
1215
1222
  "affectedPackages": {
1216
1223
  "type": "array",
1217
1224
  "items": {
1218
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0#/$defs/Affected_Package"
1225
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.4.0#/$defs/Affected_Package"
1219
1226
  },
1220
1227
  "description": "Software packages this amendment is scoped to, distinct from componentRef (which scopes to an HDF-internal Component by UUID). Use 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. Symmetric with Evaluated_Requirement.affectedPackages, which scopes findings to the same package vocabulary. When omitted, the amendment applies system-wide (or only to componentRef when that is set)."
1221
1228
  }
@@ -1348,9 +1355,9 @@
1348
1355
  }
1349
1356
  }
1350
1357
  },
1351
- "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0": {
1358
+ "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.4.0": {
1352
1359
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1353
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0",
1360
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.4.0",
1354
1361
  "title": "HDF Result Primitives",
1355
1362
  "description": "Types for representing assessment results and statuses.",
1356
1363
  "$defs": {
@@ -1481,9 +1488,9 @@
1481
1488
  }
1482
1489
  }
1483
1490
  },
1484
- "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0": {
1491
+ "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.4.0": {
1485
1492
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1486
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0",
1493
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.4.0",
1487
1494
  "title": "HDF CVSS Primitives",
1488
1495
  "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).",
1489
1496
  "$defs": {
@@ -1685,9 +1692,9 @@
1685
1692
  }
1686
1693
  }
1687
1694
  },
1688
- "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0": {
1695
+ "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.4.0": {
1689
1696
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1690
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0",
1697
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.4.0",
1691
1698
  "title": "HDF Affected Package Primitives",
1692
1699
  "description": "Types for representing the software package(s) affected by a vulnerability finding.",
1693
1700
  "$defs": {
@@ -1800,9 +1807,9 @@
1800
1807
  }
1801
1808
  }
1802
1809
  },
1803
- "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0": {
1810
+ "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.4.0": {
1804
1811
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1805
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0",
1812
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.4.0",
1806
1813
  "title": "HDF Extension Primitives",
1807
1814
  "description": "Extension types for waivers, attestations, generators, and integrity.",
1808
1815
  "$defs": {
@@ -1830,15 +1837,15 @@
1830
1837
  ],
1831
1838
  "properties": {
1832
1839
  "type": {
1833
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Override_Type",
1840
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.4.0#/$defs/Override_Type",
1834
1841
  "description": "The type of override applied to this requirement."
1835
1842
  },
1836
1843
  "status": {
1837
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
1844
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.4.0#/$defs/Result_Status",
1838
1845
  "description": "The new status this override sets for the requirement. Optional when only impact is being overridden."
1839
1846
  },
1840
1847
  "impact": {
1841
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Impact_Override",
1848
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.4.0#/$defs/Impact_Override",
1842
1849
  "description": "Override to the requirement's impact score. At least one of status or impact must be set."
1843
1850
  },
1844
1851
  "reason": {
@@ -1846,7 +1853,7 @@
1846
1853
  "description": "Explanation for why this override was applied."
1847
1854
  },
1848
1855
  "appliedBy": {
1849
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1856
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Identity",
1850
1857
  "description": "Identity of who applied this override. For simple cases, use type 'simple' with just an identifier."
1851
1858
  },
1852
1859
  "appliedAt": {
@@ -1860,27 +1867,27 @@
1860
1867
  "description": "Timestamp when this override expires and must be reviewed/renewed. REQUIRED - no permanent overrides allowed. ISO 8601 format."
1861
1868
  },
1862
1869
  "signature": {
1863
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
1870
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Signature",
1864
1871
  "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."
1865
1872
  },
1866
1873
  "evidence": {
1867
1874
  "type": "array",
1868
1875
  "items": {
1869
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
1876
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Evidence"
1870
1877
  },
1871
1878
  "description": "Supporting evidence for this override, such as screenshots demonstrating manual verification for attestations."
1872
1879
  },
1873
1880
  "previousChecksum": {
1874
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
1881
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Checksum",
1875
1882
  "description": "SHA-256 checksum of the previous amendment in chronological order. Creates a tamper-evident chain of amendments (similar to blockchain). Null for the first amendment on a requirement."
1876
1883
  },
1877
1884
  "cvss": {
1878
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
1885
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.4.0#/$defs/Cvss",
1879
1886
  "$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.",
1880
1887
  "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."
1881
1888
  },
1882
1889
  "justification": {
1883
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Justification",
1890
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.4.0#/$defs/Justification",
1884
1891
  "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."
1885
1892
  }
1886
1893
  },
@@ -1987,7 +1994,7 @@
1987
1994
  "description": "Detailed explanation of the plan, including what actions will be taken."
1988
1995
  },
1989
1996
  "appliedBy": {
1990
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1997
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Identity",
1991
1998
  "description": "Identity of who created this POA&M. For simple cases, use type 'simple' with just an identifier."
1992
1999
  },
1993
2000
  "appliedAt": {
@@ -2003,23 +2010,23 @@
2003
2010
  "milestones": {
2004
2011
  "type": "array",
2005
2012
  "items": {
2006
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
2013
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Milestone"
2007
2014
  },
2008
2015
  "description": "Optional array of milestones tracking progress toward completion."
2009
2016
  },
2010
2017
  "signature": {
2011
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
2018
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Signature",
2012
2019
  "description": "Optional digital signature for enhanced trust and non-repudiation."
2013
2020
  },
2014
2021
  "evidence": {
2015
2022
  "type": "array",
2016
2023
  "items": {
2017
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
2024
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Evidence"
2018
2025
  },
2019
2026
  "description": "Supporting evidence for this POA&M, such as documentation of compensating controls or mitigation implementation."
2020
2027
  },
2021
2028
  "previousChecksum": {
2022
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
2029
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Checksum",
2023
2030
  "description": "SHA-256 checksum of the previous amendment in chronological order. Creates a tamper-evident chain of amendments (similar to blockchain). Null for the first amendment on a requirement."
2024
2031
  }
2025
2032
  },
@@ -2170,7 +2177,7 @@
2170
2177
  },
2171
2178
  "properties": {
2172
2179
  "algorithm": {
2173
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Hash_Algorithm",
2180
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.4.0#/$defs/Hash_Algorithm",
2174
2181
  "description": "The hash algorithm used for the checksum."
2175
2182
  },
2176
2183
  "checksum": {