@mitre/hdf-schema 3.2.0 → 3.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -16
- package/dist/go/hdf.go +398 -134
- package/dist/helpers.d.ts +1 -1
- package/dist/index.d.ts +27 -52
- package/dist/index.js +30 -48
- package/dist/schemas/hdf-amendments.schema.json +466 -45
- package/dist/schemas/hdf-baseline.schema.json +471 -50
- package/dist/schemas/hdf-comparison.schema.json +721 -103
- package/dist/schemas/hdf-evidence-package.schema.json +465 -44
- package/dist/schemas/hdf-plan.schema.json +472 -50
- package/dist/schemas/hdf-results.schema.json +678 -80
- package/dist/schemas/hdf-system.schema.json +497 -59
- package/dist/ts/hdf.d.ts +3562 -0
- package/dist/ts/hdf.js +564 -0
- package/dist/ts/hdf.ts +3623 -0
- package/package.json +18 -17
- package/dist/ts/hdf-amendments.d.ts +0 -474
- package/dist/ts/hdf-amendments.js +0 -88
- package/dist/ts/hdf-amendments.ts +0 -486
- package/dist/ts/hdf-baseline.d.ts +0 -549
- package/dist/ts/hdf-baseline.js +0 -110
- package/dist/ts/hdf-baseline.ts +0 -563
- package/dist/ts/hdf-comparison.d.ts +0 -1185
- package/dist/ts/hdf-comparison.js +0 -216
- package/dist/ts/hdf-comparison.ts +0 -1210
- package/dist/ts/hdf-evidence-package.d.ts +0 -348
- package/dist/ts/hdf-evidence-package.js +0 -39
- package/dist/ts/hdf-evidence-package.ts +0 -356
- package/dist/ts/hdf-plan.d.ts +0 -204
- package/dist/ts/hdf-plan.js +0 -23
- package/dist/ts/hdf-plan.ts +0 -205
- package/dist/ts/hdf-results.d.ts +0 -1588
- package/dist/ts/hdf-results.js +0 -246
- package/dist/ts/hdf-results.ts +0 -1616
- package/dist/ts/hdf-system.d.ts +0 -609
- package/dist/ts/hdf-system.js +0 -102
- 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-amendments/v3.
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-amendments/v3.3.0",
|
|
4
4
|
"title": "HDF Amendments",
|
|
5
5
|
"description": "Waivers, attestations, and POA&Ms that modify requirement compliance status or impact. Amendments are standalone documents that can be applied to results via merge operations.",
|
|
6
6
|
"type": "object",
|
|
@@ -29,18 +29,18 @@
|
|
|
29
29
|
"description": "URI to the hdf-system document these amendments apply to."
|
|
30
30
|
},
|
|
31
31
|
"appliedBy": {
|
|
32
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
32
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
|
|
33
33
|
"description": "Default identity of who created this amendments document. Individual overrides may specify their own appliedBy."
|
|
34
34
|
},
|
|
35
35
|
"approvedBy": {
|
|
36
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
36
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
|
|
37
37
|
"description": "Identity of the authorizing official who approved these amendments."
|
|
38
38
|
},
|
|
39
39
|
"overrides": {
|
|
40
40
|
"type": "array",
|
|
41
41
|
"minItems": 1,
|
|
42
42
|
"items": {
|
|
43
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
43
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Standalone_Override"
|
|
44
44
|
},
|
|
45
45
|
"description": "The set of amendments (waivers, attestations, POA&Ms, and other overrides)."
|
|
46
46
|
},
|
|
@@ -52,11 +52,11 @@
|
|
|
52
52
|
"description": "Optional key-value labels for grouping and querying amendments."
|
|
53
53
|
},
|
|
54
54
|
"integrity": {
|
|
55
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
55
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Integrity",
|
|
56
56
|
"description": "Cryptographic integrity information for verifying this amendments document has not been tampered with."
|
|
57
57
|
},
|
|
58
58
|
"signature": {
|
|
59
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
59
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
|
|
60
60
|
"description": "Document-level digital signature covering all amendments."
|
|
61
61
|
},
|
|
62
62
|
"version": {
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
"description": "Version of this amendments document."
|
|
65
65
|
},
|
|
66
66
|
"generator": {
|
|
67
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
67
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Generator",
|
|
68
68
|
"description": "Information about the tool that generated this document."
|
|
69
69
|
}
|
|
70
70
|
},
|
|
@@ -101,9 +101,9 @@
|
|
|
101
101
|
}
|
|
102
102
|
],
|
|
103
103
|
"$defs": {
|
|
104
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
104
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0": {
|
|
105
105
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
106
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
106
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0",
|
|
107
107
|
"title": "HDF Common Primitives",
|
|
108
108
|
"description": "Shared building blocks used by hdf-results and hdf-baseline schemas.",
|
|
109
109
|
"$defs": {
|
|
@@ -370,6 +370,7 @@
|
|
|
370
370
|
},
|
|
371
371
|
"type": {
|
|
372
372
|
"type": "string",
|
|
373
|
+
"title": "Identity Type",
|
|
373
374
|
"enum": [
|
|
374
375
|
"email",
|
|
375
376
|
"username",
|
|
@@ -413,6 +414,7 @@
|
|
|
413
414
|
"properties": {
|
|
414
415
|
"type": {
|
|
415
416
|
"type": "string",
|
|
417
|
+
"title": "Evidence Type",
|
|
416
418
|
"enum": [
|
|
417
419
|
"screenshot",
|
|
418
420
|
"code",
|
|
@@ -589,6 +591,7 @@
|
|
|
589
591
|
},
|
|
590
592
|
"status": {
|
|
591
593
|
"type": "string",
|
|
594
|
+
"title": "Milestone Status",
|
|
592
595
|
"enum": [
|
|
593
596
|
"pending",
|
|
594
597
|
"inProgress",
|
|
@@ -856,6 +859,7 @@
|
|
|
856
859
|
},
|
|
857
860
|
"controlType": {
|
|
858
861
|
"type": "string",
|
|
862
|
+
"title": "Control Type",
|
|
859
863
|
"enum": [
|
|
860
864
|
"policy",
|
|
861
865
|
"procedure",
|
|
@@ -871,6 +875,7 @@
|
|
|
871
875
|
},
|
|
872
876
|
"applicability": {
|
|
873
877
|
"type": "string",
|
|
878
|
+
"title": "Applicability",
|
|
874
879
|
"enum": [
|
|
875
880
|
"required",
|
|
876
881
|
"optional",
|
|
@@ -881,7 +886,7 @@
|
|
|
881
886
|
},
|
|
882
887
|
"examples": [
|
|
883
888
|
{
|
|
884
|
-
"$comment": "v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape under v3.
|
|
889
|
+
"$comment": "v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape under v3.3.0 (backward compatibility).",
|
|
885
890
|
"id": "SV-238196",
|
|
886
891
|
"title": "The Ubuntu operating system must enforce password complexity",
|
|
887
892
|
"impact": 0.5,
|
|
@@ -1018,9 +1023,9 @@
|
|
|
1018
1023
|
}
|
|
1019
1024
|
}
|
|
1020
1025
|
},
|
|
1021
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
1026
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0": {
|
|
1022
1027
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1023
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
1028
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0",
|
|
1024
1029
|
"title": "HDF Amendment Primitives",
|
|
1025
1030
|
"description": "Types for waivers, attestations, and POA&Ms that modify requirement compliance status.",
|
|
1026
1031
|
"$defs": {
|
|
@@ -1038,6 +1043,24 @@
|
|
|
1038
1043
|
"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.",
|
|
1039
1044
|
"title": "Override Type"
|
|
1040
1045
|
},
|
|
1046
|
+
"Justification": {
|
|
1047
|
+
"type": "string",
|
|
1048
|
+
"enum": [
|
|
1049
|
+
"component_not_present",
|
|
1050
|
+
"vulnerable_code_not_present",
|
|
1051
|
+
"vulnerable_code_not_in_execute_path",
|
|
1052
|
+
"vulnerable_code_cannot_be_controlled_by_adversary",
|
|
1053
|
+
"inline_mitigations_already_exist",
|
|
1054
|
+
"requires_configuration",
|
|
1055
|
+
"requires_dependency",
|
|
1056
|
+
"requires_environment",
|
|
1057
|
+
"protected_by_compiler",
|
|
1058
|
+
"protected_at_runtime",
|
|
1059
|
+
"protected_at_perimeter"
|
|
1060
|
+
],
|
|
1061
|
+
"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.",
|
|
1062
|
+
"title": "Justification"
|
|
1063
|
+
},
|
|
1041
1064
|
"Impact_Override": {
|
|
1042
1065
|
"type": "object",
|
|
1043
1066
|
"required": [
|
|
@@ -1057,6 +1080,7 @@
|
|
|
1057
1080
|
},
|
|
1058
1081
|
"Standalone_Override": {
|
|
1059
1082
|
"type": "object",
|
|
1083
|
+
"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).",
|
|
1060
1084
|
"unevaluatedProperties": false,
|
|
1061
1085
|
"required": [
|
|
1062
1086
|
"type",
|
|
@@ -1066,18 +1090,48 @@
|
|
|
1066
1090
|
"appliedAt",
|
|
1067
1091
|
"expiresAt"
|
|
1068
1092
|
],
|
|
1069
|
-
"
|
|
1070
|
-
{
|
|
1071
|
-
"
|
|
1072
|
-
"
|
|
1073
|
-
|
|
1093
|
+
"if": {
|
|
1094
|
+
"properties": {
|
|
1095
|
+
"type": {
|
|
1096
|
+
"enum": [
|
|
1097
|
+
"operationalRequirement"
|
|
1098
|
+
]
|
|
1099
|
+
}
|
|
1074
1100
|
},
|
|
1075
|
-
|
|
1076
|
-
"
|
|
1077
|
-
|
|
1101
|
+
"required": [
|
|
1102
|
+
"type"
|
|
1103
|
+
]
|
|
1104
|
+
},
|
|
1105
|
+
"then": {
|
|
1106
|
+
"not": {
|
|
1107
|
+
"anyOf": [
|
|
1108
|
+
{
|
|
1109
|
+
"required": [
|
|
1110
|
+
"status"
|
|
1111
|
+
]
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"required": [
|
|
1115
|
+
"impact"
|
|
1116
|
+
]
|
|
1117
|
+
}
|
|
1078
1118
|
]
|
|
1079
1119
|
}
|
|
1080
|
-
|
|
1120
|
+
},
|
|
1121
|
+
"else": {
|
|
1122
|
+
"anyOf": [
|
|
1123
|
+
{
|
|
1124
|
+
"required": [
|
|
1125
|
+
"status"
|
|
1126
|
+
]
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
"required": [
|
|
1130
|
+
"impact"
|
|
1131
|
+
]
|
|
1132
|
+
}
|
|
1133
|
+
]
|
|
1134
|
+
},
|
|
1081
1135
|
"properties": {
|
|
1082
1136
|
"type": {
|
|
1083
1137
|
"$ref": "#/$defs/Override_Type",
|
|
@@ -1092,7 +1146,7 @@
|
|
|
1092
1146
|
"description": "Name of the baseline containing the requirement. Required when the system has multiple baselines with potentially overlapping requirement IDs."
|
|
1093
1147
|
},
|
|
1094
1148
|
"status": {
|
|
1095
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
1149
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
|
|
1096
1150
|
"description": "The new status this amendment sets. Optional when only impact is being overridden."
|
|
1097
1151
|
},
|
|
1098
1152
|
"impact": {
|
|
@@ -1104,7 +1158,7 @@
|
|
|
1104
1158
|
"description": "Justification for this amendment."
|
|
1105
1159
|
},
|
|
1106
1160
|
"appliedBy": {
|
|
1107
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1161
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
|
|
1108
1162
|
"description": "Identity of who applied this amendment."
|
|
1109
1163
|
},
|
|
1110
1164
|
"appliedAt": {
|
|
@@ -1120,22 +1174,31 @@
|
|
|
1120
1174
|
"evidence": {
|
|
1121
1175
|
"type": "array",
|
|
1122
1176
|
"items": {
|
|
1123
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1177
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
|
|
1124
1178
|
},
|
|
1125
1179
|
"description": "Supporting evidence (screenshots, logs, URLs, documents)."
|
|
1126
1180
|
},
|
|
1127
1181
|
"signature": {
|
|
1128
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1182
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
|
|
1129
1183
|
"description": "Digital signature for non-repudiation."
|
|
1130
1184
|
},
|
|
1131
1185
|
"previousChecksum": {
|
|
1132
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1186
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
|
|
1133
1187
|
"description": "Checksum of the prior amendment in the chain. Creates a tamper-evident linked list. Null for the first amendment."
|
|
1134
1188
|
},
|
|
1189
|
+
"cvss": {
|
|
1190
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
|
|
1191
|
+
"$comment": "When present alongside impact.value on a riskAdjustment override, impact.value should be approximately cvss.computedScore / 10.0. Soft consistency rule — validators may warn but should not error. The cvss block makes Environmental/Threat enrichment auditable.",
|
|
1192
|
+
"description": "Structured CVSS scoring data backing this override. Captures the rubric (which Environmental/Threat metrics the consumer modified, the recomputed score) used to justify a riskAdjustment. For other override types this is optional context."
|
|
1193
|
+
},
|
|
1194
|
+
"justification": {
|
|
1195
|
+
"$ref": "#/$defs/Justification",
|
|
1196
|
+
"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."
|
|
1197
|
+
},
|
|
1135
1198
|
"milestones": {
|
|
1136
1199
|
"type": "array",
|
|
1137
1200
|
"items": {
|
|
1138
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1201
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
|
|
1139
1202
|
},
|
|
1140
1203
|
"description": "Remediation milestones (primarily for POA&M type amendments)."
|
|
1141
1204
|
},
|
|
@@ -1148,6 +1211,13 @@
|
|
|
1148
1211
|
"type": "string",
|
|
1149
1212
|
"format": "uuid",
|
|
1150
1213
|
"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."
|
|
1214
|
+
},
|
|
1215
|
+
"affectedPackages": {
|
|
1216
|
+
"type": "array",
|
|
1217
|
+
"items": {
|
|
1218
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0#/$defs/Affected_Package"
|
|
1219
|
+
},
|
|
1220
|
+
"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)."
|
|
1151
1221
|
}
|
|
1152
1222
|
},
|
|
1153
1223
|
"examples": [
|
|
@@ -1249,16 +1319,38 @@
|
|
|
1249
1319
|
},
|
|
1250
1320
|
"appliedAt": "2026-03-26T10:00:00Z",
|
|
1251
1321
|
"expiresAt": "2026-09-26T00:00:00Z"
|
|
1322
|
+
},
|
|
1323
|
+
{
|
|
1324
|
+
"$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.",
|
|
1325
|
+
"type": "falsePositive",
|
|
1326
|
+
"requirementId": "CVE-2026-12345",
|
|
1327
|
+
"status": "notApplicable",
|
|
1328
|
+
"reason": "Vulnerable code path is not present in our build — dependency compiled with the affected module disabled",
|
|
1329
|
+
"justification": "vulnerable_code_not_present",
|
|
1330
|
+
"appliedBy": {
|
|
1331
|
+
"type": "email",
|
|
1332
|
+
"identifier": "secops@org.gov"
|
|
1333
|
+
},
|
|
1334
|
+
"appliedAt": "2026-05-01T10:00:00Z",
|
|
1335
|
+
"expiresAt": "2027-05-01T00:00:00Z",
|
|
1336
|
+
"affectedPackages": [
|
|
1337
|
+
{
|
|
1338
|
+
"purl": "pkg:npm/lodash@4.17.20"
|
|
1339
|
+
},
|
|
1340
|
+
{
|
|
1341
|
+
"purl": "pkg:rpm/openssl@1.1.1k-2.el8",
|
|
1342
|
+
"fixedInVersion": "1.1.1k-3.el8"
|
|
1343
|
+
}
|
|
1344
|
+
]
|
|
1252
1345
|
}
|
|
1253
1346
|
],
|
|
1254
|
-
"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.",
|
|
1255
1347
|
"title": "Standalone Override"
|
|
1256
1348
|
}
|
|
1257
1349
|
}
|
|
1258
1350
|
},
|
|
1259
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
1351
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0": {
|
|
1260
1352
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1261
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
1353
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0",
|
|
1262
1354
|
"title": "HDF Result Primitives",
|
|
1263
1355
|
"description": "Types for representing assessment results and statuses.",
|
|
1264
1356
|
"$defs": {
|
|
@@ -1389,9 +1481,328 @@
|
|
|
1389
1481
|
}
|
|
1390
1482
|
}
|
|
1391
1483
|
},
|
|
1392
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/
|
|
1484
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0": {
|
|
1393
1485
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1394
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/
|
|
1486
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0",
|
|
1487
|
+
"title": "HDF CVSS Primitives",
|
|
1488
|
+
"description": "Types for representing CVSS (Common Vulnerability Scoring System) data attached to assessment findings. Supports CVSS v2.0, v3.0, v3.1, and v4.0 metric groups (Base, Threat, Environmental, Supplemental).",
|
|
1489
|
+
"$defs": {
|
|
1490
|
+
"Cvss_Severity": {
|
|
1491
|
+
"type": "string",
|
|
1492
|
+
"enum": [
|
|
1493
|
+
"none",
|
|
1494
|
+
"low",
|
|
1495
|
+
"medium",
|
|
1496
|
+
"high",
|
|
1497
|
+
"critical"
|
|
1498
|
+
],
|
|
1499
|
+
"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').",
|
|
1500
|
+
"title": "CVSS Severity"
|
|
1501
|
+
},
|
|
1502
|
+
"Cvss": {
|
|
1503
|
+
"type": "object",
|
|
1504
|
+
"unevaluatedProperties": false,
|
|
1505
|
+
"required": [
|
|
1506
|
+
"version"
|
|
1507
|
+
],
|
|
1508
|
+
"anyOf": [
|
|
1509
|
+
{
|
|
1510
|
+
"required": [
|
|
1511
|
+
"baseScore"
|
|
1512
|
+
]
|
|
1513
|
+
},
|
|
1514
|
+
{
|
|
1515
|
+
"required": [
|
|
1516
|
+
"baseVector"
|
|
1517
|
+
]
|
|
1518
|
+
},
|
|
1519
|
+
{
|
|
1520
|
+
"required": [
|
|
1521
|
+
"threatVector"
|
|
1522
|
+
]
|
|
1523
|
+
},
|
|
1524
|
+
{
|
|
1525
|
+
"required": [
|
|
1526
|
+
"threatScore"
|
|
1527
|
+
]
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
"required": [
|
|
1531
|
+
"environmentalVector"
|
|
1532
|
+
]
|
|
1533
|
+
},
|
|
1534
|
+
{
|
|
1535
|
+
"required": [
|
|
1536
|
+
"environmentalScore"
|
|
1537
|
+
]
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
"required": [
|
|
1541
|
+
"supplementalVector"
|
|
1542
|
+
]
|
|
1543
|
+
},
|
|
1544
|
+
{
|
|
1545
|
+
"required": [
|
|
1546
|
+
"computedScore"
|
|
1547
|
+
]
|
|
1548
|
+
}
|
|
1549
|
+
],
|
|
1550
|
+
"$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.",
|
|
1551
|
+
"properties": {
|
|
1552
|
+
"version": {
|
|
1553
|
+
"type": "string",
|
|
1554
|
+
"enum": [
|
|
1555
|
+
"2.0",
|
|
1556
|
+
"3.0",
|
|
1557
|
+
"3.1",
|
|
1558
|
+
"4.0"
|
|
1559
|
+
],
|
|
1560
|
+
"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."
|
|
1561
|
+
},
|
|
1562
|
+
"source": {
|
|
1563
|
+
"type": "string",
|
|
1564
|
+
"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.",
|
|
1565
|
+
"examples": [
|
|
1566
|
+
"CVE-2024-12345",
|
|
1567
|
+
"GHSA-9hjg-9r4m-mvj7",
|
|
1568
|
+
"RHSA-2024:0123"
|
|
1569
|
+
]
|
|
1570
|
+
},
|
|
1571
|
+
"baseVector": {
|
|
1572
|
+
"type": "string",
|
|
1573
|
+
"$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.",
|
|
1574
|
+
"pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
|
|
1575
|
+
"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."
|
|
1576
|
+
},
|
|
1577
|
+
"baseScore": {
|
|
1578
|
+
"type": "number",
|
|
1579
|
+
"minimum": 0,
|
|
1580
|
+
"maximum": 10,
|
|
1581
|
+
"description": "The Base score (0.0–10.0) computed from the base vector. Reflects the intrinsic, vendor-published severity before consumer enrichment."
|
|
1582
|
+
},
|
|
1583
|
+
"baseSeverity": {
|
|
1584
|
+
"$ref": "#/$defs/Cvss_Severity",
|
|
1585
|
+
"description": "Qualitative severity band corresponding to baseScore. CVSS 2.0 does not natively use 'none' or 'critical' bands; map accordingly when populating."
|
|
1586
|
+
},
|
|
1587
|
+
"threatVector": {
|
|
1588
|
+
"type": "string",
|
|
1589
|
+
"$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.",
|
|
1590
|
+
"pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
|
|
1591
|
+
"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."
|
|
1592
|
+
},
|
|
1593
|
+
"threatScore": {
|
|
1594
|
+
"type": "number",
|
|
1595
|
+
"minimum": 0,
|
|
1596
|
+
"maximum": 10,
|
|
1597
|
+
"description": "Optional score (0.0–10.0) recomputed after applying Threat metrics. Always less than or equal to baseScore in practice."
|
|
1598
|
+
},
|
|
1599
|
+
"environmentalVector": {
|
|
1600
|
+
"type": "string",
|
|
1601
|
+
"$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.",
|
|
1602
|
+
"pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
|
|
1603
|
+
"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)."
|
|
1604
|
+
},
|
|
1605
|
+
"environmentalScore": {
|
|
1606
|
+
"type": "number",
|
|
1607
|
+
"minimum": 0,
|
|
1608
|
+
"maximum": 10,
|
|
1609
|
+
"description": "Optional score (0.0–10.0) recomputed after applying Environmental metrics."
|
|
1610
|
+
},
|
|
1611
|
+
"supplementalVector": {
|
|
1612
|
+
"type": "string",
|
|
1613
|
+
"$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.",
|
|
1614
|
+
"pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
|
|
1615
|
+
"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."
|
|
1616
|
+
},
|
|
1617
|
+
"computedScore": {
|
|
1618
|
+
"type": "number",
|
|
1619
|
+
"minimum": 0,
|
|
1620
|
+
"maximum": 10,
|
|
1621
|
+
"description": "Optional final score after combining Base + Threat + Environmental metrics. This is the score consumers should treat as authoritative for risk decisions when present."
|
|
1622
|
+
},
|
|
1623
|
+
"computedSeverity": {
|
|
1624
|
+
"$ref": "#/$defs/Cvss_Severity",
|
|
1625
|
+
"description": "Qualitative severity band corresponding to computedScore. Same band convention as baseSeverity."
|
|
1626
|
+
}
|
|
1627
|
+
},
|
|
1628
|
+
"examples": [
|
|
1629
|
+
{
|
|
1630
|
+
"$comment": "Base-only: vendor-supplied CVSS 3.1 data exactly as a scanner (e.g., Nessus, Grype) would emit it. No consumer enrichment yet.",
|
|
1631
|
+
"version": "3.1",
|
|
1632
|
+
"source": "CVE-2024-12345",
|
|
1633
|
+
"baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
|
|
1634
|
+
"baseScore": 9.8,
|
|
1635
|
+
"baseSeverity": "critical"
|
|
1636
|
+
},
|
|
1637
|
+
{
|
|
1638
|
+
"$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.",
|
|
1639
|
+
"version": "3.1",
|
|
1640
|
+
"source": "CVE-2023-44487",
|
|
1641
|
+
"baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H",
|
|
1642
|
+
"baseScore": 7.5,
|
|
1643
|
+
"baseSeverity": "high",
|
|
1644
|
+
"threatVector": "E:U/RL:O/RC:C",
|
|
1645
|
+
"threatScore": 5.5
|
|
1646
|
+
},
|
|
1647
|
+
{
|
|
1648
|
+
"$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.",
|
|
1649
|
+
"version": "3.1",
|
|
1650
|
+
"source": "CVE-2024-3094",
|
|
1651
|
+
"baseVector": "CVSS:3.1/AV:L/AC:H/PR:H/UI:N/S:U/C:H/I:H/A:H",
|
|
1652
|
+
"baseScore": 6.7,
|
|
1653
|
+
"baseSeverity": "medium",
|
|
1654
|
+
"environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
|
|
1655
|
+
"environmentalScore": 9,
|
|
1656
|
+
"computedScore": 9,
|
|
1657
|
+
"computedSeverity": "critical"
|
|
1658
|
+
},
|
|
1659
|
+
{
|
|
1660
|
+
"$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.",
|
|
1661
|
+
"version": "4.0",
|
|
1662
|
+
"source": "CVE-2024-21762",
|
|
1663
|
+
"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",
|
|
1664
|
+
"baseScore": 9.8,
|
|
1665
|
+
"baseSeverity": "critical",
|
|
1666
|
+
"threatVector": "E:A",
|
|
1667
|
+
"threatScore": 9.3,
|
|
1668
|
+
"environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
|
|
1669
|
+
"environmentalScore": 9.5,
|
|
1670
|
+
"supplementalVector": "S:P/AU:N/V:C/RE:M",
|
|
1671
|
+
"computedScore": 4.2,
|
|
1672
|
+
"computedSeverity": "medium"
|
|
1673
|
+
},
|
|
1674
|
+
{
|
|
1675
|
+
"$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.",
|
|
1676
|
+
"version": "2.0",
|
|
1677
|
+
"source": "CVE-2014-0160",
|
|
1678
|
+
"baseVector": "AV:N/AC:L/Au:N/C:P/I:N/A:N",
|
|
1679
|
+
"baseScore": 5,
|
|
1680
|
+
"baseSeverity": "medium"
|
|
1681
|
+
}
|
|
1682
|
+
],
|
|
1683
|
+
"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.",
|
|
1684
|
+
"title": "CVSS"
|
|
1685
|
+
}
|
|
1686
|
+
}
|
|
1687
|
+
},
|
|
1688
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0": {
|
|
1689
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1690
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0",
|
|
1691
|
+
"title": "HDF Affected Package Primitives",
|
|
1692
|
+
"description": "Types for representing the software package(s) affected by a vulnerability finding.",
|
|
1693
|
+
"$defs": {
|
|
1694
|
+
"Affected_Package": {
|
|
1695
|
+
"type": "object",
|
|
1696
|
+
"unevaluatedProperties": false,
|
|
1697
|
+
"anyOf": [
|
|
1698
|
+
{
|
|
1699
|
+
"required": [
|
|
1700
|
+
"name",
|
|
1701
|
+
"version",
|
|
1702
|
+
"ecosystem"
|
|
1703
|
+
]
|
|
1704
|
+
},
|
|
1705
|
+
{
|
|
1706
|
+
"required": [
|
|
1707
|
+
"purl"
|
|
1708
|
+
]
|
|
1709
|
+
},
|
|
1710
|
+
{
|
|
1711
|
+
"required": [
|
|
1712
|
+
"cpe"
|
|
1713
|
+
]
|
|
1714
|
+
}
|
|
1715
|
+
],
|
|
1716
|
+
"properties": {
|
|
1717
|
+
"name": {
|
|
1718
|
+
"type": "string",
|
|
1719
|
+
"description": "The package name as published in its ecosystem. Examples: 'openssl' (rpm), 'lodash' (npm), 'org.apache.logging.log4j:log4j-core' (maven, group:artifact)."
|
|
1720
|
+
},
|
|
1721
|
+
"version": {
|
|
1722
|
+
"type": "string",
|
|
1723
|
+
"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)."
|
|
1724
|
+
},
|
|
1725
|
+
"ecosystem": {
|
|
1726
|
+
"type": "string",
|
|
1727
|
+
"enum": [
|
|
1728
|
+
"npm",
|
|
1729
|
+
"pypi",
|
|
1730
|
+
"rpm",
|
|
1731
|
+
"deb",
|
|
1732
|
+
"maven",
|
|
1733
|
+
"gem",
|
|
1734
|
+
"nuget",
|
|
1735
|
+
"go",
|
|
1736
|
+
"cargo",
|
|
1737
|
+
"generic"
|
|
1738
|
+
],
|
|
1739
|
+
"description": "The packaging ecosystem the package belongs to. Use 'generic' for hardware, firmware, or anything outside the listed language/OS package managers."
|
|
1740
|
+
},
|
|
1741
|
+
"cpe": {
|
|
1742
|
+
"type": "string",
|
|
1743
|
+
"pattern": "^cpe:2\\.3:[aho]:.*",
|
|
1744
|
+
"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:*:*:*:*:*:*:*'."
|
|
1745
|
+
},
|
|
1746
|
+
"purl": {
|
|
1747
|
+
"type": "string",
|
|
1748
|
+
"pattern": "^pkg:[A-Za-z0-9.+-]+/.+",
|
|
1749
|
+
"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'."
|
|
1750
|
+
},
|
|
1751
|
+
"fixedInVersion": {
|
|
1752
|
+
"type": "string",
|
|
1753
|
+
"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'."
|
|
1754
|
+
}
|
|
1755
|
+
},
|
|
1756
|
+
"examples": [
|
|
1757
|
+
{
|
|
1758
|
+
"$comment": "RPM ecosystem with full CPE + PURL — typical Grype/Trivy output for a RHEL host scan.",
|
|
1759
|
+
"name": "openssl",
|
|
1760
|
+
"version": "1.1.1k-7.el8_4",
|
|
1761
|
+
"ecosystem": "rpm",
|
|
1762
|
+
"cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*",
|
|
1763
|
+
"purl": "pkg:rpm/redhat/openssl@1.1.1k-7.el8_4?arch=x86_64",
|
|
1764
|
+
"fixedInVersion": "1.1.1l"
|
|
1765
|
+
},
|
|
1766
|
+
{
|
|
1767
|
+
"$comment": "NPM ecosystem with PURL only — the JavaScript world rarely emits CPEs; PURL is the canonical identifier.",
|
|
1768
|
+
"name": "lodash",
|
|
1769
|
+
"version": "4.17.20",
|
|
1770
|
+
"ecosystem": "npm",
|
|
1771
|
+
"purl": "pkg:npm/lodash@4.17.20",
|
|
1772
|
+
"fixedInVersion": "4.17.21"
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
"$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.",
|
|
1776
|
+
"name": "requests",
|
|
1777
|
+
"version": "2.28.1",
|
|
1778
|
+
"ecosystem": "pypi"
|
|
1779
|
+
},
|
|
1780
|
+
{
|
|
1781
|
+
"$comment": "Maven ecosystem with full identifiers + fixedInVersion — log4j Log4Shell-style finding showing the patch path from vulnerable to fixed.",
|
|
1782
|
+
"name": "org.apache.logging.log4j:log4j-core",
|
|
1783
|
+
"version": "2.14.1",
|
|
1784
|
+
"ecosystem": "maven",
|
|
1785
|
+
"cpe": "cpe:2.3:a:apache:log4j:2.14.1:*:*:*:*:*:*:*",
|
|
1786
|
+
"purl": "pkg:maven/org.apache.logging.log4j/log4j-core@2.14.1",
|
|
1787
|
+
"fixedInVersion": "2.17.1"
|
|
1788
|
+
},
|
|
1789
|
+
{
|
|
1790
|
+
"$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.",
|
|
1791
|
+
"purl": "pkg:npm/lodash@4.17.20"
|
|
1792
|
+
},
|
|
1793
|
+
{
|
|
1794
|
+
"$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.",
|
|
1795
|
+
"cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*"
|
|
1796
|
+
}
|
|
1797
|
+
],
|
|
1798
|
+
"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.",
|
|
1799
|
+
"title": "Affected Package"
|
|
1800
|
+
}
|
|
1801
|
+
}
|
|
1802
|
+
},
|
|
1803
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0": {
|
|
1804
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1805
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0",
|
|
1395
1806
|
"title": "HDF Extension Primitives",
|
|
1396
1807
|
"description": "Extension types for waivers, attestations, generators, and integrity.",
|
|
1397
1808
|
"$defs": {
|
|
@@ -1419,15 +1830,15 @@
|
|
|
1419
1830
|
],
|
|
1420
1831
|
"properties": {
|
|
1421
1832
|
"type": {
|
|
1422
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
1833
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Override_Type",
|
|
1423
1834
|
"description": "The type of override applied to this requirement."
|
|
1424
1835
|
},
|
|
1425
1836
|
"status": {
|
|
1426
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
1837
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
|
|
1427
1838
|
"description": "The new status this override sets for the requirement. Optional when only impact is being overridden."
|
|
1428
1839
|
},
|
|
1429
1840
|
"impact": {
|
|
1430
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
1841
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Impact_Override",
|
|
1431
1842
|
"description": "Override to the requirement's impact score. At least one of status or impact must be set."
|
|
1432
1843
|
},
|
|
1433
1844
|
"reason": {
|
|
@@ -1435,7 +1846,7 @@
|
|
|
1435
1846
|
"description": "Explanation for why this override was applied."
|
|
1436
1847
|
},
|
|
1437
1848
|
"appliedBy": {
|
|
1438
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1849
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
|
|
1439
1850
|
"description": "Identity of who applied this override. For simple cases, use type 'simple' with just an identifier."
|
|
1440
1851
|
},
|
|
1441
1852
|
"appliedAt": {
|
|
@@ -1449,19 +1860,28 @@
|
|
|
1449
1860
|
"description": "Timestamp when this override expires and must be reviewed/renewed. REQUIRED - no permanent overrides allowed. ISO 8601 format."
|
|
1450
1861
|
},
|
|
1451
1862
|
"signature": {
|
|
1452
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1863
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
|
|
1453
1864
|
"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."
|
|
1454
1865
|
},
|
|
1455
1866
|
"evidence": {
|
|
1456
1867
|
"type": "array",
|
|
1457
1868
|
"items": {
|
|
1458
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1869
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
|
|
1459
1870
|
},
|
|
1460
1871
|
"description": "Supporting evidence for this override, such as screenshots demonstrating manual verification for attestations."
|
|
1461
1872
|
},
|
|
1462
1873
|
"previousChecksum": {
|
|
1463
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1874
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
|
|
1464
1875
|
"description": "SHA-256 checksum of the previous amendment in chronological order. Creates a tamper-evident chain of amendments (similar to blockchain). Null for the first amendment on a requirement."
|
|
1876
|
+
},
|
|
1877
|
+
"cvss": {
|
|
1878
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
|
|
1879
|
+
"$comment": "When present alongside impact.value on a riskAdjustment override, impact.value should be approximately cvss.computedScore / 10.0. Soft consistency rule — validators may warn but should not error. The cvss block makes Environmental/Threat enrichment auditable.",
|
|
1880
|
+
"description": "Structured CVSS scoring data backing this override. Captures the rubric (which Environmental/Threat metrics the consumer modified, the recomputed score) used to justify a riskAdjustment. For other override types this is optional context."
|
|
1881
|
+
},
|
|
1882
|
+
"justification": {
|
|
1883
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Justification",
|
|
1884
|
+
"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."
|
|
1465
1885
|
}
|
|
1466
1886
|
},
|
|
1467
1887
|
"examples": [
|
|
@@ -1553,6 +1973,7 @@
|
|
|
1553
1973
|
"properties": {
|
|
1554
1974
|
"type": {
|
|
1555
1975
|
"type": "string",
|
|
1976
|
+
"title": "POAM Type",
|
|
1556
1977
|
"enum": [
|
|
1557
1978
|
"remediation",
|
|
1558
1979
|
"mitigation",
|
|
@@ -1566,7 +1987,7 @@
|
|
|
1566
1987
|
"description": "Detailed explanation of the plan, including what actions will be taken."
|
|
1567
1988
|
},
|
|
1568
1989
|
"appliedBy": {
|
|
1569
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1990
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
|
|
1570
1991
|
"description": "Identity of who created this POA&M. For simple cases, use type 'simple' with just an identifier."
|
|
1571
1992
|
},
|
|
1572
1993
|
"appliedAt": {
|
|
@@ -1582,23 +2003,23 @@
|
|
|
1582
2003
|
"milestones": {
|
|
1583
2004
|
"type": "array",
|
|
1584
2005
|
"items": {
|
|
1585
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2006
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
|
|
1586
2007
|
},
|
|
1587
2008
|
"description": "Optional array of milestones tracking progress toward completion."
|
|
1588
2009
|
},
|
|
1589
2010
|
"signature": {
|
|
1590
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2011
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
|
|
1591
2012
|
"description": "Optional digital signature for enhanced trust and non-repudiation."
|
|
1592
2013
|
},
|
|
1593
2014
|
"evidence": {
|
|
1594
2015
|
"type": "array",
|
|
1595
2016
|
"items": {
|
|
1596
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2017
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
|
|
1597
2018
|
},
|
|
1598
2019
|
"description": "Supporting evidence for this POA&M, such as documentation of compensating controls or mitigation implementation."
|
|
1599
2020
|
},
|
|
1600
2021
|
"previousChecksum": {
|
|
1601
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2022
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
|
|
1602
2023
|
"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."
|
|
1603
2024
|
}
|
|
1604
2025
|
},
|
|
@@ -1749,7 +2170,7 @@
|
|
|
1749
2170
|
},
|
|
1750
2171
|
"properties": {
|
|
1751
2172
|
"algorithm": {
|
|
1752
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
2173
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Hash_Algorithm",
|
|
1753
2174
|
"description": "The hash algorithm used for the checksum."
|
|
1754
2175
|
},
|
|
1755
2176
|
"checksum": {
|