@mitre/hdf-schema 3.0.0 → 3.0.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 +14 -2
- package/dist/helpers.js +4 -44
- package/dist/schemas/hdf-amendments.schema.json +33 -33
- package/dist/schemas/hdf-baseline.schema.json +38 -38
- package/dist/schemas/hdf-comparison.schema.json +88 -88
- package/dist/schemas/hdf-evidence-package.schema.json +32 -32
- package/dist/schemas/hdf-plan.schema.json +38 -38
- package/dist/schemas/hdf-results.schema.json +67 -67
- package/dist/schemas/hdf-system.schema.json +47 -47
- package/package.json +2 -1
- package/src/schemas/hdf-amendments.schema.json +7 -7
- package/src/schemas/hdf-baseline.schema.json +10 -10
- package/src/schemas/hdf-comparison.schema.json +13 -13
- package/src/schemas/hdf-evidence-package.schema.json +6 -6
- package/src/schemas/hdf-plan.schema.json +6 -6
- package/src/schemas/hdf-results.schema.json +24 -24
- package/src/schemas/hdf-system.schema.json +9 -9
- package/src/schemas/primitives/amendments.schema.json +7 -7
- package/src/schemas/primitives/common.schema.json +1 -1
- package/src/schemas/primitives/comparison.schema.json +6 -6
- package/src/schemas/primitives/component.schema.json +6 -6
- package/src/schemas/primitives/data-flow.schema.json +1 -1
- package/src/schemas/primitives/extensions.schema.json +13 -13
- package/src/schemas/primitives/parameter.schema.json +1 -1
- package/src/schemas/primitives/plan.schema.json +2 -2
- package/src/schemas/primitives/platform.schema.json +1 -1
- package/src/schemas/primitives/result.schema.json +1 -1
- package/src/schemas/primitives/runner.schema.json +2 -2
- package/src/schemas/primitives/statistics.schema.json +1 -1
- package/src/schemas/primitives/system.schema.json +2 -2
- package/src/schemas/primitives/target.schema.json +3 -3
|
@@ -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/
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-evidence-package/v3.0.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/
|
|
37
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.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/
|
|
58
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.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/
|
|
69
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.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/
|
|
77
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.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/
|
|
114
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Checksum",
|
|
115
115
|
"description": "Cryptographic checksum for verifying the referenced document's integrity."
|
|
116
116
|
},
|
|
117
117
|
"description": {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-plan/
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-plan/v3.0.0",
|
|
4
4
|
"title": "HDF Plan",
|
|
5
5
|
"description": "Defines an assessment plan — what baselines to run against which targets, with resolved inputs and scheduling. Maps to OSCAL Assessment Plan.",
|
|
6
6
|
"type": "object",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"description": "Human-readable plan name. Example: 'Portal Monthly Assessment'."
|
|
21
21
|
},
|
|
22
22
|
"type": {
|
|
23
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/
|
|
23
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.0.0#/$defs/Plan_Type",
|
|
24
24
|
"description": "The type of assessment plan."
|
|
25
25
|
},
|
|
26
26
|
"description": {
|
|
@@ -36,12 +36,12 @@
|
|
|
36
36
|
"type": "array",
|
|
37
37
|
"minItems": 1,
|
|
38
38
|
"items": {
|
|
39
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/
|
|
39
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.0.0#/$defs/Assessment"
|
|
40
40
|
},
|
|
41
41
|
"description": "The assessments to perform. Each assessment pairs a baseline with targets and resolved inputs."
|
|
42
42
|
},
|
|
43
43
|
"schedule": {
|
|
44
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/
|
|
44
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.0.0#/$defs/Schedule",
|
|
45
45
|
"description": "Optional scheduling configuration for recurring assessments."
|
|
46
46
|
},
|
|
47
47
|
"labels": {
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
"description": "Optional key-value labels for grouping and querying plans."
|
|
53
53
|
},
|
|
54
54
|
"integrity": {
|
|
55
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
55
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Integrity",
|
|
56
56
|
"description": "Cryptographic integrity information for verifying this plan document has not been tampered with."
|
|
57
57
|
},
|
|
58
58
|
"version": {
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
"description": "Version of this plan document."
|
|
61
61
|
},
|
|
62
62
|
"generator": {
|
|
63
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
63
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Generator",
|
|
64
64
|
"description": "Information about the tool that generated this plan."
|
|
65
65
|
}
|
|
66
66
|
},
|
|
@@ -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-results/
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-results/v3.0.0",
|
|
4
4
|
"type": "object",
|
|
5
5
|
"unevaluatedProperties": false,
|
|
6
6
|
"required": [
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"components": {
|
|
21
21
|
"type": "array",
|
|
22
22
|
"items": {
|
|
23
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/
|
|
23
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.0.0#/$defs/Component"
|
|
24
24
|
},
|
|
25
25
|
"description": "The components that were assessed. Each component describes a system element (host, container, cloud resource, application, etc.) with optional identity, SBOM, and external references."
|
|
26
26
|
},
|
|
@@ -32,27 +32,27 @@
|
|
|
32
32
|
"description": "Information on the baselines that were evaluated, including findings."
|
|
33
33
|
},
|
|
34
34
|
"statistics": {
|
|
35
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/statistics/
|
|
35
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/statistics/v3.0.0#/$defs/Statistics",
|
|
36
36
|
"description": "Statistics for the assessment run, including duration and result counts."
|
|
37
37
|
},
|
|
38
38
|
"generator": {
|
|
39
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
39
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Generator",
|
|
40
40
|
"description": "Information about the tool that generated this file."
|
|
41
41
|
},
|
|
42
42
|
"tool": {
|
|
43
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
43
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Tool",
|
|
44
44
|
"description": "The security tool that produced the assessment data in this file."
|
|
45
45
|
},
|
|
46
46
|
"integrity": {
|
|
47
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
47
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Integrity",
|
|
48
48
|
"description": "Cryptographic integrity information for verifying this file."
|
|
49
49
|
},
|
|
50
50
|
"runner": {
|
|
51
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/runner/
|
|
51
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/runner/v3.0.0#/$defs/Runner",
|
|
52
52
|
"description": "Information about the test execution environment where the security tool was run. Distinct from targets (what is being tested)."
|
|
53
53
|
},
|
|
54
54
|
"remediation": {
|
|
55
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
55
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Remediation",
|
|
56
56
|
"description": "Optional reference to automated remediation resources (Ansible playbooks, Terraform scripts, etc.) for fixing failing requirements found in this assessment."
|
|
57
57
|
},
|
|
58
58
|
"systemRef": {
|
|
@@ -154,14 +154,14 @@
|
|
|
154
154
|
],
|
|
155
155
|
"allOf": [
|
|
156
156
|
{
|
|
157
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
157
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Baseline_Metadata"
|
|
158
158
|
}
|
|
159
159
|
],
|
|
160
160
|
"properties": {
|
|
161
161
|
"depends": {
|
|
162
162
|
"type": "array",
|
|
163
163
|
"items": {
|
|
164
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
164
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Dependency"
|
|
165
165
|
},
|
|
166
166
|
"description": "The set of dependencies this baseline depends on."
|
|
167
167
|
},
|
|
@@ -174,15 +174,15 @@
|
|
|
174
174
|
"description": "The description - should be more detailed than the summary."
|
|
175
175
|
},
|
|
176
176
|
"integrity": {
|
|
177
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
177
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Integrity",
|
|
178
178
|
"description": "Cryptographic integrity information for verifying this baseline has not been tampered with."
|
|
179
179
|
},
|
|
180
180
|
"originalChecksum": {
|
|
181
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
181
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Checksum",
|
|
182
182
|
"description": "SHA-256 checksum of the original baseline definition file (before execution). This is an immutable reference to the baseline as defined, used to detect tampering with baseline requirements or metadata."
|
|
183
183
|
},
|
|
184
184
|
"resultsChecksum": {
|
|
185
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
185
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Checksum",
|
|
186
186
|
"description": "SHA-256 checksum of the raw results before any amendments (statusOverrides or POAMs). Used to detect tampering with test results. Compare with currentChecksum to verify amendment integrity."
|
|
187
187
|
},
|
|
188
188
|
"statusMessage": {
|
|
@@ -200,14 +200,14 @@
|
|
|
200
200
|
"groups": {
|
|
201
201
|
"type": "array",
|
|
202
202
|
"items": {
|
|
203
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
203
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Requirement_Group"
|
|
204
204
|
},
|
|
205
205
|
"description": "A set of descriptions for the requirement groups."
|
|
206
206
|
},
|
|
207
207
|
"inputs": {
|
|
208
208
|
"type": "array",
|
|
209
209
|
"items": {
|
|
210
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/parameter/
|
|
210
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/parameter/v3.0.0#/$defs/Input"
|
|
211
211
|
},
|
|
212
212
|
"description": "Typed inputs used to parameterize this baseline at execution time. See the Input primitive for the full schema."
|
|
213
213
|
},
|
|
@@ -232,7 +232,7 @@
|
|
|
232
232
|
],
|
|
233
233
|
"allOf": [
|
|
234
234
|
{
|
|
235
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
235
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Requirement_Core"
|
|
236
236
|
}
|
|
237
237
|
],
|
|
238
238
|
"properties": {
|
|
@@ -240,7 +240,7 @@
|
|
|
240
240
|
"type": "array",
|
|
241
241
|
"minItems": 1,
|
|
242
242
|
"items": {
|
|
243
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/
|
|
243
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.0.0#/$defs/Requirement_Description"
|
|
244
244
|
},
|
|
245
245
|
"contains": {
|
|
246
246
|
"type": "object",
|
|
@@ -256,43 +256,43 @@
|
|
|
256
256
|
"description": "Array of labeled descriptions. At least one description with label 'default' must be present. Convention: place default description first. Common labels: 'default', 'check', 'fix', 'rationale'."
|
|
257
257
|
},
|
|
258
258
|
"severity": {
|
|
259
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
259
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Severity",
|
|
260
260
|
"description": "Explicit severity rating. Typically derived from impact score but provided explicitly for clarity."
|
|
261
261
|
},
|
|
262
262
|
"sourceLocation": {
|
|
263
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
263
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Source_Location",
|
|
264
264
|
"description": "The explicit location of the requirement within the source code."
|
|
265
265
|
},
|
|
266
266
|
"results": {
|
|
267
267
|
"type": "array",
|
|
268
268
|
"minItems": 1,
|
|
269
269
|
"items": {
|
|
270
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/
|
|
270
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.0.0#/$defs/Requirement_Result"
|
|
271
271
|
},
|
|
272
272
|
"description": "The set of all tests within the requirement and their results."
|
|
273
273
|
},
|
|
274
274
|
"statusOverrides": {
|
|
275
275
|
"type": "array",
|
|
276
276
|
"items": {
|
|
277
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
277
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Status_Override"
|
|
278
278
|
},
|
|
279
279
|
"description": "Chronological history of all status overrides applied to this requirement. Status overrides are intentional changes to the compliance status (waivers, attestations). Most recent override should be first in array. Preserves full audit trail."
|
|
280
280
|
},
|
|
281
281
|
"poams": {
|
|
282
282
|
"type": "array",
|
|
283
283
|
"items": {
|
|
284
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
284
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/POAM"
|
|
285
285
|
},
|
|
286
286
|
"description": "Plan of Action and Milestones for tracking remediation, mitigation, or risk acceptance. POAMs do NOT change effectiveStatus - they track the work being done to address a failure. Separate from statusOverrides which DO change status."
|
|
287
287
|
},
|
|
288
288
|
"effectiveStatus": {
|
|
289
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/
|
|
289
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.0.0#/$defs/Result_Status",
|
|
290
290
|
"description": "The current effective status of this requirement after applying the most recent non-expired override, or computed from results if no overrides exist."
|
|
291
291
|
},
|
|
292
292
|
"evidence": {
|
|
293
293
|
"type": "array",
|
|
294
294
|
"items": {
|
|
295
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
295
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Evidence"
|
|
296
296
|
},
|
|
297
297
|
"description": "Supporting evidence for this requirement's findings, such as screenshots, code samples, or log excerpts."
|
|
298
298
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-system/
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/hdf-system/v3.0.0",
|
|
4
4
|
"title": "HDF System",
|
|
5
5
|
"description": "Describes a system's authorization boundary, components, and interconnections. Maps to OSCAL SSP system-characteristics and FedRAMP system inventory.",
|
|
6
6
|
"type": "object",
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"description": "Stable UUID (RFC 4122) for this system. Enables cross-document correlation independent of file location. Optional in casual use, expected in production documents."
|
|
17
17
|
},
|
|
18
18
|
"owner": {
|
|
19
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
19
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Identity",
|
|
20
20
|
"description": "Team or individual responsible for this system's authorization and compliance. Maps to OSCAL responsible-party with role 'system-owner'."
|
|
21
21
|
},
|
|
22
22
|
"name": {
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"description": "Description of the system's purpose and mission."
|
|
38
38
|
},
|
|
39
39
|
"authorizationStatus": {
|
|
40
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/
|
|
40
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.0.0#/$defs/Authorization_Status",
|
|
41
41
|
"description": "Current Authorization to Operate (ATO) status."
|
|
42
42
|
},
|
|
43
43
|
"authorizationDate": {
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"description": "Date the current authorization status was granted. ISO 8601 format."
|
|
47
47
|
},
|
|
48
48
|
"categorizationLevel": {
|
|
49
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/
|
|
49
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.0.0#/$defs/Categorization_Level",
|
|
50
50
|
"description": "FIPS 199 security categorization (impact level)."
|
|
51
51
|
},
|
|
52
52
|
"boundaryDescription": {
|
|
@@ -57,21 +57,21 @@
|
|
|
57
57
|
"type": "array",
|
|
58
58
|
"minItems": 1,
|
|
59
59
|
"items": {
|
|
60
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/
|
|
60
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.0.0#/$defs/Component"
|
|
61
61
|
},
|
|
62
62
|
"description": "System components within the authorization boundary. Uses the full polymorphic Component type with stable identity (componentId), external references, and SBOM support."
|
|
63
63
|
},
|
|
64
64
|
"controlDesignations": {
|
|
65
65
|
"type": "array",
|
|
66
66
|
"items": {
|
|
67
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/
|
|
67
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.0.0#/$defs/Control_Designation"
|
|
68
68
|
},
|
|
69
69
|
"description": "Declares which controls are common, hybrid, or system-specific, and which component provides them. Maps to NIST SP 800-53 control designations and OSCAL leveraged-authorizations."
|
|
70
70
|
},
|
|
71
71
|
"dataFlows": {
|
|
72
72
|
"type": "array",
|
|
73
73
|
"items": {
|
|
74
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/
|
|
74
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.0.0#/$defs/Data_Flow"
|
|
75
75
|
},
|
|
76
76
|
"description": "Inter-component data flows describing how components communicate. Supports local, cross-system, and external flows. Replaces the interconnections[] field."
|
|
77
77
|
},
|
|
@@ -83,7 +83,7 @@
|
|
|
83
83
|
"description": "Optional key-value labels for grouping and querying systems."
|
|
84
84
|
},
|
|
85
85
|
"integrity": {
|
|
86
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
86
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Integrity",
|
|
87
87
|
"description": "Cryptographic integrity information for verifying this system document has not been tampered with."
|
|
88
88
|
},
|
|
89
89
|
"version": {
|
|
@@ -91,7 +91,7 @@
|
|
|
91
91
|
"description": "Version of this system document."
|
|
92
92
|
},
|
|
93
93
|
"generator": {
|
|
94
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
94
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Generator",
|
|
95
95
|
"description": "Information about the tool that generated this system document."
|
|
96
96
|
}
|
|
97
97
|
},
|
|
@@ -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/primitives/amendments/
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.0.0",
|
|
4
4
|
"title": "HDF Amendment Primitives",
|
|
5
5
|
"description": "Types for waivers, attestations, exceptions, and POA&Ms that modify requirement compliance status.",
|
|
6
6
|
"$defs": {
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"description": "Name of the baseline containing the requirement. Required when the system has multiple baselines with potentially overlapping requirement IDs."
|
|
43
43
|
},
|
|
44
44
|
"status": {
|
|
45
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/
|
|
45
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.0.0#/$defs/Result_Status",
|
|
46
46
|
"description": "The new status this amendment sets. For POA&Ms, this is the current status (POA&Ms track work, they don't change status)."
|
|
47
47
|
},
|
|
48
48
|
"reason": {
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"description": "Justification for this amendment."
|
|
51
51
|
},
|
|
52
52
|
"appliedBy": {
|
|
53
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
53
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Identity",
|
|
54
54
|
"description": "Identity of who applied this amendment."
|
|
55
55
|
},
|
|
56
56
|
"appliedAt": {
|
|
@@ -66,22 +66,22 @@
|
|
|
66
66
|
"evidence": {
|
|
67
67
|
"type": "array",
|
|
68
68
|
"items": {
|
|
69
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
69
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Evidence"
|
|
70
70
|
},
|
|
71
71
|
"description": "Supporting evidence (screenshots, logs, URLs, documents)."
|
|
72
72
|
},
|
|
73
73
|
"signature": {
|
|
74
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
74
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Signature",
|
|
75
75
|
"description": "Digital signature for non-repudiation."
|
|
76
76
|
},
|
|
77
77
|
"previousChecksum": {
|
|
78
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
78
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Checksum",
|
|
79
79
|
"description": "Checksum of the prior amendment in the chain. Creates a tamper-evident linked list. Null for the first amendment."
|
|
80
80
|
},
|
|
81
81
|
"milestones": {
|
|
82
82
|
"type": "array",
|
|
83
83
|
"items": {
|
|
84
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
84
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Milestone"
|
|
85
85
|
},
|
|
86
86
|
"description": "Remediation milestones (primarily for POA&M type amendments)."
|
|
87
87
|
},
|
|
@@ -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/primitives/common/
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0",
|
|
4
4
|
"title": "HDF Common Primitives",
|
|
5
5
|
"description": "Shared building blocks used by hdf-results and hdf-baseline schemas.",
|
|
6
6
|
"$defs": {
|
|
@@ -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/primitives/comparison/
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/comparison/v3.0.0",
|
|
4
4
|
"title": "HDF Comparison Primitives",
|
|
5
5
|
"description": "Types for representing structured comparisons between HDF security assessment documents.",
|
|
6
6
|
"$defs": {
|
|
@@ -169,7 +169,7 @@
|
|
|
169
169
|
"description": "The original format of the source document before conversion to HDF."
|
|
170
170
|
},
|
|
171
171
|
"checksum": {
|
|
172
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
172
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Checksum",
|
|
173
173
|
"description": "Cryptographic checksum of the source document for integrity verification."
|
|
174
174
|
},
|
|
175
175
|
"assessmentTimestamp": {
|
|
@@ -178,13 +178,13 @@
|
|
|
178
178
|
"description": "When the source assessment was performed. ISO 8601 format."
|
|
179
179
|
},
|
|
180
180
|
"tool": {
|
|
181
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/
|
|
181
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0#/$defs/Tool",
|
|
182
182
|
"description": "The security tool that produced the assessment data in this source."
|
|
183
183
|
},
|
|
184
184
|
"components": {
|
|
185
185
|
"type": "array",
|
|
186
186
|
"items": {
|
|
187
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/
|
|
187
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.0.0#/$defs/Component"
|
|
188
188
|
},
|
|
189
189
|
"description": "The components assessed in this source."
|
|
190
190
|
},
|
|
@@ -700,7 +700,7 @@
|
|
|
700
700
|
"before": {
|
|
701
701
|
"oneOf": [
|
|
702
702
|
{
|
|
703
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/hdf-results/
|
|
703
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/hdf-results/v3.0.0#/$defs/Evaluated_Requirement"
|
|
704
704
|
},
|
|
705
705
|
{
|
|
706
706
|
"type": "null"
|
|
@@ -711,7 +711,7 @@
|
|
|
711
711
|
"after": {
|
|
712
712
|
"oneOf": [
|
|
713
713
|
{
|
|
714
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/hdf-results/
|
|
714
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/hdf-results/v3.0.0#/$defs/Evaluated_Requirement"
|
|
715
715
|
},
|
|
716
716
|
{
|
|
717
717
|
"type": "null"
|
|
@@ -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/primitives/component/
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/component/v3.0.0",
|
|
4
4
|
"title": "HDF Component Primitives",
|
|
5
5
|
"description": "First-class system component with identity, polymorphic type, SBOM embedding, and system-binding properties. Components are the successor to Targets, adding stable identity (componentId), external system cross-references, and software inventory.",
|
|
6
6
|
"$defs": {
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"description": "Description of this component's role or purpose."
|
|
31
31
|
},
|
|
32
32
|
"owner": {
|
|
33
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
33
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Identity",
|
|
34
34
|
"description": "Team or individual responsible for this component. Enables per-component ownership when different teams manage different parts of a system."
|
|
35
35
|
},
|
|
36
36
|
"externalIds": {
|
|
@@ -74,12 +74,12 @@
|
|
|
74
74
|
"inputOverrides": {
|
|
75
75
|
"type": "array",
|
|
76
76
|
"items": {
|
|
77
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/
|
|
77
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.0.0#/$defs/Input_Override"
|
|
78
78
|
},
|
|
79
79
|
"description": "System-specific overrides for baseline input values."
|
|
80
80
|
},
|
|
81
81
|
"targetSelector": {
|
|
82
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/
|
|
82
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.0.0#/$defs/Target_Selector",
|
|
83
83
|
"description": "Label selector to match targets belonging to this component during migration. Targets with matching labels are automatically included."
|
|
84
84
|
}
|
|
85
85
|
},
|
|
@@ -321,7 +321,7 @@
|
|
|
321
321
|
"properties": {
|
|
322
322
|
"type": { "const": "cloudAccount" },
|
|
323
323
|
"provider": {
|
|
324
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
324
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Cloud_Provider",
|
|
325
325
|
"description": "Cloud provider."
|
|
326
326
|
},
|
|
327
327
|
"accountId": {
|
|
@@ -356,7 +356,7 @@
|
|
|
356
356
|
"properties": {
|
|
357
357
|
"type": { "const": "cloudResource" },
|
|
358
358
|
"provider": {
|
|
359
|
-
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/
|
|
359
|
+
"$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Cloud_Provider",
|
|
360
360
|
"description": "Cloud provider."
|
|
361
361
|
},
|
|
362
362
|
"resourceType": {
|
|
@@ -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/primitives/data-flow/
|
|
3
|
+
"$id": "https://mitre.github.io/hdf-libs/schemas/primitives/data-flow/v3.0.0",
|
|
4
4
|
"title": "HDF Data Flow Primitives",
|
|
5
5
|
"description": "Types for describing data flows between components within a system and across system boundaries. Data flows model network connections, API calls, database queries, and other inter-component communication.",
|
|
6
6
|
"$defs": {
|