@mitre/hdf-schema 2.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/index.d.ts +6 -8
- package/dist/index.js +3 -6
- 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 +25 -20
- 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
- package/LICENSE.md +0 -55
|
@@ -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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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": {
|
|
@@ -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/
|
|
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": {
|
|
@@ -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/
|
|
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/
|
|
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": {
|
|
@@ -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/
|
|
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": {
|
|
@@ -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/
|
|
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": {
|
|
@@ -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/
|
|
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/
|
|
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
|
},
|
|
@@ -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/
|
|
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": {
|
|
@@ -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/
|
|
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/
|
|
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
|
},
|
|
@@ -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/
|
|
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/
|
|
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/
|
|
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": {
|
package/LICENSE.md
DELETED
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
# License
|
|
2
|
-
|
|
3
|
-
Copyright © 2025 The MITRE Corporation.
|
|
4
|
-
|
|
5
|
-
Approved for Public Release; Distribution Unlimited. Case Number 18-3678.
|
|
6
|
-
|
|
7
|
-
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
8
|
-
not use this file except in compliance with the License. You may obtain a
|
|
9
|
-
copy of the License at
|
|
10
|
-
|
|
11
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
-
|
|
13
|
-
Unless required by applicable law or agreed to in writing, software
|
|
14
|
-
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
15
|
-
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
16
|
-
License for the specific language governing permissions and limitations
|
|
17
|
-
under the License.
|
|
18
|
-
|
|
19
|
-
## Redistribution Terms
|
|
20
|
-
|
|
21
|
-
Redistribution and use in source and binary forms, with or without
|
|
22
|
-
modification, are permitted provided that the following conditions are
|
|
23
|
-
met:
|
|
24
|
-
|
|
25
|
-
- Redistributions of source code must retain the above copyright/digital
|
|
26
|
-
rights legend, this list of conditions and the following Notice.
|
|
27
|
-
- Redistributions in binary form must reproduce the above
|
|
28
|
-
copyright/digital rights legend, this list of conditions and the
|
|
29
|
-
following Notice in the documentation and/or other materials provided
|
|
30
|
-
with the distribution.
|
|
31
|
-
- Neither the name of The MITRE Corporation nor the names of its contributors
|
|
32
|
-
may be used to endorse or promote products derived from this software
|
|
33
|
-
without specific prior written permission.
|
|
34
|
-
|
|
35
|
-
## Notice
|
|
36
|
-
|
|
37
|
-
The MITRE Corporation grants permission to reproduce, distribute, modify, and
|
|
38
|
-
otherwise use this software to the extent permitted by the licensed terms
|
|
39
|
-
provided in the LICENSE file included with this project.
|
|
40
|
-
|
|
41
|
-
This software was produced by The MITRE Corporation for the U.S. Government
|
|
42
|
-
under contract. As such the U.S. Government has certain use and data
|
|
43
|
-
rights in this software. No use other than those granted to the U.S.
|
|
44
|
-
Government, or to those acting on behalf of the U.S. Government, under
|
|
45
|
-
these contract arrangements is authorized without the express written
|
|
46
|
-
permission of The MITRE Corporation.
|
|
47
|
-
|
|
48
|
-
Some files in this codebase were generated by generative AI, under the
|
|
49
|
-
direction and review of The MITRE Corporation employees, for the purpose of
|
|
50
|
-
development efficiency. All AI-generated code functionality was validated
|
|
51
|
-
by standard quality and assurance testing.
|
|
52
|
-
|
|
53
|
-
For further information, please contact The MITRE Corporation,
|
|
54
|
-
Contracts Management Office, 7515 Colshire Drive, McLean, VA 22102-7539,
|
|
55
|
-
(703) 983-6000.
|