@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-system/v3.1.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/hdf-system/v3.3.0",
4
4
  "title": "HDF System",
5
5
  "description": "Describes a system's authorization boundary, components, and interconnections. Maps to OSCAL SSP system-characteristics and FedRAMP system inventory.",
6
6
  "type": "object",
@@ -16,7 +16,7 @@
16
16
  "description": "Stable UUID (RFC 4122) for this system. Enables cross-document correlation independent of file location. Optional in casual use, expected in production documents."
17
17
  },
18
18
  "owner": {
19
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
19
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
20
20
  "description": "Team or individual responsible for this system's authorization and compliance. Maps to OSCAL responsible-party with role 'system-owner'."
21
21
  },
22
22
  "name": {
@@ -37,7 +37,7 @@
37
37
  "description": "Description of the system's purpose and mission."
38
38
  },
39
39
  "authorizationStatus": {
40
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0#/$defs/Authorization_Status",
40
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0#/$defs/Authorization_Status",
41
41
  "description": "Current Authorization to Operate (ATO) status."
42
42
  },
43
43
  "authorizationDate": {
@@ -46,7 +46,7 @@
46
46
  "description": "Date the current authorization status was granted. ISO 8601 format."
47
47
  },
48
48
  "categorizationLevel": {
49
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0#/$defs/Categorization_Level",
49
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0#/$defs/Categorization_Level",
50
50
  "description": "FIPS 199 security categorization (impact level)."
51
51
  },
52
52
  "boundaryDescription": {
@@ -57,21 +57,21 @@
57
57
  "type": "array",
58
58
  "minItems": 1,
59
59
  "items": {
60
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.1.0#/$defs/Component"
60
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.3.0#/$defs/Component"
61
61
  },
62
62
  "description": "System components within the authorization boundary. Uses the full polymorphic Component type with stable identity (componentId), external references, and SBOM support."
63
63
  },
64
64
  "controlDesignations": {
65
65
  "type": "array",
66
66
  "items": {
67
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0#/$defs/Control_Designation"
67
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0#/$defs/Control_Designation"
68
68
  },
69
69
  "description": "Declares which controls are common, hybrid, or system-specific, and which component provides them. Maps to NIST SP 800-53 control designations and OSCAL leveraged-authorizations."
70
70
  },
71
71
  "dataFlows": {
72
72
  "type": "array",
73
73
  "items": {
74
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.1.0#/$defs/Data_Flow"
74
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.3.0#/$defs/Data_Flow"
75
75
  },
76
76
  "description": "Inter-component data flows describing how components communicate. Supports local, cross-system, and external flows. Replaces the interconnections[] field."
77
77
  },
@@ -83,7 +83,7 @@
83
83
  "description": "Optional key-value labels for grouping and querying systems."
84
84
  },
85
85
  "integrity": {
86
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0#/$defs/Integrity",
86
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Integrity",
87
87
  "description": "Cryptographic integrity information for verifying this system document has not been tampered with."
88
88
  },
89
89
  "version": {
@@ -91,7 +91,7 @@
91
91
  "description": "Version of this system document."
92
92
  },
93
93
  "generator": {
94
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0#/$defs/Generator",
94
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Generator",
95
95
  "description": "Information about the tool that generated this system document."
96
96
  }
97
97
  },
@@ -139,9 +139,9 @@
139
139
  }
140
140
  ],
141
141
  "$defs": {
142
- "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0": {
142
+ "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0": {
143
143
  "$schema": "https://json-schema.org/draft/2020-12/schema",
144
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0",
144
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0",
145
145
  "title": "HDF Common Primitives",
146
146
  "description": "Shared building blocks used by hdf-results and hdf-baseline schemas.",
147
147
  "$defs": {
@@ -408,6 +408,7 @@
408
408
  },
409
409
  "type": {
410
410
  "type": "string",
411
+ "title": "Identity Type",
411
412
  "enum": [
412
413
  "email",
413
414
  "username",
@@ -451,6 +452,7 @@
451
452
  "properties": {
452
453
  "type": {
453
454
  "type": "string",
455
+ "title": "Evidence Type",
454
456
  "enum": [
455
457
  "screenshot",
456
458
  "code",
@@ -627,6 +629,7 @@
627
629
  },
628
630
  "status": {
629
631
  "type": "string",
632
+ "title": "Milestone Status",
630
633
  "enum": [
631
634
  "pending",
632
635
  "inProgress",
@@ -886,15 +889,42 @@
886
889
  },
887
890
  "code": {
888
891
  "type": "string",
889
- "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."
892
+ "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."
890
893
  },
891
894
  "sourceLocation": {
892
895
  "$ref": "#/$defs/Source_Location",
893
896
  "description": "The explicit location of the requirement within the source code."
897
+ },
898
+ "controlType": {
899
+ "type": "string",
900
+ "title": "Control Type",
901
+ "enum": [
902
+ "policy",
903
+ "procedure",
904
+ "technical",
905
+ "management",
906
+ "operational"
907
+ ],
908
+ "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."
909
+ },
910
+ "verificationMethod": {
911
+ "$ref": "#/$defs/Verification_Method_Enum",
912
+ "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."
913
+ },
914
+ "applicability": {
915
+ "type": "string",
916
+ "title": "Applicability",
917
+ "enum": [
918
+ "required",
919
+ "optional",
920
+ "advisory"
921
+ ],
922
+ "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."
894
923
  }
895
924
  },
896
925
  "examples": [
897
926
  {
927
+ "$comment": "v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape under v3.3.0 (backward compatibility).",
898
928
  "id": "SV-238196",
899
929
  "title": "The Ubuntu operating system must enforce password complexity",
900
930
  "impact": 0.5,
@@ -922,11 +952,85 @@
922
952
  "data": "Verify the value of 'minlen' in /etc/security/pwquality.conf."
923
953
  }
924
954
  ]
955
+ },
956
+ {
957
+ "$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.",
958
+ "id": "AC-3",
959
+ "title": "Access Enforcement",
960
+ "impact": 0.7,
961
+ "tags": {
962
+ "nist": [
963
+ "AC-3"
964
+ ],
965
+ "severity": "high"
966
+ },
967
+ "descriptions": [
968
+ {
969
+ "label": "default",
970
+ "data": "The information system enforces approved authorizations for logical access to information and system resources."
971
+ }
972
+ ],
973
+ "code": "control 'AC-3' do; impact 0.7; end",
974
+ "controlType": "technical",
975
+ "verificationMethod": "automated",
976
+ "applicability": "required"
977
+ },
978
+ {
979
+ "$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.",
980
+ "id": "KSI-CNA-01",
981
+ "title": "Cyber Security Plan documents the system",
982
+ "impact": 0.5,
983
+ "tags": {
984
+ "ksi": [
985
+ "KSI-CNA"
986
+ ]
987
+ },
988
+ "descriptions": [
989
+ {
990
+ "label": "default",
991
+ "data": "The Cyber Security Plan documents the system, its boundary, and its components."
992
+ }
993
+ ],
994
+ "controlType": "policy",
995
+ "verificationMethod": "manual-by-design",
996
+ "applicability": "required"
997
+ },
998
+ {
999
+ "$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.",
1000
+ "id": "SV-999999",
1001
+ "title": "Example STIG rule pending automation",
1002
+ "impact": 0.3,
1003
+ "tags": {
1004
+ "stig_id": "SV-999999"
1005
+ },
1006
+ "descriptions": [
1007
+ {
1008
+ "label": "default",
1009
+ "data": "Example requirement that is intended to be automated but currently lacks a fix block."
1010
+ },
1011
+ {
1012
+ "label": "check",
1013
+ "data": "Manual review of system configuration is required."
1014
+ }
1015
+ ],
1016
+ "verificationMethod": "manual-pending-automation",
1017
+ "applicability": "advisory"
925
1018
  }
926
1019
  ],
927
1020
  "description": "Core requirement fields shared between baseline requirements and evaluated requirements. Contains the fundamental requirement definition without assessment results.",
928
1021
  "title": "Requirement Core"
929
1022
  },
1023
+ "Verification_Method_Enum": {
1024
+ "type": "string",
1025
+ "enum": [
1026
+ "automated",
1027
+ "manual-by-design",
1028
+ "manual-pending-automation",
1029
+ "hybrid"
1030
+ ],
1031
+ "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.",
1032
+ "title": "Verification Method Enum"
1033
+ },
930
1034
  "Severity": {
931
1035
  "type": "string",
932
1036
  "enum": [
@@ -957,9 +1061,9 @@
957
1061
  }
958
1062
  }
959
1063
  },
960
- "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0": {
1064
+ "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0": {
961
1065
  "$schema": "https://json-schema.org/draft/2020-12/schema",
962
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0",
1066
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0",
963
1067
  "title": "HDF System Primitives",
964
1068
  "description": "Types for describing system architecture, authorization boundaries, and components.",
965
1069
  "$defs": {
@@ -1010,7 +1114,7 @@
1010
1114
  "description": "Rationale for why this override is needed."
1011
1115
  },
1012
1116
  "approvedBy": {
1013
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
1117
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1014
1118
  "description": "Identity of the person or system that approved this override."
1015
1119
  }
1016
1120
  },
@@ -1040,6 +1144,7 @@
1040
1144
  },
1041
1145
  "designation": {
1042
1146
  "type": "string",
1147
+ "title": "Designation",
1043
1148
  "enum": [
1044
1149
  "common",
1045
1150
  "system-specific",
@@ -1091,9 +1196,9 @@
1091
1196
  }
1092
1197
  }
1093
1198
  },
1094
- "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.1.0": {
1199
+ "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.3.0": {
1095
1200
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1096
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.1.0",
1201
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.3.0",
1097
1202
  "title": "HDF Component Primitives",
1098
1203
  "description": "First-class system component with identity, polymorphic type, SBOM embedding, and system-binding properties. Components are the successor to Targets, adding stable identity (componentId), external system cross-references, and software inventory.",
1099
1204
  "$defs": {
@@ -1107,6 +1212,20 @@
1107
1212
  "properties": {
1108
1213
  "type": {
1109
1214
  "type": "string",
1215
+ "title": "Target Type",
1216
+ "enum": [
1217
+ "host",
1218
+ "containerImage",
1219
+ "containerInstance",
1220
+ "containerPlatform",
1221
+ "cloudAccount",
1222
+ "cloudResource",
1223
+ "repository",
1224
+ "application",
1225
+ "artifact",
1226
+ "network",
1227
+ "database"
1228
+ ],
1110
1229
  "description": "Component type discriminator. Same values as Target types."
1111
1230
  },
1112
1231
  "name": {
@@ -1123,7 +1242,7 @@
1123
1242
  "description": "Description of this component's role or purpose."
1124
1243
  },
1125
1244
  "owner": {
1126
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
1245
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1127
1246
  "description": "Team or individual responsible for this component. Enables per-component ownership when different teams manage different parts of a system."
1128
1247
  },
1129
1248
  "externalIds": {
@@ -1151,6 +1270,7 @@
1151
1270
  },
1152
1271
  "sbomFormat": {
1153
1272
  "type": "string",
1273
+ "title": "SBOM Format",
1154
1274
  "enum": [
1155
1275
  "cyclonedx",
1156
1276
  "spdx"
@@ -1167,12 +1287,12 @@
1167
1287
  "inputOverrides": {
1168
1288
  "type": "array",
1169
1289
  "items": {
1170
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0#/$defs/Input_Override"
1290
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0#/$defs/Input_Override"
1171
1291
  },
1172
1292
  "description": "System-specific overrides for baseline input values."
1173
1293
  },
1174
1294
  "targetSelector": {
1175
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.1.0#/$defs/Target_Selector",
1295
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.3.0#/$defs/Target_Selector",
1176
1296
  "description": "Label selector to match targets belonging to this component during migration. Targets with matching labels are automatically included."
1177
1297
  }
1178
1298
  },
@@ -1492,7 +1612,7 @@
1492
1612
  "const": "cloudAccount"
1493
1613
  },
1494
1614
  "provider": {
1495
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Cloud_Provider",
1615
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Cloud_Provider",
1496
1616
  "description": "Cloud provider."
1497
1617
  },
1498
1618
  "accountId": {
@@ -1531,7 +1651,7 @@
1531
1651
  "const": "cloudResource"
1532
1652
  },
1533
1653
  "provider": {
1534
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Cloud_Provider",
1654
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Cloud_Provider",
1535
1655
  "description": "Cloud provider."
1536
1656
  },
1537
1657
  "resourceType": {
@@ -1711,9 +1831,9 @@
1711
1831
  }
1712
1832
  }
1713
1833
  },
1714
- "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.1.0": {
1834
+ "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.3.0": {
1715
1835
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1716
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.1.0",
1836
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.3.0",
1717
1837
  "title": "HDF Data Flow Primitives",
1718
1838
  "description": "Types for describing data flows between components within a system and across system boundaries. Data flows model network connections, API calls, database queries, and other inter-component communication.",
1719
1839
  "$defs": {
@@ -1806,6 +1926,7 @@
1806
1926
  },
1807
1927
  "direction": {
1808
1928
  "type": "string",
1929
+ "title": "Direction",
1809
1930
  "enum": [
1810
1931
  "unidirectional",
1811
1932
  "bidirectional"
@@ -1869,9 +1990,9 @@
1869
1990
  }
1870
1991
  }
1871
1992
  },
1872
- "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0": {
1993
+ "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0": {
1873
1994
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1874
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.1.0",
1995
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0",
1875
1996
  "title": "HDF Extension Primitives",
1876
1997
  "description": "Extension types for waivers, attestations, generators, and integrity.",
1877
1998
  "$defs": {
@@ -1899,15 +2020,15 @@
1899
2020
  ],
1900
2021
  "properties": {
1901
2022
  "type": {
1902
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0#/$defs/Override_Type",
2023
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Override_Type",
1903
2024
  "description": "The type of override applied to this requirement."
1904
2025
  },
1905
2026
  "status": {
1906
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0#/$defs/Result_Status",
2027
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
1907
2028
  "description": "The new status this override sets for the requirement. Optional when only impact is being overridden."
1908
2029
  },
1909
2030
  "impact": {
1910
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0#/$defs/Impact_Override",
2031
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Impact_Override",
1911
2032
  "description": "Override to the requirement's impact score. At least one of status or impact must be set."
1912
2033
  },
1913
2034
  "reason": {
@@ -1915,7 +2036,7 @@
1915
2036
  "description": "Explanation for why this override was applied."
1916
2037
  },
1917
2038
  "appliedBy": {
1918
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
2039
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
1919
2040
  "description": "Identity of who applied this override. For simple cases, use type 'simple' with just an identifier."
1920
2041
  },
1921
2042
  "appliedAt": {
@@ -1929,19 +2050,28 @@
1929
2050
  "description": "Timestamp when this override expires and must be reviewed/renewed. REQUIRED - no permanent overrides allowed. ISO 8601 format."
1930
2051
  },
1931
2052
  "signature": {
1932
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Signature",
2053
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
1933
2054
  "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."
1934
2055
  },
1935
2056
  "evidence": {
1936
2057
  "type": "array",
1937
2058
  "items": {
1938
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Evidence"
2059
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
1939
2060
  },
1940
2061
  "description": "Supporting evidence for this override, such as screenshots demonstrating manual verification for attestations."
1941
2062
  },
1942
2063
  "previousChecksum": {
1943
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Checksum",
2064
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
1944
2065
  "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."
2066
+ },
2067
+ "cvss": {
2068
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
2069
+ "$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.",
2070
+ "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."
2071
+ },
2072
+ "justification": {
2073
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Justification",
2074
+ "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."
1945
2075
  }
1946
2076
  },
1947
2077
  "examples": [
@@ -2033,6 +2163,7 @@
2033
2163
  "properties": {
2034
2164
  "type": {
2035
2165
  "type": "string",
2166
+ "title": "POAM Type",
2036
2167
  "enum": [
2037
2168
  "remediation",
2038
2169
  "mitigation",
@@ -2046,7 +2177,7 @@
2046
2177
  "description": "Detailed explanation of the plan, including what actions will be taken."
2047
2178
  },
2048
2179
  "appliedBy": {
2049
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
2180
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
2050
2181
  "description": "Identity of who created this POA&M. For simple cases, use type 'simple' with just an identifier."
2051
2182
  },
2052
2183
  "appliedAt": {
@@ -2062,23 +2193,23 @@
2062
2193
  "milestones": {
2063
2194
  "type": "array",
2064
2195
  "items": {
2065
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Milestone"
2196
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
2066
2197
  },
2067
2198
  "description": "Optional array of milestones tracking progress toward completion."
2068
2199
  },
2069
2200
  "signature": {
2070
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Signature",
2201
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
2071
2202
  "description": "Optional digital signature for enhanced trust and non-repudiation."
2072
2203
  },
2073
2204
  "evidence": {
2074
2205
  "type": "array",
2075
2206
  "items": {
2076
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Evidence"
2207
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
2077
2208
  },
2078
2209
  "description": "Supporting evidence for this POA&M, such as documentation of compensating controls or mitigation implementation."
2079
2210
  },
2080
2211
  "previousChecksum": {
2081
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Checksum",
2212
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
2082
2213
  "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."
2083
2214
  }
2084
2215
  },
@@ -2229,7 +2360,7 @@
2229
2360
  },
2230
2361
  "properties": {
2231
2362
  "algorithm": {
2232
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Hash_Algorithm",
2363
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Hash_Algorithm",
2233
2364
  "description": "The hash algorithm used for the checksum."
2234
2365
  },
2235
2366
  "checksum": {
@@ -2262,9 +2393,9 @@
2262
2393
  }
2263
2394
  }
2264
2395
  },
2265
- "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0": {
2396
+ "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0": {
2266
2397
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2267
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.1.0",
2398
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0",
2268
2399
  "title": "HDF Amendment Primitives",
2269
2400
  "description": "Types for waivers, attestations, and POA&Ms that modify requirement compliance status.",
2270
2401
  "$defs": {
@@ -2282,6 +2413,24 @@
2282
2413
  "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.",
2283
2414
  "title": "Override Type"
2284
2415
  },
2416
+ "Justification": {
2417
+ "type": "string",
2418
+ "enum": [
2419
+ "component_not_present",
2420
+ "vulnerable_code_not_present",
2421
+ "vulnerable_code_not_in_execute_path",
2422
+ "vulnerable_code_cannot_be_controlled_by_adversary",
2423
+ "inline_mitigations_already_exist",
2424
+ "requires_configuration",
2425
+ "requires_dependency",
2426
+ "requires_environment",
2427
+ "protected_by_compiler",
2428
+ "protected_at_runtime",
2429
+ "protected_at_perimeter"
2430
+ ],
2431
+ "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.",
2432
+ "title": "Justification"
2433
+ },
2285
2434
  "Impact_Override": {
2286
2435
  "type": "object",
2287
2436
  "required": [
@@ -2301,6 +2450,7 @@
2301
2450
  },
2302
2451
  "Standalone_Override": {
2303
2452
  "type": "object",
2453
+ "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).",
2304
2454
  "unevaluatedProperties": false,
2305
2455
  "required": [
2306
2456
  "type",
@@ -2310,18 +2460,48 @@
2310
2460
  "appliedAt",
2311
2461
  "expiresAt"
2312
2462
  ],
2313
- "anyOf": [
2314
- {
2315
- "required": [
2316
- "status"
2317
- ]
2463
+ "if": {
2464
+ "properties": {
2465
+ "type": {
2466
+ "enum": [
2467
+ "operationalRequirement"
2468
+ ]
2469
+ }
2318
2470
  },
2319
- {
2320
- "required": [
2321
- "impact"
2471
+ "required": [
2472
+ "type"
2473
+ ]
2474
+ },
2475
+ "then": {
2476
+ "not": {
2477
+ "anyOf": [
2478
+ {
2479
+ "required": [
2480
+ "status"
2481
+ ]
2482
+ },
2483
+ {
2484
+ "required": [
2485
+ "impact"
2486
+ ]
2487
+ }
2322
2488
  ]
2323
2489
  }
2324
- ],
2490
+ },
2491
+ "else": {
2492
+ "anyOf": [
2493
+ {
2494
+ "required": [
2495
+ "status"
2496
+ ]
2497
+ },
2498
+ {
2499
+ "required": [
2500
+ "impact"
2501
+ ]
2502
+ }
2503
+ ]
2504
+ },
2325
2505
  "properties": {
2326
2506
  "type": {
2327
2507
  "$ref": "#/$defs/Override_Type",
@@ -2336,7 +2516,7 @@
2336
2516
  "description": "Name of the baseline containing the requirement. Required when the system has multiple baselines with potentially overlapping requirement IDs."
2337
2517
  },
2338
2518
  "status": {
2339
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0#/$defs/Result_Status",
2519
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
2340
2520
  "description": "The new status this amendment sets. Optional when only impact is being overridden."
2341
2521
  },
2342
2522
  "impact": {
@@ -2348,7 +2528,7 @@
2348
2528
  "description": "Justification for this amendment."
2349
2529
  },
2350
2530
  "appliedBy": {
2351
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Identity",
2531
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
2352
2532
  "description": "Identity of who applied this amendment."
2353
2533
  },
2354
2534
  "appliedAt": {
@@ -2364,22 +2544,31 @@
2364
2544
  "evidence": {
2365
2545
  "type": "array",
2366
2546
  "items": {
2367
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Evidence"
2547
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
2368
2548
  },
2369
2549
  "description": "Supporting evidence (screenshots, logs, URLs, documents)."
2370
2550
  },
2371
2551
  "signature": {
2372
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Signature",
2552
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
2373
2553
  "description": "Digital signature for non-repudiation."
2374
2554
  },
2375
2555
  "previousChecksum": {
2376
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Checksum",
2556
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
2377
2557
  "description": "Checksum of the prior amendment in the chain. Creates a tamper-evident linked list. Null for the first amendment."
2378
2558
  },
2559
+ "cvss": {
2560
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
2561
+ "$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.",
2562
+ "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."
2563
+ },
2564
+ "justification": {
2565
+ "$ref": "#/$defs/Justification",
2566
+ "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."
2567
+ },
2379
2568
  "milestones": {
2380
2569
  "type": "array",
2381
2570
  "items": {
2382
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.1.0#/$defs/Milestone"
2571
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
2383
2572
  },
2384
2573
  "description": "Remediation milestones (primarily for POA&M type amendments)."
2385
2574
  },
@@ -2392,6 +2581,13 @@
2392
2581
  "type": "string",
2393
2582
  "format": "uuid",
2394
2583
  "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."
2584
+ },
2585
+ "affectedPackages": {
2586
+ "type": "array",
2587
+ "items": {
2588
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0#/$defs/Affected_Package"
2589
+ },
2590
+ "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)."
2395
2591
  }
2396
2592
  },
2397
2593
  "examples": [
@@ -2493,16 +2689,38 @@
2493
2689
  },
2494
2690
  "appliedAt": "2026-03-26T10:00:00Z",
2495
2691
  "expiresAt": "2026-09-26T00:00:00Z"
2692
+ },
2693
+ {
2694
+ "$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.",
2695
+ "type": "falsePositive",
2696
+ "requirementId": "CVE-2026-12345",
2697
+ "status": "notApplicable",
2698
+ "reason": "Vulnerable code path is not present in our build — dependency compiled with the affected module disabled",
2699
+ "justification": "vulnerable_code_not_present",
2700
+ "appliedBy": {
2701
+ "type": "email",
2702
+ "identifier": "secops@org.gov"
2703
+ },
2704
+ "appliedAt": "2026-05-01T10:00:00Z",
2705
+ "expiresAt": "2027-05-01T00:00:00Z",
2706
+ "affectedPackages": [
2707
+ {
2708
+ "purl": "pkg:npm/lodash@4.17.20"
2709
+ },
2710
+ {
2711
+ "purl": "pkg:rpm/openssl@1.1.1k-2.el8",
2712
+ "fixedInVersion": "1.1.1k-3.el8"
2713
+ }
2714
+ ]
2496
2715
  }
2497
2716
  ],
2498
- "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.",
2499
2717
  "title": "Standalone Override"
2500
2718
  }
2501
2719
  }
2502
2720
  },
2503
- "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0": {
2721
+ "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0": {
2504
2722
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2505
- "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.1.0",
2723
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0",
2506
2724
  "title": "HDF Result Primitives",
2507
2725
  "description": "Types for representing assessment results and statuses.",
2508
2726
  "$defs": {
@@ -2632,6 +2850,325 @@
2632
2850
  "title": "Requirement Description"
2633
2851
  }
2634
2852
  }
2853
+ },
2854
+ "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0": {
2855
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2856
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0",
2857
+ "title": "HDF CVSS Primitives",
2858
+ "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).",
2859
+ "$defs": {
2860
+ "Cvss_Severity": {
2861
+ "type": "string",
2862
+ "enum": [
2863
+ "none",
2864
+ "low",
2865
+ "medium",
2866
+ "high",
2867
+ "critical"
2868
+ ],
2869
+ "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').",
2870
+ "title": "CVSS Severity"
2871
+ },
2872
+ "Cvss": {
2873
+ "type": "object",
2874
+ "unevaluatedProperties": false,
2875
+ "required": [
2876
+ "version"
2877
+ ],
2878
+ "anyOf": [
2879
+ {
2880
+ "required": [
2881
+ "baseScore"
2882
+ ]
2883
+ },
2884
+ {
2885
+ "required": [
2886
+ "baseVector"
2887
+ ]
2888
+ },
2889
+ {
2890
+ "required": [
2891
+ "threatVector"
2892
+ ]
2893
+ },
2894
+ {
2895
+ "required": [
2896
+ "threatScore"
2897
+ ]
2898
+ },
2899
+ {
2900
+ "required": [
2901
+ "environmentalVector"
2902
+ ]
2903
+ },
2904
+ {
2905
+ "required": [
2906
+ "environmentalScore"
2907
+ ]
2908
+ },
2909
+ {
2910
+ "required": [
2911
+ "supplementalVector"
2912
+ ]
2913
+ },
2914
+ {
2915
+ "required": [
2916
+ "computedScore"
2917
+ ]
2918
+ }
2919
+ ],
2920
+ "$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.",
2921
+ "properties": {
2922
+ "version": {
2923
+ "type": "string",
2924
+ "enum": [
2925
+ "2.0",
2926
+ "3.0",
2927
+ "3.1",
2928
+ "4.0"
2929
+ ],
2930
+ "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."
2931
+ },
2932
+ "source": {
2933
+ "type": "string",
2934
+ "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.",
2935
+ "examples": [
2936
+ "CVE-2024-12345",
2937
+ "GHSA-9hjg-9r4m-mvj7",
2938
+ "RHSA-2024:0123"
2939
+ ]
2940
+ },
2941
+ "baseVector": {
2942
+ "type": "string",
2943
+ "$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.",
2944
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2945
+ "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."
2946
+ },
2947
+ "baseScore": {
2948
+ "type": "number",
2949
+ "minimum": 0,
2950
+ "maximum": 10,
2951
+ "description": "The Base score (0.0–10.0) computed from the base vector. Reflects the intrinsic, vendor-published severity before consumer enrichment."
2952
+ },
2953
+ "baseSeverity": {
2954
+ "$ref": "#/$defs/Cvss_Severity",
2955
+ "description": "Qualitative severity band corresponding to baseScore. CVSS 2.0 does not natively use 'none' or 'critical' bands; map accordingly when populating."
2956
+ },
2957
+ "threatVector": {
2958
+ "type": "string",
2959
+ "$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.",
2960
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2961
+ "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."
2962
+ },
2963
+ "threatScore": {
2964
+ "type": "number",
2965
+ "minimum": 0,
2966
+ "maximum": 10,
2967
+ "description": "Optional score (0.0–10.0) recomputed after applying Threat metrics. Always less than or equal to baseScore in practice."
2968
+ },
2969
+ "environmentalVector": {
2970
+ "type": "string",
2971
+ "$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.",
2972
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2973
+ "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)."
2974
+ },
2975
+ "environmentalScore": {
2976
+ "type": "number",
2977
+ "minimum": 0,
2978
+ "maximum": 10,
2979
+ "description": "Optional score (0.0–10.0) recomputed after applying Environmental metrics."
2980
+ },
2981
+ "supplementalVector": {
2982
+ "type": "string",
2983
+ "$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.",
2984
+ "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
2985
+ "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."
2986
+ },
2987
+ "computedScore": {
2988
+ "type": "number",
2989
+ "minimum": 0,
2990
+ "maximum": 10,
2991
+ "description": "Optional final score after combining Base + Threat + Environmental metrics. This is the score consumers should treat as authoritative for risk decisions when present."
2992
+ },
2993
+ "computedSeverity": {
2994
+ "$ref": "#/$defs/Cvss_Severity",
2995
+ "description": "Qualitative severity band corresponding to computedScore. Same band convention as baseSeverity."
2996
+ }
2997
+ },
2998
+ "examples": [
2999
+ {
3000
+ "$comment": "Base-only: vendor-supplied CVSS 3.1 data exactly as a scanner (e.g., Nessus, Grype) would emit it. No consumer enrichment yet.",
3001
+ "version": "3.1",
3002
+ "source": "CVE-2024-12345",
3003
+ "baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
3004
+ "baseScore": 9.8,
3005
+ "baseSeverity": "critical"
3006
+ },
3007
+ {
3008
+ "$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.",
3009
+ "version": "3.1",
3010
+ "source": "CVE-2023-44487",
3011
+ "baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H",
3012
+ "baseScore": 7.5,
3013
+ "baseSeverity": "high",
3014
+ "threatVector": "E:U/RL:O/RC:C",
3015
+ "threatScore": 5.5
3016
+ },
3017
+ {
3018
+ "$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.",
3019
+ "version": "3.1",
3020
+ "source": "CVE-2024-3094",
3021
+ "baseVector": "CVSS:3.1/AV:L/AC:H/PR:H/UI:N/S:U/C:H/I:H/A:H",
3022
+ "baseScore": 6.7,
3023
+ "baseSeverity": "medium",
3024
+ "environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
3025
+ "environmentalScore": 9,
3026
+ "computedScore": 9,
3027
+ "computedSeverity": "critical"
3028
+ },
3029
+ {
3030
+ "$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.",
3031
+ "version": "4.0",
3032
+ "source": "CVE-2024-21762",
3033
+ "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",
3034
+ "baseScore": 9.8,
3035
+ "baseSeverity": "critical",
3036
+ "threatVector": "E:A",
3037
+ "threatScore": 9.3,
3038
+ "environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
3039
+ "environmentalScore": 9.5,
3040
+ "supplementalVector": "S:P/AU:N/V:C/RE:M",
3041
+ "computedScore": 4.2,
3042
+ "computedSeverity": "medium"
3043
+ },
3044
+ {
3045
+ "$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.",
3046
+ "version": "2.0",
3047
+ "source": "CVE-2014-0160",
3048
+ "baseVector": "AV:N/AC:L/Au:N/C:P/I:N/A:N",
3049
+ "baseScore": 5,
3050
+ "baseSeverity": "medium"
3051
+ }
3052
+ ],
3053
+ "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.",
3054
+ "title": "CVSS"
3055
+ }
3056
+ }
3057
+ },
3058
+ "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0": {
3059
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3060
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0",
3061
+ "title": "HDF Affected Package Primitives",
3062
+ "description": "Types for representing the software package(s) affected by a vulnerability finding.",
3063
+ "$defs": {
3064
+ "Affected_Package": {
3065
+ "type": "object",
3066
+ "unevaluatedProperties": false,
3067
+ "anyOf": [
3068
+ {
3069
+ "required": [
3070
+ "name",
3071
+ "version",
3072
+ "ecosystem"
3073
+ ]
3074
+ },
3075
+ {
3076
+ "required": [
3077
+ "purl"
3078
+ ]
3079
+ },
3080
+ {
3081
+ "required": [
3082
+ "cpe"
3083
+ ]
3084
+ }
3085
+ ],
3086
+ "properties": {
3087
+ "name": {
3088
+ "type": "string",
3089
+ "description": "The package name as published in its ecosystem. Examples: 'openssl' (rpm), 'lodash' (npm), 'org.apache.logging.log4j:log4j-core' (maven, group:artifact)."
3090
+ },
3091
+ "version": {
3092
+ "type": "string",
3093
+ "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)."
3094
+ },
3095
+ "ecosystem": {
3096
+ "type": "string",
3097
+ "enum": [
3098
+ "npm",
3099
+ "pypi",
3100
+ "rpm",
3101
+ "deb",
3102
+ "maven",
3103
+ "gem",
3104
+ "nuget",
3105
+ "go",
3106
+ "cargo",
3107
+ "generic"
3108
+ ],
3109
+ "description": "The packaging ecosystem the package belongs to. Use 'generic' for hardware, firmware, or anything outside the listed language/OS package managers."
3110
+ },
3111
+ "cpe": {
3112
+ "type": "string",
3113
+ "pattern": "^cpe:2\\.3:[aho]:.*",
3114
+ "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:*:*:*:*:*:*:*'."
3115
+ },
3116
+ "purl": {
3117
+ "type": "string",
3118
+ "pattern": "^pkg:[A-Za-z0-9.+-]+/.+",
3119
+ "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'."
3120
+ },
3121
+ "fixedInVersion": {
3122
+ "type": "string",
3123
+ "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'."
3124
+ }
3125
+ },
3126
+ "examples": [
3127
+ {
3128
+ "$comment": "RPM ecosystem with full CPE + PURL — typical Grype/Trivy output for a RHEL host scan.",
3129
+ "name": "openssl",
3130
+ "version": "1.1.1k-7.el8_4",
3131
+ "ecosystem": "rpm",
3132
+ "cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*",
3133
+ "purl": "pkg:rpm/redhat/openssl@1.1.1k-7.el8_4?arch=x86_64",
3134
+ "fixedInVersion": "1.1.1l"
3135
+ },
3136
+ {
3137
+ "$comment": "NPM ecosystem with PURL only — the JavaScript world rarely emits CPEs; PURL is the canonical identifier.",
3138
+ "name": "lodash",
3139
+ "version": "4.17.20",
3140
+ "ecosystem": "npm",
3141
+ "purl": "pkg:npm/lodash@4.17.20",
3142
+ "fixedInVersion": "4.17.21"
3143
+ },
3144
+ {
3145
+ "$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.",
3146
+ "name": "requests",
3147
+ "version": "2.28.1",
3148
+ "ecosystem": "pypi"
3149
+ },
3150
+ {
3151
+ "$comment": "Maven ecosystem with full identifiers + fixedInVersion — log4j Log4Shell-style finding showing the patch path from vulnerable to fixed.",
3152
+ "name": "org.apache.logging.log4j:log4j-core",
3153
+ "version": "2.14.1",
3154
+ "ecosystem": "maven",
3155
+ "cpe": "cpe:2.3:a:apache:log4j:2.14.1:*:*:*:*:*:*:*",
3156
+ "purl": "pkg:maven/org.apache.logging.log4j/log4j-core@2.14.1",
3157
+ "fixedInVersion": "2.17.1"
3158
+ },
3159
+ {
3160
+ "$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.",
3161
+ "purl": "pkg:npm/lodash@4.17.20"
3162
+ },
3163
+ {
3164
+ "$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.",
3165
+ "cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*"
3166
+ }
3167
+ ],
3168
+ "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.",
3169
+ "title": "Affected Package"
3170
+ }
3171
+ }
2635
3172
  }
2636
3173
  }
2637
3174
  }