@mitre/hdf-converters 2.12.2 → 2.13.0

package/lib/types/neuvector-types.d.ts

@@ -102,3 +102,4 @@ export type NeuVectorScanJson = {
     error_message: string;
 };
 export {};
+//# sourceMappingURL=neuvector-types.d.ts.map

package/lib/types/neuvector-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"neuvector-types.d.ts","sourceRoot":"","sources":["../../types/neuvector-types.ts"],"names":[],"mappings":"AAiFA,MAAM,MAAM,iBAAiB,GAAG;IAE9B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAqB;IAElC,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAqB;IAErC,UAAU,EAAE,MAAM,CAAC;IAEnB,mBAAmB,EAAE,MAAM,CAAmB;IAC9C,uBAAuB,EAAE,MAAM,CAAmB;IAClD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GAAG,cAAc,CAAC;AAEnB,KAAK,cAAc,GAAG;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAA8B,CAAC;CAChE,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,sBAAsB,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,eAAe,EAAE,iBAAiB,EAAE,CAAC;IACrC,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAE3B,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAElC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,cAAc,CAAC,EAAE,qBAAqB,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAmB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,aAAa,EAAE,CAAC;CACzB,GAAG,cAAc,CAAC;AAEnB,KAAK,aAAa,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,iBAAiB,EAAE,CAAC;IACrC,IAAI,EAAE,MAAM,CAAmB;CAChC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC"}

package/lib/types/neuvector-types.js

@@ -1,3 +1,83 @@
 "use strict";
+/* Types are generated with Tygo, from original Golang source code to TypeScript, and tweaked to reflect actual outputted JSON.
+
+// Dockerfile
+```
+FROM alpine:3.12 AS clone
+# If using a VPN, install certificates for `git clone` to work
+ADD <URLs to CA certificates>
+RUN update-ca-certificates
+git clone https://github.com/neuvector/neuvector.git
+FROM golang:1.23.0 AS build
+# If using a VPN, install certificates for `go install` to work
+ADD <URLs to CA certificates>
+RUN update-ca-certificates
+go install github.com/gzuidhof/tygo@latest
+WORKDIR /go/neuvector
+COPY --from=clone /neuvector .
+COPY tygo.yaml .
+```
+
+// tygo.yaml
+```
+packages:
+  - path: 'github.com/neuvector/neuvector/controller/api'
+    output_path: '/go/output/neuvector-generated-types.ts'
+```
+
+// docker-compose.yml
+```
+services:
+  # Generates neuvector/scanner TypeScript types from its Golang source code
+  go2ts:
+    container_name: tygo
+    volumes:
+      - './tygo-output/:/go/output/'
+    build:
+      dockerfile: Dockerfile
+    tty: true
+    command: tygo generate
+```
+
+// `docker compose` command to regenerate Tygo types: `docker compose up --build go2ts`. Output file will be `./tygo-output/neuvector-generated-types.ts`.
+Some of the generated types are copied into and defined in this file. The currently-used generated types begin with `REST`, and some of the generated types are tweaked such that when they have a field beginning with `REST`, the field is intersected instead. For example:
+```
+type RESTScanRepoReport = {
+  verdict?: string;
+  image_id: string;
+  registry: string;
+  repository: string;
+  tag: string;
+  digest: string;
+  size: number;
+  author: string;
+  base_os: string;
+  created_at: string;
+  cvedb_version: string;
+  cvedb_create_time: string;
+  layers: RESTScanLayer[];
+} & RESTScanReport;
+```
+was tweaked from the generated
+```
+export interface RESTScanRepoReport {
+  verdict?: string;
+  image_id: string;
+  registry: string;
+  repository: string;
+  tag: string;
+  digest: string;
+  size: number;
+  author: string;
+  base_os: string;
+  created_at: string;
+  cvedb_version: string;
+  cvedb_create_time: string;
+  layers: (RESTScanLayer | undefined)[];
+  RESTScanReport: RESTScanReport;
+}
+```
+. In the original Golang RESTScanRepoReport struct at https://github.com/neuvector/neuvector/blob/15496f08f7c445acd4901105fa9e73637b72cdf7/controller/api/apis.go#L2444-L2459, RESTScanReport is composed within RESTScanRepoReport. In Golang, this allows RESTScanRepoReport to use RESTScanReport's members. Tygo embeds RESTScanReport inside of RESTScanRepoReport, but when comparing the actual NeuVector JSON output to the struct definitions, RESTScanReport is not a field of the output's `report` field. In TypeScript, the equivalent of a type accessing another type's members is type intersection. Additionally, NeuVectorScanJson is handcrafted, as its equivalent type doesn't exist in `neuvector-generated-types.ts`.
+*/
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=neuvector-types.js.map

package/lib/types/neuvector-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"neuvector-types.js","sourceRoot":"","sources":["../../types/neuvector-types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"neuvector-types.js","sourceRoot":"","sources":["../../types/neuvector-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+EE","sourcesContent":["/* Types are generated with Tygo, from original Golang source code to TypeScript, and tweaked to reflect actual outputted JSON. \n\n// Dockerfile\n```\nFROM alpine:3.12 AS clone\n# If using a VPN, install certificates for `git clone` to work\nADD <URLs to CA certificates>\nRUN update-ca-certificates\ngit clone https://github.com/neuvector/neuvector.git\nFROM golang:1.23.0 AS build\n# If using a VPN, install certificates for `go install` to work\nADD <URLs to CA certificates>\nRUN update-ca-certificates\ngo install github.com/gzuidhof/tygo@latest\nWORKDIR /go/neuvector\nCOPY --from=clone /neuvector .\nCOPY tygo.yaml .\n```\n\n// tygo.yaml\n```\npackages:\n  - path: 'github.com/neuvector/neuvector/controller/api'\n    output_path: '/go/output/neuvector-generated-types.ts'\n```\n\n// docker-compose.yml\n```\nservices:\n  # Generates neuvector/scanner TypeScript types from its Golang source code\n  go2ts:\n    container_name: tygo\n    volumes:\n      - './tygo-output/:/go/output/'\n    build:\n      dockerfile: Dockerfile\n    tty: true\n    command: tygo generate\n```\n\n// `docker compose` command to regenerate Tygo types: `docker compose up --build go2ts`. Output file will be `./tygo-output/neuvector-generated-types.ts`. \nSome of the generated types are copied into and defined in this file. The currently-used generated types begin with `REST`, and some of the generated types are tweaked such that when they have a field beginning with `REST`, the field is intersected instead. For example: \n```\ntype RESTScanRepoReport = {\n  verdict?: string;\n  image_id: string;\n  registry: string;\n  repository: string;\n  tag: string;\n  digest: string;\n  size: number;\n  author: string;\n  base_os: string;\n  created_at: string;\n  cvedb_version: string;\n  cvedb_create_time: string;\n  layers: RESTScanLayer[];\n} & RESTScanReport;\n```\nwas tweaked from the generated\n```\nexport interface RESTScanRepoReport {\n  verdict?: string;\n  image_id: string;\n  registry: string;\n  repository: string;\n  tag: string;\n  digest: string;\n  size: number;\n  author: string;\n  base_os: string;\n  created_at: string;\n  cvedb_version: string;\n  cvedb_create_time: string;\n  layers: (RESTScanLayer | undefined)[];\n  RESTScanReport: RESTScanReport;\n}\n```\n. In the original Golang RESTScanRepoReport struct at https://github.com/neuvector/neuvector/blob/15496f08f7c445acd4901105fa9e73637b72cdf7/controller/api/apis.go#L2444-L2459, RESTScanReport is composed within RESTScanRepoReport. In Golang, this allows RESTScanRepoReport to use RESTScanReport's members. Tygo embeds RESTScanReport inside of RESTScanRepoReport, but when comparing the actual NeuVector JSON output to the struct definitions, RESTScanReport is not a field of the output's `report` field. In TypeScript, the equivalent of a type accessing another type's members is type intersection. Additionally, NeuVectorScanJson is handcrafted, as its equivalent type doesn't exist in `neuvector-generated-types.ts`.\n*/\n\nexport type RESTVulnerability = {\n  // This can be a CVE, GHSA, or RHSA.\n  name: string;\n  // `score` is possibly CVSS v2 based on https://github.com/neuvector/scanner/blob/765fb1db2cf678ea6c6d386f3eb0f720311d745a/cvetools/cvesearch.go#L1416.\n  score: number /* Tygo: float32 */;\n  // Could be CVSS v3, since info for v2 and v4 doesn't always exist for CVEs.\n  severity: string;\n  // Could be the CVSS v2 vector.\n  vectors: string;\n  description: string;\n  file_name: string;\n  package_name: string;\n  package_version: string;\n  fixed_version: string;\n  link: string;\n  // In the NeuVector Scanning & Compliance documentation, Score (V3) is selectable by a dropdown. This could be the CVSS v3 score.\n  score_v3: number /* Tygo: float32 */;\n  // Could be the CVSS v3 vector.\n  vectors_v3: string;\n  // Both timestamp fields are Unix epoch timestamps, in seconds.\n  published_timestamp: number /* Tygo: int64 */;\n  last_modified_timestamp: number /* Tygo: int64 */;\n  cpes?: string[];\n  cves?: string[];\n  feed_rating: string;\n  in_base_image?: boolean;\n  tags?: string[];\n};\n\nexport type RESTScanModule = {\n  name: string;\n  file: string;\n  version: string;\n  source: string;\n  cves?: RESTModuleCve[];\n  cpes?: string[];\n};\n\nexport type RESTModuleCve = {\n  name: string;\n  status: string;\n};\n\ntype RESTBenchItem = {\n  level: string;\n  evidence?: string;\n  location?: string;\n  message: string[];\n  group?: string;\n} & RESTBenchCheck;\n\ntype RESTBenchCheck = {\n  test_number: string;\n  category: string;\n  type: string;\n  profile: string;\n  scored: boolean;\n  automated: boolean;\n  description: string;\n  remediation: string;\n  tags?: string[]; // Tygo: Tags provide list of compliance that related to the cis test item.\n  tags_v2?: Record<string, unknown /* Tygo: share.TagDetails */>; // Tygo: TagsV2 provide compliance details for each compliance tag\n};\n\ntype RESTScanSecret = {\n  type: string;\n  evidence: string;\n  path: string;\n  suggestion: string;\n};\n\ntype RESTScanSetIdPerm = {\n  type: string;\n  evidence: string;\n  path: string;\n};\n\ntype RESTScanSignatureInfo = {\n  verifiers?: string[];\n  verification_timestamp: string;\n};\n\ntype RESTScanReport = {\n  vulnerabilities: RESTVulnerability[];\n  modules?: RESTScanModule[];\n  // `checks` lines up with CIS benchmarks\n  checks?: RESTBenchItem[];\n  secrets?: RESTScanSecret[];\n  setid_perms?: RESTScanSetIdPerm[];\n  // Environment variables used within the Docker image\n  envs?: string[];\n  labels?: Record<string, string>;\n  // Dockerfile CMDs\n  cmds?: string[];\n  signature_data?: RESTScanSignatureInfo;\n};\n\nexport type RESTScanRepoReport = {\n  verdict?: string;\n  image_id: string;\n  registry: string;\n  repository: string;\n  tag: string;\n  digest: string;\n  size: number /* Tygo: int64 */;\n  author: string;\n  base_os: string;\n  created_at: string;\n  cvedb_version: string;\n  cvedb_create_time: string;\n  layers: RESTScanLayer[];\n} & RESTScanReport;\n\ntype RESTScanLayer = {\n  digest: string;\n  cmds: string;\n  vulnerabilities: RESTVulnerability[];\n  size: number /* Tygo: int64 */;\n};\n\nexport type NeuVectorScanJson = {\n  report: RESTScanRepoReport;\n  error_message: string;\n};\n"]}

package/lib/types/splunk-config-types.d.ts

@@ -11,3 +11,4 @@ export type SplunkConfig = {
     autologin?: boolean;
     version?: string;
 };
+//# sourceMappingURL=splunk-config-types.d.ts.map

package/lib/types/splunk-config-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"splunk-config-types.d.ts","sourceRoot":"","sources":["../../types/splunk-config-types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/lib/types/splunk-config-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"splunk-config-types.js","sourceRoot":"","sources":["../../types/splunk-config-types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"splunk-config-types.js","sourceRoot":"","sources":["../../types/splunk-config-types.ts"],"names":[],"mappings":"","sourcesContent":["export type SplunkConfig = {\n  scheme: string;\n  host: string;\n  port?: number;\n  username?: string;\n  password?: string;\n  index: string;\n  owner?: string;\n  app?: string;\n  sessionKey?: string;\n  autologin?: boolean;\n  version?: string;\n};\n"]}

package/lib/types/splunk-control-types.d.ts

@@ -41,3 +41,4 @@ export type Tags = {
     fix?: string;
     nist?: string[];
 };
+//# sourceMappingURL=splunk-control-types.d.ts.map

package/lib/types/splunk-control-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"splunk-control-types.d.ts","sourceRoot":"","sources":["../../types/splunk-control-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAC,aAAa,EAAC,MAAM,mDAAmD,CAAC;AAEhF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,aAAa,CAAC;IACvD,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC;IAC5B,OAAO,CAAC,EAAE,iBAAiB,EAAE,GAAG,aAAa,CAAC;IAC9C,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}

package/lib/types/splunk-control-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"splunk-control-types.js","sourceRoot":"","sources":["../../types/splunk-control-types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"splunk-control-types.js","sourceRoot":"","sources":["../../types/splunk-control-types.ts"],"names":[],"mappings":"","sourcesContent":["import {HDFControlSegment} from 'inspecjs';\nimport {ILookupPathFH} from '../src/converters-from-hdf/reverse-base-converter';\n\nexport type SplunkControl = {\n  meta: Meta;\n  code: string;\n  desc: string;\n  title?: string | null;\n  descriptions: Record<string, string>[] | ILookupPathFH;\n  id: string;\n  impact: number;\n  refs: any[] | ILookupPathFH;\n  results?: HDFControlSegment[] | ILookupPathFH;\n  source_location?: any;\n  tags: Tags;\n};\n\nexport type Meta = {\n  guid: string;\n  filename: string;\n  filetype: string;\n  subtype: string;\n  profile_sha256: string;\n  hdf_splunk_schema: string;\n  status: string;\n  is_waived: boolean;\n  is_baseline: boolean;\n  overlay_depth: number;\n};\n\nexport type Result = {\n  code_desc: string;\n  run_time: number;\n  start_time: Date;\n  status: string;\n  resource: string;\n  message: string;\n  skip_message: string;\n  exception: string;\n  backtrace: null;\n};\n\nexport type Tags = {\n  check?: string;\n  fix?: string;\n  nist?: string[];\n};\n"]}

package/lib/types/splunk-profile-types.d.ts

@@ -51,3 +51,4 @@ export type Meta = {
     hdf_splunk_schema: string;
     is_baseline: boolean;
 };
+//# sourceMappingURL=splunk-profile-types.d.ts.map

package/lib/types/splunk-profile-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"splunk-profile-types.d.ts","sourceRoot":"","sources":["../../types/splunk-profile-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,mDAAmD,CAAC;AAEhF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,QAAQ,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;IAClC,UAAU,EAAE,SAAS,EAAE,GAAG,aAAa,CAAC;IACxC,MAAM,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC"}

package/lib/types/splunk-profile-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"splunk-profile-types.js","sourceRoot":"","sources":["../../types/splunk-profile-types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"splunk-profile-types.js","sourceRoot":"","sources":["../../types/splunk-profile-types.ts"],"names":[],"mappings":"","sourcesContent":["import {ILookupPathFH} from '../src/converters-from-hdf/reverse-base-converter';\n\nexport type SplunkProfile = {\n  meta: Meta;\n  summary: string;\n  sha256: string;\n  controls: unknown[];\n  supports: any[] | ILookupPathFH;\n  name: string;\n  copyright: string;\n  maintainer: string;\n  copyright_email: string;\n  version: string;\n  license: string;\n  title: string;\n  parent_profile: string | undefined;\n  depends: Depend[] | ILookupPathFH;\n  attributes: Attribute[] | ILookupPathFH;\n  groups: Group[] | ILookupPathFH;\n  status: string;\n};\n\nexport type Attribute = {\n  name: string;\n  options: Options;\n};\n\nexport type Options = {\n  default: string;\n  required: boolean;\n  type: string;\n};\n\nexport type Depend = {\n  name: string;\n  url: string;\n  git: string;\n  branch: string;\n  path: string;\n  skip_message: string;\n  status: string;\n  supermarket: string;\n  compliance: string;\n};\n\nexport type Group = {\n  controls: string[];\n  id: string;\n};\n\nexport type Meta = {\n  guid: string;\n  filetype: string;\n  filename: string;\n  subtype: string;\n  profile_sha256: string;\n  hdf_splunk_schema: string;\n  is_baseline: boolean;\n};\n"]}

package/lib/types/splunk-report-types.d.ts

@@ -18,3 +18,4 @@ export type Platform = {
     release: string;
     name: string;
 };
+//# sourceMappingURL=splunk-report-types.d.ts.map

package/lib/types/splunk-report-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"splunk-report-types.d.ts","sourceRoot":"","sources":["../../types/splunk-report-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,UAAU,CAAC;AAElC,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,IAAI,CAAC;IACX,UAAU,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC;IACjC,WAAW,EAAE,GAAG,CAAC;IACjB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/lib/types/splunk-report-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"splunk-report-types.js","sourceRoot":"","sources":["../../types/splunk-report-types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"splunk-report-types.js","sourceRoot":"","sources":["../../types/splunk-report-types.ts"],"names":[],"mappings":"","sourcesContent":["import {ExecJSON} from 'inspecjs';\n\nexport type SplunkReport = {\n  meta: Meta;\n  statistics?: ExecJSON.Statistics;\n  passthrough: any;\n  profiles: unknown[];\n  platform: Platform;\n  version: string;\n};\n\nexport type Meta = {\n  guid: string;\n  filename: string;\n  filetype: string;\n  subtype: string;\n  hdf_splunk_schema: string;\n};\n\nexport type Platform = {\n  release: string;\n  name: string;\n};\n"]}

package/package.json

@@ -1,93 +1,76 @@
 {
   "name": "@mitre/hdf-converters",
-  "version": "2.12.2",
+  "version": "2.13.0",
   "license": "Apache-2.0",
   "description": "Converter util library used to transform various scan results into HDF format",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mitre/heimdall2",
+    "directory": "libs/hdf-converters"
+  },
   "files": [
     "lib"
   ],
   "main": "lib/index.js",
-  "publishConfig": {
-    "main": "lib/index.js"
-  },
   "scripts": {
-    "build": "run-script-os",
-    "build:darwin:linux": "../../node_modules/.bin/tsc -p ./tsconfig.build.json && cp -R ./data ./lib",
-    "build:win32": "../../node_modules/.bin/tsc -p ./tsconfig.build.json && xcopy data lib",
-    "lint": "eslint \"**/*.ts\" --fix",
-    "lint:ci": "eslint \"**/*.ts\" --max-warnings 0",
-    "prepack": "yarn build && node prepack.js",
+    "prebuild": "tailwindcss -i data/reverse-html-mapper/tailwind.css -o data/reverse-html-mapper/style.css --minify && node data/reverse-html-mapper/convert-to-embedded-strings.ts",
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "eslint --fix",
+    "lint:ci": "eslint --max-warnings 0",
+    "prepack": "run-script-os",
+    "prepack:darwin:linux": "yarn build && cp package.json package.json.orig && cat package.json.orig | jq '.main = \"lib/index.js\"' > package.json",
+    "prepack:win32": "yarn build && copy package.json package.json.orig && type package.json.orig | jq \".main = \\\"lib/index.js\\\"\" > package.json",
     "postpack": "run-script-os",
     "postpack:darwin:linux": "mv package.json.orig package.json",
     "postpack:win32": "move package.json.orig package.json",
-    "test": "jest",
-    "csv2json": "tsx data/converters/csv2json.ts",
-    "xml2json": "tsx data/converters/xml2json.ts"
+    "test": "vitest",
+    "test:ci": "vitest run",
+    "csv2json": "node data/converters/csv2json.ts",
+    "xml2json": "node data/converters/xml2json.ts"
   },
   "dependencies": {
-    "@aws-sdk/client-config-service": "3.899.0",
+    "@aws-sdk/client-config-service": "3.1028.0",
     "@e965/xlsx": "^0.20.0",
     "@mdi/js": "^7.0.96",
     "@microsoft/microsoft-graph-types": "^2.40.0",
     "@mitre/jsonix": "^3.0.7",
     "@smithy/node-http-handler": "^4.0.0",
+    "@tailwindcss/cli": "^4.0.6",
     "@types/csv2json": "^1.4.2",
-    "@types/ms": "^0.7.31",
     "@types/mustache": "^4.1.2",
     "@types/papaparse": "^5.3.2",
     "@types/revalidator": "^0.3.12",
+    "@types/sanitize-html": "^2.3.1",
     "@types/semver": "^7.7.0",
-    "@types/triple-beam": "^1.3.2",
     "@types/validator": "^13.12.0",
     "@types/xml2js": "^0.4.9",
     "axios": "^1.3.5",
     "compare-versions": "^6.0.0",
     "csv2json": "^2.0.2",
-    "fast-xml-parser": "5.2.5",
+    "fast-xml-parser": "5.5.11",
     "html-entities": "^2.3.2",
-    "htmlparser2": "^10.0.0",
-    "inspecjs": "^2.12.2",
+    "htmlparser2": "^12.0.0",
+    "inspecjs": "^2.13.0",
     "lodash": "^4.17.21",
     "moment": "^2.29.1",
-    "ms": "^2.1.3",
     "mustache": "^4.2.0",
     "papaparse": "^5.3.1",
+    "retry-axios": "^4.0.2",
     "revalidator": "^0.3.1",
     "run-script-os": "^1.1.6",
+    "sanitize-html": "^2.17.2",
     "semver": "^7.6.0",
     "tailwindcss": "^4.0.6",
-    "tw-elements": "^1.0.0-beta2",
+    "tw-elements": "^2.0.0",
     "validator": "^13.12.0",
     "winston": "^3.6.0",
     "xml-formatter": "^3.6.2",
     "yaml": "^2.1.1"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.0",
     "@types/lodash": "^4.14.161",
-    "@types/node": "^24.3.1",
-    "jest": "^27.0.6",
-    "quicktype": "^15.0.260",
-    "ts-jest": "^29.1.0",
-    "tsx": "^4.7.1",
-    "typedoc": "^0.28.12",
+    "@types/node": "^25.0.0",
+    "vitest": "^4.0.18",
     "xml2js": "^0.6.0"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts",
-      "d.ts",
-      "node"
-    ],
-    "moduleNameMapper": {
-      "axios": "axios/dist/node/axios.cjs"
-    },
-    "rootDir": ".",
-    "testTimeout": 10000000,
-    "transform": {
-      "^.+\\.ts$": "ts-jest"
-    }
   }
-}
+}

package/lib/data/converters/csv2json.ts

@@ -1,36 +0,0 @@
-import csv2json from 'csv2json';
-import {createReadStream, createWriteStream} from 'fs';
-import path from 'path';
-
-const files = [
-  'aws-config-mapping.csv',
-  'cwe-nist-mapping.csv',
-  'nessus-plugins-nist-mapping.csv',
-  'nikto-nist-mapping.csv',
-  'owasp-nist-mapping.csv',
-  'scoutsuite-nist-mapping.csv'
-];
-
-try {
-  const pathToFiles = process.argv[2];
-  try {
-    const pathToOutput = process.argv[3];
-    files.forEach((file) => {
-      createReadStream(path.join(pathToFiles, file))
-        .pipe(csv2json())
-        .pipe(
-          createWriteStream(
-            path.join(pathToOutput, file.replace('.csv', '.json'))
-          )
-        );
-    });
-  } catch {
-    console.error(`You must provide the path to an output folder.`);
-    process.exit(1);
-  }
-} catch {
-  console.error(
-    `You must provide the path to a folder containing ${files.join(', ')}.`
-  );
-  process.exit(1);
-}

package/lib/data/converters/xml2json.ts

@@ -1,57 +0,0 @@
-import fs from 'fs';
-import * as _ from 'lodash';
-import xml2js from 'xml2js';
-
-const parser = new xml2js.Parser();
-const pathToInfile = process.argv[2];
-const pathToOutfile = process.argv[3];
-
-// XML Structure after conversion
-export interface ICCIList {
-  cci_list: {
-    cci_items: {
-      cci_item: {
-        $: Record<string, string>;
-        references: {
-          reference: {
-            $: Record<string, string>;
-          }[];
-        }[];
-      }[];
-    }[];
-  };
-}
-
-if (!pathToInfile || !pathToOutfile) {
-  console.error(`You must provide the path to both an input and ouput file.`);
-} else {
-  fs.readFile(pathToInfile, function (readFileError, data) {
-    if (readFileError) {
-      console.error(`Failed to read ${pathToInfile}: ${readFileError}`);
-    } else {
-      // Parse XML to JS Object
-      parser.parseString(data, (parseFileError: any, converted: ICCIList) => {
-        if (parseFileError) {
-          console.error(`Failed to parse ${pathToInfile}: ${parseFileError}`);
-        } else {
-          // Stores our CCI->NIST mapping
-          const result: Record<string, string> = {};
-          // For all cci items
-          converted.cci_list.cci_items[0].cci_item.forEach((cciItem) => {
-            // Get the latest reference
-            const newestReference = _.maxBy(
-              cciItem.references[0].reference,
-              (item) => _.get(item, '$.version')
-            );
-            if (newestReference) {
-              result[cciItem.$.id] = newestReference.$.index;
-            } else {
-              console.error(`No NIST Controls found for ${cciItem.$.id}`);
-            }
-          });
-          fs.writeFileSync(pathToOutfile, JSON.stringify(result));
-        }
-      });
-    }
-  });
-}