@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.
- package/README.md +20 -14
- package/dist/go/go.mod +2 -2
- package/dist/go/hdf.go +570 -210
- package/dist/helpers.d.ts +5 -1
- package/dist/index.d.ts +27 -52
- package/dist/index.js +30 -48
- package/dist/schemas/hdf-amendments.schema.json +565 -45
- package/dist/schemas/hdf-baseline.schema.json +570 -50
- package/dist/schemas/hdf-comparison.schema.json +820 -103
- package/dist/schemas/hdf-evidence-package.schema.json +564 -44
- package/dist/schemas/hdf-plan.schema.json +571 -50
- package/dist/schemas/hdf-results.schema.json +777 -80
- package/dist/schemas/hdf-system.schema.json +596 -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 -472
- package/dist/ts/hdf-baseline.js +0 -58
- package/dist/ts/hdf-baseline.ts +0 -483
- 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 -1511
- package/dist/ts/hdf-results.js +0 -194
- package/dist/ts/hdf-results.ts +0 -1536
- 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-evidence-package/v3.
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-evidence-package/v3.3.0",
|
|
4
4
|
"title": "HDF Evidence Package",
|
|
5
5
|
"description": "Bundles references to all HDF documents for audit, authorization, and compliance review. Each content entry references a document by type, URI, and checksum for integrity verification.",
|
|
6
6
|
"type": "object",
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"description": "URI to the hdf-plan document that drove this assessment. Used for completeness verification — every baseline in the plan should have a corresponding results document in this package."
|
|
35
35
|
},
|
|
36
36
|
"preparedBy": {
|
|
37
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
37
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
|
|
38
38
|
"description": "Identity of who prepared this evidence package."
|
|
39
39
|
},
|
|
40
40
|
"preparedAt": {
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"description": "Summary of assessment completeness and compliance status."
|
|
56
56
|
},
|
|
57
57
|
"signature": {
|
|
58
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
58
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
|
|
59
59
|
"description": "Digital signature covering the entire evidence package."
|
|
60
60
|
},
|
|
61
61
|
"labels": {
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"description": "Optional key-value labels for grouping and querying evidence packages."
|
|
67
67
|
},
|
|
68
68
|
"integrity": {
|
|
69
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
69
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Integrity",
|
|
70
70
|
"description": "Cryptographic integrity information for verifying this evidence package has not been tampered with."
|
|
71
71
|
},
|
|
72
72
|
"version": {
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
"description": "Version of this evidence package."
|
|
75
75
|
},
|
|
76
76
|
"generator": {
|
|
77
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
77
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Generator",
|
|
78
78
|
"description": "Information about the tool that generated this document."
|
|
79
79
|
}
|
|
80
80
|
},
|
|
@@ -111,7 +111,7 @@
|
|
|
111
111
|
"description": "URI to the document. Can be a relative path or absolute URL."
|
|
112
112
|
},
|
|
113
113
|
"checksum": {
|
|
114
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
114
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
|
|
115
115
|
"description": "Cryptographic checksum for verifying the referenced document's integrity."
|
|
116
116
|
},
|
|
117
117
|
"description": {
|
|
@@ -205,9 +205,9 @@
|
|
|
205
205
|
"description": "Informational summary of assessment completeness. Not authoritative — tools should compute these from the referenced documents.",
|
|
206
206
|
"title": "Completeness Check"
|
|
207
207
|
},
|
|
208
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
208
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0": {
|
|
209
209
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
210
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
210
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0",
|
|
211
211
|
"title": "HDF Common Primitives",
|
|
212
212
|
"description": "Shared building blocks used by hdf-results and hdf-baseline schemas.",
|
|
213
213
|
"$defs": {
|
|
@@ -474,6 +474,7 @@
|
|
|
474
474
|
},
|
|
475
475
|
"type": {
|
|
476
476
|
"type": "string",
|
|
477
|
+
"title": "Identity Type",
|
|
477
478
|
"enum": [
|
|
478
479
|
"email",
|
|
479
480
|
"username",
|
|
@@ -517,6 +518,7 @@
|
|
|
517
518
|
"properties": {
|
|
518
519
|
"type": {
|
|
519
520
|
"type": "string",
|
|
521
|
+
"title": "Evidence Type",
|
|
520
522
|
"enum": [
|
|
521
523
|
"screenshot",
|
|
522
524
|
"code",
|
|
@@ -693,6 +695,7 @@
|
|
|
693
695
|
},
|
|
694
696
|
"status": {
|
|
695
697
|
"type": "string",
|
|
698
|
+
"title": "Milestone Status",
|
|
696
699
|
"enum": [
|
|
697
700
|
"pending",
|
|
698
701
|
"inProgress",
|
|
@@ -952,15 +955,42 @@
|
|
|
952
955
|
},
|
|
953
956
|
"code": {
|
|
954
957
|
"type": "string",
|
|
955
|
-
"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."
|
|
958
|
+
"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."
|
|
956
959
|
},
|
|
957
960
|
"sourceLocation": {
|
|
958
961
|
"$ref": "#/$defs/Source_Location",
|
|
959
962
|
"description": "The explicit location of the requirement within the source code."
|
|
963
|
+
},
|
|
964
|
+
"controlType": {
|
|
965
|
+
"type": "string",
|
|
966
|
+
"title": "Control Type",
|
|
967
|
+
"enum": [
|
|
968
|
+
"policy",
|
|
969
|
+
"procedure",
|
|
970
|
+
"technical",
|
|
971
|
+
"management",
|
|
972
|
+
"operational"
|
|
973
|
+
],
|
|
974
|
+
"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."
|
|
975
|
+
},
|
|
976
|
+
"verificationMethod": {
|
|
977
|
+
"$ref": "#/$defs/Verification_Method_Enum",
|
|
978
|
+
"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."
|
|
979
|
+
},
|
|
980
|
+
"applicability": {
|
|
981
|
+
"type": "string",
|
|
982
|
+
"title": "Applicability",
|
|
983
|
+
"enum": [
|
|
984
|
+
"required",
|
|
985
|
+
"optional",
|
|
986
|
+
"advisory"
|
|
987
|
+
],
|
|
988
|
+
"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."
|
|
960
989
|
}
|
|
961
990
|
},
|
|
962
991
|
"examples": [
|
|
963
992
|
{
|
|
993
|
+
"$comment": "v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape under v3.3.0 (backward compatibility).",
|
|
964
994
|
"id": "SV-238196",
|
|
965
995
|
"title": "The Ubuntu operating system must enforce password complexity",
|
|
966
996
|
"impact": 0.5,
|
|
@@ -988,11 +1018,85 @@
|
|
|
988
1018
|
"data": "Verify the value of 'minlen' in /etc/security/pwquality.conf."
|
|
989
1019
|
}
|
|
990
1020
|
]
|
|
1021
|
+
},
|
|
1022
|
+
{
|
|
1023
|
+
"$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.",
|
|
1024
|
+
"id": "AC-3",
|
|
1025
|
+
"title": "Access Enforcement",
|
|
1026
|
+
"impact": 0.7,
|
|
1027
|
+
"tags": {
|
|
1028
|
+
"nist": [
|
|
1029
|
+
"AC-3"
|
|
1030
|
+
],
|
|
1031
|
+
"severity": "high"
|
|
1032
|
+
},
|
|
1033
|
+
"descriptions": [
|
|
1034
|
+
{
|
|
1035
|
+
"label": "default",
|
|
1036
|
+
"data": "The information system enforces approved authorizations for logical access to information and system resources."
|
|
1037
|
+
}
|
|
1038
|
+
],
|
|
1039
|
+
"code": "control 'AC-3' do; impact 0.7; end",
|
|
1040
|
+
"controlType": "technical",
|
|
1041
|
+
"verificationMethod": "automated",
|
|
1042
|
+
"applicability": "required"
|
|
1043
|
+
},
|
|
1044
|
+
{
|
|
1045
|
+
"$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.",
|
|
1046
|
+
"id": "KSI-CNA-01",
|
|
1047
|
+
"title": "Cyber Security Plan documents the system",
|
|
1048
|
+
"impact": 0.5,
|
|
1049
|
+
"tags": {
|
|
1050
|
+
"ksi": [
|
|
1051
|
+
"KSI-CNA"
|
|
1052
|
+
]
|
|
1053
|
+
},
|
|
1054
|
+
"descriptions": [
|
|
1055
|
+
{
|
|
1056
|
+
"label": "default",
|
|
1057
|
+
"data": "The Cyber Security Plan documents the system, its boundary, and its components."
|
|
1058
|
+
}
|
|
1059
|
+
],
|
|
1060
|
+
"controlType": "policy",
|
|
1061
|
+
"verificationMethod": "manual-by-design",
|
|
1062
|
+
"applicability": "required"
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"$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.",
|
|
1066
|
+
"id": "SV-999999",
|
|
1067
|
+
"title": "Example STIG rule pending automation",
|
|
1068
|
+
"impact": 0.3,
|
|
1069
|
+
"tags": {
|
|
1070
|
+
"stig_id": "SV-999999"
|
|
1071
|
+
},
|
|
1072
|
+
"descriptions": [
|
|
1073
|
+
{
|
|
1074
|
+
"label": "default",
|
|
1075
|
+
"data": "Example requirement that is intended to be automated but currently lacks a fix block."
|
|
1076
|
+
},
|
|
1077
|
+
{
|
|
1078
|
+
"label": "check",
|
|
1079
|
+
"data": "Manual review of system configuration is required."
|
|
1080
|
+
}
|
|
1081
|
+
],
|
|
1082
|
+
"verificationMethod": "manual-pending-automation",
|
|
1083
|
+
"applicability": "advisory"
|
|
991
1084
|
}
|
|
992
1085
|
],
|
|
993
1086
|
"description": "Core requirement fields shared between baseline requirements and evaluated requirements. Contains the fundamental requirement definition without assessment results.",
|
|
994
1087
|
"title": "Requirement Core"
|
|
995
1088
|
},
|
|
1089
|
+
"Verification_Method_Enum": {
|
|
1090
|
+
"type": "string",
|
|
1091
|
+
"enum": [
|
|
1092
|
+
"automated",
|
|
1093
|
+
"manual-by-design",
|
|
1094
|
+
"manual-pending-automation",
|
|
1095
|
+
"hybrid"
|
|
1096
|
+
],
|
|
1097
|
+
"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.",
|
|
1098
|
+
"title": "Verification Method Enum"
|
|
1099
|
+
},
|
|
996
1100
|
"Severity": {
|
|
997
1101
|
"type": "string",
|
|
998
1102
|
"enum": [
|
|
@@ -1023,9 +1127,9 @@
|
|
|
1023
1127
|
}
|
|
1024
1128
|
}
|
|
1025
1129
|
},
|
|
1026
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
1130
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0": {
|
|
1027
1131
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1028
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.
|
|
1132
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0",
|
|
1029
1133
|
"title": "HDF Extension Primitives",
|
|
1030
1134
|
"description": "Extension types for waivers, attestations, generators, and integrity.",
|
|
1031
1135
|
"$defs": {
|
|
@@ -1053,15 +1157,15 @@
|
|
|
1053
1157
|
],
|
|
1054
1158
|
"properties": {
|
|
1055
1159
|
"type": {
|
|
1056
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
1160
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Override_Type",
|
|
1057
1161
|
"description": "The type of override applied to this requirement."
|
|
1058
1162
|
},
|
|
1059
1163
|
"status": {
|
|
1060
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
1164
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
|
|
1061
1165
|
"description": "The new status this override sets for the requirement. Optional when only impact is being overridden."
|
|
1062
1166
|
},
|
|
1063
1167
|
"impact": {
|
|
1064
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
1168
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Impact_Override",
|
|
1065
1169
|
"description": "Override to the requirement's impact score. At least one of status or impact must be set."
|
|
1066
1170
|
},
|
|
1067
1171
|
"reason": {
|
|
@@ -1069,7 +1173,7 @@
|
|
|
1069
1173
|
"description": "Explanation for why this override was applied."
|
|
1070
1174
|
},
|
|
1071
1175
|
"appliedBy": {
|
|
1072
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1176
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
|
|
1073
1177
|
"description": "Identity of who applied this override. For simple cases, use type 'simple' with just an identifier."
|
|
1074
1178
|
},
|
|
1075
1179
|
"appliedAt": {
|
|
@@ -1083,19 +1187,28 @@
|
|
|
1083
1187
|
"description": "Timestamp when this override expires and must be reviewed/renewed. REQUIRED - no permanent overrides allowed. ISO 8601 format."
|
|
1084
1188
|
},
|
|
1085
1189
|
"signature": {
|
|
1086
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1190
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
|
|
1087
1191
|
"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."
|
|
1088
1192
|
},
|
|
1089
1193
|
"evidence": {
|
|
1090
1194
|
"type": "array",
|
|
1091
1195
|
"items": {
|
|
1092
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1196
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
|
|
1093
1197
|
},
|
|
1094
1198
|
"description": "Supporting evidence for this override, such as screenshots demonstrating manual verification for attestations."
|
|
1095
1199
|
},
|
|
1096
1200
|
"previousChecksum": {
|
|
1097
|
-
"$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/Checksum",
|
|
1098
1202
|
"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."
|
|
1203
|
+
},
|
|
1204
|
+
"cvss": {
|
|
1205
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
|
|
1206
|
+
"$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.",
|
|
1207
|
+
"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."
|
|
1208
|
+
},
|
|
1209
|
+
"justification": {
|
|
1210
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Justification",
|
|
1211
|
+
"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."
|
|
1099
1212
|
}
|
|
1100
1213
|
},
|
|
1101
1214
|
"examples": [
|
|
@@ -1187,6 +1300,7 @@
|
|
|
1187
1300
|
"properties": {
|
|
1188
1301
|
"type": {
|
|
1189
1302
|
"type": "string",
|
|
1303
|
+
"title": "POAM Type",
|
|
1190
1304
|
"enum": [
|
|
1191
1305
|
"remediation",
|
|
1192
1306
|
"mitigation",
|
|
@@ -1200,7 +1314,7 @@
|
|
|
1200
1314
|
"description": "Detailed explanation of the plan, including what actions will be taken."
|
|
1201
1315
|
},
|
|
1202
1316
|
"appliedBy": {
|
|
1203
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1317
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
|
|
1204
1318
|
"description": "Identity of who created this POA&M. For simple cases, use type 'simple' with just an identifier."
|
|
1205
1319
|
},
|
|
1206
1320
|
"appliedAt": {
|
|
@@ -1216,23 +1330,23 @@
|
|
|
1216
1330
|
"milestones": {
|
|
1217
1331
|
"type": "array",
|
|
1218
1332
|
"items": {
|
|
1219
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1333
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
|
|
1220
1334
|
},
|
|
1221
1335
|
"description": "Optional array of milestones tracking progress toward completion."
|
|
1222
1336
|
},
|
|
1223
1337
|
"signature": {
|
|
1224
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1338
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
|
|
1225
1339
|
"description": "Optional digital signature for enhanced trust and non-repudiation."
|
|
1226
1340
|
},
|
|
1227
1341
|
"evidence": {
|
|
1228
1342
|
"type": "array",
|
|
1229
1343
|
"items": {
|
|
1230
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1344
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
|
|
1231
1345
|
},
|
|
1232
1346
|
"description": "Supporting evidence for this POA&M, such as documentation of compensating controls or mitigation implementation."
|
|
1233
1347
|
},
|
|
1234
1348
|
"previousChecksum": {
|
|
1235
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1349
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
|
|
1236
1350
|
"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."
|
|
1237
1351
|
}
|
|
1238
1352
|
},
|
|
@@ -1383,7 +1497,7 @@
|
|
|
1383
1497
|
},
|
|
1384
1498
|
"properties": {
|
|
1385
1499
|
"algorithm": {
|
|
1386
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1500
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Hash_Algorithm",
|
|
1387
1501
|
"description": "The hash algorithm used for the checksum."
|
|
1388
1502
|
},
|
|
1389
1503
|
"checksum": {
|
|
@@ -1416,9 +1530,9 @@
|
|
|
1416
1530
|
}
|
|
1417
1531
|
}
|
|
1418
1532
|
},
|
|
1419
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
1533
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0": {
|
|
1420
1534
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1421
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.
|
|
1535
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0",
|
|
1422
1536
|
"title": "HDF Amendment Primitives",
|
|
1423
1537
|
"description": "Types for waivers, attestations, and POA&Ms that modify requirement compliance status.",
|
|
1424
1538
|
"$defs": {
|
|
@@ -1436,6 +1550,24 @@
|
|
|
1436
1550
|
"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.",
|
|
1437
1551
|
"title": "Override Type"
|
|
1438
1552
|
},
|
|
1553
|
+
"Justification": {
|
|
1554
|
+
"type": "string",
|
|
1555
|
+
"enum": [
|
|
1556
|
+
"component_not_present",
|
|
1557
|
+
"vulnerable_code_not_present",
|
|
1558
|
+
"vulnerable_code_not_in_execute_path",
|
|
1559
|
+
"vulnerable_code_cannot_be_controlled_by_adversary",
|
|
1560
|
+
"inline_mitigations_already_exist",
|
|
1561
|
+
"requires_configuration",
|
|
1562
|
+
"requires_dependency",
|
|
1563
|
+
"requires_environment",
|
|
1564
|
+
"protected_by_compiler",
|
|
1565
|
+
"protected_at_runtime",
|
|
1566
|
+
"protected_at_perimeter"
|
|
1567
|
+
],
|
|
1568
|
+
"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.",
|
|
1569
|
+
"title": "Justification"
|
|
1570
|
+
},
|
|
1439
1571
|
"Impact_Override": {
|
|
1440
1572
|
"type": "object",
|
|
1441
1573
|
"required": [
|
|
@@ -1455,6 +1587,7 @@
|
|
|
1455
1587
|
},
|
|
1456
1588
|
"Standalone_Override": {
|
|
1457
1589
|
"type": "object",
|
|
1590
|
+
"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).",
|
|
1458
1591
|
"unevaluatedProperties": false,
|
|
1459
1592
|
"required": [
|
|
1460
1593
|
"type",
|
|
@@ -1464,18 +1597,48 @@
|
|
|
1464
1597
|
"appliedAt",
|
|
1465
1598
|
"expiresAt"
|
|
1466
1599
|
],
|
|
1467
|
-
"
|
|
1468
|
-
{
|
|
1469
|
-
"
|
|
1470
|
-
"
|
|
1471
|
-
|
|
1600
|
+
"if": {
|
|
1601
|
+
"properties": {
|
|
1602
|
+
"type": {
|
|
1603
|
+
"enum": [
|
|
1604
|
+
"operationalRequirement"
|
|
1605
|
+
]
|
|
1606
|
+
}
|
|
1472
1607
|
},
|
|
1473
|
-
|
|
1474
|
-
"
|
|
1475
|
-
|
|
1608
|
+
"required": [
|
|
1609
|
+
"type"
|
|
1610
|
+
]
|
|
1611
|
+
},
|
|
1612
|
+
"then": {
|
|
1613
|
+
"not": {
|
|
1614
|
+
"anyOf": [
|
|
1615
|
+
{
|
|
1616
|
+
"required": [
|
|
1617
|
+
"status"
|
|
1618
|
+
]
|
|
1619
|
+
},
|
|
1620
|
+
{
|
|
1621
|
+
"required": [
|
|
1622
|
+
"impact"
|
|
1623
|
+
]
|
|
1624
|
+
}
|
|
1476
1625
|
]
|
|
1477
1626
|
}
|
|
1478
|
-
|
|
1627
|
+
},
|
|
1628
|
+
"else": {
|
|
1629
|
+
"anyOf": [
|
|
1630
|
+
{
|
|
1631
|
+
"required": [
|
|
1632
|
+
"status"
|
|
1633
|
+
]
|
|
1634
|
+
},
|
|
1635
|
+
{
|
|
1636
|
+
"required": [
|
|
1637
|
+
"impact"
|
|
1638
|
+
]
|
|
1639
|
+
}
|
|
1640
|
+
]
|
|
1641
|
+
},
|
|
1479
1642
|
"properties": {
|
|
1480
1643
|
"type": {
|
|
1481
1644
|
"$ref": "#/$defs/Override_Type",
|
|
@@ -1490,7 +1653,7 @@
|
|
|
1490
1653
|
"description": "Name of the baseline containing the requirement. Required when the system has multiple baselines with potentially overlapping requirement IDs."
|
|
1491
1654
|
},
|
|
1492
1655
|
"status": {
|
|
1493
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
1656
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status",
|
|
1494
1657
|
"description": "The new status this amendment sets. Optional when only impact is being overridden."
|
|
1495
1658
|
},
|
|
1496
1659
|
"impact": {
|
|
@@ -1502,7 +1665,7 @@
|
|
|
1502
1665
|
"description": "Justification for this amendment."
|
|
1503
1666
|
},
|
|
1504
1667
|
"appliedBy": {
|
|
1505
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1668
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity",
|
|
1506
1669
|
"description": "Identity of who applied this amendment."
|
|
1507
1670
|
},
|
|
1508
1671
|
"appliedAt": {
|
|
@@ -1518,22 +1681,31 @@
|
|
|
1518
1681
|
"evidence": {
|
|
1519
1682
|
"type": "array",
|
|
1520
1683
|
"items": {
|
|
1521
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1684
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence"
|
|
1522
1685
|
},
|
|
1523
1686
|
"description": "Supporting evidence (screenshots, logs, URLs, documents)."
|
|
1524
1687
|
},
|
|
1525
1688
|
"signature": {
|
|
1526
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1689
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature",
|
|
1527
1690
|
"description": "Digital signature for non-repudiation."
|
|
1528
1691
|
},
|
|
1529
1692
|
"previousChecksum": {
|
|
1530
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1693
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum",
|
|
1531
1694
|
"description": "Checksum of the prior amendment in the chain. Creates a tamper-evident linked list. Null for the first amendment."
|
|
1532
1695
|
},
|
|
1696
|
+
"cvss": {
|
|
1697
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss",
|
|
1698
|
+
"$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.",
|
|
1699
|
+
"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."
|
|
1700
|
+
},
|
|
1701
|
+
"justification": {
|
|
1702
|
+
"$ref": "#/$defs/Justification",
|
|
1703
|
+
"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."
|
|
1704
|
+
},
|
|
1533
1705
|
"milestones": {
|
|
1534
1706
|
"type": "array",
|
|
1535
1707
|
"items": {
|
|
1536
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.
|
|
1708
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone"
|
|
1537
1709
|
},
|
|
1538
1710
|
"description": "Remediation milestones (primarily for POA&M type amendments)."
|
|
1539
1711
|
},
|
|
@@ -1546,6 +1718,13 @@
|
|
|
1546
1718
|
"type": "string",
|
|
1547
1719
|
"format": "uuid",
|
|
1548
1720
|
"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."
|
|
1721
|
+
},
|
|
1722
|
+
"affectedPackages": {
|
|
1723
|
+
"type": "array",
|
|
1724
|
+
"items": {
|
|
1725
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0#/$defs/Affected_Package"
|
|
1726
|
+
},
|
|
1727
|
+
"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)."
|
|
1549
1728
|
}
|
|
1550
1729
|
},
|
|
1551
1730
|
"examples": [
|
|
@@ -1647,16 +1826,38 @@
|
|
|
1647
1826
|
},
|
|
1648
1827
|
"appliedAt": "2026-03-26T10:00:00Z",
|
|
1649
1828
|
"expiresAt": "2026-09-26T00:00:00Z"
|
|
1829
|
+
},
|
|
1830
|
+
{
|
|
1831
|
+
"$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.",
|
|
1832
|
+
"type": "falsePositive",
|
|
1833
|
+
"requirementId": "CVE-2026-12345",
|
|
1834
|
+
"status": "notApplicable",
|
|
1835
|
+
"reason": "Vulnerable code path is not present in our build — dependency compiled with the affected module disabled",
|
|
1836
|
+
"justification": "vulnerable_code_not_present",
|
|
1837
|
+
"appliedBy": {
|
|
1838
|
+
"type": "email",
|
|
1839
|
+
"identifier": "secops@org.gov"
|
|
1840
|
+
},
|
|
1841
|
+
"appliedAt": "2026-05-01T10:00:00Z",
|
|
1842
|
+
"expiresAt": "2027-05-01T00:00:00Z",
|
|
1843
|
+
"affectedPackages": [
|
|
1844
|
+
{
|
|
1845
|
+
"purl": "pkg:npm/lodash@4.17.20"
|
|
1846
|
+
},
|
|
1847
|
+
{
|
|
1848
|
+
"purl": "pkg:rpm/openssl@1.1.1k-2.el8",
|
|
1849
|
+
"fixedInVersion": "1.1.1k-3.el8"
|
|
1850
|
+
}
|
|
1851
|
+
]
|
|
1650
1852
|
}
|
|
1651
1853
|
],
|
|
1652
|
-
"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.",
|
|
1653
1854
|
"title": "Standalone Override"
|
|
1654
1855
|
}
|
|
1655
1856
|
}
|
|
1656
1857
|
},
|
|
1657
|
-
"https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
1858
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0": {
|
|
1658
1859
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1659
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.
|
|
1860
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0",
|
|
1660
1861
|
"title": "HDF Result Primitives",
|
|
1661
1862
|
"description": "Types for representing assessment results and statuses.",
|
|
1662
1863
|
"$defs": {
|
|
@@ -1786,6 +1987,325 @@
|
|
|
1786
1987
|
"title": "Requirement Description"
|
|
1787
1988
|
}
|
|
1788
1989
|
}
|
|
1990
|
+
},
|
|
1991
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0": {
|
|
1992
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1993
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0",
|
|
1994
|
+
"title": "HDF CVSS Primitives",
|
|
1995
|
+
"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).",
|
|
1996
|
+
"$defs": {
|
|
1997
|
+
"Cvss_Severity": {
|
|
1998
|
+
"type": "string",
|
|
1999
|
+
"enum": [
|
|
2000
|
+
"none",
|
|
2001
|
+
"low",
|
|
2002
|
+
"medium",
|
|
2003
|
+
"high",
|
|
2004
|
+
"critical"
|
|
2005
|
+
],
|
|
2006
|
+
"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').",
|
|
2007
|
+
"title": "CVSS Severity"
|
|
2008
|
+
},
|
|
2009
|
+
"Cvss": {
|
|
2010
|
+
"type": "object",
|
|
2011
|
+
"unevaluatedProperties": false,
|
|
2012
|
+
"required": [
|
|
2013
|
+
"version"
|
|
2014
|
+
],
|
|
2015
|
+
"anyOf": [
|
|
2016
|
+
{
|
|
2017
|
+
"required": [
|
|
2018
|
+
"baseScore"
|
|
2019
|
+
]
|
|
2020
|
+
},
|
|
2021
|
+
{
|
|
2022
|
+
"required": [
|
|
2023
|
+
"baseVector"
|
|
2024
|
+
]
|
|
2025
|
+
},
|
|
2026
|
+
{
|
|
2027
|
+
"required": [
|
|
2028
|
+
"threatVector"
|
|
2029
|
+
]
|
|
2030
|
+
},
|
|
2031
|
+
{
|
|
2032
|
+
"required": [
|
|
2033
|
+
"threatScore"
|
|
2034
|
+
]
|
|
2035
|
+
},
|
|
2036
|
+
{
|
|
2037
|
+
"required": [
|
|
2038
|
+
"environmentalVector"
|
|
2039
|
+
]
|
|
2040
|
+
},
|
|
2041
|
+
{
|
|
2042
|
+
"required": [
|
|
2043
|
+
"environmentalScore"
|
|
2044
|
+
]
|
|
2045
|
+
},
|
|
2046
|
+
{
|
|
2047
|
+
"required": [
|
|
2048
|
+
"supplementalVector"
|
|
2049
|
+
]
|
|
2050
|
+
},
|
|
2051
|
+
{
|
|
2052
|
+
"required": [
|
|
2053
|
+
"computedScore"
|
|
2054
|
+
]
|
|
2055
|
+
}
|
|
2056
|
+
],
|
|
2057
|
+
"$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.",
|
|
2058
|
+
"properties": {
|
|
2059
|
+
"version": {
|
|
2060
|
+
"type": "string",
|
|
2061
|
+
"enum": [
|
|
2062
|
+
"2.0",
|
|
2063
|
+
"3.0",
|
|
2064
|
+
"3.1",
|
|
2065
|
+
"4.0"
|
|
2066
|
+
],
|
|
2067
|
+
"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."
|
|
2068
|
+
},
|
|
2069
|
+
"source": {
|
|
2070
|
+
"type": "string",
|
|
2071
|
+
"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.",
|
|
2072
|
+
"examples": [
|
|
2073
|
+
"CVE-2024-12345",
|
|
2074
|
+
"GHSA-9hjg-9r4m-mvj7",
|
|
2075
|
+
"RHSA-2024:0123"
|
|
2076
|
+
]
|
|
2077
|
+
},
|
|
2078
|
+
"baseVector": {
|
|
2079
|
+
"type": "string",
|
|
2080
|
+
"$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.",
|
|
2081
|
+
"pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
|
|
2082
|
+
"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."
|
|
2083
|
+
},
|
|
2084
|
+
"baseScore": {
|
|
2085
|
+
"type": "number",
|
|
2086
|
+
"minimum": 0,
|
|
2087
|
+
"maximum": 10,
|
|
2088
|
+
"description": "The Base score (0.0–10.0) computed from the base vector. Reflects the intrinsic, vendor-published severity before consumer enrichment."
|
|
2089
|
+
},
|
|
2090
|
+
"baseSeverity": {
|
|
2091
|
+
"$ref": "#/$defs/Cvss_Severity",
|
|
2092
|
+
"description": "Qualitative severity band corresponding to baseScore. CVSS 2.0 does not natively use 'none' or 'critical' bands; map accordingly when populating."
|
|
2093
|
+
},
|
|
2094
|
+
"threatVector": {
|
|
2095
|
+
"type": "string",
|
|
2096
|
+
"$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.",
|
|
2097
|
+
"pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
|
|
2098
|
+
"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."
|
|
2099
|
+
},
|
|
2100
|
+
"threatScore": {
|
|
2101
|
+
"type": "number",
|
|
2102
|
+
"minimum": 0,
|
|
2103
|
+
"maximum": 10,
|
|
2104
|
+
"description": "Optional score (0.0–10.0) recomputed after applying Threat metrics. Always less than or equal to baseScore in practice."
|
|
2105
|
+
},
|
|
2106
|
+
"environmentalVector": {
|
|
2107
|
+
"type": "string",
|
|
2108
|
+
"$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.",
|
|
2109
|
+
"pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
|
|
2110
|
+
"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)."
|
|
2111
|
+
},
|
|
2112
|
+
"environmentalScore": {
|
|
2113
|
+
"type": "number",
|
|
2114
|
+
"minimum": 0,
|
|
2115
|
+
"maximum": 10,
|
|
2116
|
+
"description": "Optional score (0.0–10.0) recomputed after applying Environmental metrics."
|
|
2117
|
+
},
|
|
2118
|
+
"supplementalVector": {
|
|
2119
|
+
"type": "string",
|
|
2120
|
+
"$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.",
|
|
2121
|
+
"pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$",
|
|
2122
|
+
"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."
|
|
2123
|
+
},
|
|
2124
|
+
"computedScore": {
|
|
2125
|
+
"type": "number",
|
|
2126
|
+
"minimum": 0,
|
|
2127
|
+
"maximum": 10,
|
|
2128
|
+
"description": "Optional final score after combining Base + Threat + Environmental metrics. This is the score consumers should treat as authoritative for risk decisions when present."
|
|
2129
|
+
},
|
|
2130
|
+
"computedSeverity": {
|
|
2131
|
+
"$ref": "#/$defs/Cvss_Severity",
|
|
2132
|
+
"description": "Qualitative severity band corresponding to computedScore. Same band convention as baseSeverity."
|
|
2133
|
+
}
|
|
2134
|
+
},
|
|
2135
|
+
"examples": [
|
|
2136
|
+
{
|
|
2137
|
+
"$comment": "Base-only: vendor-supplied CVSS 3.1 data exactly as a scanner (e.g., Nessus, Grype) would emit it. No consumer enrichment yet.",
|
|
2138
|
+
"version": "3.1",
|
|
2139
|
+
"source": "CVE-2024-12345",
|
|
2140
|
+
"baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
|
|
2141
|
+
"baseScore": 9.8,
|
|
2142
|
+
"baseSeverity": "critical"
|
|
2143
|
+
},
|
|
2144
|
+
{
|
|
2145
|
+
"$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.",
|
|
2146
|
+
"version": "3.1",
|
|
2147
|
+
"source": "CVE-2023-44487",
|
|
2148
|
+
"baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H",
|
|
2149
|
+
"baseScore": 7.5,
|
|
2150
|
+
"baseSeverity": "high",
|
|
2151
|
+
"threatVector": "E:U/RL:O/RC:C",
|
|
2152
|
+
"threatScore": 5.5
|
|
2153
|
+
},
|
|
2154
|
+
{
|
|
2155
|
+
"$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.",
|
|
2156
|
+
"version": "3.1",
|
|
2157
|
+
"source": "CVE-2024-3094",
|
|
2158
|
+
"baseVector": "CVSS:3.1/AV:L/AC:H/PR:H/UI:N/S:U/C:H/I:H/A:H",
|
|
2159
|
+
"baseScore": 6.7,
|
|
2160
|
+
"baseSeverity": "medium",
|
|
2161
|
+
"environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
|
|
2162
|
+
"environmentalScore": 9,
|
|
2163
|
+
"computedScore": 9,
|
|
2164
|
+
"computedSeverity": "critical"
|
|
2165
|
+
},
|
|
2166
|
+
{
|
|
2167
|
+
"$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.",
|
|
2168
|
+
"version": "4.0",
|
|
2169
|
+
"source": "CVE-2024-21762",
|
|
2170
|
+
"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",
|
|
2171
|
+
"baseScore": 9.8,
|
|
2172
|
+
"baseSeverity": "critical",
|
|
2173
|
+
"threatVector": "E:A",
|
|
2174
|
+
"threatScore": 9.3,
|
|
2175
|
+
"environmentalVector": "MAV:N/CR:H/IR:H/AR:H",
|
|
2176
|
+
"environmentalScore": 9.5,
|
|
2177
|
+
"supplementalVector": "S:P/AU:N/V:C/RE:M",
|
|
2178
|
+
"computedScore": 4.2,
|
|
2179
|
+
"computedSeverity": "medium"
|
|
2180
|
+
},
|
|
2181
|
+
{
|
|
2182
|
+
"$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.",
|
|
2183
|
+
"version": "2.0",
|
|
2184
|
+
"source": "CVE-2014-0160",
|
|
2185
|
+
"baseVector": "AV:N/AC:L/Au:N/C:P/I:N/A:N",
|
|
2186
|
+
"baseScore": 5,
|
|
2187
|
+
"baseSeverity": "medium"
|
|
2188
|
+
}
|
|
2189
|
+
],
|
|
2190
|
+
"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.",
|
|
2191
|
+
"title": "CVSS"
|
|
2192
|
+
}
|
|
2193
|
+
}
|
|
2194
|
+
},
|
|
2195
|
+
"https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0": {
|
|
2196
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2197
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0",
|
|
2198
|
+
"title": "HDF Affected Package Primitives",
|
|
2199
|
+
"description": "Types for representing the software package(s) affected by a vulnerability finding.",
|
|
2200
|
+
"$defs": {
|
|
2201
|
+
"Affected_Package": {
|
|
2202
|
+
"type": "object",
|
|
2203
|
+
"unevaluatedProperties": false,
|
|
2204
|
+
"anyOf": [
|
|
2205
|
+
{
|
|
2206
|
+
"required": [
|
|
2207
|
+
"name",
|
|
2208
|
+
"version",
|
|
2209
|
+
"ecosystem"
|
|
2210
|
+
]
|
|
2211
|
+
},
|
|
2212
|
+
{
|
|
2213
|
+
"required": [
|
|
2214
|
+
"purl"
|
|
2215
|
+
]
|
|
2216
|
+
},
|
|
2217
|
+
{
|
|
2218
|
+
"required": [
|
|
2219
|
+
"cpe"
|
|
2220
|
+
]
|
|
2221
|
+
}
|
|
2222
|
+
],
|
|
2223
|
+
"properties": {
|
|
2224
|
+
"name": {
|
|
2225
|
+
"type": "string",
|
|
2226
|
+
"description": "The package name as published in its ecosystem. Examples: 'openssl' (rpm), 'lodash' (npm), 'org.apache.logging.log4j:log4j-core' (maven, group:artifact)."
|
|
2227
|
+
},
|
|
2228
|
+
"version": {
|
|
2229
|
+
"type": "string",
|
|
2230
|
+
"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)."
|
|
2231
|
+
},
|
|
2232
|
+
"ecosystem": {
|
|
2233
|
+
"type": "string",
|
|
2234
|
+
"enum": [
|
|
2235
|
+
"npm",
|
|
2236
|
+
"pypi",
|
|
2237
|
+
"rpm",
|
|
2238
|
+
"deb",
|
|
2239
|
+
"maven",
|
|
2240
|
+
"gem",
|
|
2241
|
+
"nuget",
|
|
2242
|
+
"go",
|
|
2243
|
+
"cargo",
|
|
2244
|
+
"generic"
|
|
2245
|
+
],
|
|
2246
|
+
"description": "The packaging ecosystem the package belongs to. Use 'generic' for hardware, firmware, or anything outside the listed language/OS package managers."
|
|
2247
|
+
},
|
|
2248
|
+
"cpe": {
|
|
2249
|
+
"type": "string",
|
|
2250
|
+
"pattern": "^cpe:2\\.3:[aho]:.*",
|
|
2251
|
+
"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:*:*:*:*:*:*:*'."
|
|
2252
|
+
},
|
|
2253
|
+
"purl": {
|
|
2254
|
+
"type": "string",
|
|
2255
|
+
"pattern": "^pkg:[A-Za-z0-9.+-]+/.+",
|
|
2256
|
+
"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'."
|
|
2257
|
+
},
|
|
2258
|
+
"fixedInVersion": {
|
|
2259
|
+
"type": "string",
|
|
2260
|
+
"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'."
|
|
2261
|
+
}
|
|
2262
|
+
},
|
|
2263
|
+
"examples": [
|
|
2264
|
+
{
|
|
2265
|
+
"$comment": "RPM ecosystem with full CPE + PURL — typical Grype/Trivy output for a RHEL host scan.",
|
|
2266
|
+
"name": "openssl",
|
|
2267
|
+
"version": "1.1.1k-7.el8_4",
|
|
2268
|
+
"ecosystem": "rpm",
|
|
2269
|
+
"cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*",
|
|
2270
|
+
"purl": "pkg:rpm/redhat/openssl@1.1.1k-7.el8_4?arch=x86_64",
|
|
2271
|
+
"fixedInVersion": "1.1.1l"
|
|
2272
|
+
},
|
|
2273
|
+
{
|
|
2274
|
+
"$comment": "NPM ecosystem with PURL only — the JavaScript world rarely emits CPEs; PURL is the canonical identifier.",
|
|
2275
|
+
"name": "lodash",
|
|
2276
|
+
"version": "4.17.20",
|
|
2277
|
+
"ecosystem": "npm",
|
|
2278
|
+
"purl": "pkg:npm/lodash@4.17.20",
|
|
2279
|
+
"fixedInVersion": "4.17.21"
|
|
2280
|
+
},
|
|
2281
|
+
{
|
|
2282
|
+
"$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.",
|
|
2283
|
+
"name": "requests",
|
|
2284
|
+
"version": "2.28.1",
|
|
2285
|
+
"ecosystem": "pypi"
|
|
2286
|
+
},
|
|
2287
|
+
{
|
|
2288
|
+
"$comment": "Maven ecosystem with full identifiers + fixedInVersion — log4j Log4Shell-style finding showing the patch path from vulnerable to fixed.",
|
|
2289
|
+
"name": "org.apache.logging.log4j:log4j-core",
|
|
2290
|
+
"version": "2.14.1",
|
|
2291
|
+
"ecosystem": "maven",
|
|
2292
|
+
"cpe": "cpe:2.3:a:apache:log4j:2.14.1:*:*:*:*:*:*:*",
|
|
2293
|
+
"purl": "pkg:maven/org.apache.logging.log4j/log4j-core@2.14.1",
|
|
2294
|
+
"fixedInVersion": "2.17.1"
|
|
2295
|
+
},
|
|
2296
|
+
{
|
|
2297
|
+
"$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.",
|
|
2298
|
+
"purl": "pkg:npm/lodash@4.17.20"
|
|
2299
|
+
},
|
|
2300
|
+
{
|
|
2301
|
+
"$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.",
|
|
2302
|
+
"cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*"
|
|
2303
|
+
}
|
|
2304
|
+
],
|
|
2305
|
+
"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.",
|
|
2306
|
+
"title": "Affected Package"
|
|
2307
|
+
}
|
|
2308
|
+
}
|
|
1789
2309
|
}
|
|
1790
2310
|
},
|
|
1791
2311
|
"examples": [
|