@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.
Files changed (38) hide show
  1. package/README.md +20 -14
  2. package/dist/go/go.mod +2 -2
  3. package/dist/go/hdf.go +570 -210
  4. package/dist/helpers.d.ts +5 -1
  5. package/dist/index.d.ts +27 -52
  6. package/dist/index.js +30 -48
  7. package/dist/schemas/hdf-amendments.schema.json +565 -45
  8. package/dist/schemas/hdf-baseline.schema.json +570 -50
  9. package/dist/schemas/hdf-comparison.schema.json +820 -103
  10. package/dist/schemas/hdf-evidence-package.schema.json +564 -44
  11. package/dist/schemas/hdf-plan.schema.json +571 -50
  12. package/dist/schemas/hdf-results.schema.json +777 -80
  13. package/dist/schemas/hdf-system.schema.json +596 -59
  14. package/dist/ts/hdf.d.ts +3562 -0
  15. package/dist/ts/hdf.js +564 -0
  16. package/dist/ts/hdf.ts +3623 -0
  17. package/package.json +18 -17
  18. package/dist/ts/hdf-amendments.d.ts +0 -474
  19. package/dist/ts/hdf-amendments.js +0 -88
  20. package/dist/ts/hdf-amendments.ts +0 -486
  21. package/dist/ts/hdf-baseline.d.ts +0 -472
  22. package/dist/ts/hdf-baseline.js +0 -58
  23. package/dist/ts/hdf-baseline.ts +0 -483
  24. package/dist/ts/hdf-comparison.d.ts +0 -1185
  25. package/dist/ts/hdf-comparison.js +0 -216
  26. package/dist/ts/hdf-comparison.ts +0 -1210
  27. package/dist/ts/hdf-evidence-package.d.ts +0 -348
  28. package/dist/ts/hdf-evidence-package.js +0 -39
  29. package/dist/ts/hdf-evidence-package.ts +0 -356
  30. package/dist/ts/hdf-plan.d.ts +0 -204
  31. package/dist/ts/hdf-plan.js +0 -23
  32. package/dist/ts/hdf-plan.ts +0 -205
  33. package/dist/ts/hdf-results.d.ts +0 -1511
  34. package/dist/ts/hdf-results.js +0 -194
  35. package/dist/ts/hdf-results.ts +0 -1536
  36. package/dist/ts/hdf-system.d.ts +0 -609
  37. package/dist/ts/hdf-system.js +0 -102
  38. package/dist/ts/hdf-system.ts +0 -617
@@ -1,194 +0,0 @@
1
- /**
2
- * The comparison operator used when evaluating this input against observed values.
3
- *
4
- * Comparison operator for evaluating the input value against observed values. Numeric:
5
- * eq/ne/lt/le/gt/ge. String: eq/ne/contains/matches. Collection: in/notIn.
6
- */
7
- export var ComparisonOperator;
8
- (function (ComparisonOperator) {
9
- ComparisonOperator["Contains"] = "contains";
10
- ComparisonOperator["Eq"] = "eq";
11
- ComparisonOperator["Ge"] = "ge";
12
- ComparisonOperator["Gt"] = "gt";
13
- ComparisonOperator["In"] = "in";
14
- ComparisonOperator["LE"] = "le";
15
- ComparisonOperator["Lt"] = "lt";
16
- ComparisonOperator["Matches"] = "matches";
17
- ComparisonOperator["Ne"] = "ne";
18
- ComparisonOperator["NotIn"] = "notIn";
19
- })(ComparisonOperator || (ComparisonOperator = {}));
20
- /**
21
- * The data type of this input.
22
- *
23
- * The data type of the input value. Aligns with InSpec input types.
24
- */
25
- export var InputType;
26
- (function (InputType) {
27
- InputType["Array"] = "Array";
28
- InputType["Boolean"] = "Boolean";
29
- InputType["Hash"] = "Hash";
30
- InputType["Numeric"] = "Numeric";
31
- InputType["Regexp"] = "Regexp";
32
- InputType["String"] = "String";
33
- })(InputType || (InputType = {}));
34
- /**
35
- * The hash algorithm used for the checksum.
36
- *
37
- * Supported cryptographic hash algorithms for checksums and integrity verification.
38
- */
39
- export var HashAlgorithm;
40
- (function (HashAlgorithm) {
41
- HashAlgorithm["Sha256"] = "sha256";
42
- HashAlgorithm["Sha384"] = "sha384";
43
- HashAlgorithm["Sha512"] = "sha512";
44
- })(HashAlgorithm || (HashAlgorithm = {}));
45
- /**
46
- * The type of the most recent non-expired override or POAM governing this requirement.
47
- * Indicates why the requirement is in its current state (e.g., waiver, falsePositive,
48
- * riskAdjustment) or what remediation is being tracked (poam). Absent when no overrides or
49
- * POAMs apply.
50
- *
51
- * The type of amendment, aligned with FedRAMP deviation request categories. 'waiver': risk
52
- * accepted by Authorizing Official. 'attestation': manually verified by assessor. 'poam':
53
- * remediation tracked (no status change). 'inherited': control provided by another
54
- * component or system. 'falsePositive': scanner incorrectly identified a finding — for
55
- * compliance scans (STIG, CIS), the check actually passes, so status is typically set to
56
- * 'passed'; for vulnerability scans (CVE, SCA), the flagged vulnerability does not apply to
57
- * this system, so status is typically set to 'notApplicable'. The disposition field on the
58
- * requirement distinguishes false positives from genuinely not-applicable findings.
59
- * 'riskAdjustment': impact score adjusted based on environmental context (FedRAMP Risk
60
- * Adjustment); does not change pass/fail status, only impact via the impact field.
61
- * 'operationalRequirement': deviation required by operational constraints (FedRAMP
62
- * Operational Requirement); the finding cannot be remediated because the system requires
63
- * the affected functionality. Remains an open risk. Migration note: 'exception' was removed
64
- * in v3.1.0 — use 'waiver' with status 'notApplicable' instead.
65
- *
66
- * The type of override applied to this requirement.
67
- */
68
- export var OverrideType;
69
- (function (OverrideType) {
70
- OverrideType["Attestation"] = "attestation";
71
- OverrideType["FalsePositive"] = "falsePositive";
72
- OverrideType["Inherited"] = "inherited";
73
- OverrideType["OperationalRequirement"] = "operationalRequirement";
74
- OverrideType["Poam"] = "poam";
75
- OverrideType["RiskAdjustment"] = "riskAdjustment";
76
- OverrideType["Waiver"] = "waiver";
77
- })(OverrideType || (OverrideType = {}));
78
- /**
79
- * The current effective compliance status of this requirement after applying the most
80
- * recent non-expired override with a status field, or computed from results (worst-wins) if
81
- * no status-bearing overrides exist.
82
- *
83
- * The status of an individual test result. 'notApplicable' indicates the requirement does
84
- * not apply to the target. 'notReviewed' indicates the requirement was not assessed (e.g.,
85
- * requires manual verification).
86
- *
87
- * The status of this test within the requirement. Example: 'failed'.
88
- *
89
- * The new status this override sets for the requirement. Optional when only impact is being
90
- * overridden.
91
- */
92
- export var ResultStatus;
93
- (function (ResultStatus) {
94
- ResultStatus["Error"] = "error";
95
- ResultStatus["Failed"] = "failed";
96
- ResultStatus["NotApplicable"] = "notApplicable";
97
- ResultStatus["NotReviewed"] = "notReviewed";
98
- ResultStatus["Passed"] = "passed";
99
- })(ResultStatus || (ResultStatus = {}));
100
- /**
101
- * The type of identifier. Use 'email' for email addresses, 'username' for user accounts,
102
- * 'system' for automated systems, 'simple' for basic string identifiers without additional
103
- * classification, or 'other' for custom identity systems.
104
- */
105
- export var OperatorType;
106
- (function (OperatorType) {
107
- OperatorType["Email"] = "email";
108
- OperatorType["Other"] = "other";
109
- OperatorType["Simple"] = "simple";
110
- OperatorType["System"] = "system";
111
- OperatorType["Username"] = "username";
112
- })(OperatorType || (OperatorType = {}));
113
- /**
114
- * The type of evidence being provided.
115
- */
116
- export var EvidenceType;
117
- (function (EvidenceType) {
118
- EvidenceType["Code"] = "code";
119
- EvidenceType["File"] = "file";
120
- EvidenceType["Log"] = "log";
121
- EvidenceType["Other"] = "other";
122
- EvidenceType["Screenshot"] = "screenshot";
123
- EvidenceType["URL"] = "url";
124
- })(EvidenceType || (EvidenceType = {}));
125
- /**
126
- * Current status of this milestone.
127
- */
128
- export var Status;
129
- (function (Status) {
130
- Status["Completed"] = "completed";
131
- Status["InProgress"] = "inProgress";
132
- Status["Pending"] = "pending";
133
- })(Status || (Status = {}));
134
- /**
135
- * The type of POA&M. 'remediation' fixes root cause. 'mitigation' reduces risk via
136
- * compensating controls. 'riskAcceptance' documents decision to accept risk.
137
- * 'vendorDependency' tracks a fix that depends on a vendor releasing a patch or update.
138
- */
139
- export var PoamType;
140
- (function (PoamType) {
141
- PoamType["Mitigation"] = "mitigation";
142
- PoamType["Remediation"] = "remediation";
143
- PoamType["RiskAcceptance"] = "riskAcceptance";
144
- PoamType["VendorDependency"] = "vendorDependency";
145
- })(PoamType || (PoamType = {}));
146
- /**
147
- * Explicit severity rating. Typically derived from impact score but provided explicitly for
148
- * clarity.
149
- *
150
- * Severity rating for a requirement. Typically derived from the numeric impact score.
151
- */
152
- export var Severity;
153
- (function (Severity) {
154
- Severity["Critical"] = "critical";
155
- Severity["High"] = "high";
156
- Severity["Informational"] = "informational";
157
- Severity["Low"] = "low";
158
- Severity["Medium"] = "medium";
159
- })(Severity || (Severity = {}));
160
- export var CloudProvider;
161
- (function (CloudProvider) {
162
- CloudProvider["Aws"] = "aws";
163
- CloudProvider["Azure"] = "azure";
164
- CloudProvider["Gcp"] = "gcp";
165
- CloudProvider["Oci"] = "oci";
166
- CloudProvider["Other"] = "other";
167
- })(CloudProvider || (CloudProvider = {}));
168
- /**
169
- * Format of the SBOM (embedded or referenced). Required when sbom or sbomRef is present.
170
- */
171
- export var SbomFormat;
172
- (function (SbomFormat) {
173
- SbomFormat["Cyclonedx"] = "cyclonedx";
174
- SbomFormat["Spdx"] = "spdx";
175
- })(SbomFormat || (SbomFormat = {}));
176
- /**
177
- * A human readable/meaningful reference. Example: a book title.
178
- *
179
- * IP address of the host.
180
- */
181
- export var Copyright;
182
- (function (Copyright) {
183
- Copyright["Application"] = "application";
184
- Copyright["Artifact"] = "artifact";
185
- Copyright["CloudAccount"] = "cloudAccount";
186
- Copyright["CloudResource"] = "cloudResource";
187
- Copyright["ContainerImage"] = "containerImage";
188
- Copyright["ContainerInstance"] = "containerInstance";
189
- Copyright["ContainerPlatform"] = "containerPlatform";
190
- Copyright["Database"] = "database";
191
- Copyright["Host"] = "host";
192
- Copyright["Network"] = "network";
193
- Copyright["Repository"] = "repository";
194
- })(Copyright || (Copyright = {}));