@mitre/hdf-schema 3.2.0 → 3.3.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 (37) hide show
  1. package/README.md +15 -16
  2. package/dist/go/hdf.go +398 -134
  3. package/dist/helpers.d.ts +1 -1
  4. package/dist/index.d.ts +27 -52
  5. package/dist/index.js +30 -48
  6. package/dist/schemas/hdf-amendments.schema.json +466 -45
  7. package/dist/schemas/hdf-baseline.schema.json +471 -50
  8. package/dist/schemas/hdf-comparison.schema.json +721 -103
  9. package/dist/schemas/hdf-evidence-package.schema.json +465 -44
  10. package/dist/schemas/hdf-plan.schema.json +472 -50
  11. package/dist/schemas/hdf-results.schema.json +678 -80
  12. package/dist/schemas/hdf-system.schema.json +497 -59
  13. package/dist/ts/hdf.d.ts +3562 -0
  14. package/dist/ts/hdf.js +564 -0
  15. package/dist/ts/hdf.ts +3623 -0
  16. package/package.json +18 -17
  17. package/dist/ts/hdf-amendments.d.ts +0 -474
  18. package/dist/ts/hdf-amendments.js +0 -88
  19. package/dist/ts/hdf-amendments.ts +0 -486
  20. package/dist/ts/hdf-baseline.d.ts +0 -549
  21. package/dist/ts/hdf-baseline.js +0 -110
  22. package/dist/ts/hdf-baseline.ts +0 -563
  23. package/dist/ts/hdf-comparison.d.ts +0 -1185
  24. package/dist/ts/hdf-comparison.js +0 -216
  25. package/dist/ts/hdf-comparison.ts +0 -1210
  26. package/dist/ts/hdf-evidence-package.d.ts +0 -348
  27. package/dist/ts/hdf-evidence-package.js +0 -39
  28. package/dist/ts/hdf-evidence-package.ts +0 -356
  29. package/dist/ts/hdf-plan.d.ts +0 -204
  30. package/dist/ts/hdf-plan.js +0 -23
  31. package/dist/ts/hdf-plan.ts +0 -205
  32. package/dist/ts/hdf-results.d.ts +0 -1588
  33. package/dist/ts/hdf-results.js +0 -246
  34. package/dist/ts/hdf-results.ts +0 -1616
  35. package/dist/ts/hdf-system.d.ts +0 -609
  36. package/dist/ts/hdf-system.js +0 -102
  37. package/dist/ts/hdf-system.ts +0 -617
@@ -1,216 +0,0 @@
1
- /**
2
- * The category of this annotation.
3
- *
4
- * The category of an annotation attached to a comparison.
5
- */
6
- export var AnnotationCategory;
7
- (function (AnnotationCategory) {
8
- AnnotationCategory["BaselineChange"] = "baselineChange";
9
- AnnotationCategory["Drift"] = "drift";
10
- AnnotationCategory["Remediation"] = "remediation";
11
- AnnotationCategory["ScannerNote"] = "scannerNote";
12
- AnnotationCategory["Waiver"] = "waiver";
13
- })(AnnotationCategory || (AnnotationCategory = {}));
14
- /**
15
- * The state of this baseline in the comparison.
16
- *
17
- * The state of this component in the comparison.
18
- */
19
- export var BaselineDiffState;
20
- (function (BaselineDiffState) {
21
- BaselineDiffState["Absent"] = "absent";
22
- BaselineDiffState["New"] = "new";
23
- BaselineDiffState["Unchanged"] = "unchanged";
24
- BaselineDiffState["Updated"] = "updated";
25
- })(BaselineDiffState || (BaselineDiffState = {}));
26
- /**
27
- * The mode of comparison being performed.
28
- *
29
- * The mode of comparison. 'temporal' compares the same target over time. 'baseline'
30
- * compares against a golden reference. 'fleet' compares across multiple systems.
31
- * 'multiSource' compares outputs from different scanners. 'baselineEvolution' compares two
32
- * baseline documents to detect requirement changes between versions. 'systemDrift' compares
33
- * two system documents to detect component-level changes.
34
- */
35
- export var ComparisonMode;
36
- (function (ComparisonMode) {
37
- ComparisonMode["Baseline"] = "baseline";
38
- ComparisonMode["BaselineEvolution"] = "baselineEvolution";
39
- ComparisonMode["Fleet"] = "fleet";
40
- ComparisonMode["MultiSource"] = "multiSource";
41
- ComparisonMode["SystemDrift"] = "systemDrift";
42
- ComparisonMode["Temporal"] = "temporal";
43
- })(ComparisonMode || (ComparisonMode = {}));
44
- /**
45
- * The type of change operation.
46
- */
47
- export var Op;
48
- (function (Op) {
49
- Op["Add"] = "add";
50
- Op["Remove"] = "remove";
51
- Op["Replace"] = "replace";
52
- })(Op || (Op = {}));
53
- /**
54
- * The reason a requirement's state changed between sources.
55
- */
56
- export var ChangeReason;
57
- (function (ChangeReason) {
58
- ChangeReason["BaselineUpgraded"] = "baselineUpgraded";
59
- ChangeReason["ConfigChanged"] = "configChanged";
60
- ChangeReason["ControlMapped"] = "controlMapped";
61
- ChangeReason["ImpactChanged"] = "impactChanged";
62
- ChangeReason["MetadataChanged"] = "metadataChanged";
63
- ChangeReason["OverrideAdded"] = "overrideAdded";
64
- ChangeReason["OverrideExpired"] = "overrideExpired";
65
- ChangeReason["OverrideModified"] = "overrideModified";
66
- ChangeReason["OverrideRemoved"] = "overrideRemoved";
67
- ChangeReason["ResultChanged"] = "resultChanged";
68
- ChangeReason["ScannerChanged"] = "scannerChanged";
69
- ChangeReason["TargetChanged"] = "targetChanged";
70
- })(ChangeReason || (ChangeReason = {}));
71
- /**
72
- * How the conflict was resolved.
73
- *
74
- * How a conflict between multiple scanner results was resolved.
75
- */
76
- export var ConflictResolution;
77
- (function (ConflictResolution) {
78
- ConflictResolution["Manual"] = "manual";
79
- ConflictResolution["MostRecent"] = "mostRecent";
80
- ConflictResolution["MostSevere"] = "mostSevere";
81
- ConflictResolution["Unresolved"] = "unresolved";
82
- })(ConflictResolution || (ConflictResolution = {}));
83
- /**
84
- * The strategy that was used to match this requirement across sources.
85
- *
86
- * The strategy used to match requirements across sources. 'exactId' matches by identical
87
- * IDs. 'mappedId' uses an ID mapping table. 'cciMatch'/'nistMatch' match by framework
88
- * identifiers. 'fuzzyTitle'/'fuzzyContent' use text similarity.
89
- *
90
- * The primary strategy used to match requirements across sources.
91
- */
92
- export var MatchStrategy;
93
- (function (MatchStrategy) {
94
- MatchStrategy["CciMatch"] = "cciMatch";
95
- MatchStrategy["ExactID"] = "exactId";
96
- MatchStrategy["FuzzyContent"] = "fuzzyContent";
97
- MatchStrategy["FuzzyTitle"] = "fuzzyTitle";
98
- MatchStrategy["MappedID"] = "mappedId";
99
- MatchStrategy["NISTMatch"] = "nistMatch";
100
- })(MatchStrategy || (MatchStrategy = {}));
101
- /**
102
- * The state of this requirement in the comparison.
103
- *
104
- * SARIF-compatible vocabulary extended for security. 'new' = present only in new source,
105
- * 'absent' = present only in old, 'unchanged' = same effective status, 'updated' = status
106
- * changed (generic), 'fixed' = was failing now passing, 'regressed' = was passing now
107
- * failing, 'moved' = reorganized same content, 'split'/'merged' = reserved for v1.1.
108
- */
109
- export var RequirementState;
110
- (function (RequirementState) {
111
- RequirementState["Absent"] = "absent";
112
- RequirementState["Fixed"] = "fixed";
113
- RequirementState["Merged"] = "merged";
114
- RequirementState["Moved"] = "moved";
115
- RequirementState["New"] = "new";
116
- RequirementState["Regressed"] = "regressed";
117
- RequirementState["Split"] = "split";
118
- RequirementState["Unchanged"] = "unchanged";
119
- RequirementState["Updated"] = "updated";
120
- })(RequirementState || (RequirementState = {}));
121
- export var FormatVersion;
122
- (function (FormatVersion) {
123
- FormatVersion["The100"] = "1.0.0";
124
- })(FormatVersion || (FormatVersion = {}));
125
- /**
126
- * The hash algorithm used for the checksum.
127
- *
128
- * Supported cryptographic hash algorithms for checksums and integrity verification.
129
- */
130
- export var HashAlgorithm;
131
- (function (HashAlgorithm) {
132
- HashAlgorithm["Sha256"] = "sha256";
133
- HashAlgorithm["Sha384"] = "sha384";
134
- HashAlgorithm["Sha512"] = "sha512";
135
- })(HashAlgorithm || (HashAlgorithm = {}));
136
- /**
137
- * The state of this package: added (new in new SBOM), removed (absent from new SBOM),
138
- * updated (version changed), unchanged.
139
- */
140
- export var PackageDiffState;
141
- (function (PackageDiffState) {
142
- PackageDiffState["Added"] = "added";
143
- PackageDiffState["Removed"] = "removed";
144
- PackageDiffState["Unchanged"] = "unchanged";
145
- PackageDiffState["Updated"] = "updated";
146
- })(PackageDiffState || (PackageDiffState = {}));
147
- /**
148
- * The type of identifier. Use 'email' for email addresses, 'username' for user accounts,
149
- * 'system' for automated systems, 'simple' for basic string identifiers without additional
150
- * classification, or 'other' for custom identity systems.
151
- */
152
- export var Type;
153
- (function (Type) {
154
- Type["Email"] = "email";
155
- Type["Other"] = "other";
156
- Type["Simple"] = "simple";
157
- Type["System"] = "system";
158
- Type["Username"] = "username";
159
- })(Type || (Type = {}));
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
- * IP address of the host.
178
- */
179
- export var Description;
180
- (function (Description) {
181
- Description["Application"] = "application";
182
- Description["Artifact"] = "artifact";
183
- Description["CloudAccount"] = "cloudAccount";
184
- Description["CloudResource"] = "cloudResource";
185
- Description["ContainerImage"] = "containerImage";
186
- Description["ContainerInstance"] = "containerInstance";
187
- Description["ContainerPlatform"] = "containerPlatform";
188
- Description["Database"] = "database";
189
- Description["Host"] = "host";
190
- Description["Network"] = "network";
191
- Description["Repository"] = "repository";
192
- })(Description || (Description = {}));
193
- /**
194
- * The original format of the source document before conversion to HDF.
195
- */
196
- export var OriginalFormat;
197
- (function (OriginalFormat) {
198
- OriginalFormat["HdfV2"] = "hdf-v2";
199
- OriginalFormat["InspecV1"] = "inspec-v1";
200
- OriginalFormat["OscalAr"] = "oscal-ar";
201
- OriginalFormat["Sarif"] = "sarif";
202
- OriginalFormat["Xccdf"] = "xccdf";
203
- })(OriginalFormat || (OriginalFormat = {}));
204
- /**
205
- * The role of this source in the comparison.
206
- *
207
- * The role of a source document in the comparison.
208
- */
209
- export var SourceRole;
210
- (function (SourceRole) {
211
- SourceRole["Golden"] = "golden";
212
- SourceRole["New"] = "new";
213
- SourceRole["Old"] = "old";
214
- SourceRole["Reference"] = "reference";
215
- SourceRole["System"] = "system";
216
- })(SourceRole || (SourceRole = {}));