@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-baseline/v3.1.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/hdf-baseline/v3.3.0",
4
4
  "type": "object",
5
5
  "unevaluatedProperties": false,
6
6
  "required": [
@@ -9,7 +9,7 @@
9
9
  ],
10
10
  "allOf": [
11
11
  {
12
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Baseline_Metadata"
12
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Baseline_Metadata"
13
13
  }
14
14
  ],
15
15
  "properties": {
@@ -24,34 +24,34 @@
24
24
  "groups": {
25
25
  "type": "array",
26
26
  "items": {
27
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Requirement_Group"
27
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Requirement_Group"
28
28
  },
29
29
  "description": "A set of descriptions for the requirement groups."
30
30
  },
31
31
  "inputs": {
32
32
  "type": "array",
33
33
  "items": {
34
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/parameter/v3.1.0#/$defs/Input"
34
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/parameter/v3.3.0#/$defs/Input"
35
35
  },
36
36
  "description": "The input(s) or attribute(s) to be used in the run."
37
37
  },
38
38
  "integrity": {
39
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0#/$defs/Integrity",
39
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Integrity",
40
40
  "description": "Cryptographic integrity information for verifying this baseline has not been tampered with."
41
41
  },
42
42
  "remediation": {
43
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Remediation",
43
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Remediation",
44
44
  "description": "Optional reference to automated remediation resources (Ansible playbooks, Terraform scripts, etc.) for implementing the security controls defined in this baseline."
45
45
  },
46
46
  "depends": {
47
47
  "type": "array",
48
48
  "items": {
49
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Dependency"
49
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Dependency"
50
50
  },
51
51
  "description": "The set of dependencies this baseline depends on."
52
52
  },
53
53
  "generator": {
54
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0#/$defs/Generator",
54
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Generator",
55
55
  "description": "The tool that generated this file."
56
56
  }
57
57
  },
@@ -142,7 +142,7 @@
142
142
  ],
143
143
  "allOf": [
144
144
  {
145
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Requirement_Core"
145
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Requirement_Core"
146
146
  }
147
147
  ],
148
148
  "properties": {
@@ -151,7 +151,7 @@
151
151
  "description": "Array of labeled descriptions. At least one description with label 'default' must be present. Convention: place default description first. Common labels: 'default', 'check', 'fix', 'rationale'."
152
152
  },
153
153
  "severity": {
154
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Severity",
154
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Severity",
155
155
  "description": "Explicit severity rating. Typically derived from impact score but provided explicitly for clarity."
156
156
  }
157
157
  },
@@ -193,9 +193,9 @@
193
193
  "description": "Array of labeled descriptions. At least one description with label 'default' must be present.",
194
194
  "title": "Baseline Requirement Descriptions"
195
195
  },
196
- "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0": {
196
+ "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0": {
197
197
  "$schema": "https://json-schema.org/draft/2020-12/schema",
198
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0",
198
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0",
199
199
  "title": "HDF Common Primitives",
200
200
  "description": "Shared building blocks used by hdf-results and hdf-baseline schemas.",
201
201
  "$defs": {
@@ -462,6 +462,7 @@
462
462
  },
463
463
  "type": {
464
464
  "type": "string",
465
+ "title": "Identity Type",
465
466
  "enum": [
466
467
  "email",
467
468
  "username",
@@ -505,6 +506,7 @@
505
506
  "properties": {
506
507
  "type": {
507
508
  "type": "string",
509
+ "title": "Evidence Type",
508
510
  "enum": [
509
511
  "screenshot",
510
512
  "code",
@@ -681,6 +683,7 @@
681
683
  },
682
684
  "status": {
683
685
  "type": "string",
686
+ "title": "Milestone Status",
684
687
  "enum": [
685
688
  "pending",
686
689
  "inProgress",
@@ -940,15 +943,42 @@
940
943
  },
941
944
  "code": {
942
945
  "type": "string",
943
- "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."
946
+ "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."
944
947
  },
945
948
  "sourceLocation": {
946
949
  "$ref": "#/$defs/Source_Location",
947
950
  "description": "The explicit location of the requirement within the source code."
951
+ },
952
+ "controlType": {
953
+ "type": "string",
954
+ "title": "Control Type",
955
+ "enum": [
956
+ "policy",
957
+ "procedure",
958
+ "technical",
959
+ "management",
960
+ "operational"
961
+ ],
962
+ "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."
963
+ },
964
+ "verificationMethod": {
965
+ "$ref": "#/$defs/Verification_Method_Enum",
966
+ "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."
967
+ },
968
+ "applicability": {
969
+ "type": "string",
970
+ "title": "Applicability",
971
+ "enum": [
972
+ "required",
973
+ "optional",
974
+ "advisory"
975
+ ],
976
+ "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."
948
977
  }
949
978
  },
950
979
  "examples": [
951
980
  {
981
+ "$comment": "v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape under v3.3.0 (backward compatibility).",
952
982
  "id": "SV-238196",
953
983
  "title": "The Ubuntu operating system must enforce password complexity",
954
984
  "impact": 0.5,
@@ -976,11 +1006,85 @@
976
1006
  "data": "Verify the value of 'minlen' in /etc/security/pwquality.conf."
977
1007
  }
978
1008
  ]
1009
+ },
1010
+ {
1011
+ "$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.",
1012
+ "id": "AC-3",
1013
+ "title": "Access Enforcement",
1014
+ "impact": 0.7,
1015
+ "tags": {
1016
+ "nist": [
1017
+ "AC-3"
1018
+ ],
1019
+ "severity": "high"
1020
+ },
1021
+ "descriptions": [
1022
+ {
1023
+ "label": "default",
1024
+ "data": "The information system enforces approved authorizations for logical access to information and system resources."
1025
+ }
1026
+ ],
1027
+ "code": "control 'AC-3' do; impact 0.7; end",
1028
+ "controlType": "technical",
1029
+ "verificationMethod": "automated",
1030
+ "applicability": "required"
1031
+ },
1032
+ {
1033
+ "$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.",
1034
+ "id": "KSI-CNA-01",
1035
+ "title": "Cyber Security Plan documents the system",
1036
+ "impact": 0.5,
1037
+ "tags": {
1038
+ "ksi": [
1039
+ "KSI-CNA"
1040
+ ]
1041
+ },
1042
+ "descriptions": [
1043
+ {
1044
+ "label": "default",
1045
+ "data": "The Cyber Security Plan documents the system, its boundary, and its components."
1046
+ }
1047
+ ],
1048
+ "controlType": "policy",
1049
+ "verificationMethod": "manual-by-design",
1050
+ "applicability": "required"
1051
+ },
1052
+ {
1053
+ "$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.",
1054
+ "id": "SV-999999",
1055
+ "title": "Example STIG rule pending automation",
1056
+ "impact": 0.3,
1057
+ "tags": {
1058
+ "stig_id": "SV-999999"
1059
+ },
1060
+ "descriptions": [
1061
+ {
1062
+ "label": "default",
1063
+ "data": "Example requirement that is intended to be automated but currently lacks a fix block."
1064
+ },
1065
+ {
1066
+ "label": "check",
1067
+ "data": "Manual review of system configuration is required."
1068
+ }
1069
+ ],
1070
+ "verificationMethod": "manual-pending-automation",
1071
+ "applicability": "advisory"
979
1072
  }
980
1073
  ],
981
1074
  "description": "Core requirement fields shared between baseline requirements and evaluated requirements. Contains the fundamental requirement definition without assessment results.",
982
1075
  "title": "Requirement Core"
983
1076
  },
1077
+ "Verification_Method_Enum": {
1078
+ "type": "string",
1079
+ "enum": [
1080
+ "automated",
1081
+ "manual-by-design",
1082
+ "manual-pending-automation",
1083
+ "hybrid"
1084
+ ],
1085
+ "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.",
1086
+ "title": "Verification Method Enum"
1087
+ },
984
1088
  "Severity": {
985
1089
  "type": "string",
986
1090
  "enum": [
@@ -1011,9 +1115,9 @@
1011
1115
  }
1012
1116
  }
1013
1117
  },
1014
- "https://mitre.github.io/hdf-libs/schemas/primitives/parameter/v3.1.0": {
1118
+ "https://mitre.github.io/hdf-libs/schemas/primitives/parameter/v3.3.0": {
1015
1119
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1016
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/parameter/v3.1.0",
1120
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/parameter/v3.3.0",
1017
1121
  "title": "HDF Parameter Primitives",
1018
1122
  "description": "Input/parameter type definitions for typed, traceable configuration values that bridge governance prose and scanner automation.",
1019
1123
  "$defs": {
@@ -1144,9 +1248,9 @@
1144
1248
  }
1145
1249
  }
1146
1250
  },
1147
- "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0": {
1251
+ "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0": {
1148
1252
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1149
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0",
1253
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0",
1150
1254
  "title": "HDF Extension Primitives",
1151
1255
  "description": "Extension types for waivers, attestations, generators, and integrity.",
1152
1256
  "$defs": {
@@ -1174,15 +1278,15 @@
1174
1278
  ],
1175
1279
  "properties": {
1176
1280
  "type": {
1177
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0#/$defs/Override_Type",
1281
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Override_Type",
1178
1282
  "description": "The type of override applied to this requirement."
1179
1283
  },
1180
1284
  "status": {
1181
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0#/$defs/Result_Status",
1285
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
1182
1286
  "description": "The new status this override sets for the requirement. Optional when only impact is being overridden."
1183
1287
  },
1184
1288
  "impact": {
1185
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0#/$defs/Impact_Override",
1289
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Impact_Override",
1186
1290
  "description": "Override to the requirement's impact score. At least one of status or impact must be set."
1187
1291
  },
1188
1292
  "reason": {
@@ -1190,7 +1294,7 @@
1190
1294
  "description": "Explanation for why this override was applied."
1191
1295
  },
1192
1296
  "appliedBy": {
1193
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
1297
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1194
1298
  "description": "Identity of who applied this override. For simple cases, use type 'simple' with just an identifier."
1195
1299
  },
1196
1300
  "appliedAt": {
@@ -1204,19 +1308,28 @@
1204
1308
  "description": "Timestamp when this override expires and must be reviewed/renewed. REQUIRED - no permanent overrides allowed. ISO 8601 format."
1205
1309
  },
1206
1310
  "signature": {
1207
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Signature",
1311
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
1208
1312
  "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."
1209
1313
  },
1210
1314
  "evidence": {
1211
1315
  "type": "array",
1212
1316
  "items": {
1213
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Evidence"
1317
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
1214
1318
  },
1215
1319
  "description": "Supporting evidence for this override, such as screenshots demonstrating manual verification for attestations."
1216
1320
  },
1217
1321
  "previousChecksum": {
1218
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Checksum",
1322
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
1219
1323
  "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."
1324
+ },
1325
+ "cvss": {
1326
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
1327
+ "$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.",
1328
+ "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."
1329
+ },
1330
+ "justification": {
1331
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Justification",
1332
+ "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."
1220
1333
  }
1221
1334
  },
1222
1335
  "examples": [
@@ -1308,6 +1421,7 @@
1308
1421
  "properties": {
1309
1422
  "type": {
1310
1423
  "type": "string",
1424
+ "title": "POAM Type",
1311
1425
  "enum": [
1312
1426
  "remediation",
1313
1427
  "mitigation",
@@ -1321,7 +1435,7 @@
1321
1435
  "description": "Detailed explanation of the plan, including what actions will be taken."
1322
1436
  },
1323
1437
  "appliedBy": {
1324
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
1438
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1325
1439
  "description": "Identity of who created this POA&M. For simple cases, use type 'simple' with just an identifier."
1326
1440
  },
1327
1441
  "appliedAt": {
@@ -1337,23 +1451,23 @@
1337
1451
  "milestones": {
1338
1452
  "type": "array",
1339
1453
  "items": {
1340
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Milestone"
1454
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
1341
1455
  },
1342
1456
  "description": "Optional array of milestones tracking progress toward completion."
1343
1457
  },
1344
1458
  "signature": {
1345
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Signature",
1459
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
1346
1460
  "description": "Optional digital signature for enhanced trust and non-repudiation."
1347
1461
  },
1348
1462
  "evidence": {
1349
1463
  "type": "array",
1350
1464
  "items": {
1351
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Evidence"
1465
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
1352
1466
  },
1353
1467
  "description": "Supporting evidence for this POA&M, such as documentation of compensating controls or mitigation implementation."
1354
1468
  },
1355
1469
  "previousChecksum": {
1356
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Checksum",
1470
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
1357
1471
  "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."
1358
1472
  }
1359
1473
  },
@@ -1504,7 +1618,7 @@
1504
1618
  },
1505
1619
  "properties": {
1506
1620
  "algorithm": {
1507
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Hash_Algorithm",
1621
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Hash_Algorithm",
1508
1622
  "description": "The hash algorithm used for the checksum."
1509
1623
  },
1510
1624
  "checksum": {
@@ -1537,9 +1651,9 @@
1537
1651
  }
1538
1652
  }
1539
1653
  },
1540
- "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0": {
1654
+ "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0": {
1541
1655
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1542
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0",
1656
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0",
1543
1657
  "title": "HDF Amendment Primitives",
1544
1658
  "description": "Types for waivers, attestations, and POA&Ms that modify requirement compliance status.",
1545
1659
  "$defs": {
@@ -1557,6 +1671,24 @@
1557
1671
  "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.",
1558
1672
  "title": "Override Type"
1559
1673
  },
1674
+ "Justification": {
1675
+ "type": "string",
1676
+ "enum": [
1677
+ "component_not_present",
1678
+ "vulnerable_code_not_present",
1679
+ "vulnerable_code_not_in_execute_path",
1680
+ "vulnerable_code_cannot_be_controlled_by_adversary",
1681
+ "inline_mitigations_already_exist",
1682
+ "requires_configuration",
1683
+ "requires_dependency",
1684
+ "requires_environment",
1685
+ "protected_by_compiler",
1686
+ "protected_at_runtime",
1687
+ "protected_at_perimeter"
1688
+ ],
1689
+ "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.",
1690
+ "title": "Justification"
1691
+ },
1560
1692
  "Impact_Override": {
1561
1693
  "type": "object",
1562
1694
  "required": [
@@ -1576,6 +1708,7 @@
1576
1708
  },
1577
1709
  "Standalone_Override": {
1578
1710
  "type": "object",
1711
+ "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).",
1579
1712
  "unevaluatedProperties": false,
1580
1713
  "required": [
1581
1714
  "type",
@@ -1585,18 +1718,48 @@
1585
1718
  "appliedAt",
1586
1719
  "expiresAt"
1587
1720
  ],
1588
- "anyOf": [
1589
- {
1590
- "required": [
1591
- "status"
1592
- ]
1721
+ "if": {
1722
+ "properties": {
1723
+ "type": {
1724
+ "enum": [
1725
+ "operationalRequirement"
1726
+ ]
1727
+ }
1593
1728
  },
1594
- {
1595
- "required": [
1596
- "impact"
1729
+ "required": [
1730
+ "type"
1731
+ ]
1732
+ },
1733
+ "then": {
1734
+ "not": {
1735
+ "anyOf": [
1736
+ {
1737
+ "required": [
1738
+ "status"
1739
+ ]
1740
+ },
1741
+ {
1742
+ "required": [
1743
+ "impact"
1744
+ ]
1745
+ }
1597
1746
  ]
1598
1747
  }
1599
- ],
1748
+ },
1749
+ "else": {
1750
+ "anyOf": [
1751
+ {
1752
+ "required": [
1753
+ "status"
1754
+ ]
1755
+ },
1756
+ {
1757
+ "required": [
1758
+ "impact"
1759
+ ]
1760
+ }
1761
+ ]
1762
+ },
1600
1763
  "properties": {
1601
1764
  "type": {
1602
1765
  "$ref": "#/$defs/Override_Type",
@@ -1611,7 +1774,7 @@
1611
1774
  "description": "Name of the baseline containing the requirement. Required when the system has multiple baselines with potentially overlapping requirement IDs."
1612
1775
  },
1613
1776
  "status": {
1614
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0#/$defs/Result_Status",
1777
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
1615
1778
  "description": "The new status this amendment sets. Optional when only impact is being overridden."
1616
1779
  },
1617
1780
  "impact": {
@@ -1623,7 +1786,7 @@
1623
1786
  "description": "Justification for this amendment."
1624
1787
  },
1625
1788
  "appliedBy": {
1626
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
1789
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1627
1790
  "description": "Identity of who applied this amendment."
1628
1791
  },
1629
1792
  "appliedAt": {
@@ -1639,22 +1802,31 @@
1639
1802
  "evidence": {
1640
1803
  "type": "array",
1641
1804
  "items": {
1642
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Evidence"
1805
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
1643
1806
  },
1644
1807
  "description": "Supporting evidence (screenshots, logs, URLs, documents)."
1645
1808
  },
1646
1809
  "signature": {
1647
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Signature",
1810
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
1648
1811
  "description": "Digital signature for non-repudiation."
1649
1812
  },
1650
1813
  "previousChecksum": {
1651
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Checksum",
1814
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
1652
1815
  "description": "Checksum of the prior amendment in the chain. Creates a tamper-evident linked list. Null for the first amendment."
1653
1816
  },
1817
+ "cvss": {
1818
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
1819
+ "$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.",
1820
+ "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."
1821
+ },
1822
+ "justification": {
1823
+ "$ref": "#/$defs/Justification",
1824
+ "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."
1825
+ },
1654
1826
  "milestones": {
1655
1827
  "type": "array",
1656
1828
  "items": {
1657
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Milestone"
1829
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
1658
1830
  },
1659
1831
  "description": "Remediation milestones (primarily for POA&M type amendments)."
1660
1832
  },
@@ -1667,6 +1839,13 @@
1667
1839
  "type": "string",
1668
1840
  "format": "uuid",
1669
1841
  "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."
1842
+ },
1843
+ "affectedPackages": {
1844
+ "type": "array",
1845
+ "items": {
1846
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0#/$defs/Affected_Package"
1847
+ },
1848
+ "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)."
1670
1849
  }
1671
1850
  },
1672
1851
  "examples": [
@@ -1768,16 +1947,38 @@
1768
1947
  },
1769
1948
  "appliedAt": "2026-03-26T10:00:00Z",
1770
1949
  "expiresAt": "2026-09-26T00:00:00Z"
1950
+ },
1951
+ {
1952
+ "$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.",
1953
+ "type": "falsePositive",
1954
+ "requirementId": "CVE-2026-12345",
1955
+ "status": "notApplicable",
1956
+ "reason": "Vulnerable code path is not present in our build — dependency compiled with the affected module disabled",
1957
+ "justification": "vulnerable_code_not_present",
1958
+ "appliedBy": {
1959
+ "type": "email",
1960
+ "identifier": "secops@org.gov"
1961
+ },
1962
+ "appliedAt": "2026-05-01T10:00:00Z",
1963
+ "expiresAt": "2027-05-01T00:00:00Z",
1964
+ "affectedPackages": [
1965
+ {
1966
+ "purl": "pkg:npm/lodash@4.17.20"
1967
+ },
1968
+ {
1969
+ "purl": "pkg:rpm/openssl@1.1.1k-2.el8",
1970
+ "fixedInVersion": "1.1.1k-3.el8"
1971
+ }
1972
+ ]
1771
1973
  }
1772
1974
  ],
1773
- "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.",
1774
1975
  "title": "Standalone Override"
1775
1976
  }
1776
1977
  }
1777
1978
  },
1778
- "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0": {
1979
+ "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0": {
1779
1980
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1780
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0",
1981
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0",
1781
1982
  "title": "HDF Result Primitives",
1782
1983
  "description": "Types for representing assessment results and statuses.",
1783
1984
  "$defs": {
@@ -1907,6 +2108,325 @@
1907
2108
  "title": "Requirement Description"
1908
2109
  }
1909
2110
  }
2111
+ },
2112
+ "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0": {
2113
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2114
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0",
2115
+ "title": "HDF CVSS Primitives",
2116
+ "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).",
2117
+ "$defs": {
2118
+ "Cvss_Severity": {
2119
+ "type": "string",
2120
+ "enum": [
2121
+ "none",
2122
+ "low",
2123
+ "medium",
2124
+ "high",
2125
+ "critical"
2126
+ ],
2127
+ "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').",
2128
+ "title": "CVSS Severity"
2129
+ },
2130
+ "Cvss": {
2131
+ "type": "object",
2132
+ "unevaluatedProperties": false,
2133
+ "required": [
2134
+ "version"
2135
+ ],
2136
+ "anyOf": [
2137
+ {
2138
+ "required": [
2139
+ "baseScore"
2140
+ ]
2141
+ },
2142
+ {
2143
+ "required": [
2144
+ "baseVector"
2145
+ ]
2146
+ },
2147
+ {
2148
+ "required": [
2149
+ "threatVector"
2150
+ ]
2151
+ },
2152
+ {
2153
+ "required": [
2154
+ "threatScore"
2155
+ ]
2156
+ },
2157
+ {
2158
+ "required": [
2159
+ "environmentalVector"
2160
+ ]
2161
+ },
2162
+ {
2163
+ "required": [
2164
+ "environmentalScore"
2165
+ ]
2166
+ },
2167
+ {
2168
+ "required": [
2169
+ "supplementalVector"
2170
+ ]
2171
+ },
2172
+ {
2173
+ "required": [
2174
+ "computedScore"
2175
+ ]
2176
+ }
2177
+ ],
2178
+ "$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.",
2179
+ "properties": {
2180
+ "version": {
2181
+ "type": "string",
2182
+ "enum": [
2183
+ "2.0",
2184
+ "3.0",
2185
+ "3.1",
2186
+ "4.0"
2187
+ ],
2188
+ "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."
2189
+ },
2190
+ "source": {
2191
+ "type": "string",
2192
+ "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.",
2193
+ "examples": [
2194
+ "CVE-2024-12345",
2195
+ "GHSA-9hjg-9r4m-mvj7",
2196
+ "RHSA-2024:0123"
2197
+ ]
2198
+ },
2199
+ "baseVector": {
2200
+ "type": "string",
2201
+ "$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.",
2202
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2203
+ "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."
2204
+ },
2205
+ "baseScore": {
2206
+ "type": "number",
2207
+ "minimum": 0,
2208
+ "maximum": 10,
2209
+ "description": "The Base score (0.0–10.0) computed from the base vector. Reflects the intrinsic, vendor-published severity before consumer enrichment."
2210
+ },
2211
+ "baseSeverity": {
2212
+ "$ref": "#/$defs/Cvss_Severity",
2213
+ "description": "Qualitative severity band corresponding to baseScore. CVSS 2.0 does not natively use 'none' or 'critical' bands; map accordingly when populating."
2214
+ },
2215
+ "threatVector": {
2216
+ "type": "string",
2217
+ "$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.",
2218
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2219
+ "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."
2220
+ },
2221
+ "threatScore": {
2222
+ "type": "number",
2223
+ "minimum": 0,
2224
+ "maximum": 10,
2225
+ "description": "Optional score (0.0–10.0) recomputed after applying Threat metrics. Always less than or equal to baseScore in practice."
2226
+ },
2227
+ "environmentalVector": {
2228
+ "type": "string",
2229
+ "$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.",
2230
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2231
+ "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)."
2232
+ },
2233
+ "environmentalScore": {
2234
+ "type": "number",
2235
+ "minimum": 0,
2236
+ "maximum": 10,
2237
+ "description": "Optional score (0.0–10.0) recomputed after applying Environmental metrics."
2238
+ },
2239
+ "supplementalVector": {
2240
+ "type": "string",
2241
+ "$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.",
2242
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2243
+ "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."
2244
+ },
2245
+ "computedScore": {
2246
+ "type": "number",
2247
+ "minimum": 0,
2248
+ "maximum": 10,
2249
+ "description": "Optional final score after combining Base + Threat + Environmental metrics. This is the score consumers should treat as authoritative for risk decisions when present."
2250
+ },
2251
+ "computedSeverity": {
2252
+ "$ref": "#/$defs/Cvss_Severity",
2253
+ "description": "Qualitative severity band corresponding to computedScore. Same band convention as baseSeverity."
2254
+ }
2255
+ },
2256
+ "examples": [
2257
+ {
2258
+ "$comment": "Base-only: vendor-supplied CVSS 3.1 data exactly as a scanner (e.g., Nessus, Grype) would emit it. No consumer enrichment yet.",
2259
+ "version": "3.1",
2260
+ "source": "CVE-2024-12345",
2261
+ "baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
2262
+ "baseScore": 9.8,
2263
+ "baseSeverity": "critical"
2264
+ },
2265
+ {
2266
+ "$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.",
2267
+ "version": "3.1",
2268
+ "source": "CVE-2023-44487",
2269
+ "baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H",
2270
+ "baseScore": 7.5,
2271
+ "baseSeverity": "high",
2272
+ "threatVector": "E:U/RL:O/RC:C",
2273
+ "threatScore": 5.5
2274
+ },
2275
+ {
2276
+ "$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.",
2277
+ "version": "3.1",
2278
+ "source": "CVE-2024-3094",
2279
+ "baseVector": "CVSS:3.1/AV:L/AC:H/PR:H/UI:N/S:U/C:H/I:H/A:H",
2280
+ "baseScore": 6.7,
2281
+ "baseSeverity": "medium",
2282
+ "environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
2283
+ "environmentalScore": 9,
2284
+ "computedScore": 9,
2285
+ "computedSeverity": "critical"
2286
+ },
2287
+ {
2288
+ "$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.",
2289
+ "version": "4.0",
2290
+ "source": "CVE-2024-21762",
2291
+ "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",
2292
+ "baseScore": 9.8,
2293
+ "baseSeverity": "critical",
2294
+ "threatVector": "E:A",
2295
+ "threatScore": 9.3,
2296
+ "environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
2297
+ "environmentalScore": 9.5,
2298
+ "supplementalVector": "S:P/AU:N/V:C/RE:M",
2299
+ "computedScore": 4.2,
2300
+ "computedSeverity": "medium"
2301
+ },
2302
+ {
2303
+ "$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.",
2304
+ "version": "2.0",
2305
+ "source": "CVE-2014-0160",
2306
+ "baseVector": "AV:N/AC:L/Au:N/C:P/I:N/A:N",
2307
+ "baseScore": 5,
2308
+ "baseSeverity": "medium"
2309
+ }
2310
+ ],
2311
+ "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.",
2312
+ "title": "CVSS"
2313
+ }
2314
+ }
2315
+ },
2316
+ "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0": {
2317
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2318
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0",
2319
+ "title": "HDF Affected Package Primitives",
2320
+ "description": "Types for representing the software package(s) affected by a vulnerability finding.",
2321
+ "$defs": {
2322
+ "Affected_Package": {
2323
+ "type": "object",
2324
+ "unevaluatedProperties": false,
2325
+ "anyOf": [
2326
+ {
2327
+ "required": [
2328
+ "name",
2329
+ "version",
2330
+ "ecosystem"
2331
+ ]
2332
+ },
2333
+ {
2334
+ "required": [
2335
+ "purl"
2336
+ ]
2337
+ },
2338
+ {
2339
+ "required": [
2340
+ "cpe"
2341
+ ]
2342
+ }
2343
+ ],
2344
+ "properties": {
2345
+ "name": {
2346
+ "type": "string",
2347
+ "description": "The package name as published in its ecosystem. Examples: 'openssl' (rpm), 'lodash' (npm), 'org.apache.logging.log4j:log4j-core' (maven, group:artifact)."
2348
+ },
2349
+ "version": {
2350
+ "type": "string",
2351
+ "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)."
2352
+ },
2353
+ "ecosystem": {
2354
+ "type": "string",
2355
+ "enum": [
2356
+ "npm",
2357
+ "pypi",
2358
+ "rpm",
2359
+ "deb",
2360
+ "maven",
2361
+ "gem",
2362
+ "nuget",
2363
+ "go",
2364
+ "cargo",
2365
+ "generic"
2366
+ ],
2367
+ "description": "The packaging ecosystem the package belongs to. Use 'generic' for hardware, firmware, or anything outside the listed language/OS package managers."
2368
+ },
2369
+ "cpe": {
2370
+ "type": "string",
2371
+ "pattern": "^cpe:2\\.3:[aho]:.*",
2372
+ "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:*:*:*:*:*:*:*'."
2373
+ },
2374
+ "purl": {
2375
+ "type": "string",
2376
+ "pattern": "^pkg:[A-Za-z0-9.+-]+/.+",
2377
+ "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'."
2378
+ },
2379
+ "fixedInVersion": {
2380
+ "type": "string",
2381
+ "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'."
2382
+ }
2383
+ },
2384
+ "examples": [
2385
+ {
2386
+ "$comment": "RPM ecosystem with full CPE + PURL — typical Grype/Trivy output for a RHEL host scan.",
2387
+ "name": "openssl",
2388
+ "version": "1.1.1k-7.el8_4",
2389
+ "ecosystem": "rpm",
2390
+ "cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*",
2391
+ "purl": "pkg:rpm/redhat/openssl@1.1.1k-7.el8_4?arch=x86_64",
2392
+ "fixedInVersion": "1.1.1l"
2393
+ },
2394
+ {
2395
+ "$comment": "NPM ecosystem with PURL only — the JavaScript world rarely emits CPEs; PURL is the canonical identifier.",
2396
+ "name": "lodash",
2397
+ "version": "4.17.20",
2398
+ "ecosystem": "npm",
2399
+ "purl": "pkg:npm/lodash@4.17.20",
2400
+ "fixedInVersion": "4.17.21"
2401
+ },
2402
+ {
2403
+ "$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.",
2404
+ "name": "requests",
2405
+ "version": "2.28.1",
2406
+ "ecosystem": "pypi"
2407
+ },
2408
+ {
2409
+ "$comment": "Maven ecosystem with full identifiers + fixedInVersion — log4j Log4Shell-style finding showing the patch path from vulnerable to fixed.",
2410
+ "name": "org.apache.logging.log4j:log4j-core",
2411
+ "version": "2.14.1",
2412
+ "ecosystem": "maven",
2413
+ "cpe": "cpe:2.3:a:apache:log4j:2.14.1:*:*:*:*:*:*:*",
2414
+ "purl": "pkg:maven/org.apache.logging.log4j/log4j-core@2.14.1",
2415
+ "fixedInVersion": "2.17.1"
2416
+ },
2417
+ {
2418
+ "$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.",
2419
+ "purl": "pkg:npm/lodash@4.17.20"
2420
+ },
2421
+ {
2422
+ "$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.",
2423
+ "cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*"
2424
+ }
2425
+ ],
2426
+ "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.",
2427
+ "title": "Affected Package"
2428
+ }
2429
+ }
1910
2430
  }
1911
2431
  }
1912
2432
  }