@mitre/hdf-schema 3.1.0 → 3.3.0

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.
Files changed (38) hide show
  1. package/README.md +20 -14
  2. package/dist/go/go.mod +2 -2
  3. package/dist/go/hdf.go +570 -210
  4. package/dist/helpers.d.ts +5 -1
  5. package/dist/index.d.ts +27 -52
  6. package/dist/index.js +30 -48
  7. package/dist/schemas/hdf-amendments.schema.json +565 -45
  8. package/dist/schemas/hdf-baseline.schema.json +570 -50
  9. package/dist/schemas/hdf-comparison.schema.json +820 -103
  10. package/dist/schemas/hdf-evidence-package.schema.json +564 -44
  11. package/dist/schemas/hdf-plan.schema.json +571 -50
  12. package/dist/schemas/hdf-results.schema.json +777 -80
  13. package/dist/schemas/hdf-system.schema.json +596 -59
  14. package/dist/ts/hdf.d.ts +3562 -0
  15. package/dist/ts/hdf.js +564 -0
  16. package/dist/ts/hdf.ts +3623 -0
  17. package/package.json +18 -17
  18. package/dist/ts/hdf-amendments.d.ts +0 -474
  19. package/dist/ts/hdf-amendments.js +0 -88
  20. package/dist/ts/hdf-amendments.ts +0 -486
  21. package/dist/ts/hdf-baseline.d.ts +0 -472
  22. package/dist/ts/hdf-baseline.js +0 -58
  23. package/dist/ts/hdf-baseline.ts +0 -483
  24. package/dist/ts/hdf-comparison.d.ts +0 -1185
  25. package/dist/ts/hdf-comparison.js +0 -216
  26. package/dist/ts/hdf-comparison.ts +0 -1210
  27. package/dist/ts/hdf-evidence-package.d.ts +0 -348
  28. package/dist/ts/hdf-evidence-package.js +0 -39
  29. package/dist/ts/hdf-evidence-package.ts +0 -356
  30. package/dist/ts/hdf-plan.d.ts +0 -204
  31. package/dist/ts/hdf-plan.js +0 -23
  32. package/dist/ts/hdf-plan.ts +0 -205
  33. package/dist/ts/hdf-results.d.ts +0 -1511
  34. package/dist/ts/hdf-results.js +0 -194
  35. package/dist/ts/hdf-results.ts +0 -1536
  36. package/dist/ts/hdf-system.d.ts +0 -609
  37. package/dist/ts/hdf-system.js +0 -102
  38. package/dist/ts/hdf-system.ts +0 -617
@@ -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-plan/v3.1.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/hdf-plan/v3.3.0",
4
4
  "title": "HDF Plan",
5
5
  "description": "Defines an assessment plan — what baselines to run against which targets, with resolved inputs and scheduling. Maps to OSCAL Assessment Plan.",
6
6
  "type": "object",
@@ -20,7 +20,7 @@
20
20
  "description": "Human-readable plan name. Example: 'Portal Monthly Assessment'."
21
21
  },
22
22
  "type": {
23
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.1.0#/$defs/Plan_Type",
23
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.3.0#/$defs/Plan_Type",
24
24
  "description": "The type of assessment plan."
25
25
  },
26
26
  "description": {
@@ -36,12 +36,12 @@
36
36
  "type": "array",
37
37
  "minItems": 1,
38
38
  "items": {
39
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.1.0#/$defs/Assessment"
39
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.3.0#/$defs/Assessment"
40
40
  },
41
41
  "description": "The assessments to perform. Each assessment pairs a baseline with targets and resolved inputs."
42
42
  },
43
43
  "schedule": {
44
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.1.0#/$defs/Schedule",
44
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.3.0#/$defs/Schedule",
45
45
  "description": "Optional scheduling configuration for recurring assessments."
46
46
  },
47
47
  "labels": {
@@ -52,7 +52,7 @@
52
52
  "description": "Optional key-value labels for grouping and querying plans."
53
53
  },
54
54
  "integrity": {
55
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0#/$defs/Integrity",
55
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Integrity",
56
56
  "description": "Cryptographic integrity information for verifying this plan document has not been tampered with."
57
57
  },
58
58
  "version": {
@@ -60,7 +60,7 @@
60
60
  "description": "Version of this plan document."
61
61
  },
62
62
  "generator": {
63
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0#/$defs/Generator",
63
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Generator",
64
64
  "description": "Information about the tool that generated this plan."
65
65
  }
66
66
  },
@@ -94,9 +94,9 @@
94
94
  }
95
95
  ],
96
96
  "$defs": {
97
- "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.1.0": {
97
+ "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.3.0": {
98
98
  "$schema": "https://json-schema.org/draft/2020-12/schema",
99
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.1.0",
99
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.3.0",
100
100
  "title": "HDF Plan Primitives",
101
101
  "description": "Types for defining assessment plans — what to scan, how to configure it, and when to run.",
102
102
  "$defs": {
@@ -144,7 +144,7 @@
144
144
  "description": "componentId of the system component this assessment targets. Use for direct component binding. Alternative to targetSelector."
145
145
  },
146
146
  "targetSelector": {
147
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0#/$defs/Target_Selector",
147
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0#/$defs/Target_Selector",
148
148
  "description": "Label selector to match targets for this assessment. Overrides the system component's targetSelector if provided."
149
149
  },
150
150
  "inputs": {
@@ -226,9 +226,9 @@
226
226
  }
227
227
  }
228
228
  },
229
- "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0": {
229
+ "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0": {
230
230
  "$schema": "https://json-schema.org/draft/2020-12/schema",
231
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0",
231
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0",
232
232
  "title": "HDF System Primitives",
233
233
  "description": "Types for describing system architecture, authorization boundaries, and components.",
234
234
  "$defs": {
@@ -279,7 +279,7 @@
279
279
  "description": "Rationale for why this override is needed."
280
280
  },
281
281
  "approvedBy": {
282
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
282
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
283
283
  "description": "Identity of the person or system that approved this override."
284
284
  }
285
285
  },
@@ -309,6 +309,7 @@
309
309
  },
310
310
  "designation": {
311
311
  "type": "string",
312
+ "title": "Designation",
312
313
  "enum": [
313
314
  "common",
314
315
  "system-specific",
@@ -360,9 +361,9 @@
360
361
  }
361
362
  }
362
363
  },
363
- "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0": {
364
+ "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0": {
364
365
  "$schema": "https://json-schema.org/draft/2020-12/schema",
365
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0",
366
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0",
366
367
  "title": "HDF Common Primitives",
367
368
  "description": "Shared building blocks used by hdf-results and hdf-baseline schemas.",
368
369
  "$defs": {
@@ -629,6 +630,7 @@
629
630
  },
630
631
  "type": {
631
632
  "type": "string",
633
+ "title": "Identity Type",
632
634
  "enum": [
633
635
  "email",
634
636
  "username",
@@ -672,6 +674,7 @@
672
674
  "properties": {
673
675
  "type": {
674
676
  "type": "string",
677
+ "title": "Evidence Type",
675
678
  "enum": [
676
679
  "screenshot",
677
680
  "code",
@@ -848,6 +851,7 @@
848
851
  },
849
852
  "status": {
850
853
  "type": "string",
854
+ "title": "Milestone Status",
851
855
  "enum": [
852
856
  "pending",
853
857
  "inProgress",
@@ -1107,15 +1111,42 @@
1107
1111
  },
1108
1112
  "code": {
1109
1113
  "type": "string",
1110
- "description": "The raw source code of the requirement. Set to null for manual-only requirements or requirements not yet implemented. Note that if this is an overlay, it does not include the underlying source code."
1114
+ "description": "The raw source code of the requirement. Set to null for manual-only requirements or requirements not yet implemented; use verificationMethod to disambiguate manual-by-design from manual-pending-automation. Note that if this is an overlay, it does not include the underlying source code."
1111
1115
  },
1112
1116
  "sourceLocation": {
1113
1117
  "$ref": "#/$defs/Source_Location",
1114
1118
  "description": "The explicit location of the requirement within the source code."
1119
+ },
1120
+ "controlType": {
1121
+ "type": "string",
1122
+ "title": "Control Type",
1123
+ "enum": [
1124
+ "policy",
1125
+ "procedure",
1126
+ "technical",
1127
+ "management",
1128
+ "operational"
1129
+ ],
1130
+ "description": "Classification of the control's nature, aligning with NIST SP 800-53 / SP 800-53A categories. 'policy' = an authored governance statement; 'procedure' = a documented process; 'technical' = an enforced technical configuration; 'management' = a programmatic/management activity; 'operational' = a recurring operational activity (e.g. AT, IR, MA families). Optional: when omitted, consumers may infer heuristically from family/id but should not assume a default."
1131
+ },
1132
+ "verificationMethod": {
1133
+ "$ref": "#/$defs/Verification_Method_Enum",
1134
+ "description": "How this requirement is intended to be verified. Disambiguates the two cases that null 'code' overloads: 'manual-by-design' (the requirement is statement-form and not amenable to automation, e.g. FedRAMP 20x KSIs); 'manual-pending-automation' (automation could exist but does not yet, e.g. a STIG rule lacking a fix). 'automated' = a check exists and runs without operator action; 'hybrid' = part automated, part manual. Optional: when omitted, consumers should not infer a default."
1135
+ },
1136
+ "applicability": {
1137
+ "type": "string",
1138
+ "title": "Applicability",
1139
+ "enum": [
1140
+ "required",
1141
+ "optional",
1142
+ "advisory"
1143
+ ],
1144
+ "description": "Whether the requirement is mandatory within its baseline. Distinct from severity (risk weight) and status (lifecycle state). Maps 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{}). Optional: when omitted, consumers should treat the requirement as 'required' by convention."
1115
1145
  }
1116
1146
  },
1117
1147
  "examples": [
1118
1148
  {
1149
+ "$comment": "v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape under v3.3.0 (backward compatibility).",
1119
1150
  "id": "SV-238196",
1120
1151
  "title": "The Ubuntu operating system must enforce password complexity",
1121
1152
  "impact": 0.5,
@@ -1143,11 +1174,85 @@
1143
1174
  "data": "Verify the value of 'minlen' in /etc/security/pwquality.conf."
1144
1175
  }
1145
1176
  ]
1177
+ },
1178
+ {
1179
+ "$comment": "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.",
1180
+ "id": "AC-3",
1181
+ "title": "Access Enforcement",
1182
+ "impact": 0.7,
1183
+ "tags": {
1184
+ "nist": [
1185
+ "AC-3"
1186
+ ],
1187
+ "severity": "high"
1188
+ },
1189
+ "descriptions": [
1190
+ {
1191
+ "label": "default",
1192
+ "data": "The information system enforces approved authorizations for logical access to information and system resources."
1193
+ }
1194
+ ],
1195
+ "code": "control 'AC-3' do; impact 0.7; end",
1196
+ "controlType": "technical",
1197
+ "verificationMethod": "automated",
1198
+ "applicability": "required"
1199
+ },
1200
+ {
1201
+ "$comment": "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.",
1202
+ "id": "KSI-CNA-01",
1203
+ "title": "Cyber Security Plan documents the system",
1204
+ "impact": 0.5,
1205
+ "tags": {
1206
+ "ksi": [
1207
+ "KSI-CNA"
1208
+ ]
1209
+ },
1210
+ "descriptions": [
1211
+ {
1212
+ "label": "default",
1213
+ "data": "The Cyber Security Plan documents the system, its boundary, and its components."
1214
+ }
1215
+ ],
1216
+ "controlType": "policy",
1217
+ "verificationMethod": "manual-by-design",
1218
+ "applicability": "required"
1219
+ },
1220
+ {
1221
+ "$comment": "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.",
1222
+ "id": "SV-999999",
1223
+ "title": "Example STIG rule pending automation",
1224
+ "impact": 0.3,
1225
+ "tags": {
1226
+ "stig_id": "SV-999999"
1227
+ },
1228
+ "descriptions": [
1229
+ {
1230
+ "label": "default",
1231
+ "data": "Example requirement that is intended to be automated but currently lacks a fix block."
1232
+ },
1233
+ {
1234
+ "label": "check",
1235
+ "data": "Manual review of system configuration is required."
1236
+ }
1237
+ ],
1238
+ "verificationMethod": "manual-pending-automation",
1239
+ "applicability": "advisory"
1146
1240
  }
1147
1241
  ],
1148
1242
  "description": "Core requirement fields shared between baseline requirements and evaluated requirements. Contains the fundamental requirement definition without assessment results.",
1149
1243
  "title": "Requirement Core"
1150
1244
  },
1245
+ "Verification_Method_Enum": {
1246
+ "type": "string",
1247
+ "enum": [
1248
+ "automated",
1249
+ "manual-by-design",
1250
+ "manual-pending-automation",
1251
+ "hybrid"
1252
+ ],
1253
+ "description": "How a requirement is intended to be verified. Disambiguates the two cases that null 'code' overloads: 'manual-by-design' (the requirement is statement-form and not amenable to automation, e.g. FedRAMP 20x KSIs); 'manual-pending-automation' (automation could exist but does not yet, e.g. a STIG rule lacking a fix). 'automated' = a check exists and runs without operator action; 'hybrid' = part automated, part manual. Named '_Enum' to disambiguate from the unrelated Verification_Method DID-context struct.",
1254
+ "title": "Verification Method Enum"
1255
+ },
1151
1256
  "Severity": {
1152
1257
  "type": "string",
1153
1258
  "enum": [
@@ -1178,9 +1283,9 @@
1178
1283
  }
1179
1284
  }
1180
1285
  },
1181
- "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0": {
1286
+ "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0": {
1182
1287
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1183
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0",
1288
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0",
1184
1289
  "title": "HDF Extension Primitives",
1185
1290
  "description": "Extension types for waivers, attestations, generators, and integrity.",
1186
1291
  "$defs": {
@@ -1208,15 +1313,15 @@
1208
1313
  ],
1209
1314
  "properties": {
1210
1315
  "type": {
1211
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0#/$defs/Override_Type",
1316
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Override_Type",
1212
1317
  "description": "The type of override applied to this requirement."
1213
1318
  },
1214
1319
  "status": {
1215
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0#/$defs/Result_Status",
1320
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
1216
1321
  "description": "The new status this override sets for the requirement. Optional when only impact is being overridden."
1217
1322
  },
1218
1323
  "impact": {
1219
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0#/$defs/Impact_Override",
1324
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Impact_Override",
1220
1325
  "description": "Override to the requirement's impact score. At least one of status or impact must be set."
1221
1326
  },
1222
1327
  "reason": {
@@ -1224,7 +1329,7 @@
1224
1329
  "description": "Explanation for why this override was applied."
1225
1330
  },
1226
1331
  "appliedBy": {
1227
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
1332
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1228
1333
  "description": "Identity of who applied this override. For simple cases, use type 'simple' with just an identifier."
1229
1334
  },
1230
1335
  "appliedAt": {
@@ -1238,19 +1343,28 @@
1238
1343
  "description": "Timestamp when this override expires and must be reviewed/renewed. REQUIRED - no permanent overrides allowed. ISO 8601 format."
1239
1344
  },
1240
1345
  "signature": {
1241
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Signature",
1346
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
1242
1347
  "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."
1243
1348
  },
1244
1349
  "evidence": {
1245
1350
  "type": "array",
1246
1351
  "items": {
1247
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Evidence"
1352
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
1248
1353
  },
1249
1354
  "description": "Supporting evidence for this override, such as screenshots demonstrating manual verification for attestations."
1250
1355
  },
1251
1356
  "previousChecksum": {
1252
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Checksum",
1357
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
1253
1358
  "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."
1359
+ },
1360
+ "cvss": {
1361
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
1362
+ "$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.",
1363
+ "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."
1364
+ },
1365
+ "justification": {
1366
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Justification",
1367
+ "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."
1254
1368
  }
1255
1369
  },
1256
1370
  "examples": [
@@ -1342,6 +1456,7 @@
1342
1456
  "properties": {
1343
1457
  "type": {
1344
1458
  "type": "string",
1459
+ "title": "POAM Type",
1345
1460
  "enum": [
1346
1461
  "remediation",
1347
1462
  "mitigation",
@@ -1355,7 +1470,7 @@
1355
1470
  "description": "Detailed explanation of the plan, including what actions will be taken."
1356
1471
  },
1357
1472
  "appliedBy": {
1358
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
1473
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1359
1474
  "description": "Identity of who created this POA&M. For simple cases, use type 'simple' with just an identifier."
1360
1475
  },
1361
1476
  "appliedAt": {
@@ -1371,23 +1486,23 @@
1371
1486
  "milestones": {
1372
1487
  "type": "array",
1373
1488
  "items": {
1374
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Milestone"
1489
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
1375
1490
  },
1376
1491
  "description": "Optional array of milestones tracking progress toward completion."
1377
1492
  },
1378
1493
  "signature": {
1379
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Signature",
1494
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
1380
1495
  "description": "Optional digital signature for enhanced trust and non-repudiation."
1381
1496
  },
1382
1497
  "evidence": {
1383
1498
  "type": "array",
1384
1499
  "items": {
1385
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Evidence"
1500
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
1386
1501
  },
1387
1502
  "description": "Supporting evidence for this POA&M, such as documentation of compensating controls or mitigation implementation."
1388
1503
  },
1389
1504
  "previousChecksum": {
1390
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Checksum",
1505
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
1391
1506
  "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."
1392
1507
  }
1393
1508
  },
@@ -1538,7 +1653,7 @@
1538
1653
  },
1539
1654
  "properties": {
1540
1655
  "algorithm": {
1541
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Hash_Algorithm",
1656
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Hash_Algorithm",
1542
1657
  "description": "The hash algorithm used for the checksum."
1543
1658
  },
1544
1659
  "checksum": {
@@ -1571,9 +1686,9 @@
1571
1686
  }
1572
1687
  }
1573
1688
  },
1574
- "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0": {
1689
+ "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0": {
1575
1690
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1576
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0",
1691
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0",
1577
1692
  "title": "HDF Amendment Primitives",
1578
1693
  "description": "Types for waivers, attestations, and POA&Ms that modify requirement compliance status.",
1579
1694
  "$defs": {
@@ -1591,6 +1706,24 @@
1591
1706
  "description": "The type of amendment, aligned with FedRAMP deviation request categories. 'waiver': risk accepted by Authorizing Official. 'attestation': manually verified by assessor. 'poam': remediation tracked (no status change). 'inherited': control provided by another component or system. 'falsePositive': scanner incorrectly identified a finding — for compliance scans (STIG, CIS), the check actually passes, so status is typically set to 'passed'; for vulnerability scans (CVE, SCA), the flagged vulnerability does not apply to this system, so status is typically set to 'notApplicable'. The disposition field on the requirement distinguishes false positives from genuinely not-applicable findings. 'riskAdjustment': impact score adjusted based on environmental context (FedRAMP Risk Adjustment); does not change pass/fail status, only impact via the impact field. 'operationalRequirement': deviation required by operational constraints (FedRAMP Operational Requirement); the finding cannot be remediated because the system requires the affected functionality. Remains an open risk. Migration note: 'exception' was removed in v3.1.0 — use 'waiver' with status 'notApplicable' instead.",
1592
1707
  "title": "Override Type"
1593
1708
  },
1709
+ "Justification": {
1710
+ "type": "string",
1711
+ "enum": [
1712
+ "component_not_present",
1713
+ "vulnerable_code_not_present",
1714
+ "vulnerable_code_not_in_execute_path",
1715
+ "vulnerable_code_cannot_be_controlled_by_adversary",
1716
+ "inline_mitigations_already_exist",
1717
+ "requires_configuration",
1718
+ "requires_dependency",
1719
+ "requires_environment",
1720
+ "protected_by_compiler",
1721
+ "protected_at_runtime",
1722
+ "protected_at_perimeter"
1723
+ ],
1724
+ "description": "Structured controlled-vocabulary reason for an override, complementing the free-text 'reason' field. 'reason' carries the human-readable rationale an auditor reads; 'justification' carries the machine-readable category enabling filtering, aggregation, and lossless round-trip with structured ecosystems (VEX, OSCAL, FedRAMP DR). Both fields may be present simultaneously and are NOT redundant: 'reason' explains the specific circumstance; 'justification' classifies it. Authors SHOULD populate both when a controlled-vocabulary value applies — the enum value alone is not self-explanatory to an auditor. The vocabulary is drawn from the VEX ecosystem: the first five values are common across OpenVEX, CSAF VEX, and CycloneDX VEX; the remaining six (requires_configuration / requires_dependency / requires_environment / protected_by_compiler / protected_at_runtime / protected_at_perimeter) are CycloneDX-specific and describe why the vulnerable code path is unreachable in the deployed configuration. The enum is extended additively across schema versions as other ecosystems' controlled vocabularies are integrated; documents using values added in a newer schema version will fail validation against an older schema. Consumers SHOULD validate against the schema version declared by the document ($schema) rather than assume a fixed vocabulary.",
1725
+ "title": "Justification"
1726
+ },
1594
1727
  "Impact_Override": {
1595
1728
  "type": "object",
1596
1729
  "required": [
@@ -1610,6 +1743,7 @@
1610
1743
  },
1611
1744
  "Standalone_Override": {
1612
1745
  "type": "object",
1746
+ "description": "A standalone override to a requirement's compliance status or risk impact. Validation has two branches gated on 'type': when type is 'operationalRequirement', neither 'status' nor 'impact' may be set — the override records accepted risk without changing the finding (documentation-only). For all other types, at least one of 'status' or 'impact' must be set. This rule aligns with: (1) OSCAL Assessment Results — finding.target.status and finding.associated-risk[].facet[] are separate axes (https://pages.nist.gov/OSCAL/learn/concepts/layer/assessment/assessment-results/); (2) FedRAMP deviation request types — Risk Adjustment changes impact only, Operational Requirement documents acceptance only, False Positive changes status (https://www.ignyteplatform.com/blog/fedramp/fedramp-deviation-requests-submit/); (3) NIST SP 800-37 RMF — risk response (accept/mitigate/transfer) is a separate step from control assessment status (https://csrc.nist.gov/pubs/sp/800/37/r2/final).",
1613
1747
  "unevaluatedProperties": false,
1614
1748
  "required": [
1615
1749
  "type",
@@ -1619,18 +1753,48 @@
1619
1753
  "appliedAt",
1620
1754
  "expiresAt"
1621
1755
  ],
1622
- "anyOf": [
1623
- {
1624
- "required": [
1625
- "status"
1626
- ]
1756
+ "if": {
1757
+ "properties": {
1758
+ "type": {
1759
+ "enum": [
1760
+ "operationalRequirement"
1761
+ ]
1762
+ }
1627
1763
  },
1628
- {
1629
- "required": [
1630
- "impact"
1764
+ "required": [
1765
+ "type"
1766
+ ]
1767
+ },
1768
+ "then": {
1769
+ "not": {
1770
+ "anyOf": [
1771
+ {
1772
+ "required": [
1773
+ "status"
1774
+ ]
1775
+ },
1776
+ {
1777
+ "required": [
1778
+ "impact"
1779
+ ]
1780
+ }
1631
1781
  ]
1632
1782
  }
1633
- ],
1783
+ },
1784
+ "else": {
1785
+ "anyOf": [
1786
+ {
1787
+ "required": [
1788
+ "status"
1789
+ ]
1790
+ },
1791
+ {
1792
+ "required": [
1793
+ "impact"
1794
+ ]
1795
+ }
1796
+ ]
1797
+ },
1634
1798
  "properties": {
1635
1799
  "type": {
1636
1800
  "$ref": "#/$defs/Override_Type",
@@ -1645,7 +1809,7 @@
1645
1809
  "description": "Name of the baseline containing the requirement. Required when the system has multiple baselines with potentially overlapping requirement IDs."
1646
1810
  },
1647
1811
  "status": {
1648
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0#/$defs/Result_Status",
1812
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
1649
1813
  "description": "The new status this amendment sets. Optional when only impact is being overridden."
1650
1814
  },
1651
1815
  "impact": {
@@ -1657,7 +1821,7 @@
1657
1821
  "description": "Justification for this amendment."
1658
1822
  },
1659
1823
  "appliedBy": {
1660
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
1824
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1661
1825
  "description": "Identity of who applied this amendment."
1662
1826
  },
1663
1827
  "appliedAt": {
@@ -1673,22 +1837,31 @@
1673
1837
  "evidence": {
1674
1838
  "type": "array",
1675
1839
  "items": {
1676
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Evidence"
1840
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
1677
1841
  },
1678
1842
  "description": "Supporting evidence (screenshots, logs, URLs, documents)."
1679
1843
  },
1680
1844
  "signature": {
1681
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Signature",
1845
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
1682
1846
  "description": "Digital signature for non-repudiation."
1683
1847
  },
1684
1848
  "previousChecksum": {
1685
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Checksum",
1849
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
1686
1850
  "description": "Checksum of the prior amendment in the chain. Creates a tamper-evident linked list. Null for the first amendment."
1687
1851
  },
1852
+ "cvss": {
1853
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
1854
+ "$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.",
1855
+ "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."
1856
+ },
1857
+ "justification": {
1858
+ "$ref": "#/$defs/Justification",
1859
+ "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."
1860
+ },
1688
1861
  "milestones": {
1689
1862
  "type": "array",
1690
1863
  "items": {
1691
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Milestone"
1864
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
1692
1865
  },
1693
1866
  "description": "Remediation milestones (primarily for POA&M type amendments)."
1694
1867
  },
@@ -1701,6 +1874,13 @@
1701
1874
  "type": "string",
1702
1875
  "format": "uuid",
1703
1876
  "description": "componentId of the component this amendment is scoped to. When set, the amendment only applies to the specified component. When omitted, the amendment applies system-wide."
1877
+ },
1878
+ "affectedPackages": {
1879
+ "type": "array",
1880
+ "items": {
1881
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0#/$defs/Affected_Package"
1882
+ },
1883
+ "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)."
1704
1884
  }
1705
1885
  },
1706
1886
  "examples": [
@@ -1802,16 +1982,38 @@
1802
1982
  },
1803
1983
  "appliedAt": "2026-03-26T10:00:00Z",
1804
1984
  "expiresAt": "2026-09-26T00:00:00Z"
1985
+ },
1986
+ {
1987
+ "$comment": "VEX-style import — falsePositive scoped to specific packages by purl. The affectedPackages array carries structured product identity instead of squeezing 'Products: …' into the reason free-text field.",
1988
+ "type": "falsePositive",
1989
+ "requirementId": "CVE-2026-12345",
1990
+ "status": "notApplicable",
1991
+ "reason": "Vulnerable code path is not present in our build — dependency compiled with the affected module disabled",
1992
+ "justification": "vulnerable_code_not_present",
1993
+ "appliedBy": {
1994
+ "type": "email",
1995
+ "identifier": "secops@org.gov"
1996
+ },
1997
+ "appliedAt": "2026-05-01T10:00:00Z",
1998
+ "expiresAt": "2027-05-01T00:00:00Z",
1999
+ "affectedPackages": [
2000
+ {
2001
+ "purl": "pkg:npm/lodash@4.17.20"
2002
+ },
2003
+ {
2004
+ "purl": "pkg:rpm/openssl@1.1.1k-2.el8",
2005
+ "fixedInVersion": "1.1.1k-3.el8"
2006
+ }
2007
+ ]
1805
2008
  }
1806
2009
  ],
1807
- "description": "A standalone amendment that modifies a requirement's compliance status and/or impact score. At least one of status or impact must be set. Extends the inline Override concept with requirementId and baselineRef for use outside of results documents.",
1808
2010
  "title": "Standalone Override"
1809
2011
  }
1810
2012
  }
1811
2013
  },
1812
- "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0": {
2014
+ "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0": {
1813
2015
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1814
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0",
2016
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0",
1815
2017
  "title": "HDF Result Primitives",
1816
2018
  "description": "Types for representing assessment results and statuses.",
1817
2019
  "$defs": {
@@ -1941,6 +2143,325 @@
1941
2143
  "title": "Requirement Description"
1942
2144
  }
1943
2145
  }
2146
+ },
2147
+ "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0": {
2148
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2149
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0",
2150
+ "title": "HDF CVSS Primitives",
2151
+ "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).",
2152
+ "$defs": {
2153
+ "Cvss_Severity": {
2154
+ "type": "string",
2155
+ "enum": [
2156
+ "none",
2157
+ "low",
2158
+ "medium",
2159
+ "high",
2160
+ "critical"
2161
+ ],
2162
+ "description": "Qualitative CVSS severity band. Aligns with FIRST/NVD bands: none=0.0, low=0.1-3.9, medium=4.0-6.9, high=7.0-8.9, critical=9.0-10.0. Distinct from the broader Severity enum used on Requirement_Core (which includes 'informational').",
2163
+ "title": "CVSS Severity"
2164
+ },
2165
+ "Cvss": {
2166
+ "type": "object",
2167
+ "unevaluatedProperties": false,
2168
+ "required": [
2169
+ "version"
2170
+ ],
2171
+ "anyOf": [
2172
+ {
2173
+ "required": [
2174
+ "baseScore"
2175
+ ]
2176
+ },
2177
+ {
2178
+ "required": [
2179
+ "baseVector"
2180
+ ]
2181
+ },
2182
+ {
2183
+ "required": [
2184
+ "threatVector"
2185
+ ]
2186
+ },
2187
+ {
2188
+ "required": [
2189
+ "threatScore"
2190
+ ]
2191
+ },
2192
+ {
2193
+ "required": [
2194
+ "environmentalVector"
2195
+ ]
2196
+ },
2197
+ {
2198
+ "required": [
2199
+ "environmentalScore"
2200
+ ]
2201
+ },
2202
+ {
2203
+ "required": [
2204
+ "supplementalVector"
2205
+ ]
2206
+ },
2207
+ {
2208
+ "required": [
2209
+ "computedScore"
2210
+ ]
2211
+ }
2212
+ ],
2213
+ "$comment": "Only `version` is required; every metric/score field is optional because a single Cvss instance may represent vendor-supplied Base data (on a finding's cvss[]), consumer-supplied enrichment (on a riskAdjustment override — Environmental/Threat/Supplemental deltas with NO base, since base is the finding's scan-specific vendor data), or a fully-resolved effectiveCvss. The Base/Threat/Environmental/Supplemental groups do not partition cleanly into vendor-vs-consumer (Threat straddles: vendor temporal data and consumer exploit-maturity both live here), so a single permissive type is more honest than separate vendor/consumer types. The anyOf guardrail rejects a content-free object (e.g. {version} alone) by requiring at least one substantive metric or score. baseVector remains optional even when baseScore is present: some vendor tools (Twistlock/Prisma Cloud) emit a final score without the vector that derived it — that score is captured structurally rather than lost.",
2214
+ "properties": {
2215
+ "version": {
2216
+ "type": "string",
2217
+ "enum": [
2218
+ "2.0",
2219
+ "3.0",
2220
+ "3.1",
2221
+ "4.0"
2222
+ ],
2223
+ "description": "The CVSS specification version this entry conforms to. Vendor scanners typically emit 3.1 or 4.0; legacy data may use 2.0 or 3.0."
2224
+ },
2225
+ "source": {
2226
+ "type": "string",
2227
+ "description": "Optional identifier the CVSS data is associated with — most commonly a CVE ID (e.g., 'CVE-2024-12345'), but may also be a vendor advisory ID, GHSA, or similar.",
2228
+ "examples": [
2229
+ "CVE-2024-12345",
2230
+ "GHSA-9hjg-9r4m-mvj7",
2231
+ "RHSA-2024:0123"
2232
+ ]
2233
+ },
2234
+ "baseVector": {
2235
+ "type": "string",
2236
+ "$comment": "Optional. Permissive umbrella pattern accepting any FIRST CVSS vector shape — version prefix is optional (CVSS 2.0 has no prefix), metric tokens are alphanumeric uppercase pairs separated by '/'. Strict per-version semantic validation belongs in a separate utility (hdf-utilities `validateCvssVector`), not in the schema. See https://www.first.org/cvss/v4.0/specification-document for the v4 grammar and earlier-version documents for v2/v3.",
2237
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2238
+ "description": "Optional Base metric group vector string as emitted by the source (e.g., 'CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H'). For CVSS 2.0 the version prefix is omitted. Some vendor tools emit a final baseScore without the vector — in that case this field is absent and the score cannot be recomputed or decomposed. The pattern accepts any version-prefixed or prefix-less metric token sequence; semantic validity of individual metrics is checked by hdf-utilities, not by the schema."
2239
+ },
2240
+ "baseScore": {
2241
+ "type": "number",
2242
+ "minimum": 0,
2243
+ "maximum": 10,
2244
+ "description": "The Base score (0.0–10.0) computed from the base vector. Reflects the intrinsic, vendor-published severity before consumer enrichment."
2245
+ },
2246
+ "baseSeverity": {
2247
+ "$ref": "#/$defs/Cvss_Severity",
2248
+ "description": "Qualitative severity band corresponding to baseScore. CVSS 2.0 does not natively use 'none' or 'critical' bands; map accordingly when populating."
2249
+ },
2250
+ "threatVector": {
2251
+ "type": "string",
2252
+ "$comment": "Threat (formerly Temporal in v3.x) metric group. Consumer-side metrics: Exploit Maturity, Remediation Level, Report Confidence (v3 added E/RL/RC; v4 keeps E only). Same permissive grammar as baseVector but the CVSS version prefix is rarely repeated here.",
2253
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2254
+ "description": "Optional Threat metric group vector segment (e.g., 'E:U/RL:O/RC:C' for CVSS 3.1, or 'E:A' for CVSS 4.0). Consumer-supplied — captures real-world exploitation and remediation context the vendor cannot know."
2255
+ },
2256
+ "threatScore": {
2257
+ "type": "number",
2258
+ "minimum": 0,
2259
+ "maximum": 10,
2260
+ "description": "Optional score (0.0–10.0) recomputed after applying Threat metrics. Always less than or equal to baseScore in practice."
2261
+ },
2262
+ "environmentalVector": {
2263
+ "type": "string",
2264
+ "$comment": "Environmental metric group. Consumer-side: Modified Base metrics (MAV, MAC, MC, MI, MA, ...) plus Security Requirements (CR, IR, AR). Captures how a particular consumer's environment changes the impact of the vulnerability.",
2265
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2266
+ "description": "Optional Environmental metric group vector segment (e.g., 'MAV:N/CR:H/IR:H/AR:H'). Consumer-supplied — reflects the deployment context (criticality, mitigations, network exposure)."
2267
+ },
2268
+ "environmentalScore": {
2269
+ "type": "number",
2270
+ "minimum": 0,
2271
+ "maximum": 10,
2272
+ "description": "Optional score (0.0–10.0) recomputed after applying Environmental metrics."
2273
+ },
2274
+ "supplementalVector": {
2275
+ "type": "string",
2276
+ "$comment": "Supplemental metric group is unique to CVSS 4.0. It conveys context (Safety, Automatable, Recovery, Value Density, Vulnerability Response Effort, Provider Urgency) but by spec does NOT affect any score — purely informational.",
2277
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2278
+ "description": "Optional Supplemental metric group vector segment (CVSS 4.0 only). Examples: 'S:P/AU:N/V:C/RE:M/U:Amber'. Per CVSS 4.0 spec, supplemental metrics convey additional context but have no impact on the computed score."
2279
+ },
2280
+ "computedScore": {
2281
+ "type": "number",
2282
+ "minimum": 0,
2283
+ "maximum": 10,
2284
+ "description": "Optional final score after combining Base + Threat + Environmental metrics. This is the score consumers should treat as authoritative for risk decisions when present."
2285
+ },
2286
+ "computedSeverity": {
2287
+ "$ref": "#/$defs/Cvss_Severity",
2288
+ "description": "Qualitative severity band corresponding to computedScore. Same band convention as baseSeverity."
2289
+ }
2290
+ },
2291
+ "examples": [
2292
+ {
2293
+ "$comment": "Base-only: vendor-supplied CVSS 3.1 data exactly as a scanner (e.g., Nessus, Grype) would emit it. No consumer enrichment yet.",
2294
+ "version": "3.1",
2295
+ "source": "CVE-2024-12345",
2296
+ "baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
2297
+ "baseScore": 9.8,
2298
+ "baseSeverity": "critical"
2299
+ },
2300
+ {
2301
+ "$comment": "Base + Threat: consumer added Exploit Maturity ('E:U' = Unproven) and Remediation Level ('RL:O' = Official Fix) to a HTTP/2 'Rapid Reset' DoS finding. Threat score drops from base 7.5 to 5.5.",
2302
+ "version": "3.1",
2303
+ "source": "CVE-2023-44487",
2304
+ "baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H",
2305
+ "baseScore": 7.5,
2306
+ "baseSeverity": "high",
2307
+ "threatVector": "E:U/RL:O/RC:C",
2308
+ "threatScore": 5.5
2309
+ },
2310
+ {
2311
+ "$comment": "Base + Environmental: consumer asserts the affected system is high-criticality (CR:H, IR:H, AR:H) AND network-reachable in their environment (MAV:N). Environmental score reflects deployment risk for the xz-utils backdoor.",
2312
+ "version": "3.1",
2313
+ "source": "CVE-2024-3094",
2314
+ "baseVector": "CVSS:3.1/AV:L/AC:H/PR:H/UI:N/S:U/C:H/I:H/A:H",
2315
+ "baseScore": 6.7,
2316
+ "baseSeverity": "medium",
2317
+ "environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
2318
+ "environmentalScore": 9,
2319
+ "computedScore": 9,
2320
+ "computedSeverity": "critical"
2321
+ },
2322
+ {
2323
+ "$comment": "Full CVSS 4.0: vendor base + consumer threat (E:A = Attacked, exploits seen in the wild) + environmental (high CIA requirements) + supplemental context (S:P = present safety impact, AU:N = no autonomous spread, RE:M = moderate response effort) for the Fortinet FortiOS pre-auth RCE. computedScore reflects post-mitigation final risk.",
2324
+ "version": "4.0",
2325
+ "source": "CVE-2024-21762",
2326
+ "baseVector": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N",
2327
+ "baseScore": 9.8,
2328
+ "baseSeverity": "critical",
2329
+ "threatVector": "E:A",
2330
+ "threatScore": 9.3,
2331
+ "environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
2332
+ "environmentalScore": 9.5,
2333
+ "supplementalVector": "S:P/AU:N/V:C/RE:M",
2334
+ "computedScore": 4.2,
2335
+ "computedSeverity": "medium"
2336
+ },
2337
+ {
2338
+ "$comment": "CVSS 2.0 legacy: Heartbleed (CVE-2014-0160) as still reported by older scanner output and legacy NVD data. CVSS 2.0 vectors have no 'CVSS:2.0/' prefix.",
2339
+ "version": "2.0",
2340
+ "source": "CVE-2014-0160",
2341
+ "baseVector": "AV:N/AC:L/Au:N/C:P/I:N/A:N",
2342
+ "baseScore": 5,
2343
+ "baseSeverity": "medium"
2344
+ }
2345
+ ],
2346
+ "description": "A CVSS (Common Vulnerability Scoring System) score record for a vulnerability finding. Captures the vendor-supplied Base metric group and optional consumer-supplied Threat, Environmental, and Supplemental metric groups. Supports all four CVSS major versions (2.0, 3.0, 3.1, 4.0). Vector strings are validated against a permissive umbrella grammar; semantic validation (correct metrics per version, correct values per metric) is performed by the hdf-utilities `validateCvssVector` helper rather than at the schema layer.",
2347
+ "title": "CVSS"
2348
+ }
2349
+ }
2350
+ },
2351
+ "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0": {
2352
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2353
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0",
2354
+ "title": "HDF Affected Package Primitives",
2355
+ "description": "Types for representing the software package(s) affected by a vulnerability finding.",
2356
+ "$defs": {
2357
+ "Affected_Package": {
2358
+ "type": "object",
2359
+ "unevaluatedProperties": false,
2360
+ "anyOf": [
2361
+ {
2362
+ "required": [
2363
+ "name",
2364
+ "version",
2365
+ "ecosystem"
2366
+ ]
2367
+ },
2368
+ {
2369
+ "required": [
2370
+ "purl"
2371
+ ]
2372
+ },
2373
+ {
2374
+ "required": [
2375
+ "cpe"
2376
+ ]
2377
+ }
2378
+ ],
2379
+ "properties": {
2380
+ "name": {
2381
+ "type": "string",
2382
+ "description": "The package name as published in its ecosystem. Examples: 'openssl' (rpm), 'lodash' (npm), 'org.apache.logging.log4j:log4j-core' (maven, group:artifact)."
2383
+ },
2384
+ "version": {
2385
+ "type": "string",
2386
+ "description": "The exact version of the package that the vulnerability scanner observed. Use the ecosystem's native version string verbatim (e.g., '1.1.1k-7.el8_4' for rpm, '4.17.20' for npm)."
2387
+ },
2388
+ "ecosystem": {
2389
+ "type": "string",
2390
+ "enum": [
2391
+ "npm",
2392
+ "pypi",
2393
+ "rpm",
2394
+ "deb",
2395
+ "maven",
2396
+ "gem",
2397
+ "nuget",
2398
+ "go",
2399
+ "cargo",
2400
+ "generic"
2401
+ ],
2402
+ "description": "The packaging ecosystem the package belongs to. Use 'generic' for hardware, firmware, or anything outside the listed language/OS package managers."
2403
+ },
2404
+ "cpe": {
2405
+ "type": "string",
2406
+ "pattern": "^cpe:2\\.3:[aho]:.*",
2407
+ "description": "Optional CPE 2.3 URI identifying the affected product. Validated leniently: only the 'cpe:2.3:' prefix and the part-type letter ('a' application, 'h' hardware, 'o' operating system) are enforced here. Use `hdf-utilities.parseCpe` for full-grammar parsing. Example: 'cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*'."
2408
+ },
2409
+ "purl": {
2410
+ "type": "string",
2411
+ "pattern": "^pkg:[A-Za-z0-9.+-]+/.+",
2412
+ "description": "Optional Package URL (PURL) identifying the affected package. Validated leniently: only the 'pkg:TYPE/' scheme prefix is enforced here, where TYPE follows the PURL grammar (a letter followed by letters, digits, '.', '+', or '-') and is matched case-insensitively to mirror `hdf-utilities.parsePurl`'s accept-and-warn behavior. Use `parsePurl` for full PURL parsing. Example: 'pkg:rpm/redhat/openssl@1.1.1k-7.el8_4?arch=x86_64'."
2413
+ },
2414
+ "fixedInVersion": {
2415
+ "type": "string",
2416
+ "description": "Optional version string identifying the first release that contains the fix for the vulnerability. Use the same version syntax as `version`. Example: '1.1.1l' fixes 'openssl@1.1.1k'."
2417
+ }
2418
+ },
2419
+ "examples": [
2420
+ {
2421
+ "$comment": "RPM ecosystem with full CPE + PURL — typical Grype/Trivy output for a RHEL host scan.",
2422
+ "name": "openssl",
2423
+ "version": "1.1.1k-7.el8_4",
2424
+ "ecosystem": "rpm",
2425
+ "cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*",
2426
+ "purl": "pkg:rpm/redhat/openssl@1.1.1k-7.el8_4?arch=x86_64",
2427
+ "fixedInVersion": "1.1.1l"
2428
+ },
2429
+ {
2430
+ "$comment": "NPM ecosystem with PURL only — the JavaScript world rarely emits CPEs; PURL is the canonical identifier.",
2431
+ "name": "lodash",
2432
+ "version": "4.17.20",
2433
+ "ecosystem": "npm",
2434
+ "purl": "pkg:npm/lodash@4.17.20",
2435
+ "fixedInVersion": "4.17.21"
2436
+ },
2437
+ {
2438
+ "$comment": "Minimal valid AffectedPackage — only the three required fields. Use when the scanner reports a package by name+version without emitting CPE or PURL strings.",
2439
+ "name": "requests",
2440
+ "version": "2.28.1",
2441
+ "ecosystem": "pypi"
2442
+ },
2443
+ {
2444
+ "$comment": "Maven ecosystem with full identifiers + fixedInVersion — log4j Log4Shell-style finding showing the patch path from vulnerable to fixed.",
2445
+ "name": "org.apache.logging.log4j:log4j-core",
2446
+ "version": "2.14.1",
2447
+ "ecosystem": "maven",
2448
+ "cpe": "cpe:2.3:a:apache:log4j:2.14.1:*:*:*:*:*:*:*",
2449
+ "purl": "pkg:maven/org.apache.logging.log4j/log4j-core@2.14.1",
2450
+ "fixedInVersion": "2.17.1"
2451
+ },
2452
+ {
2453
+ "$comment": "purl-only — VEX import path where the source format gives a purl and we choose not to decompose it. Valid because purl encodes name/version/ecosystem implicitly.",
2454
+ "purl": "pkg:npm/lodash@4.17.20"
2455
+ },
2456
+ {
2457
+ "$comment": "cpe-only — NIST-flavored scopes where the consumer carries a CPE 2.3 string and no purl. Valid because cpe encodes vendor/product/version.",
2458
+ "cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*"
2459
+ }
2460
+ ],
2461
+ "description": "Represents a package referenced by a vulnerability finding or by an amendment's scope. On Evaluated_Requirement.affectedPackages it says 'this CVE affects these package versions'. On Standalone_Override.affectedPackages it says 'this amendment is scoped to these packages' (used by VEX, OSCAL POA&M, FedRAMP component-aware amendments). NOT a system-level component identifier — see `components[]` on hdf-system for those. Validity requires at least one of: (name + version + ecosystem), purl alone, or cpe alone. purl and cpe are self-describing identifiers that encode name/version implicitly, so either may stand on its own; the name+version+ecosystem combination is the explicit form for sources without formal identifiers.",
2462
+ "title": "Affected Package"
2463
+ }
2464
+ }
1944
2465
  }
1945
2466
  }
1946
2467
  }