@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.
Files changed (31) hide show
  1. package/README.md +14 -2
  2. package/dist/helpers.js +4 -44
  3. package/dist/schemas/hdf-amendments.schema.json +33 -33
  4. package/dist/schemas/hdf-baseline.schema.json +38 -38
  5. package/dist/schemas/hdf-comparison.schema.json +88 -88
  6. package/dist/schemas/hdf-evidence-package.schema.json +32 -32
  7. package/dist/schemas/hdf-plan.schema.json +38 -38
  8. package/dist/schemas/hdf-results.schema.json +67 -67
  9. package/dist/schemas/hdf-system.schema.json +47 -47
  10. package/package.json +2 -1
  11. package/src/schemas/hdf-amendments.schema.json +7 -7
  12. package/src/schemas/hdf-baseline.schema.json +10 -10
  13. package/src/schemas/hdf-comparison.schema.json +13 -13
  14. package/src/schemas/hdf-evidence-package.schema.json +6 -6
  15. package/src/schemas/hdf-plan.schema.json +6 -6
  16. package/src/schemas/hdf-results.schema.json +24 -24
  17. package/src/schemas/hdf-system.schema.json +9 -9
  18. package/src/schemas/primitives/amendments.schema.json +7 -7
  19. package/src/schemas/primitives/common.schema.json +1 -1
  20. package/src/schemas/primitives/comparison.schema.json +6 -6
  21. package/src/schemas/primitives/component.schema.json +6 -6
  22. package/src/schemas/primitives/data-flow.schema.json +1 -1
  23. package/src/schemas/primitives/extensions.schema.json +13 -13
  24. package/src/schemas/primitives/parameter.schema.json +1 -1
  25. package/src/schemas/primitives/plan.schema.json +2 -2
  26. package/src/schemas/primitives/platform.schema.json +1 -1
  27. package/src/schemas/primitives/result.schema.json +1 -1
  28. package/src/schemas/primitives/runner.schema.json +2 -2
  29. package/src/schemas/primitives/statistics.schema.json +1 -1
  30. package/src/schemas/primitives/system.schema.json +2 -2
  31. package/src/schemas/primitives/target.schema.json +3 -3
package/src/schemas/primitives/extensions.schema.json CHANGED
@@ -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/extensions/v2.0.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.0.0",
4
4
  "title": "HDF Extension Primitives",
5
5
  "description": "Extension types for waivers, attestations, generators, and integrity.",
6
6
  "$defs": {
@@ -17,11 +17,11 @@
17
17
  ],
18
18
  "properties": {
19
19
  "type": {
20
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v2.0.0#/$defs/Override_Type",
20
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.0.0#/$defs/Override_Type",
21
21
  "description": "The type of status override applied to this requirement."
22
22
  },
23
23
  "status": {
24
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v2.0.0#/$defs/Result_Status",
24
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.0.0#/$defs/Result_Status",
25
25
  "description": "The new status this override sets for the requirement. This intentionally changes the compliance status."
26
26
  },
27
27
  "reason": {
@@ -29,7 +29,7 @@
29
29
  "description": "Explanation for why this status override was applied."
30
30
  },
31
31
  "appliedBy": {
32
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Identity",
32
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Identity",
33
33
  "description": "Identity of who applied this status override. For simple cases, use type 'simple' with just an identifier."
34
34
  },
35
35
  "appliedAt": {
@@ -43,18 +43,18 @@
43
43
  "description": "Timestamp when this status override expires and must be reviewed/renewed. REQUIRED - no permanent status overrides allowed. ISO 8601 format."
44
44
  },
45
45
  "signature": {
46
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Signature",
46
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Signature",
47
47
  "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."
48
48
  },
49
49
  "evidence": {
50
50
  "type": "array",
51
51
  "items": {
52
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Evidence"
52
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Evidence"
53
53
  },
54
54
  "description": "Supporting evidence for this status override, such as screenshots demonstrating manual verification for attestations."
55
55
  },
56
56
  "previousChecksum": {
57
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Checksum",
57
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Checksum",
58
58
  "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."
59
59
  }
60
60
  },
@@ -124,7 +124,7 @@
124
124
  "description": "Detailed explanation of the plan, including what actions will be taken."
125
125
  },
126
126
  "appliedBy": {
127
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Identity",
127
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Identity",
128
128
  "description": "Identity of who created this POA&M. For simple cases, use type 'simple' with just an identifier."
129
129
  },
130
130
  "appliedAt": {
@@ -140,23 +140,23 @@
140
140
  "milestones": {
141
141
  "type": "array",
142
142
  "items": {
143
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Milestone"
143
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Milestone"
144
144
  },
145
145
  "description": "Optional array of milestones tracking progress toward completion."
146
146
  },
147
147
  "signature": {
148
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Signature",
148
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Signature",
149
149
  "description": "Optional digital signature for enhanced trust and non-repudiation."
150
150
  },
151
151
  "evidence": {
152
152
  "type": "array",
153
153
  "items": {
154
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Evidence"
154
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Evidence"
155
155
  },
156
156
  "description": "Supporting evidence for this POA&M, such as documentation of compensating controls or mitigation implementation."
157
157
  },
158
158
  "previousChecksum": {
159
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Checksum",
159
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Checksum",
160
160
  "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."
161
161
  }
162
162
  },
@@ -307,7 +307,7 @@
307
307
  },
308
308
  "properties": {
309
309
  "algorithm": {
310
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Hash_Algorithm",
310
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Hash_Algorithm",
311
311
  "description": "The hash algorithm used for the checksum."
312
312
  },
313
313
  "checksum": {
package/src/schemas/primitives/parameter.schema.json CHANGED
@@ -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/parameter/v2.0.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/parameter/v3.0.0",
4
4
  "title": "HDF Parameter Primitives",
5
5
  "description": "Input/parameter type definitions for typed, traceable configuration values that bridge governance prose and scanner automation.",
6
6
  "$defs": {
package/src/schemas/primitives/plan.schema.json CHANGED
@@ -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/plan/v2.0.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/plan/v3.0.0",
4
4
  "title": "HDF Plan Primitives",
5
5
  "description": "Types for defining assessment plans — what to scan, how to configure it, and when to run.",
6
6
  "$defs": {
@@ -48,7 +48,7 @@
48
48
  "description": "componentId of the system component this assessment targets. Use for direct component binding. Alternative to targetSelector."
49
49
  },
50
50
  "targetSelector": {
51
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v2.0.0#/$defs/Target_Selector",
51
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.0.0#/$defs/Target_Selector",
52
52
  "description": "Label selector to match targets for this assessment. Overrides the system component's targetSelector if provided."
53
53
  },
54
54
  "inputs": {
package/src/schemas/primitives/platform.schema.json CHANGED
@@ -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/platform/v2.0.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/platform/v3.0.0",
4
4
  "title": "HDF Platform Primitive",
5
5
  "description": "Legacy platform information for backward compatibility with existing HDF documents.",
6
6
  "$defs": {
package/src/schemas/primitives/result.schema.json CHANGED
@@ -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/result/v2.0.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.0.0",
4
4
  "title": "HDF Result Primitives",
5
5
  "description": "Types for representing assessment results and statuses.",
6
6
  "$defs": {
package/src/schemas/primitives/runner.schema.json CHANGED
@@ -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/runner/v2.0.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/runner/v3.0.0",
4
4
  "title": "HDF Runner Primitive",
5
5
  "description": "Information about the test execution environment where the security tool/scanner was executed.",
6
6
  "$defs": {
@@ -34,7 +34,7 @@
34
34
  "description": "The container instance identifier. Example: 'a1b2c3d4e5f6', 'security-scan-job-xyz123'. Can be a Docker container ID, Kubernetes pod name, or other container runtime identifier."
35
35
  },
36
36
  "operator": {
37
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Identity",
37
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Identity",
38
38
  "description": "The identity of the person or system responsible for executing the test. This could be a human auditor manually completing a checklist, an automated CI/CD system, or a security tool. Optional field to support both automated and manual HDF generation."
39
39
  }
40
40
  },
package/src/schemas/primitives/statistics.schema.json CHANGED
@@ -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/statistics/v2.0.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/statistics/v3.0.0",
4
4
  "title": "HDF Statistics Primitives",
5
5
  "description": "Statistics types for tracking assessment run metrics.",
6
6
  "$defs": {
package/src/schemas/primitives/system.schema.json CHANGED
@@ -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/system/v2.0.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/system/v3.0.0",
4
4
  "title": "HDF System Primitives",
5
5
  "description": "Types for describing system architecture, authorization boundaries, and components.",
6
6
  "$defs": {
@@ -51,7 +51,7 @@
51
51
  "description": "Rationale for why this override is needed."
52
52
  },
53
53
  "approvedBy": {
54
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Identity",
54
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Identity",
55
55
  "description": "Identity of the person or system that approved this override."
56
56
  }
57
57
  },
package/src/schemas/primitives/target.schema.json CHANGED
@@ -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/target/v2.0.0",
3
+ "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/target/v3.0.0",
4
4
  "title": "HDF Target Primitives",
5
5
  "description": "Polymorphic target system supporting diverse scan targets from 35+ security tools.",
6
6
  "$defs": {
@@ -266,7 +266,7 @@
266
266
  "const": "cloudAccount"
267
267
  },
268
268
  "provider": {
269
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Cloud_Provider",
269
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Cloud_Provider",
270
270
  "description": "Cloud provider."
271
271
  },
272
272
  "accountId": {
@@ -295,7 +295,7 @@
295
295
  "const": "cloudResource"
296
296
  },
297
297
  "provider": {
298
- "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v2.0.0#/$defs/Cloud_Provider",
298
+ "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.0.0#/$defs/Cloud_Provider",
299
299
  "description": "Cloud provider."
300
300
  },
301
301
  "resourceType": {